API Documentation

Zend/Form/Decorator/Callback.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Form  
Subpackage
Decorator  

\Zend_Form_Decorator_Callback

Package: Zend\Form\Decorator

Zend_Form_Decorator_Callback

Execute an arbitrary callback to decorate an element. Callbacks should take three arguments, $content, $element, and $options:

function mycallback($content, $element, array $options) { }

and should return a string. ($options are whatever options were provided to the decorator.)

To specify a callback, pass a valid callback as the 'callback' option.

Callback results will be either appended, prepended, or replace the provided content. To replace the content, specify a placement of boolean false; defaults to append content.

Parent(s)
\Zend_Form_Decorator_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Version
$Id: Callback.php 24594 2012-01-05 21:27:01Z matthew $  

Properties

Propertyprotectedstring|array  $_callback= ''

Callback

Details
Type
stringarray

Methods

methodpublicgetCallback( ) : null|string|array

Get registered callback

If not previously registered, checks to see if it exists in registered options.

Returns
Type Description
null|string|array
methodpublicrender( string $content ) : string

Render

If no callback registered, returns callback. Otherwise, gets return value of callback and either appends, prepends, or replaces passed in content.

Parameters
Name Type Description
$content string
Returns
Type Description
string
methodpublicsetCallback( callback $callback ) : \Zend_Form_Decorator_Callback

Set callback

Parameters
Name Type Description
$callback callback
Returns
Type Description
\Zend_Form_Decorator_Callback
Throws
Exception Description
\Zend_Form_Exception
Documentation was generated by DocBlox 0.15.1.