Overview

Packages

  • currencysymbol
  • MAbout
  • Mage
    • Admin
    • Adminhtml
    • AdminNotification
    • Api
    • Api2
    • Authorizenet
    • Backup
    • Bundle
    • Captcha
    • Catalog
    • CatalogIndex
    • CatalogInventory
    • CatalogRule
    • CatalogSearch
    • Centinel
    • Checkout
    • Cms
    • Compiler
    • Connect
    • Contacts
    • Core
    • Cron
    • CurrencySymbol
    • Customer
    • Dataflow
    • Directory
    • DirtectPost
    • Downloadable
    • Eav
    • GiftMessage
    • GoogleAnalytics
    • GoogleBase
    • GoogleCheckout
    • ImportExport
    • Index
    • Install
    • Log
    • Media
    • Newsletter
    • Oauth
    • Page
    • PageCache
    • Paygate
    • Payment
    • Paypal
    • PaypalUk
    • Persistent
    • Poll
    • ProductAlert
    • Rating
    • Reports
    • Review
    • Rss
    • Rule
    • Sales
    • SalesRule
    • Sedfriend
    • Sendfriend
    • Shipping
    • Sitemap
    • Tag
    • Tax
    • Usa
    • Weee
    • Widget
    • Wishlist
    • XmlConnect
  • None
  • Phoenix
    • Moneybookers
  • PHP
  • Zend
    • Date
    • Mime
    • XmlRpc

Classes

  • Mage_Api_Controller_Action
  • Mage_Api_Helper_Data
  • Mage_Api_IndexController
  • Mage_Api_Model_Acl
  • Mage_Api_Model_Acl_Assert_Ip
  • Mage_Api_Model_Acl_Assert_Time
  • Mage_Api_Model_Acl_Resource
  • Mage_Api_Model_Acl_Role
  • Mage_Api_Model_Acl_Role_Generic
  • Mage_Api_Model_Acl_Role_Group
  • Mage_Api_Model_Acl_Role_Registry
  • Mage_Api_Model_Acl_Role_User
  • Mage_Api_Model_Config
  • Mage_Api_Model_Mysql4_Acl
  • Mage_Api_Model_Mysql4_Acl_Role
  • Mage_Api_Model_Mysql4_Acl_Role_Collection
  • Mage_Api_Model_Mysql4_Permissions_Collection
  • Mage_Api_Model_Mysql4_Role
  • Mage_Api_Model_Mysql4_Role_Collection
  • Mage_Api_Model_Mysql4_Roles
  • Mage_Api_Model_Mysql4_Roles_Collection
  • Mage_Api_Model_Mysql4_Roles_User_Collection
  • Mage_Api_Model_Mysql4_Rules
  • Mage_Api_Model_Mysql4_Rules_Collection
  • Mage_Api_Model_Mysql4_User
  • Mage_Api_Model_Mysql4_User_Collection
  • Mage_Api_Model_Resource_Abstract
  • Mage_Api_Model_Resource_Acl
  • Mage_Api_Model_Resource_Acl_Role
  • Mage_Api_Model_Resource_Acl_Role_Collection
  • Mage_Api_Model_Resource_Permissions_Collection
  • Mage_Api_Model_Resource_Role
  • Mage_Api_Model_Resource_Role_Collection
  • Mage_Api_Model_Resource_Roles
  • Mage_Api_Model_Resource_Roles_Collection
  • Mage_Api_Model_Resource_Roles_User_Collection
  • Mage_Api_Model_Resource_Rules
  • Mage_Api_Model_Resource_Rules_Collection
  • Mage_Api_Model_Resource_User
  • Mage_Api_Model_Resource_User_Collection
  • Mage_Api_Model_Role
  • Mage_Api_Model_Roles
  • Mage_Api_Model_Rules
  • Mage_Api_Model_Server
  • Mage_Api_Model_Server_Adapter_Soap
  • Mage_Api_Model_Server_Adapter_Xmlrpc
  • Mage_Api_Model_Server_Handler
  • Mage_Api_Model_Server_Handler_Abstract
  • Mage_Api_Model_Server_V2_Adapter_Soap
  • Mage_Api_Model_Server_V2_Handler
  • Mage_Api_Model_Server_WSI_Adapter_Soap
  • Mage_Api_Model_Server_WSI_Handler
  • Mage_Api_Model_Session
  • Mage_Api_Model_User
  • Mage_Api_Model_Wsdl_Config
  • Mage_Api_Model_Wsdl_Config_Base
  • Mage_Api_SoapController
  • Mage_Api_V2_SoapController
  • Mage_Api_XmlrpcController

