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


Classes:
Var_Dump
Var_Dump_Renderer
Var_Dump_Renderer_Common
Var_Dump_Renderer_HTML4_Table
Var_Dump_Renderer_HTML4_Text
Var_Dump_Renderer_Table
Var_Dump_Renderer_Text
Var_Dump_Renderer_XHTML_Table
Var_Dump_Renderer_XHTML_Text
Var_Dump_Renderer_XML
Files:
Common.php
example-1.php
example-2.php
example-3.php
example-4.php
example-5.php
example-6.php
HTML4_Table.php
HTML4_Text.php
Renderer.php
Table.php
Text.php
Var_Dump.php
XHTML_Table.php
XHTML_Text.php
XML.php

Class: Var_Dump

Source Location: /Var_Dump-1.0.4/Var_Dump.php

Class Overview




Main class.




Author(s):






        
          
          

Version:


    
  
  • CVS: $Id: Var_Dump.php 237750 2007-06-15 08:06:25Z fredericpoeydome $
    • 




Copyright:


    
  
  • 1997-2006 The PHP Group
    • 







Variables






Methods
















Inherited Variables





Inherited Methods














Class Details



[line 87]

Main class.









[ Top ]







Class Variables



	
	

	
$defaultOptions = array(

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

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

    )

	
[line 96]

  Default configuration options.


    

  • Access: public
    • 





  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$options = array()

	
[line 107]

  Run-time configuration options.


    

  • Access: public
    • 





  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$renderer =  NULL

	
[line 115]

  Rendering object.


    

  • Access: public
    • 





  

	

  

    

      Type:  
      object
    

      

	



	
[ Top ]


	
	

	
$rendererOptions = array()

	
[line 125]

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

	

    

    

		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








        
Parameters:

    

    

          

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

          

        array  
        $rendererOptions  
        — 
        Parameters for the rendering.
      

        

    


        
[ Top ]

  

  
  
	
	
display   [line 528]

	

    

    

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

    


	
		Outputs or returns a string representation of a variable.








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

	

    

    

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

    


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








        
Parameters:

    

    

          

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

          

        array  
        $rendererOptions  
        — 
        Parameters for the rendering.
      

        

    


        
[ Top ]

  

  
  
	
	
factory   [line 176]

	

    

    

		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








        
Parameters:

    

    

          

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

          

        array  
        $rendererOptions  
        — 
        Parameters for the rendering.
      

        

    


        
[ Top ]

  

  
  
	
	
singleton   [line 494]

	

    

    

		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








        
[ Top ]

  

  
  
	
	
toString   [line 189]

	

    

    

		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 15:38:20 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright ©  PHP Group 2004.