HTML_QuickForm2
[ class tree: HTML_QuickForm2 ] [ index: HTML_QuickForm2 ] [ all elements ]
Packages:
HTML_QuickForm2


Classes:
HTML_QuickForm2
HTML_QuickForm2_Container
HTML_QuickForm2_ContainerIterator
HTML_QuickForm2_Container_Fieldset
HTML_QuickForm2_Container_Group
HTML_QuickForm2_DataSource_Array
HTML_QuickForm2_DataSource_SuperGlobal
HTML_QuickForm2_Element
HTML_QuickForm2_Element_Button
HTML_QuickForm2_Element_Input
HTML_QuickForm2_Element_InputButton
HTML_QuickForm2_Element_InputCheckable
HTML_QuickForm2_Element_InputCheckbox
HTML_QuickForm2_Element_InputFile
HTML_QuickForm2_Element_InputHidden
HTML_QuickForm2_Element_InputImage
HTML_QuickForm2_Element_InputPassword
HTML_QuickForm2_Element_InputRadio
HTML_QuickForm2_Element_InputReset
HTML_QuickForm2_Element_InputSubmit
HTML_QuickForm2_Element_InputText
HTML_QuickForm2_Element_Select
HTML_QuickForm2_Element_Select_Optgroup
HTML_QuickForm2_Element_Select_OptionContainer
HTML_QuickForm2_Element_Select_OptionIterator
HTML_QuickForm2_Element_Textarea
HTML_QuickForm2_Exception
HTML_QuickForm2_Factory
HTML_QuickForm2_InvalidArgumentException
HTML_QuickForm2_Loader
HTML_QuickForm2_Node
HTML_QuickForm2_NotFoundException
HTML_QuickForm2_Renderer
HTML_QuickForm2_Renderer_Array
HTML_QuickForm2_Renderer_Default
HTML_QuickForm2_Renderer_Plugin
HTML_QuickForm2_Renderer_Proxy
HTML_QuickForm2_Rule
HTML_QuickForm2_Rule_Callback
HTML_QuickForm2_Rule_Compare
HTML_QuickForm2_Rule_Empty
HTML_QuickForm2_Rule_Length
HTML_QuickForm2_Rule_MaxFileSize
HTML_QuickForm2_Rule_MimeType
HTML_QuickForm2_Rule_Nonempty
HTML_QuickForm2_Rule_Regex
HTML_QuickForm2_Rule_Required
HTML_QuickForm2
   HTML_QuickForm2_Element_DualSelect
   HTML_QuickForm2_Renderer_Default_DualSelectPlugin
Files:
Array.php
Array.php
basic-elements.php
builtin-rules.php
Button.php
Callback.php
Compare.php
Container.php
DataSource.php
default-renderer.php
Default.php
dualselect.php
Element.php
Empty.php
Exception.php
Factory.php
Fieldset.php
Group.php
Input.php
InputButton.php
InputCheckable.php
InputCheckbox.php
InputFile.php
InputHidden.php
InputImage.php
InputPassword.php
InputRadio.php
InputReset.php
InputSubmit.php
InputText.php
Length.php
Loader.php
MaxFileSize.php
MimeType.php
Node.php
Nonempty.php
Plugin.php
Proxy.php
QuickForm2.php
Regex.php
Renderer.php
Required.php
Rule.php
Select.php
Submit.php
SuperGlobal.php
Textarea.php

Class: HTML_QuickForm2_Renderer_Proxy

Source Location: /HTML_QuickForm2-0.3.0/QuickForm2/Renderer/Proxy.php

Class Overview

HTML_QuickForm2_Renderer
   |
   --HTML_QuickForm2_Renderer_Proxy

Proxy class for HTML_QuickForm2 renderers and their plugins


Author(s):

Version:

  • Release: 0.3.0

Methods

Inherited Variables

Class: HTML_QuickForm2_Renderer

HTML_QuickForm2_Renderer::$options

Inherited Methods

Class: HTML_QuickForm2_Renderer

HTML_QuickForm2_Renderer::__construct()
Constructor
HTML_QuickForm2_Renderer::exportMethods()
Returns an array of "published" method names that should be callable through proxy
HTML_QuickForm2_Renderer::factory()
Creates a new renderer instance of the given type
HTML_QuickForm2_Renderer::finishContainer()
Finishes rendering a generic container, called after processing contained elements
HTML_QuickForm2_Renderer::finishForm()
Finishes rendering a form, called after processing contained elements
HTML_QuickForm2_Renderer::finishGroup()
Finishes rendering a group, called after processing grouped elements
HTML_QuickForm2_Renderer::getOption()
Returns the value(s) of the renderer option(s)
HTML_QuickForm2_Renderer::register()
Registers a new renderer type
HTML_QuickForm2_Renderer::registerPlugin()
Registers a plugin for a renderer type
HTML_QuickForm2_Renderer::renderElement()
Renders a generic element
HTML_QuickForm2_Renderer::renderHidden()
Renders a hidden element
HTML_QuickForm2_Renderer::setOption()
Sets the option(s) affecting renderer behaviour
HTML_QuickForm2_Renderer::startContainer()
Starts rendering a generic container, called before processing contained elements
HTML_QuickForm2_Renderer::startForm()
Starts rendering a form, called before processing contained elements
HTML_QuickForm2_Renderer::startGroup()
Starts rendering a group, called before processing grouped elements

Class Details

