BlueSpice MediaWiki master
 All Classes Namespaces Files Functions Variables Groups Pages
Skins\Chameleon\Components\Modifications\Modification Class Reference
Inheritance diagram for Skins\Chameleon\Components\Modifications\Modification:
Collaboration diagram for Skins\Chameleon\Components\Modifications\Modification:

Public Member Functions

 __construct (Component $component,\DOMElement $domElement=null)
 
 getDomElementOfModification ()
 
 getDomElementOfComponent ()
 
 setClasses ($classes)
 
 getComponent ()
 
 addClasses ($classes)
 
 getSkinTemplate ()
 
 getIndent ()
 
 getClassString ()
 
 removeClasses ($classes)
 
 getDomElement ()
 
 getHtml ()
 
 getResourceLoaderModules ()
 
- Public Member Functions inherited from Skins\Chameleon\Components\Component
 __construct (ChameleonTemplate $template,\DOMElement $domElement=null, $indent=0)
 
 setClasses ($classes)
 
 addClasses ($classes)
 
 getSkinTemplate ()
 
 getSkin ()
 
 getIndent ()
 
 getClassString ()
 
 removeClasses ($classes)
 
 getDomElement ()
 
 getHtml ()
 
 getResourceLoaderModules ()
 

Protected Member Functions

 applyModification ()
 
 setComponent (Component $component)
 
- Protected Member Functions inherited from Skins\Chameleon\Components\Component
 transformClassesToArray ($classes)
 
 indent ($indent=0)
 
 getAttribute ($attributeName, $default=null)
 

Detailed Description

Modification class

This is the abstract base class of all modifications.

Follows the Decorator pattern (Decorator role).

Author
Stephan Gambke
Since
1.0

Constructor & Destructor Documentation

Skins\Chameleon\Components\Modifications\Modification::__construct ( Component  $component,
\DOMElement  $domElement = null 
)
Parameters
Component$component
\DOMElement$domElement

Member Function Documentation

Skins\Chameleon\Components\Modifications\Modification::addClasses (   $classes)

Adds the given class to the class string that should be assigned to the top-level html element of this component

Parameters
string  |  array  |  null$classes
Returns
string | array
Skins\Chameleon\Components\Modifications\Modification::applyModification ( )
abstractprotected

This method should apply any modifications to the decorated component available from the getComponent() method.

Skins\Chameleon\Components\Modifications\Modification::getClassString ( )

Returns the class string that should be assigned to the top-level html element of this component

Returns
string
Skins\Chameleon\Components\Modifications\Modification::getComponent ( )
Returns
Component
Skins\Chameleon\Components\Modifications\Modification::getDomElement ( )

Returns the DOMElement from the description XML file associated with this element.

Returns
Skins\Chameleon\Components\Modifications\Modification::getDomElementOfComponent ( )
Returns
Skins\Chameleon\Components\Modifications\Modification::getDomElementOfModification ( )
Returns
|null
Skins\Chameleon\Components\Modifications\Modification::getHtml ( )

Builds the HTML code for this component

Returns
String the HTML code
Skins\Chameleon\Components\Modifications\Modification::getIndent ( )

Returns the current indentation level

Returns
int
Skins\Chameleon\Components\Modifications\Modification::getResourceLoaderModules ( )
Returns
array the resource loader modules needed by this component
Skins\Chameleon\Components\Modifications\Modification::getSkinTemplate ( )
Skins\Chameleon\Components\Modifications\Modification::removeClasses (   $classes)

Removes the given class from the class string that should be assigned to the top-level html element of this component

Parameters
string  |  array  |  null$classes
Returns
string
Skins\Chameleon\Components\Modifications\Modification::setClasses (   $classes)

Sets the class string that should be assigned to the top-level html element of this component

Parameters
string  |  array  |  null$classes
Skins\Chameleon\Components\Modifications\Modification::setComponent ( Component  $component)
protected
Parameters
Component$component
Since
1.1

The documentation for this class was generated from the following file: