Subversion-Projekte lars-tiefland.php_share

<?php

/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4 foldmethod=marker: */

// LICENSE AGREEMENT. If folded, press za here to unfold and read license {{{

/**

* +-----------------------------------------------------------------------------+

* | Copyright (c) 2004-2006 Sergio Goncalves Carvalho                                |

* +-----------------------------------------------------------------------------+

* | This file is part of XML_RPC2.                                              |

* |                                                                             |

* | XML_RPC2 is free software; you can redistribute it and/or modify            |

* | it under the terms of the GNU Lesser General Public License as published by |

* | the Free Software Foundation; either version 2.1 of the License, or         |

* | (at your option) any later version.                                         |

* |                                                                             |

* | XML_RPC2 is distributed in the hope that it will be useful,                 |

* | but WITHOUT ANY WARRANTY; without even the implied warranty of              |

* | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |

* | GNU Lesser General Public License for more details.                         |

* |                                                                             |

* | You should have received a copy of the GNU Lesser General Public License    |

* | along with XML_RPC2; if not, write to the Free Software                     |

* | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA                    |

* | 02111-1307 USA                                                              |

* +-----------------------------------------------------------------------------+

* | Author: Sergio Carvalho <sergio.carvalho@portugalmail.com>                  |

* +-----------------------------------------------------------------------------+

*

* @category   XML

* @package    XML_RPC2

* @author     Sergio Carvalho <sergio.carvalho@portugalmail.com>

* @copyright  2004-2006 Sergio Carvalho

* @license    http://www.gnu.org/copyleft/lesser.html  LGPL License 2.1

* @version    CVS: $Id: Struct.php 205683 2006-01-22 02:00:41Z fab $

* @link       http://pear.php.net/package/XML_RPC2

*/

// }}}

// dependencies {{{

require_once 'XML/RPC2/Exception.php';

require_once 'XML/RPC2/Backend/Php/Value.php';

// }}}

/**

 * XML_RPC struct value class. Represents values of type struct (associative struct)

 *

 * @category   XML

 * @package    XML_RPC2

 * @author     Sergio Carvalho <sergio.carvalho@portugalmail.com>

 * @copyright  2004-2006 Sergio Carvalho

 * @license    http://www.gnu.org/copyleft/lesser.html  LGPL License 2.1

 * @link       http://pear.php.net/package/XML_RPC2

 */

class XML_RPC2_Backend_Php_Value_Struct extends XML_RPC2_Backend_Php_Value

{

    // {{{ setNativeValue()

    /**

     * nativeValue property setter

     *

     * @param mixed value the new nativeValue

     */

    protected function setNativeValue($value)

    {

        if (!is_array($value)) {

            throw new XML_RPC2_InvalidTypeException(sprintf('Cannot create XML_RPC2_Backend_Php_Value_Struct from type \'%s\'.', gettype($nativeValue)));

        }

        parent::setNativeValue($value);

    }

    // }}}

    // {{{ constructor

    /**

     * Constructor. Will build a new XML_RPC2_Backend_Php_Value_Scalar with the given nativeValue

     *

     * @param mixed nativeValue

     */

    public function __construct($nativeValue)

    {

        $this->setNativeValue($nativeValue);

    }

    // }}}

    // {{{ encode()

    /**

     * Encode the instance into XML, for transport

     *

     * @return string The encoded XML-RPC value,

     */

    public function encode()

    {

        $result = '<struct>';

        foreach($this->getNativeValue() as $name => $element) {

            $result .= '<member>';

            $result .= '<name>';

            $result .= strtr($name, array('&' => '&amp;', '<' => '&lt;', '>' => '&gt;'));

            $result .= '</name>';

            $result .= '<value>';

            $result .= ($element instanceof XML_RPC2_Backend_Php_Value) ?

                        $element->encode() :

                        XML_RPC2_Backend_Php_Value::createFromNative($element)->encode();

            $result .= '</value>';

            $result .= '</member>';

        }

        $result .= '</struct>';

        return $result;

    }

    // }}}

    // {{{ decode()

    /**

     * Decode transport XML and set the instance value accordingly

     *

     * @param mixed The encoded XML-RPC value,

     */

    public static function decode($xml)

    {

        // TODO Remove reparsing of XML fragment, when SimpleXML proves more solid. Currently it segfaults when

        // xpath is used both in an element and in one of its children

        $xml = simplexml_load_string($xml->asXML());

        $values = $xml->xpath('/value/struct/member');

        $result = array();

        foreach (array_keys($values) as $i) {

            $result[(string) $values[$i]->name] = XML_RPC2_Backend_Php_Value::createFromDecode($values[$i]->value)->getNativeValue();

        }

        return $result;

    }

    // }}}

}

?>