[line 70]
Proxy class for HTML_QuickForm2 renderers and their plugins

This class serves two purposes:

  1. Aggregates renderer and its plugins. From user's point of view renderer plugins simply add new methods to renderer instances.
  2. Restricts access to renderer properties and methods. Those are defined as 'public' to allow easy access from plugins, but only methods with names explicitly returned by Renderer::exportMethods() are available to the outside world.



[ Top ]

Method Detail

__construct (Constructor)   [line 111]

HTML_QuickForm2_Renderer_Proxy __construct( HTML_QuickForm2_Renderer $renderer, array &$pluginClasses)

Constructor, sets proxied renderer and its plugins
  • Access: protected

Overrides HTML_QuickForm2_Renderer::__construct() (Constructor)

Parameters:

HTML_QuickForm2_Renderer   $renderer   —  Renderer instance to proxy
array   &$pluginClasses   —  Plugins registered for that renderer type

[ Top ]

addPlugin   [line 160]

void addPlugin( HTML_QuickForm2_Renderer_Plugin $index, HTML_QuickForm2_Renderer_Plugin $plugin)

Adds a plugin for the current renderer instance

Plugin's methods are imported and can be later called as this object's own

  • Throws: HTML_QuickForm2_InvalidArgumentException if a plugin has already imported name
  • Access: protected

Parameters:

HTML_QuickForm2_Renderer_Plugin   $index   —  a plugin instance
HTML_QuickForm2_Renderer_Plugin   $plugin   — 

[ Top ]

finishContainer   [line 226]

void finishContainer( HTML_QuickForm2_Node $container)

Proxies for methods defined in HTML_QuickForm2_Renderer
  • Access: public

Overrides HTML_QuickForm2_Renderer::finishContainer() (Finishes rendering a generic container, called after processing contained elements)

Parameters:

HTML_QuickForm2_Node   $container   — 

[ Top ]

finishForm   [line 216]

void finishForm( HTML_QuickForm2_Node $form)

Proxies for methods defined in HTML_QuickForm2_Renderer
  • Access: public

Overrides HTML_QuickForm2_Renderer::finishForm() (Finishes rendering a form, called after processing contained elements)

Parameters:

HTML_QuickForm2_Node   $form   — 

[ Top ]

finishGroup   [line 236]

void finishGroup( HTML_QuickForm2_Node $group)

Proxies for methods defined in HTML_QuickForm2_Renderer
  • Access: public

Overrides HTML_QuickForm2_Renderer::finishGroup() (Finishes rendering a group, called after processing grouped elements)

Parameters:

HTML_QuickForm2_Node   $group   — 

[ Top ]

getOption   [line 196]

void getOption( [ $name = null])

Proxies for methods defined in HTML_QuickForm2_Renderer
  • Access: public

Overrides HTML_QuickForm2_Renderer::getOption() (Returns the value(s) of the renderer option(s))

Parameters:

   $name   — 

[ Top ]

renderElement   [line 201]

void renderElement( HTML_QuickForm2_Node $element)

Proxies for methods defined in HTML_QuickForm2_Renderer
  • Access: public

Overrides HTML_QuickForm2_Renderer::renderElement() (Renders a generic element)

Parameters:

HTML_QuickForm2_Node   $element   — 

[ Top ]

renderHidden   [line 206]

void renderHidden( HTML_QuickForm2_Node $element)

Proxies for methods defined in HTML_QuickForm2_Renderer
  • Access: public

Overrides HTML_QuickForm2_Renderer::renderHidden() (Renders a hidden element)

Parameters:

HTML_QuickForm2_Node   $element   — 

[ Top ]

setOption   [line 190]

void setOption( $nameOrOptions, [ $value = null])

Proxies for methods defined in HTML_QuickForm2_Renderer
  • Access: public

Overrides HTML_QuickForm2_Renderer::setOption() (Sets the option(s) affecting renderer behaviour)

Parameters:

   $nameOrOptions   — 
   $value   — 

[ Top ]

startContainer   [line 221]

void startContainer( HTML_QuickForm2_Node $container)

Proxies for methods defined in HTML_QuickForm2_Renderer
  • Access: public

Overrides HTML_QuickForm2_Renderer::startContainer() (Starts rendering a generic container, called before processing contained elements)

Parameters:

HTML_QuickForm2_Node   $container   — 

[ Top ]

startForm   [line 211]

void startForm( HTML_QuickForm2_Node $form)

Proxies for methods defined in HTML_QuickForm2_Renderer
  • Access: public

Overrides HTML_QuickForm2_Renderer::startForm() (Starts rendering a form, called before processing contained elements)

Parameters:

HTML_QuickForm2_Node   $form   — 

[ Top ]

startGroup   [line 231]

void startGroup( HTML_QuickForm2_Node $group)

Proxies for methods defined in HTML_QuickForm2_Renderer
  • Access: public

Overrides HTML_QuickForm2_Renderer::startGroup() (Starts rendering a group, called before processing grouped elements)

Parameters:

HTML_QuickForm2_Node   $group   — 

[ Top ]

__call   [line 127]

mixed __call( string $name, array $arguments)

Magic function; call an imported method of a renderer or its plugin
  • Access: public

Parameters:

string   $name   —  method name
array   $arguments   —  method arguments

[ Top ]

__toString   [line 242]

void __toString( )

  • Access: public

[ Top ]
Documentation generated on Mon, 11 Mar 2019 15:34:59 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.