1: <?php
  2: /**
  3:  * Magento
  4:  *
  5:  * NOTICE OF LICENSE
  6:  *
  7:  * This source file is subject to the Open Software License (OSL 3.0)
  8:  * that is bundled with this package in the file LICENSE.txt.
  9:  * It is also available through the world-wide-web at this URL:
 10:  * http://opensource.org/licenses/osl-3.0.php
 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@magentocommerce.com so we can send you a copy immediately.
 14:  *
 15:  * DISCLAIMER
 16:  *
 17:  * Do not edit or add to this file if you wish to upgrade Magento to newer
 18:  * versions in the future. If you wish to customize Magento for your
 19:  * needs please refer to http://www.magentocommerce.com for more information.
 20:  *
 21:  * @category    Mage
 22:  * @package     Mage_Api
 23:  * @copyright   Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
 24:  * @license     http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
 25:  */
 26: 
 27: 
 28: /**
 29:  * Wsdl element model
 30:  *
 31:  * @category   Mage
 32:  * @package    Mage_Core
 33:  */
 34: class Mage_Api_Model_Wsdl_Config_Element extends Varien_Simplexml_Element
 35: {
 36:     public function extend($source, $overwrite=false)
 37:     {
 38:         if (!$source instanceof Varien_Simplexml_Element) {
 39:             return $this;
 40:         }
 41: 
 42:         foreach ($this->getChildren($source) as $namespace => $children) {
 43:             foreach ($children as $child) {
 44:                 $this->extendChild($child, $overwrite, $namespace);
 45:             }
 46:         }
 47: 
 48:         return $this;
 49:     }
 50: 
 51:     /**
 52:      * Extends one node
 53:      *
 54:      * @param Varien_Simplexml_Element $source
 55:      * @param boolean $overwrite
 56:      * @return Varien_Simplexml_Element
 57:      */
 58:     public function extendChild($source, $overwrite=false, $elmNamespace = '')
 59:     {
 60:         // this will be our new target node
 61:         $targetChild = null;
 62: 
 63:         // name of the source node
 64:         $sourceName = $source->getName();
 65: 
 66:         // here we have children of our source node
 67:         $sourceChildren = $this->getChildren($source);
 68: 
 69:         if ($elmNamespace == '') {
 70:             $elmNamespace = null;
 71:         }
 72: 
 73:         if (!$source->hasChildren()) {
 74:             // handle string node
 75:             $elm = $this->getElementByName($source, $elmNamespace);
 76:             if (!is_null($elm)) {
 77: 
 78:                 // if target already has children return without regard
 79:                 if ($this->getChildren($elm)) {
 80:                     return $this;
 81:                 }
 82:                 if ($overwrite) {
 83: //                    unset($this->$sourceName);
 84:                     unset($elm);
 85:                 } else {
 86:                     return $this;
 87:                 }
 88:             }
 89:             $targetChild = $this->addChild($sourceName, $source->xmlentities(), $elmNamespace);
 90:             $targetChild->setParent($this);
 91:             foreach ($this->getAttributes($source) as $namespace => $attributes) {
 92:                 foreach ($attributes as $key => $value) {
 93:                     $_namespacesPrefix = Mage_Api_Model_Wsdl_Config::getNamespacesPrefix();
 94:                     if ($namespace == '') {
 95:                         $namespace = null;
 96:                     } elseif (array_key_exists($namespace, $_namespacesPrefix)) {
 97:                         $key = $_namespacesPrefix[$namespace] . ':' . $key;
 98:                     }
 99: 
100:                     $targetChild->addAttribute($key, $this->xmlentities($value), $namespace);
101:                 }
102:             }
103:             return $this;
104:         }
105: 
106:         $elm = $this->getElementByName($source, $elmNamespace);
107:         if (!is_null($elm)) {
108:             $targetChild = $elm;
109:         }
110:         if (is_null($targetChild)) {
111:             // if child target is not found create new and descend
112:             $targetChild = $this->addChild($sourceName, null, $elmNamespace);
113:             $targetChild->setParent($this);
114:             foreach ($this->getAttributes($source) as $namespace => $attributes) {
115:                 foreach ($attributes as $key => $value) {
116:                     $_namespacesPrefix = Mage_Api_Model_Wsdl_Config::getNamespacesPrefix();
117:                     if ($namespace == '') {
118:                         $namespace = null;
119:                     } elseif (array_key_exists($namespace, $_namespacesPrefix)) {
120:                         $key = $_namespacesPrefix[$namespace] . ':' . $key;
121:                     }
122:                     $targetChild->addAttribute($key, $this->xmlentities($value), $namespace);
123:                 }
124:             }
125:         }
126: 
127:         foreach ($sourceChildren as $elmNamespace => $children) {
128:             foreach ($children as $childKey => $childNode) {
129:                 $targetChild->extendChild($childNode, $overwrite, $elmNamespace);
130:             }
131:         }
132: 
133:         return $this;
134:     }
135: 
136:     /**
137:      * Return attributes of all namespaces
138:      *
139:      * array(
140:      *   namespace => array(
141:      *     attribute_key => attribute_value,
142:      *     ...
143:      *   )
144:      * )
145:      *
146:      * @param Varien_Simplexml_Element $source
147:      * @return array
148:      */
149:     public function getAttributes($source, $namespace = null)
150:     {
151:         $attributes = array();
152:         if (!is_null($namespace)) {
153:             $attributes[$namespace] = $source->attributes($namespace);
154:             return $attributes;
155:         }
156:         $namespaces = $source->getNamespaces(true);
157:         $attributes[''] = $source->attributes('');
158:         foreach ($namespaces as $key => $value) {
159:             if ($key == '' || $key == 'soap') {
160:                 continue;
161:             }
162:             $attributes[$value] = $source->attributes($value);
163:         }
164:         return $attributes;
165:     }
166: 
167:     /**
168:      * Return children of all namespaces
169:      *
170:      * @param Varien_Simplexml_Element $source
171:      */
172:     public function getChildren($source)
173:     {
174:         $children = array();
175:         $namespaces = $source->getNamespaces(true);
176: 
177:         $isWsi = Mage::helper('api/data')->isComplianceWSI();
178: 
179:         foreach ($namespaces as $key => $value) {
180:             if ($key == '' || (!$isWsi && $key == 'wsdl')) {
181:                 continue;
182:             }
183:             $children[$value] = $source->children($value);
184:         }
185:         $children[''] = $source->children('');
186:         return $children;
187:     }
188: 
189:     /**
190:      * Return if has children
191:      *
192:      * @return boolean
193:      */
194:     public function hasChildren()
195:     {
196:         if (!$this->getChildren($this)) {
197:             return false;
198:         }
199: 
200:         // simplexml bug: @attributes is in children() but invisible in foreach
201:         foreach ($this->getChildren($this) as $namespace => $children) {
202:             foreach ($children as $k => $child) {
203:                 return true;
204:             }
205:         }
206:         return false;
207:     }
208: 
209:     /**
210:      * Return element by tag name, and checking attributes with namespaces
211:      *
212:      * @param Varien_Simplexml_Element $source
213:      * @param string $namespace
214:      * @return null|Varien_Simplexml_Element
215:      */
216:     public function getElementByName($source, $elmNamespace = '')
217:     {
218:         $sourceName = $source->getName();
219:         $extendElmAttributes = $this->getAttributes($source);
220:         foreach ($this->children($elmNamespace) as $k => $child) {
221:             if ($child->getName() == $sourceName) {
222:                 $elm = true;
223:                 foreach ($extendElmAttributes as $namespace => $attributes) {
224:                     /**
225:                      * if count of attributes of extend element is 0 in $namespace,
226:                      * and current element has attributes in $namespace - different elements
227:                      */
228: //                    if (!count($attributes) && count($this->getAttributes($child, $namespace))) {
229: //                        foreach ($this->getAttributes($child, $namespace) as $attribute) {
230: //                            $elm = false;
231: //                            break;
232: //                        }
233: //                    }
234:                     foreach ($attributes as $key => $value) {
235:                         if (is_null($child->getAttribute($key, $namespace)) || $child->getAttribute($key, $namespace) != $value) {
236:                             $elm = false;
237:                         }
238:                     }
239:                 }
240:                 /**
241:                  * if count of namespaces attributes of element to extend is 0,
242:                  * but current element has namespaces attributes - different elements
243:                  */
244:                 if (!count($extendElmAttributes) && count($this->getAttributes($child))) {
245:                     $elm = false;
246:                 }
247:                 if ($elm) {
248:                     return $child;
249:                 }
250:             }
251:         }
252:         return null;
253:     }
254: 
255:     /**
256:      * Returns attribute value by attribute name
257:      *
258:      * @return string
259:      */
260:     public function getAttribute($name, $namespace = ''){
261:         $attrs = $this->attributes($namespace);
262:         return isset($attrs[$name]) ? (string)$attrs[$name] : null;
263:     }
264: 
265: }
266: