Mage_Api_Model_Server_Handler_Abstract Class Reference

Inheritance diagram for Mage_Api_Model_Server_Handler_Abstract:

Mage_Api_Model_Server_Handler Mage_Api_Model_Server_V2_Handler

List of all members.

Public Member Functions

 __construct ()
 startSession ()
 endSession ($sessionId)
 login ($username, $apiKey)
 call ($sessionId, $apiPath, $args=array())
 multiCall ($sessionId, array $calls=array(), $options=array())
 resources ($sessionId)
 resourceFaults ($sessionId, $resourceName)
 globalFaults ($sessionId)

Static Public Member Functions

static handlePhpError ($errorCode, $errorMessage, $errorFile)

Protected Member Functions

 _getSession ()
 _getConfig ()
 _getServer ()
 _startSession ($sessionId=null)
 _isAllowed ($resource, $privilege=null)
 _isSessionExpired ()
 _fault ($faultName, $resourceName=null, $customMessage=null)
 _faultAsArray ($faultName, $resourceName=null, $customMessage=null)
 _prepareResourceModelName ($resource)

Protected Attributes

 $_resourceSuffix = null

Detailed Description

Definition at line 34 of file Abstract.php.

Constructor & Destructor Documentation

__construct (  ) 

Definition at line 38 of file Abstract.php.

00039     {
00040         set_error_handler(array(get_class($this), 'handlePhpError'), E_ALL);
00041     }

Member Function Documentation

_fault ( $  faultName,
$  resourceName = null,
$  customMessage = null 
) [protected]

Dispatch webservice fault

Parameters:
string $faultName
string $resourceName
string $customMessage

Definition at line 126 of file Abstract.php.

00127     {
00128         $faults = $this->_getConfig()->getFaults($resourceName);
00129         if (!isset($faults[$faultName]) && !is_null($resourceName)) {
00130             $this->_fault($faultName);
00131             return;
00132         } elseif (!isset($faults[$faultName])) {
00133             $this->_fault('unknown');
00134             return;
00135         }
00136         $this->_getServer()->getAdapter()->fault(
00137             $faults[$faultName]['code'],
00138             (is_null($customMessage) ? $faults[$faultName]['message'] : $customMessage)
00139         );
00140     }

_faultAsArray ( $  faultName,
$  resourceName = null,
$  customMessage = null 
) [protected]

Retrive webservice fault as array

Parameters:
string $faultName
string $resourceName
string $customMessage
Returns:
array

Definition at line 150 of file Abstract.php.

00151     {
00152         $faults = $this->_getConfig()->getFaults($resourceName);
00153         if (!isset($faults[$faultName]) && !is_null($resourceName)) {
00154             return $this->_faultAsArray($faultName);
00155         } elseif (!isset($faults[$faultName])) {
00156             return $this->_faultAsArray('unknown');
00157         }
00158 
00159         return array(
00160             'isFault'      => true,
00161             'faultCode'    => $faults[$faultName]['code'],
00162             'faultMessage' => (is_null($customMessage) ? $faults[$faultName]['message'] : $customMessage)
00163         );
00164     }

_getConfig (  )  [protected]

Retrive webservice configuration

Returns:
Mage_Api_Model_Config

Definition at line 68 of file Abstract.php.

00069     {
00070         return Mage::getSingleton('api/config');
00071     }

_getServer (  )  [protected]

Retrive webservice server

Returns:
Mage_Api_Model_Server

Definition at line 78 of file Abstract.php.

00079     {
00080         return Mage::getSingleton('api/server');
00081     }

_getSession (  )  [protected]

Retrive webservice session

Returns:
Mage_Api_Model_Session

Definition at line 58 of file Abstract.php.

00059     {
00060         return Mage::getSingleton('api/session');
00061     }

_isAllowed ( $  resource,
$  privilege = null 
) [protected]

Check current user permission on resource and privilege

Parameters:
string $resource
string $privilege
Returns:
bool

Definition at line 104 of file Abstract.php.

00105     {
00106         return $this->_getSession()->isAllowed($resource, $privilege);
00107     }

_isSessionExpired (  )  [protected]

Check session expiration

Returns:
boolean

Definition at line 114 of file Abstract.php.

00115     {
00116         return $this->_getSession()->isSessionExpired();
00117     }

_prepareResourceModelName ( $  resource  )  [protected]

Enter description here...

Parameters:
string $resource
Returns:
string

Definition at line 197 of file Abstract.php.

