library/Zend/Tool/Project/Profile/FileParser/Xml.php

   1 <?php
   2 /**
   3  * Zend Framework
   4  *
   5  * LICENSE
   6  *
   7  * This source file is subject to the new BSD license that is bundled
   8  * with this package in the file LICENSE.txt.
   9  * It is also available through the world-wide-web at this URL:
  10  * http://framework.zend.com/license/new-bsd
  11  * If you did not receive a copy of the license and are unable to
  12  * obtain it through the world-wide-web, please send an email
  13  * to license@zend.com so we can send you a copy immediately.
  14  *
  15  * @category   Zend
  16  * @package    Zend_Tool
  17  * @subpackage Framework
  18  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  19  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  20  * @version    $Id: Xml.php 16971 2009-07-22 18:05:45Z mikaelkael $
  21  */
  22
  23 require_once 'Zend/Tool/Project/Profile/FileParser/Interface.php';
  24 require_once 'Zend/Tool/Project/Context/Repository.php';
  25 require_once 'Zend/Tool/Project/Profile.php';
  26 require_once 'Zend/Tool/Project/Profile/Resource.php';
  27
  28 /**
  29  * @category   Zend
  30  * @package    Zend_Tool
  31  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  32  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  33  */
  34 class Zend_Tool_Project_Profile_FileParser_Xml implements Zend_Tool_Project_Profile_FileParser_Interface
  35 {
  36
  37     /**
  38      * @var Zend_Tool_Project_Profile
  39      */
  40     protected $_profile = null;
  41
  42     /**
  43      * @var Zend_Tool_Project_Context_Repository
  44      */
  45     protected $_contextRepository = null;
  46
  47     /**
  48      * __construct()
  49      *
  50      */
  51     public function __construct()
  52     {
  53         $this->_contextRepository = Zend_Tool_Project_Context_Repository::getInstance();
  54     }
  55
  56     /**
  57      * serialize()
  58      *
  59      * create an xml string from the provided profile
  60      *
  61      * @param Zend_Tool_Project_Profile $profile
  62      * @return string
  63      */
  64     public function serialize(Zend_Tool_Project_Profile $profile)
  65     {
  66
  67         $profile = clone $profile;
  68
  69         $this->_profile = $profile;
  70         $xmlElement = new SimpleXMLElement('<projectProfile />');
  71
  72         self::_serializeRecurser($profile, $xmlElement);
  73
  74         $doc = new DOMDocument('1.0');
  75         $doc->formatOutput = true;
  76         $domnode = dom_import_simplexml($xmlElement);
  77         $domnode = $doc->importNode($domnode, true);
  78         $domnode = $doc->appendChild($domnode);
  79
  80         return $doc->saveXML();
  81     }
  82
  83     /**
  84      * unserialize()
  85      *
  86      * Create a structure in the object $profile from the structure specficied
  87      * in the xml string provided
  88      *
  89      * @param string xml data
  90      * @param Zend_Tool_Project_Profile The profile to use as the top node
  91      * @return Zend_Tool_Project_Profile
  92      */
  93     public function unserialize($data, Zend_Tool_Project_Profile $profile)
  94     {
  95         if ($data == null) {
  96             throw new Exception('contents not available to unserialize.');
  97         }
  98
  99         $this->_profile = $profile;
 100
 101         $xmlDataIterator = new SimpleXMLIterator($data);
 102
 103         if ($xmlDataIterator->getName() != 'projectProfile') {
 104             throw new Exception('Profiles must start with a projectProfile node');
 105         }
 106
 107
 108         $this->_unserializeRecurser($xmlDataIterator);
 109
 110         $this->_lazyLoadContexts();
 111
 112         return $this->_profile;
 113
 114     }
 115
 116     /**
 117      * _serializeRecurser()
 118      *
 119      * This method will be used to traverse the depths of the structure
 120      * when *serializing* an xml structure into a string
 121      *
 122      * @param array $resources
 123      * @param SimpleXmlElement $xmlNode
 124      */
 125     protected function _serializeRecurser($resources, SimpleXmlElement $xmlNode)
 126     {
 127         // @todo find a better way to handle concurrency.. if no clone, _position in node gets messed up
 128         //if ($resources instanceof Zend_Tool_Project_Profile_Resource) {
 129         //    $resources = clone $resources;
 130         //}
 131
 132         foreach ($resources as $resource) {
 133
 134             if ($resource->isDeleted()) {
 135                 continue;
 136             }
 137
 138             $resourceName = $resource->getContext()->getName();
 139             $resourceName[0] = strtolower($resourceName[0]);
 140
 141             $newNode = $xmlNode->addChild($resourceName);
 142
 143             //$reflectionClass = new ReflectionClass($resource->getContext());
 144
 145             if ($resource->isEnabled() == false) {
 146                 $newNode->addAttribute('enabled', 'false');
 147             }
 148
 149             foreach ($resource->getPersistentAttributes() as $paramName => $paramValue) {
 150                 $newNode->addAttribute($paramName, $paramValue);
 151             }
 152
 153             if ($resource->hasChildren()) {
 154                 self::_serializeRecurser($resource, $newNode);
 155             }
 156
 157         }
 158
 159     }
 160
 161
 162     /**
 163      * _unserializeRecurser()
 164      *
 165      * This method will be used to traverse the depths of the structure
 166      * as needed to *unserialize* the profile from an xmlIterator
 167      *
 168      * @param SimpleXMLIterator $xmlIterator
 169      * @param Zend_Tool_Project_Profile_Resource $resource
 170      */
 171     protected function _unserializeRecurser(SimpleXMLIterator $xmlIterator, Zend_Tool_Project_Profile_Resource $resource = null)
 172     {
 173
 174         foreach ($xmlIterator as $resourceName => $resourceData) {
 175
 176             $contextName = $resourceName;
 177             $subResource = new Zend_Tool_Project_Profile_Resource($contextName);
 178             $subResource->setProfile($this->_profile);
 179
 180             if ($resourceAttributes = $resourceData->attributes()) {
 181                 $attributes = array();
 182                 foreach ($resourceAttributes as $attrName => $attrValue) {
 183                     $attributes[$attrName] = (string) $attrValue;
 184                 }
 185                 $subResource->setAttributes($attributes);
 186             }
 187
 188             if ($resource) {
 189                 $resource->append($subResource, false);
 190             } else {
 191                 $this->_profile->append($subResource);
 192             }
 193
 194             if ($this->_contextRepository->isOverwritableContext($contextName) == false) {
 195                 $subResource->initializeContext();
 196             }
 197
 198             if ($xmlIterator->hasChildren()) {
 199                 self::_unserializeRecurser($xmlIterator->getChildren(), $subResource);
 200             }
 201         }
 202     }
 203
 204     /**
 205      * _lazyLoadContexts()
 206      *
 207      * This method will call initializeContext on the resources in a profile
 208      * @todo determine if this method belongs inside the profile
 209      *
 210      */
 211     protected function _lazyLoadContexts()
 212     {
 213
 214         foreach ($this->_profile as $topResource) {
 215             $rii = new RecursiveIteratorIterator($topResource, RecursiveIteratorIterator::SELF_FIRST);
 216             foreach ($rii as $resource) {
 217                 $resource->initializeContext();
 218             }
 219         }
 220
 221     }
 222
 223 }