Dojo/View/Helper/Editor.php

Show: PublicProtectedPrivateinherited
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_Dojo  
Subpackage
View  
Version
$Id: Editor.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Dojo_View_Helper_Editor

Package: Zend\Dojo\View
Dojo Editor dijit
Parent(s)
\Zend_Dojo_View_Helper_Dijit < \Zend_View_Helper_HtmlElement < \Zend_View_Helper_Abstract
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Uses
\global\Zend_Dojo_View_Helper_Textarea  

Constants

Properties

>VPropertyprotectedstring $_closingBracket = null
Default valuenullDetails
Type
string
Inherited_from
\Zend_View_Helper_HtmlElement::$$_closingBracket  
Inherited_from
\Zend_Dojo_View_Helper_Dijit::$$_closingBracket  
>VPropertyprotectedstring $_dijit = 'dijit.Editor'
Dijit being used
Default value'dijit.Editor'Details
Type
string
$_dijit
string

Dijit type

>VPropertyprotectedstring $_elementType
inherited
Element type
Inherited from: \Zend_Dojo_View_Helper_Dijit::$$_elementType
Details
Type
string
Inherited_from
\Zend_Dojo_View_Helper_Dijit::$$_elementType  
>VPropertyprotectedarray $_jsonParams = array('captureEvents', 'events', 'plugins', 'extraPlugins')
JSON-encoded parameters
Default valuearray('captureEvents', 'events', 'plugins', 'extraPlugins')Details
Type
array
>VPropertyprotectedstring $_module = 'dijit.Editor'
Dojo module to use
Default value'dijit.Editor'Details
Type
string
>VPropertyprotectedarray $_pluginsModules = array('createLink' => 'LinkDialog', 'insertImage' => 'LinkDialog', 'fontName' => 'FontChoice', 'fontSize' => 'FontChoice', 'formatBlock' => 'FontChoice', 'foreColor' => 'TextColor', 'hiliteColor' => 'TextColor', 'enterKeyHandling' => 'EnterKeyHandling', 'fullScreen' => 'FullScreen', 'newPage' => 'NewPage', 'print' => 'Print', 'tabIndent' => 'TabIndent', 'toggleDir' => 'ToggleDir', 'viewSource' => 'ViewSource')

Maps non-core plugin to module basename

Default valuearray('createLink' => 'LinkDialog', 'insertImage' => 'LinkDialog', 'fontName' => 'FontChoice', 'fontSize' => 'FontChoice', 'formatBlock' => 'FontChoice', 'foreColor' => 'TextColor', 'hiliteColor' => 'TextColor', 'enterKeyHandling' => 'EnterKeyHandling', 'fullScreen' => 'FullScreen', 'newPage' => 'NewPage', 'print' => 'Print', 'tabIndent' => 'TabIndent', 'toggleDir' => 'ToggleDir', 'viewSource' => 'ViewSource')Details
Type
array
>VPropertyprotectedstring $_rootNode = 'div'
inherited
Root node element type for layout elements
Inherited from: \Zend_Dojo_View_Helper_Dijit::$$_rootNode
Default value'div'Details
Type
string
Inherited_from
\Zend_Dojo_View_Helper_Dijit::$$_rootNode  
>VPropertypublic\Zend_Dojo_View_Helper_Dojo_Container $dojo
inherited
Inherited from: \Zend_Dojo_View_Helper_Dijit::$$dojo

Methods

methodprotected_castBoolToString(mixed $item, string $key) : void
inherited

Cast a boolean to a string value

Inherited from: \Zend_Dojo_View_Helper_Dijit::_castBoolToString()
Parameters
NameTypeDescription
$itemmixed
$keystring
methodprotected_createDijit(string $dijit, string $id, array $params) : void
inherited

Create a dijit programmatically

Inherited from: \Zend_Dojo_View_Helper_Dijit::_createDijit()
Parameters
NameTypeDescription
$dijitstring
$idstring
$paramsarray
methodprotected_createEditorOnSubmit(string $hiddenId, string $editorId) : void

Create onSubmit binding for element

Parameters
NameTypeDescription
$hiddenIdstring
$editorIdstring
methodpublic_createFormElement(string $id, string $value, array $params, array $attribs, string | null $dijit = null) : string
inherited

Create HTML representation of a dijit form element

