.. include:: /Includes.rst.txt .. index:: Functions; split .. _split: ===== split ===== This object is used to split the input by a character and then parse the result onto some functions. For each iteration the split index starting with 0 (zero) is stored in the register key :typoscript:`SPLIT_COUNT`. .. contents:: :local: .. index:: split; Properties .. _split-properties: Properties ========== .. _split-token: token ----- .. confval:: token :name: split-token :Data type: :ref:`data-type-string` / :ref:`stdwrap` String or character (token) used to split the value. .. _split-max: max --- .. confval:: max :name: split-max :Data type: :ref:`data-type-integer` / :ref:`stdwrap` Maximum number of splits. .. _split-min: min --- .. confval:: min :name: split-min :Data type: :ref:`data-type-integer` / :ref:`stdwrap` Minimum number of splits. .. _split-returnKey: returnKey --------- .. confval:: returnKey :name: split-returnKey :Data type: :ref:`data-type-integer` / :ref:`stdwrap` Instead of parsing the split result, return the element of the index with this number immediately and stop processing of the split function. .. _split-returnCount: returnCount ----------- .. confval:: returnCount :name: split-returnCount :Data type: :ref:`data-type-boolean` / :ref:`stdwrap` Counts all elements resulting from the split, returns their number and stops processing of the split function. .. rubric:: Example .. code-block:: typoscript :caption: EXT:site_package/Configuration/TypoScript/setup.typoscript # returns 9 1 = TEXT 1 { value = x,y,z,1,2,3,a,b,c split.token = , split.returnCount = 1 } .. _split-cObjNum: cObjNum ------- .. confval:: cObjNum :name: split-cObjNum :Data type: *cObjNum* + :ref:`optionsplit` / :ref:`stdwrap` This is a pointer the array of this object ("1,2,3,4"), that should treat the items, resulting from the split. .. _split-cObject: 1,2,3,4 ------- .. confval:: 1,2,3,4,... :name: split-cObject :Data type: :ref:`cObject ` / :ref:`stdwrap` The object that should treat the value. **Note:** The "current"-value is set to the value of current item, when the objects are called. See :ref:`stdwrap` / current. .. rubric:: Example for stdWrap .. code-block:: typoscript :caption: EXT:site_package/Configuration/TypoScript/setup.typoscript 1.current = 1 1.wrap = | .. rubric:: Example for stdWrap .. code-block:: typoscript :caption: EXT:site_package/Configuration/TypoScript/setup.typoscript 1 { 10 = TEXT 10.stdWrap.current = 1 10.stdWrap.wrap = | } .. _split-wrap: wrap ---- .. confval:: wrap :name: split-wrap :Data type: wrap + :ref:`optionsplit` / :ref:`stdwrap` Defines a wrap for each item. .. _split-examples: Example ======= This is an example of TypoScript code that imports the content of field "bodytext" from the :php:`$cObj->data-array` (ln 3). The content is split by the line break character (ln 5). The items should all be treated with a :typoscript:`stdWrap` (ln 6) which imports the value of the item (ln 7). This value is wrapped in a table row where the first column is a bullet-gif (ln 8). Finally the whole thing is wrapped in the proper table-tags (ln 10). : .. code-block:: typoscript :linenos: 20 = TEXT 20.stdWrap { field = bodytext split { token.char = 10 cObjNum = 1 1.current = 1 1.wrap = | } stdWrap.wrap = |

}