Static Public Member Functions
static	decode ($source=null, $objectDecodeType=Zend_Json::TYPE_ARRAY)

static	decodeUnicodeString ($chrs)

Data Fields
const	EOF = 0

const	DATUM = 1

const	LBRACE = 2

const	LBRACKET = 3

const	RBRACE = 4

const	RBRACKET = 5

const	COMMA = 6

const	COLON = 7

Protected Member Functions
	__construct ($source, $decodeType)

	_decodeValue ()

	_decodeObject ()

	_decodeArray ()

	_eatWhitespace ()

	_getNextToken ()

Static Protected Member Functions
static	_utf162utf8 ($utf16)

Protected Attributes
	$_source

	$_sourceLength

	$_offset

	$_token

	$_decodeType

Detailed Description

Definition at line 35 of file Decoder.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	$source,
		$decodeType
	)

protected

Constructor

Parameters

string	$source	String source to decode
int	$decodeType	How objects should be decoded – see Zend_Json::TYPE_ARRAY and Zend_Json::TYPE_OBJECT for valid values

Returns: void

Definition at line 97 of file Decoder.php.

     {
         // Set defaults
         $this->_source       = self::decodeUnicodeString($source);
         $this->_sourceLength = strlen($this->_source);
         $this->_token        = self::EOF;
         $this->_offset       = 0;
 
         // Normalize and set $decodeType
         if (!in_array($decodeType, array(Zend_Json::TYPE_ARRAY, Zend_Json::TYPE_OBJECT)))
         {
             $decodeType = Zend_Json::TYPE_ARRAY;
         }
         $this->_decodeType   = $decodeType;
 
         // Set pointer at first token
         $this->_getNextToken();
     }

Member Function Documentation

◆ _decodeArray()

_decodeArray ( )

protected

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

Returns: array

Definition at line 261 of file Decoder.php.

     {
         $result = array();
         $starttok = $tok = $this->_getNextToken(); // Move past the '['
         $index  = 0;
 
         while ($tok && $tok != self::RBRACKET) {
             $result[$index++] = $this->_decodeValue();
 
             $tok = $this->_token;
 
             if ($tok == self::RBRACKET || !$tok) {
                 break;
             }
 
             if ($tok != self::COMMA) {
                 #require_once 'Zend/Json/Exception.php';
                 throw new Zend_Json_Exception('Missing "," in array encoding: ' . $this->_source);
             }
 
             $tok = $this->_getNextToken();
         }
 
         $this->_getNextToken();
         return($result);
     }

◆ _decodeObject()

_decodeObject ( )

protected

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 $_decodeType. If invalid $_decodeType present, returns as an array.

Returns: array|StdClass

Definition at line 199 of file Decoder.php.

     {
         $members = array();
         $tok = $this->_getNextToken();
 
         while ($tok && $tok != self::RBRACE) {
             if ($tok != self::DATUM || ! is_string($this->_tokenValue)) {
                 #require_once 'Zend/Json/Exception.php';
                 throw new Zend_Json_Exception('Missing key in object encoding: ' . $this->_source);
             }
 
             $key = $this->_tokenValue;
             $tok = $this->_getNextToken();
 
             if ($tok != self::COLON) {
                 #require_once 'Zend/Json/Exception.php';
                 throw new Zend_Json_Exception('Missing ":" in object encoding: ' . $this->_source);
             }
 
             $tok = $this->_getNextToken();
             $members[$key] = $this->_decodeValue();
             $tok = $this->_token;
 
             if ($tok == self::RBRACE) {
                 break;
             }
 
             if ($tok != self::COMMA) {
                 #require_once 'Zend/Json/Exception.php';
                 throw new Zend_Json_Exception('Missing "," in object encoding: ' . $this->_source);
             }
 
             $tok = $this->_getNextToken();
         }
 
         switch ($this->_decodeType) {
             case Zend_Json::TYPE_OBJECT:
                 // Create new StdClass and populate with $members
                 $result = new StdClass();
                 foreach ($members as $key => $value) {
                     if ($key === '') {
                         $key = '_empty_';
                     }
                     $result->$key = $value;
                 }
                 break;
             case Zend_Json::TYPE_ARRAY:
             default:
                 $result = $members;
                 break;
         }
 
         $this->_getNextToken();
         return $result;
     }

