SerializableObject::oldPhpSerialize() - Code Metrics - Inspection of "Merge pull request #136 from BurningFlipside/devel..." - BurningFlipside/CommonCode - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8bc84d...a7da70 )

by Patrick

created 2020-06-23 21:31 UTC

SerializableObject::oldPhpSerialize() A

↳ Parent: SerializableObject::object2XML()

Complexity

Conditions	3
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
nc	4
nop	1
dl	0
loc	19
rs	9.6333
c	0
b	0
f	0

<?php
namespace Flipside;
/**
 * An easily serializable class
 *
 * This file describes a serializable object
 *
 * PHP version 5 and 7
 *
 * @author Patrick Boyd / [email protected]
 * @copyright Copyright (c) 2015, Austin Artistic Reconstruction
 * @license http://www.apache.org/licenses/ Apache 2.0 License
 */

/**
 * An object that can be serialized and accessed as an array.
 *
 * This class can be serialized to various formats
 */
class SerializableObject implements \ArrayAccess, \JsonSerializable
{
    /**
     * Create the object from an array
     *
     * @param boolean|array $array The array of object properties
     */
    public function __construct($array = false)
    {
        if($array !== false)
        {
            if(is_object($array))
            {
                $array = get_object_vars($array);
            }
            if(is_array($array))
            {
                foreach($array as $key => $value)
                {
                    $this->{$key} = $value;
                }
            }
        }
    }

    /**
     * Serialize the object into a format consumable by json_encode
     *
     * @return array The object in a more serialized format
     */
    public function jsonSerialize()
    {
        return (array)$this;
    }

    /**
     * Convert the object into an XML string
     *
     * @return string The XML format of the object
     */
    public function xmlSerialize()
    {
        $xml = new \XmlWriter();
        $xml->openMemory();
        $xml->startDocument('1.0');
        $this->php7XmlSerialize($xml);
        $xml->endElement();
        return $xml->outputMemory(true);
    }

    /**
     * Convert the object into an XML string for PHP 7 or greater
     *
     * @param XmlWriter $xml The XmlWriter Instancce to use in serializing
     *
     * @return string The XML format of the object
     */
    private function php7XmlSerialize(\XMLWriter $xml)
    {
        if(isset($this[0]))
        {
            $xml->startElement('Array');
            $this->array2XML($xml, 'Entity', get_object_vars($this));
            $xml->endElement();
        }
        else
        {
            $this->object2XML($xml, $this);
        }
    }

    /**
     * Convert an object to XML without document tags
     *
     * @param XmlWriter $xml The XMLWriter to write the object to
     * @param mixed $data The data to serialze to XML
     */
    private function object2XML(\XMLWriter $xml, $data)
    {
        foreach($data as $key => $value)
        {
            if(is_array($value) || is_numeric($key))
            {
                $this->array2XML($xml, $key, (array)$value);
            }
            else if(is_object($value))
            {
                $xml->startElement($key);
                $this->object2XML($xml, $value);
                $xml->endElement();
            }
            else
            {
                if($key[0] === '$')
                {
                    $xml->writeElement(substr($key, 1), $value);
                }
                else
                {
                    $key = strtr($key, array(' '=>'', ','=>''));
                    $xml->writeElement($key, $value);
                }
            }
        }
    }

    /**
     * Determine if an array has any string keys
     *
     * @param array $array The array to test
     * 
     * @return boolean True if the array has string keys, false otherwise
     */
    private function arrayHasStringKeys(array $array)
    {
        return count(array_filter(array_keys($array), 'is_string')) > 0;
    }

    /**
     * Convert an array to XML without document tags
     *
     * @param XmlWriter $xml The XMLWriter to write the object to
     * @param string $keyParent The key of the parent object
     * @param mixed $data The data to serialze to XML
     */
    private function array2XML(\XMLWriter $xml, $keyParent, $data)
    {
        $data = array_values($data);
        $count = count($data);
        for($i = 0; $i < $count; $i++)
        {
            $value = $data[$i];
            if(is_array($value) && isset($value[0]))
            {
                $xml->startElement($keyParent);
                $this->array2XML($xml, 'Child', $value);
                $xml->endElement();
            }
            else if(is_array($value) && $this->arrayHasStringKeys($value))
            {
                $xml->startElement($keyParent);
                $this->object2XML($xml, $value);
                $xml->endElement();
            }
            else if(is_object($value))
            {
                $xml->startElement($keyParent);
                $this->object2XML($xml, $value);
                $xml->endElement();
            }
            else
            {
                $xml->writeElement($keyParent, $value);
            }
        }
    }

