Home Info Files

Zend Framework 2 Documentation (Manual)

File: /_sources/modules/zend.filter.word.underscore-to-separator.txt

.. _zend.filter.set.underscoretoseparator:

UnderscoreToSeparator
---------------------

This filter modifies a given string such that 'words_with_underscores' are converted to 'words with underscores'.

.. _zend.filter.set.underscoretoseparator.options:

Supported Options
^^^^^^^^^^^^^^^^^

The following options are supported for ``Zend\Filter\Word\UnderscoreToSeparator``:

- **separator**: A separator char. If this is not set the separator will be a space character.

.. _zend.filter.set.underscoretoseparator.basic:

Basic usage
^^^^^^^^^^^

A basic example of usage is below:

.. code-block:: php
   :linenos:

   $filter = new Zend\Filter\Word\UnderscoreToSeparator('+');
   // or new Zend\Filter\Word\CamelCaseToSeparator(array('separator' => '+'));

   print $filter->filter('this_is_my_content');

The above example returns 'this+is+my+content'.

.. _zend.filter.set.underscoretoseparator.default-behavior:

Default Behavior
^^^^^^^^^^^^^^^^

.. code-block:: php
   :linenos:

   $filter = new Zend\Filter\Word\UnderscoreToSeparator();

   print $filter->filter('this_is_my_content');

The above example returns 'this is my content'.