Dolibarr / dolibarr

htdocs/includes/restler/framework/Luracast/Restler/Data/ValidationInfo.php

Indentation +227 added lines, -227 removed lines

@@ -19,255 +19,255 @@
  */
 class ValidationInfo implements iValueObject
 {
-    /**
-     * @var mixed given value for the parameter
-     */
-    public $value;
-    /**
-     * @var string proper name for given parameter
-     */
-    public $label;
-    /**
-     * @var string html element that can be used to represent the parameter for
-     *             input
-     */
-    public $field;
-    /**
-     * @var mixed default value for the parameter
-     */
-    public $default;
-    /**
-     * Name of the variable being validated
-     *
-     * @var string variable name
-     */
-    public $name;
+	/**
+	 * @var mixed given value for the parameter
+	 */
+	public $value;
+	/**
+	 * @var string proper name for given parameter
+	 */
+	public $label;
+	/**
+	 * @var string html element that can be used to represent the parameter for
+	 *             input
+	 */
+	public $field;
+	/**
+	 * @var mixed default value for the parameter
+	 */
+	public $default;
+	/**
+	 * Name of the variable being validated
+	 *
+	 * @var string variable name
+	 */
+	public $name;
 
-    /**
-     * @var bool is it required or not
-     */
-    public $required;
+	/**
+	 * @var bool is it required or not
+	 */
+	public $required;
 
-    /**
-     * @var string body or header or query where this parameter is coming from
-     * in the http request
-     */
-    public $from;
+	/**
+	 * @var string body or header or query where this parameter is coming from
+	 * in the http request
+	 */
+	public $from;
 
-    /**
-     * Data type of the variable being validated.
-     * It will be mostly string
-     *
-     * @var string|array multiple types are specified it will be of
-     *      type array otherwise it will be a string
-     */
-    public $type;
+	/**
+	 * Data type of the variable being validated.
+	 * It will be mostly string
+	 *
+	 * @var string|array multiple types are specified it will be of
+	 *      type array otherwise it will be a string
+	 */
+	public $type;
 
-    /**
-     * When the type is array, this field is used to define the type of the
-     * contents of the array
-     *
-     * @var string|null when all the items in an array are of certain type, we
-     * can set this property. It will be null if the items can be of any type
-     */
-    public $contentType;
+	/**
+	 * When the type is array, this field is used to define the type of the
+	 * contents of the array
+	 *
+	 * @var string|null when all the items in an array are of certain type, we
+	 * can set this property. It will be null if the items can be of any type
+	 */
+	public $contentType;
 
-    /**
-     * Should we attempt to fix the value?
-     * When set to false validation class should throw
-     * an exception or return false for the validate call.
-     * When set to true it will attempt to fix the value if possible
-     * or throw an exception or return false when it cant be fixed.
-     *
-     * @var boolean true or false
-     */
-    public $fix = false;
+	/**
+	 * Should we attempt to fix the value?
+	 * When set to false validation class should throw
+	 * an exception or return false for the validate call.
+	 * When set to true it will attempt to fix the value if possible
+	 * or throw an exception or return false when it cant be fixed.
+	 *
+	 * @var boolean true or false
+	 */
+	public $fix = false;
 
-    /**
-     * @var array of children to be validated
-     */
-    public $children = null;
+	/**
+	 * @var array of children to be validated
+	 */
+	public $children = null;
 
-    // ==================================================================
-    //
-    // VALUE RANGE
-    //
-    // ------------------------------------------------------------------
-    /**
-     * Given value should match one of the values in the array
-     *
-     * @var array of choices to match to
-     */
-    public $choice;
-    /**
-     * If the type is string it will set the lower limit for length
-     * else will specify the lower limit for the value
-     *
-     * @var number minimum value
-     */
-    public $min;
-    /**
-     * If the type is string it will set the upper limit limit for length
-     * else will specify the upper limit for the value
-     *
-     * @var number maximum value
-     */
-    public $max;
+	// ==================================================================
+	//
+	// VALUE RANGE
+	//
+	// ------------------------------------------------------------------
+	/**
+	 * Given value should match one of the values in the array
+	 *
+	 * @var array of choices to match to
+	 */
+	public $choice;
+	/**
+	 * If the type is string it will set the lower limit for length
+	 * else will specify the lower limit for the value
+	 *
+	 * @var number minimum value
+	 */
+	public $min;
+	/**
+	 * If the type is string it will set the upper limit limit for length
+	 * else will specify the upper limit for the value
+	 *
+	 * @var number maximum value
+	 */
+	public $max;
 
-    // ==================================================================
-    //
-    // REGEX VALIDATION
-    //
-    // ------------------------------------------------------------------
-    /**
-     * RegEx pattern to match the value
-     *
-     * @var string regular expression
-     */
-    public $pattern;
+	// ==================================================================
+	//
+	// REGEX VALIDATION
+	//
+	// ------------------------------------------------------------------
+	/**
+	 * RegEx pattern to match the value
+	 *
+	 * @var string regular expression
+	 */
+	public $pattern;
 
-    // ==================================================================
-    //
-    // CUSTOM VALIDATION
-    //
-    // ------------------------------------------------------------------
-    /**
-     * Rules specified for the parameter in the php doc comment.
-     * It is passed to the validation method as the second parameter
-     *
-     * @var array custom rule set
-     */
-    public $rules;
+	// ==================================================================
+	//
+	// CUSTOM VALIDATION
+	//
+	// ------------------------------------------------------------------
+	/**
+	 * Rules specified for the parameter in the php doc comment.
+	 * It is passed to the validation method as the second parameter
+	 *
+	 * @var array custom rule set
+	 */
+	public $rules;
 
-    /**
-     * Specifying a custom error message will override the standard error
-     * message return by the validator class
-     *
-     * @var string custom error response
-     */
-    public $message;
+	/**
+	 * Specifying a custom error message will override the standard error
+	 * message return by the validator class
+	 *
+	 * @var string custom error response
+	 */
+	public $message;
 
-    // ==================================================================
-    //
-    // METHODS
-    //
-    // ------------------------------------------------------------------
+	// ==================================================================
+	//
+	// METHODS
+	//
+	// ------------------------------------------------------------------
 
-    /**
-     * Name of the method to be used for validation.
-     * It will be receiving two parameters $input, $rules (array)
-     *
-     * @var string validation method name
-     */
-    public $method;
+	/**
+	 * Name of the method to be used for validation.
+	 * It will be receiving two parameters $input, $rules (array)
+	 *
+	 * @var string validation method name
+	 */
+	public $method;
 
-    /**
-     * Instance of the API class currently being called. It will be null most of
-     * the time. Only when method is defined it will contain an instance.
-     * This behavior is for lazy loading of the API class
-     *
-     * @var null|object will be null or api class instance
-     */
-    public $apiClassInstance = null;
+	/**
+	 * Instance of the API class currently being called. It will be null most of
+	 * the time. Only when method is defined it will contain an instance.
+	 * This behavior is for lazy loading of the API class
+	 *
+	 * @var null|object will be null or api class instance
+	 */
+	public $apiClassInstance = null;
 
-    public static function numericValue($value)
-    {
-        return ( int )$value == $value
-            ? ( int )$value
-            : floatval($value);
-    }
+	public static function numericValue($value)
+	{
+		return ( int )$value == $value
+			? ( int )$value
+			: floatval($value);
+	}
 
-    public static function arrayValue($value)
-    {
-        return is_array($value) ? $value : array(
-            $value
-        );
-    }
+	public static function arrayValue($value)
+	{
+		return is_array($value) ? $value : array(
+			$value
+		);
+	}
 
-    public static function stringValue($value, $glue = ',')
-    {
-        return is_array($value)
-            ? implode($glue, $value)
-            : ( string )$value;
-    }
+	public static function stringValue($value, $glue = ',')
+	{
+		return is_array($value)
+			? implode($glue, $value)
+			: ( string )$value;
+	}
 
-    public static function booleanValue($value)
-    {
-        return is_bool($value)
-            ? $value
-            : $value !== 'false';
-    }
+	public static function booleanValue($value)
+	{
+		return is_bool($value)
+			? $value
+			: $value !== 'false';
+	}
 
-    public static function filterArray(array $data, $keepNumericKeys)
-    {
-        $r = array();
-        foreach ($data as $key => $value) {
-            if (is_numeric($key)) {
-                if ($keepNumericKeys) {
-                    $r[$key] = $value;
-                }
-            } elseif (!$keepNumericKeys) {
-                $r[$key] = $value;
-            }
-        }
-        return $r;
-    }
+	public static function filterArray(array $data, $keepNumericKeys)
+	{
+		$r = array();
+		foreach ($data as $key => $value) {
+			if (is_numeric($key)) {
+				if ($keepNumericKeys) {
+					$r[$key] = $value;
+				}
+			} elseif (!$keepNumericKeys) {
+				$r[$key] = $value;
+			}
+		}
+		return $r;
+	}
 
-    public function __toString()
-    {
-        return ' new ValidationInfo() ';
-    }
+	public function __toString()
+	{
+		return ' new ValidationInfo() ';
+	}
 
-    private function getProperty(array &$from, $property)
-    {
-        $p = Util::nestedValue($from, $property);
-        unset($from[$property]);
-        $p2 = Util::nestedValue(
-            $from, CommentParser::$embeddedDataName, $property
-        );
-        unset($from[CommentParser::$embeddedDataName][$property]);
+	private function getProperty(array &$from, $property)
+	{
+		$p = Util::nestedValue($from, $property);
+		unset($from[$property]);
+		$p2 = Util::nestedValue(
+			$from, CommentParser::$embeddedDataName, $property
+		);
+		unset($from[CommentParser::$embeddedDataName][$property]);
 
-        if ($property == 'type' && $p == 'array' && $p2) {
-            $this->contentType = $p2;
-            return $p;
-        }
-        $r = is_null($p2) ? (is_null($p) ? null : $p) : $p2;
-        if (!is_null($r)) {
-            if ($property == 'min' || $property == 'max') {
-                return static::numericValue($r);
-            } elseif ($property == 'required' || $property == 'fix') {
-                return static::booleanValue($r);
-            } elseif ($property == 'choice') {
-                return static::arrayValue($r);
-            } elseif ($property == 'pattern') {
-                return static::stringValue($r);
-            }
-        }
-        return $r;
-    }
+		if ($property == 'type' && $p == 'array' && $p2) {
+			$this->contentType = $p2;
+			return $p;
+		}
+		$r = is_null($p2) ? (is_null($p) ? null : $p) : $p2;
+		if (!is_null($r)) {
+			if ($property == 'min' || $property == 'max') {
+				return static::numericValue($r);
+			} elseif ($property == 'required' || $property == 'fix') {
+				return static::booleanValue($r);
+			} elseif ($property == 'choice') {
+				return static::arrayValue($r);
+			} elseif ($property == 'pattern') {
+				return static::stringValue($r);
+			}
+		}
+		return $r;
+	}
 
-    public function __construct(array $info)
-    {
-        $properties = get_object_vars($this);
-        unset($properties['contentType']);
-        foreach ($properties as $property => $value) {
-            $this->{$property} = $this->getProperty($info, $property);
-        }
-        $inner = Util::nestedValue($info, 'properties');
-        $this->rules = !empty($inner) ? $inner + $info : $info;
-        unset($this->rules['properties']);
-        if (is_string($this->type) && $this->type == 'integer') {
-            $this->type = 'int';
-        }
-    }
+	public function __construct(array $info)
+	{
+		$properties = get_object_vars($this);
+		unset($properties['contentType']);
+		foreach ($properties as $property => $value) {
+			$this->{$property} = $this->getProperty($info, $property);
+		}
+		$inner = Util::nestedValue($info, 'properties');
+		$this->rules = !empty($inner) ? $inner + $info : $info;
+		unset($this->rules['properties']);
+		if (is_string($this->type) && $this->type == 'integer') {
+			$this->type = 'int';
+		}
+	}
 
-    /**
-     * Magic Method used for creating instance at run time
-     */
-    public static function __set_state(array $info)
-    {
-        $o = new self ($info);
-        return $o;
-    }
+	/**
+	 * Magic Method used for creating instance at run time
+	 */
+	public static function __set_state(array $info)
+	{
+		$o = new self ($info);
+		return $o;
+	}
 }
 

Spacing +4 added lines, -4 removed lines

@@ -172,8 +172,8 @@ 
 
     public static function numericValue($value)
     {
-        return ( int )$value == $value
-            ? ( int )$value
+        return (int) $value == $value
+            ? (int) $value
             : floatval($value);
     }
 
@@ -188,7 +188,7 @@ 
     {
         return is_array($value)
             ? implode($glue, $value)
-            : ( string )$value;
+            : (string) $value;
     }
 
     public static function booleanValue($value)
@@ -266,7 +266,7 @@ 
      */
     public static function __set_state(array $info)
     {
-        $o = new self ($info);
+        $o = new self($info);
         return $o;
     }
 }

htdocs/includes/restler/framework/Luracast/Restler/Compose.php

Indentation +52 added lines, -52 removed lines

@@ -15,58 +15,58 @@
  */
 class Compose implements iCompose
 {
-    /**
-     * @var bool When restler is not running in production mode, this value will
-     * be checked to include the debug information on error response
-     */
-    public static $includeDebugInfo = true;
-    /**
-     * Current Restler instance
-     * Injected at runtime
-     *
-     * @var Restler
-     */
-    public $restler;
+	/**
+	 * @var bool When restler is not running in production mode, this value will
+	 * be checked to include the debug information on error response
+	 */
+	public static $includeDebugInfo = true;
+	/**
+	 * Current Restler instance
+	 * Injected at runtime
+	 *
+	 * @var Restler
+	 */
+	public $restler;
 
-    /**
-     * Result of an api call is passed to this method
-     * to create a standard structure for the data
-     *
-     * @param mixed $result can be a primitive or array or object
-     *
-     * @return mixed
-     */
-    public function response($result)
-    {
-        //TODO: check Defaults::language and change result accordingly
-        return $result;
-    }
+	/**
+	 * Result of an api call is passed to this method
+	 * to create a standard structure for the data
+	 *
+	 * @param mixed $result can be a primitive or array or object
+	 *
+	 * @return mixed
+	 */
+	public function response($result)
+	{
+		//TODO: check Defaults::language and change result accordingly
+		return $result;
+	}
 
-    /**
-     * When the api call results in RestException this method
-     * will be called to return the error message
-     *
-     * @param RestException $exception exception that has reasons for failure
-     *
-     * @return array
-     */
-    public function message(RestException $exception)
-    {
-        //TODO: check Defaults::language and change result accordingly
-        $r = array(
-            'error' => array(
-                    'code' => $exception->getCode(),
-                    'message' => $exception->getErrorMessage(),
-                ) + $exception->getDetails()
-        );
-        if (!Scope::get('Restler')->getProductionMode() && self::$includeDebugInfo) {
-            $r += array(
-                'debug' => array(
-                    'source' => $exception->getSource(),
-                    'stages' => $exception->getStages(),
-                )
-            );
-        }
-        return $r;
-    }
+	/**
+	 * When the api call results in RestException this method
+	 * will be called to return the error message
+	 *
+	 * @param RestException $exception exception that has reasons for failure
+	 *
+	 * @return array
+	 */
+	public function message(RestException $exception)
+	{
+		//TODO: check Defaults::language and change result accordingly
+		$r = array(
+			'error' => array(
+					'code' => $exception->getCode(),
+					'message' => $exception->getErrorMessage(),
+				) + $exception->getDetails()
+		);
+		if (!Scope::get('Restler')->getProductionMode() && self::$includeDebugInfo) {
+			$r += array(
+				'debug' => array(
+					'source' => $exception->getSource(),
+					'stages' => $exception->getStages(),
+				)
+			);
+		}
+		return $r;
+	}
 }
\ No newline at end of file

htdocs/includes/restler/framework/Luracast/Restler/Resources.php

Indentation +984 added lines, -984 removed lines

