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


Classes:
HTML_Common2
Files:
Common2.php

Class: HTML_Common2

Source Location: /HTML_Common2-2.0.0RC1/Common2.php

Class Overview




Base class for HTML classes




Author(s):






        
        

Version:


    
  
  • Release: 2.0.0RC1
    • 








Variables






Methods
















Inherited Variables





Inherited Methods














Class Details



[line 57]

Base class for HTML classes
Implements methods for working with HTML attributes, parsing and generating  attribute strings. Port of HTML_Common class for PHP4 originally written by  Adam Daniel with contributions from numerous other developers.


    

  • Author: Alexey Borzov <avb@php.net>
    • 

  • Version: Release: 2.0.0RC1
    • 

  • Abstract: 
    • 









[ Top ]







Class Variables



	
	

	
$attributes = array()

	
[line 63]

  Associative array of attributes


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$watchedAttributes = array()

	
[line 71]

  List of attribites changes to which will be announced via onAttributeChange()
method rather than performed by HTML_Common2 class itself





  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]










Method Detail



	
	
__construct (Constructor)   [line 230]

	

    

    

		HTML_Common2 __construct(
[mixed
$attributes = null])
    

    


	
		Class constructor, sets default attributes


    

  • Access: public
    • 








        
Parameters:

    

    

          

        mixed  
        $attributes  
        — 
        Array of attribute 'name' => 'value' pairs or HTML attribute string
      

        

    


        
[ Top ]

  

  
  
	
	
addClass   [line 419]

	

    

    

		HTML_Common2 addClass(
string|array
$class)
    

    


	
		Adds the given CSS class(es) to the element


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string|array  
        $class  
        — 
        Class name, multiple class names separated by                            whitespace, array of class names
      

        

    


        
[ Top ]

  

  
  
	
	
getAttribute   [line 262]

	

    

    

		string getAttribute(
string
$name)
    

    


	
		Returns the value of an attribute


    

  • Return: Attribute value, null if attribute does not exist
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $name  
        — 
        Attribute name
      

        

    


        
[ Top ]

  

  
  
	
	
getAttributes   [line 299]

	

    

    

		mixed getAttributes(
[bool
$asString = false])
    

    


	
		Returns the attribute array or string


    

  • Return: Either an array or string of attributes
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        bool  
        $asString  
        — 
        Whether to return attributes as string
      

        

    


        
[ Top ]

  

  
  
	
	
getAttributesString   [line 213]

	

    

    

		string getAttributesString(
array
$attributes)
    

    


	
		Creates HTML attribute string from array


    

  • Return: Attribute string
    • 

  • Access: protected
    • 








        
Parameters:

    

    

          

        array  
        $attributes  
        — 
        Attribute array
      

        

    


        
[ Top ]

  

  
  
	
	
getComment   [line 395]

	

    

    

		string getComment(
)
    

    


	
		Returns the comment associated with the element


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
getIndent   [line 373]

	

    

    

		string getIndent(
)
    

    


	
		Returns the string to indent the element


    

  • Access: protected
    • 








        
[ Top ]

  

  
  
	
	
getIndentLevel   [line 363]

	

    

    

		int getIndentLevel(
)
    

    


	
		Gets the indentation level


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
getOption   [line 130]

	

    

    

		mixed getOption(
[string
$name = null])
    

    


	
		Returns global option(s)


    

  • Return: Option value, null if option does not exist,                    array of all options if $name is not given
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $name  
        — 
        Option name
      

        

    


        
[ Top ]

  

  
  
	
	
hasClass   [line 406]

	

    

    

		bool hasClass(
string
$class)
    

    


	
		Checks whether the element has given CSS class


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $class  
        — 
        Class name
      

        

    


        
[ Top ]

  

  
  
	
	
mergeAttributes   [line 314]

	

    

    

		HTML_Common2 mergeAttributes(
mixed
$attributes)
    

    


	
		Merges the existing attributes with the new ones


    

  • Access: public
    • 








        
Parameters:

    

    

          

        mixed  
        $attributes  
        — 
        Array of attribute 'name' => 'value' pairs or HTML attribute string
      

        

    


        
[ Top ]

  

  
  
	
	
onAttributeChange   [line 484]

	

    

    

		void onAttributeChange(
string
$name, [string
$value = null])
    

    


	
		Called if trying to change an attribute with name in $watchedAttributes
