diff --git a/Documentation/Fluid/ViewHelper/Alias.rst b/Documentation/Fluid/ViewHelper/Alias.rst deleted file mode 100644 index 59c2457..0000000 --- a/Documentation/Fluid/ViewHelper/Alias.rst +++ /dev/null @@ -1,70 +0,0 @@ -.. include:: ../../Includes.txt - -.. _vh-f-alias: - -f:alias -======= - -This ViewHelper creates variables that you can use when developing Fluid views. You create variables which contain either -static values or dynamic values from objects or other ViewHelpers. - -Details -------- - -map -~~~ -:aspect:`Variable type` - Array - -:aspect:`Description` - The key is the name by which the variable is known, where the value reflects the content. - -:aspect:`Default value` - -:aspect:`Mandatory` - Yes - -Examples for static values --------------------------- - -:: - - -

Hello, my name is {firstName} {lastName}

- - -**Output** - -:: - -

Hello, my name is Stefan Froemken

- -Example for results from another ViewHelper --------------------------------------------- - -:: - - -

There are {amount} records in database

- - -**Output** - -:: - -

There are 23 records in database

- -Example for values from an object ---------------------------------- - -:: - - -

Hello, my name is {firstName} {lastName}

- - -**Output** - -:: - -

Hello, my name is Stefan Froemken