@@ -19,988 +19,988 @@
  */
 class Resources implements iUseAuthentication, iProvideMultiVersionApi
 {
-    /**
-     * @var bool should protected resources be shown to unauthenticated users?
-     */
-    public static $hideProtected = true;
-    /**
-     * @var bool should we use format as extension?
-     */
-    public static $useFormatAsExtension = true;
-    /**
-     * @var bool should we include newer apis in the list? works only when
-     * Defaults::$useUrlBasedVersioning is set to true;
-     */
-    public static $listHigherVersions = true;
-    /**
-     * @var array all http methods specified here will be excluded from
-     * documentation
-     */
-    public static $excludedHttpMethods = array('OPTIONS');
-    /**
-     * @var array all paths beginning with any of the following will be excluded
-     * from documentation
-     */
-    public static $excludedPaths = array();
-    /**
-     * @var bool
-     */
-    public static $placeFormatExtensionBeforeDynamicParts = true;
-    /**
-     * @var bool should we group all the operations with the same url or not
-     */
-    public static $groupOperations = false;
-    /**
-     * @var null|callable if the api methods are under access control mechanism
-     * you can attach a function here that returns true or false to determine
-     * visibility of a protected api method. this function will receive method
-     * info as the only parameter.
-     */
-    public static $accessControlFunction = null;
-    /**
-     * @var array type mapping for converting data types to javascript / swagger
-     */
-    public static $dataTypeAlias = array(
-        'string' => 'string',
-        'int' => 'int',
-        'number' => 'float',
-        'float' => 'float',
-        'bool' => 'boolean',
-        'boolean' => 'boolean',
-        'NULL' => 'null',
-        'array' => 'Array',
-        'object' => 'Object',
-        'stdClass' => 'Object',
-        'mixed' => 'string',
-        'DateTime' => 'Date'
-    );
-    /**
-     * @var array configurable symbols to differentiate public, hybrid and
-     * protected api
-     */
-    public static $apiDescriptionSuffixSymbols = array(
-        0 => '&nbsp; <i class="icon-unlock-alt icon-large"></i>', //public api
-        1 => '&nbsp; <i class="icon-adjust icon-large"></i>', //hybrid api
-        2 => '&nbsp; <i class="icon-lock icon-large"></i>', //protected api
-    );
-
-    /**
-     * Injected at runtime
-     *
-     * @var Restler instance of restler
-     */
-    public $restler;
-    /**
-     * @var string when format is not used as the extension this property is
-     * used to set the extension manually
-     */
-    public $formatString = '';
-    protected $_models;
-    protected $_bodyParam;
-    /**
-     * @var bool|stdClass
-     */
-    protected $_fullDataRequested = false;
-    protected $crud = array(
-        'POST' => 'create',
-        'GET' => 'retrieve',
-        'PUT' => 'update',
-        'DELETE' => 'delete',
-        'PATCH' => 'partial update'
-    );
-    protected static $prefixes = array(
-        'get' => 'retrieve',
-        'index' => 'list',
-        'post' => 'create',
-        'put' => 'update',
-        'patch' => 'modify',
-        'delete' => 'remove',
-    );
-    protected $_authenticated = false;
-    protected $cacheName = '';
-
-    public function __construct()
-    {
-        if (static::$useFormatAsExtension) {
-            $this->formatString = '.{format}';
-        }
-    }
-
-    /**
-     * This method will be called first for filter classes and api classes so
-     * that they can respond accordingly for filer method call and api method
-     * calls
-     *
-     *
-     * @param bool $isAuthenticated passes true when the authentication is
-     *                              done, false otherwise
-     *
-     * @return mixed
-     */
-    public function __setAuthenticationStatus($isAuthenticated = false)
-    {
-        $this->_authenticated = $isAuthenticated;
-    }
-
-    /**
-     * pre call for get($id)
-     *
-     * if cache is present, use cache
-     */
-    public function _pre_get_json($id)
-    {
-        $userClass = Defaults::$userIdentifierClass;
-        $this->cacheName = $userClass::getCacheIdentifier() . '_resources_' . $id;
-        if ($this->restler->getProductionMode()
-            && !$this->restler->refreshCache
-            && $this->restler->cache->isCached($this->cacheName)
-        ) {
-            //by pass call, compose, postCall stages and directly send response
-            $this->restler->composeHeaders();
-            die($this->restler->cache->get($this->cacheName));
-        }
-    }
-
-    /**
-     * post call for get($id)
-     *
-     * create cache if in production mode
-     *
-     * @param $responseData
-     *
-     * @internal param string $data composed json output
-     *
-     * @return string
-     */
-    public function _post_get_json($responseData)
-    {
-        if ($this->restler->getProductionMode()) {
-            $this->restler->cache->set($this->cacheName, $responseData);
-        }
-        return $responseData;
-    }
-
-    /**
-     * @access hybrid
-     *
-     * @param string $id
-     *
-     * @throws RestException
-     * @return null|stdClass
-     *
-     * @url    GET {id}
-     */
-    public function get($id = '')
-    {
-        $version = $this->restler->getRequestedApiVersion();
-        if (empty($id)) {
-            //do nothing
-        } elseif (false !== ($pos = strpos($id, '-v'))) {
-            //$version = intval(substr($id, $pos + 2));
-            $id = substr($id, 0, $pos);
-        } elseif ($id[0] == 'v' && is_numeric($v = substr($id, 1))) {
-            $id = '';
-            //$version = $v;
-        } elseif ($id == 'root' || $id == 'index') {
-            $id = '';
-        }
-        $this->_models = new stdClass();
-        $r = null;
-        $count = 0;
-
-        $tSlash = !empty($id);
-        $target = empty($id) ? '' : $id;
-        $tLen = strlen($target);
-
-        $filter = array();
-
-        $routes
-            = Util::nestedValue(Routes::toArray(), "v$version")
-            ? : array();
-
-        $prefix = Defaults::$useUrlBasedVersioning ? "/v$version" : '';
-
-        foreach ($routes as $value) {
-            foreach ($value as $httpMethod => $route) {
-                if (in_array($httpMethod, static::$excludedHttpMethods)) {
-                    continue;
-                }
-                $fullPath = $route['url'];
-                if ($fullPath !== $target && !Text::beginsWith($fullPath, $target)) {
-                    continue;
-                }
-                $fLen = strlen($fullPath);
-                if ($tSlash) {
-                    if ($fLen != $tLen && !Text::beginsWith($fullPath, $target . '/'))
-                        continue;
-                } elseif ($fLen > $tLen + 1 && $fullPath[$tLen + 1] != '{' && !Text::beginsWith($fullPath, '{')) {
-                    //when mapped to root exclude paths that have static parts
-                    //they are listed else where under that static part name
-                    continue;
-                }
-
-                if (!static::verifyAccess($route)) {
-                    continue;
-                }
-                foreach (static::$excludedPaths as $exclude) {
-                    if (empty($exclude)) {
-                        if ($fullPath == $exclude)
-                            continue 2;
-                    } elseif (Text::beginsWith($fullPath, $exclude)) {
-                        continue 2;
-                    }
-                }
-                $m = $route['metadata'];
-                if ($id == '' && $m['resourcePath'] != '') {
-                    continue;
-                }
-                if (isset($filter[$httpMethod][$fullPath])) {
-                    continue;
-                }
-                $filter[$httpMethod][$fullPath] = true;
-                // reset body params
-                $this->_bodyParam = array(
-                    'required' => false,
-                    'description' => array()
-                );
-                $count++;
-                $className = $this->_noNamespace($route['className']);
-                if (!$r) {
-                    $resourcePath = '/'
-                        . trim($m['resourcePath'], '/');
-                    $r = $this->_operationListing($resourcePath);
-                }
-                $parts = explode('/', $fullPath);
-                $pos = count($parts) - 1;
-                if (count($parts) == 1 && $httpMethod == 'GET') {
-                } else {
-                    for ($i = 0; $i < count($parts); $i++) {
-                        if (strlen($parts[$i]) && $parts[$i][0] == '{') {
-                            $pos = $i - 1;
-                            break;
-                        }
-                    }
-                }
-                $nickname = $this->_nickname($route);
-                $index = static::$placeFormatExtensionBeforeDynamicParts && $pos > 0 ? $pos : 0;
-                if (!empty($parts[$index]))
-                    $parts[$index] .= $this->formatString;
-
-                $fullPath = implode('/', $parts);
-                $description = isset(
-                $m['classDescription'])
-                    ? $m['classDescription']
-                    : $className . ' API';
-                if (empty($m['description'])) {
-                    $m['description'] = $this->restler->getProductionMode()
-                        ? ''
-                        : 'routes to <mark>'
-                        . $route['className']
-                        . '::'
-                        . $route['methodName'] . '();</mark>';
-                }
-                if (empty($m['longDescription'])) {
-                    $m['longDescription'] = $this->restler->getProductionMode()
-                        ? ''
-                        : 'Add PHPDoc long description to '
-                        . "<mark>$className::"
-                        . $route['methodName'] . '();</mark>'
-                        . '  (the api method) to write here';
-                }
-                $operation = $this->_operation(
-                    $route,
-                    $nickname,
-                    $httpMethod,
-                    $m['description'],
-                    $m['longDescription']
-                );
-                if (isset($m['throws'])) {
-                    foreach ($m['throws'] as $exception) {
-                        $operation->errorResponses[] = array(
-                            'reason' => $exception['message'],
-                            'code' => $exception['code']);
-                    }
-                }
-                if (isset($m['param'])) {
-                    foreach ($m['param'] as $param) {
-                        //combine body params as one
-                        $p = $this->_parameter($param);
-                        if ($p->paramType == 'body') {
-                            $this->_appendToBody($p);
-                        } else {
-                            $operation->parameters[] = $p;
-                        }
-                    }
-                }
-                if (
-                    count($this->_bodyParam['description']) ||
-                    (
-                        $this->_fullDataRequested &&
-                        $httpMethod != 'GET' &&
-                        $httpMethod != 'DELETE'
-                    )
-                ) {
-                    $operation->parameters[] = $this->_getBody();
-                }
-                if (isset($m['return']['type'])) {
-                    $responseClass = $m['return']['type'];
-                    if (is_string($responseClass)) {
-                        if (class_exists($responseClass)) {
-                            $this->_model($responseClass);
-                            $operation->responseClass
-                                = $this->_noNamespace($responseClass);
-                        } elseif (strtolower($responseClass) == 'array') {
-                            $operation->responseClass = 'Array';
-                            $rt = $m['return'];
-                            if (isset(
-                            $rt[CommentParser::$embeddedDataName]['type'])
-                            ) {
-                                $rt = $rt[CommentParser::$embeddedDataName]
-                                ['type'];
-                                if (class_exists($rt)) {
-                                    $this->_model($rt);
-                                    $operation->responseClass .= '[' .
-                                        $this->_noNamespace($rt) . ']';
-                                }
-                            }
-                        }
-                    }
-                }
-                $api = false;
-
-                if (static::$groupOperations) {
-                    foreach ($r->apis as $a) {
-                        if ($a->path == "$prefix/$fullPath") {
-                            $api = $a;
-                            break;
-                        }
-                    }
-                }
-
-                if (!$api) {
-                    $api = $this->_api("$prefix/$fullPath", $description);
-                    $r->apis[] = $api;
-                }
-
-                $api->operations[] = $operation;
-            }
-        }
-        if (!$count) {
-            throw new RestException(404);
-        }
-        if (!is_null($r))
-            $r->models = $this->_models;
-        usort(
-            $r->apis,
-            function ($a, $b) {
-                $order = array(
-                    'GET' => 1,
-                    'POST' => 2,
-                    'PUT' => 3,
-                    'PATCH' => 4,
-                    'DELETE' => 5
-                );
-                return
-                    $a->operations[0]->httpMethod ==
-                    $b->operations[0]->httpMethod
-                        ? $a->path > $b->path
-                        : $order[$a->operations[0]->httpMethod] >
-                        $order[$b->operations[0]->httpMethod];
-
-            }
-        );
-        return $r;
-    }
-
-    protected function _nickname(array $route)
-    {
-        static $hash = array();
-        $method = $route['methodName'];
-        if (isset(static::$prefixes[$method])) {
-            $method = static::$prefixes[$method];
-        } else {
-            $method = str_replace(
-                array_keys(static::$prefixes),
-                array_values(static::$prefixes),
-                $method
-            );
-        }
-        while (isset($hash[$method]) && $route['url'] != $hash[$method]) {
-            //create another one
-            $method .= '_';
-        }
-        $hash[$method] = $route['url'];
-        return $method;
-    }
-
-    protected function _noNamespace($className)
-    {
-        $className = explode('\\', $className);
-        return end($className);
-    }
-
-    protected function _operationListing($resourcePath = '/')
-    {
-        $r = $this->_resourceListing();
-        $r->resourcePath = $resourcePath;
-        $r->models = new stdClass();
-        return $r;
-    }
-
-    protected function _resourceListing()
-    {
-        $r = new stdClass();
-        $r->apiVersion = (string)$this->restler->_requestedApiVersion;
-        $r->swaggerVersion = "1.1";
-        $r->basePath = $this->restler->getBaseUrl();
-        $r->produces = $this->restler->getWritableMimeTypes();
-        $r->consumes = $this->restler->getReadableMimeTypes();
-        $r->apis = array();
-        return $r;
-    }
-
-    protected function _api($path, $description = '')
-    {
-        $r = new stdClass();
-        $r->path = $path;
-        $r->description =
-            empty($description) && $this->restler->getProductionMode()
-                ? 'Use PHPDoc comment to describe here'
-                : $description;
-        $r->operations = array();
-        return $r;
-    }
-
-    protected function _operation(
-        $route,
-        $nickname,
-        $httpMethod = 'GET',
-        $summary = 'description',
-        $notes = 'long description',
-        $responseClass = 'void'
-    )
-    {
-        //reset body params
-        $this->_bodyParam = array(
-            'required' => false,
-            'description' => array()
-        );
-
-        $r = new stdClass();
-        $r->httpMethod = $httpMethod;
-        $r->nickname = $nickname;
-        $r->responseClass = $responseClass;
-
-        $r->parameters = array();
-
-        $r->summary = $summary . ($route['accessLevel'] > 2
-                ? static::$apiDescriptionSuffixSymbols[2]
-                : static::$apiDescriptionSuffixSymbols[$route['accessLevel']]
-            );
-        $r->notes = $notes;
-
-        $r->errorResponses = array();
-        return $r;
-    }
-
-    protected function _parameter($param)
-    {
-        $r = new stdClass();
-        $r->name = $param['name'];
-        $r->description = !empty($param['description'])
-            ? $param['description'] . '.'
-            : ($this->restler->getProductionMode()
-                ? ''
-                : 'add <mark>@param {type} $' . $r->name
-                . ' {comment}</mark> to describe here');
-        //paramType can be path or query or body or header
-        $r->paramType = Util::nestedValue($param, CommentParser::$embeddedDataName, 'from') ? : 'query';
-        $r->required = isset($param['required']) && $param['required'];
-        if (isset($param['default'])) {
-            $r->defaultValue = $param['default'];
-        } elseif (isset($param[CommentParser::$embeddedDataName]['example'])) {
-            $r->defaultValue
-                = $param[CommentParser::$embeddedDataName]['example'];
-        }
-        $r->allowMultiple = false;
-        $type = 'string';
-        if (isset($param['type'])) {
-            $type = $param['type'];
-            if (is_array($type)) {
-                $type = array_shift($type);
-            }
-            if ($type == 'array') {
-                $contentType = Util::nestedValue(
-                    $param,
-                    CommentParser::$embeddedDataName,
-                    'type'
-                );
-                if ($contentType) {
-                    if ($contentType == 'indexed') {
-                        $type = 'Array';
-                    } elseif ($contentType == 'associative') {
-                        $type = 'Object';
-                    } else {
-                        $type = "Array[$contentType]";
-                    }
-                    if (Util::isObjectOrArray($contentType)) {
-                        $this->_model($contentType);
-                    }
-                } elseif (isset(static::$dataTypeAlias[$type])) {
-                    $type = static::$dataTypeAlias[$type];
-                }
-            } elseif (Util::isObjectOrArray($type)) {
-                $this->_model($type);
-            } elseif (isset(static::$dataTypeAlias[$type])) {
-                $type = static::$dataTypeAlias[$type];
-            }
-        }
-        $r->dataType = $type;
-        if (isset($param[CommentParser::$embeddedDataName])) {
-            $p = $param[CommentParser::$embeddedDataName];
-            if (isset($p['min']) && isset($p['max'])) {
-                $r->allowableValues = array(
-                    'valueType' => 'RANGE',
-                    'min' => $p['min'],
-                    'max' => $p['max'],
-                );
-            } elseif (isset($p['choice'])) {
-                $r->allowableValues = array(
-                    'valueType' => 'LIST',
-                    'values' => $p['choice']
-                );
-            }
-        }
-        return $r;
-    }
-
-    protected function _appendToBody($p)
-    {
-        if ($p->name === Defaults::$fullRequestDataName) {
-            $this->_fullDataRequested = $p;
-            unset($this->_bodyParam['names'][Defaults::$fullRequestDataName]);
-            return;
-        }
-        $this->_bodyParam['description'][$p->name]
-            = "$p->name"
-            . ' : <tag>' . $p->dataType . '</tag> '
-            . ($p->required ? ' <i>(required)</i> - ' : ' - ')
-            . $p->description;
-        $this->_bodyParam['required'] = $p->required
-            || $this->_bodyParam['required'];
-        $this->_bodyParam['names'][$p->name] = $p;
-    }
-
-    protected function _getBody()
-    {
-        $r = new stdClass();
-        $n = isset($this->_bodyParam['names'])
-            ? array_values($this->_bodyParam['names'])
-            : array();
-        if (count($n) == 1) {
-            if (isset($this->_models->{$n[0]->dataType})) {
-                // ============ custom class ===================
-                $r = $n[0];
-                $c = $this->_models->{$r->dataType};
-                $a = $c->properties;
-                $r->description = "Paste JSON data here";
-                if (count($a)) {
-                    $r->description .= " with the following"
-                        . (count($a) > 1 ? ' properties.' : ' property.');
-                    foreach ($a as $k => $v) {
-                        $r->description .= "<hr/>$k : <tag>"
-                            . $v['type'] . '</tag> '
-                            . (isset($v['required']) ? '(required)' : '')
-                            . ' - ' . $v['description'];
-                    }
-                }
-                $r->defaultValue = "{\n    \""
-                    . implode("\": \"\",\n    \"",
-                        array_keys($c->properties))
-                    . "\": \"\"\n}";
-                return $r;
-            } elseif (false !== ($p = strpos($n[0]->dataType, '['))) {
-                // ============ array of custom class ===============
-                $r = $n[0];
-                $t = substr($r->dataType, $p + 1, -1);
-                if ($c = Util::nestedValue($this->_models, $t)) {
-                    $a = $c->properties;
-                    $r->description = "Paste JSON data here";
-                    if (count($a)) {
-                        $r->description .= " with an array of objects with the following"
-                            . (count($a) > 1 ? ' properties.' : ' property.');
-                        foreach ($a as $k => $v) {
-                            $r->description .= "<hr/>$k : <tag>"
-                                . $v['type'] . '</tag> '
-                                . (isset($v['required']) ? '(required)' : '')
-                                . ' - ' . $v['description'];
-                        }
-                    }
-                    $r->defaultValue = "[\n    {\n        \""
-                        . implode("\": \"\",\n        \"",
-                            array_keys($c->properties))
-                        . "\": \"\"\n    }\n]";
-                    return $r;
-                } else {
-                    $r->description = "Paste JSON data here with an array of $t values.";
-                    $r->defaultValue = "[ ]";
-                    return $r;
-                }
-            } elseif ($n[0]->dataType == 'Array') {
-                // ============ array ===============================
-                $r = $n[0];
-                $r->description = "Paste JSON array data here"
-                    . ($r->required ? ' (required) . ' : '. ')
-                    . "<br/>$r->description";
-                $r->defaultValue = "[\n    {\n        \""
-                    . "property\" : \"\"\n    }\n]";
-                return $r;
-            } elseif ($n[0]->dataType == 'Object') {
-                // ============ object ==============================
-                $r = $n[0];
-                $r->description = "Paste JSON object data here"
-                    . ($r->required ? ' (required) . ' : '. ')
-                    . "<br/>$r->description";
-                $r->defaultValue = "{\n    \""
-                    . "property\" : \"\"\n}";
-                return $r;
-            }
-        }
-        $p = array_values($this->_bodyParam['description']);
-        $r->name = 'REQUEST_BODY';
-        $r->description = "Paste JSON data here";
-        if (count($p) == 0 && $this->_fullDataRequested) {
-            $r->required = $this->_fullDataRequested->required;
-            $r->defaultValue = "{\n    \"property\" : \"\"\n}";
-        } else {
-            $r->description .= " with the following"
-                . (count($p) > 1 ? ' properties.' : ' property.')
-                . '<hr/>'
-                . implode("<hr/>", $p);
-            $r->required = $this->_bodyParam['required'];
-            // Create default object that includes parameters to be submitted
-            $defaultObject = new \StdClass();
-            foreach ($this->_bodyParam['names'] as $name => $values) {
-                if (!$values->required)
-                    continue;
-                if (class_exists($values->dataType)) {
-                    $myClassName = $values->dataType;
-                    $defaultObject->$name = new $myClassName();
-                } else {
-                    $defaultObject->$name = '';
-                }
-            }
-            $r->defaultValue = Scope::get('JsonFormat')->encode($defaultObject, true);
-        }
-        $r->paramType = 'body';
-        $r->allowMultiple = false;
-        $r->dataType = 'Object';
-        return $r;
-    }
-
-    protected function _model($className, $instance = null)
-    {
-        $id = $this->_noNamespace($className);
-        if (isset($this->_models->{$id})) {
-            return;
-        }
-        $properties = array();
-        if (!$instance) {
-            if (!class_exists($className))
-                return;
-            $instance = new $className();
-        }
-        $data = get_object_vars($instance);
-        $reflectionClass = new \ReflectionClass($className);
-        foreach ($data as $key => $value) {
-
-            $propertyMetaData = null;
-
-            try {
-                $property = $reflectionClass->getProperty($key);
-                if ($c = $property->getDocComment()) {
-                    $propertyMetaData = Util::nestedValue(
-                        CommentParser::parse($c),
-                        'var'
-                    );
-                }
-            } catch (\ReflectionException $e) {
-            }
-
-            if (is_null($propertyMetaData)) {
-                $type = $this->getType($value, true);
-                $description = '';
-            } else {
-                $type = Util::nestedValue(
-                    $propertyMetaData,
-                    'type'
-                ) ? : $this->getType($value, true);
-                $description = Util::nestedValue(
-                    $propertyMetaData,
-                    'description'
-                ) ? : '';
-
-                if (class_exists($type)) {
-                    $this->_model($type);
-                    $type = $this->_noNamespace($type);
-                }
-            }
-
-            if (isset(static::$dataTypeAlias[$type])) {
-                $type = static::$dataTypeAlias[$type];
-            }
-            $properties[$key] = array(
-                'type' => $type,
-                'description' => $description
-            );
-            if (Util::nestedValue(
-                $propertyMetaData,
-                CommentParser::$embeddedDataName,
-                'required'
-            )
-            ) {
-                $properties[$key]['required'] = true;
-            }
-            if ($type == 'Array') {
-                $itemType = Util::nestedValue(
-                    $propertyMetaData,
-                    CommentParser::$embeddedDataName,
-                    'type'
-                ) ? :
-                    (count($value)
-                        ? $this->getType(end($value), true)
-                        : 'string');
-                if (class_exists($itemType)) {
-                    $this->_model($itemType);
-                    $itemType = $this->_noNamespace($itemType);
-                }
-                $properties[$key]['items'] = array(
-                    'type' => $itemType,
-                    /*'description' => '' */ //TODO: add description
-                );
-            } else if (preg_match('/^Array\[(.+)\]$/', $type, $matches)) {
-                $itemType = $matches[1];
-                $properties[$key]['type'] = 'Array';
-                $properties[$key]['items']['type'] = $this->_noNamespace($itemType);
-
-                if (class_exists($itemType)) {
-                    $this->_model($itemType);
-                }
-            }
-        }
-        if (!empty($properties)) {
-            $model = new stdClass();
-            $model->id = $id;
-            $model->properties = $properties;
-            $this->_models->{$id} = $model;
-        }
-    }
-
-    /**
-     * Find the data type of the given value.
-     *
-     *
-     * @param mixed $o given value for finding type
-     *
-     * @param bool $appendToModels if an object is found should we append to
-     *                              our models list?
-     *
-     * @return string
-     *
-     * @access private
-     */
-    public function getType($o, $appendToModels = false)
-    {
-        if (is_object($o)) {
-            $oc = get_class($o);
-            if ($appendToModels) {
-                $this->_model($oc, $o);
-            }
-            return $this->_noNamespace($oc);
-        }
-        if (is_array($o)) {
-            if (count($o)) {
-                $child = end($o);
-                if (Util::isObjectOrArray($child)) {
-                    $childType = $this->getType($child, $appendToModels);
-                    return "Array[$childType]";
-                }
-            }
-            return 'array';
-        }
-        if (is_bool($o)) return 'boolean';
-        if (is_numeric($o)) return is_float($o) ? 'float' : 'int';
-        return 'string';
-    }
-
-    /**
-     * pre call for index()
-     *
-     * if cache is present, use cache
-     */
-    public function _pre_index_json()
-    {
-        $userClass = Defaults::$userIdentifierClass;
-        $this->cacheName = $userClass::getCacheIdentifier()
-            . '_resources-v'
-            . $this->restler->_requestedApiVersion;
-        if ($this->restler->getProductionMode()
-            && !$this->restler->refreshCache
-            && $this->restler->cache->isCached($this->cacheName)
-        ) {
-            //by pass call, compose, postCall stages and directly send response
-            $this->restler->composeHeaders();
-            die($this->restler->cache->get($this->cacheName));
-        }
-    }
-
-    /**
-     * post call for index()
-     *
-     * create cache if in production mode
-     *
-     * @param $responseData
-     *
-     * @internal param string $data composed json output
-     *
-     * @return string
-     */
-    public function _post_index_json($responseData)
-    {
-        if ($this->restler->getProductionMode()) {
-            $this->restler->cache->set($this->cacheName, $responseData);
-        }
-        return $responseData;
-    }
-
-    /**
-     * @access hybrid
-     * @return \stdClass
-     */
-    public function index()
-    {
-        if (!static::$accessControlFunction && Defaults::$accessControlFunction)
-            static::$accessControlFunction = Defaults::$accessControlFunction;
-        $version = $this->restler->getRequestedApiVersion();
-        $allRoutes = Util::nestedValue(Routes::toArray(), "v$version");
-        $r = $this->_resourceListing();
-        $map = array();
-        if (isset($allRoutes['*'])) {
-            $this->_mapResources($allRoutes['*'], $map, $version);
-            unset($allRoutes['*']);
-        }
-        $this->_mapResources($allRoutes, $map, $version);
-        foreach ($map as $path => $description) {
-            if (!Text::contains($path, '{')) {
-                //add id
-                $r->apis[] = array(
-                    'path' => $path . $this->formatString,
-                    'description' => $description
-                );
-            }
-        }
-        if (Defaults::$useUrlBasedVersioning && static::$listHigherVersions) {
-            $nextVersion = $version + 1;
-            if ($nextVersion <= $this->restler->getApiVersion()) {
-                list($status, $data) = $this->_loadResource("/v$nextVersion/resources.json");
-                if ($status == 200) {
-                    $r->apis = array_merge($r->apis, $data->apis);
-                    $r->apiVersion = $data->apiVersion;
-                }
-            }
-
-        }
-        return $r;
-    }
-
-    protected function _loadResource($url)
-    {
-        $ch = curl_init($this->restler->getBaseUrl() . $url
-            . (empty($_GET) ? '' : '?' . http_build_query($_GET)));
-        curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
-        curl_setopt($ch, CURLOPT_TIMEOUT, 15);
-        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
-        curl_setopt($ch, CURLOPT_HTTPHEADER, array(
-            'Accept:application/json',
-        ));
-        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);        
-        $result = json_decode(curl_exec($ch));
-        $http_status = (int)curl_getinfo($ch, CURLINFO_HTTP_CODE);
-        return array($http_status, $result);
-    }
-
-    protected function _mapResources(array $allRoutes, array &$map, $version = 1)
-    {
-        foreach ($allRoutes as $fullPath => $routes) {
-            $path = explode('/', $fullPath);
-            $resource = isset($path[0]) ? $path[0] : '';
-            if ($resource == 'resources' || Text::endsWith($resource, 'index'))
-                continue;
-            foreach ($routes as $httpMethod => $route) {
-                if (in_array($httpMethod, static::$excludedHttpMethods)) {
-                    continue;
-                }
-                if (!static::verifyAccess($route)) {
-                    continue;
-                }
-
-                foreach (static::$excludedPaths as $exclude) {
-                    if (empty($exclude)) {
-                        if ($fullPath == $exclude)
-                            continue 2;
-                    } elseif (Text::beginsWith($fullPath, $exclude)) {
-                        continue 2;
-                    }
-                }
-
-                $res = $resource
-                    ? ($version == 1 ? "/resources/$resource" : "/v$version/resources/$resource-v$version")
-                    : ($version == 1 ? "/resources/root" : "/v$version/resources/root-v$version");
-
-                if (empty($map[$res])) {
-                    $map[$res] = isset(
-                    $route['metadata']['classDescription'])
-                        ? $route['metadata']['classDescription'] : '';
-                }
-            }
-        }
-    }
-
-    /**
-     * Maximum api version supported by the api class
-     * @return int
-     */
-    public static function __getMaximumSupportedVersion()
-    {
-        return Scope::get('Restler')->getApiVersion();
-    }
-
-    /**
-     * Verifies that the requesting user is allowed to view the docs for this API
-     *
-     * @param $route
-     *
-     * @return boolean True if the user should be able to view this API's docs
-     */
-    protected function verifyAccess($route)
-    {
-        if ($route['accessLevel'] < 2) {
-            return true;
-        }
-        if (
-            static::$hideProtected
-            && !$this->_authenticated
-            && $route['accessLevel'] > 1
-        ) {
-            return false;
-        }
-        if ($this->_authenticated
-            && static::$accessControlFunction
-            && (!call_user_func(
-                static::$accessControlFunction, $route['metadata']))
-        ) {
-            return false;
-        }
-        return true;
-    }
+	/**
+	 * @var bool should protected resources be shown to unauthenticated users?
+	 */
+	public static $hideProtected = true;
+	/**
+	 * @var bool should we use format as extension?
+	 */
+	public static $useFormatAsExtension = true;
+	/**
+	 * @var bool should we include newer apis in the list? works only when
+	 * Defaults::$useUrlBasedVersioning is set to true;
+	 */
+	public static $listHigherVersions = true;
+	/**
+	 * @var array all http methods specified here will be excluded from
+	 * documentation
+	 */
+	public static $excludedHttpMethods = array('OPTIONS');
+	/**
+	 * @var array all paths beginning with any of the following will be excluded
+	 * from documentation
+	 */
+	public static $excludedPaths = array();
+	/**
+	 * @var bool
+	 */
+	public static $placeFormatExtensionBeforeDynamicParts = true;
+	/**
+	 * @var bool should we group all the operations with the same url or not
+	 */
+	public static $groupOperations = false;
+	/**
+	 * @var null|callable if the api methods are under access control mechanism
+	 * you can attach a function here that returns true or false to determine
+	 * visibility of a protected api method. this function will receive method
+	 * info as the only parameter.
+	 */
+	public static $accessControlFunction = null;
+	/**
+	 * @var array type mapping for converting data types to javascript / swagger
+	 */
+	public static $dataTypeAlias = array(
+		'string' => 'string',
+		'int' => 'int',
+		'number' => 'float',
+		'float' => 'float',
+		'bool' => 'boolean',
+		'boolean' => 'boolean',
+		'NULL' => 'null',
+		'array' => 'Array',
+		'object' => 'Object',
+		'stdClass' => 'Object',
+		'mixed' => 'string',
+		'DateTime' => 'Date'
+	);
+	/**
+	 * @var array configurable symbols to differentiate public, hybrid and
+	 * protected api
+	 */
+	public static $apiDescriptionSuffixSymbols = array(
+		0 => '&nbsp; <i class="icon-unlock-alt icon-large"></i>', //public api
+		1 => '&nbsp; <i class="icon-adjust icon-large"></i>', //hybrid api
+		2 => '&nbsp; <i class="icon-lock icon-large"></i>', //protected api
+	);
+
+	/**
+	 * Injected at runtime
+	 *
+	 * @var Restler instance of restler
+	 */
+	public $restler;
+	/**
+	 * @var string when format is not used as the extension this property is
+	 * used to set the extension manually
+	 */
+	public $formatString = '';
+	protected $_models;
+	protected $_bodyParam;
+	/**
+	 * @var bool|stdClass
+	 */
+	protected $_fullDataRequested = false;
+	protected $crud = array(
+		'POST' => 'create',
+		'GET' => 'retrieve',
+		'PUT' => 'update',
+		'DELETE' => 'delete',
+		'PATCH' => 'partial update'
+	);
+	protected static $prefixes = array(
+		'get' => 'retrieve',
+		'index' => 'list',
+		'post' => 'create',
+		'put' => 'update',
+		'patch' => 'modify',
+		'delete' => 'remove',
+	);
+	protected $_authenticated = false;
+	protected $cacheName = '';
+
+	public function __construct()
+	{
+		if (static::$useFormatAsExtension) {
+			$this->formatString = '.{format}';
+		}
+	}
+
+	/**
+	 * This method will be called first for filter classes and api classes so
+	 * that they can respond accordingly for filer method call and api method
+	 * calls
+	 *
+	 *
+	 * @param bool $isAuthenticated passes true when the authentication is
+	 *                              done, false otherwise
+	 *
+	 * @return mixed
+	 */
+	public function __setAuthenticationStatus($isAuthenticated = false)
+	{
+		$this->_authenticated = $isAuthenticated;
+	}
+
+	/**
+	 * pre call for get($id)
+	 *
+	 * if cache is present, use cache
+	 */
+	public function _pre_get_json($id)
+	{
+		$userClass = Defaults::$userIdentifierClass;
+		$this->cacheName = $userClass::getCacheIdentifier() . '_resources_' . $id;
+		if ($this->restler->getProductionMode()
+			&& !$this->restler->refreshCache
+			&& $this->restler->cache->isCached($this->cacheName)
+		) {
+			//by pass call, compose, postCall stages and directly send response
+			$this->restler->composeHeaders();
+			die($this->restler->cache->get($this->cacheName));
+		}
+	}
+
+	/**
+	 * post call for get($id)
+	 *
+	 * create cache if in production mode
+	 *
+	 * @param $responseData
+	 *
+	 * @internal param string $data composed json output
+	 *
+	 * @return string
+	 */
+	public function _post_get_json($responseData)
+	{
+		if ($this->restler->getProductionMode()) {
+			$this->restler->cache->set($this->cacheName, $responseData);
+		}
+		return $responseData;
+	}
+
+	/**
+	 * @access hybrid
+	 *
+	 * @param string $id
+	 *
+	 * @throws RestException
+	 * @return null|stdClass
+	 *
+	 * @url    GET {id}
+	 */
+	public function get($id = '')
+	{
+		$version = $this->restler->getRequestedApiVersion();
+		if (empty($id)) {
+			//do nothing
+		} elseif (false !== ($pos = strpos($id, '-v'))) {
+			//$version = intval(substr($id, $pos + 2));
+			$id = substr($id, 0, $pos);
+		} elseif ($id[0] == 'v' && is_numeric($v = substr($id, 1))) {
+			$id = '';
+			//$version = $v;
+		} elseif ($id == 'root' || $id == 'index') {
+			$id = '';
+		}
+		$this->_models = new stdClass();
+		$r = null;
+		$count = 0;
+
+		$tSlash = !empty($id);
+		$target = empty($id) ? '' : $id;
+		$tLen = strlen($target);
+
+		$filter = array();
+
+		$routes
+			= Util::nestedValue(Routes::toArray(), "v$version")
+			? : array();
+
+		$prefix = Defaults::$useUrlBasedVersioning ? "/v$version" : '';
+
+		foreach ($routes as $value) {
+			foreach ($value as $httpMethod => $route) {
+				if (in_array($httpMethod, static::$excludedHttpMethods)) {
+					continue;
+				}
+				$fullPath = $route['url'];
+				if ($fullPath !== $target && !Text::beginsWith($fullPath, $target)) {
+					continue;
+				}
+				$fLen = strlen($fullPath);
+				if ($tSlash) {
+					if ($fLen != $tLen && !Text::beginsWith($fullPath, $target . '/'))
+						continue;
+				} elseif ($fLen > $tLen + 1 && $fullPath[$tLen + 1] != '{' && !Text::beginsWith($fullPath, '{')) {
+					//when mapped to root exclude paths that have static parts
+					//they are listed else where under that static part name
+					continue;
+				}
+
+				if (!static::verifyAccess($route)) {
+					continue;
+				}
+				foreach (static::$excludedPaths as $exclude) {
+					if (empty($exclude)) {
+						if ($fullPath == $exclude)
+							continue 2;
+					} elseif (Text::beginsWith($fullPath, $exclude)) {
+						continue 2;
+					}
+				}
+				$m = $route['metadata'];
+				if ($id == '' && $m['resourcePath'] != '') {
+					continue;
+				}
+				if (isset($filter[$httpMethod][$fullPath])) {
+					continue;
+				}
+				$filter[$httpMethod][$fullPath] = true;
+				// reset body params
+				$this->_bodyParam = array(
+					'required' => false,
+					'description' => array()
+				);
+				$count++;
+				$className = $this->_noNamespace($route['className']);
+				if (!$r) {
+					$resourcePath = '/'
+						. trim($m['resourcePath'], '/');
+					$r = $this->_operationListing($resourcePath);
+				}
+				$parts = explode('/', $fullPath);
+				$pos = count($parts) - 1;
+				if (count($parts) == 1 && $httpMethod == 'GET') {
+				} else {
+					for ($i = 0; $i < count($parts); $i++) {
+						if (strlen($parts[$i]) && $parts[$i][0] == '{') {
+							$pos = $i - 1;
+							break;
+						}
+					}
+				}
+				$nickname = $this->_nickname($route);
+				$index = static::$placeFormatExtensionBeforeDynamicParts && $pos > 0 ? $pos : 0;
+				if (!empty($parts[$index]))
+					$parts[$index] .= $this->formatString;
+
+				$fullPath = implode('/', $parts);
+				$description = isset(
+				$m['classDescription'])
+					? $m['classDescription']
+					: $className . ' API';
+				if (empty($m['description'])) {
+					$m['description'] = $this->restler->getProductionMode()
+						? ''
+						: 'routes to <mark>'
+						. $route['className']
+						. '::'
+						. $route['methodName'] . '();</mark>';
+				}
+				if (empty($m['longDescription'])) {
+					$m['longDescription'] = $this->restler->getProductionMode()
+						? ''
+						: 'Add PHPDoc long description to '
+						. "<mark>$className::"
+						. $route['methodName'] . '();</mark>'
+						. '  (the api method) to write here';
+				}
+				$operation = $this->_operation(
+					$route,
+					$nickname,
+					$httpMethod,
+					$m['description'],
+					$m['longDescription']
+				);
+				if (isset($m['throws'])) {
+					foreach ($m['throws'] as $exception) {
+						$operation->errorResponses[] = array(
+							'reason' => $exception['message'],
+							'code' => $exception['code']);
+					}
+				}
+				if (isset($m['param'])) {
+					foreach ($m['param'] as $param) {
+						//combine body params as one
+						$p = $this->_parameter($param);
+						if ($p->paramType == 'body') {
+							$this->_appendToBody($p);
+						} else {
+							$operation->parameters[] = $p;
+						}
+					}
+				}
+				if (
+					count($this->_bodyParam['description']) ||
+					(
+						$this->_fullDataRequested &&
+						$httpMethod != 'GET' &&
+						$httpMethod != 'DELETE'
+					)
+				) {
+					$operation->parameters[] = $this->_getBody();
+				}
+				if (isset($m['return']['type'])) {
+					$responseClass = $m['return']['type'];
+					if (is_string($responseClass)) {
+						if (class_exists($responseClass)) {
+							$this->_model($responseClass);
+							$operation->responseClass
+								= $this->_noNamespace($responseClass);
+						} elseif (strtolower($responseClass) == 'array') {
+							$operation->responseClass = 'Array';
+							$rt = $m['return'];
+							if (isset(
+							$rt[CommentParser::$embeddedDataName]['type'])
+							) {
+								$rt = $rt[CommentParser::$embeddedDataName]
+								['type'];
+								if (class_exists($rt)) {
+									$this->_model($rt);
+									$operation->responseClass .= '[' .
+										$this->_noNamespace($rt) . ']';
+								}
+							}
+						}
+					}
+				}
+				$api = false;
+
+				if (static::$groupOperations) {
+					foreach ($r->apis as $a) {
+						if ($a->path == "$prefix/$fullPath") {
+							$api = $a;
+							break;
+						}
+					}
+				}
+
+				if (!$api) {
+					$api = $this->_api("$prefix/$fullPath", $description);
+					$r->apis[] = $api;
+				}
+
+				$api->operations[] = $operation;
+			}
+		}
+		if (!$count) {
+			throw new RestException(404);
+		}
+		if (!is_null($r))
+			$r->models = $this->_models;
+		usort(
+			$r->apis,
+			function ($a, $b) {
+				$order = array(
+					'GET' => 1,
+					'POST' => 2,
+					'PUT' => 3,
+					'PATCH' => 4,
+					'DELETE' => 5
+				);
+				return
+					$a->operations[0]->httpMethod ==
+					$b->operations[0]->httpMethod
+						? $a->path > $b->path
+						: $order[$a->operations[0]->httpMethod] >
+						$order[$b->operations[0]->httpMethod];
+
+			}
+		);
+		return $r;
+	}
+
+	protected function _nickname(array $route)
+	{
+		static $hash = array();
+		$method = $route['methodName'];
+		if (isset(static::$prefixes[$method])) {
+			$method = static::$prefixes[$method];
+		} else {
+			$method = str_replace(
+				array_keys(static::$prefixes),
+				array_values(static::$prefixes),
+				$method
+			);
+		}
+		while (isset($hash[$method]) && $route['url'] != $hash[$method]) {
+			//create another one
+			$method .= '_';
+		}
+		$hash[$method] = $route['url'];
+		return $method;
+	}
+
+	protected function _noNamespace($className)
+	{
+		$className = explode('\\', $className);
+		return end($className);
+	}
+
+	protected function _operationListing($resourcePath = '/')
+	{
+		$r = $this->_resourceListing();
+		$r->resourcePath = $resourcePath;
+		$r->models = new stdClass();
+		return $r;
+	}
+
+	protected function _resourceListing()
+	{
+		$r = new stdClass();
+		$r->apiVersion = (string)$this->restler->_requestedApiVersion;
+		$r->swaggerVersion = "1.1";
+		$r->basePath = $this->restler->getBaseUrl();
+		$r->produces = $this->restler->getWritableMimeTypes();
+		$r->consumes = $this->restler->getReadableMimeTypes();
+		$r->apis = array();
+		return $r;
+	}
+
+	protected function _api($path, $description = '')
+	{
+		$r = new stdClass();
+		$r->path = $path;
+		$r->description =
+			empty($description) && $this->restler->getProductionMode()
+				? 'Use PHPDoc comment to describe here'
+				: $description;
+		$r->operations = array();
+		return $r;
+	}
+
+	protected function _operation(
+		$route,
+		$nickname,
+		$httpMethod = 'GET',
+		$summary = 'description',
+		$notes = 'long description',
+		$responseClass = 'void'
+	)
+	{
+		//reset body params
+		$this->_bodyParam = array(
+			'required' => false,
+			'description' => array()
+		);
+
+		$r = new stdClass();
+		$r->httpMethod = $httpMethod;
+		$r->nickname = $nickname;
+		$r->responseClass = $responseClass;
+
+		$r->parameters = array();
+
+		$r->summary = $summary . ($route['accessLevel'] > 2
+				? static::$apiDescriptionSuffixSymbols[2]
+				: static::$apiDescriptionSuffixSymbols[$route['accessLevel']]
+			);
+		$r->notes = $notes;
+
+		$r->errorResponses = array();
+		return $r;
+	}
+
+	protected function _parameter($param)
+	{
+		$r = new stdClass();
+		$r->name = $param['name'];
+		$r->description = !empty($param['description'])
+			? $param['description'] . '.'
+			: ($this->restler->getProductionMode()
+				? ''
+				: 'add <mark>@param {type} $' . $r->name
+				. ' {comment}</mark> to describe here');
+		//paramType can be path or query or body or header
+		$r->paramType = Util::nestedValue($param, CommentParser::$embeddedDataName, 'from') ? : 'query';
+		$r->required = isset($param['required']) && $param['required'];
+		if (isset($param['default'])) {
+			$r->defaultValue = $param['default'];
+		} elseif (isset($param[CommentParser::$embeddedDataName]['example'])) {
+			$r->defaultValue
+				= $param[CommentParser::$embeddedDataName]['example'];
+		}
+		$r->allowMultiple = false;
+		$type = 'string';
+		if (isset($param['type'])) {
+			$type = $param['type'];
+			if (is_array($type)) {
+				$type = array_shift($type);
+			}
+			if ($type == 'array') {
+				$contentType = Util::nestedValue(
+					$param,
+					CommentParser::$embeddedDataName,
+					'type'
+				);
+				if ($contentType) {
+					if ($contentType == 'indexed') {
+						$type = 'Array';
+					} elseif ($contentType == 'associative') {
+						$type = 'Object';
+					} else {
+						$type = "Array[$contentType]";
+					}
+					if (Util::isObjectOrArray($contentType)) {
+						$this->_model($contentType);
+					}
+				} elseif (isset(static::$dataTypeAlias[$type])) {
+					$type = static::$dataTypeAlias[$type];
+				}
+			} elseif (Util::isObjectOrArray($type)) {
+				$this->_model($type);
+			} elseif (isset(static::$dataTypeAlias[$type])) {
+				$type = static::$dataTypeAlias[$type];
+			}
+		}
+		$r->dataType = $type;
+		if (isset($param[CommentParser::$embeddedDataName])) {
+			$p = $param[CommentParser::$embeddedDataName];
+			if (isset($p['min']) && isset($p['max'])) {
+				$r->allowableValues = array(
+					'valueType' => 'RANGE',
+					'min' => $p['min'],
+					'max' => $p['max'],
+				);
+			} elseif (isset($p['choice'])) {
+				$r->allowableValues = array(
+					'valueType' => 'LIST',
+					'values' => $p['choice']
+				);
+			}
+		}
+		return $r;
+	}
+
+	protected function _appendToBody($p)
+	{
+		if ($p->name === Defaults::$fullRequestDataName) {
+			$this->_fullDataRequested = $p;
+			unset($this->_bodyParam['names'][Defaults::$fullRequestDataName]);
+			return;
+		}
+		$this->_bodyParam['description'][$p->name]
+			= "$p->name"
+			. ' : <tag>' . $p->dataType . '</tag> '
+			. ($p->required ? ' <i>(required)</i> - ' : ' - ')
+			. $p->description;
+		$this->_bodyParam['required'] = $p->required
+			|| $this->_bodyParam['required'];
+		$this->_bodyParam['names'][$p->name] = $p;
+	}
+
+	protected function _getBody()
+	{
+		$r = new stdClass();
+		$n = isset($this->_bodyParam['names'])
+			? array_values($this->_bodyParam['names'])
+			: array();
+		if (count($n) == 1) {
+			if (isset($this->_models->{$n[0]->dataType})) {
+				// ============ custom class ===================
+				$r = $n[0];
+				$c = $this->_models->{$r->dataType};
+				$a = $c->properties;
+				$r->description = "Paste JSON data here";
+				if (count($a)) {
+					$r->description .= " with the following"
+						. (count($a) > 1 ? ' properties.' : ' property.');
+					foreach ($a as $k => $v) {
+						$r->description .= "<hr/>$k : <tag>"
+							. $v['type'] . '</tag> '
+							. (isset($v['required']) ? '(required)' : '')
+							. ' - ' . $v['description'];
+					}
+				}
+				$r->defaultValue = "{\n    \""
+					. implode("\": \"\",\n    \"",
+						array_keys($c->properties))
+					. "\": \"\"\n}";
+				return $r;
+			} elseif (false !== ($p = strpos($n[0]->dataType, '['))) {
+				// ============ array of custom class ===============
+				$r = $n[0];
+				$t = substr($r->dataType, $p + 1, -1);
+				if ($c = Util::nestedValue($this->_models, $t)) {
+					$a = $c->properties;
+					$r->description = "Paste JSON data here";
+					if (count($a)) {
+						$r->description .= " with an array of objects with the following"
+							. (count($a) > 1 ? ' properties.' : ' property.');
+						foreach ($a as $k => $v) {
+							$r->description .= "<hr/>$k : <tag>"
+								. $v['type'] . '</tag> '
+								. (isset($v['required']) ? '(required)' : '')
+								. ' - ' . $v['description'];
+						}
+					}
+					$r->defaultValue = "[\n    {\n        \""
+						. implode("\": \"\",\n        \"",
+							array_keys($c->properties))
+						. "\": \"\"\n    }\n]";
+					return $r;
+				} else {
+					$r->description = "Paste JSON data here with an array of $t values.";
+					$r->defaultValue = "[ ]";
+					return $r;
+				}
+			} elseif ($n[0]->dataType == 'Array') {
+				// ============ array ===============================
+				$r = $n[0];
+				$r->description = "Paste JSON array data here"
+					. ($r->required ? ' (required) . ' : '. ')
+					. "<br/>$r->description";
+				$r->defaultValue = "[\n    {\n        \""
+					. "property\" : \"\"\n    }\n]";
+				return $r;
+			} elseif ($n[0]->dataType == 'Object') {
+				// ============ object ==============================
+				$r = $n[0];
+				$r->description = "Paste JSON object data here"
+					. ($r->required ? ' (required) . ' : '. ')
+					. "<br/>$r->description";
+				$r->defaultValue = "{\n    \""
+					. "property\" : \"\"\n}";
+				return $r;
+			}
+		}
+		$p = array_values($this->_bodyParam['description']);
+		$r->name = 'REQUEST_BODY';
+		$r->description = "Paste JSON data here";
+		if (count($p) == 0 && $this->_fullDataRequested) {
+			$r->required = $this->_fullDataRequested->required;
+			$r->defaultValue = "{\n    \"property\" : \"\"\n}";
+		} else {
+			$r->description .= " with the following"
+				. (count($p) > 1 ? ' properties.' : ' property.')
+				. '<hr/>'
+				. implode("<hr/>", $p);
+			$r->required = $this->_bodyParam['required'];
+			// Create default object that includes parameters to be submitted
+			$defaultObject = new \StdClass();
+			foreach ($this->_bodyParam['names'] as $name => $values) {
+				if (!$values->required)
+					continue;
+				if (class_exists($values->dataType)) {
+					$myClassName = $values->dataType;
+					$defaultObject->$name = new $myClassName();
+				} else {
+					$defaultObject->$name = '';
+				}
+			}
+			$r->defaultValue = Scope::get('JsonFormat')->encode($defaultObject, true);
+		}
+		$r->paramType = 'body';
+		$r->allowMultiple = false;
+		$r->dataType = 'Object';
+		return $r;
+	}
+
+	protected function _model($className, $instance = null)
+	{
+		$id = $this->_noNamespace($className);
+		if (isset($this->_models->{$id})) {
+			return;
+		}
+		$properties = array();
+		if (!$instance) {
+			if (!class_exists($className))
+				return;
+			$instance = new $className();
+		}
+		$data = get_object_vars($instance);
+		$reflectionClass = new \ReflectionClass($className);
+		foreach ($data as $key => $value) {
+
+			$propertyMetaData = null;
+
+			try {
+				$property = $reflectionClass->getProperty($key);
+				if ($c = $property->getDocComment()) {
+					$propertyMetaData = Util::nestedValue(
+						CommentParser::parse($c),
+						'var'
+					);
+				}
+			} catch (\ReflectionException $e) {
+			}
+
+			if (is_null($propertyMetaData)) {
+				$type = $this->getType($value, true);
+				$description = '';
+			} else {
+				$type = Util::nestedValue(
+					$propertyMetaData,
+					'type'
+				) ? : $this->getType($value, true);
+				$description = Util::nestedValue(
+					$propertyMetaData,
+					'description'
+				) ? : '';
+
+				if (class_exists($type)) {
+					$this->_model($type);
+					$type = $this->_noNamespace($type);
+				}
+			}
+
+			if (isset(static::$dataTypeAlias[$type])) {
+				$type = static::$dataTypeAlias[$type];
+			}
+			$properties[$key] = array(
+				'type' => $type,
+				'description' => $description
+			);
+			if (Util::nestedValue(
+				$propertyMetaData,
+				CommentParser::$embeddedDataName,
+				'required'
+			)
+			) {
+				$properties[$key]['required'] = true;
+			}
+			if ($type == 'Array') {
+				$itemType = Util::nestedValue(
+					$propertyMetaData,
+					CommentParser::$embeddedDataName,
+					'type'
+				) ? :
+					(count($value)
+						? $this->getType(end($value), true)
+						: 'string');
+				if (class_exists($itemType)) {
+					$this->_model($itemType);
+					$itemType = $this->_noNamespace($itemType);
+				}
+				$properties[$key]['items'] = array(
+					'type' => $itemType,
+					/*'description' => '' */ //TODO: add description
+				);
+			} else if (preg_match('/^Array\[(.+)\]$/', $type, $matches)) {
+				$itemType = $matches[1];
+				$properties[$key]['type'] = 'Array';
+				$properties[$key]['items']['type'] = $this->_noNamespace($itemType);
+
+				if (class_exists($itemType)) {
+					$this->_model($itemType);
+				}
+			}
+		}
+		if (!empty($properties)) {
+			$model = new stdClass();
+			$model->id = $id;
+			$model->properties = $properties;
+			$this->_models->{$id} = $model;
+		}
+	}
+
+	/**
+	 * Find the data type of the given value.
+	 *
+	 *
+	 * @param mixed $o given value for finding type
+	 *
+	 * @param bool $appendToModels if an object is found should we append to
+	 *                              our models list?
+	 *
+	 * @return string
+	 *
+	 * @access private
+	 */
+	public function getType($o, $appendToModels = false)
+	{
+		if (is_object($o)) {
+			$oc = get_class($o);
+			if ($appendToModels) {
+				$this->_model($oc, $o);
+			}
+			return $this->_noNamespace($oc);
+		}
+		if (is_array($o)) {
+			if (count($o)) {
+				$child = end($o);
+				if (Util::isObjectOrArray($child)) {
+					$childType = $this->getType($child, $appendToModels);
+					return "Array[$childType]";
+				}
+			}
+			return 'array';
+		}
+		if (is_bool($o)) return 'boolean';
+		if (is_numeric($o)) return is_float($o) ? 'float' : 'int';
+		return 'string';
+	}
+
+	/**
+	 * pre call for index()
+	 *
+	 * if cache is present, use cache
+	 */
+	public function _pre_index_json()
+	{
+		$userClass = Defaults::$userIdentifierClass;
+		$this->cacheName = $userClass::getCacheIdentifier()
+			. '_resources-v'
+			. $this->restler->_requestedApiVersion;
+		if ($this->restler->getProductionMode()
+			&& !$this->restler->refreshCache
+			&& $this->restler->cache->isCached($this->cacheName)
+		) {
+			//by pass call, compose, postCall stages and directly send response
+			$this->restler->composeHeaders();
+			die($this->restler->cache->get($this->cacheName));
+		}
+	}
+
+	/**
+	 * post call for index()
+	 *
+	 * create cache if in production mode
+	 *
+	 * @param $responseData
+	 *
+	 * @internal param string $data composed json output
+	 *
+	 * @return string
+	 */
+	public function _post_index_json($responseData)
+	{
+		if ($this->restler->getProductionMode()) {
+			$this->restler->cache->set($this->cacheName, $responseData);
+		}
+		return $responseData;
+	}
+
+	/**
+	 * @access hybrid
+	 * @return \stdClass
+	 */
+	public function index()
+	{
+		if (!static::$accessControlFunction && Defaults::$accessControlFunction)
+			static::$accessControlFunction = Defaults::$accessControlFunction;
+		$version = $this->restler->getRequestedApiVersion();
+		$allRoutes = Util::nestedValue(Routes::toArray(), "v$version");
+		$r = $this->_resourceListing();
+		$map = array();
+		if (isset($allRoutes['*'])) {
+			$this->_mapResources($allRoutes['*'], $map, $version);
+			unset($allRoutes['*']);
+		}
+		$this->_mapResources($allRoutes, $map, $version);
+		foreach ($map as $path => $description) {
+			if (!Text::contains($path, '{')) {
+				//add id
+				$r->apis[] = array(
+					'path' => $path . $this->formatString,
+					'description' => $description
+				);
+			}
+		}
+		if (Defaults::$useUrlBasedVersioning && static::$listHigherVersions) {
+			$nextVersion = $version + 1;
+			if ($nextVersion <= $this->restler->getApiVersion()) {
+				list($status, $data) = $this->_loadResource("/v$nextVersion/resources.json");
+				if ($status == 200) {
+					$r->apis = array_merge($r->apis, $data->apis);
+					$r->apiVersion = $data->apiVersion;
+				}
+			}
+
+		}
+		return $r;
+	}
+
+	protected function _loadResource($url)
+	{
+		$ch = curl_init($this->restler->getBaseUrl() . $url
+			. (empty($_GET) ? '' : '?' . http_build_query($_GET)));
+		curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
+		curl_setopt($ch, CURLOPT_TIMEOUT, 15);
+		curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
+		curl_setopt($ch, CURLOPT_HTTPHEADER, array(
+			'Accept:application/json',
+		));
+		curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);        
+		$result = json_decode(curl_exec($ch));
+		$http_status = (int)curl_getinfo($ch, CURLINFO_HTTP_CODE);
+		return array($http_status, $result);
+	}
+
+	protected function _mapResources(array $allRoutes, array &$map, $version = 1)
+	{
+		foreach ($allRoutes as $fullPath => $routes) {
+			$path = explode('/', $fullPath);
+			$resource = isset($path[0]) ? $path[0] : '';
+			if ($resource == 'resources' || Text::endsWith($resource, 'index'))
+				continue;
+			foreach ($routes as $httpMethod => $route) {
+				if (in_array($httpMethod, static::$excludedHttpMethods)) {
+					continue;
+				}
+				if (!static::verifyAccess($route)) {
+					continue;
+				}
+
+				foreach (static::$excludedPaths as $exclude) {
+					if (empty($exclude)) {
+						if ($fullPath == $exclude)
+							continue 2;
+					} elseif (Text::beginsWith($fullPath, $exclude)) {
+						continue 2;
+					}
+				}
+
+				$res = $resource
+					? ($version == 1 ? "/resources/$resource" : "/v$version/resources/$resource-v$version")
+					: ($version == 1 ? "/resources/root" : "/v$version/resources/root-v$version");
+
+				if (empty($map[$res])) {
+					$map[$res] = isset(
+					$route['metadata']['classDescription'])
+						? $route['metadata']['classDescription'] : '';
+				}
+			}
+		}
+	}
+
+	/**
+	 * Maximum api version supported by the api class
+	 * @return int
+	 */
+	public static function __getMaximumSupportedVersion()
+	{
+		return Scope::get('Restler')->getApiVersion();
+	}
+
+	/**
+	 * Verifies that the requesting user is allowed to view the docs for this API
+	 *
+	 * @param $route
+	 *
+	 * @return boolean True if the user should be able to view this API's docs
+	 */
+	protected function verifyAccess($route)
+	{
+		if ($route['accessLevel'] < 2) {
+			return true;
+		}
+		if (
+			static::$hideProtected
+			&& !$this->_authenticated
+			&& $route['accessLevel'] > 1
+		) {
+			return false;
+		}
+		if ($this->_authenticated
+			&& static::$accessControlFunction
+			&& (!call_user_func(
+				static::$accessControlFunction, $route['metadata']))
+		) {
+			return false;
+		}
+		return true;
+	}
 }