◆ _decodeValue()

_decodeValue ( )

protected

Recursive driving rountine for supported toplevel tops

Returns: mixed

Definition at line 165 of file Decoder.php.

     {
         switch ($this->_token) {
             case self::DATUM:
                 $result  = $this->_tokenValue;
                 $this->_getNextToken();
                 return($result);
                 break;
             case self::LBRACE:
                 return($this->_decodeObject());
                 break;
             case self::LBRACKET:
                 return($this->_decodeArray());
                 break;
             default:
                 return null;
                 break;
         }
     }

◆ _eatWhitespace()

_eatWhitespace ( )

protected

Removes whitepsace characters from the source input

Definition at line 292 of file Decoder.php.

     {
         if (preg_match(
                 '/([\t\b\f\n\r ])*/s',
                 $this->_source,
                 $matches,
                 PREG_OFFSET_CAPTURE,
                 $this->_offset)
             && $matches[0][1] == $this->_offset)
         {
             $this->_offset += strlen($matches[0][0]);
         }
     }

◆ _getNextToken()

_getNextToken ( )

protected

Retrieves the next token from the source stream

Returns: int Token constant value specified in class definition

Definition at line 312 of file Decoder.php.

     {
         $this->_token      = self::EOF;
         $this->_tokenValue = null;
         $this->_eatWhitespace();
 
         if ($this->_offset >= $this->_sourceLength) {
             return(self::EOF);
         }
 
         $str        = $this->_source;
         $str_length = $this->_sourceLength;
         $i          = $this->_offset;
         $start      = $i;
 
         switch ($str{$i}) {
             case '{':
                $this->_token = self::LBRACE;
                break;
             case '}':
                 $this->_token = self::RBRACE;
                 break;
             case '[':
                 $this->_token = self::LBRACKET;
                 break;
             case ']':
                 $this->_token = self::RBRACKET;
                 break;
             case ',':
                 $this->_token = self::COMMA;
                 break;
             case ':':
                 $this->_token = self::COLON;
                 break;
             case  '"':
                 $result = '';
                 do {
                     $i++;
                     if ($i >= $str_length) {
                         break;
                     }
 
                     $chr = $str{$i};
 
                     if ($chr == '\\') {
                         $i++;
                         if ($i >= $str_length) {
                             break;
                         }
                         $chr = $str{$i};
                         switch ($chr) {
                             case '"' :
                                 $result .= '"';
                                 break;
                             case '\\':
                                 $result .= '\\';
                                 break;
                             case '/' :
                                 $result .= '/';
                                 break;
                             case 'b' :
                                 $result .= "\x08";
                                 break;
                             case 'f' :
                                 $result .= "\x0c";
                                 break;
                             case 'n' :
                                 $result .= "\x0a";
                                 break;
                             case 'r' :
                                 $result .= "\x0d";
                                 break;
                             case 't' :
                                 $result .= "\x09";
                                 break;
                             case '\'' :
                                 $result .= '\'';
                                 break;
                             default:
                                 #require_once 'Zend/Json/Exception.php';
                                 throw new Zend_Json_Exception("Illegal escape "
                                     .  "sequence '" . $chr . "'");
                         }
                     } elseif($chr == '"') {
                         break;
                     } else {
                         $result .= $chr;
                     }
                 } while ($i < $str_length);
 
                 $this->_token = self::DATUM;
                 //$this->_tokenValue = substr($str, $start + 1, $i - $start - 1);
                 $this->_tokenValue = $result;
                 break;
             case 't':
                 if (($i+ 3) < $str_length && substr($str, $start, 4) == "true") {
                     $this->_token = self::DATUM;
                 }
                 $this->_tokenValue = true;
                 $i += 3;
                 break;
             case 'f':
                 if (($i+ 4) < $str_length && substr($str, $start, 5) == "false") {
                     $this->_token = self::DATUM;
                 }
                 $this->_tokenValue = false;
                 $i += 4;
                 break;
             case 'n':
                 if (($i+ 3) < $str_length && substr($str, $start, 4) == "null") {
                     $this->_token = self::DATUM;
                 }
                 $this->_tokenValue = NULL;
                 $i += 3;
                 break;
         }
 
         if ($this->_token != self::EOF) {
             $this->_offset = $i + 1; // Consume the last token character
             return($this->_token);
         }
 
         $chr = $str{$i};
         if ($chr == '-' || $chr == '.' || ($chr >= '0' && $chr <= '9')) {
             if (preg_match('/-?([0-9])*(\.[0-9]*)?((e|E)((-|\+)?)[0-9]+)?/s',
                 $str, $matches, PREG_OFFSET_CAPTURE, $start) && $matches[0][1] == $start) {
 
                 $datum = $matches[0][0];
 
                 if (is_numeric($datum)) {
                     if (preg_match('/^0\d+$/', $datum)) {
                         #require_once 'Zend/Json/Exception.php';
                         throw new Zend_Json_Exception("Octal notation not supported by JSON (value: $datum)");
                     } else {
                         $val  = intval($datum);
                         $fVal = floatval($datum);
                         $this->_tokenValue = ($val == $fVal ? $val : $fVal);
                     }
                 } else {
                     #require_once 'Zend/Json/Exception.php';
                     throw new Zend_Json_Exception("Illegal number format: $datum");
                 }
 
                 $this->_token = self::DATUM;
                 $this->_offset = $start + strlen($datum);
             }
         } else {
             #require_once 'Zend/Json/Exception.php';
             throw new Zend_Json_Exception('Illegal Token');
         }
 
         return($this->_token);
     }

