	Source Code Coverage
	Designed for use with PHPUnit, Xdebug and Phing.

Methods: 24

LOC: 482

Statements: 152

Legend:

executednot executeddead code

Source file

Statements

Methods

Total coverage

Object.php

100.0%

83.3%

97.7%

<?php
/**
 * Object.php
 * 26-Apr-2011
 *
 * PHP Version 5
 *
 * @category Services
 * @package  Services_Openstreetmap
 * @author   Ken Guest <kguest@php.net>
 * @license  BSD http://www.opensource.org/licenses/bsd-license.php
 * @version  Release: @package_version@
 * @link     Object.php
 */

/**
 * Services_Openstreetmap_Object
 *
 * @category Services
 * @package  Services_Openstreetmap
 * @author   Ken Guest <kguest@php.net>
 * @license  BSD http://www.opensource.org/licenses/bsd-license.php
 * @link     Object.php
 */
class Services_Openstreetmap_Object
{
    protected $xml = null;

    /**
     * Array of tags in key/value format
     *
     * @var array
     */
    protected $tags = array();

    protected $id = null;

    protected $transport = null;

    protected $config = null;

    /**
     * type of object
     *
     * @var string
     */
    protected $type = null;

    protected $obj = null;

    protected $dirty = false;

    protected $action = null;

    protected $changesetId = null;

    /**
     * getXml
     *
     * @return string
     */
    public function getXml()
    {
        return $this->xml;
    }

    /**
     * If modified, return the osmChangeXML for the object, otherwise the defining
     * XML.
     *
     * @return string
     * @link   http://wiki.openstreetmap.org/wiki/OsmChange
     */
    public function __toString()
    {
        $changeXML = $this->getOsmChangeXml();
        if (is_null($changeXML)) {
            return '' . $this->getXml();
        } else {
            return $changeXML;
        }
    }

    /**
     * setXml
     *
     * @param SimpleXMLElement $xml OSM XML
     *
     * @return void
     */
    public function setXml(SimpleXMLElement $xml)
    {
        $this->xml = $xml->saveXml();
        $obj = $xml->xpath('//' . $this->getType());
        foreach ($obj[0]->children() as $child) {
            $key = (string) $child->attributes()->k;
            if ($key != '') {
                $this->tags[$key] = (string) $child->attributes()->v;
            }
        }
        $this->obj = $obj;
        return $this;
    }

    /**
     * Store a specified value.
     *
     * @param string $value Most likely an id value, returned from the server.
     *
     * @return void
     */
    public function setVal($value)
    {
        $this->xml = $value;
        return $this;
    }

    /**
     * Set the Changeset Id for this object.
     *
     * @param integer $id Changeset Id (numeric)
     *
     * @return Services_Openstreetmap_Object
     */
    public function setChangesetId($id)
    {
        $this->changesetId = $id;
        return $this;
    }

