--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/web/lib/Zend/Amf/Adobe/Introspector.php Fri Mar 11 15:05:35 2011 +0100
@@ -0,0 +1,318 @@
+<?php
+/**
+ * Zend Framework
+ *
+ * LICENSE
+ *
+ * This source file is subject to the new BSD license that is bundled
+ * with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * http://framework.zend.com/license/new-bsd
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@zend.com so we can send you a copy immediately.
+ *
+ * @category Zend
+ * @package Zend_Amf
+ * @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license http://framework.zend.com/license/new-bsd New BSD License
+ * @version $Id: Introspector.php 23316 2010-11-10 16:37:40Z matthew $
+ */
+
+/** @see Zend_Amf_Parse_TypeLoader */
+require_once 'Zend/Amf/Parse/TypeLoader.php';
+
+/** @see Zend_Reflection_Class */
+require_once 'Zend/Reflection/Class.php';
+
+/** @see Zend_Server_Reflection */
+require_once 'Zend/Server/Reflection.php';
+
+/**
+ * This class implements a service for generating AMF service descriptions as XML.
+ *
+ * @package Zend_Amf
+ * @subpackage Adobe
+ * @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license http://framework.zend.com/license/new-bsd New BSD License
+ */
+class Zend_Amf_Adobe_Introspector
+{
+ /**
+ * Options used:
+ * - server: instance of Zend_Amf_Server to use
+ * - directories: directories where class files may be looked up
+ *
+ * @var array Introspector options
+ */
+ protected $_options;
+
+ /**
+ * @var DOMElement DOM element to store types
+ */
+ protected $_types;
+
+ /**
+ * @var array Map of the known types
+ */
+ protected $_typesMap = array();
+
+ /**
+ * @var DOMDocument XML document to store data
+ */
+ protected $_xml;
+
+ /**
+ * Constructor
+ *
+ * @return void
+ */
+ public function __construct()
+ {
+ $this->_xml = new DOMDocument('1.0', 'utf-8');
+ }
+
+ /**
+ * Create XML definition on an AMF service class
+ *
+ * @param string $serviceClass Service class name
+ * @param array $options invocation options
+ * @return string XML with service class introspection
+ */
+ public function introspect($serviceClass, $options = array())
+ {
+ $this->_options = $options;
+
+ if (strpbrk($serviceClass, '\\/<>')) {
+ return $this->_returnError('Invalid service name');
+ }
+
+ // Transform com.foo.Bar into com_foo_Bar
+ $serviceClass = str_replace('.' , '_', $serviceClass);
+
+ // Introspect!
+ if (!class_exists($serviceClass)) {
+ require_once 'Zend/Loader.php';
+ Zend_Loader::loadClass($serviceClass, $this->_getServicePath());
+ }
+
+ $serv = $this->_xml->createElement('service-description');
+ $serv->setAttribute('xmlns', 'http://ns.adobe.com/flex/service-description/2008');
+
+ $this->_types = $this->_xml->createElement('types');
+ $this->_ops = $this->_xml->createElement('operations');
+
+ $r = Zend_Server_Reflection::reflectClass($serviceClass);
+ $this->_addService($r, $this->_ops);
+
+ $serv->appendChild($this->_types);
+ $serv->appendChild($this->_ops);
+ $this->_xml->appendChild($serv);
+
+ return $this->_xml->saveXML();
+ }
+
+ /**
+ * Authentication handler
+ *
+ * @param Zend_Acl $acl
+ * @return unknown_type
+ */
+ public function initAcl(Zend_Acl $acl)
+ {
+ return false; // we do not need auth for this class
+ }
+
+ /**
+ * Generate map of public class attributes
+ *
+ * @param string $typename type name
+ * @param DOMElement $typexml target XML element
+ * @return void
+ */
+ protected function _addClassAttributes($typename, DOMElement $typexml)
+ {
+ // Do not try to autoload here because _phpTypeToAS should
+ // have already attempted to load this class
+ if (!class_exists($typename, false)) {
+ return;
+ }
+
+ $rc = new Zend_Reflection_Class($typename);
+ foreach ($rc->getProperties() as $prop) {
+ if (!$prop->isPublic()) {
+ continue;
+ }
+
+ $propxml = $this->_xml->createElement('property');
+ $propxml->setAttribute('name', $prop->getName());
+
+ $type = $this->_registerType($this->_getPropertyType($prop));
+ $propxml->setAttribute('type', $type);
+
+ $typexml->appendChild($propxml);
+ }
+ }
+
+ /**
+ * Build XML service description from reflection class
+ *
+ * @param Zend_Server_Reflection_Class $refclass
+ * @param DOMElement $target target XML element
+ * @return void
+ */
+ protected function _addService(Zend_Server_Reflection_Class $refclass, DOMElement $target)
+ {
+ foreach ($refclass->getMethods() as $method) {
+ if (!$method->isPublic()
+ || $method->isConstructor()
+ || ('__' == substr($method->name, 0, 2))
+ ) {
+ continue;
+ }
+
+ foreach ($method->getPrototypes() as $proto) {
+ $op = $this->_xml->createElement('operation');
+ $op->setAttribute('name', $method->getName());
+
+ $rettype = $this->_registerType($proto->getReturnType());
+ $op->setAttribute('returnType', $rettype);
+
+ foreach ($proto->getParameters() as $param) {
+ $arg = $this->_xml->createElement('argument');
+ $arg->setAttribute('name', $param->getName());
+
+ $type = $param->getType();
+ if ($type == 'mixed' && ($pclass = $param->getClass())) {
+ $type = $pclass->getName();
+ }
+
+ $ptype = $this->_registerType($type);
+ $arg->setAttribute('type', $ptype);
+
+ if($param->isDefaultValueAvailable()) {
+ $arg->setAttribute('defaultvalue', $param->getDefaultValue());
+ }
+
+ $op->appendChild($arg);
+ }
+
+ $target->appendChild($op);
+ }
+ }
+ }
+
+ /**
+ * Extract type of the property from DocBlock
+ *
+ * @param Zend_Reflection_Property $prop reflection property object
+ * @return string Property type
+ */
+ protected function _getPropertyType(Zend_Reflection_Property $prop)
+ {
+ $docBlock = $prop->getDocComment();
+
+ if (!$docBlock) {
+ return 'Unknown';
+ }
+
+ if (!$docBlock->hasTag('var')) {
+ return 'Unknown';
+ }
+
+ $tag = $docBlock->getTag('var');
+ return trim($tag->getDescription());
+ }
+
+ /**
+ * Get the array of service directories
+ *
+ * @return array Service class directories
+ */
+ protected function _getServicePath()
+ {
+ if (isset($this->_options['server'])) {
+ return $this->_options['server']->getDirectory();
+ }
+
+ if (isset($this->_options['directories'])) {
+ return $this->_options['directories'];
+ }
+
+ return array();
+ }
+
+ /**
+ * Map from PHP type name to AS type name
+ *
+ * @param string $typename PHP type name
+ * @return string AS type name
+ */
+ protected function _phpTypeToAS($typename)
+ {
+ if (class_exists($typename)) {
+ $vars = get_class_vars($typename);
+
+ if (isset($vars['_explicitType'])) {
+ return $vars['_explicitType'];
+ }
+ }
+
+ if (false !== ($asname = Zend_Amf_Parse_TypeLoader::getMappedClassName($typename))) {
+ return $asname;
+ }
+
+ return $typename;
+ }
+
+ /**
+ * Register new type on the system
+ *
+ * @param string $typename type name
+ * @return string New type name
+ */
+ protected function _registerType($typename)
+ {
+ // Known type - return its AS name
+ if (isset($this->_typesMap[$typename])) {
+ return $this->_typesMap[$typename];
+ }
+
+ // Standard types
+ if (in_array($typename, array('void', 'null', 'mixed', 'unknown_type'))) {
+ return 'Unknown';
+ }
+
+ // Arrays
+ if ('array' == $typename) {
+ return 'Unknown[]';
+ }
+
+ if (in_array($typename, array('int', 'integer', 'bool', 'boolean', 'float', 'string', 'object', 'Unknown', 'stdClass'))) {
+ return $typename;
+ }
+
+ // Resolve and store AS name
+ $asTypeName = $this->_phpTypeToAS($typename);
+ $this->_typesMap[$typename] = $asTypeName;
+
+ // Create element for the name
+ $typeEl = $this->_xml->createElement('type');
+ $typeEl->setAttribute('name', $asTypeName);
+ $this->_addClassAttributes($typename, $typeEl);
+ $this->_types->appendChild($typeEl);
+
+ return $asTypeName;
+ }
+
+ /**
+ * Return error with error message
+ *
+ * @param string $msg Error message
+ * @return string
+ */
+ protected function _returnError($msg)
+ {
+ return 'ERROR: $msg';
+ }
+}