diff --git a/Documentation/Fluid/ViewHelper/Base.rst b/Documentation/Fluid/ViewHelper/Base.rst deleted file mode 100644 index 222b9db..0000000 --- a/Documentation/Fluid/ViewHelper/Base.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. include:: ../../Includes.txt - -f:base -====== - -This ViewHelper embeds the `base-Tag `_ into your HTML template. - -Properties ----------- - -This ViewHelper doesn't accept any properties. - -Example --------- - -:: - - - -**Output** - -:: - - - -.. tip:: - - Using this ViewHelper only makes sense when you're building a website template - including the - using - Fluid. If there's no in the template, this HTML tag will be added to the and that's not where it belongs. diff --git a/Documentation/Fluid/ViewHelper/Be/Buttons/Csh.rst b/Documentation/Fluid/ViewHelper/Be/Buttons/Csh.rst deleted file mode 100644 index 03cef89..0000000 --- a/Documentation/Fluid/ViewHelper/Be/Buttons/Csh.rst +++ /dev/null @@ -1,121 +0,0 @@ -.. include:: ../../../../Includes.txt - -================ -f:be.buttons.csh -================ - -This View helper returns a CSH (context sensitive help) button with an icon. -It enables you to include hints into backend forms. - -TYPO3 uses this functionality all over the backend, and it is noticeable by the small “question mark” image when hovering -over the element, whilst clicking on the element displays the help text in a small tooltip. - -Properties -========== - -.. rst-class:: dl-parameters - -table - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` string - :sep:`|` :aspect:`Default:` null - :sep:`|` - - Table name ('_MOD_'+module name). If not set, the current module name will - be used. - - -field - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` string - :sep:`|` :aspect:`Default:` empty string - :sep:`|` - - Field name (CSH locallang main key). - - -wrap - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` string - :sep:`|` :aspect:`Default:` empty string - :sep:`|` - - Markup to wrap around the CSH, split by `|` . - - -Special case ------------- - -There's a special case in which the “table” property doesn't need to be -defined. This is the case when there are form fields in the module, but when -there is no 1:1 column in the database. For example, in the Scheduler, which -stores its information in a serialized format in a single field, or in the case -of a search field, whose value isn't sent to the database. Such fields can be -assigned a csh icon through the addition of an entry in -:file:`ext_tables.php`:: - - \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addLLrefForTCAdescr( - '_MOD_FullModuleName', - 'Path to a language file' - ); - - -Note the reference to the fully-formed module name. This is comprised of the -category (e.g. “web”), the upper-camel-cased extension name and the upper- -camel-cased module name. In the example of an extension named “sfextbase” and a -module named “extbase”, the complete name would be:: - - web_SfextbaseExtbase - - -Here's an example of how the configuration might appear:: - - \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addLLrefForTCAdescr( - '_MOD_web_SfextbaseExtbase', - 'EXT:ext_key/Resources/Private/Language/locallang_extbase.xlf' - ); - - -The entry for the email address in the XLF file would be as follows: - -.. code-block:: xml - - - Email - - - Enter your email address - - - - I am a really long description, which gives plenty of detail about - this field relating to an email address, as well as what you need to - note and that you need to add a valid email address in this field. - - - - -Examples -======== - -Example: database fields ------------------------- - -In the majority of TYPO3 tables, the language file key is usually the same as -the column name: - -.. code-block:: html - - - - -Example: Icons for form fields without a 1:1 database structure ---------------------------------------------------------------- - -This example relates to the special case mentioned above, in which the table -name may not be indicated: - -.. code-block:: html - - - diff --git a/Documentation/Fluid/ViewHelper/Be/Buttons/Index.rst b/Documentation/Fluid/ViewHelper/Be/Buttons/Index.rst deleted file mode 100644 index a967415..0000000 --- a/Documentation/Fluid/ViewHelper/Be/Buttons/Index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. include:: ../../../../Includes.txt - -=================== -ViewHelper: Buttons -=================== - -**Contents** - -.. toctree:: - :titlesonly: - - Csh - Shortcut diff --git a/Documentation/Fluid/ViewHelper/Be/Buttons/Shortcut.rst b/Documentation/Fluid/ViewHelper/Be/Buttons/Shortcut.rst deleted file mode 100644 index b7e328a..0000000 --- a/Documentation/Fluid/ViewHelper/Be/Buttons/Shortcut.rst +++ /dev/null @@ -1,47 +0,0 @@ -.. include:: ../../../../Includes.txt - -===================== -f:be.buttons.shortcut -===================== - -This ViewHelper provides the bookmark function used in the backend. Currently -this ViewHelper is not used by the core. - -Properties -========== - -.. rst-class:: dl-parameters - -getVars - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` array - :sep:`|` :aspect:`Default:` empty array - :sep:`|` - - List of GET variables to store. By default the current id, module and all - module arguments will be stored. - - -setVars - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` array - :sep:`|` :aspect:`Default:` empty array - :sep:`|` - - List of SET[] variables to store. See DocumentTemplate::makeShortcutIcon(). - Normally won't be used by Extbase modules. - - -Example -======= - -Default:: - - - - -Explicitly set parameters to be stored in the shortcut:: - - diff --git a/Documentation/Fluid/ViewHelper/Be/Container.rst b/Documentation/Fluid/ViewHelper/Be/Container.rst deleted file mode 100644 index 4229f67..0000000 --- a/Documentation/Fluid/ViewHelper/Be/Container.rst +++ /dev/null @@ -1,223 +0,0 @@ -.. include:: ../../../Includes.txt - -============== -f:be.container -============== - -The first question you should ask yourself is whether you want to build -something using the existing TYPO3 interface, or build something completely -bespoke. If you're making a bespoke interface, then you don't need this -ViewHelper at all. In this event, bind your own JavaScript and CSS assets -yourself. - -However, if you want to build something using the standard TYPO3 interface, -thereby providing a close integration and compatibility with other modules, -then use this ViewHelper. In essence, you only need to use two rows of code and -around ten properties. - -Properties -========== - -.. rst-class:: dl-parameters - -pageTitle - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` string - :sep:`|` :aspect:`Default:` empty string - :sep:`|` - - Backend modules are loaded in an HTML frame, so it's not essential to define - an HTML page title. If you want to, then this is the property to use. - - -enableJumpToUrl - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` boolean - :sep:`|` :aspect:`Default:` true - :sep:`|` - - Activate this parameter if you want to use the ActionMenu ViewHelper. This - loads the necessary JavaScript assets. - - This property has been marked as deprecated in TYPO3 6.2 and was removed in - TYPO3 7.0. - - -enableClickMenu - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` boolean - :sep:`|` :aspect:`Default:` true - :sep:`|` - - When active, this property loads the JavaScript for context menu - functionality. - - -loadPrototype - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` boolean - :sep:`|` :aspect:`Default:` true - :sep:`|` - - When active, the Prototype JS framework will be loaded. - -loadScriptaculous - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` boolean - :sep:`|` :aspect:`Default:` false - :sep:`|` - - When active, the Scriptaculous extension to Prototype JS will be loaded. - -scriptaculousModule - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` string - :sep:`|` :aspect:`Default:` empty string - :sep:`|` - - Using this option, you can load additional JavaScript modules for - Scriptaculous. - - -loadExtJs - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` boolean - :sep:`|` :aspect:`Default:` false - :sep:`|` - - When active, the ExtJS framework will be loaded. - - -loadExtJsTheme - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` boolean - :sep:`|` :aspect:`Default:` true - :sep:`|` - - When active, templates for the graphical elements of the ExtJs framework - will be loaded. - - -extJsAdapter - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` string - :sep:`|` :aspect:`Default:` empty string - :sep:`|` - - You can use this property to define a different adaptor instead of the - standard, Extbase. - - -enableExtJsDebug - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` boolean - :sep:`|` :aspect:`Default:` false - :sep:`|` - - This property should only be activated during a development process - involving ExtJS. - - -addCssFile - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` string - :sep:`|` :aspect:`Default:` null - :sep:`|` - - Bind a specific CSS asset file to the view. - - This property has been marked as deprecated in TYPO3 6.2 and was removed in - TYPO3 7.0. Please use the `includeCssFiles` instead. - - -addJsFile - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` string - :sep:`|` :aspect:`Default:` null - :sep:`|` - - Bind a specific JavaScript asset file to the view. - - This property has been marked as deprecated in TYPO3 6.2 and was removed in - TYPO3 7.0. Please use the `includeJsFiles` instead. - - -loadJQuery - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` boolean - :sep:`|` :aspect:`Default:` false - :sep:`|` - - When active, jQuery will be loaded. - - -includeCssFiles - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` array - :sep:`|` :aspect:`Default:` null - :sep:`|` - - Using addCssFile will only allow you to bind in a single CSS asset file. - Using includeCssFiles allows you to bind multiple files. - - -includeJsFiles - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` array - :sep:`|` :aspect:`Default:` null - :sep:`|` - - Using addJsFile will only allow you to bind in a single JavaScript asset - file. Using includeJsFiles allows you to bind multiple files. - - -addJsInlineLabels - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` array - :sep:`|` :aspect:`Default:` null - :sep:`|` - - Each value must correspond to a key from the locallang.xml/xlf file. The - matching translation will then be available in the backend. - - -Examples -======== - -Simple ------- - -"your module content" wrapped with proper head & body tags. -Default backend CSS styles and JavaScript will be included. - -:: - - your module content - -All options ------------ - -"your module content" wrapped with proper head & body tags. Custom CSS file -:file:`EXT:your_extension/Resources/Public/Css/styles.css` and JavaScript files -:file:`EXT:your_extension/Resources/Public/JavaScript/Library1.js` and -:file:`EXT:your_extension/Resources/Public/JavaScript/Library2.js` will be -loaded, plus ExtJS and jQuery and some inline labels for usage in JS code. - -:: - - - your module content - diff --git a/Documentation/Fluid/ViewHelper/Be/Index.rst b/Documentation/Fluid/ViewHelper/Be/Index.rst deleted file mode 100644 index 5e3aaa7..0000000 --- a/Documentation/Fluid/ViewHelper/Be/Index.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. include:: ../../../Includes.txt - -ViewHelpers for the TYPO3 backend -================================= - -**Contents** - -.. toctree:: - :titlesonly: - - Buttons/Index - Menus/Index - Security/Index - Widget/Index - Container - InfoBox - PageInfo - PagePath - PageRenderer - TableList diff --git a/Documentation/Fluid/ViewHelper/Be/InfoBox.rst b/Documentation/Fluid/ViewHelper/Be/InfoBox.rst deleted file mode 100644 index dca03a9..0000000 --- a/Documentation/Fluid/ViewHelper/Be/InfoBox.rst +++ /dev/null @@ -1,87 +0,0 @@ -.. include:: ../../../Includes.txt - -============ -f:be.infobox -============ - -View helper for rendering a styled content infobox markup. - -Properties -========== - -.. rst-class:: dl-parameters - -message - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` string - :sep:`|` :aspect:`Default:` empty string - :sep:`|` - - The message of the info box, if NULL tag content is used. - - -title - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` string - :sep:`|` :aspect:`Default:` empty string - :sep:`|` - - The title of the info box. - - -state - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` integer - :sep:`|` :aspect:`Default:` InfoboxViewHelper::STATE_NOTICE - :sep:`|` - - The Infobox provides different context sensitive states that can be used to - provide an additional visual feedback to the to the user to underline the - meaning of the information. The possible states are:: - - InfoboxViewHelper::STATE_NOTICE - InfoboxViewHelper::STATE_INFO - InfoboxViewHelper::STATE_OK - InfoboxViewHelper::STATE_WARNING - InfoboxViewHelper::STATE_ERROR - - -iconName - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` string - :sep:`|` :aspect:`Default:` empty string - :sep:`|` - - The icon name from font awesome, NULL sets default icon. - - -disableIcon - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` boolean - :sep:`|` :aspect:`Default:` false - :sep:`|` - - If set to TRUE, the icon is not rendered. - - -Examples -======== - -Simple ------- - -:: - - your box content - -All options ------------ - -:: - - diff --git a/Documentation/Fluid/ViewHelper/Be/Menus/ActionMenu.rst b/Documentation/Fluid/ViewHelper/Be/Menus/ActionMenu.rst deleted file mode 100644 index 647d18a..0000000 --- a/Documentation/Fluid/ViewHelper/Be/Menus/ActionMenu.rst +++ /dev/null @@ -1,44 +0,0 @@ -.. include:: ../../../../Includes.txt - -===================== -f:be.menus.actionMenu -===================== - -This ViewHelper creates a select box. With the addition of the -`f:be.menus.actionMenuItem` and `f:be.menus.actionMenuItemGroup` ViewHelper, -you can fill this select box with options, which will lead to an appropriate -view when they are selected. - -Properties -========== - -.. rst-class:: dl-parameters - -defaultController - :sep:`|` :aspect:`Condition:` required - :sep:`|` :aspect:`Type:` string - :sep:`|` :aspect:`Default:` null - :sep:`|` - - Provide the name of the Controller to be used in the event that the - Controller name isn't provided in the individual ActionMenuItem ViewHelper. - As the Controller parameter is required for the ActionMenuItem ViewHelper - anyway, you're better off not setting this property in this ViewHelper. - - -Example -======= - -The following menu contains a Select element with two menu entries. Further -details of the ActionMenuItem ViewHelper are in its own documentation. - -:: - - - - - diff --git a/Documentation/Fluid/ViewHelper/Be/Menus/ActionMenuItem.rst b/Documentation/Fluid/ViewHelper/Be/Menus/ActionMenuItem.rst deleted file mode 100644 index 9757f96..0000000 --- a/Documentation/Fluid/ViewHelper/Be/Menus/ActionMenuItem.rst +++ /dev/null @@ -1,69 +0,0 @@ -.. include:: ../../../../Includes.txt - -========================= -f:be.menus.actionMenuItem -========================= - -You can use this ViewHelper to create a menu entry for your backend module. For -this to work, the call to this ViewHelper must be placed within a -`f:be.menus.actionMenu` ViewHelper. - -Properties -========== - -.. rst-class:: dl-parameters - -label - :sep:`|` :aspect:`Condition:` required - :sep:`|` :aspect:`Type:` string - :sep:`|` :aspect:`Default:` null - :sep:`|` - - The name to display in the menu - - -controller - :sep:`|` :aspect:`Condition:` required - :sep:`|` :aspect:`Type:` string - :sep:`|` :aspect:`Default:` null - :sep:`|` - - The Controller in which the appropriate Action lies. - - -action - :sep:`|` :aspect:`Condition:` required - :sep:`|` :aspect:`Type:` string - :sep:`|` :aspect:`Default:` null - :sep:`|` - - Which Action should be called when this menu entry is selected. - - -arguments - :sep:`|` :aspect:`Condition:` required - :sep:`|` :aspect:`Type:` array - :sep:`|` :aspect:`Default:` empty array - :sep:`|` - - Parameters to be passed to the Action. - - -Example -======= - -The following menu contains a Select element with two menu entries. Selecting -an entry calls the indicated Action within the indicated Controller. As you can -see, you can either define the menu entry label directly, or (better) through -the use of the `f:translate` ViewHelper. - -:: - - - - - diff --git a/Documentation/Fluid/ViewHelper/Be/Menus/ActionMenuItemGroup.rst b/Documentation/Fluid/ViewHelper/Be/Menus/ActionMenuItemGroup.rst deleted file mode 100644 index eed1222..0000000 --- a/Documentation/Fluid/ViewHelper/Be/Menus/ActionMenuItemGroup.rst +++ /dev/null @@ -1,42 +0,0 @@ -.. include:: ../../../../Includes.txt - -============================== -f:be.menus.actionMenuItemGroup -============================== - -With this ViewHelper it is possible to group some `actionMenuItem` of an -`actionMenu`. - -Properties -========== - -.. rst-class:: dl-parameters - -label - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` string - :sep:`|` :aspect:`Default:` empty string - :sep:`|` - - The name of the group to display in the menu - - -Example -======= - -:: - - - - - - - - - - - - - - - diff --git a/Documentation/Fluid/ViewHelper/Be/Menus/Index.rst b/Documentation/Fluid/ViewHelper/Be/Menus/Index.rst deleted file mode 100644 index 24ab7d1..0000000 --- a/Documentation/Fluid/ViewHelper/Be/Menus/Index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. include:: ../../../../Includes.txt - -ViewHelper: Menus -================= - -**Contents** - -.. toctree:: - :titlesonly: - - ActionMenu - ActionMenuItem - ActionMenuItemGroup diff --git a/Documentation/Fluid/ViewHelper/Be/PageInfo.rst b/Documentation/Fluid/ViewHelper/Be/PageInfo.rst deleted file mode 100644 index d988c0c..0000000 --- a/Documentation/Fluid/ViewHelper/Be/PageInfo.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. include:: ../../../Includes.txt - -f:be.pageInfo -============= - -This ViewHelper provides the icon and the 'pid' of the current page, as known from TYPO3 backend modules. - -Properties ----------- - -This ViewHelper doesn't accept any properties. - -Example -------- - -Page info icon with context menu. - -:: - - diff --git a/Documentation/Fluid/ViewHelper/Be/PagePath.rst b/Documentation/Fluid/ViewHelper/Be/PagePath.rst deleted file mode 100644 index 6033b7b..0000000 --- a/Documentation/Fluid/ViewHelper/Be/PagePath.rst +++ /dev/null @@ -1,22 +0,0 @@ -.. include:: ../../../Includes.txt - -f:be.pagePath -============= - -This ViewHelper displays the path to the currently selected page. This information is most useful in large sites, when -a page is most likely to be found via a search request. In this case, it's often difficult for the site user to orient -themselves and recognize where the current page sits in the page structure. - -Properties ----------- - -This ViewHelper doesn't accept any properties. - -Example -------- - -Current page path, prefixed with "Path:" and wrapped in a span with the class "typo3-docheader-pagePath". - -:: - - diff --git a/Documentation/Fluid/ViewHelper/Be/PageRenderer.rst b/Documentation/Fluid/ViewHelper/Be/PageRenderer.rst deleted file mode 100644 index bf64af4..0000000 --- a/Documentation/Fluid/ViewHelper/Be/PageRenderer.rst +++ /dev/null @@ -1,139 +0,0 @@ -.. include:: ../../../Includes.txt - -================= -f:be.pageRenderer -================= - -The first question you should ask yourself is whether you want to build something using the existing TYPO3 interface, or -build something completely bespoke. If you're making a bespoke interface, then you don't need this ViewHelper at all. -In this event, bind your own JavaScript and CSS assets yourself. - -However, if you want to build Extbase modules using the standard TYPO3 interface, thereby providing a close integration and -compatibility with other modules, then use this ViewHelper. In essence, you only need to use two rows of code and around -ten properties. - -Properties -========== - -.. rst-class:: dl-parameters - -pageTitle - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` string - :sep:`|` :aspect:`Default:` empty string - :sep:`|` - - 'title' tag of the module. Not required by default, as BE modules are shown - in a frame. - - -loadExtJs - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` boolean - :sep:`|` :aspect:`Default:` false - :sep:`|` - - Specifies whether to load ExtJS library. This option will be removed in - TYPO3 v9. - - -loadExtJsTheme - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` boolean - :sep:`|` :aspect:`Default:` true - :sep:`|` - - Whether to load ExtJS "grey" theme. This option will be removed in TYPO3 v9. - - -enableExtJsDebug - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` boolean - :sep:`|` :aspect:`Default:` false - :sep:`|` - - If set to TRUE, the debug version of ExtJS is loaded. Use this for - development only. This option will be removed in TYPO3 v9. - - -loadJQuery - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` boolean - :sep:`|` :aspect:`Default:` false - :sep:`|` - - Whether to load jQuery library. This option will be removed in TYPO3 v9. - - -includeCssFiles - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` array - :sep:`|` :aspect:`Default:` null - :sep:`|` - - List of custom CSS files to be loaded. - - -includeJsFiles - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` array - :sep:`|` :aspect:`Default:` null - :sep:`|` - - List of custom JavaScript files to be loaded. - - -addJsInlineLabels - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` array - :sep:`|` :aspect:`Default:` null - :sep:`|` - - Custom labels to add to JavaScript inline labels. - - -includeRequireJsModules - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` array - :sep:`|` :aspect:`Default:` null - :sep:`|` - - List of RequireJS modules to be loaded. - - -jQueryNamespace - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` string - :sep:`|` :aspect:`Default:` empty string - :sep:`|` - - Store the jQuery object in a specific namespace. This option will be removed - in TYPO3 v9. - - -Examples -======== - -All options ------------ - -Custom CSS file EXT:your_extension/Resources/Public/Css/styles.css and JavaScript files -EXT:your_extension/Resources/Public/JavaScript/Library1.js and EXT:your_extension/Resources/Public/JavaScript/Library2.js -will be loaded, plus ExtJS and jQuery and some inline labels for usage in JS code. - -:: - - - - diff --git a/Documentation/Fluid/ViewHelper/Be/Security/IfAuthenticated.rst b/Documentation/Fluid/ViewHelper/Be/Security/IfAuthenticated.rst deleted file mode 100644 index 806ec4d..0000000 --- a/Documentation/Fluid/ViewHelper/Be/Security/IfAuthenticated.rst +++ /dev/null @@ -1,48 +0,0 @@ -.. include:: ../../../../Includes.txt - -============================= -f:be.security.ifAuthenticated -============================= - -This ViewHelper checks to see whether the current page visitor (backend user) -is authenticated or not. According to the result of the check, the content of -the subsidiary `f:then` or `f:else` ViewHelper will be parsed. - -This feature is predominantly used in the front end of the website: you can -check whether the website visitor is currently authenticated as a backend user. -A good example of a possible use case is for a front end editing tool, which -should only be made available to a validated, logged-in backend user. - -Properties -========== - -This ViewHelper doesn't accept any properties. - - -Examples -======== - -IF->THEN->ELSE --------------- - -:: - - - - You have permission to edit this content. - - - You must log in if you want to edit this content. - - - - -Status-dependent content ------------------------- - -:: - - - You are seeing this message because you are - logged in as a backend user. - diff --git a/Documentation/Fluid/ViewHelper/Be/Security/IfHasRole.rst b/Documentation/Fluid/ViewHelper/Be/Security/IfHasRole.rst deleted file mode 100644 index efacb7f..0000000 --- a/Documentation/Fluid/ViewHelper/Be/Security/IfHasRole.rst +++ /dev/null @@ -1,54 +0,0 @@ -.. include:: ../../../../Includes.txt - -======================= -f:be.security.ifHasRole -======================= - -This ViewHelper checks to see whether a logged-in backend user has been -assigned the indicated role, through use of a user group. The general use is -the same as with the `f:if` ViewHelper: if the check is true, then the code -within the subsidiary `f:then` ViewHelper will be parsed. If not, then the -content of the optional `f:else` ViewHelper will be parsed. - -Properties -========== - -.. rst-class:: dl-parameters - -role - :sep:`|` :aspect:`Condition:` required - :sep:`|` :aspect:`Type:` string - :sep:`|` :aspect:`Default:` null - :sep:`|` - - Either the (case-sensitive) user group name or (preferentially) the user - group UID. - - -Examples -======== - -IF->THEN->ELSE --------------- - -:: - - - - You have permission to edit this content. - - - Only backend users with administration rights - may edit this content. - - - - -Status-dependent content ------------------------- - -:: - - - Welcome, Administrator. - diff --git a/Documentation/Fluid/ViewHelper/Be/Security/Index.rst b/Documentation/Fluid/ViewHelper/Be/Security/Index.rst deleted file mode 100644 index f333e76..0000000 --- a/Documentation/Fluid/ViewHelper/Be/Security/Index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. include:: ../../../../Includes.txt - -==================== -ViewHelper: Security -==================== - -**Contents** - -.. toctree:: - :titlesonly: - - IfAuthenticated - IfHasRole diff --git a/Documentation/Fluid/ViewHelper/Be/TableList.rst b/Documentation/Fluid/ViewHelper/Be/TableList.rst deleted file mode 100644 index 6f5dd90..0000000 --- a/Documentation/Fluid/ViewHelper/Be/TableList.rst +++ /dev/null @@ -1,187 +0,0 @@ -.. include:: ../../../Includes.txt - -============== -f:be.tableList -============== - -A very useful ViewHelper. We can use the familiar view from the Web->List -module and configure it for our own purposes. - -Properties -========== - - -.. rst-class:: dl-parameters - -tableName - :sep:`|` :aspect:`Condition:` required - :sep:`|` :aspect:`Type:` string - :sep:`|` :aspect:`Default:` null - :sep:`|` - - The name of the database table. - -fieldList - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` array - :sep:`|` :aspect:`Default:` null - :sep:`|` - - List of fields to be displayed. If empty, only the title column (configured - in :php:` $TCA[$tableName]['ctrl']['title']`) is shown. - - -storagePid - :sep:`|` :aspect:`Condition:` required - :sep:`|` :aspect:`Type:` integer - :sep:`|` :aspect:`Default:` null - :sep:`|` - - By default, records are fetched from the storage PID configured in - persistence.storagePid. With this argument, the storage PID can be - overwritten. - - -levels - :sep:`|` :aspect:`Condition:` required - :sep:`|` :aspect:`Type:` integer - :sep:`|` :aspect:`Default:` 0 - :sep:`|` - - Corresponds to the level selector of the TYPO3 list module. By default only - records from the current storagePid are fetched. - - -filter - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` string - :sep:`|` :aspect:`Default:` empty string - :sep:`|` - - Corresponds to the "Search String" textbox of the TYPO3 list module. If not - empty, only records matching the string will be fetched. - - -recordsPerPage - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` integer - :sep:`|` :aspect:`Default:` ... \| 100 - :sep:`|` - - The amount of records to be displayed at once. Defaults to - :php:`$TCA[$tableName]['interface']['maxSingleDBListItems']` or (if that's - not set) to 100. - - -sortField - :sep:`|` :aspect:`Condition:` required - :sep:`|` :aspect:`Type:` string - :sep:`|` :aspect:`Default:` empty string - :sep:`|` - - The table field by which the applicable records should be sorted. - - -sortDescending - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` boolean - :sep:`|` :aspect:`Default:` false - :sep:`|` - - If set to TRUE, the records will be sorted in descending order. - - -readOnly - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` boolean - :sep:`|` :aspect:`Default:` false - :sep:`|` - - If set to TRUE, the edit icons won't be shown. Otherwise edit icons will be - shown, if the current BE user has edit rights for the specified table! - - -enableClickMenu - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` boolean - :sep:`|` :aspect:`Default:` true - :sep:`|` - - When active, the context menu will be activated for the view. - - -clickTitleMode - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` string - :sep:`|` :aspect:`Default:` null - :sep:`|` - - A choice of “edit”, “info” or “show”. The mode “show” only applies to - records from the “pages” or ”tt_content” types. Under usual circumstances, - you need to either work using the content menu or an alternative module. - Now, clicking on the record title will be sufficient. - - -Minimal example -=============== - -The following example shows a table containing the header and bodytext fields -of matching tt_content records. The table will only be displayed if there are -records of this type available in the page defined by storagePid. - -All backend modules - at least, those created using the Extension Builder - -come with an extension template which must be bound to the site's root page. -You can then define the page uid in the TypoScript constants as a fallback, in -the event that storagePid isn't defined. (As is the case in this example.) - -:: - - - - -Example: maximum number of records -================================== - -Although we haven't defined recordsPerPage in the following example, only 100 -of more than 150 records will be displayed within the data delivered with the -Introduction Package. This is because where the property recordsPerPage isn't -defined, the value from TCA -(:php:`$TCA[TabellenName]['interface']['maxSingleDBListItems']`) is applicable. -Where this isn't set, then the limit is set to 100. If you need to show more -than 100 records (in this example), use the property recordsPerPage. - -:: - - - - -Example: show records directly -============================== - -You normally need to switch to the Web->View module or navigate via the context -menu to see a preview of a selected record. A much easier option is to link the -title of the record in such a way that clicking on it reveals a preview. This -is where the property clickTitleMode comes into play, when it's set to “show”. -(The following example also contains an example of the use of alternating -background colours.) - -:: - - diff --git a/Documentation/Fluid/ViewHelper/Be/Widget/Index.rst b/Documentation/Fluid/ViewHelper/Be/Widget/Index.rst deleted file mode 100644 index b86561a..0000000 --- a/Documentation/Fluid/ViewHelper/Be/Widget/Index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. include:: ../../../../Includes.txt - -================== -ViewHelper: Widget -================== - -**Contents** - -.. toctree:: - :titlesonly: - - Paginate diff --git a/Documentation/Fluid/ViewHelper/Be/Widget/Paginate.rst b/Documentation/Fluid/ViewHelper/Be/Widget/Paginate.rst deleted file mode 100644 index 845d852..0000000 --- a/Documentation/Fluid/ViewHelper/Be/Widget/Paginate.rst +++ /dev/null @@ -1,84 +0,0 @@ -.. include:: ../../../../Includes.txt - -==================== -f:be.widget.paginate -==================== - -This ViewHelper allows you to split a large amount of data into chunks across -multiple pages, to define the number of records on each page, and to define -where and how the navigation between the pages should appear. - -Properties -========== - -.. rst-class:: dl-parameters - -objects - :sep:`|` :aspect:`Condition:` required - :sep:`|` :aspect:`Type:` QueryResultInterface - :sep:`|` - - Not the result objects themselves, but the object from the Repository which - contains the data needed to reproduce the SQL command. The SQL statement - object and the SQL command aren't allowed here, as Extbase won't be able to - work out how to implement the LIMIT attribute which controls the division of - the data into paginated results. - - -as - :sep:`|` :aspect:`Condition:` required - :sep:`|` :aspect:`Type:` string - :sep:`|` - - The name of the variable in which the reduced object is made available. - - -configuration - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` array - :sep:`|` :aspect:`Default:` See "Configuration of the page navigation" - :sep:`|` - - Configuration of the page navigation - - -Configuration of the page navigation -==================================== - -.. rst-class:: dl-parameters - -itemsPerPage - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` QueryResultInterface - :sep:`|` :aspect:`Default:` 10 - :sep:`|` - - The number of objects which may be associated with each page in the series. - - -insertAbove - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` boolean - :sep:`|` :aspect:`Default:` false - :sep:`|` - - Display the page navigation above the results. - - -insertBelow - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` boolean - :sep:`|` :aspect:`Default:` true - :sep:`|` - - Display the page navigation below the results. - - -recordsLabel - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` string - :sep:`|` :aspect:`Default:` empty string - :sep:`|` - - An optional text to replace the standard descriptor “Records 1 - xy”. - diff --git a/Documentation/Fluid/ViewHelper/CObject.rst b/Documentation/Fluid/ViewHelper/CObject.rst deleted file mode 100644 index 6cd314b..0000000 --- a/Documentation/Fluid/ViewHelper/CObject.rst +++ /dev/null @@ -1,138 +0,0 @@ -.. include:: ../../Includes.txt - -f:cObject -========= - -This ViewHelper provides a connection to TypoScript. Pass in a TypoScript object path (lib.*) and let TypoScript -do the work. - -Properties ----------- - -typoscriptObjectPath -~~~~~~~~~~~~~~~~~~~~ -:aspect:`Variable type` - String - -:aspect:`Description` - The TypoScript object path - -:aspect:`Default value` - -:aspect:`Mandatory` - Yes - -data -~~~~ -:aspect:`Variable type` - Mixed - -:aspect:`Description` - Iterable variable containing values to use inside the object - -:aspect:`Default value` - NULL - -:aspect:`Mandatory` - No - -currentValueKey -~~~~~~~~~~~~~~~ -:aspect:`Variable type` - String - -:aspect:`Description` - Key of the value mapped as current in the data. It will be used when using :ts:`current=1` - -:aspect:`Default value` - NULL - -:aspect:`Mandatory` - No - - -Simple example --------------- - -**TypoScript** - -:: - - lib.fluidText = TEXT - lib.fluidText { - value = Text from TypoScript - } - -**Fluid template** - -:: - -