    /**
     * Generate and return the OsmChange XML required to record the changes
     * made to the object in question.
     *
     * @return string
     * @link   http://wiki.openstreetmap.org/wiki/OsmChange
     */
    public function getOsmChangeXml()
    {
        $type = $this->getType();
        if ($this->dirty) {
            $version = $this->getVersion();
            $version++;
            $domd = new DomDocument();
            $domd->loadXml($this->getXml());
            $xpath = new DomXPath($domd);
            $nodelist = $xpath->query("//{$type}");
            $nodelist->item(0)->setAttribute('action', $this->action);
            $nodelist->item(0)->setAttribute('id', $this->getId());

            if (!is_null($this->changesetId)) {
                $nodelist->item(0)->setAttribute('changeset', $this->changesetId);
            }
            $tags = $xpath->query("//{$type}/tag");

            $set = array();
            for ($i = 0; $i < $tags->length; $i++) {
                $key = $tags->item($i)->getAttribute('k');
                $val = $tags->item($i)->getAttribute('v');
                $set[$key] = $val;
            }

            $diff = array_diff($this->getTags(), $set);

            // Remove existing tags
            for ($i = 0; $i < $tags->length; $i++) {
                $rkey = $tags->item($i)->getAttribute('k');
                if (isset($diff[$rkey])) {
                    $nodelist->item(0)->removeChild($tags->item($i));
                }
            }

            foreach ($diff as $key=>$value) {
                $new = $domd->createElement('tag');
                $new->setAttribute('k', $key);
                $new->setAttribute('v', $value);
                $nodelist->item(0)->appendChild($new);
            }

            $xml = $domd->saveXml($nodelist->item(0));
            $xml = "<{$this->action}>{$xml}</{$this->action}>";
            return $this->osmChangeXml($xml);

        } elseif ($this->action == 'delete') {
            $xml = null;
            $domd = new DomDocument();
            $domd->loadXml($this->getXml());
            $xpath = new DomXPath($domd);
            $n = $xpath->query("//{$type}");
            $version = $this->getVersion();
            $version++;
            if (!is_null($this->changesetId)) {
                $n->item(0)->setAttribute('changeset', $this->changesetId);
            }
            $n->item(0)->setAttribute('action', 'delete');
            $xml = $domd->saveXml($n->item(0));
            return $this->osmChangeXml("<delete>{$xml}</delete>");
        }
    }

    /**
     * Amend changeXML with specific updates as appropriate.
     *
     * @param string $xml OsmChange XML as generated by getOsmChangeXml
     *
     * @return string
     * @see    getOsmChangeXml
     * @link   http://wiki.openstreetmap.org/wiki/OsmChange
     */
    public function osmChangeXml($xml)
    {
        return $xml;
    }

    /**
     * Retrieve the id of the object in question.
     *
     * @return integer id of the object
     */
    public function getId()
    {
        if (!is_null($this->id)) {
            return $this->id;
        }

        $attribs = $this->getAttributes();
        if (!is_null($attribs)) {
            return (integer) $attribs->id;
        }
    }

    /**
     * Set the id value of the object in question.
     *
     * <pre>
     * $obj->setId($id)->...
     * </pre>
     *
     * @param integer $value new id of the object
     *
     * @return Services_Openstreetmap_Object
     */
    public function setId($value)
    {
        $this->id = $value;
        return $this;
    }

    /**
     * Retrieve the uid of the object in question.
     *
     * @return integer uid of the object
     */
    public function getUid()
    {
        $attribs = $this->getAttributes();
        if (!is_null($attribs)) {
            return (integer) $attribs->uid;
        }
    }

    /**
     * Retrieve the user (creator/editor) of the object in question.
     *
     * @return string user of the object
     */
    public function getUser()
    {
        $attribs = $this->getAttributes();
        if (!is_null($attribs)) {
            return (string) $attribs->user;
        }
    }

    /**
     * Retrieve the version of the object in question
     *
     * @return string version of the object
     */
    public function getVersion()
    {
        $attribs = $this->getAttributes();
        if (!is_null($attribs)) {
            return (integer) $attribs->version;
        }
    }

    /**
     * Return the attributes set for this object in question.
     *
     * @return string getAttributes()
     */
    public function getAttributes()
    {

        if (is_null($this->obj[0])) {
            return null;
        }
        return $this->obj[0]->attributes();
    }

    /**
     * Return the tags set for this object in question.
     *
     * @return array tags
     */
    public function getTags()
    {
        return $this->tags;
    }


    /**
     * Return value of specified tag as set against this object.
     * If tag isn't set, return null.
     *
     * @param string $key Key value, For example, 'amenity', 'highway' etc
     *
     * @return string
     */
    public function getTag($key)
    {
        if (isset($this->tags[$key])) {
            return $this->tags[$key];
        } else {
            return null;
        }
    }