This method is called for each attribute whose name is in the  $watchedAttributes array and which is being changed by setAttribute(),  setAttributes() or mergeAttributes() or removed via removeAttribute().  Note that the operation for the attribute is not carried on after calling  this method, it is the responsibility of this method to change or remove  (or not) the attribute.


    

  • Access: protected
    • 








        
Parameters:

    

    

          

        string  
        $name  
        — 
        Attribute name
      

          

        string  
        $value  
        — 
        Attribute value, null if attribute is being removed
      

        

    


        
[ Top ]

  

  
  
	
	
parseAttributes   [line 145]

	

    

    

		array parseAttributes(
string
$attrString)
    

    


	
		Parses the HTML attributes given as string


    

  • Return: An associative aray of attributes
    • 

  • Access: protected
    • 








        
Parameters:

    

    

          

        string  
        $attrString  
        — 
        HTML attribute string
      

        

    


        
[ Top ]

  

  
  
	
	
prepareAttributes   [line 177]

	

    

    

		array prepareAttributes(
mixed
$attributes)
    

    


	
		Creates a valid attribute array from either a string or an array


    

  • Return: An associative aray of attributes
    • 

  • Access: protected
    • 








        
Parameters:

    

    

          

        mixed  
        $attributes  
        — 
        Array of attributes or HTML attribute string
      

        

    


        
[ Top ]

  

  
  
	
	
removeAttribute   [line 333]

	

    

    

		HTML_Common2 removeAttribute(
string
$attribute)
    

    


	
		Removes an attribute


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $attribute  
        — 
        Name of attribute to remove
      

        

    


        
[ Top ]

  

  
  
	
	
removeAttributeArray   [line 202]

	

    

    

		void removeAttributeArray(
array
&$attributes, string
$name)
    

    


	
		Removes an attribute from an attribute array


    

  • Access: protected
    • 








        
Parameters:

    

    

          

        array  
        &$attributes  
        — 
        Attribute array
      

          

        string  
        $name  
        — 
        Name of attribute to remove
      

        

    


        
[ Top ]

  

  
  
	
	
removeClass   [line 443]

	

    

    

		HTML_Common2 removeClass(
string|array
$class)
    

    


	
		Removes the given CSS class(es) from the element


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string|array  
        $class  
        — 
        Class name, multiple class names separated by                            whitespace, array of class names
      

        

    


        
[ Top ]

  

  
  
	
	
setAttribute   [line 242]

	

    

    

		HTML_Common2 setAttribute(
string
$name, [string
$value = null])
    

    


	
		Sets the value of the attribute


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $name  
        — 
        Attribute name
      

          

        string  
        $value  
        — 
        Attribute value (will be set to $name if omitted)
      

        

    


        
[ Top ]

  

  
  
	
	
setAttributes   [line 274]

	

    

    

		HTML_Common2 setAttributes(
mixed
$attributes)
    

    


	
		Sets the attributes


    

  • Access: public
    • 








        
Parameters:

    

    

          

        mixed  
        $attributes  
        — 
        Array of attribute 'name' => 'value' pairs or HTML attribute string
      

        

    


        
[ Top ]

  

  
  
	
	
setComment   [line 384]

	

    

    

		HTML_Common2 setComment(
string
$comment)
    

    


	
		Sets the comment for the element


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $comment  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
setIndentLevel   [line 349]

	

    

    

		HTML_Common2 setIndentLevel(
int
$level)
    

    


	
		Sets the indentation level


    

  • Access: public
    • 








        
Parameters:

    

    

          

        int  
        $level  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
setOption   [line 108]

	

    

    

		void setOption(
string|array
$nameOrOptions, [mixed
$value = null])
    

    


	
		Sets global option(s)


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string|array  
        $nameOrOptions  
        — 
        Option name or array ('option name' => 'option value')
      

          

        mixed  
        $value  
        — 
        Option value, if first argument is not an array
      

        

    


        
[ Top ]

  

  
  
	
	
__toString   [line 469]

	

    

    

		string __toString(
)
    

    


	
		Returns the HTML representation of the element
This magic method allows using the instances of HTML_Common2 in string  contexts


    

  • Abstract: 
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  



        

		    

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