Inherited from: \Zend_Dojo_View_Helper_Dijit::_createFormElement()
Parameters
NameTypeDescription
$idstring
$valuestring
$paramsarray
$attribsarray
$dijitstring | null
Returns
TypeDescription
string
methodprotected_createGetParentFormFunction() : void
inherited

Create JS function for retrieving parent form

Inherited from: \Zend_Dojo_View_Helper_Dijit::_createGetParentFormFunction()
methodprotected_createLayoutContainer(int $id, string $content, array $params, array $attribs, string | null $dijit = null) : string
inherited

Create a layout container

Inherited from: \Zend_Dojo_View_Helper_Dijit::_createLayoutContainer()
Parameters
NameTypeDescription
$idint
$contentstring
$paramsarray
$attribsarray
$dijitstring | null
Returns
TypeDescription
string
methodprotected_getRequiredModules(array $plugins) : array

Generates the list of required modules to include, if any is needed.

Parameters
NameTypeDescription
$pluginsarray

plugins to include

Returns
TypeDescription
array
methodprotected_htmlAttribs(array $attribs) : string
inherited

Converts an associative array to a string of tag attributes.

Inherited from: \Zend_View_Helper_HtmlElement::_htmlAttribs()\Zend_Dojo_View_Helper_Dijit::_htmlAttribs()
Parameters
NameTypeDescription
$attribsarray

From this array, each key-value pair is converted to an attribute name and value.

Returns
TypeDescription
stringThe XHTML for the attributes.
Details
Access
public  
methodprotected_isStrictDoctype() : boolean
Returns
TypeDescription
boolean
methodprotected_isXhtml() : boolean
Returns
TypeDescription
boolean
methodprotected_normalizeEditorName(string $name) : string

Normalize editor element name

Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
string
methodprotected_normalizeId(string $value) : string
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
string
methodprotected_prepareDijit(array $attribs, array $params, string $type, string $dijit = null) : array
inherited

Merge attributes and parameters

Inherited from: \Zend_Dojo_View_Helper_Dijit::_prepareDijit()

Also sets up requires

Parameters
NameTypeDescription
$attribsarray
$paramsarray
$typestring
$dijitstring

Dijit type to use (otherwise, pull from $_dijit)

Returns
TypeDescription
array
methodprotected_renderHiddenElement(string $id, string | int | float $value) : string
inherited

Render a hidden element to hold a value

Inherited from: \Zend_Dojo_View_Helper_Dijit::_renderHiddenElement()
Parameters
NameTypeDescription
$idstring
$valuestring | int | float
Returns
TypeDescription
string
methodprotected_useDeclarative() : bool
inherited

Whether or not to use declarative dijit creation

Inherited from: \Zend_Dojo_View_Helper_Dijit::_useDeclarative()
Returns
TypeDescription
bool
methodprotected_useProgrammatic() : bool
inherited

Whether or not to use programmatic dijit creation

Inherited from: \Zend_Dojo_View_Helper_Dijit::_useProgrammatic()
Returns
TypeDescription
bool
methodprotected_useProgrammaticNoScript() : bool
inherited

Whether or not to use programmatic dijit creation w/o script creation

Inherited from: \Zend_Dojo_View_Helper_Dijit::_useProgrammaticNoScript()
Returns
TypeDescription
bool
methodpublicdirect() : void
methodpubliceditor(string $id, string $value = null, array $params = array(), array $attribs = array()) : string

dijit.Editor

Parameters
NameTypeDescription
$idstring
$valuestring
$paramsarray
$attribsarray
Returns
TypeDescription
string
methodpublicgetClosingBracket() : string
Returns
TypeDescription
string
methodpublicgetRootNode() : string
inherited

Get root node type

Inherited from: \Zend_Dojo_View_Helper_Dijit::getRootNode()
Returns
TypeDescription
string
methodpublicsetRootNode(string $value) : \Zend_Dojo_View_Helper_Dijit
inherited

Set root node type

Inherited from: \Zend_Dojo_View_Helper_Dijit::setRootNode()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Dojo_View_Helper_Dijit
methodpublicsetView(\Zend_View_Interface $view) : \Zend_Dojo_View_Helper_Dijit
inherited

Set view

Inherited from: \Zend_Dojo_View_Helper_Dijit::setView()

Set view and enable dojo

Parameters
NameTypeDescription
$view\Zend_View_Interface
Returns
TypeDescription
\Zend_Dojo_View_Helper_Dijit
Documentation was generated by phpDocumentor 2.0.0a12.