Interfaces

  • Mage_Api_Model_Server_Adapter_Interface

Exceptions

  • Mage_Api_Exception
  • Overview
  • Package
  • Class
  • Tree
  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:  * Webservice XmlRpc adapter
 29:  *
 30:  * @category   Mage
 31:  * @package    Mage_Api
 32:  * @author     Magento Core Team <core@magentocommerce.com>
 33:  */
 34: class Mage_Api_Model_Server_Adapter_Xmlrpc
 35:     extends Varien_Object
 36:     implements Mage_Api_Model_Server_Adapter_Interface
 37: {
 38:      /**
 39:       * XmlRpc Server
 40:       *
 41:       * @var Zend_XmlRpc_Server
 42:       */
 43:      protected $_xmlRpc = null;
 44: 
 45:      /**
 46:      * Set handler class name for webservice
 47:      *
 48:      * @param string $handler
 49:      * @return Mage_Api_Model_Server_Adapter_Xmlrpc
 50:      */
 51:     public function setHandler($handler)
 52:     {
 53:         $this->setData('handler', $handler);
 54:         return $this;
 55:     }
 56: 
 57:     /**
 58:      * Retrive handler class name for webservice
 59:      *
 60:      * @return string
 61:      */
 62:     public function getHandler()
 63:     {
 64:         return $this->getData('handler');
 65:     }
 66: 
 67:      /**
 68:      * Set webservice api controller
 69:      *
 70:      * @param Mage_Api_Controller_Action $controller
 71:      * @return Mage_Api_Model_Server_Adapter_Xmlrpc
 72:      */
 73:     public function setController(Mage_Api_Controller_Action $controller)
 74:     {
 75:          $this->setData('controller', $controller);
 76:          return $this;
 77:     }
 78: 
 79:     /**
 80:      * Retrive webservice api controller. If no controller have been set - emulate it by the use of Varien_Object
 81:      *
 82:      * @return Mage_Api_Controller_Action|Varien_Object
 83:      */
 84:     public function getController()
 85:     {
 86:         $controller = $this->getData('controller');
 87: 
 88:         if (null === $controller) {
 89:             $controller = new Varien_Object(
 90:                 array('request' => Mage::app()->getRequest(), 'response' => Mage::app()->getResponse())
 91:             );
 92: 
 93:             $this->setData('controller', $controller);
 94:         }
 95:         return $controller;
 96:     }
 97: 
 98:     /**
 99:      * Run webservice
100:      *
101:      * @return Mage_Api_Model_Server_Adapter_Xmlrpc
102:      */
103:     public function run()
104:     {
105:         $apiConfigCharset = Mage::getStoreConfig("api/config/charset");
106: 
107:         $this->_xmlRpc = new Zend_XmlRpc_Server();
108:         $this->_xmlRpc->setEncoding($apiConfigCharset)
109:             ->setClass($this->getHandler());
110:         $this->getController()->getResponse()
111:             ->clearHeaders()
112:             ->setHeader('Content-Type','text/xml; charset='.$apiConfigCharset)
113:             ->setBody($this->_xmlRpc->handle());
114:         return $this;
115:     }
116: 
117:     /**
118:      * Dispatch webservice fault
119:      *
120:      * @param int $code
121:      * @param string $message
122:      */
123:     public function fault($code, $message)
124:     {
125:         throw new Zend_XmlRpc_Server_Exception($message, $code);
126:     }
127: } // Class Mage_Api_Model_Server_Adapter_Xmlrpc End
128: 
Magento 1.7.0.2 API documentation generated by ApiGen 2.8.0