Dojo/View/Helper/Editor.php
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
- 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

EOL
= "\n"
- Inherited_from
- \Zend_View_Helper_HtmlElement::EOL
- Inherited_from
- \Zend_Dojo_View_Helper_Dijit::EOL
Properties


string $_closingBracket = null
null
Details- Type
- string
- Inherited_from
- \Zend_View_Helper_HtmlElement::$$_closingBracket
- Inherited_from
- \Zend_Dojo_View_Helper_Dijit::$$_closingBracket


string $_dijit = 'dijit.Editor'
'dijit.Editor'
Details- Type
- string
- $_dijit
- string
Dijit type


array $_jsonParams = array('captureEvents', 'events', 'plugins', 'extraPlugins')
array('captureEvents', 'events', 'plugins', 'extraPlugins')
Details- Type
- array


array $_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
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')
Details- Type
- array


string $_rootNode = 'div'
'div'
Details- Type
- string
- Inherited_from
- \Zend_Dojo_View_Helper_Dijit::$$_rootNode


\Zend_Dojo_View_Helper_Dojo_Container $dojo


\Zend_View_Interface $view = null
null
Details- Type
- \Zend_View_Interface
- Inherited_from
- \Zend_View_Helper_Abstract::$$view
- Inherited_from
- \Zend_View_Helper_HtmlElement::$$view
- Inherited_from
- \Zend_Dojo_View_Helper_Dijit::$$view
Methods


_castBoolToString(mixed $item, string $key) : void
Cast a boolean to a string value
Inherited from: \Zend_Dojo_View_Helper_Dijit::_castBoolToString()Name | Type | Description |
---|---|---|
$item | mixed | |
$key | string |


_createDijit(string $dijit, string $id, array $params) : void
Create a dijit programmatically
Inherited from: \Zend_Dojo_View_Helper_Dijit::_createDijit()Name | Type | Description |
---|---|---|
$dijit | string | |
$id | string | |
$params | array |


_createEditorOnSubmit(string $hiddenId, string $editorId) : void
Create onSubmit binding for element
Name | Type | Description |
---|---|---|
$hiddenId | string | |
$editorId | string |


_createFormElement(string $id, string $value, array $params, array $attribs, string | null $dijit = null) : string
Create HTML representation of a dijit form element
Inherited from: \Zend_Dojo_View_Helper_Dijit::_createFormElement()Name | Type | Description |
---|---|---|
$id | string | |
$value | string | |
$params | array | |
$attribs | array | |
$dijit | string | null |
Type | Description |
---|---|
string |


_createGetParentFormFunction() : void
Create JS function for retrieving parent form
Inherited from: \Zend_Dojo_View_Helper_Dijit::_createGetParentFormFunction()

_createLayoutContainer(int $id, string $content, array $params, array $attribs, string | null $dijit = null) : string
Create a layout container
Inherited from: \Zend_Dojo_View_Helper_Dijit::_createLayoutContainer()Name | Type | Description |
---|---|---|
$id | int | |
$content | string | |
$params | array | |
$attribs | array | |
$dijit | string | null |
Type | Description |
---|---|
string |


_getRequiredModules(array $plugins) : array
Generates the list of required modules to include, if any is needed.
Name | Type | Description |
---|---|---|
$plugins | array | plugins to include |
Type | Description |
---|---|
array |


_htmlAttribs(array $attribs) : string
Converts an associative array to a string of tag attributes.
Inherited from: \Zend_View_Helper_HtmlElement::_htmlAttribs()\Zend_Dojo_View_Helper_Dijit::_htmlAttribs()Name | Type | Description |
---|---|---|
$attribs | array | From this array, each key-value pair is converted to an attribute name and value. |
Type | Description |
---|---|
string | The XHTML for the attributes. |
- Access
- public


_isStrictDoctype() : boolean
Is doctype strict?
Inherited from: \Zend_View_Helper_HtmlElement::_isStrictDoctype()\Zend_Dojo_View_Helper_Dijit::_isStrictDoctype()Type | Description |
---|---|
boolean |


_isXhtml() : boolean
Is doctype XHTML?
Inherited from: \Zend_View_Helper_HtmlElement::_isXhtml()\Zend_Dojo_View_Helper_Dijit::_isXhtml()Type | Description |
---|---|
boolean |


_normalizeEditorName(string $name) : string
Normalize editor element name
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
string |


_normalizeId(string $value) : string
Normalize an ID
Inherited from: \Zend_View_Helper_HtmlElement::_normalizeId()\Zend_Dojo_View_Helper_Dijit::_normalizeId()Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
string |


_prepareDijit(array $attribs, array $params, string $type, string $dijit = null) : array
Merge attributes and parameters
Inherited from: \Zend_Dojo_View_Helper_Dijit::_prepareDijit()Also sets up requires
Name | Type | Description |
---|---|---|
$attribs | array | |
$params | array | |
$type | string | |
$dijit | string | Dijit type to use (otherwise, pull from $_dijit) |
Type | Description |
---|---|
array |


_renderHiddenElement(string $id, string | int | float $value) : string
Render a hidden element to hold a value
Inherited from: \Zend_Dojo_View_Helper_Dijit::_renderHiddenElement()Name | Type | Description |
---|---|---|
$id | string | |
$value | string | int | float |
Type | Description |
---|---|
string |


_useDeclarative() : bool
Whether or not to use declarative dijit creation
Inherited from: \Zend_Dojo_View_Helper_Dijit::_useDeclarative()Type | Description |
---|---|
bool |


_useProgrammatic() : bool
Whether or not to use programmatic dijit creation
Inherited from: \Zend_Dojo_View_Helper_Dijit::_useProgrammatic()Type | Description |
---|---|
bool |


_useProgrammaticNoScript() : bool
Whether or not to use programmatic dijit creation w/o script creation
Inherited from: \Zend_Dojo_View_Helper_Dijit::_useProgrammaticNoScript()Type | Description |
---|---|
bool |


direct() : void
Strategy pattern: currently unutilized
Inherited from: \Zend_View_Helper_Abstract::direct()\Zend_View_Helper_HtmlElement::direct()\Zend_Dojo_View_Helper_Dijit::direct()

editor(string $id, string $value = null, array $params = array(), array $attribs = array()) : string
dijit.Editor
Name | Type | Description |
---|---|---|
$id | string | |
$value | string | |
$params | array | |
$attribs | array |
Type | Description |
---|---|
string |


getClosingBracket() : string
Get the tag closing bracket
Inherited from: \Zend_View_Helper_HtmlElement::getClosingBracket()\Zend_Dojo_View_Helper_Dijit::getClosingBracket()Type | Description |
---|---|
string |


setRootNode(string $value) : \Zend_Dojo_View_Helper_Dijit
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Dojo_View_Helper_Dijit |


setView(\Zend_View_Interface $view) : \Zend_Dojo_View_Helper_Dijit
Set view and enable dojo
Name | Type | Description |
---|---|---|
$view | \Zend_View_Interface |
Type | Description |
---|---|
\Zend_Dojo_View_Helper_Dijit |