◆ _utf162utf8()

static _utf162utf8 ( $utf16 )

staticprotected

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

string $utf16 UTF-16 character string UTF-8 character

Definition at line 548 of file Decoder.php.

     {
         // Check for mb extension otherwise do by hand.
         if( function_exists('mb_convert_encoding') ) {
             return mb_convert_encoding($utf16, 'UTF-8', 'UTF-16');
         }
 
         $bytes = (ord($utf16{0}) << 8) | ord($utf16{1});
 
         switch (true) {
             case ((0x7F & $bytes) == $bytes):
                 // this case should never be reached, because we are in ASCII range
                 // see: http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8
                 return chr(0x7F & $bytes);
 
             case (0x07FF & $bytes) == $bytes:
                 // return a 2-byte UTF-8 character
                 // see: http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8
                 return chr(0xC0 | (($bytes >> 6) & 0x1F))
                      . chr(0x80 | ($bytes & 0x3F));
 
             case (0xFFFF & $bytes) == $bytes:
                 // return a 3-byte UTF-8 character
                 // see: http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8
                 return chr(0xE0 | (($bytes >> 12) & 0x0F))
                      . chr(0x80 | (($bytes >> 6) & 0x3F))
                      . chr(0x80 | ($bytes & 0x3F));
         }
 
         // ignoring UTF-32 for now, sorry
         return '';
     }

◆ decode()

static decode	(	$source = `null`,
		$objectDecodeType = `Zend_Json::TYPE_ARRAY`
	)

static

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 Zend_Json::TYPE_OBJECT to the $objectDecodeType parameter.

Throws a Zend_Json_Exception if the source string is null.

@access public

Parameters

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

Returns: mixed

Exceptions

Zend_Json_Exception

Definition at line 144 of file Decoder.php.

     {
         if (null === $source) {
             #require_once 'Zend/Json/Exception.php';
             throw new Zend_Json_Exception('Must specify JSON encoded source for decoding');
         } elseif (!is_string($source)) {
             #require_once 'Zend/Json/Exception.php';
             throw new Zend_Json_Exception('Can only decode JSON encoded strings');
         }
 
         $decoder = new self($source, $objectDecodeType);
 
         return $decoder->_decodeValue();
     }

◆ decodeUnicodeString()

static decodeUnicodeString ( $chrs )

static

Decode Unicode Characters from \u0000 ASCII syntax.

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

http://svn.solarphp.com/core/trunk/Solar/Json.php string $value string

