.. ================================================== .. FOR YOUR INFORMATION .. -------------------------------------------------- .. -*- coding: utf-8 -*- with BOM. .. include:: /Includes.rst.txt .. _template_objects: ================ Template objects ================ The following objects are available in the different views. Please have a look at the templates included with the extension, since they show many of the properties of the given objects and how to use them. .. tip:: You can use :html:`{object}` in your template to see available properties of each object. Plugin: Events and event-registration ------------------------------------- List view ~~~~~~~~~ .. t3-field-list-table:: :header-rows: 1 - :Object: Object: :Description: Description: - :Object: :html:`{events}` :Description: An object holding all events that matched the configured demand in the plugin settings - :Object: :html:`{categories}` :Description: All configured categories for the category menu (see :php:`plugin.tx_sfeventmgt.settings.categoryMenu` in the :ref:`eventplugin-settings`) - :Object: :html:`{locations}` :Description: All available locations - :Object: :html:`{organisators}` :Description: All available organisators - :Object: :html:`{speakers}` :Description: All available speakers - :Object: :html:`{eventDemand}` :Description: The eventDemand object - :Object: :html:`{overwriteDemand}` :Description: The overwriteDemand object - :Object: :html:`{contentObjectData}` :Description: The current content object of the plugin - :Object: :html:`{pageData}` :Description: The current page data Detail view ~~~~~~~~~~~ .. t3-field-list-table:: :header-rows: 1 - :Object: Object: :Description: Description: - :Object: :html:`{event}` :Description: An object holding the given event - :Object: :html:`{contentObjectData}` :Description: The current content object of the plugin - :Object: :html:`{pageData}` :Description: The current page data Registration view ~~~~~~~~~~~~~~~~~ .. t3-field-list-table:: :header-rows: 1 - :Object: Object: :Description: Description: - :Object: :html:`{event}` :Description: An object holding the given event - :Object: :html:`{contentObjectData}` :Description: The current content object of the plugin - :Object: :html:`{pageData}` :Description: The current page data Calendar view ~~~~~~~~~~~~~ .. t3-field-list-table:: :header-rows: 1 - :Object: Object: :Description: Description: - :Object: :html:`{events}` :Description: An array holding all events for the current calendar month - :Object: :html:`{weeks}` :Description: An array holding all events grouped by week (represented by the week number as key) and day. - :Object: :html:`{categories}` :Description: All configured categories for the category menu (see :php:`plugin.tx_sfeventmgt.settings.categoryMenu` in the :ref:`eventplugin-settings`) - :Object: :html:`{locations}` :Description: All available locations - :Object: :html:`{organisators}` :Description: All available organisators - :Object: :html:`{speakers}` :Description: All available speakers - :Object: :html:`{eventDemand}` :Description: The eventDemand object - :Object: :html:`{overwriteDemand}` :Description: The overwriteDemand object - :Object: :html:`{currentPageId}` :Description: The PID of the current page - :Object: :html:`{firstDayOfMonth}` :Description: DateTime object with the first day of the current month - :Object: :html:`{previousMonthConfig}` :Description: Array with date, month and year of the previous month - :Object: :html:`{nextMonthConfig}` :Description: Array with date, month and year of the next month - :Object: :html:`{weekConfig}` :Description: Array holding the year and weeknumber for the current, previous and next week. This variable must be used to create a calendar view by week. - :Object: :html:`{contentObjectData}` :Description: The current content object of the plugin - :Object: :html:`{pageData}` :Description: The current page data Search view ~~~~~~~~~~~ .. t3-field-list-table:: :header-rows: 1 - :Object: Object: :Description: Description: - :Object: :html:`{events}` :Description: An object holding all events that matched the configured demand in the plugin settings and the given searchdemand - :Object: :html:`{categories}` :Description: All available categories - :Object: :html:`{locations}` :Description: All available locations - :Object: :html:`{organisators}` :Description: All available organisators - :Object: :html:`{speakers}` :Description: All available speakers - :Object: :html:`{searchDemand}` :Description: The searchDemand object - :Object: :html:`{overwriteDemand}` :Description: The overwriteDemand object - :Object: :html:`{contentObjectData}` :Description: The current content object data - :Object: :html:`{pageData}` :Description: The current page data Notification views ~~~~~~~~~~~~~~~~~~ The following objects can be used in notification views .. t3-field-list-table:: :header-rows: 1 - :Object: Object: :Description: Description: - :Object: :html:`{event}` :Description: An object holding the given event - :Object: :html:`{registration}` :Description: An object holding the given registration - :Object: :html:`{settings}` :Description: An array of extension settings - :Object: :html:`{hmac}` :Description: HMAC for the registration UID - :Object: :html:`{reghmac}` :Description: Appended HMAC for the registration UID E-Mail subjects ~~~~~~~~~~~~~~~ The following objects can be used in email subjects for event registration and custom notifications .. t3-field-list-table:: :header-rows: 1 - :Object: Object: :Description: Description: - :Object: :html:`{event}` :Description: An object holding the event for a registration - :Object: :html:`{registration}` :Description: An object holding the registration Registration message views ~~~~~~~~~~~~~~~~~~~~~~~~~~ Registration message views are :php:`cancelRegistration`, :php:`confirmRegistration` and :php:`saveRegistrationResult` .. t3-field-list-table:: :header-rows: 1 - :Object: Object: :Description: Description: - :Object: :html:`{event}` :Description: An object holding the given event - :Object: :html:`{registration}` :Description: An object holding the given registration - :Object: :html:`{failed}` :Description: If the status is failed - :Object: :html:`{titleKey}` :Description: The key of the title to use in viewHelper - :Object: :html:`{messageKey}` :Description: The key of the message to use in viewHelper - :Object: :html:`{result}` :Description: The integer value of the {messageKey} variable iCalendar view ~~~~~~~~~~~~~~ The iCalendar view is used to render an iCal file which can be downloaded by the user for the given event. Please note, that the iCalendar view is a simple textfile. If you choose to extend the view, be sure that new fields are compliant with RFC 5545 https://tools.ietf.org/html/rfc5545 .. t3-field-list-table:: :header-rows: 1 - :Object: Object: :Description: Description: - :Object: :html:`{event}` :Description: An object holding the given event Plugin: Events and event-registration - FE user registrations ------------------------------------------------------------- List view ~~~~~~~~~ .. t3-field-list-table:: :header-rows: 1 - :Object: Object: :Description: Description: - :Object: :html:`{registrations}` :Description: An object holding all registrations that matched the configured demand in the plugin settings