- -**Output** - -:: - -

Text from TypoScript

- -Example for a localized date value ----------------------------------- - -The `f:format.date` ViewHelper works with the PHP function `date()`, so it can only output English month names. It would -be better if we could use `strftime`: TypoScript provides dates formatted using `strftime`. Here's an example, using the -current date and a German date format. - -**TypoScript** - -:: - - lib.formattedDate = TEXT - lib.formattedDate { - current = 1 - strftime = %d. %B %Y - } - -**Fluid template** - -:: - -

{address.dayOfBirth}

- -**Output** - -:: - -

17. Januar 2013

- -Example with an array or object -------------------------------- - -**TypoScript** - -:: - - lib.address = COA - lib.address { - 10 = TEXT - 10.value.current = 1 - 10.value.wrap =

First name: |

- 20 = TEXT - 20.value.dataWrap =

Full name: {field: firstName} {field: lastName} - } - -**Fluid template** - -:: - - - -**Output** - -:: - -

First name: Stefan

Full name: Stefan Froemken

- -.. tip:: - - As explained above, you can use currentValueKey to define which value should be provided using current=1. You can - access other values from the array using "field", as per the example. diff --git a/Documentation/Fluid/ViewHelper/Case.rst b/Documentation/Fluid/ViewHelper/Case.rst deleted file mode 100644 index 9874795..0000000 --- a/Documentation/Fluid/ViewHelper/Case.rst +++ /dev/null @@ -1,50 +0,0 @@ -.. include:: ../../Includes.txt - -====== -f:case -====== - -This ViewHelper is part of the use case for `f:switch`. Where the value of -this tag matches the value in the `f:switch` tag, the content of this tag -will be rendered and output. - -Properties -========== - -Exclusive properties of this ViewHelper: - - -value ------ - -:aspect:`Variable type` - Mixed - -:aspect:`Description` - The value against which the value from the `f:switch` ViewHelper should be compared. - -:aspect:`Mandatory` - Yes - - -Example -======= - -See the example for the :ref:`viewhelper 'switch' `. - - -Deprecation -=========== - -The usage of this ViewHelper for the default case in the following manner -is deprecated and will be removed in TYPO3 v9. Use `DefaultCaseViewHelper` instead. - -.. highlight:: xml - -Old, deprecated:: - - Foo - -New:: - - Foo diff --git a/Documentation/Fluid/ViewHelper/Comment.rst b/Documentation/Fluid/ViewHelper/Comment.rst deleted file mode 100644 index d4f23a5..0000000 --- a/Documentation/Fluid/ViewHelper/Comment.rst +++ /dev/null @@ -1,39 +0,0 @@ -.. include:: ../../Includes.txt - -f:comment -========= - -Everything inside an `f:comment` ViewHelper will be removed. ViewHelpers within an `f:comment` block will not be executed. -This ViewHelper is most useful when debugging a website: for example, you can temporarily wrap a `f:for` loop with an -`f:comment` ViewHelper to stop it from being executed. - -Properties ----------- - -This ViewHelper has no properties. - -Example -------- - -:: - - -

