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

Class: HTML_QuickForm2_Renderer_Proxy

Source Location: /HTML_QuickForm2-2.0.0/HTML/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: 2.0.0

Methods


Inherited Variables

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::getJavascriptBuilder()
Returns the javascript builder object
HTML_QuickForm2_Renderer::getOption()
Returns the value(s) of the renderer option(s)
HTML_QuickForm2_Renderer::methodExists()
Checks whether a method is available in this object
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::reset()
Resets the accumulated data
HTML_QuickForm2_Renderer::setJavascriptBuilder()
Sets the javascript builder object
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 72]
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 113]

HTML_QuickForm2_Renderer_Proxy __construct( HTML_QuickForm2_Renderer $renderer, &$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 ]

finishContainer   [line 274]

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 264]

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 284]

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 ]

getJavascriptBuilder   [line 232]

void getJavascriptBuilder( )

Proxies for methods defined in HTML_QuickForm2_Renderer
  • Access: public

Overrides HTML_QuickForm2_Renderer::getJavascriptBuilder() (Returns the javascript builder object)
[ Top ]

getOption   [line 227]

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 ]

methodExists   [line 162]

bool methodExists( string $name)

Checks whether a method is available in this object

A method is considered available if this class has such a public method, if a proxied renderer publishes such a method, if some plugin has such a public method.

  • Access: public

Overrides HTML_QuickForm2_Renderer::methodExists() (Checks whether a method is available in this object)

Parameters:

string   $name     Method name

[ Top ]

renderElement   [line 249]

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 254]

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 ]

reset   [line 243]

void reset( )

Proxies for methods defined in HTML_QuickForm2_Renderer
  • Access: public

Overrides HTML_QuickForm2_Renderer::reset() (Resets the accumulated data)
[ Top ]

setJavascriptBuilder   [line 237]

void setJavascriptBuilder( [HTML_QuickForm2_JavascriptBuilder $builder = null])

Proxies for methods defined in HTML_QuickForm2_Renderer
  • Access: public

Overrides HTML_QuickForm2_Renderer::setJavascriptBuilder() (Sets the javascript builder object)

Parameters:

HTML_QuickForm2_JavascriptBuilder   $builder     

[ Top ]

setOption   [line 221]

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 269]

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 259]

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 279]

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 ]

updatePlugins   [line 184]

void updatePlugins( )

Updates the list of plugins for the current renderer instance

This method checks whether any new plugin classes were registered since its previous invocation and adds instances of these classes to the list. Plugins' 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

[ Top ]

__call   [line 130]

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 290]

void __toString( )

  • Access: public

[ Top ]


Documentation generated on Tue, 26 Jun 2012 15:30:25 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.