    /**
     * Convert json back to an object
     *
     * @param string $json The JSON string to deserialize back into an object
     *
     * @return SerializableObject The object the json deserializes into 
     */
    public static function jsonDeserialize($json)
    {
        $array = json_decode($json, true);
        return new self($array);
    }

    /**
     * Convert the object to a serizlized string
     *
     * @param string $fmt The format to serialize into
     * @param array|false $select Which fields to include
     *
     * @return string The object in string format
     */
    public function serializeObject($fmt = 'json', $select = false)
    {
        $copy = $this;
        if($select !== false)
        {
            $copy = new self();
            $count = count($select);
            for($i = 0; $i < $count; $i++)
            {
                $copy->{$select[$i]} = $this->offsetGet($select[$i]);
            }
        }
        switch($fmt)
        {
            case 'json':
                return json_encode($copy);
            default:
                throw new \Exception('Unsupported fmt '.$fmt);
        }
    }

    /**
     * Function to allow the caller to set a value in the object via object[offset] = value
     *
     * @param string $offset The key to set
     * @param mixed $value The value for the key
     */
    public function offsetSet($offset, $value)
    {
        $this->{$offset} = $value;
    }

    /**
     * Function to allow the caller to determin if a value in the object is set
     *
     * @param string $offset The key to determine if it has a value
     *
     * @return boolean Does the key have a value?
     */
    public function offsetExists($offset)
    {
        return isset($this->{$offset});
    }

    /**
     * Function to allow the caller to delete the value in the object for a key
     *
     * @param string $offset The key to unset
     */
    public function offsetUnset($offset)
    {
        unset($this->{$offset});
    }

    /**
     * Function to allow the caller to obtain the value for a key
     *
     * @param string $offset The key to return the value for
     *
     * @return mixed the value in the key
     */
    public function offsetGet($offset)
    {
        return $this->{$offset};
    }
}
/* vim: set tabstop=4 shiftwidth=4 expandtab: */


