sunnysideup / silverstripe-ecommerce

code/api/EcommerceRestfulServer.php

<?php
/**
 * extends the standard RestfulServer to provide better access to extended classes.
 *
 * see: http://api.silverstripe.org/2.4/sapphire/api/RestfulServer.html
 *
 * You can show JSON by hacking: RestfulServer::getDataFormatter
 * NOTE: JSON IS NOT AVAILABLE YET WITHIN RESTFUL SERVER
 *
 * @todo:
 * - fix http://site/api/ecommerce/v1/Order/123/BillingAddress.xml
 * - fix http://site/api/ecommerce/v1/Order/123/ShippingAddress.xml
 * - fix http://site/api/ecommerce/v1/Order/123/Member.xml
 *
 * <b>Test Post</b>
 * <code>
 * $baseURL = Director::absoluteBaseURL();
 * 	// 1) My Personal Data
 * 	$className = 'EcommerceClassWithEditableFields';
 * 	$fields = array(
 * 		'MyField' => 1
 * 	);
 * 	// 2) The Query
 * 	$url = "{$baseURL}/api/ecommerce/v1/{$className}.xml";
 * 	$body = $fields;
 * 	$c = curl_init($url);
 * 	curl_setopt($c, CURLOPT_POST, true);
 * 	curl_setopt($c, CURLOPT_POSTFIELDS, $body);
 * 	curl_setopt($c, CURLOPT_RETURNTRANSFER, true);
 * 	$page = curl_exec($c);
 * 	curl_close($c);

 * 	// 3) The XML Result

 * 	return $page;
 * </code>
 *
 *
 * @authors: Romain [at] Sunny Side Up .co.nz
 * @package: ecommerce
 * @sub-package: api
 * @inspiration: Silverstripe Ltd, Jeremy
 **/
class EcommerceRestfulServer extends RestfulServer

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    public function index()

The return type could not be reliably inferred; please add a @return annotation.

    {
        XMLDataFormatter::$api_base = 'api/ecommerce/v1/';

The property api_base cannot be accessed from this context as it is declared private in class XMLDataFormatter.

        if (!isset($this->urlParams['ClassName'])) {
            return $this->notFound();
        }
        $className = $this->urlParams['ClassName'];
        $id = (isset($this->urlParams['ID'])) ? $this->urlParams['ID'] : null;
        $relation = (isset($this->urlParams['Relation'])) ? $this->urlParams['Relation'] : null;

        // Check input formats
        if (!class_exists($className)) {
            return $this->notFound();
        }
        if ($id && !is_numeric($id)) {
            return $this->notFound();
        }
        if ($relation && !preg_match('/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/', $relation)) {
            return $this->notFound();
        }

        // fix
        if ($id) {
            $obj = $className::get()->byID($id);
            if ($obj) {
                $className = $this->urlParams['ClassName'] = $obj->ClassName;
            } else {
                return $this->notFound();
            }
        }

        // if api access is disabled, don't proceed
        $apiAccess = singleton($className)->stat('api_access');
        if (!$apiAccess) {
            return $this->permissionFailure();
        }

        // authenticate through HTTP BasicAuth
        $this->member = $this->authenticate();

        // handle different HTTP verbs
        if ($this->request->isGET() || $this->request->isHEAD()) {
            return $this->getHandler($className, $id, $relation);
        }
        if ($this->request->isPOST()) {
            return $this->postHandler($className, $id, $relation);
        }
        if ($this->request->isPUT()) {
            return $this->putHandler($className, $id, $relation);
        }
        if ($this->request->isDELETE()) {
            return $this->deleteHandler($className, $id, $relation);
        }

        // if no HTTP verb matches, return error
        return $this->methodNotAllowed();
    }
}