Spacing +26 added lines, -27 removed lines

@@ -150,7 +150,7 @@ 
     public function _pre_get_json($id)
     {
         $userClass = Defaults::$userIdentifierClass;
-        $this->cacheName = $userClass::getCacheIdentifier() . '_resources_' . $id;
+        $this->cacheName = $userClass::getCacheIdentifier().'_resources_'.$id;
         if ($this->restler->getProductionMode()
             && !$this->restler->refreshCache
             && $this->restler->cache->isCached($this->cacheName)
@@ -216,7 +216,7 @@ 
 
         $routes
             = Util::nestedValue(Routes::toArray(), "v$version")
-            ? : array();
+            ?: array();
 
         $prefix = Defaults::$useUrlBasedVersioning ? "/v$version" : '';
 
@@ -231,7 +231,7 @@ 
                 }
                 $fLen = strlen($fullPath);
                 if ($tSlash) {
-                    if ($fLen != $tLen && !Text::beginsWith($fullPath, $target . '/'))
+                    if ($fLen != $tLen && !Text::beginsWith($fullPath, $target.'/'))
                         continue;
                 } elseif ($fLen > $tLen + 1 && $fullPath[$tLen + 1] != '{' && !Text::beginsWith($fullPath, '{')) {
                     //when mapped to root exclude paths that have static parts
@@ -290,21 +290,21 @@ 
                 $description = isset(
                 $m['classDescription'])
                     ? $m['classDescription']
-                    : $className . ' API';
+                    : $className.' API';
                 if (empty($m['description'])) {
                     $m['description'] = $this->restler->getProductionMode()
                         ? ''
                         : 'routes to <mark>'
                         . $route['className']
                         . '::'
-                        . $route['methodName'] . '();</mark>';
+                        . $route['methodName'].'();</mark>';
                 }
                 if (empty($m['longDescription'])) {
                     $m['longDescription'] = $this->restler->getProductionMode()
                         ? ''
                         : 'Add PHPDoc long description to '
                         . "<mark>$className::"
-                        . $route['methodName'] . '();</mark>'
+                        . $route['methodName'].'();</mark>'
                         . '  (the api method) to write here';
                 }
                 $operation = $this->_operation(
@@ -359,8 +359,8 @@ 
                                 ['type'];
                                 if (class_exists($rt)) {
                                     $this->_model($rt);
-                                    $operation->responseClass .= '[' .
-                                        $this->_noNamespace($rt) . ']';
+                                    $operation->responseClass .= '['.
+                                        $this->_noNamespace($rt).']';
                                 }
                             }
                         }
@@ -392,7 +392,7 @@ 
             $r->models = $this->_models;
         usort(
             $r->apis,
-            function ($a, $b) {
+            function($a, $b) {
                 $order = array(
                     'GET' => 1,
                     'POST' => 2,
@@ -450,7 +450,7 @@ 
     protected function _resourceListing()
     {
         $r = new stdClass();
-        $r->apiVersion = (string)$this->restler->_requestedApiVersion;
+        $r->apiVersion = (string) $this->restler->_requestedApiVersion;
         $r->swaggerVersion = "1.1";
         $r->basePath = $this->restler->getBaseUrl();
         $r->produces = $this->restler->getWritableMimeTypes();
@@ -493,7 +493,7 @@ 
 
         $r->parameters = array();
 
-        $r->summary = $summary . ($route['accessLevel'] > 2
+        $r->summary = $summary.($route['accessLevel'] > 2
                 ? static::$apiDescriptionSuffixSymbols[2]
                 : static::$apiDescriptionSuffixSymbols[$route['accessLevel']]
             );
@@ -508,13 +508,13 @@ 
         $r = new stdClass();
         $r->name = $param['name'];
         $r->description = !empty($param['description'])
-            ? $param['description'] . '.'
+            ? $param['description'].'.'
             : ($this->restler->getProductionMode()
                 ? ''
-                : 'add <mark>@param {type} $' . $r->name
+                : 'add <mark>@param {type} $'.$r->name
                 . ' {comment}</mark> to describe here');
         //paramType can be path or query or body or header
-        $r->paramType = Util::nestedValue($param, CommentParser::$embeddedDataName, 'from') ? : 'query';
+        $r->paramType = Util::nestedValue($param, CommentParser::$embeddedDataName, 'from') ?: 'query';
         $r->required = isset($param['required']) && $param['required'];
         if (isset($param['default'])) {
             $r->defaultValue = $param['default'];
@@ -583,7 +583,7 @@ 
         }
         $this->_bodyParam['description'][$p->name]
             = "$p->name"
-            . ' : <tag>' . $p->dataType . '</tag> '
+            . ' : <tag>'.$p->dataType.'</tag> '
             . ($p->required ? ' <i>(required)</i> - ' : ' - ')
             . $p->description;
         $this->_bodyParam['required'] = $p->required
@@ -609,9 +609,9 @@ 
                         . (count($a) > 1 ? ' properties.' : ' property.');
                     foreach ($a as $k => $v) {
                         $r->description .= "<hr/>$k : <tag>"
-                            . $v['type'] . '</tag> '
+                            . $v['type'].'</tag> '
                             . (isset($v['required']) ? '(required)' : '')
-                            . ' - ' . $v['description'];
+                            . ' - '.$v['description'];
                     }
                 }
                 $r->defaultValue = "{\n    \""
@@ -631,9 +631,9 @@ 
                             . (count($a) > 1 ? ' properties.' : ' property.');
                         foreach ($a as $k => $v) {
                             $r->description .= "<hr/>$k : <tag>"
-                                . $v['type'] . '</tag> '
+                                . $v['type'].'</tag> '
                                 . (isset($v['required']) ? '(required)' : '')
-                                . ' - ' . $v['description'];
+                                . ' - '.$v['description'];
                         }
                     }
                     $r->defaultValue = "[\n    {\n        \""
@@ -734,11 +734,11 @@ 
                 $type = Util::nestedValue(
                     $propertyMetaData,
                     'type'
-                ) ? : $this->getType($value, true);
+                ) ?: $this->getType($value, true);
                 $description = Util::nestedValue(
                     $propertyMetaData,
                     'description'
-                ) ? : '';
+                ) ?: '';
 
                 if (class_exists($type)) {
                     $this->_model($type);
@@ -766,8 +766,7 @@ 
                     $propertyMetaData,
                     CommentParser::$embeddedDataName,
                     'type'
-                ) ? :
-                    (count($value)
+                ) ?: (count($value)
                         ? $this->getType(end($value), true)
                         : 'string');
                 if (class_exists($itemType)) {
@@ -894,7 +893,7 @@ 
             if (!Text::contains($path, '{')) {
                 //add id
                 $r->apis[] = array(
-                    'path' => $path . $this->formatString,
+                    'path' => $path.$this->formatString,
                     'description' => $description
                 );
             }
@@ -915,8 +914,8 @@ 
 
     protected function _loadResource($url)
     {
-        $ch = curl_init($this->restler->getBaseUrl() . $url
-            . (empty($_GET) ? '' : '?' . http_build_query($_GET)));
+        $ch = curl_init($this->restler->getBaseUrl().$url
+            . (empty($_GET) ? '' : '?'.http_build_query($_GET)));
         curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
         curl_setopt($ch, CURLOPT_TIMEOUT, 15);
         curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
@@ -925,7 +924,7 @@ 
         ));
         curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);        
         $result = json_decode(curl_exec($ch));
-        $http_status = (int)curl_getinfo($ch, CURLINFO_HTTP_CODE);
+        $http_status = (int) curl_getinfo($ch, CURLINFO_HTTP_CODE);
         return array($http_status, $result);
     }
 

Braces +33 added lines, -20 removed lines

@@ -231,8 +231,9 @@ 
                 }
                 $fLen = strlen($fullPath);
                 if ($tSlash) {
-                    if ($fLen != $tLen && !Text::beginsWith($fullPath, $target . '/'))
-                        continue;
+                    if ($fLen != $tLen && !Text::beginsWith($fullPath, $target . '/')) {
+                                            continue;
+                    }
                 } elseif ($fLen > $tLen + 1 && $fullPath[$tLen + 1] != '{' && !Text::beginsWith($fullPath, '{')) {
                     //when mapped to root exclude paths that have static parts
                     //they are listed else where under that static part name
@@ -244,8 +245,9 @@ 
                 }
                 foreach (static::$excludedPaths as $exclude) {
                     if (empty($exclude)) {
-                        if ($fullPath == $exclude)
-                            continue 2;
+                        if ($fullPath == $exclude) {
+                                                    continue 2;
+                        }
                     } elseif (Text::beginsWith($fullPath, $exclude)) {
                         continue 2;
                     }
@@ -283,8 +285,9 @@ 
                 }
                 $nickname = $this->_nickname($route);
                 $index = static::$placeFormatExtensionBeforeDynamicParts && $pos > 0 ? $pos : 0;