    /**
     * Return which type of object this is.
     *
     * @return string type
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * Get each distinct version of an object.
     *
     * @return Services_Openstreetmap_Objects
     */
    public function history()
    {
        $transport = null;
        $type = $this->getType();
        $id = $this->getId();
        $config = $this->getConfig();
        $url = $config->getValue('server')
            . 'api/'
            . $config->getValue('api_version')
            . "/$type/$id/history";
        $class = 'Services_Openstreetmap_' . ucfirst($type) . 's';
        $transport = $this->getTransport();
        $response = $transport->getResponse($url);
        $obj = new $class();
        $sxe = @simplexml_load_string($response->getBody());
        if ($sxe === false) {
            $obj->setVal(trim($response->getBody()));
        } else {
            $obj->setXml($sxe);
        }
        return $obj;
    }

    /**
     * Get all relations referring to the object in question.
     *
     * @return Services_Openstreetmap_Relations
     */
    public function getRelations()
    {
        $type = $this->getType();
        $id = $this->getId();
        $config = $this->getConfig();
        $url = $config->getValue('server')
            . 'api/'
            . $config->getValue('api_version')
            . "/$type/$id/relations";
        $response = $this->getTransport()->getResponse($url);
        $obj = new Services_Openstreetmap_Relations();
        $sxe = @simplexml_load_string($response->getBody());
        if ($sxe === false) {
            $obj->setVal(trim($response->getBody()));
        } else {
            $obj->setXml($sxe);
        }
        return $obj;
    }

    /**
     * setTag
     *
     * <pre>
     * $obj->setTag('key', 'value')->setTag(...);
     * </pre>
     *
     * @param mixed $key   key
     * @param mixed $value value
     *
     * @return void
     */
    public function setTag($key, $value)
    {
        if (is_null($this->action)) {
            if ($this->getId() < 0) {
                $this->action = 'create';
            } else {
                $this->action = 'modify';
            }
        }
        $this->dirty = true;
        $this->tags[$key] = $value;
        return $this;
    }

    /**
     * Mark the object as deleted.
     *
     * <pre>
     * $obj->delete();
     * </pre>
     *
     * @return void
     */
    public function delete()
    {
        $this->action = 'delete';
        return $this;
    }

    /**
     * Set Config object
     *
     * @param Services_Openstreetmap_Config $config Config object
     *
     * @return Services_Openstreetmap_Changeset
     */
    public function setConfig(Services_Openstreetmap_Config $config)
    {
        $this->config = $config;
        return $this;
    }

    /**
     * Get current Config object
     *
     * @return Services_Openstreetmap_Config
     */
    public function getConfig()
    {
        return $this->config;
    }

    /**
     * Set the Transport instance.
     *
     * @param Services_Openstreetmap_Transport $transport Transport instance.
     *
     * @return Services_Openstreetmap_Config
     */
    public function setTransport($transport)
    {
        $this->transport = $transport;
        return $this;
    }

    /**
     * Retrieve the current Transport instance.
     *
     * @return Services_Openstreetmap_Transport.
     */
    public function getTransport()
    {
        return $this->transport;
    }
}

// vim:set et ts=4 sw=4:
?>

Report generated at 2012-01-31T21:54:37Z

