apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]
Packages:
HTML_AJAX
AJAX
apidoc


Classes:
HTML_AJAX
   Foo
   HTML_AJAX_JSON
   HTML_AJAX_JSON_Error
   Interceptor
   Review
   testHaa
Files:
subpackage HTML_AJAX
JSON.php

Class: HTML_AJAX_JSON

Source Location: /HTML_AJAX-0.5.4/AJAX/JSON.php

Class Overview




Converts to and from JSON format.















Methods
















Inherited Variables





Inherited Methods














Class Details



[line 124]

Converts to and from JSON format.
Brief example of use:
  1.  // create a new instance of HTML_AJAX_JSON
    2. 

  2.  $json = new HTML_AJAX_JSON();
    3. 

  3.  
    4. 

  4.  // convert a complexe value to JSON notation, and send it to the browser
    5. 

  5.  $value = array('foo', 'bar', array(1, 2, 'baz'), array(3, array(4)));
    6. 

  6.  $output = $json->encode($value);
    7. 

  7.  
    8. 

  8.  print($output);
    9. 

  9.  // prints: ["foo","bar",[1,2,"baz"],[3,[4]]]
    10. 

  10.  
    11. 

  11.  // accept incoming POST data, assumed to be in JSON notation
    12. 

  12.  $input = file_get_contents('php://input', 1000000);
    13. 

  13.  $value = $json->decode($input);
    14. 





[ Top ]








Method Detail



	
	
HTML_AJAX_JSON (Constructor)   [line 142]

	

    

    

		HTML_AJAX_JSON HTML_AJAX_JSON(
[int
$use = 0])
    

    


	
		constructs a new JSON instance




        
Parameters:

    

    

          

        int  
        $use  
        —
          
object behavior flags; combine with boolean-OR
possible values: 
  • SERVICES_JSON_LOOSE_TYPE:  loose typing.
                                   "{...}" syntax creates associative arrays
                                   instead of objects in decode().
  • SERVICES_JSON_SUPPRESS_ERRORS:  error suppression.
                                   Values which can't be encoded (e.g. resources)
                                   appear as NULL instead of throwing errors.
                                   By default, a deeply-nested resource will
                                   bubble up with an error, so all return values
                                   from encode() should be checked with isError()

      

        

    


        
[ Top ]

  

  
  
	
	
decode   [line 484]

	

    

    

		mixed decode(
string
$str)
    

    


	
		decodes a JSON string into appropriate variable


    

  • Return: number, boolean, string, array, or object                    corresponding to given JSON input string.                    See argument 1 to HTML_AJAX_JSON() above for object-output behavior.                    Note that decode() always returns strings                    in ASCII or UTF-8 format!
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $str  
        —
          JSON-formatted string
      

        

    


        
[ Top ]

  

  
  
	
	
encode   [line 244]

	

    

    

		mixed encode(
mixed
$var)
    

    


	
		encodes an arbitrary variable into JSON format


    

  • Return: JSON string representation of input var or an error if a problem occurs
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        mixed  
        $var  
        —
          any number, boolean, string, array, or object to be encoded.                            see argument 1 to HTML_AJAX_JSON() above for array-parsing behavior.                            if var is a strng, note that encode() always expects it                            to be in ASCII or UTF-8 format!
      

        

    


        
[ Top ]

  

  
  
	
	
isError   [line 761]

	

    

    

		void isError(

$data, [
$code = null])
    

    


	
		


    

  • Todo: Ultimately, this should just call PEAR::isError()
    • 








        
Parameters:

    

    

          

          
        $data  
        —
          
      

          

          
        $code  
        —
          
      

        

    


        
[ Top ]

  

  
  



        

		    

		    Documentation generated on Fri, 04 Apr 2008 18:30:21 -0400 by phpDocumentor 1.4.0. PEAR Logo Copyright ©  PHP Group 2004.