API Documentation

Form/Decorator/Callback.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Form  
subpackage
Decorator  

\Zend_Form_Decorator_Callback

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.

Extends from
\Zend_Form_Decorator_Abstract
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Form  
subpackage
Decorator  
version
$Id: Callback.php 23775 2011-03-01 17:25:24Z ralph $  

Properties

Propertyprotectedstring|array  $_callback= ''

Callback

Details
Type
stringarray

Methods

methodpublic__construct( array|\Zend_Config $options = null ) : void

Constructor

Inherited from: \Zend_Form_Decorator_Abstract::__construct()

Accept options during initialization.

Parameters
Name Type Description
$options array|\Zend_Config
methodpublicclearOptions( ) : \Zend_Form_Decorator_Abstract

Clear all options

Inherited from: \Zend_Form_Decorator_Abstract::clearOptions()
Returns
Type Description
\Zend_Form_Decorator_Abstract
methodpublicgetCallback( ) : null|string|array

Get registered callback

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

Returns
Type Description
nullstringarray
methodpublicgetElement( ) : \Zend_Form_Element|\Zend_Form

Retrieve current element

Inherited from: \Zend_Form_Decorator_Abstract::getElement()
Returns
Type Description
\Zend_Form_Element\Zend_Form
methodpublicgetOption( string $key ) : mixed

Get option

Inherited from: \Zend_Form_Decorator_Abstract::getOption()
Parameters
Name Type Description
$key string
Returns
Type Description
mixed
methodpublicgetOptions( ) : array

Retrieve options

Inherited from: \Zend_Form_Decorator_Abstract::getOptions()
Returns
Type Description
array
methodpublicgetPlacement( ) : string

Determine if decorator should append or prepend content

Inherited from: \Zend_Form_Decorator_Abstract::getPlacement()
Returns
Type Description
string
methodpublicgetSeparator( ) : string

Retrieve separator to use between old and new content

Inherited from: \Zend_Form_Decorator_Abstract::getSeparator()
Returns
Type Description
string
methodpublicremoveOption( mixed $key ) : void

Remove single option

Inherited from: \Zend_Form_Decorator_Abstract::removeOption()
Parameters
Name Type Description
$key mixed
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
Throws
Exception Description
\Zend_Form_Decorator_Exception when unimplemented
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
methodpublicsetConfig( \Zend_Config $config ) : \Zend_Form_Decorator_Abstract

Set options from config object

Inherited from: \Zend_Form_Decorator_Abstract::setConfig()
Parameters
Name Type Description
$config \Zend_Config
Returns
Type Description
\Zend_Form_Decorator_Abstract
methodpublicsetElement( \Zend_Form_Element|\Zend_Form $element ) : \Zend_Form_Decorator_Abstract

Set current form element

Inherited from: \Zend_Form_Decorator_Abstract::setElement()

While the name is "setElement", a form decorator could decorate either an element or a form object.

Parameters
Name Type Description
$element \Zend_Form_Element|\Zend_Form
Returns
Type Description
\Zend_Form_Decorator_Abstract
Throws
Exception Description
\Zend_Form_Decorator_Exception on invalid element type
methodpublicsetOption( string $key, mixed $value ) : \Zend_Form_Decorator_Abstract

Set option

Inherited from: \Zend_Form_Decorator_Abstract::setOption()
Parameters
Name Type Description
$key string
$value mixed
Returns
Type Description
\Zend_Form_Decorator_Abstract
methodpublicsetOptions( array $options ) : \Zend_Form_Decorator_Abstract

Set options

Inherited from: \Zend_Form_Decorator_Abstract::setOptions()
Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_Form_Decorator_Abstract
Documentation was generated by DocBlox 0.13.3.