This text will not be displayed

-

My name is: {address.firstName}

- -

{address.firstName} lives in city xyz

- This text was made by {address.firstName} and will be displayed but not processed.

]]> - -**Output** - -:: - -

Stefan lives in city xyz

-

This text was made by {address.firstName} and will be displayed but not processed.

- -.. tip:: - - The last row in this example is a special case. By using CDATA notation, you can stop the processing of variable - placeholders from being executed. The text will be output, but the placeholder {address.firstName} won't be - replaced. This is most common when working with JavaScript in your template, where you may want to output a - string containing curly quotes. diff --git a/Documentation/Fluid/ViewHelper/Count.rst b/Documentation/Fluid/ViewHelper/Count.rst deleted file mode 100644 index ac298d3..0000000 --- a/Documentation/Fluid/ViewHelper/Count.rst +++ /dev/null @@ -1,81 +0,0 @@ -.. include:: ../../Includes.txt - -f:count -======= - -This ViewHelper counts the elements in the referenced object or array. - -Properties ----------- - -subject -~~~~~~~ -:aspect:`Variable type` - Array - -:aspect:`Description` - Provide the array or object containing the entries to be counted. If this value is empty, the ViewHelper - will attempt to interpret the content between the tags as an array, and then count its entries. - -:aspect:`Default value` - NULL - -:aspect:`Mandatory` - No - - - -.. highlight:: html - - -Example: array as renderChildren --------------------------------- - -:: - -

