Dojo/View/Helper/Editor.php

Show:

inherited

Classes
- \Zend_Dojo_View_Helper_Editor

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
jump to top

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

 
                EOL
                = "\n"

inherited

EOL character

Inherited from: \Zend_View_Helper_HtmlElement::EOL \Zend_Dojo_View_Helper_Dijit::EOL

Inherited_from: \Zend_View_Helper_HtmlElement::EOL
Inherited_from: \Zend_Dojo_View_Helper_Dijit::EOL

Properties

string $_closingBracket = null

inherited

The tag closing bracket

Inherited from: \Zend_View_Helper_HtmlElement::$$_closingBracket \Zend_Dojo_View_Helper_Dijit::$$_closingBracket

Default valuenullDetails

Type: string
Inherited_from: \Zend_View_Helper_HtmlElement::$$_closingBracket
Inherited_from: \Zend_Dojo_View_Helper_Dijit::$$_closingBracket

string $_dijit = 'dijit.Editor'

Dijit being used

Default value'dijit.Editor'Details

Type: string
$_dijit: string

Dijit type

string $_elementType

inherited

Element type

Inherited from: \Zend_Dojo_View_Helper_Dijit::$$_elementType

Details

Type: string
Inherited_from: \Zend_Dojo_View_Helper_Dijit::$$_elementType

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

JSON-encoded parameters

Default valuearray('captureEvents', 'events', 'plugins', 'extraPlugins')Details

Type: array

string $_module = 'dijit.Editor'

Dojo module to use

Default value'dijit.Editor'Details

Type: string

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

Default value

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'

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

\Zend_Dojo_View_Helper_Dojo_Container $dojo

inherited

Inherited from: \Zend_Dojo_View_Helper_Dijit::$$dojo

Details

Type: \Zend_Dojo_View_Helper_Dojo_Container
Inherited_from: \Zend_Dojo_View_Helper_Dijit::$$dojo

\Zend_View_Interface $view = null

inherited

View object

Inherited from: \Zend_View_Helper_Abstract::$$view \Zend_View_Helper_HtmlElement::$$view \Zend_Dojo_View_Helper_Dijit::$$view

Default valuenullDetails

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

inherited

Cast a boolean to a string value

Inherited from: \Zend_Dojo_View_Helper_Dijit::_castBoolToString()

Parameters

Name	Type	Description
$item	mixed
$key	string

_createDijit(string $dijit, string $id, array $params) : void

inherited

Create a dijit programmatically

Inherited from: \Zend_Dojo_View_Helper_Dijit::_createDijit()

Parameters

Name	Type	Description
$dijit	string
$id	string
$params	array

_createEditorOnSubmit(string $hiddenId, string $editorId) : void

Create onSubmit binding for element

Parameters

Name	Type	Description
$hiddenId	string
$editorId	string

_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

Name	Type	Description
$id	string
$value	string
$params	array
$attribs	array
$dijit	string \| null

Returns

Type	Description
string

_createGetParentFormFunction() : void

inherited

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

inherited

Create a layout container

Inherited from: \Zend_Dojo_View_Helper_Dijit::_createLayoutContainer()

Parameters

Name	Type	Description
$id	int
$content	string
$params	array
$attribs	array
$dijit	string \| null

Returns

Type	Description
string

_getRequiredModules(array $plugins) : array

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

Parameters

Name	Type	Description
$plugins	array	plugins to include

Returns

Type	Description
array

_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

Name	Type	Description
$attribs	array	From this array, each key-value pair is converted to an attribute name and value.

Returns

Type	Description
string	The XHTML for the attributes.

Details

Access: public

_isStrictDoctype() : boolean

inherited

Is doctype strict?

Inherited from: \Zend_View_Helper_HtmlElement::_isStrictDoctype()\Zend_Dojo_View_Helper_Dijit::_isStrictDoctype()

Returns

Type	Description
boolean

_isXhtml() : boolean

inherited

Is doctype XHTML?

Inherited from: \Zend_View_Helper_HtmlElement::_isXhtml()\Zend_Dojo_View_Helper_Dijit::_isXhtml()

Returns

Type	Description
boolean

_normalizeEditorName(string $name) : string

Normalize editor element name

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
string

_normalizeId(string $value) : string

inherited

Normalize an ID

Inherited from: \Zend_View_Helper_HtmlElement::_normalizeId()\Zend_Dojo_View_Helper_Dijit::_normalizeId()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
string

_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

Name	Type	Description
$attribs	array
$params	array
$type	string
$dijit	string	Dijit type to use (otherwise, pull from $_dijit)

Returns

Type	Description
array

_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

Name	Type	Description
$id	string
$value	string \| int \| float

Returns

Type	Description
string

_useDeclarative() : bool

inherited

Whether or not to use declarative dijit creation

Inherited from: \Zend_Dojo_View_Helper_Dijit::_useDeclarative()

Returns

Type	Description
bool

_useProgrammatic() : bool

inherited

Whether or not to use programmatic dijit creation

Inherited from: \Zend_Dojo_View_Helper_Dijit::_useProgrammatic()

Returns

Type	Description
bool

_useProgrammaticNoScript() : bool

inherited

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

Inherited from: \Zend_Dojo_View_Helper_Dijit::_useProgrammaticNoScript()

Returns

Type	Description
bool

direct() : void

inherited

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

Parameters

Name	Type	Description
$id	string
$value	string
$params	array
$attribs	array

Returns

Type	Description
string

getClosingBracket() : string

inherited

Get the tag closing bracket

Inherited from: \Zend_View_Helper_HtmlElement::getClosingBracket()\Zend_Dojo_View_Helper_Dijit::getClosingBracket()

Returns

Type	Description
string

getRootNode() : string

inherited

Get root node type

Inherited from: \Zend_Dojo_View_Helper_Dijit::getRootNode()

Returns

Type	Description
string

setRootNode(string $value) : \Zend_Dojo_View_Helper_Dijit

inherited

Set root node type

Inherited from: \Zend_Dojo_View_Helper_Dijit::setRootNode()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Dojo_View_Helper_Dijit

setView(\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

Name	Type	Description
$view	\Zend_View_Interface

Returns

Type	Description
\Zend_Dojo_View_Helper_Dijit

Dojo/View/Helper/Editor.php

\Zend_Dojo_View_Helper_Editorjump to top

Constants

Properties

Methods

\Zend_Dojo_View_Helper_Editor
jump to top