.. include:: ../../../../Includes.txt

.. _typo3-fluid-format-padding:

==============
format.padding
==============


Formats a string using PHPs str_pad function.

Examples
========

Defaults::

   <f:format.padding padLength="10">TYPO3</f:format.padding>

Output::

   TYPO3     (note the trailing whitespace)

Specify padding string::

   <f:format.padding padLength="10" padString="-=">TYPO3</f:format.padding>

Output::

   TYPO3-=-=-

Specify padding type::

   <f:format.padding padLength="10" padString="-" padType="both">TYPO3</f:format.padding>

Output::

   --TYPO3---

Arguments
=========


.. _format.padding_value:
value
-----

:aspect:`DataType`
   string

:aspect:`Required`
   true
:aspect:`Description`
   String to format

.. _format.padding_padlength:
padLength
---------

:aspect:`DataType`
   mixed

:aspect:`Required`
   true
:aspect:`Description`
   Length of the resulting string. If the value of pad_length is negative or less than the length of the input string, no padding takes place.

.. _format.padding_padstring:
padString
---------

:aspect:`DataType`
   string

:aspect:`Default`
   ' '

:aspect:`Required`
   true
:aspect:`Description`
   The padding string

.. _format.padding_padtype:
padType
-------

:aspect:`DataType`
   string

:aspect:`Default`
   'right'

:aspect:`Required`
   true
:aspect:`Description`
   Append the padding at this site (Possible values: right,left,both. Default: right)