Json/Decoder.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Json
version: $Id: Decoder.php 22655 2010-07-22 18:47:20Z mabe $
Classes: Zend_Json_Decoder

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Json_Decoder
jump to top

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Json
Constants: EOF; DATUM; LBRACE; LBRACKET; RBRACE; RBRACKET; COMMA; COLON
Properties: $_source; $_sourceLength; $_offset; $_token; $_decodeType
Methods: __construct; decode; _decodeValue; _decodeObject; _decodeArray; _eatWhitespace; _getNextToken; decodeUnicodeString; _utf162utf8

Description

Decode JSON encoded string to PHP variable constructs

Constants

EOF
jump to class

 EOF = '0'

Parse tokens used to decode the JSON object. These are not for public consumption, they are just used internally to the class.

Details

value: 0

DATUM
jump to class

 DATUM = '1'

Details

value: 1

LBRACE
jump to class

 LBRACE = '2'

Details

value: 2

LBRACKET
jump to class

 LBRACKET = '3'

Details

value: 3

RBRACE
jump to class

 RBRACE = '4'

Details

value: 4

RBRACKET
jump to class

 RBRACKET = '5'

Details

value: 5

COMMA
jump to class

 COMMA = '6'

Details

value: 6

COLON
jump to class

 COLON = '7'

Details

value: 7

Properties

$_decodeType
jump to class

int $_decodeType = ''

Flag indicating how objects should be decoded

Details

$_decodeType: int
visibility: protected
default
final: false
static: false
access: protected

$_offset
jump to class

int $_offset = ''

The offset within the souce being decoded

Details

$_offset: int
visibility: protected
default
final: false
static: false

$_source
jump to class

string $_source = ''

Use to maintain a "pointer" to the source being decoded

Details

$_source: string
visibility: protected
default
final: false
static: false

$_sourceLength
jump to class

int $_sourceLength = ''

Caches the source length

Details

$_sourceLength: int
visibility: protected
default
final: false
static: false

$_token
jump to class

int $_token = ''

The current token being considered in the parser cycle

Details

$_token: int
visibility: protected
default
final: false
static: false

Methods

__construct
jump to class

__construct(
          string $source, int $decodeType
          )
        
        :
        void

Constructor

Arguments

$source: string
String source to decode
$decodeType: int
How objects should be decoded -- see {@link Zend_Json::TYPE_ARRAY} and {@link Zend_Json::TYPE_OBJECT} for valid values

Details

visibility: protected
final: false
static: false

_decodeArray
jump to class

_decodeArray(
          
          )
        
        :
        array

Decodes a JSON array format: [element, element2,...,elementN]

Output

array

Details

visibility: protected
final: false
static: false

_decodeObject
jump to class

_decodeObject(
          
          )
        
        :
        array|StdClass

Decodes an object of the form: { "attribute: value, "attribute2" : value,...}

If Zend_Json_Encoder was used to encode the original object then a special attribute called __className which specifies a class name that should wrap the data contained within the encoded source.

Decodes to either an array or StdClass object, based on the value of {@link $_decodeType}. If invalid $_decodeType present, returns as an array.

Output

array|StdClass

Details

visibility: protected
final: false
static: false

_decodeValue
jump to class

_decodeValue(
          
          )
        
        :
        mixed

Recursive driving rountine for supported toplevel tops

Output

mixed

Details

visibility: protected
final: false
static: false

_eatWhitespace
jump to class

_eatWhitespace(
          
          )
        
        :

Removes whitepsace characters from the source input

Details

visibility: protected
final: false
static: false

_getNextToken
jump to class

_getNextToken(
          
          )
        
        :
        int

Retrieves the next token from the source stream

Output

int: Token constant value specified in class definition

Details

visibility: protected
final: false
static: false

_utf162utf8
jump to class

_utf162utf8(
          string $utf16
          )
        
        :
        string

Convert a string from one UTF-16 char to one UTF-8 char.

Normally should be handled by mb_convert_encoding, but provides a slower PHP-only method for installations that lack the multibye string extension.

This method is from the Solar Framework by Paul M. Jones

Arguments

$utf16: string
UTF-16 character

Output

string: UTF-8 character

Details

visibility: protected
final: false
static: true
link: http://solarphp.com

decode
jump to class

decode(
          string $source
              =
              null, int $objectDecodeType
              =
              Zend_Json
          )
        
        :
        mixed

Decode a JSON source string

Decodes a JSON encoded string. The value returned will be one of the following: - integer - float - boolean - null - StdClass - array - array of one or more of the above types

By default, decoded objects will be returned as associative arrays; to return a StdClass object instead, pass {@link Zend_Json::TYPE_OBJECT} to the $objectDecodeType parameter.

Throws a Zend_Json_Exception if the source string is null.

Arguments

$source: string
String to be decoded
$objectDecodeType: int
How objects should be decoded; should be either or {@link Zend_Json::TYPE_ARRAY} or {@link Zend_Json::TYPE_OBJECT}; defaults to TYPE_ARRAY

Output

mixed

Details

visibility: public
final: false
static: true
access: public
static
throws

decodeUnicodeString
jump to class

decodeUnicodeString(
           $chrs
          )
        
        :
        string

Decode Unicode Characters from \u0000 ASCII syntax.

This algorithm was originally developed for the Solar Framework by Paul M. Jones

Arguments

$chrs

Output

string

Details

visibility: public
final: false
static: true
link: http://solarphp.com/
link: http://svn.solarphp.com/core/trunk/Solar/Json.php

API Documentation

Json/Decoder.php

Description

Zend_Json_Decoderjump to top

Description

Constants

EOFjump to class

Details

DATUMjump to class

Details

LBRACEjump to class

Details

LBRACKETjump to class

Details

RBRACEjump to class

Details

RBRACKETjump to class

Details

COMMAjump to class

Details

COLONjump to class

Details

Properties

$_decodeTypejump to class

Details

$_offsetjump to class

Details

$_sourcejump to class

Details

$_sourceLengthjump to class

Details

$_tokenjump to class

Details

Methods

__constructjump to class

Arguments

Details

_decodeArrayjump to class

Output

Details

_decodeObjectjump to class

Output

Details

_decodeValuejump to class

Output

Details

_eatWhitespacejump to class

Details

_getNextTokenjump to class

Output

Details

_utf162utf8jump to class

Arguments

Output

Details

decodejump to class

Arguments

Output

Details

decodeUnicodeStringjump to class

Arguments

Output

Details

Zend_Json_Decoder
jump to top

EOF
jump to class

DATUM
jump to class

LBRACE
jump to class

LBRACKET
jump to class

RBRACE
jump to class

RBRACKET
jump to class

COMMA
jump to class

COLON
jump to class

$_decodeType
jump to class

$_offset
jump to class

$_source
jump to class

$_sourceLength
jump to class

$_token
jump to class

__construct
jump to class

_decodeArray
jump to class

_decodeObject
jump to class

_decodeValue
jump to class

_eatWhitespace
jump to class

_getNextToken
jump to class

_utf162utf8
jump to class

decode
jump to class

decodeUnicodeString
jump to class