apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]
Packages:
Var_Dump


Classes:
Var_Dump
   child
   c_parent
   test
   Var_Dump

Class: Var_Dump

Source Location: /Var_Dump-1.0.2/php/Var_Dump.php

Class Overview


















Variables






Methods
















Inherited Variables





Inherited Methods














Class Details



[line 68]






[ Top ]







Class Variables



	
	

	
$defaultOptions = array(

        'display_mode' => 'XHTML_Text', // Display mode.

        'ignore_list'  => NULL          // List of ignored class names.

    )

	
[line 77]

  Default configuration options.


    

  • Access: public
    • 





  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$options = array()

	
[line 88]

  Run-time configuration options.


    

  • Access: public
    • 





  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$renderer =  NULL

	
[line 96]

  Rendering object.


    

  • Access: public
    • 





  

	

  

    

      Type:  
      object
    

      

	



	
[ Top ]


	
	

	
$rendererOptions = array()

	
[line 106]

  Rendering configuration options.
See Var_Dump/Renderer/*.php for the complete list of options


    

  • Access: public
    • 





  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]










Method Detail



	
	
Var_Dump (Constructor)   [line 120]

	

    

    

		Var_Dump Var_Dump(
[mixed
$options = array()], [array
$rendererOptions = array()])
    

    


	
		Class constructor.
The factory approach must be used in relationship with the  toString() method.  See Var_Dump/Renderer/*.php for the complete list of options


    

  • See: Var_Dump::toString()
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        mixed  
        $options  
        — 
        String (display mode) or array (Global parameters).
      

          

        array  
        $rendererOptions  
        — 
        Parameters for the rendering.
      

        

    


        
[ Top ]

  

  
  
	
	
display   [line 493]

	

    

    

		string display(
mixed
$expression, [bool
$return = FALSE], [mixed
$options = NULL], [array
$rendererOptions = NULL])
    

    


	
		Outputs or returns a string representation of a variable.


    

  • Return: If returned, the string representation of the variable.
    • 

  • See: Var_Dump::singleton(), Var_Dump::displayInit()
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        mixed  
        $expression  
        — 
        The variable to parse.
      

          

        bool  
        $return  
        — 
        Whether the variable should be echoed or returned.
      

          

        mixed  
        $options  
        — 
        String (display mode) or array (Global parameters).
      

          

        array  
        $rendererOptions  
        — 
        Parameters for the rendering.
      

        

    


        
[ Top ]

  

  
  
	
	
displayInit   [line 476]

	

    

    

		void displayInit(
[mixed
$options = array()], [array
$rendererOptions = array()])
    

    


	
		Initialise the singleton object used by the display() method.


    

  • See: Var_Dump::singleton(), Var_Dump::display()
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        mixed  
        $options  
        — 
        String (display mode) or array (Global parameters).
      

          

        array  
        $rendererOptions  
        — 
        Parameters for the rendering.
      

        

    


        
[ Top ]

  

  
  
	
	
factory   [line 157]

	

    

    

		void &factory(
[mixed
$options = array()], [array
$rendererOptions = array()])
    

    


	
		Attempt to return a concrete Var_Dump instance.
The factory approach must be used in relationship with the  toString() method.  See Var_Dump/Renderer/*.php for the complete list of options


    

  • See: Var_Dump::toString()
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        mixed  
        $options  
        — 
        String (display mode) or array (Global parameters).
      

          

        array  
        $rendererOptions  
        — 
        Parameters for the rendering.
      

        

    


        
[ Top ]

  

  
  
	
	
singleton   [line 459]

	

    

    

		object Var_Dump &singleton(
)
    

    


	
		Attempt to return a concrete singleton Var_Dump instance.
The singleton approach must be used in relationship with the  displayInit() and display() methods.  See Var_Dump/Renderer/*.php for the complete list of options


    

  • Return: instance
    • 

  • See: Var_Dump::display(), Var_Dump::displayInit()
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
toString   [line 170]

	

    

    

		string toString(
mixed
$expression)
    

    


	
		Uses a renderer object to return the string representation of a variable.


    

  • Return: The string representation of the variable.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        mixed  
        $expression  
        — 
        The variable to parse.
      

        

    


        
[ Top ]

  

  
  



        

		    

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