1		<?php
2		/**
3		* Object.php
4		* 26-Apr-2011
5		*
6		* PHP Version 5
7		*
8		* @category Services
9		* @package Services_Openstreetmap
10		* @author Ken Guest <kguest@php.net>
11		* @license BSD http://www.opensource.org/licenses/bsd-license.php
12		* @version Release: @package_version@
13		* @link Object.php
14		*/
15
16		/**
17		* Services_Openstreetmap_Object
18		*
19		* @category Services
20		* @package Services_Openstreetmap
21		* @author Ken Guest <kguest@php.net>
22		* @license BSD http://www.opensource.org/licenses/bsd-license.php
23		* @link Object.php
24		*/
25		class Services_Openstreetmap_Object
26		{
27		protected $xml = null;
28
29		/**
30		* Array of tags in key/value format
31		*
32		* @var array
33		*/
34		protected $tags = array();
35
36		protected $id = null;
37
38		protected $transport = null;
39
40		protected $config = null;
41
42		/**
43		* type of object
44		*
45		* @var string
46		*/
47		protected $type = null;
48
49		protected $obj = null;
50
51		protected $dirty = false;
52
53		protected $action = null;
54
55		protected $changesetId = null;
56
57		/**
58		* getXml
59		*
60		* @return string
61		*/
62		public function getXml()
63		{
64	7	return $this->xml;
65		}
66
67		/**
68		* If modified, return the osmChangeXML for the object, otherwise the defining
69		* XML.
70		*
71		* @return string
72		* @link http://wiki.openstreetmap.org/wiki/OsmChange
73		*/
74		public function __toString()
75		{
76	2	$changeXML = $this->getOsmChangeXml();
77	2	if (is_null($changeXML)) {
78	1	return '' . $this->getXml();
79	1	} else {
80	1	return $changeXML;
81		}
82		}
83
84		/**
85		* setXml
86		*
87		* @param SimpleXMLElement $xml OSM XML
88		*
89		* @return void
90		*/
91		public function setXml(SimpleXMLElement $xml)
92		{
93	31	$this->xml = $xml->saveXml();
94	31	$obj = $xml->xpath('//' . $this->getType());
95	31	foreach ($obj[0]->children() as $child) {
96	24	$key = (string) $child->attributes()->k;
97	24	if ($key != '') {
98	23	$this->tags[$key] = (string) $child->attributes()->v;
99	23	}
100	31	}
101	31	$this->obj = $obj;
102	31	return $this;
103		}
104
105		/**
106		* Store a specified value.
107		*
108		* @param string $value Most likely an id value, returned from the server.
109		*
110		* @return void
111		*/
112		public function setVal($value)
113		{
114		$this->xml = $value;
115		return $this;
116		}
117
118		/**
119		* Set the Changeset Id for this object.
120		*
121		* @param integer $id Changeset Id (numeric)
122		*
123		* @return Services_Openstreetmap_Object
124		*/
125		public function setChangesetId($id)
126		{
127	6	$this->changesetId = $id;
128	6	return $this;
129		}
130
131		/**
132		* Generate and return the OsmChange XML required to record the changes
133		* made to the object in question.
134		*
135		* @return string
136		* @link http://wiki.openstreetmap.org/wiki/OsmChange
137		*/
138		public function getOsmChangeXml()
139		{
140	7	$type = $this->getType();
141	7	if ($this->dirty) {
142	2	$version = $this->getVersion();
143	2	$version++;
144	2	$domd = new DomDocument();
145	2	$domd->loadXml($this->getXml());
146	2	$xpath = new DomXPath($domd);
147	2	$nodelist = $xpath->query("//{$type}");
148	2	$nodelist->item(0)->setAttribute('action', $this->action);
149	2	$nodelist->item(0)->setAttribute('id', $this->getId());
150
151	2	if (!is_null($this->changesetId)) {
152	1	$nodelist->item(0)->setAttribute('changeset', $this->changesetId);
153	1	}
154	2	$tags = $xpath->query("//{$type}/tag");
155
156	2	$set = array();
157	2	for ($i = 0; $i < $tags->length; $i++) {
158	1	$key = $tags->item($i)->getAttribute('k');
159	1	$val = $tags->item($i)->getAttribute('v');
160	1	$set[$key] = $val;
161	1	}
162
163	2	$diff = array_diff($this->getTags(), $set);
164
165		// Remove existing tags
166	2	for ($i = 0; $i < $tags->length; $i++) {
167	1	$rkey = $tags->item($i)->getAttribute('k');
168	1	if (isset($diff[$rkey])) {
169	1	$nodelist->item(0)->removeChild($tags->item($i));
170	1	}
171	1	}
172
173	2	foreach ($diff as $key=>$value) {
174	2	$new = $domd->createElement('tag');
175	2	$new->setAttribute('k', $key);
176	2	$new->setAttribute('v', $value);
177	2	$nodelist->item(0)->appendChild($new);
178	2	}
179
180	2	$xml = $domd->saveXml($nodelist->item(0));
181	2	$xml = "<{$this->action}>{$xml}</{$this->action}>";
182	2	return $this->osmChangeXml($xml);
183
184	5	} elseif ($this->action == 'delete') {
185	4	$xml = null;
186	4	$domd = new DomDocument();
187	4	$domd->loadXml($this->getXml());
188	4	$xpath = new DomXPath($domd);
189	4	$n = $xpath->query("//{$type}");
190	4	$version = $this->getVersion();
191	4	$version++;
192	4	if (!is_null($this->changesetId)) {
193	4	$n->item(0)->setAttribute('changeset', $this->changesetId);
194	4	}
195	4	$n->item(0)->setAttribute('action', 'delete');
196	4	$xml = $domd->saveXml($n->item(0));
197	4	return $this->osmChangeXml("<delete>{$xml}</delete>");
198	4	}
199		}
200
201		/**
202		* Amend changeXML with specific updates as appropriate.
203		*
204		* @param string $xml OsmChange XML as generated by getOsmChangeXml
205		*
206		* @return string
207		* @see getOsmChangeXml
208		* @link http://wiki.openstreetmap.org/wiki/OsmChange
209		*/
210		public function osmChangeXml($xml)
211		{
212	5	return $xml;
213		}
214
215		/**
216		* Retrieve the id of the object in question.
217		*
218		* @return integer id of the object
219		*/
220		public function getId()
221		{
222	22	if (!is_null($this->id)) {
223	9	return $this->id;
224	9	}
225
226	19	$attribs = $this->getAttributes();
227	19	if (!is_null($attribs)) {
228	17	return (integer) $attribs->id;
229	17	}
230		}
231
232		/**
233		* Set the id value of the object in question.
234		*
235		* <pre>
236		* $obj->setId($id)->...
237		* </pre>
238		*
239		* @param integer $value new id of the object
240		*
241		* @return Services_Openstreetmap_Object
242		*/
243		public function setId($value)
244		{
245	7	$this->id = $value;
246	7	return $this;
247		}
248
249		/**
250		* Retrieve the uid of the object in question.
251		*
252		* @return integer uid of the object
253		*/
254		public function getUid()
255		{
256	3	$attribs = $this->getAttributes();
257	3	if (!is_null($attribs)) {
258	2	return (integer) $attribs->uid;
259	2	}
260		}
261
262		/**
263		* Retrieve the user (creator/editor) of the object in question.
264		*
265		* @return string user of the object
266		*/
267		public function getUser()
268		{
269	3	$attribs = $this->getAttributes();
270	3	if (!is_null($attribs)) {
271	2	return (string) $attribs->user;
272	2	}
273		}
274
275		/**
276		* Retrieve the version of the object in question
277		*
278		* @return string version of the object
279		*/
280		public function getVersion()
281		{
282	10	$attribs = $this->getAttributes();
283	10	if (!is_null($attribs)) {
284	9	return (integer) $attribs->version;
285	9	}
286		}
287
288		/**
289		* Return the attributes set for this object in question.
290		*
291		* @return string getAttributes()
292		*/
293		public function getAttributes()
294		{
295
296	29	if (is_null($this->obj[0])) {
297	10	return null;
298	10	}
299	24	return $this->obj[0]->attributes();
300		}
301
302		/**
303		* Return the tags set for this object in question.
304		*
305		* @return array tags
306		*/
307		public function getTags()
308		{
309	19	return $this->tags;
310		}
311
312
313		/**
314		* Return value of specified tag as set against this object.
315		* If tag isn't set, return null.
316		*
317		* @param string $key Key value, For example, 'amenity', 'highway' etc
318		*
319		* @return string
320		*/
321		public function getTag($key)
322		{
323	1	if (isset($this->tags[$key])) {
324	1	return $this->tags[$key];
325	1	} else {
326		return null;
327		}
328		}
329
330		/**
331		* Return which type of object this is.
332		*
333		* @return string type
334		*/
335		public function getType()
336		{
337	32	return $this->type;
338		}
339
340		/**
341		* Get each distinct version of an object.
342		*
343		* @return Services_Openstreetmap_Objects
344		*/
345		public function history()
346		{
347	2	$transport = null;
348	2	$type = $this->getType();
349	2	$id = $this->getId();
350	2	$config = $this->getConfig();
351	2	$url = $config->getValue('server')
352		. 'api/'
353	2	. $config->getValue('api_version')
354	2	. "/$type/$id/history";
355	2	$class = 'Services_Openstreetmap_' . ucfirst($type) . 's';
356	2	$transport = $this->getTransport();
357	2	$response = $transport->getResponse($url);
358	2	$obj = new $class();
359	2	$sxe = @simplexml_load_string($response->getBody());
360	2	if ($sxe === false) {
361		$obj->setVal(trim($response->getBody()));
362		} else {
363	2	$obj->setXml($sxe);
364		}
365	2	return $obj;
366		}
367
368		/**
369		* Get all relations referring to the object in question.
370		*
371		* @return Services_Openstreetmap_Relations
372		*/
373		public function getRelations()
374		{
375	2	$type = $this->getType();
376	2	$id = $this->getId();
377	2	$config = $this->getConfig();
378	2	$url = $config->getValue('server')
379		. 'api/'
380	2	. $config->getValue('api_version')
381	2	. "/$type/$id/relations";
382	2	$response = $this->getTransport()->getResponse($url);
383	2	$obj = new Services_Openstreetmap_Relations();
384	2	$sxe = @simplexml_load_string($response->getBody());
385	2	if ($sxe === false) {
386		$obj->setVal(trim($response->getBody()));
387		} else {
388	2	$obj->setXml($sxe);
389		}
390	2	return $obj;
391		}
392
393		/**
394		* setTag
395		*
396		* <pre>
397		* $obj->setTag('key', 'value')->setTag(...);
398		* </pre>
399		*
400		* @param mixed $key key
401		* @param mixed $value value
402		*
403		* @return void
404		*/
405		public function setTag($key, $value)
406		{
407	6	if (is_null($this->action)) {
408	5	if ($this->getId() < 0) {
409	4	$this->action = 'create';
410	4	} else {
411	1	$this->action = 'modify';
412		}
413	5	}
414	6	$this->dirty = true;
415	6	$this->tags[$key] = $value;
416	6	return $this;
417		}
418
419		/**
420		* Mark the object as deleted.
421		*
422		* <pre>
423		* $obj->delete();
424		* </pre>
425		*
426		* @return void
427		*/
428		public function delete()
429		{
430	4	$this->action = 'delete';
431	4	return $this;
432		}
433
434		/**
435		* Set Config object
436		*
437		* @param Services_Openstreetmap_Config $config Config object
438		*
439		* @return Services_Openstreetmap_Changeset
440		*/
441		public function setConfig(Services_Openstreetmap_Config $config)
442		{
443	31	$this->config = $config;
444	31	return $this;
445		}
446
447		/**
448		* Get current Config object
449		*
450		* @return Services_Openstreetmap_Config
451		*/
452		public function getConfig()
453		{
454	14	return $this->config;
455		}
456
457		/**
458		* Set the Transport instance.
459		*
460		* @param Services_Openstreetmap_Transport $transport Transport instance.
461		*
462		* @return Services_Openstreetmap_Config
463		*/
464		public function setTransport($transport)
465		{
466	32	$this->transport = $transport;
467	32	return $this;
468		}
469
470		/**
471		* Retrieve the current Transport instance.
472		*
473		* @return Services_Openstreetmap_Transport.
474		*/
475		public function getTransport()
476		{
477	12	return $this->transport;
478		}
479		}
480
481		// vim:set et ts=4 sw=4:
482		?>

Source Code Coverage