Source of file TemplatemapperInterface.php

Size: 1,259 Bytes - Last Modified: 2016-05-18T03:08:27+02:00

buildproject/core/module_system/portal/TemplatemapperInterface.php

12345678910111213141516171819202122232425262728293031323334
<?php
/*"******************************************************************************************************
*   (c) 2004-2006 by MulchProductions, www.mulchprod.de                                                 *
*   (c) 2007-2016 by Kajona, www.kajona.de                                                              *
*       Published under the GNU LGPL v2.1, see /system/licence_lgpl.txt                                 *
*-------------------------------------------------------------------------------------------------------*
*	$Id$                                         *
********************************************************************************************************/

namespace Kajona\System\Portal;

/**
 * Interface to convert a single value to a readable value, printable to a template.
 * Use the annotation @templateMapper in combination with @templateExport to define a mapper
 * to be used,
 *
 * @package module_system
 * @since 4.5
 */
interface TemplatemapperInterface {

    /**
     * Converts the passed value to a formatted value.
     * In most scenarios, the value is written directly to the template.
     *
     * @param mixed $strValue
     *
     * @return string
     */
    public function format($strValue);


}