flbEventList

Integrační manuál rezervačního systému FlexBook
Search…
flbEventList
Zobrazí seznam všech a nebo vyspecifikovaných aktivních akcí poskytovatele, které je možné filtrovat podle střediska a nebo tagu
Volitelné parametry:
tag: je pole textových řetězců asociované k akci nebo zdroji. Tagy se kombinují pomocí logického operátoru AND. V příkladu výše se tedy zobrazí akce označené tagem kurt a tagem trener. Tagy středisek je možné dohledat v back-officu rezervačního systému FlexBook.
Příklad použití parametru:
tag: ['kurt','trener']
tagOperator: možnost předefinování defaultního logického operátoru (AND), který se aplikuje na tagy  
Možné hodnoty
or
and
center: je pole integer hodnot, identifikující konkrétní střediska poskytovatele. Identifikátory středisek je možné dohledat v back-officu rezervačního systému FlexBook.
region: pole řetězců omezující výpis akcí na akce, které jsou na střediscích v konkrétním kraji
organiser: možnost omezit akce na akce konkrétního organizátora. Konkrétní organizátor se zadává pomocí emailové adresy a nebo je možné zadat místo emailové adresy speciální hodnotu loggedInUser, která zajistí doplnění aktuálně nalogovaného uživatele do front-endu
dateMin: možnost omezit akce podle datumu začátku akce (YYYY-MM-DD)
dateMax: možnost omezit akce podle datumu konce akce (YYYY-MM-DD)
weekday: možnost omezit akce pouze na ty, které začínají v určitý den v týdnu. Např.: weekday: 'mon,tue' zajistí zobrazení událostí začínajících v pondělí nebo v úterý.
count: možnost omezit počet zobrazených akcí
onPageCount: možnost omezit počet zobrazených akcí s možností zobrazit (dogenerovat) další pomocí buttonu 
Příklad použití parametru:
onPageCount: 10
renderText: definice atributů, které se mají pro konkrétní akci zobrazit v detailu vybrané akce. Viz. parametr renderText v komponentě flbEventDetail
cycleItemTemplate: možnost definice HTML šablony pro změnu řádku jedné lekce v cyklu zobrazované v detailu vybrané akce (typu cyklus). Viz. parametr cycleItemTemplate v komponentě flbEventDetail
attendeeTemplate: možnost definice HTML šablony jednoho účastníka akce, tak jak se to má pro konkrétní akci zobrazit v detailu vybrané akce. Viz. parametr attendeeTemplate v komponentě flbEventDetail
eventResourcePrefix a eventResourcePostfix: parametry, které se dají použít v případě, že je použit @@EVENT_RESOURCE v parametru eventTemplate. Parametry je možné nadefinovat co se ma zobrazit před zdrojem a za zdrojem - např. někdo chce udělat seznam "<název události> - <název zdroje>", některé události nemusí mít zdroj a pak by tam bylo "<název události> - ", takže řešení je nadefinovat eventResourcePrefix=' - ' a ten se přidá pouze když má událost asociovaný nějaký zdroj.
eventTemplate: možnost definice HTML šablony jedné neopakující se akce v seznamu
Možné hodnoty: jeden string obsahující následující tagy
@@ID
@@EVENT_NAME
@@EVENT_DESCRIPTION
@@EVENT_CENTER
@@EVENT_CENTER_STREET
@@EVENT_CENTER_CITY
@@EVENT_CENTER_ZIP
@@EVENT_CENTER_REGION
@@EVENT_CENTER_COUNTRY
@@EVENT_START
@@EVENT_END
@@EVENT_START_DATE
@@EVENT_START_TIME
@@EVENT_END_DATE
@@EVENT_END_TIME
@@EVENT_ORGANISER
@@EVENT_PLACES
@@EVENT_FREE
@@EVENT_FREE_SUBSTITUTE
@@EVENT_PRICE
@@EVENT_ATTRIBUTE(<zkratka_atributu>)
@@EVENT_RESOURCE
@@EVENT_PHOTO - zobrazí první foto z externích fotek definovaných v rámci akce
@@EVENT_PHOTOTHUMB - zobrazí náhled všech fotografií z externích fotek definovaných v rámci akce
Default: '@@EVENT_NAME (@@EVENT_START - @@EVENT_END) - @@EVENT_OVERALL_FREE - @@EVENT_PRICE'
eventCycleTemplate: možnost definice HTML šablony jedné opakující se akce v seznamu
String může obsahovat stejné jako u parametru eventTemplate, ale navíc jsou implemetované následující tagy specfické pro opakující se akce (tzv. cykly) 
@@EVENT_CYCLE_COUNT - počet akcí (lekcí) v rámci cyklu 
Default: '@@EVENT_NAME (@@EVENT_START_DATE - @@EVENT_END_DATE @@EVENT_START_TIME - @@EVENT_END_TIME) - @@EVENT_OVERALL_FREE - @@EVENT_PRICE'
tag: je pole textových řetězců asociované k akci nebo zdroji. Tagy se kombinují pomocí logického operátoru OR. V příkladu výše se tedy zobrazí akce označené tagem kurt nebo tagem trener. Tagy středisek je možné dohledat v back-officu rezervačního systému FlexBook.
Příklad použití parametru:
tag: ['kurt','trener']
tagOperator: možnost předefinování defaultního logického operátoru (OR), který se aplikuje na tagy  
Možné hodnoty
or
and
center: je integer hodnota, identifikující konkrétní středisko poskytovatele. Identifikátory středisek je možné dohledat v back-officu rezervačního systému FlexBook.
organiser: možnost omezit akce na akce konkrétního organizátora. Konkrétní organizátor se zadává pomocí emailové adresy a nebo je možné zadat místo emailové adresy speciální hodnotu loggedInUser, která zajistí doplnění aktuálně nalogovaného uživatele do front-endu
organiserCanReserveOnBehalf: parameter, kterým je možné povolit z front-endu dělat rezervace organizátorům akcí. Pomocí hodnoty tohoto parametru se určuje, kterým uživatelům může rezervaci udělat. Jen tací uživatelé se mu nabízí ve výběru.
Možné hodnoty:
'allUsers' - všichni uživatelé poskytovatele
{usersHavingReservationsOnEventWithTag: 'tag'} - uživatelé, kteří mají rezervaci na akci s uvedeným tagem
{usersHavingPaidReservationsOnEventWithTag: 'tag'} - uživatelé, kteří mají zaplacenou rezervaci na akci s uvedeným tagem
organiserCanReserveOnBehalfFunctionButtons: parameter (pole), kterým je možné nadefinovat jaké buttony (funkce) bude mít organizátor na front-endu k dispozici.
Možné hodnoty:
'attendeeToSubstitute'
'cancelAttendee'
'failAttendee'
'substituteToAttendee'
'cancelSubstitute'
Příklad použití parametru
organiserCanReserveOnBehalfFunctionButtons:[‘attendeeToSubstitute’,’cancelAttendee’,’failAttendee’,’substituteToAttendee’,’cancelSubstitute’],
organiserCanReserveOnBehalfCustomColumn: parametr (objekt / json), kterým je možné nadefinovat název a obsah třetího sloupce v AJAXovém vyhledávání.
Možné hodnoty:
'name'
'firstname'
'lastname'
'email'
'address'
'attribute_<XXX>', kde <XXX> je ID uživatelského atributu z backoffice
Příklad použití parametru
organiserCanReserveOnBehalfCustomColumn: { title: 'Custom column', value: 'attribute_BIRTH' }
organiserShowReservationAttendee: 
Možné hodnoty:
1 (default) - input liny pro zadání účastníků jména, příjmení a emailu se zobrazují
0, false, null - input liny pro zadání účastníků jména, příjmení a emailu se nezobrazují, ale jen v případě, že jsou požadovány informace pro jednoho účastníka. V případě vstupu osobních informací pro více účastníků se input liny pro zadání účastníků zobrazují
dateMin: možnost omezit akce podle datumu začátku akce (YYYY-MM-DD)
dateMax: možnost omezit akce podle datumu konce akce (YYYY-MM-DD)
weekday: možnost omezit akce pouze na ty, které začínají v určitý den v týdnu. Např.: weekday: 'mon,tue' zajistí zobrazení událostí začínajících v pondělí nebo v úterý.
count: možnost omezit počet zobrazených akcí
onPageCount: omezení počtu zobrazených akcí s možností dogenerování dalších akcí stisknutím tlačítka na konci výpisu
Příklad použití parametru
onPageCount: 10
renderText: definice atributů, které se mají pro konkrétní akci zobrazit v detailu vybrané akce. Viz. parametr renderText v komponentě flbEventDetail
attendeeTemplate: možnost definice HTML šablony jednoho účastníka akce, tak jak se to má pro konkrétní akci zobrazit v detailu vybrané akce. Viz. parametr attendeeTemplate v komponentě flbEventDetail
eventResourcePrefix a eventResourcePostfix: parametry, které se dají použít v případě, že je použit @@EVENT_RESOURCE v parametru eventTemplate. Parametry je možné nadefinovat co se ma zobrazit před zdrojem a za zdrojem - např. někdo chce udělat seznam "<název události> - <název zdroje>", některé události nemusí mít zdroj a pak by tam bylo "<název události> - ", takže řešení je nadefinovat eventResourcePrefix=' - ' a ten se přidá pouze když má událost asociovaný nějaký zdroj.
eventTemplate: možnost definice HTML šablony jedné akce v seznamu
Možné hodnoty: jeden string obsahující následující parametry
@@ID
@@EVENT_NAME
@@EVENT_DESCRIPTION
@@EVENT_CENTER
@@EVENT_START
@@EVENT_END
@@EVENT_ORGANISER
@@EVENT_PLACES
@@EVENT_FREE
@@EVENT_FREE_SUBSTITUTE
@@EVENT_PRICE
@@EVENT_ATTRIBUTE(<zkratka_atributu>)
@@EVENT_RESOURCE
Default: empty string
Příklad: ' @@EVENT_NAME - @@EVENT_START '
Přiklad 1 - seznam akcí ze střediska s ID 153 a rendrovat komponentu v českém jazyce 
1
flbInit('https://www.flexbook.cz/ajax.php', 4, [
2
{
3
  type: 'flbEventList',
4
  placeHolder: 'flb_placeholder_1',
5
  params: {
6
    lang: 'cz',
7
    center : [153],
8
  },
9
}
10
]);
Copied!
Přiklad 2 - seznam akcí s tagem kurt nebo trener, ale jen ze středisek s ID 1 a 2
1
flbEventList(
2
'flexbook_2',    
3
{
4
  tag: ['kurt','trener'],   
5
  center: [1,2]
6
}
7
);
Copied!
Přiklad 3 - akce organizátora s emailem [email protected] ze střediska ID 150 a v detailu rendrovat specifické atributy
1
<script>// <![CDATA[
2
flbInit('https://www.flexbook.cz/ajax.php', @@PROVIDER_ID(), [
3
{ type: 'flbEventList', placeHolder: 'f_3',
4
   params: { 
5
                    center: [150],
6
                    organiser: '[email protected]',
7
                    renderText: ['name', 'center', 'start', 'end', 'description', 'organiser', 'price', 'places', 'attendees', 'reservation', 'repeat_start', 'resource'],
8
                 },
9
}
10
]);
11
// ]]></script>
Copied!
Přiklad 4 - akce organizátora, který je aktuálně nalogován do front-endu
1
<script>// <![CDATA[
2
flbInit('https://www.flexbook.cz/ajax.php', @@PROVIDER_ID(), [
3
{ type: 'flbEventList', placeHolder: 'f_3',
4
   params: { 
5
                    organiser: 'loggedInUser',
6
                 },
7
}
8
]);
9
// ]]></script>
Copied!
Přiklad 5 - omezení počtu akcí na stránce s možností přigenerování dalších akcí
1
<div id="flb_placeholder_1">&nbsp;</div>
2
<script>// <![CDATA[
3
flbInit('https://www.flexbook.cz/ajax.php', @@PROVIDER_ID(), [
4
{ type: 'flbEventList', placeHolder: 'flb_placeholder_1',
5
   params: {
6
     format: { datetime: '<b>D</b> d.m. H:i', time: 'H:i' }, 
7
     lang: 'cz',
8
     onPageCount: 10,
9
     renderText: ['name','center','start','end','description','organiser','price','places','attendees','reservation'],
10
     eventTemplate: '@@EVENT_NAME - @@EVENT_CENTER - @@EVENT_START - @@EVENT_FREE - @@EVENT_PRICE'
11
   },
12
}
13
]);
14
// ]]></script>
Copied!
​
JavaScript komponenty - Previous
flbReservationList
Next - JavaScript komponenty
flbEventDetail
Last modified 9mo ago
Copy link