-                if (!empty($parts[$index]))
-                    $parts[$index] .= $this->formatString;
+                if (!empty($parts[$index])) {
+                                    $parts[$index] .= $this->formatString;
+                }
 
                 $fullPath = implode('/', $parts);
                 $description = isset(
@@ -388,8 +391,9 @@ 
         if (!$count) {
             throw new RestException(404);
         }
-        if (!is_null($r))
-            $r->models = $this->_models;
+        if (!is_null($r)) {
+                    $r->models = $this->_models;
+        }
         usort(
             $r->apis,
             function ($a, $b) {
@@ -681,8 +685,9 @@ 
             // Create default object that includes parameters to be submitted
             $defaultObject = new \StdClass();
             foreach ($this->_bodyParam['names'] as $name => $values) {
-                if (!$values->required)
-                    continue;
+                if (!$values->required) {
+                                    continue;
+                }
                 if (class_exists($values->dataType)) {
                     $myClassName = $values->dataType;
                     $defaultObject->$name = new $myClassName();
@@ -706,8 +711,9 @@ 
         }
         $properties = array();
         if (!$instance) {
-            if (!class_exists($className))
-                return;
+            if (!class_exists($className)) {
+                            return;
+            }
             $instance = new $className();
         }
         $data = get_object_vars($instance);
@@ -828,8 +834,12 @@ 
             }
             return 'array';
         }
-        if (is_bool($o)) return 'boolean';
-        if (is_numeric($o)) return is_float($o) ? 'float' : 'int';
+        if (is_bool($o)) {
+        	return 'boolean';
+        }
+        if (is_numeric($o)) {
+        	return is_float($o) ? 'float' : 'int';
+        }
         return 'string';
     }
 
@@ -879,8 +889,9 @@ 
      */
     public function index()
     {
-        if (!static::$accessControlFunction && Defaults::$accessControlFunction)
-            static::$accessControlFunction = Defaults::$accessControlFunction;
+        if (!static::$accessControlFunction && Defaults::$accessControlFunction) {
+                    static::$accessControlFunction = Defaults::$accessControlFunction;
+        }
         $version = $this->restler->getRequestedApiVersion();
         $allRoutes = Util::nestedValue(Routes::toArray(), "v$version");
         $r = $this->_resourceListing();
@@ -934,8 +945,9 @@ 
         foreach ($allRoutes as $fullPath => $routes) {
             $path = explode('/', $fullPath);
             $resource = isset($path[0]) ? $path[0] : '';
-            if ($resource == 'resources' || Text::endsWith($resource, 'index'))
-                continue;
+            if ($resource == 'resources' || Text::endsWith($resource, 'index')) {
+                            continue;
+            }
             foreach ($routes as $httpMethod => $route) {
                 if (in_array($httpMethod, static::$excludedHttpMethods)) {
                     continue;
@@ -946,8 +958,9 @@ 
 
                 foreach (static::$excludedPaths as $exclude) {
                     if (empty($exclude)) {
-                        if ($fullPath == $exclude)
-                            continue 2;
+                        if ($fullPath == $exclude) {
+                                                    continue 2;
+                        }
                     } elseif (Text::beginsWith($fullPath, $exclude)) {
                         continue 2;
                     }

htdocs/includes/restler/framework/Luracast/Restler/Scope.php

Indentation +217 added lines, -217 removed lines

@@ -17,221 +17,221 @@
  */
 class Scope
 {
-    public static $classAliases = array(
-
-        //Core
-        'Restler'            => 'Luracast\Restler\Restler',
-
-        //Format classes
-        'AmfFormat'          => 'Luracast\Restler\Format\AmfFormat',
-        'JsFormat'           => 'Luracast\Restler\Format\JsFormat',
-        'JsonFormat'         => 'Luracast\Restler\Format\JsonFormat',
-        'HtmlFormat'         => 'Luracast\Restler\Format\HtmlFormat',
-        'PlistFormat'        => 'Luracast\Restler\Format\PlistFormat',
-        'UploadFormat'       => 'Luracast\Restler\Format\UploadFormat',
-        'UrlEncodedFormat'   => 'Luracast\Restler\Format\UrlEncodedFormat',
-        'XmlFormat'          => 'Luracast\Restler\Format\XmlFormat',
-        'YamlFormat'         => 'Luracast\Restler\Format\YamlFormat',
-        'CsvFormat'          => 'Luracast\Restler\Format\CsvFormat',
-        'TsvFormat'          => 'Luracast\Restler\Format\TsvFormat',
-
-        //Filter classes
-        'RateLimit'          => 'Luracast\Restler\Filter\RateLimit',
-
-        //UI classes
-        'Forms'              => 'Luracast\Restler\UI\Forms',
-        'Nav'                => 'Luracast\Restler\UI\Nav',
-        'Emmet'              => 'Luracast\Restler\UI\Emmet',
-        'T'                  => 'Luracast\Restler\UI\Tags',
-
-        //API classes
-        'Resources'          => 'Luracast\Restler\Resources',
-        'Explorer'           => 'Luracast\Restler\Explorer\v2\Explorer',
-        'Explorer1'          => 'Luracast\Restler\Explorer\v1\Explorer',
-        'Explorer2'          => 'Luracast\Restler\Explorer\v2\Explorer',
-
-        //Cache classes
-        'HumanReadableCache' => 'Luracast\Restler\HumanReadableCache',
-        'ApcCache'           => 'Luracast\Restler\ApcCache',
-        'MemcacheCache'      => 'Luracast\Restler\MemcacheCache',
-
-        //Utility classes
-        'Object'             => 'Luracast\Restler\Data\Obj',
-        'Text'               => 'Luracast\Restler\Data\Text',
-        'Arr'                => 'Luracast\Restler\Data\Arr',
-
-        //Exception
-        'RestException'      => 'Luracast\Restler\RestException'
-    );
-    /**
-     * @var null|Callable adding a resolver function that accepts
-     * the class name as the parameter and returns an instance of the class
-     * as a singleton. Allows the use of your favourite DI container
-     */
-    public static $resolver = null;
-    public static $properties = array();
-    protected static $instances = array();
-    protected static $registry = array();
-
-    /**
-     * @param string   $name
-     * @param callable $function
-     * @param bool     $singleton
-     */
-    public static function register($name, $function, $singleton = true)
-    {
-        static::$registry[$name] = (object)compact('function', 'singleton');
-    }
-
-    public static function set($name, $instance)
-    {
-        static::$instances[$name] = (object)array('instance' => $instance);
-    }
-
-    public static function get($name)
-    {
-        $r = null;
-        $initialized = false;
-        $properties = array();
-        if (array_key_exists($name, static::$instances)) {
-            $initialized = true;
-            $r = static::$instances[$name]->instance;
-        } elseif (!empty(static::$registry[$name])) {
-            $function = static::$registry[$name]->function;
-            $r = $function();
-            if (static::$registry[$name]->singleton) {
-                static::$instances[$name] = (object)array('instance' => $r);
-            }
-        } elseif (is_callable(static::$resolver) && false === stristr($name, 'Luracast\Restler')) {
-            $fullName = $name;
-            if (isset(static::$classAliases[$name])) {
-                $fullName = static::$classAliases[$name];
-            }
-            /** @var Callable $function */
-            $function = static::$resolver;
-            $r = $function($fullName);
-            static::$instances[$name] = (object)array('instance' => $r);
-            static::$instances[$name]->initPending = true;
-        } else {
-            $fullName = $name;
-            if (isset(static::$classAliases[$name])) {
-                $fullName = static::$classAliases[$name];
-            }
-            if (class_exists($fullName)) {
-                $shortName = Util::getShortName($name);
-                $r = new $fullName();
-                static::$instances[$name] = (object)array('instance' => $r);
-                if ($name != 'Restler') {
-                    /** @var Restler restler */
-                    $r->restler = static::get('Restler');
-                    $m = Util::nestedValue($r->restler, 'apiMethodInfo', 'metadata');
-                    if ($m) {
-                        $properties = Util::nestedValue(
-                            $m, 'class', $fullName,
-                            CommentParser::$embeddedDataName
-                        ) ?: (Util::nestedValue(
-                            $m, 'class', $shortName,
-                            CommentParser::$embeddedDataName
-                        ) ?: array());
-                    } else {
-                        static::$instances[$name]->initPending = true;
-                    }
-                }
-            }
-        }
-        if (
-            $r instanceof iUseAuthentication &&
-            $r->restler && $r->restler->_authVerified &&
-            !isset(static::$instances[$name]->authVerified)
-        ) {
-            static::$instances[$name]->authVerified = true;
-            $r->__setAuthenticationStatus($r->restler->_authenticated);
-        }
-        if (isset(static::$instances[$name]->initPending)) {
-            $m = Util::nestedValue($r->restler, 'apiMethodInfo', 'metadata');
-            $fullName = $name;
-            if (class_exists($name)) {
-                $shortName = Util::getShortName($name);
-            } else {
-                $shortName = $name;
-                if (isset(static::$classAliases[$name])) {
-                    $fullName = static::$classAliases[$name];
-                }
-            }
-            if ($m) {
-                $properties = Util::nestedValue(
-                    $m, 'class', $fullName,
-                    CommentParser::$embeddedDataName
-                ) ?: (Util::nestedValue(
-                    $m, 'class', $shortName,
-                    CommentParser::$embeddedDataName
-                ) ?: array());
-                unset(static::$instances[$name]->initPending);
-                $initialized = false;
-            }
-        }
-        if (!$initialized && is_object($r)) {
-            $properties += static::$properties;
-            $objectVars = get_object_vars($r);
-            $className = get_class($r);
-            foreach ($properties as $property => $value) {
-                if (property_exists($className, $property)) {
-                    //if not a static property
-                    array_key_exists($property, $objectVars)
-                        ? $r->{$property} = $value
-                        : $r::$$property = $value;
-                }
-            }
-        }
-        return $r;
-    }
-
-    /**
-     * Get fully qualified class name for the given scope
-     *
-     * @param string $className
-     * @param array  $scope local scope
-     *
-     * @return string|boolean returns the class name or false
-     */
-    public static function resolve($className, array $scope)
-    {
-        if (empty($className) || !is_string($className)) {
-            return false;
-        }
-
-        if (self::isPrimitiveDataType($className)) {
-            return false;
-        }
-
-        $divider = '\\';
-        if ($className[0] == $divider) {
-            $qualified = trim($className, $divider);
-        } elseif (array_key_exists($className, $scope)) {
-            $qualified = $scope[$className];
-        } else {
-            $qualified = $scope['*'] . $className;
-        }
-        if (class_exists($qualified)) {
-            return $qualified;
-        }
-        if (isset(static::$classAliases[$className])) {
-            $qualified = static::$classAliases[$className];
-            if (class_exists($qualified)) {
-                return $qualified;
-            }
-        }
-        return false;
-    }
-
-    /**
-     * @param string $stringName
-     *
-     * @return boolean
-     */
-    private static function isPrimitiveDataType($stringName)
-    {
-        $primitiveDataTypes = array('Array', 'array', 'bool', 'boolean', 'float', 'int', 'integer', 'string');
-        return in_array($stringName, $primitiveDataTypes);
-    }
+	public static $classAliases = array(
+
+		//Core
+		'Restler'            => 'Luracast\Restler\Restler',
+
+		//Format classes
+		'AmfFormat'          => 'Luracast\Restler\Format\AmfFormat',
+		'JsFormat'           => 'Luracast\Restler\Format\JsFormat',
+		'JsonFormat'         => 'Luracast\Restler\Format\JsonFormat',
+		'HtmlFormat'         => 'Luracast\Restler\Format\HtmlFormat',
+		'PlistFormat'        => 'Luracast\Restler\Format\PlistFormat',
+		'UploadFormat'       => 'Luracast\Restler\Format\UploadFormat',
+		'UrlEncodedFormat'   => 'Luracast\Restler\Format\UrlEncodedFormat',
+		'XmlFormat'          => 'Luracast\Restler\Format\XmlFormat',
+		'YamlFormat'         => 'Luracast\Restler\Format\YamlFormat',
+		'CsvFormat'          => 'Luracast\Restler\Format\CsvFormat',
+		'TsvFormat'          => 'Luracast\Restler\Format\TsvFormat',
+
+		//Filter classes
+		'RateLimit'          => 'Luracast\Restler\Filter\RateLimit',
+
+		//UI classes
+		'Forms'              => 'Luracast\Restler\UI\Forms',
+		'Nav'                => 'Luracast\Restler\UI\Nav',
+		'Emmet'              => 'Luracast\Restler\UI\Emmet',
+		'T'                  => 'Luracast\Restler\UI\Tags',
+
+		//API classes
+		'Resources'          => 'Luracast\Restler\Resources',
+		'Explorer'           => 'Luracast\Restler\Explorer\v2\Explorer',
+		'Explorer1'          => 'Luracast\Restler\Explorer\v1\Explorer',
+		'Explorer2'          => 'Luracast\Restler\Explorer\v2\Explorer',
+
+		//Cache classes
+		'HumanReadableCache' => 'Luracast\Restler\HumanReadableCache',
+		'ApcCache'           => 'Luracast\Restler\ApcCache',
+		'MemcacheCache'      => 'Luracast\Restler\MemcacheCache',
+
+		//Utility classes
+		'Object'             => 'Luracast\Restler\Data\Obj',
+		'Text'               => 'Luracast\Restler\Data\Text',
+		'Arr'                => 'Luracast\Restler\Data\Arr',
+
+		//Exception
+		'RestException'      => 'Luracast\Restler\RestException'
+	);
+	/**
+	 * @var null|Callable adding a resolver function that accepts
+	 * the class name as the parameter and returns an instance of the class
+	 * as a singleton. Allows the use of your favourite DI container
+	 */
+	public static $resolver = null;
+	public static $properties = array();
+	protected static $instances = array();
+	protected static $registry = array();
+
+	/**
+	 * @param string   $name
+	 * @param callable $function
+	 * @param bool     $singleton
+	 */
+	public static function register($name, $function, $singleton = true)
+	{
+		static::$registry[$name] = (object)compact('function', 'singleton');
+	}
+
+	public static function set($name, $instance)
+	{
+		static::$instances[$name] = (object)array('instance' => $instance);
+	}
+
+	public static function get($name)
+	{
+		$r = null;
+		$initialized = false;
+		$properties = array();
+		if (array_key_exists($name, static::$instances)) {
+			$initialized = true;
+			$r = static::$instances[$name]->instance;
+		} elseif (!empty(static::$registry[$name])) {
+			$function = static::$registry[$name]->function;
+			$r = $function();
+			if (static::$registry[$name]->singleton) {
+				static::$instances[$name] = (object)array('instance' => $r);
+			}
+		} elseif (is_callable(static::$resolver) && false === stristr($name, 'Luracast\Restler')) {
+			$fullName = $name;
+			if (isset(static::$classAliases[$name])) {
+				$fullName = static::$classAliases[$name];
+			}
+			/** @var Callable $function */
+			$function = static::$resolver;
+			$r = $function($fullName);
+			static::$instances[$name] = (object)array('instance' => $r);
+			static::$instances[$name]->initPending = true;
+		} else {
+			$fullName = $name;
+			if (isset(static::$classAliases[$name])) {
+				$fullName = static::$classAliases[$name];
+			}
+			if (class_exists($fullName)) {
+				$shortName = Util::getShortName($name);
+				$r = new $fullName();
+				static::$instances[$name] = (object)array('instance' => $r);
+				if ($name != 'Restler') {
+					/** @var Restler restler */
+					$r->restler = static::get('Restler');
+					$m = Util::nestedValue($r->restler, 'apiMethodInfo', 'metadata');
+					if ($m) {
+						$properties = Util::nestedValue(
+							$m, 'class', $fullName,
+							CommentParser::$embeddedDataName
+						) ?: (Util::nestedValue(
+							$m, 'class', $shortName,
+							CommentParser::$embeddedDataName
+						) ?: array());
+					} else {
+						static::$instances[$name]->initPending = true;
+					}
+				}
+			}
+		}
+		if (
+			$r instanceof iUseAuthentication &&
+			$r->restler && $r->restler->_authVerified &&
+			!isset(static::$instances[$name]->authVerified)
+		) {
+			static::$instances[$name]->authVerified = true;
+			$r->__setAuthenticationStatus($r->restler->_authenticated);
+		}
+		if (isset(static::$instances[$name]->initPending)) {
+			$m = Util::nestedValue($r->restler, 'apiMethodInfo', 'metadata');
+			$fullName = $name;
+			if (class_exists($name)) {
+				$shortName = Util::getShortName($name);
+			} else {
+				$shortName = $name;
+				if (isset(static::$classAliases[$name])) {
+					$fullName = static::$classAliases[$name];
+				}
+			}
+			if ($m) {
+				$properties = Util::nestedValue(
+					$m, 'class', $fullName,
+					CommentParser::$embeddedDataName
+				) ?: (Util::nestedValue(
+					$m, 'class', $shortName,
+					CommentParser::$embeddedDataName
+				) ?: array());
+				unset(static::$instances[$name]->initPending);
+				$initialized = false;
+			}
+		}
+		if (!$initialized && is_object($r)) {
+			$properties += static::$properties;
+			$objectVars = get_object_vars($r);
+			$className = get_class($r);
+			foreach ($properties as $property => $value) {
+				if (property_exists($className, $property)) {
+					//if not a static property
+					array_key_exists($property, $objectVars)
+						? $r->{$property} = $value
+						: $r::$$property = $value;
+				}
+			}
+		}
+		return $r;
+	}
+
+	/**
+	 * Get fully qualified class name for the given scope
+	 *
+	 * @param string $className
+	 * @param array  $scope local scope
+	 *
+	 * @return string|boolean returns the class name or false
+	 */
+	public static function resolve($className, array $scope)
+	{
+		if (empty($className) || !is_string($className)) {
+			return false;
+		}
+
+		if (self::isPrimitiveDataType($className)) {
+			return false;
+		}
+
+		$divider = '\\';
+		if ($className[0] == $divider) {
+			$qualified = trim($className, $divider);
+		} elseif (array_key_exists($className, $scope)) {
+			$qualified = $scope[$className];
+		} else {
+			$qualified = $scope['*'] . $className;
+		}
+		if (class_exists($qualified)) {
+			return $qualified;
+		}
+		if (isset(static::$classAliases[$className])) {
+			$qualified = static::$classAliases[$className];
+			if (class_exists($qualified)) {
+				return $qualified;
+			}
+		}
+		return false;
+	}
+
+	/**
+	 * @param string $stringName
+	 *
+	 * @return boolean
+	 */
+	private static function isPrimitiveDataType($stringName)
+	{
+		$primitiveDataTypes = array('Array', 'array', 'bool', 'boolean', 'float', 'int', 'integer', 'string');
+		return in_array($stringName, $primitiveDataTypes);
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -80,12 +80,12 @@ 
      */
     public static function register($name, $function, $singleton = true)
     {
-        static::$registry[$name] = (object)compact('function', 'singleton');
+        static::$registry[$name] = (object) compact('function', 'singleton');
     }
 
     public static function set($name, $instance)
     {
-        static::$instances[$name] = (object)array('instance' => $instance);
+        static::$instances[$name] = (object) array('instance' => $instance);
     }
 
     public static function get($name)
@@ -100,7 +100,7 @@ 
             $function = static::$registry[$name]->function;
             $r = $function();
             if (static::$registry[$name]->singleton) {
-                static::$instances[$name] = (object)array('instance' => $r);
+                static::$instances[$name] = (object) array('instance' => $r);
             }
         } elseif (is_callable(static::$resolver) && false === stristr($name, 'Luracast\Restler')) {
             $fullName = $name;
@@ -110,7 +110,7 @@ 
             /** @var Callable $function */
             $function = static::$resolver;
             $r = $function($fullName);
-            static::$instances[$name] = (object)array('instance' => $r);
+            static::$instances[$name] = (object) array('instance' => $r);
             static::$instances[$name]->initPending = true;
         } else {
             $fullName = $name;
@@ -120,7 +120,7 @@ 
             if (class_exists($fullName)) {
                 $shortName = Util::getShortName($name);
                 $r = new $fullName();
-                static::$instances[$name] = (object)array('instance' => $r);
+                static::$instances[$name] = (object) array('instance' => $r);
                 if ($name != 'Restler') {
                     /** @var Restler restler */
                     $r->restler = static::get('Restler');
@@ -210,7 +210,7 @@ 
         } elseif (array_key_exists($className, $scope)) {
             $qualified = $scope[$className];
         } else {
-            $qualified = $scope['*'] . $className;
+            $qualified = $scope['*'].$className;
         }
         if (class_exists($qualified)) {
             return $qualified;

htdocs/includes/restler/framework/Luracast/Restler/RestException.php

Spacing +7 added lines, -7 removed lines

@@ -80,10 +80,10 @@ 
     public function __construct($httpStatusCode, $errorMessage = null, array $details = array(), Exception $previous = null)
     {
         $events = Scope::get('Restler')->getEvents();
-        if(count($events)<= 1){
+        if (count($events) <= 1) {
             $this->stage = 'setup';
         } else {
-            $this->stage = $previous ? $events[count($events)-2] : end($events);
+            $this->stage = $previous ? $events[count($events) - 2] : end($events);
         }
         $this->details = $details;
         parent::__construct($errorMessage, $httpStatusCode, $previous);
@@ -119,8 +119,8 @@ 
         $statusCode = $this->getCode();
         $message = $this->getMessage();
         if (isset(RestException::$codes[$statusCode])) {
-            $message = RestException::$codes[$statusCode] .
-                (empty($message) ? '' : ': ' . $message);
+            $message = RestException::$codes[$statusCode].
+                (empty($message) ? '' : ': '.$message);
         }
         return $message;
     }
@@ -131,9 +131,9 @@ 
         while ($e->getPrevious()) {
             $e = $e->getPrevious();
         }
-        return basename($e->getFile()) . ':'
-        . $e->getLine() . ' at '
-        . $this->getStage() . ' stage';
+        return basename($e->getFile()).':'
+        . $e->getLine().' at '
+        . $this->getStage().' stage';
     }
 }
 

Indentation +110 added lines, -110 removed lines

@@ -19,120 +19,120 @@
 
 class RestException extends Exception
 {
-    /**
-     * HTTP status codes
-     *
-     * @var array
-     */
-    public static $codes = array(
-        100 => 'Continue',
-        101 => 'Switching Protocols',
-        200 => 'OK',
-        201 => 'Created',
-        202 => 'Accepted',
-        203 => 'Non-Authoritative Information',
-        204 => 'No Content',
-        205 => 'Reset Content',
-        206 => 'Partial Content',
-        300 => 'Multiple Choices',
-        301 => 'Moved Permanently',
-        302 => 'Found',
-        303 => 'See Other',
-        304 => 'Not Modified',
-        305 => 'Use Proxy',
-        306 => '(Unused)',
-        307 => 'Temporary Redirect',
-        400 => 'Bad Request',
-        401 => 'Unauthorized',
-        402 => 'Payment Required',
-        403 => 'Forbidden',
-        404 => 'Not Found',
-        405 => 'Method Not Allowed',
-        406 => 'Not Acceptable',
-        407 => 'Proxy Authentication Required',
-        408 => 'Request Timeout',
-        409 => 'Conflict',
-        410 => 'Gone',
-        411 => 'Length Required',
-        412 => 'Precondition Failed',
-        413 => 'Request Entity Too Large',
-        414 => 'Request-URI Too Long',
-        415 => 'Unsupported Media Type',
-        416 => 'Requested Range Not Satisfiable',
-        417 => 'Expectation Failed',
-        429 => 'Too Many Requests', //still in draft but used for rate limiting
-        500 => 'Internal Server Error',
-        501 => 'Not Implemented',
-        502 => 'Bad Gateway',
-        503 => 'Service Unavailable',
-        504 => 'Gateway Timeout',
-        505 => 'HTTP Version Not Supported'
-    );
-    private $details;
-    private $stage;
+	/**
+	 * HTTP status codes
+	 *
+	 * @var array
+	 */
+	public static $codes = array(
+		100 => 'Continue',
+		101 => 'Switching Protocols',
+		200 => 'OK',
+		201 => 'Created',
+		202 => 'Accepted',
+		203 => 'Non-Authoritative Information',
+		204 => 'No Content',
+		205 => 'Reset Content',
+		206 => 'Partial Content',
+		300 => 'Multiple Choices',
+		301 => 'Moved Permanently',
+		302 => 'Found',
+		303 => 'See Other',
+		304 => 'Not Modified',
+		305 => 'Use Proxy',
+		306 => '(Unused)',
+		307 => 'Temporary Redirect',
+		400 => 'Bad Request',
+		401 => 'Unauthorized',
+		402 => 'Payment Required',
+		403 => 'Forbidden',
+		404 => 'Not Found',
+		405 => 'Method Not Allowed',
+		406 => 'Not Acceptable',
+		407 => 'Proxy Authentication Required',
+		408 => 'Request Timeout',
+		409 => 'Conflict',
+		410 => 'Gone',
+		411 => 'Length Required',
+		412 => 'Precondition Failed',
+		413 => 'Request Entity Too Large',
+		414 => 'Request-URI Too Long',
+		415 => 'Unsupported Media Type',
+		416 => 'Requested Range Not Satisfiable',
+		417 => 'Expectation Failed',
+		429 => 'Too Many Requests', //still in draft but used for rate limiting
+		500 => 'Internal Server Error',
+		501 => 'Not Implemented',
+		502 => 'Bad Gateway',
+		503 => 'Service Unavailable',
+		504 => 'Gateway Timeout',
+		505 => 'HTTP Version Not Supported'
+	);
+	private $details;
+	private $stage;
 
-    /**
-     * @param int         $httpStatusCode http status code
-     * @param string|null $errorMessage   error message
-     * @param array       $details        any extra detail about the exception
-     * @param Exception   $previous       previous exception if any
-     */
-    public function __construct($httpStatusCode, $errorMessage = null, array $details = array(), Exception $previous = null)
-    {
-        $events = Scope::get('Restler')->getEvents();
-        if(count($events)<= 1){
-            $this->stage = 'setup';
-        } else {
-            $this->stage = $previous ? $events[count($events)-2] : end($events);
-        }
-        $this->details = $details;
-        parent::__construct($errorMessage, $httpStatusCode, $previous);
-    }
+	/**
+	 * @param int         $httpStatusCode http status code
+	 * @param string|null $errorMessage   error message
+	 * @param array       $details        any extra detail about the exception
+	 * @param Exception   $previous       previous exception if any
+	 */
+	public function __construct($httpStatusCode, $errorMessage = null, array $details = array(), Exception $previous = null)
+	{
+		$events = Scope::get('Restler')->getEvents();
+		if(count($events)<= 1){
+			$this->stage = 'setup';
+		} else {
+			$this->stage = $previous ? $events[count($events)-2] : end($events);
+		}
+		$this->details = $details;
+		parent::__construct($errorMessage, $httpStatusCode, $previous);
+	}
 
-    /**
-     * Get extra details about the exception
-     *
-     * @return array details array
-     */
-    public function getDetails()
-    {
-        return $this->details;
-    }
+	/**
+	 * Get extra details about the exception
+	 *
+	 * @return array details array
+	 */
+	public function getDetails()
+	{
+		return $this->details;
+	}
 
-    public function getStage()
-    {
-        return $this->stage;
-    }
+	public function getStage()
+	{
+		return $this->stage;
+	}
 
-    public function getStages()
-    {
-        $e = Scope::get('Restler')->getEvents();
-        $i = array_search($this->stage, $e);
-        return array(
-            'success' => array_slice($e, 0, $i),
-            'failure' => array_slice($e, $i),
-        );
-    }
+	public function getStages()
+	{
+		$e = Scope::get('Restler')->getEvents();
+		$i = array_search($this->stage, $e);
+		return array(
+			'success' => array_slice($e, 0, $i),
+			'failure' => array_slice($e, $i),
+		);
+	}
 
-    public function getErrorMessage()
-    {
-        $statusCode = $this->getCode();
-        $message = $this->getMessage();
-        if (isset(RestException::$codes[$statusCode])) {
-            $message = RestException::$codes[$statusCode] .
-                (empty($message) ? '' : ': ' . $message);
-        }
-        return $message;
-    }
+	public function getErrorMessage()
+	{
+		$statusCode = $this->getCode();
+		$message = $this->getMessage();
+		if (isset(RestException::$codes[$statusCode])) {
+			$message = RestException::$codes[$statusCode] .
+				(empty($message) ? '' : ': ' . $message);
+		}
+		return $message;
+	}
 
-    public function getSource()
-    {
-        $e = $this;
-        while ($e->getPrevious()) {
-            $e = $e->getPrevious();
-        }
-        return basename($e->getFile()) . ':'
-        . $e->getLine() . ' at '
-        . $this->getStage() . ' stage';
-    }
+	public function getSource()
+	{
+		$e = $this;
+		while ($e->getPrevious()) {
+			$e = $e->getPrevious();
+		}
+		return basename($e->getFile()) . ':'
+		. $e->getLine() . ' at '
+		. $this->getStage() . ' stage';
+	}
 }

htdocs/includes/restler/framework/Luracast/Restler/iUseAuthentication.php

Indentation +13 added lines, -13 removed lines

@@ -15,18 +15,18 @@
  */
 interface iUseAuthentication
 {
-    /**
-     * This method will be called first for filter classes and api classes so
-     * that they can respond accordingly for filer method call and api method
-     * calls
-     *
-     * @abstract
-     *
-     * @param bool $isAuthenticated passes true when the authentication is
-     * done false otherwise
-     *
-     * @return mixed
-     */
-    public function __setAuthenticationStatus($isAuthenticated=false);
+	/**
+	 * This method will be called first for filter classes and api classes so
+	 * that they can respond accordingly for filer method call and api method
+	 * calls
+	 *
+	 * @abstract
+	 *
+	 * @param bool $isAuthenticated passes true when the authentication is
+	 * done false otherwise
+	 *
+	 * @return mixed
+	 */
+	public function __setAuthenticationStatus($isAuthenticated=false);
 }
 

Spacing +1 added lines, -1 removed lines

@@ -27,6 +27,6 @@
      *
      * @return mixed
      */
-    public function __setAuthenticationStatus($isAuthenticated=false);
+    public function __setAuthenticationStatus($isAuthenticated = false);
 }
 

htdocs/includes/restler/framework/Luracast/Restler/MemcacheCache.php

Indentation +109 added lines, -109 removed lines

@@ -14,127 +14,127 @@
  */
 class MemcacheCache implements iCache
 {
-    /**
-     * The namespace that all of the cached entries will be stored under.  This allows multiple APIs to run concurrently.
-     *
-     * @var string
-     */
-    static public $namespace;
+	/**
+	 * The namespace that all of the cached entries will be stored under.  This allows multiple APIs to run concurrently.
+	 *
+	 * @var string
+	 */
+	static public $namespace;
     
-    /**
-     * @var string the memcache server hostname / IP address. For the memcache 
-     * cache method.
-     */
-    static public $memcacheServer = '127.0.0.1';
+	/**
+	 * @var string the memcache server hostname / IP address. For the memcache 
+	 * cache method.
+	 */
+	static public $memcacheServer = '127.0.0.1';
     
-    /**
-     * @var int the memcache server port. For the memcache cache method. 
-     */
-    static public $memcachePort = 11211;
+	/**
+	 * @var int the memcache server port. For the memcache cache method. 
+	 */
+	static public $memcachePort = 11211;
 
     
-    private $memcache;
+	private $memcache;
 
-    /**
-     * @param string $namespace
-     */
-    function __construct($namespace = 'restler')
-    {
-        self::$namespace = $namespace;
-        if (function_exists('memcache_connect')) {
-            $this->memcache = new \Memcache;
-            $this->memcache->connect(self::$memcacheServer, self::$memcachePort);
-        } else {
-            $this->memcacheNotAvailable('Memcache is not available for use as Restler Cache. Please make sure the the memcache php extension is installed.');
-        }
-    }
+	/**
+	 * @param string $namespace
+	 */
+	function __construct($namespace = 'restler')
+	{
+		self::$namespace = $namespace;
+		if (function_exists('memcache_connect')) {
+			$this->memcache = new \Memcache;
+			$this->memcache->connect(self::$memcacheServer, self::$memcachePort);
+		} else {
+			$this->memcacheNotAvailable('Memcache is not available for use as Restler Cache. Please make sure the the memcache php extension is installed.');
+		}
+	}
 
-    /**
-     * store data in the cache
-     *
-     *
-     * @param string $name
-     * @param mixed $data
-     *
-     * @return boolean true if successful
-     */
-    public function set($name, $data)
-    {
-        function_exists('memcache_set') || $this->memcacheNotAvailable();
+	/**
+	 * store data in the cache
+	 *
+	 *
+	 * @param string $name
+	 * @param mixed $data
+	 *
+	 * @return boolean true if successful
+	 */
+	public function set($name, $data)
+	{
+		function_exists('memcache_set') || $this->memcacheNotAvailable();
 
-        try {
-            return $this->memcache->set(self::$namespace . "-" . $name, $data);
-        } catch
-        (\Exception $exception) {
-            return false;
-        }
-    }
+		try {
+			return $this->memcache->set(self::$namespace . "-" . $name, $data);
+		} catch
+		(\Exception $exception) {
+			return false;
+		}
+	}
 
-    private function memcacheNotAvailable($message = 'Memcache is not available.')
-    {
-        throw new \Exception($message);
-    }
+	private function memcacheNotAvailable($message = 'Memcache is not available.')
+	{
+		throw new \Exception($message);
+	}
 
-    /**
-     * retrieve data from the cache
-     *
-     *
-     * @param string $name
-     * @param bool $ignoreErrors
-     *
-     * @throws \Exception
-     * @return mixed
-     */
-    public function get($name, $ignoreErrors = false)
-    {
-        function_exists('memcache_get') || $this->memcacheNotAvailable();
+	/**
+	 * retrieve data from the cache
+	 *
+	 *
+	 * @param string $name
+	 * @param bool $ignoreErrors
+	 *
+	 * @throws \Exception
+	 * @return mixed
+	 */
+	public function get($name, $ignoreErrors = false)
+	{
+		function_exists('memcache_get') || $this->memcacheNotAvailable();
 
-        try {
-            return $this->memcache->get(self::$namespace . "-" . $name);
-        } catch (\Exception $exception) {
-            if (!$ignoreErrors) {
-                throw $exception;
-            }
-            return null;
-        }
-    }
+		try {
+			return $this->memcache->get(self::$namespace . "-" . $name);
+		} catch (\Exception $exception) {
+			if (!$ignoreErrors) {
+				throw $exception;
+			}
+			return null;
+		}
+	}
 
-    /**
-     * delete data from the cache
-     *
-     *
-     * @param string $name
-     * @param bool $ignoreErrors
-     *
-     * @throws \Exception
-     * @return boolean true if successful
-     */
-    public function clear($name, $ignoreErrors = false)
-    {
-        function_exists('memcache_delete') || $this->memcacheNotAvailable();
+	/**
+	 * delete data from the cache
+	 *
+	 *
+	 * @param string $name
+	 * @param bool $ignoreErrors
+	 *
+	 * @throws \Exception
+	 * @return boolean true if successful
+	 */
+	public function clear($name, $ignoreErrors = false)
+	{
+		function_exists('memcache_delete') || $this->memcacheNotAvailable();
 
-        try {
-            $this->memcache->delete(self::$namespace . "-" . $name);
-        } catch (\Exception $exception) {
-            if (!$ignoreErrors) {
-                throw $exception;
-            }
-        }
-    }
+		try {
+			$this->memcache->delete(self::$namespace . "-" . $name);
+		} catch (\Exception $exception) {
+			if (!$ignoreErrors) {
+				throw $exception;
+			}
+		}
+	}
 
-    /**
-     * check if the given name is cached
-     *
-     *
-     * @param string $name
-     *
-     * @return boolean true if cached
-     */
-    public function isCached($name)
-    {
-        function_exists('memcache_get') || $this->memcacheNotAvailable();
-        $data = $this->memcache->get(self::$namespace . "-" . $name);
-        return !empty($data);
-    }
+	/**
+	 * check if the given name is cached
+	 *
+	 *
+	 * @param string $name
+	 *
+	 * @return boolean true if cached
+	 */
+	public function isCached($name)
+	{
+		function_exists('memcache_get') || $this->memcacheNotAvailable();
+		$data = $this->memcache->get(self::$namespace . "-" . $name);
+		return !empty($data);
+	}
 
 }

Spacing +5 added lines, -6 removed lines

@@ -63,9 +63,8 @@ 
         function_exists('memcache_set') || $this->memcacheNotAvailable();
 
         try {
-            return $this->memcache->set(self::$namespace . "-" . $name, $data);
-        } catch
-        (\Exception $exception) {
+            return $this->memcache->set(self::$namespace."-".$name, $data);
+        } catch (\Exception $exception) {
             return false;
         }
     }
@@ -90,7 +89,7 @@ 
         function_exists('memcache_get') || $this->memcacheNotAvailable();
 
         try {
-            return $this->memcache->get(self::$namespace . "-" . $name);
+            return $this->memcache->get(self::$namespace."-".$name);
         } catch (\Exception $exception) {
             if (!$ignoreErrors) {
                 throw $exception;
@@ -114,7 +113,7 @@ 
         function_exists('memcache_delete') || $this->memcacheNotAvailable();
 
         try {
-            $this->memcache->delete(self::$namespace . "-" . $name);
+            $this->memcache->delete(self::$namespace."-".$name);
         } catch (\Exception $exception) {
             if (!$ignoreErrors) {
                 throw $exception;
@@ -133,7 +132,7 @@ 
     public function isCached($name)
     {
         function_exists('memcache_get') || $this->memcacheNotAvailable();
-        $data = $this->memcache->get(self::$namespace . "-" . $name);
+        $data = $this->memcache->get(self::$namespace."-".$name);
         return !empty($data);
     }
 

htdocs/includes/restler/framework/Luracast/Restler/iAuthenticate.php

Indentation +7 added lines, -7 removed lines

@@ -15,11 +15,11 @@
  */
 interface iAuthenticate extends iFilter
 {
-    /**
-     * @return string string to be used with WWW-Authenticate header
-     * @example Basic
-     * @example Digest
-     * @example OAuth
-     */
-    public function __getWWWAuthenticateString();
+	/**
+	 * @return string string to be used with WWW-Authenticate header
+	 * @example Basic
+	 * @example Digest
+	 * @example OAuth
+	 */
+	public function __getWWWAuthenticateString();
 }

htdocs/includes/restler/framework/Luracast/Restler/Restler.php

Indentation +1631 added lines, -1631 removed lines

@@ -55,1635 +55,1635 @@
  */
 class Restler extends EventDispatcher
 {
-    const VERSION = '3.1.0';
-
-    // ==================================================================
-    //
-    // Public variables
-    //
-    // ------------------------------------------------------------------
-    /**
-     * Reference to the last exception thrown
-     * @var RestException
-     */
-    public $exception = null;
-    /**
-     * Used in production mode to store the routes and more
-     *
-     * @var iCache
-     */
-    public $cache;
-    /**
-     * URL of the currently mapped service
-     *
-     * @var string
-     */
-    public $url;
-    /**
-     * Http request method of the current request.
-     * Any value between [GET, PUT, POST, DELETE]
-     *
-     * @var string
-     */
-    public $requestMethod;
-    /**
-     * Requested data format.
-     * Instance of the current format class
-     * which implements the iFormat interface
-     *
-     * @var iFormat
-     * @example jsonFormat, xmlFormat, yamlFormat etc
-     */
-    public $requestFormat;
-    /**
-     * Response data format.
-     *
-     * Instance of the current format class
-     * which implements the iFormat interface
-     *
-     * @var iFormat
-     * @example jsonFormat, xmlFormat, yamlFormat etc
-     */
-    public $responseFormat;
-    /**
-     * Http status code
-     *
-     * @var int|null when specified it will override @status comment
-     */
-    public $responseCode=null;
-    /**
-     * @var string base url of the api service
-     */
-    protected $baseUrl;
-    /**
-     * @var bool Used for waiting till verifying @format
-     *           before throwing content negotiation failed
-     */
-    protected $requestFormatDiffered = false;
-    /**
-     * method information including metadata
-     *
-     * @var ApiMethodInfo
-     */
-    public $apiMethodInfo;
-    /**
-     * @var int for calculating execution time
-     */
-    protected $startTime;
-    /**
-     * When set to false, it will run in debug mode and parse the
-     * class files every time to map it to the URL
-     *
-     * @var boolean
-     */
-    protected $productionMode = false;
-    public $refreshCache = false;
-    /**
-     * Caching of url map is enabled or not
-     *
-     * @var boolean
-     */
-    protected $cached;
-    /**
-     * @var int
-     */
-    protected $apiVersion = 1;
-    /**
-     * @var int
-     */
-    protected $requestedApiVersion = 1;
-    /**
-     * @var int
-     */
-    protected $apiMinimumVersion = 1;
-    /**
-     * @var array
-     */
-    protected $apiVersionMap = array();
-    /**
-     * Associated array that maps formats to their respective format class name
-     *
-     * @var array
-     */
-    protected $formatMap = array();
-    /**
-     * List of the Mime Types that can be produced as a response by this API
-     *
-     * @var array
-     */
-    protected $writableMimeTypes = array();
-    /**
-     * List of the Mime Types that are supported for incoming requests by this API
-     *
-     * @var array
-     */
-    protected $readableMimeTypes = array();
-    /**
-     * Associated array that maps formats to their respective format class name
-     *
-     * @var array
-     */
-    protected $formatOverridesMap = array('extensions' => array());
-    /**
-     * list of filter classes
-     *
-     * @var array
-     */
-    protected $filterClasses = array();
-    /**
-     * instances of filter classes that are executed after authentication
-     *
-     * @var array
-     */
-    protected $postAuthFilterClasses = array();
-
-
-    // ==================================================================
-    //
-    // Protected variables
-    //
-    // ------------------------------------------------------------------
-
-    /**
-     * Data sent to the service
-     *
-     * @var array
-     */
-    protected $requestData = array();
-    /**
-     * list of authentication classes
-     *
-     * @var array
-     */
-    protected $authClasses = array();
-    /**
-     * list of error handling classes
-     *
-     * @var array
-     */
-    protected $errorClasses = array();
-    protected $authenticated = false;
-    protected $authVerified = false;
-    /**
-     * @var mixed
-     */
-    protected $responseData;
-
-    /**
-     * Constructor
-     *
-     * @param boolean $productionMode    When set to false, it will run in
-     *                                   debug mode and parse the class files
-     *                                   every time to map it to the URL
-     *
-     * @param bool    $refreshCache      will update the cache when set to true
-     */
-    public function __construct($productionMode = false, $refreshCache = false)
-    {
-        parent::__construct();
-        $this->startTime = time();
-        Util::$restler = $this;
-        Scope::set('Restler', $this);
-        $this->productionMode = $productionMode;
-        if (is_null(Defaults::$cacheDirectory)) {
-            Defaults::$cacheDirectory = dirname($_SERVER['SCRIPT_FILENAME']) .
-                DIRECTORY_SEPARATOR . 'cache';
-        }
-        $this->cache = new Defaults::$cacheClass();
-        $this->refreshCache = $refreshCache;
-        // use this to rebuild cache every time in production mode
-        if ($productionMode && $refreshCache) {
-            $this->cached = false;
-        }
-    }
-
-    /**
-     * Main function for processing the api request
-     * and return the response
-     *
-     * @throws Exception     when the api service class is missing
-     * @throws RestException to send error response
-     */
-    public function handle()
-    {
-        try {
-            try {
-                try {
-                    $this->get();
-                } catch (Exception $e) {
-                    $this->requestData
-                        = array(Defaults::$fullRequestDataName => array());
-                    if (!$e instanceof RestException) {
-                        $e = new RestException(
-                            500,
-                            $this->productionMode ? null : $e->getMessage(),
-                            array(),
-                            $e
-                        );
-                    }
-                    $this->route();
-                    throw $e;
-                }
-                if (Defaults::$useVendorMIMEVersioning)
-                    $this->responseFormat = $this->negotiateResponseFormat();
-                $this->route();
-            } catch (Exception $e) {
-                $this->negotiate();
-                if (!$e instanceof RestException) {
-                    $e = new RestException(
-                        500,
-                        $this->productionMode ? null : $e->getMessage(),
-                        array(),
-                        $e
-                    );
-                }
-                throw $e;
-            }
-            $this->negotiate();
-            $this->preAuthFilter();
-            $this->authenticate();
-            $this->postAuthFilter();
-            $this->validate();
-            $this->preCall();
-            $this->call();
-            $this->compose();
-            $this->postCall();
-            if (Defaults::$returnResponse) {
-                return $this->respond();
-            }
-            $this->respond();
-        } catch (Exception $e) {
-            try{
-                if (Defaults::$returnResponse) {
-                    return $this->message($e);
-                }
-                $this->message($e);
-            } catch (Exception $e2) {
-                if (Defaults::$returnResponse) {
-                    return $this->message($e2);
-                }
-                $this->message($e2);
-            }
-        }
-    }
-
-    /**
-     * read the request details
-     *
-     * Find out the following
-     *  - baseUrl
-     *  - url requested
-     *  - version requested (if url based versioning)
-     *  - http verb/method
-     *  - negotiate content type
-     *  - request data
-     *  - set defaults
-     */
-    protected function get()
-    {
-        $this->dispatch('get');
-        if (empty($this->formatMap)) {
-            $this->setSupportedFormats('JsonFormat');
-        }
-        $this->url = $this->getPath();
-        $this->requestMethod = Util::getRequestMethod();
-        $this->requestFormat = $this->getRequestFormat();
-        $this->requestData = $this->getRequestData(false);
-
-        //parse defaults
-        foreach ($_GET as $key => $value) {
-            if (isset(Defaults::$aliases[$key])) {
-                $_GET[Defaults::$aliases[$key]] = $value;
-                unset($_GET[$key]);
-                $key = Defaults::$aliases[$key];
-            }
-            if (in_array($key, Defaults::$overridables)) {
-                Defaults::setProperty($key, $value);
-            }
-        }
-    }
-
-    /**
-     * Returns a list of the mime types (e.g.  ["application/json","application/xml"]) that the API can respond with
-     * @return array
-     */
-    public function getWritableMimeTypes()
-    {
-        return $this->writableMimeTypes;
-    }
-
-    /**
-     * Returns the list of Mime Types for the request that the API can understand
-     * @return array
-     */
-    public function getReadableMimeTypes()
-    {
-        return $this->readableMimeTypes;
-    }
-
-    /**
-     * Call this method and pass all the formats that should be  supported by
-     * the API Server. Accepts multiple parameters
-     *
-     * @param string ,... $formatName   class name of the format class that
-     *                                  implements iFormat
-     *
-     * @example $restler->setSupportedFormats('JsonFormat', 'XmlFormat'...);
-     * @throws Exception
-     */
-    public function setSupportedFormats($format = null /*[, $format2...$farmatN]*/)
-    {
-        $args = func_get_args();
-        $extensions = array();
-        $throwException = $this->requestFormatDiffered;
-        $this->writableMimeTypes = $this->readableMimeTypes = array();
-        foreach ($args as $className) {
-
-            $obj = Scope::get($className);
-
-            if (!$obj instanceof iFormat)
-                throw new Exception('Invalid format class; must implement ' .
-                    'iFormat interface');
-            if ($throwException && get_class($obj) == get_class($this->requestFormat)) {
-                $throwException = false;
-            }
-
-            foreach ($obj->getMIMEMap() as $mime => $extension) {
-                if($obj->isWritable()){
-                    $this->writableMimeTypes[]=$mime;
-                    $extensions[".$extension"] = true;
-                }
-                if($obj->isReadable())
-                    $this->readableMimeTypes[]=$mime;
-                if (!isset($this->formatMap[$extension]))
-                    $this->formatMap[$extension] = $className;
-                if (!isset($this->formatMap[$mime]))
-                    $this->formatMap[$mime] = $className;
-            }
-        }
-        if ($throwException) {
-            throw new RestException(
-                403,
-                'Content type `' . $this->requestFormat->getMIME() . '` is not supported.'
-            );
-        }
-        $this->formatMap['default'] = $args[0];
-        $this->formatMap['extensions'] = array_keys($extensions);
-    }
-
-    /**
-     * Call this method and pass all the formats that can be used to override
-     * the supported formats using `@format` comment. Accepts multiple parameters
-     *
-     * @param string ,... $formatName   class name of the format class that
-     *                                  implements iFormat
-     *
-     * @example $restler->setOverridingFormats('JsonFormat', 'XmlFormat'...);
-     * @throws Exception
-     */
-    public function setOverridingFormats($format = null /*[, $format2...$farmatN]*/)
-    {
-        $args = func_get_args();
-        $extensions = array();
-        foreach ($args as $className) {
-
-            $obj = Scope::get($className);
-
-            if (!$obj instanceof iFormat)
-                throw new Exception('Invalid format class; must implement ' .
-                    'iFormat interface');
-
-            foreach ($obj->getMIMEMap() as $mime => $extension) {
-                if (!isset($this->formatOverridesMap[$extension]))
-                    $this->formatOverridesMap[$extension] = $className;
-                if (!isset($this->formatOverridesMap[$mime]))
-                    $this->formatOverridesMap[$mime] = $className;
-                if($obj->isWritable())
-                    $extensions[".$extension"] = true;
-            }
-        }
-        $this->formatOverridesMap['extensions'] = array_keys($extensions);
-    }
-
-    /**
-     * Set one or more string to be considered as the base url
-     *
-     * When more than one base url is provided, restler will make
-     * use of $_SERVER['HTTP_HOST'] to find the right one
-     *
-     * @param string ,... $url
-     */
-    public function setBaseUrls($url /*[, $url2...$urlN]*/)
-    {
-        if (func_num_args() > 1) {
-            $urls = func_get_args();
-            usort($urls, function ($a, $b) {
-                return strlen($a) - strlen($b);
-            });
-            foreach ($urls as $u) {
-                if (0 === strpos($_SERVER['HTTP_HOST'], parse_url($u, PHP_URL_HOST))) {
-                    $this->baseUrl = $u;
-                    return;
-                }
-            }
-        }
-        $this->baseUrl = $url;
-    }
-
-    /**
-     * Parses the request url and get the api path
-     *
-     * @return string api path
-     */
-    protected function getPath()
-    {
-        // fix SCRIPT_NAME for PHP 5.4 built-in web server
-        if (false === strpos($_SERVER['SCRIPT_NAME'], '.php'))
-            $_SERVER['SCRIPT_NAME']
-                = '/' . substr($_SERVER['SCRIPT_FILENAME'], strlen($_SERVER['DOCUMENT_ROOT']) + 1);
-
-        list($base, $path) = Util::splitCommonPath(
-            strtok(urldecode($_SERVER['REQUEST_URI']), '?'), //remove query string
-            $_SERVER['SCRIPT_NAME']
-        );
-
-        if (!$this->baseUrl) {
-            // Fix port number retrieval if port is specified in HOST header.
-            $host = isset($_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : '';
-            $portPos = strpos($host,":");
-            if ($portPos){
-               $port = substr($host,$portPos+1);
-            } else {
-               $port = isset($_SERVER['SERVER_PORT']) ? $_SERVER['SERVER_PORT'] : '80';
-               $port = isset($_SERVER['HTTP_X_FORWARDED_PORT']) ? $_SERVER['HTTP_X_FORWARDED_PORT'] : $port; // Amazon ELB
-            }
-            $https = $port == '443' ||
-                (isset($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https') || // Amazon ELB
-                (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on');
-            $baseUrl = ($https ? 'https://' : 'http://') . $_SERVER['SERVER_NAME'];
-            if (!$https && $port != '80' || $https && $port != '443')
-                $baseUrl .= ':' . $port;
-            $this->baseUrl = $baseUrl . $base;
-        } elseif (!empty($base) && false === strpos($this->baseUrl, $base)) {
-            $this->baseUrl .= $base;
-        }
-
-        $path = str_replace(
-            array_merge(
-                $this->formatMap['extensions'],
-                $this->formatOverridesMap['extensions']
-            ),
-            '',
-            rtrim($path, '/') //remove trailing slash if found
-        );
-
-        if (Defaults::$useUrlBasedVersioning && strlen($path) && $path[0] == 'v') {
-            $version = intval(substr($path, 1));
-            if ($version && $version <= $this->apiVersion) {
-                $this->requestedApiVersion = $version;
-                $path = explode('/', $path, 2);
-                $path = count($path) == 2 ? $path[1] : '';
-            }
-        } else {
-            $this->requestedApiVersion = $this->apiMinimumVersion;
-        }
-        return $path;
-    }
-
-    /**
-     * Parses the request to figure out format of the request data
-     *
-     * @throws RestException
-     * @return iFormat any class that implements iFormat
-     * @example JsonFormat
-     */
-    protected function getRequestFormat()
-    {
-        $format = null ;
-        // check if client has sent any information on request format
-        if (
-            !empty($_SERVER['CONTENT_TYPE']) ||
-            (
-                !empty($_SERVER['HTTP_CONTENT_TYPE']) &&
-                $_SERVER['CONTENT_TYPE'] = $_SERVER['HTTP_CONTENT_TYPE']
-            )
-        ) {
-            $mime = $_SERVER['CONTENT_TYPE'];
-            if (false !== $pos = strpos($mime, ';')) {
-                $mime = substr($mime, 0, $pos);
-            }
-            if ($mime == UrlEncodedFormat::MIME)
-                $format = Scope::get('UrlEncodedFormat');
-            elseif (isset($this->formatMap[$mime])) {
-                $format = Scope::get($this->formatMap[$mime]);
-                $format->setMIME($mime);
-            } elseif (!$this->requestFormatDiffered && isset($this->formatOverridesMap[$mime])) {
-                //if our api method is not using an @format comment
-                //to point to this $mime, we need to throw 403 as in below
-                //but since we don't know that yet, we need to defer that here
-                $format = Scope::get($this->formatOverridesMap[$mime]);
-                $format->setMIME($mime);
-                $this->requestFormatDiffered = true;
-            } else {
-                throw new RestException(
-                    403,
-                    "Content type `$mime` is not supported."
-                );
-            }
-        }
-        if(!$format){
-            $format = Scope::get($this->formatMap['default']);
-        }
-        return $format;
-    }
-
-    public function getRequestStream()
-    {
-        static $tempStream = false;
-        if (!$tempStream) {
-            $tempStream = fopen('php://temp', 'r+');
-            $rawInput = fopen('php://input', 'r');
-            stream_copy_to_stream($rawInput, $tempStream);
-        }
-        rewind($tempStream);
-        return $tempStream;
-    }
-
-    /**
-     * Parses the request data and returns it
-     *
-     * @param bool $includeQueryParameters
-     *
-     * @return array php data
-     */
-    public function getRequestData($includeQueryParameters = true)
-    {
-        $get = UrlEncodedFormat::decoderTypeFix($_GET);
-        if ($this->requestMethod == 'PUT'
-            || $this->requestMethod == 'PATCH'
-            || $this->requestMethod == 'POST'
-        ) {
-            if (!empty($this->requestData)) {
-                return $includeQueryParameters
-                    ? $this->requestData + $get
-                    : $this->requestData;
-            }
-
-            $stream = $this->getRequestStream();
-            if($stream === FALSE)
-                return array();
-            $r = $this->requestFormat instanceof iDecodeStream
-                ? $this->requestFormat->decodeStream($stream)
-                : $this->requestFormat->decode(stream_get_contents($stream));
-
-            $r = is_array($r)
-                ? array_merge($r, array(Defaults::$fullRequestDataName => $r))
-                : array(Defaults::$fullRequestDataName => $r);
-            return $includeQueryParameters
-                ? $r + $get
-                : $r;
-        }
-        return $includeQueryParameters ? $get : array(); //no body
-    }
-
-    /**
-     * Find the api method to execute for the requested Url
-     */
-    protected function route()
-    {
-        $this->dispatch('route');
-
-        $params = $this->getRequestData();
-
-        //backward compatibility for restler 2 and below
-        if (!Defaults::$smartParameterParsing) {
-            $params = $params + array(Defaults::$fullRequestDataName => $params);
-        }
-
-        $this->apiMethodInfo = $o = Routes::find(
-            $this->url, $this->requestMethod,
-            $this->requestedApiVersion, $params
-        );
-        //set defaults based on api method comments
-        if (isset($o->metadata)) {
-            foreach (Defaults::$fromComments as $key => $defaultsKey) {
-                if (array_key_exists($key, $o->metadata)) {
-                    $value = $o->metadata[$key];
-                    Defaults::setProperty($defaultsKey, $value);
-                }
-            }
-        }
-        if (!isset($o->className))
-            throw new RestException(404);
-
-        if(isset($this->apiVersionMap[$o->className])){
-            Scope::$classAliases[Util::getShortName($o->className)]
-                = $this->apiVersionMap[$o->className][$this->requestedApiVersion];
-        }
-
-        foreach ($this->authClasses as $auth) {
-            if (isset($this->apiVersionMap[$auth])) {
-                Scope::$classAliases[$auth] = $this->apiVersionMap[$auth][$this->requestedApiVersion];
-            } elseif (isset($this->apiVersionMap[Scope::$classAliases[$auth]])) {
-                Scope::$classAliases[$auth]
-                    = $this->apiVersionMap[Scope::$classAliases[$auth]][$this->requestedApiVersion];
-            }
-        }
-    }
-
-    /**
-     * Negotiate the response details such as
-     *  - cross origin resource sharing
-     *  - media type
-     *  - charset
-     *  - language
-     *
-     * @throws RestException
-     */
-    protected function negotiate()
-    {
-        $this->dispatch('negotiate');
-        $this->negotiateCORS();
-        $this->responseFormat = $this->negotiateResponseFormat();
-        $this->negotiateCharset();
-        $this->negotiateLanguage();
-    }
-
-    protected function negotiateCORS()
-    {
-        if (
-            $this->requestMethod == 'OPTIONS'
-            && Defaults::$crossOriginResourceSharing
-        ) {
-            if (isset($_SERVER['HTTP_ACCESS_CONTROL_REQUEST_METHOD']))
-                header('Access-Control-Allow-Methods: '
-                    . Defaults::$accessControlAllowMethods);
-
-            if (isset($_SERVER['HTTP_ACCESS_CONTROL_REQUEST_HEADERS']))
-                header('Access-Control-Allow-Headers: '
-                    . $_SERVER['HTTP_ACCESS_CONTROL_REQUEST_HEADERS']);
-
-            header('Access-Control-Allow-Origin: ' .
-                ((Defaults::$accessControlAllowOrigin == '*' && isset($_SERVER['HTTP_ORIGIN']))
-                    ? $_SERVER['HTTP_ORIGIN'] : Defaults::$accessControlAllowOrigin));
-            header('Access-Control-Allow-Credentials: true');
-
-            exit(0);
-        }
-    }
-
-    // ==================================================================
-    //
-    // Protected functions
-    //
-    // ------------------------------------------------------------------
-
-    /**
-     * Parses the request to figure out the best format for response.
-     * Extension, if present, overrides the Accept header
-     *
-     * @throws RestException
-     * @return iFormat
-     * @example JsonFormat
-     */
-    protected function negotiateResponseFormat()
-    {
-        $metadata = Util::nestedValue($this, 'apiMethodInfo', 'metadata');
-        //check if the api method insists on response format using @format comment
-
-        if ($metadata && isset($metadata['format'])) {
-            $formats = explode(',', (string)$metadata['format']);
-            foreach ($formats as $i => $f) {
-                $f = trim($f);
-                if (!in_array($f, $this->formatOverridesMap))
-                    throw new RestException(
-                        500,
-                        "Given @format is not present in overriding formats. Please call `\$r->setOverridingFormats('$f');` first."
-                    );
-                $formats[$i] = $f;
-            }
-            call_user_func_array(array($this, 'setSupportedFormats'), $formats);
-        }
-
-        // check if client has specified an extension
-        /** @var $format iFormat*/
-        $format = null;
-        $extensions = explode(
-            '.',
-            parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH)
-        );
-        while ($extensions) {
-            $extension = array_pop($extensions);
-            $extension = explode('/', $extension);
-            $extension = array_shift($extension);
-            if ($extension && isset($this->formatMap[$extension])) {
-                $format = Scope::get($this->formatMap[$extension]);
-                $format->setExtension($extension);
-                // echo "Extension $extension";
-                return $format;
-            }
-        }
-        // check if client has sent list of accepted data formats
-        if (isset($_SERVER['HTTP_ACCEPT'])) {
-            $acceptList = Util::sortByPriority($_SERVER['HTTP_ACCEPT']);
-            foreach ($acceptList as $accept => $quality) {
-                if (isset($this->formatMap[$accept])) {
-                    $format = Scope::get($this->formatMap[$accept]);
-                    $format->setMIME($accept);
-                    //echo "MIME $accept";
-                    // Tell cache content is based on Accept header
-                    @header('Vary: Accept');
-
-                    return $format;
-                } elseif (false !== ($index = strrpos($accept, '+'))) {
-                    $mime = substr($accept, 0, $index);
-                    if (is_string(Defaults::$apiVendor)
-                        && 0 === stripos($mime,
-                            'application/vnd.'
-                            . Defaults::$apiVendor . '-v')
-                    ) {
-                        $extension = substr($accept, $index + 1);
-                        if (isset($this->formatMap[$extension])) {
-                            //check the MIME and extract version
-                            $version = intval(substr($mime,
-                                18 + strlen(Defaults::$apiVendor)));
-                            if ($version > 0 && $version <= $this->apiVersion) {
-                                $this->requestedApiVersion = $version;
-                                $format = Scope::get($this->formatMap[$extension]);
-                                $format->setExtension($extension);
-                                // echo "Extension $extension";
-                                Defaults::$useVendorMIMEVersioning = true;
-                                @header('Vary: Accept');
-
-                                return $format;
-                            }
-                        }
-                    }
-
-                }
-            }
-        } else {
-            // RFC 2616: If no Accept header field is
-            // present, then it is assumed that the
-            // client accepts all media types.
-            $_SERVER['HTTP_ACCEPT'] = '*/*';
-        }
-        if (strpos($_SERVER['HTTP_ACCEPT'], '*') !== false) {
-            if (false !== strpos($_SERVER['HTTP_ACCEPT'], 'application/*')) {
-                $format = Scope::get('JsonFormat');
-            } elseif (false !== strpos($_SERVER['HTTP_ACCEPT'], 'text/*')) {
-                $format = Scope::get('XmlFormat');
-            } elseif (false !== strpos($_SERVER['HTTP_ACCEPT'], '*/*')) {
-                $format = Scope::get($this->formatMap['default']);
-            }
-        }
-        if (empty($format)) {
-            // RFC 2616: If an Accept header field is present, and if the
-            // server cannot send a response which is acceptable according to
-            // the combined Accept field value, then the server SHOULD send
-            // a 406 (not acceptable) response.
-            $format = Scope::get($this->formatMap['default']);
-            $this->responseFormat = $format;
-            throw new RestException(
-                406,
-                'Content negotiation failed. ' .
-                'Try `' . $format->getMIME() . '` instead.'
-            );
-        } else {
-            // Tell cache content is based at Accept header
-            @header("Vary: Accept");
-            return $format;
-        }
-    }
-
-    protected function negotiateCharset()
-    {
-        if (isset($_SERVER['HTTP_ACCEPT_CHARSET'])) {
-            $found = false;
-            $charList = Util::sortByPriority($_SERVER['HTTP_ACCEPT_CHARSET']);
-            foreach ($charList as $charset => $quality) {
-                if (in_array($charset, Defaults::$supportedCharsets)) {
-                    $found = true;
-                    Defaults::$charset = $charset;
-                    break;
-                }
-            }
-            if (!$found) {
-                if (strpos($_SERVER['HTTP_ACCEPT_CHARSET'], '*') !== false) {
-                    //use default charset
-                } else {
-                    throw new RestException(
-                        406,
-                        'Content negotiation failed. ' .
-                        'Requested charset is not supported'
-                    );
-                }
-            }
-        }
-    }
-
-    protected function negotiateLanguage()
-    {
-        if (isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
-            $found = false;
-            $langList = Util::sortByPriority($_SERVER['HTTP_ACCEPT_LANGUAGE']);
-            foreach ($langList as $lang => $quality) {
-                foreach (Defaults::$supportedLanguages as $supported) {
-                    if (strcasecmp($supported, $lang) == 0) {
-                        $found = true;
-                        Defaults::$language = $supported;
-                        break 2;
-                    }
-                }
-            }
-            if (!$found) {
-                if (strpos($_SERVER['HTTP_ACCEPT_LANGUAGE'], '*') !== false) {
-                    //use default language
-                } else {
-                    //ignore
-                }
-            }
-        }
-    }
-
-    /**
-     * Filer api calls before authentication
-     */
-    protected function preAuthFilter()
-    {
-        if (empty($this->filterClasses)) {
-            return;
-        }
-        $this->dispatch('preAuthFilter');
-        foreach ($this->filterClasses as $filterClass) {
-            /**
-             * @var iFilter
-             */
-            $filterObj = Scope::get($filterClass);
-
-            if (!$filterObj instanceof iFilter) {
-                throw new RestException (
-                    500, 'Filter Class ' .
-                    'should implement iFilter');
-            } else if (!($ok = $filterObj->__isAllowed())) {
-                if (is_null($ok)
-                    && $filterObj instanceof iUseAuthentication
-                ) {
-                    //handle at authentication stage
-                    $this->postAuthFilterClasses[] = $filterClass;
-                    continue;
-                }
-                throw new RestException(403); //Forbidden
-            }
-        }
-    }
-
-    protected function authenticate()
-    {
-        $o = &$this->apiMethodInfo;
-        $accessLevel = max(Defaults::$apiAccessLevel, $o->accessLevel);
-        if ($accessLevel || count($this->postAuthFilterClasses)) {
-            $this->dispatch('authenticate');
-            if (!count($this->authClasses) && $accessLevel > 1) {
-                throw new RestException(
-                    403,
-                    'at least one Authentication Class is required'
-                );
-            }
-            $unauthorized = false;
-            foreach ($this->authClasses as $authClass) {
-                try {
-                    $authObj = Scope::get($authClass);
-                    if (!method_exists($authObj, Defaults::$authenticationMethod)) {
-                        throw new RestException (
-                            500, 'Authentication Class ' .
-                            'should implement iAuthenticate');
-                    } elseif (
-                    !$authObj->{Defaults::$authenticationMethod}()
-                    ) {
-                        throw new RestException(401);
-                    }
-                    $unauthorized = false;
-                    break;
-                } catch (InvalidAuthCredentials $e) {
-                    $this->authenticated = false;
-                    throw $e;
-                } catch (RestException $e) {
-                    if (!$unauthorized) {
-                        $unauthorized = $e;
-                    }
-                }
-            }
-            $this->authVerified = true;
-            if ($unauthorized) {
-                if ($accessLevel > 1) { //when it is not a hybrid api
-                    throw $unauthorized;
-                } else {
-                    $this->authenticated = false;
-                }
-            } else {
-                $this->authenticated = true;
-            }
-        }
-    }
-
-    /**
-     * Filer api calls after authentication
-     */
-    protected function postAuthFilter()
-    {
-        if(empty($this->postAuthFilterClasses)) {
-            return;
-        }
-        $this->dispatch('postAuthFilter');
-        foreach ($this->postAuthFilterClasses as $filterClass) {
-            Scope::get($filterClass);
-        }
-    }
-
-    protected function validate()
-    {
-        if (!Defaults::$autoValidationEnabled) {
-            return;
-        }
-        $this->dispatch('validate');
-
-        $o = & $this->apiMethodInfo;
-        foreach ($o->metadata['param'] as $index => $param) {
-            $info = & $param [CommentParser::$embeddedDataName];
-            if (!isset ($info['validate'])
-                || $info['validate'] != false
-            ) {
-                if (isset($info['method'])) {
-                    $info ['apiClassInstance'] = Scope::get($o->className);
-                }
-                //convert to instance of ValidationInfo
-                $info = new ValidationInfo($param);
-                //initialize validator
-                Scope::get(Defaults::$validatorClass);
-                $validator = Defaults::$validatorClass;
-                //if(!is_subclass_of($validator, 'Luracast\\Restler\\Data\\iValidate')) {
-                //changed the above test to below for addressing this php bug
-                //https://bugs.php.net/bug.php?id=53727
-                if (function_exists("$validator::validate")) {
-                    throw new \UnexpectedValueException(
-                        '`Defaults::$validatorClass` must implement `iValidate` interface'
-                    );
-                }
-                $valid = $o->parameters[$index];
-                $o->parameters[$index] = null;
-                if (empty(Validator::$exceptions))
-                    $o->metadata['param'][$index]['autofocus'] = true;
-                $valid = $validator::validate(
-                    $valid, $info
-                );
-                $o->parameters[$index] = $valid;
-                unset($o->metadata['param'][$index]['autofocus']);
-            }
-        }
-    }
-
-    protected function call()
-    {
-        $this->dispatch('call');
-        $o = & $this->apiMethodInfo;
-        $accessLevel = max(Defaults::$apiAccessLevel,
-            $o->accessLevel);
-        if (function_exists('newrelic_name_transaction'))
-            newrelic_name_transaction("{$o->className}/{$o->methodName}");
-        $object =  Scope::get($o->className);
-        switch ($accessLevel) {
-            case 3 : //protected method
-                $reflectionMethod = new \ReflectionMethod(
-                    $object,
-                    $o->methodName
-                );
-                $reflectionMethod->setAccessible(true);
-                $result = $reflectionMethod->invokeArgs(
-                    $object,
-                    $o->parameters
-                );
-                break;
-            default :
-                $result = call_user_func_array(array(
-                    $object,
-                    $o->methodName
-                ), $o->parameters);
-        }
-        $this->responseData = $result;
-    }
-
-    protected function compose()
-    {
-        $this->dispatch('compose');
-        $this->composeHeaders();
-        /**
-         * @var iCompose Default Composer
-         */
-        $compose = Scope::get(Defaults::$composeClass);
-        $this->responseData = is_null($this->responseData) &&
-        Defaults::$emptyBodyForNullResponse
-            ? ''
-            : $this->responseFormat->encode(
-                $compose->response($this->responseData),
-                !$this->productionMode
-            );
-    }
-
-    public function composeHeaders(RestException $e = null)
-    {
-        //only GET method should be cached if allowed by API developer
-        $expires = $this->requestMethod == 'GET' ? Defaults::$headerExpires : 0;
-        if(!is_array(Defaults::$headerCacheControl))
-            Defaults::$headerCacheControl = array(Defaults::$headerCacheControl);
-        $cacheControl = Defaults::$headerCacheControl[0];
-        if ($expires > 0) {
-            $cacheControl = $this->apiMethodInfo->accessLevel
-                ? 'private, ' : 'public, ';
-            $cacheControl .= end(Defaults::$headerCacheControl);
-            $cacheControl = str_replace('{expires}', $expires, $cacheControl);
-            $expires = gmdate('D, d M Y H:i:s \G\M\T', time() + $expires);
-        }
-        @header('Cache-Control: ' . $cacheControl);
-        @header('Expires: ' . $expires);
-        @header('X-Powered-By: Luracast Restler v' . Restler::VERSION);
-
-        if (Defaults::$crossOriginResourceSharing
-            && isset($_SERVER['HTTP_ORIGIN'])
-        ) {
-            header('Access-Control-Allow-Origin: ' .
-                (Defaults::$accessControlAllowOrigin == '*'
-                    ? $_SERVER['HTTP_ORIGIN']
-                    : Defaults::$accessControlAllowOrigin)
-            );
-            header('Access-Control-Allow-Credentials: true');
-            header('Access-Control-Max-Age: 86400');
-        }
-
-        $this->responseFormat->setCharset(Defaults::$charset);
-        $charset = $this->responseFormat->getCharset()
-            ? : Defaults::$charset;
-
-        @header('Content-Type: ' . (
-            Defaults::$useVendorMIMEVersioning
-                ? 'application/vnd.'
-                . Defaults::$apiVendor
-                . "-v{$this->requestedApiVersion}"
-                . '+' . $this->responseFormat->getExtension()
-                : $this->responseFormat->getMIME())
-            . '; charset=' . $charset
-        );
-
-        @header('Content-Language: ' . Defaults::$language);
-
-        if (isset($this->apiMethodInfo->metadata['header'])) {
-            foreach ($this->apiMethodInfo->metadata['header'] as $header)
-                @header($header, true);
-        }
-        $code = 200;
-        if (!Defaults::$suppressResponseCode) {
-            if ($e) {
-                $code = $e->getCode();
-            } elseif ($this->responseCode) {
-                $code = $this->responseCode;
-            } elseif (isset($this->apiMethodInfo->metadata['status'])) {
-                $code = $this->apiMethodInfo->metadata['status'];
-            }
-        }
-        $this->responseCode = $code;
-        @header(
-            "{$_SERVER['SERVER_PROTOCOL']} $code " .
-            (isset(RestException::$codes[$code]) ? RestException::$codes[$code] : '')
-        );
-    }
-
-    protected function respond()
-    {
-        $this->dispatch('respond');
-        //handle throttling
-        if (Defaults::$throttle) {
-            $elapsed = time() - $this->startTime;
-            if (Defaults::$throttle / 1e3 > $elapsed) {
-                usleep(1e6 * (Defaults::$throttle / 1e3 - $elapsed));
-            }
-        }
-        if ($this->responseCode == 401) {
-            $authString = count($this->authClasses)
-                ? Scope::get($this->authClasses[0])->__getWWWAuthenticateString()
-                : 'Unknown';
-            @header('WWW-Authenticate: ' . $authString, false);
-        }
-        $this->dispatch('complete');
-        if (Defaults::$returnResponse) {
-            return $this->responseData;
-        } else {
-            echo $this->responseData;
-            exit;
-        }
-    }
-
-    protected function message(Exception $exception)
-    {
-        $this->dispatch('message');
-
-        if (!$exception instanceof RestException) {
-            $exception = new RestException(
-                500,
-                $this->productionMode ? null : $exception->getMessage(),
-                array(),
-                $exception
-            );
-        }
-
-        $this->exception = $exception;
-
-        $method = 'handle' . $exception->getCode();
-        $handled = false;
-        foreach ($this->errorClasses as $className) {
-            if (method_exists($className, $method)) {
-                $obj = Scope::get($className);
-                if ($obj->$method($exception))
-                    $handled = true;
-            }
-        }
-        if ($handled) {
-            return;
-        }
-        if (!isset($this->responseFormat)) {
-            $this->responseFormat = Scope::get('JsonFormat');
-        }
-        $this->composeHeaders($exception);
-        /**
-         * @var iCompose Default Composer
-         */
-        $compose = Scope::get(Defaults::$composeClass);
-        $this->responseData = $this->responseFormat->encode(
-            $compose->message($exception),
-            !$this->productionMode
-        );
-        if (Defaults::$returnResponse) {
-            return $this->respond();
-        }
-        $this->respond();
-    }
-
-    /**
-     * Provides backward compatibility with older versions of Restler
-     *
-     * @param int $version restler version
-     *
-     * @throws \OutOfRangeException
-     */
-    public function setCompatibilityMode($version = 2)
-    {
-        if ($version <= intval(self::VERSION) && $version > 0) {
-            require __DIR__."/compatibility/restler{$version}.php";
-            return;
-        }
-        throw new \OutOfRangeException();
-    }
-
-    /**
-     * @param int $version                 maximum version number supported
-     *                                     by  the api
-     * @param int $minimum                 minimum version number supported
-     * (optional)
-     *
-     * @throws InvalidArgumentException
-     * @return void
-     */
-    public function setAPIVersion($version = 1, $minimum = 1)
-    {
-        if (!is_int($version) && $version < 1) {
-            throw new InvalidArgumentException
-            ('version should be an integer greater than 0');
-        }
-        $this->apiVersion = $version;
-        if (is_int($minimum)) {
-            $this->apiMinimumVersion = $minimum;
-        }
-    }
-
-    /**
-     * Classes implementing iFilter interface can be added for filtering out
-     * the api consumers.
-     *
-     * It can be used for rate limiting based on usage from a specific ip
-     * address or filter by country, device etc.
-     *
-     * @param $className
-     */
-    public function addFilterClass($className)
-    {
-        $this->filterClasses[] = $className;
-    }
-
-    /**
-     * protected methods will need at least one authentication class to be set
-     * in order to allow that method to be executed
-     *
-     * @param string $className     of the authentication class
-     * @param string $resourcePath  optional url prefix for mapping
-     */
-    public function addAuthenticationClass($className, $resourcePath = null)
-    {
-        $this->authClasses[] = $className;
-        $this->addAPIClass($className, $resourcePath);
-    }
-
-    /**
-     * Add api classes through this method.
-     *
-     * All the public methods that do not start with _ (underscore)
-     * will be will be exposed as the public api by default.
-     *
-     * All the protected methods that do not start with _ (underscore)
-     * will exposed as protected api which will require authentication
-     *
-     * @param string $className       name of the service class
-     * @param string $resourcePath    optional url prefix for mapping, uses
-     *                                lowercase version of the class name when
-     *                                not specified
-     *
-     * @return null
-     *
-     * @throws Exception when supplied with invalid class name
-     */
-    public function addAPIClass($className, $resourcePath = null)
-    {
-        try{
-            if ($this->productionMode && is_null($this->cached)) {
-                $routes = $this->cache->get('routes');
-                if (isset($routes) && is_array($routes)) {
-                    $this->apiVersionMap = $routes['apiVersionMap'];
-                    unset($routes['apiVersionMap']);
-                    Routes::fromArray($routes);
-                    $this->cached = true;
-                } else {
-                    $this->cached = false;
-                }
-            }
-            if (isset(Scope::$classAliases[$className])) {
-                $className = Scope::$classAliases[$className];
-            }
-            if (!$this->cached) {
-                $maxVersionMethod = '__getMaximumSupportedVersion';
-                if (class_exists($className)) {
-                    if (method_exists($className, $maxVersionMethod)) {
-                        $max = $className::$maxVersionMethod();
-                        for ($i = 1; $i <= $max; $i++) {
-                            $this->apiVersionMap[$className][$i] = $className;
-                        }
-                    } else {
-                        $this->apiVersionMap[$className][1] = $className;
-                    }
-                }
-                //versioned api
-                if (false !== ($index = strrpos($className, '\\'))) {
-                    $name = substr($className, 0, $index)
-                        . '\\v{$version}' . substr($className, $index);
-                } else if (false !== ($index = strrpos($className, '_'))) {
-                    $name = substr($className, 0, $index)
-                        . '_v{$version}' . substr($className, $index);
-                } else {
-                    $name = 'v{$version}\\' . $className;
-                }
-
-                for ($version = $this->apiMinimumVersion;
-                     $version <= $this->apiVersion;
-                     $version++) {
-
-                    $versionedClassName = str_replace('{$version}', $version,
-                        $name);
-                    if (class_exists($versionedClassName)) {
-                        Routes::addAPIClass($versionedClassName,
-                            Util::getResourcePath(
-                                $className,
-                                $resourcePath
-                            ),
-                            $version
-                        );
-                        if (method_exists($versionedClassName, $maxVersionMethod)) {
-                            $max = $versionedClassName::$maxVersionMethod();
-                            for ($i = $version; $i <= $max; $i++) {
-                                $this->apiVersionMap[$className][$i] = $versionedClassName;
-                            }
-                        } else {
-                            $this->apiVersionMap[$className][$version] = $versionedClassName;
-                        }
-                    } elseif (isset($this->apiVersionMap[$className][$version])) {
-                        Routes::addAPIClass($this->apiVersionMap[$className][$version],
-                            Util::getResourcePath(
-                                $className,
-                                $resourcePath
-                            ),
-                            $version
-                        );
-                    }
-                }
-
-            }
-        } catch (Exception $e) {
-            $e = new Exception(
-                "addAPIClass('$className') failed. ".$e->getMessage(),
-                $e->getCode(),
-                $e
-            );
-            $this->setSupportedFormats('JsonFormat');
-            $this->message($e);
-        }
-    }
-
-    /**
-     * Add class for custom error handling
-     *
-     * @param string $className   of the error handling class
-     */
-    public function addErrorClass($className)
-    {
-        $this->errorClasses[] = $className;
-    }
-
-    /**
-     * protected methods will need at least one authentication class to be set
-     * in order to allow that method to be executed.  When multiple authentication
-     * classes are in use, this function provides better performance by setting
-     * all auth classes through a single function call.
-     *
-     * @param array $classNames     array of associative arrays containing
-     *                              the authentication class name & optional
-     *                              url prefix for mapping.
-     */
-    public function setAuthClasses(array $classNames)
-    {
-        $this->authClasses = array_merge($this->authClasses, array_values($classNames));
-    }
-
-    /**
-     * Add multiple api classes through this method.
-     *
-     * This method provides better performance when large number
-     * of API classes are in use as it processes them all at once,
-     * as opposed to hundreds (or more) addAPIClass calls.
-     *
-     *
-     * All the public methods that do not start with _ (underscore)
-     * will be will be exposed as the public api by default.
-     *
-     * All the protected methods that do not start with _ (underscore)
-     * will exposed as protected api which will require authentication
-     *
-     * @param array $map        array of associative arrays containing
-     *                          the class name & optional url prefix
-     *                          for mapping.
-     *
-     * @return null
-     *
-     * @throws Exception when supplied with invalid class name
-     */
-    public function mapAPIClasses(array $map)
-    {
-        try {
-            if ($this->productionMode && is_null($this->cached)) {
-                $routes = $this->cache->get('routes');
-                if (isset($routes) && is_array($routes)) {
-                    $this->apiVersionMap = $routes['apiVersionMap'];
-                    unset($routes['apiVersionMap']);
-                    Routes::fromArray($routes);
-                    $this->cached = true;
-                } else {
-                    $this->cached = false;
-                }
-            }
-            $maxVersionMethod = '__getMaximumSupportedVersion';
-            if (!$this->productionMode || !$this->cached) {
-                foreach ($map as $className => $resourcePath) {
-                    if (is_numeric($className)) {
-                        $className = $resourcePath;
-                        $resourcePath = null;
-                    }
-                    if (isset(Scope::$classAliases[$className])) {
-                        $className = Scope::$classAliases[$className];
-                    }
-                    if (class_exists($className)) {
-                        if (method_exists($className, $maxVersionMethod)) {
-                            $max = $className::$maxVersionMethod();
-                            for ($i = 1; $i <= $max; $i++) {
-                                $this->apiVersionMap[$className][$i] = $className;
-                            }
-                        } else {
-                            $this->apiVersionMap[$className][1] = $className;
-                        }
-                    }
-                    //versioned api
-                    if (false !== ($index = strrpos($className, '\\'))) {
-                        $name = substr($className, 0, $index)
-                            . '\\v{$version}' . substr($className, $index);
-                    } else {
-                        if (false !== ($index = strrpos($className, '_'))) {
-                            $name = substr($className, 0, $index)
-                                . '_v{$version}' . substr($className, $index);
-                        } else {
-                            $name = 'v{$version}\\' . $className;
-                        }
-                    }
-
-                    for ($version = $this->apiMinimumVersion;
-                         $version <= $this->apiVersion;
-                         $version++) {
-
-                        $versionedClassName = str_replace('{$version}', $version,
-                            $name);
-                        if (class_exists($versionedClassName)) {
-                            Routes::addAPIClass($versionedClassName,
-                                Util::getResourcePath(
-                                    $className,
-                                    $resourcePath
-                                ),
-                                $version
-                            );
-                            if (method_exists($versionedClassName, $maxVersionMethod)) {
-                                $max = $versionedClassName::$maxVersionMethod();
-                                for ($i = $version; $i <= $max; $i++) {
-                                    $this->apiVersionMap[$className][$i] = $versionedClassName;
-                                }
-                            } else {
-                                $this->apiVersionMap[$className][$version] = $versionedClassName;
-                            }
-                        } elseif (isset($this->apiVersionMap[$className][$version])) {
-                            Routes::addAPIClass($this->apiVersionMap[$className][$version],
-                                Util::getResourcePath(
-                                    $className,
-                                    $resourcePath
-                                ),
-                                $version
-                            );
-                        }
-                    }
-                }
-            }
-        } catch (Exception $e) {
-            $e = new Exception(
-                "mapAPIClasses failed. " . $e->getMessage(),
-                $e->getCode(),
-                $e
-            );
-            $this->setSupportedFormats('JsonFormat');
-            $this->message($e);
-        }
-    }
-
-    /**
-     * Associated array that maps formats to their respective format class name
-     *
-     * @return array
-     */
-    public function getFormatMap()
-    {
-        return $this->formatMap;
-    }
-
-    /**
-     * API version requested by the client
-     * @return int
-     */
-    public function getRequestedApiVersion()
-    {
-        return $this->requestedApiVersion;
-    }
-
-    /**
-     * When false, restler will run in debug mode and parse the class files
-     * every time to map it to the URL
-     *
-     * @return bool
-     */
-    public function getProductionMode()
-    {
-        return $this->productionMode;
-    }
-
-    /**
-     * Chosen API version
-     *
-     * @return int
-     */
-    public function getApiVersion()
-    {
-        return $this->apiVersion;
-    }
-
-    /**
-     * Base Url of the API Service
-     *
-     * @return string
-     *
-     * @example http://localhost/restler3
-     * @example http://restler3.com
-     */
-    public function getBaseUrl()
-    {
-        return $this->baseUrl;
-    }
-
-    /**
-     * List of events that fired already
-     *
-     * @return array
-     */
-    public function getEvents()
-    {
-        return $this->events;
-    }
-
-    /**
-     * Magic method to expose some protected variables
-     *
-     * @param string $name name of the hidden property
-     *
-     * @return null|mixed
-     */
-    public function __get($name)
-    {
-        if ($name[0] == '_') {
-            $hiddenProperty = substr($name, 1);
-            if (isset($this->$hiddenProperty)) {
-                return $this->$hiddenProperty;
-            }
-        }
-        return null;
-    }
-
-    /**
-     * Store the url map cache if needed
-     */
-    public function __destruct()
-    {
-        if ($this->productionMode && !$this->cached) {
-            if (empty($this->url) && empty($this->requestMethod)) {
-                // url and requestMethod is NOT set:
-                // This can only happen, when an exception was thrown outside of restler, so that the method Restler::handle was NOT called.
-                // In this case, the routes can now be corrupt/incomplete, because we don't know, if all API-classes could be registered
-                // before the exception was thrown. So, don't cache the routes, because the routes can now be corrupt/incomplete!
-                return;
-            }
-            if ($this->exception instanceof RestException && $this->exception->getStage() === 'setup') {
-                // An exception has occured during configuration of restler. Maybe we could not add all API-classes correctly!
-                // So, don't cache the routes, because the routes can now be corrupt/incomplete!
-                return;
-            }
-
-            $this->cache->set(
-                'routes',
-                Routes::toArray() +
-                array('apiVersionMap' => $this->apiVersionMap)
-            );
-        }
-    }
-
-    /**
-     * pre call
-     *
-     * call _pre_{methodName)_{extension} if exists with the same parameters as
-     * the api method
-     *
-     * @example _pre_get_json
-     *
-     */
-    protected function preCall()
-    {
-        $o = & $this->apiMethodInfo;
-        $preCall = '_pre_' . $o->methodName . '_'
-            . $this->requestFormat->getExtension();
-
-        if (method_exists($o->className, $preCall)) {
-            $this->dispatch('preCall');
-            call_user_func_array(array(
-                Scope::get($o->className),
-                $preCall
-            ), $o->parameters);
-        }
-    }
-
-    /**
-     * post call
-     *
-     * call _post_{methodName}_{extension} if exists with the composed and
-     * serialized (applying the repose format) response data
-     *
-     * @example _post_get_json
-     */
-    protected function postCall()
-    {
-        $o = & $this->apiMethodInfo;
-        $postCall = '_post_' . $o->methodName . '_' .
-            $this->responseFormat->getExtension();
-        if (method_exists($o->className, $postCall)) {
-            $this->dispatch('postCall');
-            $this->responseData = call_user_func(array(
-                Scope::get($o->className),
-                $postCall
-            ), $this->responseData);
-        }
-    }
+	const VERSION = '3.1.0';
+
+	// ==================================================================
+	//
+	// Public variables
+	//
+	// ------------------------------------------------------------------
+	/**
+	 * Reference to the last exception thrown
+	 * @var RestException
+	 */
+	public $exception = null;
+	/**
+	 * Used in production mode to store the routes and more
+	 *
+	 * @var iCache
+	 */
+	public $cache;
+	/**
+	 * URL of the currently mapped service
+	 *
+	 * @var string
+	 */
+	public $url;
+	/**
+	 * Http request method of the current request.
+	 * Any value between [GET, PUT, POST, DELETE]
+	 *
+	 * @var string
+	 */
+	public $requestMethod;
+	/**
+	 * Requested data format.
+	 * Instance of the current format class
+	 * which implements the iFormat interface
+	 *
+	 * @var iFormat
+	 * @example jsonFormat, xmlFormat, yamlFormat etc
+	 */
+	public $requestFormat;
+	/**
+	 * Response data format.
+	 *
+	 * Instance of the current format class
+	 * which implements the iFormat interface
+	 *
+	 * @var iFormat
+	 * @example jsonFormat, xmlFormat, yamlFormat etc
+	 */
+	public $responseFormat;
+	/**
+	 * Http status code
+	 *
+	 * @var int|null when specified it will override @status comment
+	 */
+	public $responseCode=null;
+	/**
+	 * @var string base url of the api service
+	 */
+	protected $baseUrl;
+	/**
+	 * @var bool Used for waiting till verifying @format
+	 *           before throwing content negotiation failed
+	 */
+	protected $requestFormatDiffered = false;
+	/**
+	 * method information including metadata
+	 *
+	 * @var ApiMethodInfo
+	 */
+	public $apiMethodInfo;
+	/**
+	 * @var int for calculating execution time
+	 */
+	protected $startTime;
+	/**
+	 * When set to false, it will run in debug mode and parse the
+	 * class files every time to map it to the URL
+	 *
+	 * @var boolean
+	 */
+	protected $productionMode = false;
+	public $refreshCache = false;
+	/**
+	 * Caching of url map is enabled or not
+	 *
+	 * @var boolean
+	 */
+	protected $cached;
+	/**
+	 * @var int
+	 */
+	protected $apiVersion = 1;
+	/**
+	 * @var int
+	 */
+	protected $requestedApiVersion = 1;
+	/**
+	 * @var int
+	 */
+	protected $apiMinimumVersion = 1;
+	/**
+	 * @var array
+	 */
+	protected $apiVersionMap = array();
+	/**
+	 * Associated array that maps formats to their respective format class name
+	 *
+	 * @var array
+	 */
+	protected $formatMap = array();
+	/**
+	 * List of the Mime Types that can be produced as a response by this API
+	 *
+	 * @var array
+	 */
+	protected $writableMimeTypes = array();
+	/**
+	 * List of the Mime Types that are supported for incoming requests by this API
+	 *
+	 * @var array
+	 */
+	protected $readableMimeTypes = array();
+	/**
+	 * Associated array that maps formats to their respective format class name
+	 *
+	 * @var array
+	 */
+	protected $formatOverridesMap = array('extensions' => array());
+	/**
+	 * list of filter classes
+	 *
+	 * @var array
+	 */
+	protected $filterClasses = array();
+	/**
+	 * instances of filter classes that are executed after authentication
+	 *
+	 * @var array
+	 */
+	protected $postAuthFilterClasses = array();
+
+
+	// ==================================================================
+	//
+	// Protected variables
+	//
+	// ------------------------------------------------------------------
+
+	/**
+	 * Data sent to the service
+	 *
+	 * @var array
+	 */
+	protected $requestData = array();
+	/**
+	 * list of authentication classes
+	 *
+	 * @var array
+	 */
+	protected $authClasses = array();
+	/**
+	 * list of error handling classes
+	 *
+	 * @var array
+	 */
+	protected $errorClasses = array();
+	protected $authenticated = false;
+	protected $authVerified = false;
+	/**
+	 * @var mixed
+	 */
+	protected $responseData;
+
+	/**
+	 * Constructor
+	 *
+	 * @param boolean $productionMode    When set to false, it will run in
+	 *                                   debug mode and parse the class files
+	 *                                   every time to map it to the URL
+	 *
+	 * @param bool    $refreshCache      will update the cache when set to true
+	 */
+	public function __construct($productionMode = false, $refreshCache = false)
+	{
+		parent::__construct();
+		$this->startTime = time();
+		Util::$restler = $this;
+		Scope::set('Restler', $this);
+		$this->productionMode = $productionMode;
+		if (is_null(Defaults::$cacheDirectory)) {
+			Defaults::$cacheDirectory = dirname($_SERVER['SCRIPT_FILENAME']) .
+				DIRECTORY_SEPARATOR . 'cache';
+		}
+		$this->cache = new Defaults::$cacheClass();
+		$this->refreshCache = $refreshCache;
+		// use this to rebuild cache every time in production mode
+		if ($productionMode && $refreshCache) {
+			$this->cached = false;
+		}
+	}
+
+	/**
+	 * Main function for processing the api request
+	 * and return the response
+	 *
+	 * @throws Exception     when the api service class is missing
+	 * @throws RestException to send error response
+	 */
+	public function handle()
+	{
+		try {
+			try {
+				try {
+					$this->get();
+				} catch (Exception $e) {
+					$this->requestData
+						= array(Defaults::$fullRequestDataName => array());
+					if (!$e instanceof RestException) {
+						$e = new RestException(
+							500,
+							$this->productionMode ? null : $e->getMessage(),
+							array(),
+							$e
+						);
+					}
+					$this->route();
+					throw $e;
+				}
+				if (Defaults::$useVendorMIMEVersioning)
+					$this->responseFormat = $this->negotiateResponseFormat();
+				$this->route();
+			} catch (Exception $e) {
+				$this->negotiate();
+				if (!$e instanceof RestException) {
+					$e = new RestException(
+						500,
+						$this->productionMode ? null : $e->getMessage(),
+						array(),
+						$e
+					);
+				}
+				throw $e;
+			}
+			$this->negotiate();
+			$this->preAuthFilter();
+			$this->authenticate();
+			$this->postAuthFilter();
+			$this->validate();
+			$this->preCall();
+			$this->call();
+			$this->compose();
+			$this->postCall();
+			if (Defaults::$returnResponse) {
+				return $this->respond();
+			}
+			$this->respond();
+		} catch (Exception $e) {
+			try{
+				if (Defaults::$returnResponse) {
+					return $this->message($e);
+				}
+				$this->message($e);
+			} catch (Exception $e2) {
+				if (Defaults::$returnResponse) {
+					return $this->message($e2);
+				}
+				$this->message($e2);
+			}
+		}
+	}
+
+	/**
+	 * read the request details
+	 *
+	 * Find out the following
+	 *  - baseUrl
+	 *  - url requested
+	 *  - version requested (if url based versioning)
+	 *  - http verb/method
+	 *  - negotiate content type
+	 *  - request data
+	 *  - set defaults
+	 */
+	protected function get()
+	{
+		$this->dispatch('get');
+		if (empty($this->formatMap)) {
+			$this->setSupportedFormats('JsonFormat');
+		}
+		$this->url = $this->getPath();
+		$this->requestMethod = Util::getRequestMethod();
+		$this->requestFormat = $this->getRequestFormat();
+		$this->requestData = $this->getRequestData(false);
+
+		//parse defaults
+		foreach ($_GET as $key => $value) {
+			if (isset(Defaults::$aliases[$key])) {
+				$_GET[Defaults::$aliases[$key]] = $value;
+				unset($_GET[$key]);
+				$key = Defaults::$aliases[$key];
+			}
+			if (in_array($key, Defaults::$overridables)) {
+				Defaults::setProperty($key, $value);
+			}
+		}
+	}
+
+	/**
+	 * Returns a list of the mime types (e.g.  ["application/json","application/xml"]) that the API can respond with
+	 * @return array
+	 */
+	public function getWritableMimeTypes()
+	{
+		return $this->writableMimeTypes;
+	}
+
+	/**
+	 * Returns the list of Mime Types for the request that the API can understand
+	 * @return array
+	 */
+	public function getReadableMimeTypes()
+	{
+		return $this->readableMimeTypes;
+	}
+
+	/**
+	 * Call this method and pass all the formats that should be  supported by
+	 * the API Server. Accepts multiple parameters
+	 *
+	 * @param string ,... $formatName   class name of the format class that
+	 *                                  implements iFormat
+	 *
+	 * @example $restler->setSupportedFormats('JsonFormat', 'XmlFormat'...);
+	 * @throws Exception
+	 */
+	public function setSupportedFormats($format = null /*[, $format2...$farmatN]*/)
+	{
+		$args = func_get_args();
+		$extensions = array();
+		$throwException = $this->requestFormatDiffered;
+		$this->writableMimeTypes = $this->readableMimeTypes = array();
+		foreach ($args as $className) {
+
+			$obj = Scope::get($className);
+
+			if (!$obj instanceof iFormat)
+				throw new Exception('Invalid format class; must implement ' .
+					'iFormat interface');
+			if ($throwException && get_class($obj) == get_class($this->requestFormat)) {
+				$throwException = false;
+			}
+
+			foreach ($obj->getMIMEMap() as $mime => $extension) {
+				if($obj->isWritable()){
+					$this->writableMimeTypes[]=$mime;
+					$extensions[".$extension"] = true;
+				}
+				if($obj->isReadable())
+					$this->readableMimeTypes[]=$mime;
+				if (!isset($this->formatMap[$extension]))
+					$this->formatMap[$extension] = $className;
+				if (!isset($this->formatMap[$mime]))
+					$this->formatMap[$mime] = $className;
+			}
+		}
+		if ($throwException) {
+			throw new RestException(
+				403,
+				'Content type `' . $this->requestFormat->getMIME() . '` is not supported.'
+			);
+		}
+		$this->formatMap['default'] = $args[0];
+		$this->formatMap['extensions'] = array_keys($extensions);
+	}
+
+	/**
+	 * Call this method and pass all the formats that can be used to override
+	 * the supported formats using `@format` comment. Accepts multiple parameters
+	 *
+	 * @param string ,... $formatName   class name of the format class that
+	 *                                  implements iFormat
+	 *
+	 * @example $restler->setOverridingFormats('JsonFormat', 'XmlFormat'...);
+	 * @throws Exception
+	 */
+	public function setOverridingFormats($format = null /*[, $format2...$farmatN]*/)
+	{
+		$args = func_get_args();
+		$extensions = array();
+		foreach ($args as $className) {
+
+			$obj = Scope::get($className);
+
+			if (!$obj instanceof iFormat)
+				throw new Exception('Invalid format class; must implement ' .
+					'iFormat interface');
+
+			foreach ($obj->getMIMEMap() as $mime => $extension) {
+				if (!isset($this->formatOverridesMap[$extension]))
+					$this->formatOverridesMap[$extension] = $className;
+				if (!isset($this->formatOverridesMap[$mime]))
+					$this->formatOverridesMap[$mime] = $className;
+				if($obj->isWritable())
+					$extensions[".$extension"] = true;
+			}
+		}
+		$this->formatOverridesMap['extensions'] = array_keys($extensions);
+	}
+
+	/**
+	 * Set one or more string to be considered as the base url
+	 *
+	 * When more than one base url is provided, restler will make
+	 * use of $_SERVER['HTTP_HOST'] to find the right one
+	 *
+	 * @param string ,... $url
+	 */
+	public function setBaseUrls($url /*[, $url2...$urlN]*/)
+	{
+		if (func_num_args() > 1) {
+			$urls = func_get_args();
+			usort($urls, function ($a, $b) {
+				return strlen($a) - strlen($b);
+			});
+			foreach ($urls as $u) {
+				if (0 === strpos($_SERVER['HTTP_HOST'], parse_url($u, PHP_URL_HOST))) {
+					$this->baseUrl = $u;
+					return;
+				}
+			}
+		}
+		$this->baseUrl = $url;
+	}
+
+	/**
+	 * Parses the request url and get the api path
+	 *
+	 * @return string api path
+	 */
+	protected function getPath()
+	{
+		// fix SCRIPT_NAME for PHP 5.4 built-in web server
+		if (false === strpos($_SERVER['SCRIPT_NAME'], '.php'))
+			$_SERVER['SCRIPT_NAME']
+				= '/' . substr($_SERVER['SCRIPT_FILENAME'], strlen($_SERVER['DOCUMENT_ROOT']) + 1);
+
+		list($base, $path) = Util::splitCommonPath(
+			strtok(urldecode($_SERVER['REQUEST_URI']), '?'), //remove query string
+			$_SERVER['SCRIPT_NAME']
+		);
+
+		if (!$this->baseUrl) {
+			// Fix port number retrieval if port is specified in HOST header.
+			$host = isset($_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : '';
+			$portPos = strpos($host,":");
+			if ($portPos){
+			   $port = substr($host,$portPos+1);
+			} else {
+			   $port = isset($_SERVER['SERVER_PORT']) ? $_SERVER['SERVER_PORT'] : '80';
+			   $port = isset($_SERVER['HTTP_X_FORWARDED_PORT']) ? $_SERVER['HTTP_X_FORWARDED_PORT'] : $port; // Amazon ELB
+			}
+			$https = $port == '443' ||
+				(isset($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https') || // Amazon ELB
+				(isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on');
+			$baseUrl = ($https ? 'https://' : 'http://') . $_SERVER['SERVER_NAME'];
+			if (!$https && $port != '80' || $https && $port != '443')
+				$baseUrl .= ':' . $port;
+			$this->baseUrl = $baseUrl . $base;
+		} elseif (!empty($base) && false === strpos($this->baseUrl, $base)) {
+			$this->baseUrl .= $base;
+		}
+
+		$path = str_replace(
+			array_merge(
+				$this->formatMap['extensions'],
+				$this->formatOverridesMap['extensions']
+			),
+			'',
+			rtrim($path, '/') //remove trailing slash if found
+		);
+
+		if (Defaults::$useUrlBasedVersioning && strlen($path) && $path[0] == 'v') {
+			$version = intval(substr($path, 1));
+			if ($version && $version <= $this->apiVersion) {
+				$this->requestedApiVersion = $version;
+				$path = explode('/', $path, 2);
+				$path = count($path) == 2 ? $path[1] : '';
+			}
+		} else {
+			$this->requestedApiVersion = $this->apiMinimumVersion;
+		}
+		return $path;
+	}
+
+	/**
+	 * Parses the request to figure out format of the request data
+	 *
+	 * @throws RestException
+	 * @return iFormat any class that implements iFormat
+	 * @example JsonFormat
+	 */
+	protected function getRequestFormat()
+	{
+		$format = null ;
+		// check if client has sent any information on request format
+		if (
+			!empty($_SERVER['CONTENT_TYPE']) ||
+			(
+				!empty($_SERVER['HTTP_CONTENT_TYPE']) &&
+				$_SERVER['CONTENT_TYPE'] = $_SERVER['HTTP_CONTENT_TYPE']
+			)
+		) {
+			$mime = $_SERVER['CONTENT_TYPE'];
+			if (false !== $pos = strpos($mime, ';')) {
+				$mime = substr($mime, 0, $pos);
+			}
+			if ($mime == UrlEncodedFormat::MIME)
+				$format = Scope::get('UrlEncodedFormat');
+			elseif (isset($this->formatMap[$mime])) {
+				$format = Scope::get($this->formatMap[$mime]);
+				$format->setMIME($mime);
+			} elseif (!$this->requestFormatDiffered && isset($this->formatOverridesMap[$mime])) {
+				//if our api method is not using an @format comment
+				//to point to this $mime, we need to throw 403 as in below
+				//but since we don't know that yet, we need to defer that here
+				$format = Scope::get($this->formatOverridesMap[$mime]);
+				$format->setMIME($mime);
+				$this->requestFormatDiffered = true;
+			} else {
+				throw new RestException(
+					403,
+					"Content type `$mime` is not supported."
+				);
+			}
+		}
+		if(!$format){
+			$format = Scope::get($this->formatMap['default']);
+		}
+		return $format;
+	}
+
+	public function getRequestStream()
+	{
+		static $tempStream = false;
+		if (!$tempStream) {
+			$tempStream = fopen('php://temp', 'r+');
+			$rawInput = fopen('php://input', 'r');
+			stream_copy_to_stream($rawInput, $tempStream);
+		}
+		rewind($tempStream);
+		return $tempStream;
+	}
+
+	/**
+	 * Parses the request data and returns it
+	 *
+	 * @param bool $includeQueryParameters
+	 *
+	 * @return array php data
+	 */
+	public function getRequestData($includeQueryParameters = true)
+	{
+		$get = UrlEncodedFormat::decoderTypeFix($_GET);
+		if ($this->requestMethod == 'PUT'
+			|| $this->requestMethod == 'PATCH'
+			|| $this->requestMethod == 'POST'
+		) {
+			if (!empty($this->requestData)) {
+				return $includeQueryParameters
+					? $this->requestData + $get
+					: $this->requestData;
+			}
+
+			$stream = $this->getRequestStream();
+			if($stream === FALSE)
+				return array();
+			$r = $this->requestFormat instanceof iDecodeStream
+				? $this->requestFormat->decodeStream($stream)
+				: $this->requestFormat->decode(stream_get_contents($stream));
+
+			$r = is_array($r)
+				? array_merge($r, array(Defaults::$fullRequestDataName => $r))
+				: array(Defaults::$fullRequestDataName => $r);
+			return $includeQueryParameters
+				? $r + $get
+				: $r;
+		}
+		return $includeQueryParameters ? $get : array(); //no body
+	}
+
+	/**
+	 * Find the api method to execute for the requested Url
+	 */
+	protected function route()
+	{
+		$this->dispatch('route');
+
+		$params = $this->getRequestData();
+
+		//backward compatibility for restler 2 and below
+		if (!Defaults::$smartParameterParsing) {
+			$params = $params + array(Defaults::$fullRequestDataName => $params);
+		}
+
+		$this->apiMethodInfo = $o = Routes::find(
+			$this->url, $this->requestMethod,
+			$this->requestedApiVersion, $params
+		);
+		//set defaults based on api method comments
+		if (isset($o->metadata)) {
+			foreach (Defaults::$fromComments as $key => $defaultsKey) {
+				if (array_key_exists($key, $o->metadata)) {
+					$value = $o->metadata[$key];
+					Defaults::setProperty($defaultsKey, $value);
+				}
+			}
+		}
+		if (!isset($o->className))
+			throw new RestException(404);
+
+		if(isset($this->apiVersionMap[$o->className])){
+			Scope::$classAliases[Util::getShortName($o->className)]
+				= $this->apiVersionMap[$o->className][$this->requestedApiVersion];
+		}
+
+		foreach ($this->authClasses as $auth) {
+			if (isset($this->apiVersionMap[$auth])) {
+				Scope::$classAliases[$auth] = $this->apiVersionMap[$auth][$this->requestedApiVersion];
+			} elseif (isset($this->apiVersionMap[Scope::$classAliases[$auth]])) {
+				Scope::$classAliases[$auth]
+					= $this->apiVersionMap[Scope::$classAliases[$auth]][$this->requestedApiVersion];
+			}
+		}
+	}
+
+	/**
+	 * Negotiate the response details such as
+	 *  - cross origin resource sharing
+	 *  - media type
+	 *  - charset
+	 *  - language
+	 *
+	 * @throws RestException
+	 */
+	protected function negotiate()
+	{
+		$this->dispatch('negotiate');
+		$this->negotiateCORS();
+		$this->responseFormat = $this->negotiateResponseFormat();
+		$this->negotiateCharset();
+		$this->negotiateLanguage();
+	}
+
+	protected function negotiateCORS()
+	{
+		if (
+			$this->requestMethod == 'OPTIONS'
+			&& Defaults::$crossOriginResourceSharing
+		) {
+			if (isset($_SERVER['HTTP_ACCESS_CONTROL_REQUEST_METHOD']))
+				header('Access-Control-Allow-Methods: '
+					. Defaults::$accessControlAllowMethods);
+
+			if (isset($_SERVER['HTTP_ACCESS_CONTROL_REQUEST_HEADERS']))
+				header('Access-Control-Allow-Headers: '
+					. $_SERVER['HTTP_ACCESS_CONTROL_REQUEST_HEADERS']);
+
+			header('Access-Control-Allow-Origin: ' .
+				((Defaults::$accessControlAllowOrigin == '*' && isset($_SERVER['HTTP_ORIGIN']))
+					? $_SERVER['HTTP_ORIGIN'] : Defaults::$accessControlAllowOrigin));
+			header('Access-Control-Allow-Credentials: true');
+
+			exit(0);
+		}
+	}
+
+	// ==================================================================
+	//
+	// Protected functions
+	//
+	// ------------------------------------------------------------------
+
+	/**
+	 * Parses the request to figure out the best format for response.
+	 * Extension, if present, overrides the Accept header
+	 *
+	 * @throws RestException
+	 * @return iFormat
+	 * @example JsonFormat
+	 */
+	protected function negotiateResponseFormat()
+	{
+		$metadata = Util::nestedValue($this, 'apiMethodInfo', 'metadata');
+		//check if the api method insists on response format using @format comment
+
+		if ($metadata && isset($metadata['format'])) {
+			$formats = explode(',', (string)$metadata['format']);
+			foreach ($formats as $i => $f) {
+				$f = trim($f);
+				if (!in_array($f, $this->formatOverridesMap))
+					throw new RestException(
+						500,
+						"Given @format is not present in overriding formats. Please call `\$r->setOverridingFormats('$f');` first."
+					);
+				$formats[$i] = $f;
+			}
+			call_user_func_array(array($this, 'setSupportedFormats'), $formats);
+		}
+
+		// check if client has specified an extension
+		/** @var $format iFormat*/
+		$format = null;
+		$extensions = explode(
+			'.',
+			parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH)
+		);
+		while ($extensions) {
+			$extension = array_pop($extensions);
+			$extension = explode('/', $extension);
+			$extension = array_shift($extension);
+			if ($extension && isset($this->formatMap[$extension])) {
+				$format = Scope::get($this->formatMap[$extension]);
+				$format->setExtension($extension);
+				// echo "Extension $extension";
+				return $format;
+			}
+		}
+		// check if client has sent list of accepted data formats
+		if (isset($_SERVER['HTTP_ACCEPT'])) {
+			$acceptList = Util::sortByPriority($_SERVER['HTTP_ACCEPT']);
+			foreach ($acceptList as $accept => $quality) {
+				if (isset($this->formatMap[$accept])) {
+					$format = Scope::get($this->formatMap[$accept]);
+					$format->setMIME($accept);
+					//echo "MIME $accept";
+					// Tell cache content is based on Accept header
+					@header('Vary: Accept');
+
+					return $format;
+				} elseif (false !== ($index = strrpos($accept, '+'))) {
+					$mime = substr($accept, 0, $index);
+					if (is_string(Defaults::$apiVendor)
+						&& 0 === stripos($mime,
+							'application/vnd.'
+							. Defaults::$apiVendor . '-v')
+					) {
+						$extension = substr($accept, $index + 1);
+						if (isset($this->formatMap[$extension])) {
+							//check the MIME and extract version
+							$version = intval(substr($mime,
+								18 + strlen(Defaults::$apiVendor)));
+							if ($version > 0 && $version <= $this->apiVersion) {
+								$this->requestedApiVersion = $version;
+								$format = Scope::get($this->formatMap[$extension]);
+								$format->setExtension($extension);
+								// echo "Extension $extension";
+								Defaults::$useVendorMIMEVersioning = true;
+								@header('Vary: Accept');
+
+								return $format;
+							}
+						}
+					}
+
+				}
+			}
+		} else {
+			// RFC 2616: If no Accept header field is
+			// present, then it is assumed that the
+			// client accepts all media types.
+			$_SERVER['HTTP_ACCEPT'] = '*/*';
+		}
+		if (strpos($_SERVER['HTTP_ACCEPT'], '*') !== false) {
+			if (false !== strpos($_SERVER['HTTP_ACCEPT'], 'application/*')) {
+				$format = Scope::get('JsonFormat');
+			} elseif (false !== strpos($_SERVER['HTTP_ACCEPT'], 'text/*')) {
+				$format = Scope::get('XmlFormat');
+			} elseif (false !== strpos($_SERVER['HTTP_ACCEPT'], '*/*')) {
+				$format = Scope::get($this->formatMap['default']);
+			}
+		}
+		if (empty($format)) {
+			// RFC 2616: If an Accept header field is present, and if the
+			// server cannot send a response which is acceptable according to
+			// the combined Accept field value, then the server SHOULD send
+			// a 406 (not acceptable) response.
+			$format = Scope::get($this->formatMap['default']);
+			$this->responseFormat = $format;
+			throw new RestException(
+				406,
+				'Content negotiation failed. ' .
+				'Try `' . $format->getMIME() . '` instead.'
+			);
+		} else {
+			// Tell cache content is based at Accept header
+			@header("Vary: Accept");
+			return $format;
+		}
+	}
+
+	protected function negotiateCharset()
+	{
+		if (isset($_SERVER['HTTP_ACCEPT_CHARSET'])) {
+			$found = false;
+			$charList = Util::sortByPriority($_SERVER['HTTP_ACCEPT_CHARSET']);
+			foreach ($charList as $charset => $quality) {
+				if (in_array($charset, Defaults::$supportedCharsets)) {
+					$found = true;
+					Defaults::$charset = $charset;
+					break;
+				}
+			}
+			if (!$found) {
+				if (strpos($_SERVER['HTTP_ACCEPT_CHARSET'], '*') !== false) {
+					//use default charset
+				} else {
+					throw new RestException(
+						406,
+						'Content negotiation failed. ' .
+						'Requested charset is not supported'
+					);
+				}
+			}
+		}
+	}
+
+	protected function negotiateLanguage()
+	{
+		if (isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
+			$found = false;
+			$langList = Util::sortByPriority($_SERVER['HTTP_ACCEPT_LANGUAGE']);
+			foreach ($langList as $lang => $quality) {
+				foreach (Defaults::$supportedLanguages as $supported) {
+					if (strcasecmp($supported, $lang) == 0) {
+						$found = true;
+						Defaults::$language = $supported;
+						break 2;
+					}
+				}
+			}
+			if (!$found) {
+				if (strpos($_SERVER['HTTP_ACCEPT_LANGUAGE'], '*') !== false) {
+					//use default language
+				} else {
+					//ignore
+				}
+			}
+		}
+	}
+
+	/**
+	 * Filer api calls before authentication
+	 */
+	protected function preAuthFilter()
+	{
+		if (empty($this->filterClasses)) {
+			return;
+		}
+		$this->dispatch('preAuthFilter');
+		foreach ($this->filterClasses as $filterClass) {
+			/**
+			 * @var iFilter
+			 */
+			$filterObj = Scope::get($filterClass);
+
+			if (!$filterObj instanceof iFilter) {
+				throw new RestException (
+					500, 'Filter Class ' .
+					'should implement iFilter');
+			} else if (!($ok = $filterObj->__isAllowed())) {
+				if (is_null($ok)
+					&& $filterObj instanceof iUseAuthentication
+				) {
+					//handle at authentication stage
+					$this->postAuthFilterClasses[] = $filterClass;
+					continue;
+				}
+				throw new RestException(403); //Forbidden
+			}
+		}
+	}
+
+	protected function authenticate()
+	{
+		$o = &$this->apiMethodInfo;
+		$accessLevel = max(Defaults::$apiAccessLevel, $o->accessLevel);
+		if ($accessLevel || count($this->postAuthFilterClasses)) {
+			$this->dispatch('authenticate');
+			if (!count($this->authClasses) && $accessLevel > 1) {
+				throw new RestException(
+					403,
+					'at least one Authentication Class is required'
+				);
+			}
+			$unauthorized = false;
+			foreach ($this->authClasses as $authClass) {
+				try {
+					$authObj = Scope::get($authClass);
+					if (!method_exists($authObj, Defaults::$authenticationMethod)) {
+						throw new RestException (
+							500, 'Authentication Class ' .
+							'should implement iAuthenticate');
+					} elseif (
+					!$authObj->{Defaults::$authenticationMethod}()
+					) {
+						throw new RestException(401);
+					}
+					$unauthorized = false;
+					break;
+				} catch (InvalidAuthCredentials $e) {
+					$this->authenticated = false;
+					throw $e;
+				} catch (RestException $e) {
+					if (!$unauthorized) {
+						$unauthorized = $e;
+					}
+				}
+			}
+			$this->authVerified = true;
+			if ($unauthorized) {
+				if ($accessLevel > 1) { //when it is not a hybrid api
+					throw $unauthorized;
+				} else {
+					$this->authenticated = false;
+				}
+			} else {
+				$this->authenticated = true;
+			}
+		}
+	}
+
+	/**
+	 * Filer api calls after authentication
+	 */
+	protected function postAuthFilter()
+	{
+		if(empty($this->postAuthFilterClasses)) {
+			return;
+		}
+		$this->dispatch('postAuthFilter');
+		foreach ($this->postAuthFilterClasses as $filterClass) {
+			Scope::get($filterClass);
+		}
+	}
+
+	protected function validate()
+	{
+		if (!Defaults::$autoValidationEnabled) {
+			return;
+		}
+		$this->dispatch('validate');
+
+		$o = & $this->apiMethodInfo;
+		foreach ($o->metadata['param'] as $index => $param) {
+			$info = & $param [CommentParser::$embeddedDataName];
+			if (!isset ($info['validate'])
+				|| $info['validate'] != false
+			) {
+				if (isset($info['method'])) {
+					$info ['apiClassInstance'] = Scope::get($o->className);
+				}
+				//convert to instance of ValidationInfo
+				$info = new ValidationInfo($param);
+				//initialize validator
+				Scope::get(Defaults::$validatorClass);
+				$validator = Defaults::$validatorClass;
+				//if(!is_subclass_of($validator, 'Luracast\\Restler\\Data\\iValidate')) {
+				//changed the above test to below for addressing this php bug
+				//https://bugs.php.net/bug.php?id=53727
+				if (function_exists("$validator::validate")) {
+					throw new \UnexpectedValueException(
+						'`Defaults::$validatorClass` must implement `iValidate` interface'
+					);
+				}
+				$valid = $o->parameters[$index];
+				$o->parameters[$index] = null;
+				if (empty(Validator::$exceptions))
+					$o->metadata['param'][$index]['autofocus'] = true;
+				$valid = $validator::validate(
+					$valid, $info
+				);
+				$o->parameters[$index] = $valid;
+				unset($o->metadata['param'][$index]['autofocus']);
+			}
+		}
+	}
+
+	protected function call()
+	{
+		$this->dispatch('call');
+		$o = & $this->apiMethodInfo;
+		$accessLevel = max(Defaults::$apiAccessLevel,
+			$o->accessLevel);
+		if (function_exists('newrelic_name_transaction'))
+			newrelic_name_transaction("{$o->className}/{$o->methodName}");
+		$object =  Scope::get($o->className);
+		switch ($accessLevel) {
+			case 3 : //protected method
+				$reflectionMethod = new \ReflectionMethod(
+					$object,
+					$o->methodName
+				);
+				$reflectionMethod->setAccessible(true);
+				$result = $reflectionMethod->invokeArgs(
+					$object,
+					$o->parameters
+				);
+				break;
+			default :
+				$result = call_user_func_array(array(
+					$object,
+					$o->methodName
+				), $o->parameters);
+		}
+		$this->responseData = $result;
+	}
+
+	protected function compose()
+	{
+		$this->dispatch('compose');
+		$this->composeHeaders();
+		/**
+		 * @var iCompose Default Composer
+		 */
+		$compose = Scope::get(Defaults::$composeClass);
+		$this->responseData = is_null($this->responseData) &&
+		Defaults::$emptyBodyForNullResponse
+			? ''
+			: $this->responseFormat->encode(
+				$compose->response($this->responseData),
+				!$this->productionMode
+			);
+	}
+
+	public function composeHeaders(RestException $e = null)
+	{
+		//only GET method should be cached if allowed by API developer
+		$expires = $this->requestMethod == 'GET' ? Defaults::$headerExpires : 0;
+		if(!is_array(Defaults::$headerCacheControl))
+			Defaults::$headerCacheControl = array(Defaults::$headerCacheControl);
+		$cacheControl = Defaults::$headerCacheControl[0];
+		if ($expires > 0) {
+			$cacheControl = $this->apiMethodInfo->accessLevel
+				? 'private, ' : 'public, ';
+			$cacheControl .= end(Defaults::$headerCacheControl);
+			$cacheControl = str_replace('{expires}', $expires, $cacheControl);
+			$expires = gmdate('D, d M Y H:i:s \G\M\T', time() + $expires);
+		}
+		@header('Cache-Control: ' . $cacheControl);
+		@header('Expires: ' . $expires);
+		@header('X-Powered-By: Luracast Restler v' . Restler::VERSION);
+
+		if (Defaults::$crossOriginResourceSharing
+			&& isset($_SERVER['HTTP_ORIGIN'])
+		) {
+			header('Access-Control-Allow-Origin: ' .
+				(Defaults::$accessControlAllowOrigin == '*'
+					? $_SERVER['HTTP_ORIGIN']
+					: Defaults::$accessControlAllowOrigin)
+			);
+			header('Access-Control-Allow-Credentials: true');
+			header('Access-Control-Max-Age: 86400');
+		}
+
+		$this->responseFormat->setCharset(Defaults::$charset);
+		$charset = $this->responseFormat->getCharset()
+			? : Defaults::$charset;
+
+		@header('Content-Type: ' . (
+			Defaults::$useVendorMIMEVersioning
+				? 'application/vnd.'
+				. Defaults::$apiVendor
+				. "-v{$this->requestedApiVersion}"
+				. '+' . $this->responseFormat->getExtension()
+				: $this->responseFormat->getMIME())
+			. '; charset=' . $charset
+		);
+
+		@header('Content-Language: ' . Defaults::$language);
+
+		if (isset($this->apiMethodInfo->metadata['header'])) {
+			foreach ($this->apiMethodInfo->metadata['header'] as $header)
+				@header($header, true);
+		}
+		$code = 200;
+		if (!Defaults::$suppressResponseCode) {
+			if ($e) {
+				$code = $e->getCode();
+			} elseif ($this->responseCode) {
+				$code = $this->responseCode;
+			} elseif (isset($this->apiMethodInfo->metadata['status'])) {
+				$code = $this->apiMethodInfo->metadata['status'];
+			}
+		}
+		$this->responseCode = $code;
+		@header(
+			"{$_SERVER['SERVER_PROTOCOL']} $code " .
+			(isset(RestException::$codes[$code]) ? RestException::$codes[$code] : '')
+		);
+	}
+
+	protected function respond()
+	{
+		$this->dispatch('respond');
+		//handle throttling
+		if (Defaults::$throttle) {
+			$elapsed = time() - $this->startTime;
+			if (Defaults::$throttle / 1e3 > $elapsed) {
+				usleep(1e6 * (Defaults::$throttle / 1e3 - $elapsed));
+			}
+		}
+		if ($this->responseCode == 401) {
+			$authString = count($this->authClasses)
+				? Scope::get($this->authClasses[0])->__getWWWAuthenticateString()
+				: 'Unknown';
+			@header('WWW-Authenticate: ' . $authString, false);
+		}
+		$this->dispatch('complete');
+		if (Defaults::$returnResponse) {
+			return $this->responseData;
+		} else {
+			echo $this->responseData;
+			exit;
+		}
+	}
+
+	protected function message(Exception $exception)
+	{
+		$this->dispatch('message');
+
+		if (!$exception instanceof RestException) {
+			$exception = new RestException(
+				500,
+				$this->productionMode ? null : $exception->getMessage(),
+				array(),
+				$exception
+			);
+		}
+
+		$this->exception = $exception;
+
+		$method = 'handle' . $exception->getCode();
+		$handled = false;
+		foreach ($this->errorClasses as $className) {
+			if (method_exists($className, $method)) {
+				$obj = Scope::get($className);
+				if ($obj->$method($exception))
+					$handled = true;
+			}
+		}
+		if ($handled) {
+			return;
+		}
+		if (!isset($this->responseFormat)) {
+			$this->responseFormat = Scope::get('JsonFormat');
+		}
+		$this->composeHeaders($exception);
+		/**
+		 * @var iCompose Default Composer
+		 */
+		$compose = Scope::get(Defaults::$composeClass);
+		$this->responseData = $this->responseFormat->encode(
+			$compose->message($exception),
+			!$this->productionMode
+		);
+		if (Defaults::$returnResponse) {
+			return $this->respond();
+		}
+		$this->respond();
+	}
+
+	/**
+	 * Provides backward compatibility with older versions of Restler
+	 *
+	 * @param int $version restler version
+	 *
+	 * @throws \OutOfRangeException
+	 */
+	public function setCompatibilityMode($version = 2)
+	{
+		if ($version <= intval(self::VERSION) && $version > 0) {
+			require __DIR__."/compatibility/restler{$version}.php";
+			return;
+		}
+		throw new \OutOfRangeException();
+	}
+
+	/**
+	 * @param int $version                 maximum version number supported
+	 *                                     by  the api
+	 * @param int $minimum                 minimum version number supported
+	 * (optional)
+	 *
+	 * @throws InvalidArgumentException
+	 * @return void
+	 */
+	public function setAPIVersion($version = 1, $minimum = 1)
+	{
+		if (!is_int($version) && $version < 1) {
+			throw new InvalidArgumentException
+			('version should be an integer greater than 0');
+		}
+		$this->apiVersion = $version;
+		if (is_int($minimum)) {
+			$this->apiMinimumVersion = $minimum;
+		}
+	}
+
+	/**
+	 * Classes implementing iFilter interface can be added for filtering out
+	 * the api consumers.
+	 *
+	 * It can be used for rate limiting based on usage from a specific ip
+	 * address or filter by country, device etc.
+	 *
+	 * @param $className
+	 */
+	public function addFilterClass($className)
+	{
+		$this->filterClasses[] = $className;
+	}
+
+	/**
+	 * protected methods will need at least one authentication class to be set
+	 * in order to allow that method to be executed
+	 *
+	 * @param string $className     of the authentication class
+	 * @param string $resourcePath  optional url prefix for mapping
+	 */
+	public function addAuthenticationClass($className, $resourcePath = null)
+	{
+		$this->authClasses[] = $className;
+		$this->addAPIClass($className, $resourcePath);
+	}
+
+	/**
+	 * Add api classes through this method.
+	 *
+	 * All the public methods that do not start with _ (underscore)
+	 * will be will be exposed as the public api by default.
+	 *
+	 * All the protected methods that do not start with _ (underscore)
+	 * will exposed as protected api which will require authentication
+	 *
+	 * @param string $className       name of the service class
+	 * @param string $resourcePath    optional url prefix for mapping, uses
+	 *                                lowercase version of the class name when
+	 *                                not specified
+	 *
+	 * @return null
+	 *
+	 * @throws Exception when supplied with invalid class name
+	 */
+	public function addAPIClass($className, $resourcePath = null)
+	{
+		try{
+			if ($this->productionMode && is_null($this->cached)) {
+				$routes = $this->cache->get('routes');
+				if (isset($routes) && is_array($routes)) {
+					$this->apiVersionMap = $routes['apiVersionMap'];
+					unset($routes['apiVersionMap']);
+					Routes::fromArray($routes);
+					$this->cached = true;
+				} else {
+					$this->cached = false;
+				}
+			}
+			if (isset(Scope::$classAliases[$className])) {
+				$className = Scope::$classAliases[$className];
+			}
+			if (!$this->cached) {
+				$maxVersionMethod = '__getMaximumSupportedVersion';
+				if (class_exists($className)) {
+					if (method_exists($className, $maxVersionMethod)) {
+						$max = $className::$maxVersionMethod();
+						for ($i = 1; $i <= $max; $i++) {
+							$this->apiVersionMap[$className][$i] = $className;
+						}
+					} else {
+						$this->apiVersionMap[$className][1] = $className;
+					}
+				}
+				//versioned api
+				if (false !== ($index = strrpos($className, '\\'))) {
+					$name = substr($className, 0, $index)
+						. '\\v{$version}' . substr($className, $index);
+				} else if (false !== ($index = strrpos($className, '_'))) {
+					$name = substr($className, 0, $index)
+						. '_v{$version}' . substr($className, $index);
+				} else {
+					$name = 'v{$version}\\' . $className;
+				}
+
+				for ($version = $this->apiMinimumVersion;
+					 $version <= $this->apiVersion;
+					 $version++) {
+
+					$versionedClassName = str_replace('{$version}', $version,
+						$name);
+					if (class_exists($versionedClassName)) {
+						Routes::addAPIClass($versionedClassName,
+							Util::getResourcePath(
+								$className,
+								$resourcePath
+							),
+							$version
+						);
+						if (method_exists($versionedClassName, $maxVersionMethod)) {
+							$max = $versionedClassName::$maxVersionMethod();
+							for ($i = $version; $i <= $max; $i++) {
+								$this->apiVersionMap[$className][$i] = $versionedClassName;
+							}
+						} else {
+							$this->apiVersionMap[$className][$version] = $versionedClassName;
+						}
+					} elseif (isset($this->apiVersionMap[$className][$version])) {
+						Routes::addAPIClass($this->apiVersionMap[$className][$version],
+							Util::getResourcePath(
+								$className,
+								$resourcePath
+							),
+							$version
+						);
+					}
+				}
+
+			}
+		} catch (Exception $e) {
+			$e = new Exception(
+				"addAPIClass('$className') failed. ".$e->getMessage(),
+				$e->getCode(),
+				$e
+			);
+			$this->setSupportedFormats('JsonFormat');
+			$this->message($e);
+		}
+	}
+
+	/**
+	 * Add class for custom error handling
+	 *
+	 * @param string $className   of the error handling class
+	 */
+	public function addErrorClass($className)
+	{
+		$this->errorClasses[] = $className;
+	}
+
+	/**
+	 * protected methods will need at least one authentication class to be set
+	 * in order to allow that method to be executed.  When multiple authentication
+	 * classes are in use, this function provides better performance by setting
+	 * all auth classes through a single function call.
+	 *
+	 * @param array $classNames     array of associative arrays containing
+	 *                              the authentication class name & optional
+	 *                              url prefix for mapping.
+	 */
+	public function setAuthClasses(array $classNames)
+	{
+		$this->authClasses = array_merge($this->authClasses, array_values($classNames));
+	}
+
+	/**
+	 * Add multiple api classes through this method.
+	 *
+	 * This method provides better performance when large number
+	 * of API classes are in use as it processes them all at once,
+	 * as opposed to hundreds (or more) addAPIClass calls.
+	 *
+	 *
+	 * All the public methods that do not start with _ (underscore)
+	 * will be will be exposed as the public api by default.
+	 *
+	 * All the protected methods that do not start with _ (underscore)
+	 * will exposed as protected api which will require authentication
+	 *
+	 * @param array $map        array of associative arrays containing
+	 *                          the class name & optional url prefix
+	 *                          for mapping.
+	 *
+	 * @return null
+	 *
+	 * @throws Exception when supplied with invalid class name
+	 */
+	public function mapAPIClasses(array $map)
+	{
+		try {
+			if ($this->productionMode && is_null($this->cached)) {
+				$routes = $this->cache->get('routes');
+				if (isset($routes) && is_array($routes)) {
+					$this->apiVersionMap = $routes['apiVersionMap'];
+					unset($routes['apiVersionMap']);
+					Routes::fromArray($routes);
+					$this->cached = true;
+				} else {
+					$this->cached = false;
+				}
+			}
+			$maxVersionMethod = '__getMaximumSupportedVersion';
+			if (!$this->productionMode || !$this->cached) {
+				foreach ($map as $className => $resourcePath) {
+					if (is_numeric($className)) {
+						$className = $resourcePath;
+						$resourcePath = null;
+					}
+					if (isset(Scope::$classAliases[$className])) {
+						$className = Scope::$classAliases[$className];
+					}
+					if (class_exists($className)) {
+						if (method_exists($className, $maxVersionMethod)) {
+							$max = $className::$maxVersionMethod();
+							for ($i = 1; $i <= $max; $i++) {
+								$this->apiVersionMap[$className][$i] = $className;
+							}
+						} else {
+							$this->apiVersionMap[$className][1] = $className;
+						}
+					}
+					//versioned api
+					if (false !== ($index = strrpos($className, '\\'))) {
+						$name = substr($className, 0, $index)
+							. '\\v{$version}' . substr($className, $index);
+					} else {
+						if (false !== ($index = strrpos($className, '_'))) {
+							$name = substr($className, 0, $index)
+								. '_v{$version}' . substr($className, $index);
+						} else {
+							$name = 'v{$version}\\' . $className;
+						}
+					}
+
+					for ($version = $this->apiMinimumVersion;
+						 $version <= $this->apiVersion;
+						 $version++) {
+
+						$versionedClassName = str_replace('{$version}', $version,
+							$name);
+						if (class_exists($versionedClassName)) {
+							Routes::addAPIClass($versionedClassName,
+								Util::getResourcePath(
+									$className,
+									$resourcePath
+								),
+								$version
+							);
+							if (method_exists($versionedClassName, $maxVersionMethod)) {
+								$max = $versionedClassName::$maxVersionMethod();
+								for ($i = $version; $i <= $max; $i++) {
+									$this->apiVersionMap[$className][$i] = $versionedClassName;
+								}
+							} else {
+								$this->apiVersionMap[$className][$version] = $versionedClassName;
+							}
+						} elseif (isset($this->apiVersionMap[$className][$version])) {
+							Routes::addAPIClass($this->apiVersionMap[$className][$version],
+								Util::getResourcePath(
+									$className,
+									$resourcePath
+								),
+								$version
+							);
+						}
+					}
+				}
+			}
+		} catch (Exception $e) {
+			$e = new Exception(
+				"mapAPIClasses failed. " . $e->getMessage(),
+				$e->getCode(),
+				$e
+			);
+			$this->setSupportedFormats('JsonFormat');
+			$this->message($e);
+		}
+	}
+
+	/**
+	 * Associated array that maps formats to their respective format class name
+	 *
+	 * @return array
+	 */
+	public function getFormatMap()
+	{
+		return $this->formatMap;
+	}
+
+	/**
+	 * API version requested by the client
+	 * @return int
+	 */
+	public function getRequestedApiVersion()
+	{
+		return $this->requestedApiVersion;
+	}
+
+	/**
+	 * When false, restler will run in debug mode and parse the class files
+	 * every time to map it to the URL
+	 *
+	 * @return bool
+	 */
+	public function getProductionMode()
+	{
+		return $this->productionMode;
+	}
+
+	/**
+	 * Chosen API version
+	 *
+	 * @return int
+	 */
+	public function getApiVersion()
+	{
+		return $this->apiVersion;
+	}
+
+	/**
+	 * Base Url of the API Service
+	 *
+	 * @return string
+	 *
+	 * @example http://localhost/restler3
+	 * @example http://restler3.com
+	 */
+	public function getBaseUrl()
+	{
+		return $this->baseUrl;
+	}
+
+	/**
+	 * List of events that fired already
+	 *
+	 * @return array
+	 */
+	public function getEvents()
+	{
+		return $this->events;
+	}
+
+	/**
+	 * Magic method to expose some protected variables
+	 *
+	 * @param string $name name of the hidden property
+	 *
+	 * @return null|mixed
+	 */
+	public function __get($name)
+	{
+		if ($name[0] == '_') {
+			$hiddenProperty = substr($name, 1);
+			if (isset($this->$hiddenProperty)) {
+				return $this->$hiddenProperty;
+			}
+		}
+		return null;
+	}
+
+	/**
+	 * Store the url map cache if needed
+	 */
+	public function __destruct()
+	{
+		if ($this->productionMode && !$this->cached) {
+			if (empty($this->url) && empty($this->requestMethod)) {
+				// url and requestMethod is NOT set:
+				// This can only happen, when an exception was thrown outside of restler, so that the method Restler::handle was NOT called.
+				// In this case, the routes can now be corrupt/incomplete, because we don't know, if all API-classes could be registered
+				// before the exception was thrown. So, don't cache the routes, because the routes can now be corrupt/incomplete!
+				return;
+			}
+			if ($this->exception instanceof RestException && $this->exception->getStage() === 'setup') {
+				// An exception has occured during configuration of restler. Maybe we could not add all API-classes correctly!
+				// So, don't cache the routes, because the routes can now be corrupt/incomplete!
+				return;
+			}
+
+			$this->cache->set(
+				'routes',
+				Routes::toArray() +
+				array('apiVersionMap' => $this->apiVersionMap)
+			);
+		}
+	}
+
+	/**
+	 * pre call
+	 *
+	 * call _pre_{methodName)_{extension} if exists with the same parameters as
+	 * the api method
+	 *
+	 * @example _pre_get_json
+	 *
+	 */
+	protected function preCall()
+	{
+		$o = & $this->apiMethodInfo;
+		$preCall = '_pre_' . $o->methodName . '_'
+			. $this->requestFormat->getExtension();
+
+		if (method_exists($o->className, $preCall)) {
+			$this->dispatch('preCall');
+			call_user_func_array(array(
+				Scope::get($o->className),
+				$preCall
+			), $o->parameters);
+		}
+	}
+
+	/**
+	 * post call
+	 *
+	 * call _post_{methodName}_{extension} if exists with the composed and
+	 * serialized (applying the repose format) response data
+	 *
+	 * @example _post_get_json
+	 */
+	protected function postCall()
+	{
+		$o = & $this->apiMethodInfo;
+		$postCall = '_post_' . $o->methodName . '_' .
+			$this->responseFormat->getExtension();
+		if (method_exists($o->className, $postCall)) {
+			$this->dispatch('postCall');
+			$this->responseData = call_user_func(array(
+				Scope::get($o->className),
+				$postCall
+			), $this->responseData);
+		}
+	}
 }

Spacing +60 added lines, -61 removed lines

@@ -110,7 +110,7 @@ 
      *
      * @var int|null when specified it will override @status comment
      */
-    public $responseCode=null;
+    public $responseCode = null;
     /**
      * @var string base url of the api service
      */
@@ -246,8 +246,8 @@ 
         Scope::set('Restler', $this);
         $this->productionMode = $productionMode;
         if (is_null(Defaults::$cacheDirectory)) {
-            Defaults::$cacheDirectory = dirname($_SERVER['SCRIPT_FILENAME']) .
-                DIRECTORY_SEPARATOR . 'cache';
+            Defaults::$cacheDirectory = dirname($_SERVER['SCRIPT_FILENAME']).
+                DIRECTORY_SEPARATOR.'cache';
         }
         $this->cache = new Defaults::$cacheClass();
         $this->refreshCache = $refreshCache;
@@ -313,7 +313,7 @@ 
             }
             $this->respond();
         } catch (Exception $e) {
-            try{
+            try {
                 if (Defaults::$returnResponse) {
                     return $this->message($e);
                 }
@@ -402,19 +402,19 @@ 
             $obj = Scope::get($className);
 
             if (!$obj instanceof iFormat)
-                throw new Exception('Invalid format class; must implement ' .
+                throw new Exception('Invalid format class; must implement '.
                     'iFormat interface');
             if ($throwException && get_class($obj) == get_class($this->requestFormat)) {
                 $throwException = false;
             }
 
             foreach ($obj->getMIMEMap() as $mime => $extension) {
-                if($obj->isWritable()){
-                    $this->writableMimeTypes[]=$mime;
+                if ($obj->isWritable()) {
+                    $this->writableMimeTypes[] = $mime;
                     $extensions[".$extension"] = true;
                 }
-                if($obj->isReadable())
-                    $this->readableMimeTypes[]=$mime;
+                if ($obj->isReadable())
+                    $this->readableMimeTypes[] = $mime;
                 if (!isset($this->formatMap[$extension]))
                     $this->formatMap[$extension] = $className;
                 if (!isset($this->formatMap[$mime]))
@@ -424,7 +424,7 @@ 
         if ($throwException) {
             throw new RestException(
                 403,
-                'Content type `' . $this->requestFormat->getMIME() . '` is not supported.'
+                'Content type `'.$this->requestFormat->getMIME().'` is not supported.'
             );
         }
         $this->formatMap['default'] = $args[0];
@@ -450,7 +450,7 @@ 
             $obj = Scope::get($className);
 
             if (!$obj instanceof iFormat)
-                throw new Exception('Invalid format class; must implement ' .
+                throw new Exception('Invalid format class; must implement '.
                     'iFormat interface');
 
             foreach ($obj->getMIMEMap() as $mime => $extension) {
@@ -458,7 +458,7 @@ 
                     $this->formatOverridesMap[$extension] = $className;
                 if (!isset($this->formatOverridesMap[$mime]))
                     $this->formatOverridesMap[$mime] = $className;
-                if($obj->isWritable())
+                if ($obj->isWritable())
                     $extensions[".$extension"] = true;
             }
         }
@@ -477,7 +477,7 @@ 
     {
         if (func_num_args() > 1) {
             $urls = func_get_args();
-            usort($urls, function ($a, $b) {
+            usort($urls, function($a, $b) {
                 return strlen($a) - strlen($b);
             });
             foreach ($urls as $u) {
@@ -500,7 +500,7 @@ 
         // fix SCRIPT_NAME for PHP 5.4 built-in web server
         if (false === strpos($_SERVER['SCRIPT_NAME'], '.php'))
             $_SERVER['SCRIPT_NAME']
-                = '/' . substr($_SERVER['SCRIPT_FILENAME'], strlen($_SERVER['DOCUMENT_ROOT']) + 1);
+                = '/'.substr($_SERVER['SCRIPT_FILENAME'], strlen($_SERVER['DOCUMENT_ROOT']) + 1);
 
         list($base, $path) = Util::splitCommonPath(
             strtok(urldecode($_SERVER['REQUEST_URI']), '?'), //remove query string
@@ -510,9 +510,9 @@ 
         if (!$this->baseUrl) {
             // Fix port number retrieval if port is specified in HOST header.
             $host = isset($_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : '';
-            $portPos = strpos($host,":");
-            if ($portPos){
-               $port = substr($host,$portPos+1);
+            $portPos = strpos($host, ":");
+            if ($portPos) {
+               $port = substr($host, $portPos + 1);
             } else {
                $port = isset($_SERVER['SERVER_PORT']) ? $_SERVER['SERVER_PORT'] : '80';
                $port = isset($_SERVER['HTTP_X_FORWARDED_PORT']) ? $_SERVER['HTTP_X_FORWARDED_PORT'] : $port; // Amazon ELB
@@ -520,10 +520,10 @@ 
             $https = $port == '443' ||
                 (isset($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https') || // Amazon ELB
                 (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on');
-            $baseUrl = ($https ? 'https://' : 'http://') . $_SERVER['SERVER_NAME'];
+            $baseUrl = ($https ? 'https://' : 'http://').$_SERVER['SERVER_NAME'];
             if (!$https && $port != '80' || $https && $port != '443')
-                $baseUrl .= ':' . $port;
-            $this->baseUrl = $baseUrl . $base;
+                $baseUrl .= ':'.$port;
+            $this->baseUrl = $baseUrl.$base;
         } elseif (!empty($base) && false === strpos($this->baseUrl, $base)) {
             $this->baseUrl .= $base;
         }
@@ -559,7 +559,7 @@ 
      */
     protected function getRequestFormat()
     {
-        $format = null ;
+        $format = null;
         // check if client has sent any information on request format
         if (
             !empty($_SERVER['CONTENT_TYPE']) ||
@@ -591,7 +591,7 @@ 
                 );
             }
         }
-        if(!$format){
+        if (!$format) {
             $format = Scope::get($this->formatMap['default']);
         }
         return $format;
@@ -630,7 +630,7 @@ 
             }
 
             $stream = $this->getRequestStream();
-            if($stream === FALSE)
+            if ($stream === FALSE)
                 return array();
             $r = $this->requestFormat instanceof iDecodeStream
                 ? $this->requestFormat->decodeStream($stream)
@@ -676,7 +676,7 @@ 
         if (!isset($o->className))
             throw new RestException(404);
 
-        if(isset($this->apiVersionMap[$o->className])){
+        if (isset($this->apiVersionMap[$o->className])) {
             Scope::$classAliases[Util::getShortName($o->className)]
                 = $this->apiVersionMap[$o->className][$this->requestedApiVersion];
         }
@@ -723,7 +723,7 @@ 
                 header('Access-Control-Allow-Headers: '
                     . $_SERVER['HTTP_ACCESS_CONTROL_REQUEST_HEADERS']);
 
-            header('Access-Control-Allow-Origin: ' .
+            header('Access-Control-Allow-Origin: '.
                 ((Defaults::$accessControlAllowOrigin == '*' && isset($_SERVER['HTTP_ORIGIN']))
                     ? $_SERVER['HTTP_ORIGIN'] : Defaults::$accessControlAllowOrigin));
             header('Access-Control-Allow-Credentials: true');
@@ -752,7 +752,7 @@ 
         //check if the api method insists on response format using @format comment
 
         if ($metadata && isset($metadata['format'])) {
-            $formats = explode(',', (string)$metadata['format']);
+            $formats = explode(',', (string) $metadata['format']);
             foreach ($formats as $i => $f) {
                 $f = trim($f);
                 if (!in_array($f, $this->formatOverridesMap))
@@ -800,7 +800,7 @@ 
                     if (is_string(Defaults::$apiVendor)
                         && 0 === stripos($mime,
                             'application/vnd.'
-                            . Defaults::$apiVendor . '-v')
+                            . Defaults::$apiVendor.'-v')
                     ) {
                         $extension = substr($accept, $index + 1);
                         if (isset($this->formatMap[$extension])) {
@@ -846,8 +846,8 @@ 
             $this->responseFormat = $format;
             throw new RestException(
                 406,
-                'Content negotiation failed. ' .
-                'Try `' . $format->getMIME() . '` instead.'
+                'Content negotiation failed. '.
+                'Try `'.$format->getMIME().'` instead.'
             );
         } else {
             // Tell cache content is based at Accept header
@@ -874,7 +874,7 @@ 
                 } else {
                     throw new RestException(
                         406,
-                        'Content negotiation failed. ' .
+                        'Content negotiation failed. '.
                         'Requested charset is not supported'
                     );
                 }
@@ -922,8 +922,8 @@ 
             $filterObj = Scope::get($filterClass);
 
             if (!$filterObj instanceof iFilter) {
-                throw new RestException (
-                    500, 'Filter Class ' .
+                throw new RestException(
+                    500, 'Filter Class '.
                     'should implement iFilter');
             } else if (!($ok = $filterObj->__isAllowed())) {
                 if (is_null($ok)
@@ -955,8 +955,8 @@ 
                 try {
                     $authObj = Scope::get($authClass);
                     if (!method_exists($authObj, Defaults::$authenticationMethod)) {
-                        throw new RestException (
-                            500, 'Authentication Class ' .
+                        throw new RestException(
+                            500, 'Authentication Class '.
                             'should implement iAuthenticate');
                     } elseif (
                     !$authObj->{Defaults::$authenticationMethod}()
@@ -992,7 +992,7 @@ 
      */
     protected function postAuthFilter()
     {
-        if(empty($this->postAuthFilterClasses)) {
+        if (empty($this->postAuthFilterClasses)) {
             return;
         }
         $this->dispatch('postAuthFilter');
@@ -1051,7 +1051,7 @@ 
             $o->accessLevel);
         if (function_exists('newrelic_name_transaction'))
             newrelic_name_transaction("{$o->className}/{$o->methodName}");
-        $object =  Scope::get($o->className);
+        $object = Scope::get($o->className);
         switch ($accessLevel) {
             case 3 : //protected method
                 $reflectionMethod = new \ReflectionMethod(
@@ -1094,7 +1094,7 @@ 
     {
         //only GET method should be cached if allowed by API developer
         $expires = $this->requestMethod == 'GET' ? Defaults::$headerExpires : 0;
-        if(!is_array(Defaults::$headerCacheControl))
+        if (!is_array(Defaults::$headerCacheControl))
             Defaults::$headerCacheControl = array(Defaults::$headerCacheControl);
         $cacheControl = Defaults::$headerCacheControl[0];
         if ($expires > 0) {
@@ -1104,14 +1104,14 @@ 
             $cacheControl = str_replace('{expires}', $expires, $cacheControl);
             $expires = gmdate('D, d M Y H:i:s \G\M\T', time() + $expires);
         }
-        @header('Cache-Control: ' . $cacheControl);
-        @header('Expires: ' . $expires);
-        @header('X-Powered-By: Luracast Restler v' . Restler::VERSION);
+        @header('Cache-Control: '.$cacheControl);
+        @header('Expires: '.$expires);
+        @header('X-Powered-By: Luracast Restler v'.Restler::VERSION);
 
         if (Defaults::$crossOriginResourceSharing
             && isset($_SERVER['HTTP_ORIGIN'])
         ) {
-            header('Access-Control-Allow-Origin: ' .
+            header('Access-Control-Allow-Origin: '.
                 (Defaults::$accessControlAllowOrigin == '*'
                     ? $_SERVER['HTTP_ORIGIN']
                     : Defaults::$accessControlAllowOrigin)
@@ -1122,19 +1122,19 @@ 
 
         $this->responseFormat->setCharset(Defaults::$charset);
         $charset = $this->responseFormat->getCharset()
-            ? : Defaults::$charset;
+            ?: Defaults::$charset;
 
-        @header('Content-Type: ' . (
+        @header('Content-Type: '.(
             Defaults::$useVendorMIMEVersioning
                 ? 'application/vnd.'
                 . Defaults::$apiVendor
                 . "-v{$this->requestedApiVersion}"
-                . '+' . $this->responseFormat->getExtension()
+                . '+'.$this->responseFormat->getExtension()
                 : $this->responseFormat->getMIME())
-            . '; charset=' . $charset
+            . '; charset='.$charset
         );
 
-        @header('Content-Language: ' . Defaults::$language);
+        @header('Content-Language: '.Defaults::$language);
 
         if (isset($this->apiMethodInfo->metadata['header'])) {
             foreach ($this->apiMethodInfo->metadata['header'] as $header)
@@ -1152,7 +1152,7 @@ 
         }
         $this->responseCode = $code;
         @header(
-            "{$_SERVER['SERVER_PROTOCOL']} $code " .
+            "{$_SERVER['SERVER_PROTOCOL']} $code ".
             (isset(RestException::$codes[$code]) ? RestException::$codes[$code] : '')
         );
     }
@@ -1171,7 +1171,7 @@ 
             $authString = count($this->authClasses)
                 ? Scope::get($this->authClasses[0])->__getWWWAuthenticateString()
                 : 'Unknown';
-            @header('WWW-Authenticate: ' . $authString, false);
+            @header('WWW-Authenticate: '.$authString, false);
         }
         $this->dispatch('complete');
         if (Defaults::$returnResponse) {
@@ -1197,7 +1197,7 @@ 
 
         $this->exception = $exception;
 
-        $method = 'handle' . $exception->getCode();
+        $method = 'handle'.$exception->getCode();
         $handled = false;
         foreach ($this->errorClasses as $className) {
             if (method_exists($className, $method)) {
@@ -1255,8 +1255,7 @@ 
     public function setAPIVersion($version = 1, $minimum = 1)
     {
         if (!is_int($version) && $version < 1) {
-            throw new InvalidArgumentException
-            ('version should be an integer greater than 0');
+            throw new InvalidArgumentException('version should be an integer greater than 0');
         }
         $this->apiVersion = $version;
         if (is_int($minimum)) {
@@ -1311,7 +1310,7 @@ 
      */
     public function addAPIClass($className, $resourcePath = null)
     {
-        try{
+        try {
             if ($this->productionMode && is_null($this->cached)) {
                 $routes = $this->cache->get('routes');
                 if (isset($routes) && is_array($routes)) {
@@ -1341,12 +1340,12 @@ 
                 //versioned api
                 if (false !== ($index = strrpos($className, '\\'))) {
                     $name = substr($className, 0, $index)
-                        . '\\v{$version}' . substr($className, $index);
+                        . '\\v{$version}'.substr($className, $index);
                 } else if (false !== ($index = strrpos($className, '_'))) {
                     $name = substr($className, 0, $index)
-                        . '_v{$version}' . substr($className, $index);
+                        . '_v{$version}'.substr($className, $index);
                 } else {
-                    $name = 'v{$version}\\' . $className;
+                    $name = 'v{$version}\\'.$className;
                 }
 
                 for ($version = $this->apiMinimumVersion;
@@ -1478,13 +1477,13 @@ 
                     //versioned api
                     if (false !== ($index = strrpos($className, '\\'))) {
                         $name = substr($className, 0, $index)
-                            . '\\v{$version}' . substr($className, $index);
+                            . '\\v{$version}'.substr($className, $index);
                     } else {
                         if (false !== ($index = strrpos($className, '_'))) {
                             $name = substr($className, 0, $index)
-                                . '_v{$version}' . substr($className, $index);
+                                . '_v{$version}'.substr($className, $index);
                         } else {
-                            $name = 'v{$version}\\' . $className;
+                            $name = 'v{$version}\\'.$className;
                         }
                     }
 
@@ -1524,7 +1523,7 @@ 
             }
         } catch (Exception $e) {
             $e = new Exception(
-                "mapAPIClasses failed. " . $e->getMessage(),
+                "mapAPIClasses failed. ".$e->getMessage(),
                 $e->getCode(),
                 $e
             );
@@ -1653,7 +1652,7 @@ 
     protected function preCall()
     {
         $o = & $this->apiMethodInfo;
-        $preCall = '_pre_' . $o->methodName . '_'
+        $preCall = '_pre_'.$o->methodName.'_'
             . $this->requestFormat->getExtension();
 
         if (method_exists($o->className, $preCall)) {
@@ -1676,7 +1675,7 @@ 
     protected function postCall()
     {
         $o = & $this->apiMethodInfo;
-        $postCall = '_post_' . $o->methodName . '_' .
+        $postCall = '_post_'.$o->methodName.'_'.
             $this->responseFormat->getExtension();
         if (method_exists($o->className, $postCall)) {
             $this->dispatch('postCall');

Braces +66 added lines, -45 removed lines

@@ -284,8 +284,9 @@ 
                     $this->route();
                     throw $e;
                 }
-                if (Defaults::$useVendorMIMEVersioning)
-                    $this->responseFormat = $this->negotiateResponseFormat();
+                if (Defaults::$useVendorMIMEVersioning) {
+                                    $this->responseFormat = $this->negotiateResponseFormat();
+                }
                 $this->route();
             } catch (Exception $e) {
                 $this->negotiate();
@@ -401,9 +402,10 @@ 
 
             $obj = Scope::get($className);
 
-            if (!$obj instanceof iFormat)
-                throw new Exception('Invalid format class; must implement ' .
+            if (!$obj instanceof iFormat) {
+                            throw new Exception('Invalid format class; must implement ' .
                     'iFormat interface');
+            }
             if ($throwException && get_class($obj) == get_class($this->requestFormat)) {
                 $throwException = false;
             }
@@ -413,12 +415,15 @@ 
                     $this->writableMimeTypes[]=$mime;
                     $extensions[".$extension"] = true;
                 }
-                if($obj->isReadable())
-                    $this->readableMimeTypes[]=$mime;
-                if (!isset($this->formatMap[$extension]))
-                    $this->formatMap[$extension] = $className;
-                if (!isset($this->formatMap[$mime]))
-                    $this->formatMap[$mime] = $className;
+                if($obj->isReadable()) {
+                                    $this->readableMimeTypes[]=$mime;
+                }
+                if (!isset($this->formatMap[$extension])) {
+                                    $this->formatMap[$extension] = $className;
+                }
+                if (!isset($this->formatMap[$mime])) {
+                                    $this->formatMap[$mime] = $className;
+                }
             }
         }
         if ($throwException) {
@@ -449,17 +454,21 @@ 
 
             $obj = Scope::get($className);
 
-            if (!$obj instanceof iFormat)
-                throw new Exception('Invalid format class; must implement ' .
+            if (!$obj instanceof iFormat) {
+                            throw new Exception('Invalid format class; must implement ' .
                     'iFormat interface');
+            }
 
             foreach ($obj->getMIMEMap() as $mime => $extension) {
-                if (!isset($this->formatOverridesMap[$extension]))
-                    $this->formatOverridesMap[$extension] = $className;
-                if (!isset($this->formatOverridesMap[$mime]))
-                    $this->formatOverridesMap[$mime] = $className;
-                if($obj->isWritable())
-                    $extensions[".$extension"] = true;
+                if (!isset($this->formatOverridesMap[$extension])) {
+                                    $this->formatOverridesMap[$extension] = $className;
+                }
+                if (!isset($this->formatOverridesMap[$mime])) {
+                                    $this->formatOverridesMap[$mime] = $className;
+                }
+                if($obj->isWritable()) {
+                                    $extensions[".$extension"] = true;
+                }
             }
         }
         $this->formatOverridesMap['extensions'] = array_keys($extensions);
@@ -498,9 +507,10 @@ 
     protected function getPath()
     {
         // fix SCRIPT_NAME for PHP 5.4 built-in web server
-        if (false === strpos($_SERVER['SCRIPT_NAME'], '.php'))
-            $_SERVER['SCRIPT_NAME']
+        if (false === strpos($_SERVER['SCRIPT_NAME'], '.php')) {
+                    $_SERVER['SCRIPT_NAME']
                 = '/' . substr($_SERVER['SCRIPT_FILENAME'], strlen($_SERVER['DOCUMENT_ROOT']) + 1);
+        }
 
         list($base, $path) = Util::splitCommonPath(
             strtok(urldecode($_SERVER['REQUEST_URI']), '?'), //remove query string
@@ -521,8 +531,9 @@ 
                 (isset($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https') || // Amazon ELB
                 (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on');
             $baseUrl = ($https ? 'https://' : 'http://') . $_SERVER['SERVER_NAME'];
-            if (!$https && $port != '80' || $https && $port != '443')
-                $baseUrl .= ':' . $port;
+            if (!$https && $port != '80' || $https && $port != '443') {
+                            $baseUrl .= ':' . $port;
+            }
             $this->baseUrl = $baseUrl . $base;
         } elseif (!empty($base) && false === strpos($this->baseUrl, $base)) {
             $this->baseUrl .= $base;
@@ -572,9 +583,9 @@ 
             if (false !== $pos = strpos($mime, ';')) {
                 $mime = substr($mime, 0, $pos);
             }
-            if ($mime == UrlEncodedFormat::MIME)
-                $format = Scope::get('UrlEncodedFormat');
-            elseif (isset($this->formatMap[$mime])) {
+            if ($mime == UrlEncodedFormat::MIME) {
+                            $format = Scope::get('UrlEncodedFormat');
+            } elseif (isset($this->formatMap[$mime])) {
                 $format = Scope::get($this->formatMap[$mime]);
                 $format->setMIME($mime);
             } elseif (!$this->requestFormatDiffered && isset($this->formatOverridesMap[$mime])) {
@@ -630,8 +641,9 @@ 
             }
 
             $stream = $this->getRequestStream();
-            if($stream === FALSE)
-                return array();
+            if($stream === FALSE) {
+                            return array();
+            }
             $r = $this->requestFormat instanceof iDecodeStream
                 ? $this->requestFormat->decodeStream($stream)
                 : $this->requestFormat->decode(stream_get_contents($stream));
@@ -673,8 +685,9 @@ 
                 }
             }
         }
-        if (!isset($o->className))
-            throw new RestException(404);
+        if (!isset($o->className)) {
+                    throw new RestException(404);
+        }
 
         if(isset($this->apiVersionMap[$o->className])){
             Scope::$classAliases[Util::getShortName($o->className)]
@@ -715,13 +728,15 @@ 
             $this->requestMethod == 'OPTIONS'
             && Defaults::$crossOriginResourceSharing
         ) {
-            if (isset($_SERVER['HTTP_ACCESS_CONTROL_REQUEST_METHOD']))
-                header('Access-Control-Allow-Methods: '
+            if (isset($_SERVER['HTTP_ACCESS_CONTROL_REQUEST_METHOD'])) {
+                            header('Access-Control-Allow-Methods: '
                     . Defaults::$accessControlAllowMethods);
+            }
 
-            if (isset($_SERVER['HTTP_ACCESS_CONTROL_REQUEST_HEADERS']))
-                header('Access-Control-Allow-Headers: '
+            if (isset($_SERVER['HTTP_ACCESS_CONTROL_REQUEST_HEADERS'])) {
+                            header('Access-Control-Allow-Headers: '
                     . $_SERVER['HTTP_ACCESS_CONTROL_REQUEST_HEADERS']);
+            }
 
             header('Access-Control-Allow-Origin: ' .
                 ((Defaults::$accessControlAllowOrigin == '*' && isset($_SERVER['HTTP_ORIGIN']))
@@ -755,11 +770,12 @@ 
             $formats = explode(',', (string)$metadata['format']);
             foreach ($formats as $i => $f) {
                 $f = trim($f);
-                if (!in_array($f, $this->formatOverridesMap))
-                    throw new RestException(
+                if (!in_array($f, $this->formatOverridesMap)) {
+                                    throw new RestException(
                         500,
                         "Given @format is not present in overriding formats. Please call `\$r->setOverridingFormats('$f');` first."
                     );
+                }
                 $formats[$i] = $f;
             }
             call_user_func_array(array($this, 'setSupportedFormats'), $formats);
@@ -1032,8 +1048,9 @@ 
                 }
                 $valid = $o->parameters[$index];
                 $o->parameters[$index] = null;
-                if (empty(Validator::$exceptions))
-                    $o->metadata['param'][$index]['autofocus'] = true;
+                if (empty(Validator::$exceptions)) {
+                                    $o->metadata['param'][$index]['autofocus'] = true;
+                }
                 $valid = $validator::validate(
                     $valid, $info
                 );
@@ -1049,8 +1066,9 @@ 
         $o = & $this->apiMethodInfo;
         $accessLevel = max(Defaults::$apiAccessLevel,
             $o->accessLevel);
-        if (function_exists('newrelic_name_transaction'))
-            newrelic_name_transaction("{$o->className}/{$o->methodName}");
+        if (function_exists('newrelic_name_transaction')) {
+                    newrelic_name_transaction("{$o->className}/{$o->methodName}");
+        }
         $object =  Scope::get($o->className);
         switch ($accessLevel) {
             case 3 : //protected method
@@ -1094,8 +1112,9 @@ 
     {
         //only GET method should be cached if allowed by API developer
         $expires = $this->requestMethod == 'GET' ? Defaults::$headerExpires : 0;
-        if(!is_array(Defaults::$headerCacheControl))
-            Defaults::$headerCacheControl = array(Defaults::$headerCacheControl);
+        if(!is_array(Defaults::$headerCacheControl)) {
+                    Defaults::$headerCacheControl = array(Defaults::$headerCacheControl);
+        }
         $cacheControl = Defaults::$headerCacheControl[0];
         if ($expires > 0) {
             $cacheControl = $this->apiMethodInfo->accessLevel
@@ -1137,8 +1156,9 @@ 
         @header('Content-Language: ' . Defaults::$language);
 
         if (isset($this->apiMethodInfo->metadata['header'])) {
-            foreach ($this->apiMethodInfo->metadata['header'] as $header)
-                @header($header, true);
+            foreach ($this->apiMethodInfo->metadata['header'] as $header) {
+                            @header($header, true);
+            }
         }
         $code = 200;
         if (!Defaults::$suppressResponseCode) {
@@ -1202,8 +1222,9 @@ 
         foreach ($this->errorClasses as $className) {
             if (method_exists($className, $method)) {
                 $obj = Scope::get($className);
-                if ($obj->$method($exception))
-                    $handled = true;
+                if ($obj->$method($exception)) {
+                                    $handled = true;
+                }
             }
         }
         if ($handled) {