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


Classes:
XML_CSSML
XML_CSSML_libxslt
XML_CSSML_xslt
Files:
CSSML.php
CSSML.php
Error.php
example.php
libxslt.php
xslt.php

Class: XML_CSSML

Source Location: /XML_CSSML-1.1.1/CSSML.php

Class Overview




The XML_CSSML class provides the xsl functions  to parse a CSSML document into a stylesheet  with the ability to output to a file or return




Author(s):






        
        

Version:


    
  
  • Revision: 0.1
    • 








Variables






Methods















Child classes:






XML_CSSML_xslt

	
The XML_CSSML_xslt is a container class which






XML_CSSML_libxslt

	
The XML_CSSML_domxml is a container class which









Inherited Variables





Inherited Methods














Class Details



[line 89]

The XML_CSSML class provides the xsl functions  to parse a CSSML document into a stylesheet  with the ability to output to a file or return









[ Top ]







Class Variables



	
	

	
$browser =  ''

	
[line 116]

  Code corresponding to the user agent of the browser,
such as is generated with Net_UserAgentDetect

  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$comment =  ''

	
[line 128]

  Comment to be used at the top of the stylesheet output

  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$CSSMLDoc = 

	
[line 96]

  domxml object which holds the xml document with the css information

  

	

  

    

      Type:  
      object
    

      

	



	
[ Top ]


	
	

	
$filter =  ''

	
[line 122]

  Filter for the entries in the CSSML

  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$loaded =  false

	
[line 134]

  Boolean which defines if the CSSML document has been loaded

  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$output =  'STDOUT'

	
[line 109]

  Redirection method for the output of the cssml (file, stdout)
If redirection is a file, it must be absolute

  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$stylesheetDoc = 

	
[line 102]

  domxml object which holds the xsl document which parses the cssml document

  

	

  

    

      Type:  
      object
    

      

	



	
[ Top ]










Method Detail



	
	
errorMessage   [line 273]

	

    

    

		string errorMessage(
int
$in_value)
    

    


	
		Return a textual error message for an XML_CSSML error code.


    

  • Return: error message, or false if not error code
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        int  
        $in_value  
        — 
        error code
      

        

    


        
[ Top ]

  

  
  
	
	
factory   [line 154]

	

    

    

		void &factory(

$in_driver, [
$in_CSSML = null], [
$in_type = 'string'], [
$in_params = null])
    

    


	
		



        
Parameters:

    

    

          

          
        $in_driver  
        — 
        
      

          

          
        $in_CSSML  
        — 
        
      

          

          
        $in_type  
        — 
        
      

          

          
        $in_params  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
free   [line 325]

	

    

    

		void free(
)
    

    


	
		Kill the class object to free memory.  Not really sure how necessary this is, but xml  documents can be pretty big.  This will kill everything, so only use it when you are done


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
isError   [line 257]

	

    

    

		boolean isError(
object
$in_value)
    

    


	
		Tell whether a result code from a XML_CSSML method is an error.


    

  • Return: whether object is an error object
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        object  
        $in_value  
        — 
        object in question
      

        

    


        
[ Top ]

  

  
  
	
	
load   [line 179]

	

    

    

		void load(
mixed
$in_CSSML)
    

    


	
		Prepare the CSSML document object from either a string, file or object.  This  will set the CSSMLDoc class variable which will be parsed by the xsl stylesheet  into a CSS stylesheet



	
Overridden in child classes as:

		

	
XML_CSSML_xslt::load()

		

	

		

	
XML_CSSML_libxslt::load()

		

	

	


        
Parameters:

    

    

          

        mixed  
        $in_CSSML  
        — 
        The CSSML document which contains the information for                          generating the CSS document
      

        

    


        
[ Top ]

  

  
  
	
	
process   [line 239]

	

    

    

		css process(
)
    

    


	
		Run the transformation on the CSSML document using the CSSML xsl stylesheet.  If
the output method is to a file, then the function will not return.  If the output  is set to STDOUT, the xml string will be returned (really the css document) after  some clean up of entities and domxml bugs have been fixed


    

  • Return: string if output method is STDOUT, else void
    • 

  • Access: public
    • 







	
Overridden in child classes as:

		

	
XML_CSSML_xslt::process()

		

	

		

	
XML_CSSML_libxslt::process()

		

	

	


        
[ Top ]

  

  
  
	
	
reset   [line 309]

	

    

    

		void reset(
)
    

    


	
		Resets the object so it is possible to load another xml document.


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
setParams   [line 201]

	

    

    

		void setParams(
array
$in_params)
    

    


	
		Set the params (params) that will be used when calling the stylesheet parser.
This pertains particularly to variables such as browser code, image path and  the filter.  It works by passing an associative array with any number of the  possible parameters for the stylesheet.  If a variable is not set, the default  will be used




        
Parameters:

    

    

          

        array  
        $in_params  
        — 
        Associative array of the params
      

        

    


        
[ Top ]

  

  
  



        

		    

		    Documentation generated on Mon, 11 Mar 2019 14:12:45 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright ©  PHP Group 2004.