1			<?php
2			namespace Flipside;
3			/**
4			* An easily serializable class
5			*
6			* This file describes a serializable object
7			*
8			* PHP version 5 and 7
9			*
10			* @author Patrick Boyd / [email protected]
11			* @copyright Copyright (c) 2015, Austin Artistic Reconstruction
12			* @license http://www.apache.org/licenses/ Apache 2.0 License
13			*/
14
15			/**
16			* An object that can be serialized and accessed as an array.
17			*
18			* This class can be serialized to various formats
19			*/
20			class SerializableObject implements \ArrayAccess, \JsonSerializable
21			{
22			/**
23			* Create the object from an array
24			*
25			* @param boolean\|array $array The array of object properties
26			*/
27			public function __construct($array = false)
28			{
29			if($array !== false)
30			{
31			if(is_object($array))
32			{
33			$array = get_object_vars($array);
34			}
35			if(is_array($array))
36			{
37			foreach($array as $key => $value)
38			{
39			$this->{$key} = $value;
40			}
41			}
42			}
43			}
44
45			/**
46			* Serialize the object into a format consumable by json_encode
47			*
48			* @return array The object in a more serialized format
49			*/
50			public function jsonSerialize()
51			{
52			return (array)$this;
53			}
54
55			/**
56			* Convert the object into an XML string
57			*
58			* @return string The XML format of the object
59			*/
60			public function xmlSerialize()
61			{
62			$xml = new \XmlWriter();
63			$xml->openMemory();
64			$xml->startDocument('1.0');
65			$this->php7XmlSerialize($xml);
66			$xml->endElement();
67			return $xml->outputMemory(true);
68			}
69
70			/**
71			* Convert the object into an XML string for PHP 7 or greater
72			*
73			* @param XmlWriter $xml The XmlWriter Instancce to use in serializing
74			*
75			* @return string The XML format of the object
76			*/
77			private function php7XmlSerialize(\XMLWriter $xml)
78			{
79			if(isset($this[0]))
80			{
81			$xml->startElement('Array');
82			$this->array2XML($xml, 'Entity', get_object_vars($this));
83			$xml->endElement();
84			}
85			else
86			{
87			$this->object2XML($xml, $this);
88			}
89			}
90
91			/**
92			* Convert an object to XML without document tags
93			*
94			* @param XmlWriter $xml The XMLWriter to write the object to
95			* @param mixed $data The data to serialze to XML
96			*/
97			private function object2XML(\XMLWriter $xml, $data)
98			{
99			foreach($data as $key => $value)
100			{
101			if(is_array($value) \|\| is_numeric($key))
102			{
103			$this->array2XML($xml, $key, (array)$value);
104			}
105			else if(is_object($value))
106			{
107			$xml->startElement($key);
108			$this->object2XML($xml, $value);
109			$xml->endElement();
110			}
111			else
112			{
113			if($key[0] === '$')
114			{
115			$xml->writeElement(substr($key, 1), $value);
116			}
117			else
118			{
119			$key = strtr($key, array(' '=>'', ','=>''));
120			$xml->writeElement($key, $value);
121			}
122			}
123			}
124			}
125
126			/**
127			* Determine if an array has any string keys
128			*
129			* @param array $array The array to test
130			*
131			* @return boolean True if the array has string keys, false otherwise
132			*/
133			private function arrayHasStringKeys(array $array)
134			{
135			return count(array_filter(array_keys($array), 'is_string')) > 0;
136			}
137
138			/**
139			* Convert an array to XML without document tags
140			*
141			* @param XmlWriter $xml The XMLWriter to write the object to
142			* @param string $keyParent The key of the parent object
143			* @param mixed $data The data to serialze to XML
144			*/
145			private function array2XML(\XMLWriter $xml, $keyParent, $data)
146			{
147			$data = array_values($data);
148			$count = count($data);
149			for($i = 0; $i < $count; $i++)
150			{
151			$value = $data[$i];
152			if(is_array($value) && isset($value[0]))
153			{
154			$xml->startElement($keyParent);
155			$this->array2XML($xml, 'Child', $value);
156			$xml->endElement();
157			}
158			else if(is_array($value) && $this->arrayHasStringKeys($value))
159			{
160			$xml->startElement($keyParent);
161			$this->object2XML($xml, $value);
162			$xml->endElement();
163			}
164			else if(is_object($value))
165			{
166			$xml->startElement($keyParent);
167			$this->object2XML($xml, $value);
168			$xml->endElement();
169			}
170			else
171			{
172			$xml->writeElement($keyParent, $value);
173			}
174			}
175			}
176
177			/**
178			* Convert json back to an object
179			*
180			* @param string $json The JSON string to deserialize back into an object
181			*
182			* @return SerializableObject The object the json deserializes into
183			*/
184			public static function jsonDeserialize($json)
185			{
186			$array = json_decode($json, true);
187			return new self($array);
188			}
189
190			/**
191			* Convert the object to a serizlized string
192			*
193			* @param string $fmt The format to serialize into
194			* @param array\|false $select Which fields to include
195			*
196			* @return string The object in string format
197			*/
198			public function serializeObject($fmt = 'json', $select = false)
199			{
200			$copy = $this;
201			if($select !== false)
202			{
203			$copy = new self();
204			$count = count($select);
205			for($i = 0; $i < $count; $i++)
206			{
207			$copy->{$select[$i]} = $this->offsetGet($select[$i]);
208			}
209			}
210			switch($fmt)
211			{
212			case 'json':
213			return json_encode($copy);
214			default:
215			throw new \Exception('Unsupported fmt '.$fmt);
216			}
217			}
218
219			/**
220			* Function to allow the caller to set a value in the object via object[offset] = value
221			*
222			* @param string $offset The key to set
223			* @param mixed $value The value for the key
224			*/
225			public function offsetSet($offset, $value)
226			{
227			$this->{$offset} = $value;
228			}
229
230			/**
231			* Function to allow the caller to determin if a value in the object is set
232			*
233			* @param string $offset The key to determine if it has a value
234			*
235			* @return boolean Does the key have a value?
236			*/
237			public function offsetExists($offset)
238			{
239			return isset($this->{$offset});
240			}
241
242			/**
243			* Function to allow the caller to delete the value in the object for a key
244			*
245			* @param string $offset The key to unset
246			*/
247			public function offsetUnset($offset)
248			{
249			unset($this->{$offset});
250			}
251
252			/**
253			* Function to allow the caller to obtain the value for a key
254			*
255			* @param string $offset The key to return the value for
256			*
257			* @return mixed the value in the key
258			*/
259			public function offsetGet($offset)
260			{
261			return $this->{$offset};
262			}
263			}
264			/* vim: set tabstop=4 shiftwidth=4 expandtab: */
265

BurningFlipside / CommonCode

Push — master ( 8bc84d...a7da70 )

SerializableObject::oldPhpSerialize() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like