There are {addresses} records in our database

- -**Output** - -:: - -

There are 23 records in our database

- -Example: array by subject -------------------------- - -:: - -

There are records in our database

- -**Output** - -:: - -

There are 23 records in our database

- -Example: inline notation ------------------------- - -:: - -

There are {f:count(subject: addresses)} records in our database

- -**Output** - -:: - -

There are 23 records in our database

- -Example: better inline notation -------------------------------- - -:: - -

There are {addresses -> f:count()} records in our database

- -**Output** - -:: - -

There are 23 records in our database

diff --git a/Documentation/Fluid/ViewHelper/Cycle.rst b/Documentation/Fluid/ViewHelper/Cycle.rst deleted file mode 100644 index 8aa244f..0000000 --- a/Documentation/Fluid/ViewHelper/Cycle.rst +++ /dev/null @@ -1,76 +0,0 @@ -.. include:: ../../Includes.txt - -f:cycle -======= - -You can improve the output of the `f:for` ViewHelper using `f:cycle`. For example, you can add odd/even classes to a -table row. While you can reach the first and last elements using `f:for`, you'll need to use `f:cycle` to reach any of -the other entries. - -Properties ----------- - -values -~~~~~~ -:aspect:`Variable type` - Array - -:aspect:`Description` - Input in array notation. (See example for details.) - -:aspect:`Default value` - -:aspect:`Mandatory` - Yes - -as -~~ -:aspect:`Variable type` - String - -:aspect:`Description` - The name of the new variable for subsequent use in your template. - -:aspect:`Default value` - -:aspect:`Mandatory` - Yes - -Beispiel --------- - -:: - - - - - - - - - - -
{address.firstName}{address.lastName}
- -**Output** - -:: - - - - - - - - - - - - - - - - - - -
StefanFroemken
BastianKrump
ThorstenPloemi
MaxMustermann
diff --git a/Documentation/Fluid/ViewHelper/Debug.rst b/Documentation/Fluid/ViewHelper/Debug.rst deleted file mode 100644 index 0bb28ee..0000000 --- a/Documentation/Fluid/ViewHelper/Debug.rst +++ /dev/null @@ -1,140 +0,0 @@ -.. include:: ../../Includes.txt - -f:debug -======= - -This ViewHelper allows you to output the value of a variable or a set of variables (e.g. array) to the screen. This can -be helpful when debugging, to make sure that the value of the variable is as you would expect it to be. Individual nested -array or object attributes can be individually expanded. - -Properties ----------- - -title -~~~~~ -:aspect:`Variable type` - String - -:aspect:`Description` - You can use this property to give the debug output a title, so that it can more readily be identified. - (For example, if you're going to output multiple debug blocks during the same request.) - -:aspect:`Default value` - NULL - -:aspect:`Mandatory` - Yes - -maxDepth -~~~~~~~~ -:aspect:`Variable type` - Integer - -:aspect:`Description` - Extremely large arrays or deeply-nested objects can lead to TYPO3 being unable to build a complete view - of the entire structure. By using the 'maxDepth' property, you can adjust the depth of the output to a - maximum of 8 levels, in order to get around this problem. You can fine-tune the value of the property - according to the performance of the server and the maximum processing time available. - -:aspect:`Default value` - 8 - -:aspect:`Mandatory` - No - -plainText -~~~~~~~~~ -:aspect:`Variable type` - Boolean - -:aspect:`Description` - If you're using the CLI mode, using this property will switch the output into plain text mode. - -:aspect:`Default value` - FALSE - -:aspect:`Mandatory` - No - -ansiColors -~~~~~~~~~~ -:aspect:`Variable type` - Boolean - -:aspect:`Description` - Some shell environments allow syntax highlighting - by activating the ansiColors mode, the debug - output will be extended with control characters, so that the shell can implement highlighting. This - option only works when 'plainText' mode is active. - -:aspect:`Default value` - FALSE - -:aspect:`Mandatory` - No - -inline -~~~~~~ -:aspect:`Variable type` - Boolean - -:aspect:`Description` - The debug output usually appears at the top of the page output. By setting this property, the output - will appear at the point where the `f:debug` ViewHelper is inserted in the code. - -:aspect:`Default value` - FALSE - -:aspect:`Mandatory` - No - -blacklistedClassNames -~~~~~~~~~~~~~~~~~~~~~ -:aspect:`Variable type` - Array - -:aspect:`Description` - The use of this property highlights specific classes. It currently (?) doesn't work when Namespaces - are in use. - -:aspect:`Default value` - NULL - -:aspect:`Mandatory` - No - -blacklistedPropertyNames -~~~~~~~~~~~~~~~~~~~~~~~~ -:aspect:`Variable type` - Array - -:aspect:`Description` - The use of this property highlights specific object properties. It currently (?) doesn't work when - Namespaces are in use. - -:aspect:`Default value` - NULL - -:aspect:`Mandatory` - No - -.. tip:: - - Debugging aggregate root objects in earlier versions often lead to problems. Many objects are deeply nested or even - built recursively. This lead in many instances to the system exceeding the memory_limit or max_execution_time in - php.ini. In such cases, it's recommended to only debug a part of the object in question, or to first convert it to - an array. - -Examples --------- - -:: - - {customers} - -:: - - {customers -> f:debug(title: "Results of customers query")} - -:: - - {f:debug(subject: customers, title: "Results of customers query")} diff --git a/Documentation/Fluid/ViewHelper/Debug/Index.rst b/Documentation/Fluid/ViewHelper/Debug/Index.rst deleted file mode 100644 index 230cf8a..0000000 --- a/Documentation/Fluid/ViewHelper/Debug/Index.rst +++ /dev/null @@ -1,107 +0,0 @@ -.. include:: ../../../Includes.txt - -ViewHelper: Debug -================= - -This ViewHelper generates a HTML dump of the tagged variable. - -Properties ----------- - -title -~~~~~ -:aspect:`Variable type` - String - -:aspect:`Description` - An optional custom title for the debug output. - -:aspect:`Default value` - -:aspect:`Mandatory` - No - -maxDepth -~~~~~~~~ -:aspect:`Variable type` - Integer - -:aspect:`Description` - Sets the max recursion depth of the dump. - De- or increase the number according to your needs and memory limit. - -:aspect:`Default value` - 8 - -:aspect:`Mandatory` - No - -plainText -~~~~~~~~~ -:aspect:`Variable type` - Boolean - -:aspect:`Description` - If TRUE, the dump is in plain text, if FALSE the debug output is in HTML format. - -:aspect:`Default value` - FALSE - -:aspect:`Mandatory` - No - -ansiColors -~~~~~~~~~~ -:aspect:`Variable type` - Boolean - -:aspect:`Description` - If TRUE, ANSI color codes are added to the plaintext output, if FALSE the - plaintext debug output is not colored. - -:aspect:`Default value` - FALSE - -:aspect:`Mandatory` - No - -inline -~~~~~~ -:aspect:`Variable type` - Boolean - -:aspect:`Description` - If TRUE, the dump is rendered at the position of the tag. - If FALSE, the dump is displayed at the top of the page. - -:aspect:`Default value` - FALSE - -:aspect:`Mandatory` - No - -blacklistedClassNames -~~~~~~~~~~~~~~~~~~~~~ -:aspect:`Variable type` - Array - -:aspect:`Description` - An array of class names (RegEx) to be filtered. - -:aspect:`Default value` - -:aspect:`Mandatory` - No - -blacklistedPropertyNames -~~~~~~~~~~~~~~~~~~~~~~~~ -:aspect:`Variable type` - Array - -:aspect:`Description` - An array of property names and/or array keys (RegEx) to be filtered. - -:aspect:`Default value` - -:aspect:`Mandatory` - No diff --git a/Documentation/Fluid/ViewHelper/Debug/Render.rst b/Documentation/Fluid/ViewHelper/Debug/Render.rst deleted file mode 100644 index aa72d4d..0000000 --- a/Documentation/Fluid/ViewHelper/Debug/Render.rst +++ /dev/null @@ -1,97 +0,0 @@ -.. include:: ../../../Includes.txt - -f:debug.render -============== - -This ViewHelper contains a debuggable version of f:render. It performs the same rendering operation but wraps the output -with HTML that can be inspected with the admin panel in FE. - -This ViewHelper replaces `f:render` when the admin panel decides (see ViewHelperResolver class). It is also possible to -use explicitly by using `f:debug.render` instead of the normal `f:render` statement. - -Properties ----------- - -section -~~~~~~~ -:aspect:`Variable type` - String - -:aspect:`Description` - Section to render - combine with partial to render section in partial - -:aspect:`Default value` - NULL - -:aspect:`Mandatory` - No - -partial -~~~~~~~ -:aspect:`Variable type` - String - -:aspect:`Description` - Partial to render, with or without section - -:aspect:`Default value` - NULL - -:aspect:`Mandatory` - No - -arguments -~~~~~~~~~ -:aspect:`Variable type` - Array - -:aspect:`Description` - Array of variables to be transferred. Use {_all} for all variables - -:aspect:`Default value` - [] - -:aspect:`Mandatory` - No - -optional -~~~~~~~~ -:aspect:`Variable type` - Boolean - -:aspect:`Description` - If TRUE, considers the *section* optional. Partial never is. - -:aspect:`Default value` - FALSE - -:aspect:`Mandatory` - No - -default -~~~~~~~ -:aspect:`Variable type` - Mixed - -:aspect:`Description` - Value (usually string) to be displayed if the section or partial does not exist - -:aspect:`Default value` - NULL - -:aspect:`Mandatory` - No - -contentAs -~~~~~~~~~ -:aspect:`Variable type` - String - -:aspect:`Description` - If used, renders the child content and adds it as a template variable with this name for use in the partial/section - -:aspect:`Default value` - NULL - -:aspect:`Mandatory` - No diff --git a/Documentation/Fluid/ViewHelper/DefaultCase.rst b/Documentation/Fluid/ViewHelper/DefaultCase.rst deleted file mode 100644 index a467aa3..0000000 --- a/Documentation/Fluid/ViewHelper/DefaultCase.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. include:: ../../Includes.txt - -f:defaultCase -============= - -A view helper which specifies the "default" case when used within the SwitchViewHelper. -Returns the contents of this view helper if no other "Case" view helper of the surrounding switch view helper matches. - -Properties ----------- - -This ViewHelper has no properties. - -Example -------- - -:: - - - Hello Mr. {person.lastName} - Hello Mrs. {person.lastName} - Hello Miss {person.lastName} - A person with no specified gender - diff --git a/Documentation/Fluid/ViewHelper/Else.rst b/Documentation/Fluid/ViewHelper/Else.rst deleted file mode 100644 index 8990c9b..0000000 --- a/Documentation/Fluid/ViewHelper/Else.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. include:: ../../Includes.txt - -f:else -====== - -The use of this ViewHelper is explained in the documentation for `f:if`, as it can only be used within that ViewHelper. - -Properties ----------- - -This ViewHelper has no properties. diff --git a/Documentation/Fluid/ViewHelper/Escape.rst b/Documentation/Fluid/ViewHelper/Escape.rst deleted file mode 100644 index a131ab4..0000000 --- a/Documentation/Fluid/ViewHelper/Escape.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. include:: ../../Includes.txt - -f:escape -======== - -This ViewHelper has been deprecated since Extbase 1.4.0 and it was removed in Extbase version 1.6.0. Please use -the `f:format.*` ViewHelper instead. \ No newline at end of file diff --git a/Documentation/Fluid/ViewHelper/FlashMessages.rst b/Documentation/Fluid/ViewHelper/FlashMessages.rst deleted file mode 100644 index abe28cb..0000000 --- a/Documentation/Fluid/ViewHelper/FlashMessages.rst +++ /dev/null @@ -1,84 +0,0 @@ -.. highlight:: html - -.. _vh-flash-messages: - -=============== -f:flashMessages -=============== - -This viewhelper is for use in extensions you program yourself, as it is -intended to output error messages which are shown to the website user. For -example, a user has forgotten to fill out a required field and the relevant -Action method is connected to a server-side validator. The input is passed to -an errorAction method, which collates each error messages as a 'Flash Message' -in turn, then outputs them all as a “bundle” at the place where you have -inserted this viewhelper. - - -Usage -===== - -Minimal usage: - :: - - - - -All parameters: - :: - - - - -Parameters -========== - -All the :ref:`universal tag attributes ` - -plus - -.. rst-class:: dl-parameters - -queueIdentifier - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` string - :sep:`|` :aspect:`Default:` null - :sep:`|` - - Flash-message queue to use. - - -as - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` string - :sep:`|` :aspect:`Default:` null - :sep:`|` - - The name of the current flashMessage variable for rendering inside. - - -Examples -======== - -Example: Standard Usage ------------------------ - -:: - - - -Example: Self Rendered Template -------------------------------- - -:: - - - -
- - {flashMessage.title}
- -

{flashMessage.message -> f:format.html()}

-
- - diff --git a/Documentation/Fluid/ViewHelper/For.rst b/Documentation/Fluid/ViewHelper/For.rst deleted file mode 100644 index 24dc535..0000000 --- a/Documentation/Fluid/ViewHelper/For.rst +++ /dev/null @@ -1,242 +0,0 @@ -.. include:: ../../Includes.txt -.. highlight:: html - -===== -f:for -===== - -The `f:for` viewhelper is the preferred viewhelper to form loops and lists. - - -Usage -===== - -Minimal usage: - :: - - - ... - - - -All parameters: - :: - - - ... - - - -Parameters -========== - -.. rst-class:: dl-parameters - -each - :sep:`|` :aspect:`Condition:` required - :sep:`|` :aspect:`Type:` array - :sep:`|` :aspect:`Default:` NULL - :sep:`|` - - The **array** or **object** to be iterated. - -as - :sep:`|` :aspect:`Condition:` required - :sep:`|` :aspect:`Type:` string - :sep:`|` :aspect:`Default:` NULL - :sep:`|` - - The **name of the variable** which contains the value - for the current loop iteration. - -key - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` string - :sep:`|` :aspect:`Default:` empty string - :sep:`|` - - The **name of the variable** that contains the key - of the current loop iteration. - -reverse - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` boolean - :sep:`|` :aspect:`Default:` false - :sep:`|` - - A **boolean flag**. Use *true* to reverse the sequence. - - *Examples of true:* `reverse="true"`, `reverse="1"`, `reverse="abc"`. - - *Examples of false:* `reverse="false"`, `reverse="0"`, `reverse=""`. - -iteration - :sep:`|` :aspect:`Condition:` optional - :sep:`|` :aspect:`Type:` string - :sep:`|` :aspect:`Default:` NULL - :sep:`|` - - The **name of a variable** that holds the iteration data of each loop. - - *Example:* `iteration="iterator"`. Iteration data can then be accessed - like `{iterator.index}`, `{iterator.cycle}`, `{iterator.total}`, - `{iterator.isEven}`, `{iterator.isOdd}`, `{iterator.isFirst}`, `{iterator.isLast}`. - - *Attention:* `iterator.cycle` is just a simple counter. It has nothing to - do with the viewhelper `f:cycle`. - -Examples -======== - -Example: Exhaustive usage -------------------------- - -1. Page typoscript template: - - .. code-block:: typoscript - - page = PAGE - page { - 10 = FLUIDTEMPLATE - 10.file = fileadmin/FluidForLoopExample.html - } - -2. Fluid html template in file :file:`fileadmin/FluidForLoopExample.html`:: - -

FluidForLoopExample.html

-
- - -

Legend:
-
01 = employee.first_name -
02 = employee.city -
03 = itemkey -
04 = iterator.index -
05 = iterator.cycle -
06 = iterator.isFirst -
07 = iterator.isLast -
08 = iterator.isOdd -
09 = iterator.isEven -
10 = iterator.total -

- -

reverse = "false"

- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
01020304050607080910
{employee.first_name}{employee.city} {itemkey} {iterator.index} {iterator.cycle} {iterator.isFirst} {iterator.isLast} {iterator.isOdd} {iterator.isEven} {iterator.total}
- - -3. Result for `reverse="false"`: - - .. figure:: For.rst.001.png - :class: with-shadow - - With `reverse="false"` items appear in normal (default) order. - -4. Result for `reverse="true"`: - - .. figure:: For.rst.002.png - :class: with-shadow - - With `reverse="true"` items appear in reversed order. Everything else - remains. - - -Example: Minimum usage ----------------------- - -:: - - - - - - - - - -
{employee.first_name}{employee.city}
- - -This creates a new table row for each of the entries in the 'employee' array. - - -Example: Iterator usage ------------------------ - -:: - - - - - - - - - - - - - {employee.first_name} - {employee.city} - - - - - - - -
List of employees
Iteration beginning with 0: {iterator.index}Iteration beginning with 1: {iterator.cycle}
Number of employees: {iterator.total}
- diff --git a/Documentation/Fluid/ViewHelper/For.rst.001.png b/Documentation/Fluid/ViewHelper/For.rst.001.png deleted file mode 100644 index f22d7ea..0000000 Binary files a/Documentation/Fluid/ViewHelper/For.rst.001.png and /dev/null differ diff --git a/Documentation/Fluid/ViewHelper/For.rst.002.png b/Documentation/Fluid/ViewHelper/For.rst.002.png deleted file mode 100644 index b0e2b9f..0000000 Binary files a/Documentation/Fluid/ViewHelper/For.rst.002.png and /dev/null differ diff --git a/Documentation/Fluid/ViewHelper/Form.rst b/Documentation/Fluid/ViewHelper/Form.rst deleted file mode 100644 index be62aaf..0000000 --- a/Documentation/Fluid/ViewHelper/Form.rst +++ /dev/null @@ -1,401 +0,0 @@ -.. include:: ../../Includes.txt - -f:form -====== - -The `f:form` ViewHelper looks pretty mighty, when you look at how many parameters it takes. But once you realize that 11 -of them generate the form target page, you'll see that there are only a few others remaining. The big advantages of this -ViewHelper are security and a lighter workload. We'll take a look at these in the following examples. - -Properties ----------- - -All the :ref:`universal tag attributes ` - -Global properties of this ViewHelper -#################################### - -enctype -~~~~~~~ -:aspect:`Variable type` - String - -:aspect:`Description` - The format with which the form data should be encoded and submitted. - -:aspect:`Default value` - NULL - -:aspect:`Mandatory` - No - -method -~~~~~~ -:aspect:`Variable type` - String - -:aspect:`Description` - Transfer method - GET or POST. - -:aspect:`Default value` - NULL - -:aspect:`Mandatory` - No - -name -~~~~ -:aspect:`Variable type` - String - -:aspect:`Description` - The HTML 'name' attribute of the form. - -:aspect:`Default value` - NULL - -:aspect:`Mandatory` - No - -onreset -~~~~~~~ -:aspect:`Variable type` - String - -:aspect:`Description` - The JavaScript to be executed when the reset button in the form is clicked. - -:aspect:`Default value` - NULL - -:aspect:`Mandatory` - No - -onsubmit -~~~~~~~~ -:aspect:`Variable type` - String - -:aspect:`Description` - The JavaScript to be executed when the submit button in the form is clicked. - -:aspect:`Default value` - NULL - -:aspect:`Mandatory` - No - -Exclusive properties of this ViewHelper -####################################### - -action -~~~~~~ -:aspect:`Variable type` - String - -:aspect:`Description` - The action method to be called when the form is submitted. - -:aspect:`Default value` - NULL - -:aspect:`Mandatory` - Yes - -arguments -~~~~~~~~~ -:aspect:`Variable type` - Array - -:aspect:`Description` - Additional variables should be sent with each form submission. - -:aspect:`Default value` - Empty array - -:aspect:`Mandatory` - Yes - -controller -~~~~~~~~~~ -:aspect:`Variable type` - String - -:aspect:`Description` - If the action method isn't in the same Controller, then you'll need to specify the appropriate Controller. - -:aspect:`Default value` - NULL - -:aspect:`Mandatory` - Yes - -extensionName -~~~~~~~~~~~~~ -:aspect:`Variable type` - String - -:aspect:`Description` - If the form submission should be handled by a different extension, this property contains the name of - this extension, without the tx\_ prefix and without underline characters. - -:aspect:`Default value` - NULL - -:aspect:`Mandatory` - Yes - -pluginName -~~~~~~~~~~ -:aspect:`Variable type` - String - -:aspect:`Description` - If the form submission should be handled by a different plugin, this property should contain the plugin name. - -:aspect:`Default value` - NULL - -:aspect:`Mandatory` - Yes - -pageUid -~~~~~~~ -:aspect:`Variable type` - Integer - -:aspect:`Description` - Define the page UID if the form submission should be sent to a different page. - -:aspect:`Default value` - NULL - -:aspect:`Mandatory` - Yes - -object -~~~~~~ -:aspect:`Variable type` - Mixed - -:aspect:`Description` - Contains an object with properties which mirror the input fields in the form. - -:aspect:`Default value` - NULL - -:aspect:`Mandatory` - Yes - -pageType -~~~~~~~~ -:aspect:`Variable type` - Integer - -:aspect:`Description` - Use the pageType property to define a non-standard page type to handle the form submission. For example, - where the form submission takes place via AJAX. - -:aspect:`Default value` - 0 - -:aspect:`Mandatory` - Yes - -noCache -~~~~~~~ -:aspect:`Variable type` - Boolean - -:aspect:`Description` - Can be used to completely deactivate the page cache on the target page. - -:aspect:`Default value` - FALSE - -:aspect:`Mandatory` - Yes - -noCacheHash -~~~~~~~~~~~ -:aspect:`Variable type` - Boolean - -:aspect:`Description` - If this property is activated, the link to the target page won't contain a cHash parameter. - -:aspect:`Default value` - FALSE - -:aspect:`Mandatory` - Yes - -section -~~~~~~~ -:aspect:`Variable type` - String - -:aspect:`Description` - Define an anchor on the target page, if the target page contains a large amount of content. The browser - will scroll to the indicated anchor. - -:aspect:`Default value` - Empty string - -:aspect:`Mandatory` - Yes - -format -~~~~~~ -:aspect:`Variable type` - String - -:aspect:`Description` - The required data format to be delivered on the target page - for example, “xml”. This property only takes - effect if 'actionUri' isn't set. - -:aspect:`Default value` - Empty string - -:aspect:`Mandatory` - Yes - -additionalParams -~~~~~~~~~~~~~~~~ -:aspect:`Variable type` - Array - -:aspect:`Description` - Additional variables for the target page. Contrary to 'arguments', these variables won't be prefixed - with the extension name. This property only takes effect if 'actionUri' isn't set. - -:aspect:`Default value` - Empty array - -:aspect:`Mandatory` - Yes - -absolute -~~~~~~~~ -:aspect:`Variable type` - Boolean - -:aspect:`Description` - Upon activation, the domain name and full page path will be prefixed to the form action. This property - only takes effect if 'actionUri' isn't set. - -:aspect:`Default value` - FALSE - -:aspect:`Mandatory` - Yes - -addQueryString -~~~~~~~~~~~~~~ -:aspect:`Variable type` - Boolean - -:aspect:`Description` - This property defines whether query parameters on the page containing the form will be passed on to the - target page. This property only takes effect if 'actionUri' isn't set. - -:aspect:`Default value` - FALSE - -:aspect:`Mandatory` - Yes - -argumentsToBeExcludedFromQueryString -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:aspect:`Variable type` - Array - -:aspect:`Description` - If 'addQueryString' is activated, you can use this property to exclude specific query parameters. This - property only takes effect if 'actionUri' isn't set. - -:aspect:`Default value` - Empty array - -:aspect:`Mandatory` - Yes - -fieldNamePrefix -~~~~~~~~~~~~~~~ -:aspect:`Variable type` - String - -:aspect:`Description` - Use this property if you want to use an alternative string to prefix the form fields. Mainly for use - if the form submission is handled by a different extension. - -:aspect:`Default value` - NULL - -:aspect:`Mandatory` - Yes - -actionUri -~~~~~~~~~ -:aspect:`Variable type` - String - -:aspect:`Description` - Define a specific form action URL. Using this option disables many of the other properties (above). - -:aspect:`Default value` - NULL - -:aspect:`Mandatory` - Yes - -objectName -~~~~~~~~~~ -:aspect:`Variable type` - String - -:aspect:`Description` - An object (Model) name, into which the submitted form data will be saved. This allows the data to be - validated once in the Model, instead of in every individual action method. - -:aspect:`Default value` - NULL - -:aspect:`Mandatory` - Yes - - -Example --------- - -:: - - - - - -…will create (approximately) the following output in the form page HTML. - -:: - -
-
- - - - -
- -
- -If you take a close look at this generated code, you can see the security elements. Fluid builds a hidden section within -the form, which contains a few values: amongst them, an '_hmac' value, which contains a reference to all allowed form -fields. This means that in the event of a website attack, in which specific fields are added or omitted, Extbase can -compare the form data with the _hmac value to see that the form submission is invalid, and stop processing the request -immediately with an error message. - -In the earlier example, we've set the object name “newFeUser”. As you can see, this value is prepended to each field. The -advantage of this is that all of you form fields are bundled together into an array for the target page. Your action can -take this array and port it into a Model object, during which the array entries are validated. (Assuming that the Model -contains the appropriate validation definitions.) The form data will only be accepted into the Model if it can be -validated, after which a simple, single command could store the data in the database. \ No newline at end of file diff --git a/Documentation/Fluid/ViewHelper/Form/AbstractForm.rst b/Documentation/Fluid/ViewHelper/Form/AbstractForm.rst deleted file mode 100644 index 9b5ebe8..0000000 --- a/Documentation/Fluid/ViewHelper/Form/AbstractForm.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. include:: ../../../Includes.txt - -f:form.abstractForm -=================== - -Abstract Form View Helper. Bundles functionality related to direct property access of objects in other Form ViewHelpers. - -If you set the "property" attribute to the name of the property to resolve from the object, this class will -automatically set the name and value of a form element. diff --git a/Documentation/Fluid/ViewHelper/Form/AbstractFormField.rst b/Documentation/Fluid/ViewHelper/Form/AbstractFormField.rst deleted file mode 100644 index 806690d..0000000 --- a/Documentation/Fluid/ViewHelper/Form/AbstractFormField.rst +++ /dev/null @@ -1,54 +0,0 @@ -.. include:: ../../../Includes.txt - -f:form.abstractFormField -======================== - -Abstract Form Field View Helper. Bundles functionality related to direct property access of objects in other Form ViewHelpers. - -If you set the "property" attribute to the name of the property to resolve from the object, this class will -automatically set the name and value of a form element. - -Properties ----------- - -name -~~~~ -:aspect:`Variable type` - String - -:aspect:`Description` - Name of input tag - -:aspect:`Default value` - Empty string - -:aspect:`Mandatory` - No - -value -~~~~~ -:aspect:`Variable type` - Mixed - -:aspect:`Description` - Value of input tag - -:aspect:`Default value` - NULL - -:aspect:`Mandatory` - No - -property -~~~~~~~~ -:aspect:`Variable type` - String - -:aspect:`Description` - Name of Object Property. If used in conjunction with , "name" and "value" properties will be ignored. - -:aspect:`Default value` - Empty string - -:aspect:`Mandatory` - No diff --git a/Documentation/Fluid/ViewHelper/Form/Button.rst b/Documentation/Fluid/ViewHelper/Form/Button.rst deleted file mode 100644 index ebc0891..0000000 --- a/Documentation/Fluid/ViewHelper/Form/Button.rst +++ /dev/null @@ -1,42 +0,0 @@ -.. include:: ../../../Includes.txt - -f:form.button -============= - -This ViewHelper creates a button element in a form, for example the one which allows the form to be submitted. - -Properties ----------- - -All the :ref:`universal tag attributes ` - -All the :ref:`universal form field attributes ` - -Exclusive properties for the HTML-Element -######################################### - -type -~~~~ -:aspect:`Variable type` - String - -:aspect:`Description` - The type of button to create. Allowed options are "button", "reset" and "submit" - -:aspect:`Default value` - NULL - -:aspect:`Mandatory` - No - -Examples --------- - -:: - - Send Mail - - -:: - - Cancel diff --git a/Documentation/Fluid/ViewHelper/Form/Checkbox.rst b/Documentation/Fluid/ViewHelper/Form/Checkbox.rst deleted file mode 100644 index 09cab14..0000000 --- a/Documentation/Fluid/ViewHelper/Form/Checkbox.rst +++ /dev/null @@ -1,205 +0,0 @@ -.. include:: ../../../Includes.txt - -f:form.checkbox -=============== - -This ViewHelper creates a checkbox element for use in an HTML form. - -Properties ----------- - -All the :ref:`universal tag attributes ` - -All the :ref:`universal form field attributes ` - -Exclusive properties for the HTML-Element -######################################### - -disabled -~~~~~~~~ -:aspect:`Variable type` - String - -:aspect:`Description` - Allows the checkbox to appear in an inactive (non-responsive) state. - -:aspect:`Default value` - -:aspect:`Mandatory` - No - -Exclusive properties of this ViewHelper -####################################### - -checked -~~~~~~~ -:aspect:`Variable type` - Boolean - -:aspect:`Description` - When active, the checkbox will appear in a checked (active) state. - -:aspect:`Default value` - NULL - -:aspect:`Mandatory` - No - -multiple -~~~~~~~~ -:aspect:`Variable type` - Boolean - -:aspect:`Description` - Specifies whether the checkbox belongs to a grouped set of multiple checkboxes. - -:aspect:`Default value` - NULL - -:aspect:`Mandatory` - No - - - -Workaround for an invalid Form object -------------------------------------- - -.. tip:: - - The following text was pre-existing at the time of this page's translation to English. It may no longer be - relevant in more up-to-date versions of Fluid/Extbase. - -Checkbox handling is a catastrophe in Fluid/Extbase. It took me quite a bit of time to get checkboxes working, because -their use requires an empty but available Model if they are to be bound to an object by means of a property:: - - No value found for key `Tx_Fluid_ViewHelpers_FormViewHelper->formObject` - -In order to get rid of an error message like this one, you'll need to ensure that the object isn't NULL. You'll need to -create an empty object in the relevant Action. You could achieve this with something like the following: - -:: - - /** - * action new - * - * @param $newCar - * @dontvalidate $newCar - * @return void - */ - public function newAction(\Vendor\Extkey\Domain\Model\Car $newCar = NULL) { - if ($newCar == NULL) { // workaround for fluid bug ##5636 - $newCar = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\Vendor\Extkey\Domain\Model\Car::class); - } - $this->view->assign('newCar', $newCar); - } - -The checkbox will only appear once this amendment is in place. - -Example without a property --------------------------- - -The problem with this method is that you'll have to find out yourself if the checkbox is active or not. You will need -to have already set the values in your Controller, and then apply the state by means of the `checked` attribute. Valid -values at this point are either TRUE (or 1) or FALSE (or 0). - -As this example uses a grouped set of multiple checkboxes, you'll need to add the empty square brackets to the field -name, in order to ensure that the group is maintained and so that the values are submitted as a grouped Array. - -:: - - - - - - -Example with a property ------------------------ - -If you want to avoid the problem above - you should - then bind the checkboxes to an Object property you've defined -in the encompassing `f:form` ViewHelper. Then, your code will look like this.:: - - - - - - -Somewhat more elegant, I'm sure you'll agree. - -Example of grouped checkboxes ------------------------------ - -At the present time, the extension_builder can only create individual checkboxes. This happens when you choose the -field type “Boolean”. If you want to create multiple checkboxes which act together as a group, as in the examples -above, then you'll have to move away from the boolean field type. - -This might be a good point to think about whether your code would be better served by creating a relation to a -separate table, and managing the options for the checkboxes in that table. If not - if you want to simply build a group -of checkboxes directly - then you can save the values together in a single database field. Using a grouped set of -multiple checkboxes will mean that you won't be able to edit the data in the Backend. The Backend doesn't currently -allow for a grouped set of multiple checkboxes. - -When you create your field in the extension_builder, use the field type “Text”. This creates a field in the database -which can store 65,000 individual characters. Don't forget to write the new type to the database, by means of the -Database Analyzer. - -The form will then remain as in the former examples.:: - - yellow
- brown
- blue
- - -Because you can't save an Array directly to the database, you'll have to convert the values which come from the form to -a string. For example, by using the `serialize()` function. The accompanying function `unserialize()` will convert the -values back to an Array when reading the values from the database. Each of these functions can be applied in the -appropriate “getter” and “setter” functions in your Model. :: - - /** - * @var string - */ - protected $colour; - /** - * @return array $colour - */ - public function getColour() { - return unserialize($this->colour); - } - /** - * @param array $colour - * @return void - */ - public function setColour(array $colour) { - $this->colour = serialize($colour); - } - - - -Add a constructor to the Model, too.:: - - /** - * initializes this object - * - * @param string $make - * @param string $description - * @param boolean $accident - * @param array $colour - */ - public function __construct($make = '', $description = '', $accident = false, array $colour = array()) { - $this->setMake($make); - $this->setDescription($description); - $this->setAccident($accident); - $this->setColour($colour); - } - - -Your group will only be converted to a grouped set of multiple checkboxes through the use of this constructor. Take a -look at the generated HTML code.:: - - -
-
-
- - -You can see, by the empty square brackets, that the `colour` field is a grouped set of multiple checkboxes. This also -allows users to edit existing data with no problem at all. diff --git a/Documentation/Fluid/ViewHelper/Form/Hidden.rst b/Documentation/Fluid/ViewHelper/Form/Hidden.rst deleted file mode 100644 index 6d4c9cf..0000000 --- a/Documentation/Fluid/ViewHelper/Form/Hidden.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. include:: ../../../Includes.txt - -f:form.hidden -============= - -This ViewHelper allows you to create a hidden field in an HTML form. It renders an tag. -Such a field can be useful to provide record UIDs in the form, which the website visitor can't see but which are -essential when transmitting the form data to the web server. - -Properties ----------- - -All the :ref:`universal tag attributes ` - -All the :ref:`universal form field attributes ` - -Examples --------- - -:: - - - - -or - -:: - - diff --git a/Documentation/Fluid/ViewHelper/Form/Index.rst b/Documentation/Fluid/ViewHelper/Form/Index.rst deleted file mode 100644 index 7539c80..0000000 --- a/Documentation/Fluid/ViewHelper/Form/Index.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. include:: ../../../Includes.txt - -ViewHelper: Form -================ - -Properties ----------- - -**Table of Contents** - -.. toctree:: - :maxdepth: 5 - :titlesonly: - :glob: - - AbstractForm - AbstractFormField - Button - Checkbox - Hidden - Password - Radio - Select - Select/Index - Submit - Textarea - Textfield - Uploads - ValidationResults \ No newline at end of file diff --git a/Documentation/Fluid/ViewHelper/Form/Password.rst b/Documentation/Fluid/ViewHelper/Form/Password.rst deleted file mode 100644 index 24f8918..0000000 --- a/Documentation/Fluid/ViewHelper/Form/Password.rst +++ /dev/null @@ -1,28 +0,0 @@ -.. include:: ../../../Includes.txt - -f:form.password -=============== - -This ViewHelper allows you to create a field in an HTML form, whose content is optically masked by the browser. (e.g. -the value in the field is replaced by a series of star characters. - -Properties ----------- - -All the :ref:`universal tag attributes ` - -All the :ref:`universal form field attributes ` - -Examples --------- - -:: - - - - -or - -:: - - diff --git a/Documentation/Fluid/ViewHelper/Form/Radio.rst b/Documentation/Fluid/ViewHelper/Form/Radio.rst deleted file mode 100644 index 26a8cac..0000000 --- a/Documentation/Fluid/ViewHelper/Form/Radio.rst +++ /dev/null @@ -1,56 +0,0 @@ -.. include:: ../../../Includes.txt - -f:form.radio -============ - -This ViewHelper allows you to create a radio button element for use in an HTML form. Radio button fields are usually -used in groups, and only a single radio button in a group may be active at one time. A multiple selection - like the one -we see when using checkboxes - isn't possible with radio buttons. - -Properties ----------- - -All the :ref:`universal tag attributes ` - -All the :ref:`universal form field attributes ` - -Exclusive properties for the HTML-Element -######################################### - -checked -~~~~~~~ -:aspect:`Variable type` - Boolean - -:aspect:`Description` - When active, the radio button field will appear in a checked (active) state. - -:aspect:`Default value` - NULL - -:aspect:`Mandatory` - No - -Examples --------- - -:: - - - - - - -Preselect - -:: - - - -Bind to object property - -:: - - - - diff --git a/Documentation/Fluid/ViewHelper/Form/Select.rst b/Documentation/Fluid/ViewHelper/Form/Select.rst deleted file mode 100644 index 177cc6c..0000000 --- a/Documentation/Fluid/ViewHelper/Form/Select.rst +++ /dev/null @@ -1,208 +0,0 @@ -.. include:: ../../../Includes.txt - -f:form.select -============= - -This ViewHelper enables you to create a