00198     {
00199         if (null !== $this->_resourceSuffix) {
00200             return $resource . $this->_resourceSuffix;
00201         }
00202         return $resource;
00203     }

_startSession ( $  sessionId = null  )  [protected]

Start webservice session

Parameters:
string $sessionId
Returns:
Mage_Api_Model_Server_Handler_Abstract

Definition at line 89 of file Abstract.php.

00090     {
00091         $this->_getSession()->setSessionId($sessionId);
00092         $this->_getSession()->init('api', 'api');
00093         return $this;
00094     }

call ( $  sessionId,
$  apiPath,
$  args = array() 
)

Call resource functionality

Parameters:
string $sessionId
string $resourcePath
array $args
Returns:
mixed

Definition at line 231 of file Abstract.php.

00232     {
00233         $this->_startSession($sessionId);
00234 
00235         if (!$this->_getSession()->isLoggedIn($sessionId)) {
00236             return $this->_fault('session_expired');
00237         }
00238 
00239         list($resourceName, $methodName) = explode('.', $apiPath);
00240 
00241         if (empty($resourceName) || empty($methodName)) {
00242             return $this->_fault('resource_path_invalid');
00243         }
00244 
00245         $resourcesAlias = $this->_getConfig()->getResourcesAlias();
00246         $resources      = $this->_getConfig()->getResources();
00247         if (isset($resourcesAlias->$resourceName)) {
00248             $resourceName = (string) $resourcesAlias->$resourceName;
00249         }
00250 
00251         if (!isset($resources->$resourceName)
00252             || !isset($resources->$resourceName->methods->$methodName)) {
00253             return $this->_fault('resource_path_invalid');
00254         }
00255 
00256         if (!isset($resources->$resourceName->public)
00257             && isset($resources->$resourceName->acl)
00258             && !$this->_isAllowed((string)$resources->$resourceName->acl)) {
00259             return $this->_fault('access_denied');
00260 
00261         }
00262 
00263 
00264         if (!isset($resources->$resourceName->methods->$methodName->public)
00265             && isset($resources->$resourceName->methods->$methodName->acl)
00266             && !$this->_isAllowed((string)$resources->$resourceName->methods->$methodName->acl)) {
00267             return $this->_fault('access_denied');
00268         }
00269 
00270         $methodInfo = $resources->$resourceName->methods->$methodName;
00271 
00272         try {
00273             $method = (isset($methodInfo->method) ? (string) $methodInfo->method : $methodName);
00274 
00275             $modelName = $this->_prepareResourceModelName((string) $resources->$resourceName->model);
00276             try {
00277                 $model = Mage::getModel($modelName);
00278                 if ($model instanceof Mage_Api_Model_Resource_Abstract) {
00279                     $model->setResourceConfig($resources->$resourceName);
00280                 }
00281             } catch (Exception $e) {
00282                 throw new Mage_Api_Exception('resource_path_not_callable');
00283             }
00284 
00285             if (is_callable(array(&$model, $method))) {
00286                 if (isset($methodInfo->arguments) && ((string)$methodInfo->arguments) == 'array') {
00287                     return $model->$method((is_array($args) ? $args : array($args)));
00288                 } elseif (!is_array($args)) {
00289                     return $model->$method($args);
00290                 } else {
00291                     return call_user_func_array(array(&$model, $method), $args);
00292                 }
00293             } else {
00294                 throw new Mage_Api_Exception('resource_path_not_callable');
00295             }
00296         } catch (Mage_Api_Exception $e) {
00297             return $this->_fault($e->getMessage(), $resourceName, $e->getCustomMessage());
00298         } catch (Exception $e) {
00299             Mage::logException($e);
00300             return $this->_fault('internal', null, $e->getMessage());
00301         }
00302     }

endSession ( $  sessionId  ) 

End web service session

Parameters:
string $sessionId
Returns:
boolean

Definition at line 184 of file Abstract.php.

00185     {
00186         $this->_startSession($sessionId);
00187         $this->_getSession()->clear();
00188         return true;
00189     }

globalFaults ( $  sessionId  ) 

List of global faults

Parameters:
string $sessionId
Returns:
array

Definition at line 527 of file Abstract.php.

00528     {
00529         $this->_startSession($sessionId);
00530         return array_values($this->_getConfig()->getFaults());
00531     }

static handlePhpError ( $  errorCode,
$  errorMessage,
$  errorFile 
) [static]

Definition at line 43 of file Abstract.php.

