Class for encoding to and decoding from JSON.
| category | Zend |
|---|---|
| package | Zend_Json |
| uses | |
| copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
| license | New BSD License |
decode(string $encodedValue, integer $objectDecodeType = \Zend_Json::TYPE_ARRAY) : mixed
Uses ext/json's json_decode if available.
stringEncoded in JSON format
integerOptional; flag indicating how to decode objects. See {@link Zend_Json_Decoder::decode()} for details.
mixedencode(mixed $valueToEncode, boolean $cycleCheck= false, array $options= array()) : string
Encodes using ext/json's json_encode() if available.
NOTE: Object should not contain cycles; the JSON format does not allow object reference.
NOTE: Only public variables will be encoded
NOTE: Encoding native javascript expressions are possible using Zend_Json_Expr. You can enable this by setting $options['enableJsonExprFinder'] = true
| see |
|---|
mixed
booleanOptional; whether or not to check for object recursion; off by default
arrayAdditional options used during encoding
stringJSON encoded objectfromXml(string $xmlStringContents, boolean $ignoreXmlAttributes = true) : mixed
Converts a XML formatted string into a JSON formatted string. The value returned will be a string in JSON format.
The caller of this function needs to provide only the first parameter, which is an XML formatted String. The second parameter is optional, which lets the user to select if the XML attributes in the input XML string should be included or ignored in xml2json conversion.
This function converts the XML formatted string into a PHP array by calling a recursive (protected static) function in this class. Then, it converts that PHP array into JSON by calling the "encode" static funcion.
Throws a Zend_Json_Exception if the input not a XML formatted string. NOTE: Encoding native javascript expressions via Zend_Json_Expr is not possible.
| static | |
|---|---|
| access | public |
stringXML String to be converted
booleanInclude or exclude XML attributes in the xml2json conversion process.
\Zend_Json_Exception |
|---|
mixed- JSON formatted string on successprettyPrint(string $json, array $options = array()) : string
Use 'format' option to select output format - currently html and txt supported, txt is default Use 'indent' option to override the indentation string set in the format - by default for the 'txt' format it's a tab
stringOriginal JSON string
arrayEncoding options
string_getXmlValue(\SimpleXMLElement $simpleXmlElementObject) : \Zend_Json_Expr | string
In order to allow Zend_Json_Expr from xml, we check if the node matchs the pattern that try to detect if it is a new Zend_Json_Expr if it matches, we return a new Zend_Json_Expr instead of a text node
\SimpleXMLElement
\Zend_Json_Exprstring
_processXml(\SimpleXMLElement $simpleXmlElementObject, boolean $ignoreXmlAttributes, integer $recursionDepth = 0) : array
The logic in this function is a recursive one.
The main caller of this function (i.e. fromXml) needs to provide only the first two parameters i.e. the SimpleXMLElement object and the flag for ignoring or not ignoring XML attributes. The third parameter will be used internally within this function during the recursive calls.
This function converts the SimpleXMLElement object into a PHP array by calling a recursive (protected static) function in this class. Once all the XML elements are stored in the PHP array, it is returned to the caller.
Throws a Zend_Json_Exception if the XML tree is deeper than the allowed limit.
\SimpleXMLElement
boolean
integer
array$maxRecursionDepthAllowed : integer
25$useBuiltinEncoderDecoder : boolean
falseTYPE_ARRAY = 1
TYPE_OBJECT = 0