API Documentation

ZendX/JQuery/Form/Element/UiWidget.php

Includes |Classes |

Properties

Description

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.


Includes

Zend/Form/Element.php (Require Once)

Classes

ZendX_JQuery_Form_Element_UiWidget

Properties

 
 
Form  
No 
No 

Description

Base Form Element for jQuery View Helpers

Methods

__construct, getDecorators, getJQueryParam, getJQueryParams, loadDefaultDecorators, setJQueryParam, setJQueryParams, setView,

__construct( mixed   $spec, mixed   $options = null, ) : void

Description

Constructor

Arguments

Name Type Description Default
$spec mixed |
$options mixed | null

Return value

Type Description
void

getDecorators( ) : array

Description

Retrieve all decorators

Return value

Type Description
array

Tags

Name Description
throws ZendX_JQuery_Form_Exception

getJQueryParam( string   $key, ) : string

Description

Get jQuery related parameter of this form element

Arguments

Name Type Description Default
$key string |

Return value

Type Description
string

getJQueryParams( ) : array

Description

Get all currently known jQuery related parameters of this element

Return value

Type Description
array

loadDefaultDecorators( ) : void

Description

Load default decorators

Return value

Type Description
void

setJQueryParam( string   $key, string   $value, ) : ZendX_JQuery_Form_Element_UiWidget

Description

Set a jQuery related parameter of this form element.

Arguments

Name Type Description Default
$key string |
$value string |

Return value

Type Description
ZendX_JQuery_Form_Element_UiWidget

setJQueryParams( Array   $params, ) : ZendX_JQuery_Form_Element_UiWidget

Description

Set an array of jQuery related options for this element (merging with old options).

Arguments

Name Type Description Default
$params Array |

Return value

Type Description
ZendX_JQuery_Form_Element_UiWidget

setView( Zend_View_Interface   $view = null, ) : ZendX_JQuery_Form_Element_UiWidget

Description

Set the view object

Ensures that the view object has the jQuery view helper path set.


Arguments

Name Type Description Default
$view Zend_View_Interface | null

Return value

Type Description
ZendX_JQuery_Form_Element_UiWidget

Properties

$jQueryParams, $options,

  public  $jQueryParams = array

jQuery related parameters of this form element.array


  public  $options = array

Just here to prevent errors.array


Documentation was generated by DocBlox.