00044     {
00045         Mage::log($errorMessage . $errorFile);
00046         if (in_array($errorCode, array(E_ERROR, E_USER_ERROR, E_RECOVERABLE_ERROR))) {
00047             $this->_fault('internal');
00048         }
00049         return true;
00050     }

login ( $  username,
$  apiKey 
)

Login user and Retrieve session id

Parameters:
string $username
string $apiKey
Returns:
string

Definition at line 212 of file Abstract.php.

00213     {
00214         $this->_startSession();
00215         try {
00216             $this->_getSession()->login($username, $apiKey);
00217         } catch (Exception $e) {
00218             return $this->_fault('access_denied');
00219         }
00220         return $this->_getSession()->getSessionId();
00221     }

multiCall ( $  sessionId,
array $  calls = array(),
$  options = array() 
)

Multiple calls of resource functionality

Parameters:
string $sessionId
array $calls
array $options
Returns:
array

Definition at line 312 of file Abstract.php.

00313     {
00314         $this->_startSession($sessionId);
00315 
00316         if (!$this->_getSession()->isLoggedIn($sessionId)) {
00317             return $this->_fault('session_expired');
00318         }
00319 
00320         $result = array();
00321 
00322         $resourcesAlias = $this->_getConfig()->getResourcesAlias();
00323         $resources      = $this->_getConfig()->getResources();
00324 
00325         foreach ($calls as $call) {
00326             if (!isset($call[0])) {
00327                 $result[] = $this->_faultAsArray('resource_path_invalid');
00328                 if (isset($options['break']) && $options['break']==1) {
00329                     break;
00330                 } else {
00331                     continue;
00332                 }
00333             }
00334 
00335             $apiPath = $call[0];
00336             $args    =  (isset($call[1]) ? $call[1] : array());
00337 
00338             list($resourceName, $methodName) = explode('.', $apiPath);
00339 
00340             if (empty($resourceName) || empty($methodName)) {
00341                 $result[] = $this->_faultAsArray('resource_path_invalid');
00342                 if (isset($options['break']) && $options['break']==1) {
00343                     break;
00344                 } else {
00345                     continue;
00346                 }
00347             }
00348 
00349             if (isset($resourcesAlias->$resourceName)) {
00350                 $resourceName = (string) $resourcesAlias->$resourceName;
00351             }
00352 
00353             if (!isset($resources->$resourceName)
00354                 || !isset($resources->$resourceName->methods->$methodName)) {
00355                 $result[] = $this->_faultAsArray('resource_path_invalid');
00356                 if (isset($options['break']) && $options['break']==1) {
00357                     break;
00358                 } else {
00359                     continue;
00360                 }
00361             }
00362 
00363             if (!isset($resources->$resourceName->public)
00364                 && isset($resources->$resourceName->acl)
00365                 && !$this->_isAllowed((string)$resources->$resourceName->acl)) {
00366                 $result[] = $this->_faultAsArray('access_denied');
00367                 if (isset($options['break']) && $options['break']==1) {
00368                     break;
00369                 } else {
00370                     continue;
00371                 }
00372             }
00373 
00374 
00375             if (!isset($resources->$resourceName->methods->$methodName->public)
00376                 && isset($resources->$resourceName->methods->$methodName->acl)
00377                 && !$this->_isAllowed((string)$resources->$resourceName->methods->$methodName->acl)) {
00378                 $result[] = $this->_faultAsArray('access_denied');
00379                 if (isset($options['break']) && $options['break']==1) {
00380                     break;
00381                 } else {
00382                     continue;
00383                 }
00384             }
00385 
00386             $methodInfo = $resources->$resourceName->methods->$methodName;
00387 
00388             try {
00389                 $method = (isset($methodInfo->method) ? (string) $methodInfo->method : $methodName);
00390 
00391                 $modelName = $this->_prepareResourceModelName((string) $resources->$resourceName->model);
00392                 try {
00393                     $model = Mage::getModel($modelName);
00394                 } catch (Exception $e) {
00395                     throw new Mage_Api_Exception('resource_path_not_callable');
00396                 }
00397 
00398                 if (is_callable(array(&$model, $method))) {
00399                     if (isset($methodInfo->arguments) && ((string)$methodInfo->arguments) == 'array') {
00400                         $result[] = $model->$method((is_array($args) ? $args : array($args)));
00401                     } elseif (!is_array($args)) {
00402                         $result[] = $model->$method($args);
00403                     } else {
00404                         $result[] = call_user_func_array(array(&$model, $method), $args);
00405                     }
00406                 } else {
00407                     throw new Mage_Api_Exception('resource_path_not_callable');
00408                 }
00409             } catch (Mage_Api_Exception $e) {
00410                 $result[] = $this->_faultAsArray($e->getMessage(), $resourceName, $e->getCustomMessage());
00411                 if (isset($options['break']) && $options['break']==1) {
00412                     break;
00413                 } else {
00414                     continue;
00415                 }
00416             } catch (Exception $e) {
00417                 Mage::logException($e);
00418                 $result[] = $this->_faultAsArray('internal');
00419                 if (isset($options['break']) && $options['break']==1) {
00420                     break;
00421                 } else {
00422                     continue;
00423                 }
00424             }
00425         }
00426 
00427         return $result;
00428     }