Definition at line 477 of file Decoder.php.

     {
         $delim       = substr($chrs, 0, 1);
         $utf8        = '';
         $strlen_chrs = strlen($chrs);
 
         for($i = 0; $i < $strlen_chrs; $i++) {
 
             $substr_chrs_c_2 = substr($chrs, $i, 2);
             $ord_chrs_c = ord($chrs[$i]);
 
             switch (true) {
                 case preg_match('/\\\u[0-9A-F]{4}/i', substr($chrs, $i, 6)):
                     // single, escaped unicode character
                     $utf16 = chr(hexdec(substr($chrs, ($i + 2), 2)))
                            . chr(hexdec(substr($chrs, ($i + 4), 2)));
                     $utf8 .= self::_utf162utf8($utf16);
                     $i += 5;
                     break;
                 case ($ord_chrs_c >= 0x20) && ($ord_chrs_c <= 0x7F):
                     $utf8 .= $chrs{$i};
                     break;
                 case ($ord_chrs_c & 0xE0) == 0xC0:
                     // characters U-00000080 - U-000007FF, mask 110XXXXX
                     //see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8
                     $utf8 .= substr($chrs, $i, 2);
                     ++$i;
                     break;
                 case ($ord_chrs_c & 0xF0) == 0xE0:
                     // characters U-00000800 - U-0000FFFF, mask 1110XXXX
                     // see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8
                     $utf8 .= substr($chrs, $i, 3);
                     $i += 2;
                     break;
                 case ($ord_chrs_c & 0xF8) == 0xF0:
                     // characters U-00010000 - U-001FFFFF, mask 11110XXX
                     // see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8
                     $utf8 .= substr($chrs, $i, 4);
                     $i += 3;
                     break;
                 case ($ord_chrs_c & 0xFC) == 0xF8:
                     // characters U-00200000 - U-03FFFFFF, mask 111110XX
                     // see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8
                     $utf8 .= substr($chrs, $i, 5);
                     $i += 4;
                     break;
                 case ($ord_chrs_c & 0xFE) == 0xFC:
                     // characters U-04000000 - U-7FFFFFFF, mask 1111110X
                     // see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8
                     $utf8 .= substr($chrs, $i, 6);
                     $i += 5;
                     break;
             }
         }
 
         return $utf8;
     }

Field Documentation

◆ $_decodeType

$_decodeType

protected

Definition at line 86 of file Decoder.php.

◆ $_offset

$_offset

protected

Definition at line 71 of file Decoder.php.

◆ $_source

$_source

protected

Definition at line 56 of file Decoder.php.

◆ $_sourceLength

$_sourceLength

protected

Definition at line 63 of file Decoder.php.

◆ $_token

$_token

protected

Definition at line 78 of file Decoder.php.

◆ COLON

const COLON = 7

Definition at line 49 of file Decoder.php.

◆ COMMA

const COMMA = 6

Definition at line 48 of file Decoder.php.

◆ DATUM

const DATUM = 1

Definition at line 43 of file Decoder.php.

◆ EOF

const EOF = 0

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

Definition at line 42 of file Decoder.php.

◆ LBRACE

const LBRACE = 2

Definition at line 44 of file Decoder.php.

◆ LBRACKET

const LBRACKET = 3

Definition at line 45 of file Decoder.php.

◆ RBRACE

const RBRACE = 4

Definition at line 46 of file Decoder.php.

◆ RBRACKET

const RBRACKET = 5

Definition at line 47 of file Decoder.php.

The documentation for this class was generated from the following file:

vendor/magento/zendframework1/library/Zend/Json/Decoder.php

Static Public Member Functions

Data Fields

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _decodeArray()

◆ _decodeObject()

◆ _decodeValue()

◆ _eatWhitespace()

◆ _getNextToken()

◆ _utf162utf8()

◆ decode()

◆ decodeUnicodeString()

Field Documentation

◆ $_decodeType

◆ $_offset

◆ $_source

◆ $_sourceLength

◆ $_token

◆ COLON

◆ COMMA

◆ DATUM

◆ EOF

◆ LBRACE

◆ LBRACKET

◆ RBRACE

◆ RBRACKET