resourceFaults ( $  sessionId,
$  resourceName 
)

List of resource faults

Parameters:
string $sessionId
string $resourceName
Returns:
array

Definition at line 496 of file Abstract.php.

00497     {
00498         $this->_startSession($sessionId);
00499 
00500         $resourcesAlias = $this->_getConfig()->getResourcesAlias();
00501         $resources      = $this->_getConfig()->getResources();
00502 
00503         if (isset($resourcesAlias->$resourceName)) {
00504             $resourceName = (string) $resourcesAlias->$resourceName;
00505         }
00506 
00507 
00508         if (empty($resourceName)
00509             || !isset($resources->$resourceName)) {
00510             return $this->_fault('resource_path_invalid');
00511         }
00512 
00513         if (isset($resources->$resourceName->acl)
00514             && !$this->_isAllowed((string)$resources->$resourceName->acl)) {
00515             return $this->_fault('access_denied');
00516         }
00517 
00518         return array_values($this->_getConfig()->getFaults($resourceName));
00519     }

resources ( $  sessionId  ) 

List of available resources

Parameters:
string $sessionId
Returns:
array

Definition at line 436 of file Abstract.php.

00437     {
00438         $this->_startSession($sessionId);
00439         $resources = array();
00440 
00441         $resourcesAlias = array();
00442         foreach ($this->_getConfig()->getResourcesAlias() as $alias => $resourceName) {
00443             $resourcesAlias[(string) $resourceName][] = $alias;
00444         }
00445 
00446 
00447         foreach ($this->_getConfig()->getResources() as $resourceName => $resource) {
00448             if (isset($resource->acl) && !$this->_isAllowed((string) $resource->acl)) {
00449                 continue;
00450             }
00451 
00452             $methods = array();
00453             foreach ($resource->methods->children() as $methodName => $method) {
00454                 if (isset($method->acl) && !$this->_isAllowed((string) $method->acl)) {
00455                     continue;
00456                 }
00457                 $methodAliases = array();
00458                 if (isset($resourcesAlias[$resourceName])) {
00459                    foreach ($resourcesAlias[$resourceName] as $alias) {
00460                        $methodAliases[] =  $alias . '.' . $methodName;
00461                    }
00462                 }
00463 
00464                 $methods[] = array(
00465                     'title'       => (string) $method->title,
00466                     'description' => (isset($method->description) ? (string)$method->description : null),
00467                     'path'        => $resourceName . '.' . $methodName,
00468                     'name'        => $methodName,
00469                     'aliases'     => $methodAliases
00470                 );
00471             }
00472 
00473             if (count($methods) == 0) {
00474                 continue;
00475             }
00476 
00477             $resources[] = array(
00478                 'title'       => (string) $resource->title,
00479                 'description' => (isset($resource->description) ? (string)$resource->description : null),
00480                 'name'        => $resourceName,
00481                 'aliases'     => (isset($resourcesAlias[$resourceName]) ? $resourcesAlias[$resourceName] : array()),
00482                 'methods'     => $methods
00483             );
00484         }
00485 
00486         return $resources;
00487     }

startSession (  ) 

Start web service session

Returns:
string

Definition at line 171 of file Abstract.php.

00172     {
00173         $this->_startSession();
00174         return $this->_getSession()->getSessionId();
00175     }

Member Data Documentation

$_resourceSuffix = null [protected]

Reimplemented in Mage_Api_Model_Server_V2_Handler.

Definition at line 36 of file Abstract.php.

The documentation for this class was generated from the following file:
Generated on Sat Jul 4 17:23:33 2009 for Magento by  doxygen 1.5.8