Dolibarr / dolibarr

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

Indentation +14 added lines, -14 removed lines

@@ -14,19 +14,19 @@
  */
 interface iValidate {
 
-    /**
-     * method used for validation.
-     *
-     * @param mixed $input
-     *            data that needs to be validated
-     * @param ValidationInfo $info
-     *            information to be used for validation
-     * @return boolean false in case of failure or fixed value in the expected
-     *         type
-     * @throws \Luracast\Restler\RestException 400 with information about the
-     * failed
-     * validation
-     */
-    public static function validate($input, ValidationInfo $info);
+	/**
+	 * method used for validation.
+	 *
+	 * @param mixed $input
+	 *            data that needs to be validated
+	 * @param ValidationInfo $info
+	 *            information to be used for validation
+	 * @return boolean false in case of failure or fixed value in the expected
+	 *         type
+	 * @throws \Luracast\Restler\RestException 400 with information about the
+	 * failed
+	 * validation
+	 */
+	public static function validate($input, ValidationInfo $info);
 }
 

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

Indentation +132 added lines, -132 removed lines

@@ -15,143 +15,143 @@
  */
 class Obj
 {
-    /**
-     * @var bool|string|callable
-     */
-    public static $stringEncoderFunction = false;
-    /**
-     * @var bool|string|callable
-     */
-    public static $numberEncoderFunction = false;
-    /**
-     * @var array key value pairs for fixing value types using functions.
-     * For example
-     *
-     *      'id'=>'intval'      will make sure all values of the id properties
-     *                          will be converted to integers intval function
-     *      'password'=> null   will remove all the password entries
-     */
-    public static $fix = array();
-    /**
-     * @var string character that is used to identify sub objects
-     *
-     * For example
-     *
-     * when Object::$separatorChar = '.';
-     *
-     * array('my.object'=>true) will result in
-     *
-     * array(
-     *    'my'=>array('object'=>true)
-     * );
-     */
-    public static $separatorChar = null;
-    /**
-     * @var bool set it to true when empty arrays, blank strings, null values
-     * to be automatically removed from response
-     */
-    public static $removeEmpty = false;
-    /**
-     * @var bool set it to true to remove all null values from the result
-     */
-    public static $removeNull = false;
+	/**
+	 * @var bool|string|callable
+	 */
+	public static $stringEncoderFunction = false;
+	/**
+	 * @var bool|string|callable
+	 */
+	public static $numberEncoderFunction = false;
+	/**
+	 * @var array key value pairs for fixing value types using functions.
+	 * For example
+	 *
+	 *      'id'=>'intval'      will make sure all values of the id properties
+	 *                          will be converted to integers intval function
+	 *      'password'=> null   will remove all the password entries
+	 */
+	public static $fix = array();
+	/**
+	 * @var string character that is used to identify sub objects
+	 *
+	 * For example
+	 *
+	 * when Object::$separatorChar = '.';
+	 *
+	 * array('my.object'=>true) will result in
+	 *
+	 * array(
+	 *    'my'=>array('object'=>true)
+	 * );
+	 */
+	public static $separatorChar = null;
+	/**
+	 * @var bool set it to true when empty arrays, blank strings, null values
+	 * to be automatically removed from response
+	 */
+	public static $removeEmpty = false;
+	/**
+	 * @var bool set it to true to remove all null values from the result
+	 */
+	public static $removeNull = false;
 
-    /**
-     * Convenience function that converts the given object
-     * in to associative array
-     *
-     * @static
-     *
-     * @param mixed $object                          that needs to be converted
-     *
-     * @param bool  $forceObjectTypeWhenEmpty        when set to true outputs
-     *                                               actual type  (array or
-     *                                               object) rather than
-     *                                               always an array when the
-     *                                               array/object is empty
-     *
-     * @return array
-     */
-    public static function toArray($object,
-                                   $forceObjectTypeWhenEmpty = false)
-    {
-        //if ($object instanceof JsonSerializable) { //wont work on PHP < 5.4
-        if (is_object($object)) {
-            if (method_exists($object, 'jsonSerialize')) {
-                $object = $object->jsonSerialize();
-            } elseif (method_exists($object, '__sleep')) {
-                $properties = $object->__sleep();
-                $array = array();
-                foreach ($properties as $key) {
-                    $value = self::toArray($object->{$key},
-                        $forceObjectTypeWhenEmpty);
-                    if (self::$stringEncoderFunction && is_string($value)) {
-                        $value = self::$stringEncoderFunction ($value);
-                    } elseif (self::$numberEncoderFunction && is_numeric($value)) {
-                        $value = self::$numberEncoderFunction ($value);
-                    }
-                    $array [$key] = $value;
-                }
-                return $array;
-            }
-        }
-        if (is_array($object) || is_object($object)) {
-            $count = 0;
-            $array = array();
-            foreach ($object as $key => $value) {
-                if (
-                    is_string(self::$separatorChar) &&
-                    false !== strpos($key, self::$separatorChar)
-                ) {
-                    list($key, $obj) = explode(self::$separatorChar, $key, 2);
-                    $object[$key][$obj] = $value;
-                    $value = $object[$key];
-                }
-                if (self::$removeEmpty && empty($value) && !is_numeric($value) && !is_bool($value)) {
-                    continue;
-                } elseif (self::$removeNull && is_null($value)) {
-                    continue;
-                }
-                if (array_key_exists($key, self::$fix)) {
-                    if (isset(self::$fix[$key])) {
-                        $value = call_user_func(self::$fix[$key], $value);
-                    } else {
-                        continue;
-                    }
-                }
-                $value = self::toArray($value, $forceObjectTypeWhenEmpty);
-                if (self::$stringEncoderFunction && is_string($value)) {
-                    $value = self::$encoderFunctionName ($value);
-                } elseif (self::$numberEncoderFunction && is_numeric($value)) {
-                    $value = self::$numberEncoderFunction ($value);
-                }
-                $array [$key] = $value;
-                $count++;
-            }
-            return $forceObjectTypeWhenEmpty && $count == 0 ? $object : $array;
-        }
+	/**
+	 * Convenience function that converts the given object
+	 * in to associative array
+	 *
+	 * @static
+	 *
+	 * @param mixed $object                          that needs to be converted
+	 *
+	 * @param bool  $forceObjectTypeWhenEmpty        when set to true outputs
+	 *                                               actual type  (array or
+	 *                                               object) rather than
+	 *                                               always an array when the
+	 *                                               array/object is empty
+	 *
+	 * @return array
+	 */
+	public static function toArray($object,
+								   $forceObjectTypeWhenEmpty = false)
+	{
+		//if ($object instanceof JsonSerializable) { //wont work on PHP < 5.4
+		if (is_object($object)) {
+			if (method_exists($object, 'jsonSerialize')) {
+				$object = $object->jsonSerialize();
+			} elseif (method_exists($object, '__sleep')) {
+				$properties = $object->__sleep();
+				$array = array();
+				foreach ($properties as $key) {
+					$value = self::toArray($object->{$key},
+						$forceObjectTypeWhenEmpty);
+					if (self::$stringEncoderFunction && is_string($value)) {
+						$value = self::$stringEncoderFunction ($value);
+					} elseif (self::$numberEncoderFunction && is_numeric($value)) {
+						$value = self::$numberEncoderFunction ($value);
+					}
+					$array [$key] = $value;
+				}
+				return $array;
+			}
+		}
+		if (is_array($object) || is_object($object)) {
+			$count = 0;
+			$array = array();
+			foreach ($object as $key => $value) {
+				if (
+					is_string(self::$separatorChar) &&
+					false !== strpos($key, self::$separatorChar)
+				) {
+					list($key, $obj) = explode(self::$separatorChar, $key, 2);
+					$object[$key][$obj] = $value;
+					$value = $object[$key];
+				}
+				if (self::$removeEmpty && empty($value) && !is_numeric($value) && !is_bool($value)) {
+					continue;
+				} elseif (self::$removeNull && is_null($value)) {
+					continue;
+				}
+				if (array_key_exists($key, self::$fix)) {
+					if (isset(self::$fix[$key])) {
+						$value = call_user_func(self::$fix[$key], $value);
+					} else {
+						continue;
+					}
+				}
+				$value = self::toArray($value, $forceObjectTypeWhenEmpty);
+				if (self::$stringEncoderFunction && is_string($value)) {
+					$value = self::$encoderFunctionName ($value);
+				} elseif (self::$numberEncoderFunction && is_numeric($value)) {
+					$value = self::$numberEncoderFunction ($value);
+				}
+				$array [$key] = $value;
+				$count++;
+			}
+			return $forceObjectTypeWhenEmpty && $count == 0 ? $object : $array;
+		}
 
-        return $object;
-    }
+		return $object;
+	}
 
-    public function __get($name)
-    {
-        isset(self::$fix[$name]) ? self::$fix[$name] : null;
-    }
+	public function __get($name)
+	{
+		isset(self::$fix[$name]) ? self::$fix[$name] : null;
+	}
 
-    public function __set($name, $function)
-    {
-        self::$fix[$name] = $function;
-    }
+	public function __set($name, $function)
+	{
+		self::$fix[$name] = $function;
+	}
 
-    public function __isset($name)
-    {
-        return isset(self::$fix[$name]);
-    }
+	public function __isset($name)
+	{
+		return isset(self::$fix[$name]);
+	}
 
-    public function __unset($name)
-    {
-        unset(self::$fix[$name]);
-    }
+	public function __unset($name)
+	{
+		unset(self::$fix[$name]);
+	}
 }
 

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

Indentation +38 added lines, -38 removed lines

@@ -16,46 +16,46 @@
 class ValueObject implements iValueObject
 {
 
-    public function __toString()
-    {
-        return ' new ' . get_called_class() . '() ';
-    }
+	public function __toString()
+	{
+		return ' new ' . get_called_class() . '() ';
+	}
 
-    public static function __set_state(array $properties)
-    {
-        $class = get_called_class();
-        $instance = new $class ();
-        $vars = get_object_vars($instance);
-        foreach ($properties as $property => $value) {
-            if (property_exists($instance, $property)) {
-                // see if the property is accessible
-                if (array_key_exists($property, $vars)) {
-                    $instance->{$property} = $value;
-                } else {
-                    $method = 'set' . ucfirst($property);
-                    if (method_exists($instance, $method)) {
-                        call_user_func(array(
-                            $instance,
-                            $method
-                        ), $value);
-                    }
-                }
-            }
-        }
-        return $instance;
-    }
+	public static function __set_state(array $properties)
+	{
+		$class = get_called_class();
+		$instance = new $class ();
+		$vars = get_object_vars($instance);
+		foreach ($properties as $property => $value) {
+			if (property_exists($instance, $property)) {
+				// see if the property is accessible
+				if (array_key_exists($property, $vars)) {
+					$instance->{$property} = $value;
+				} else {
+					$method = 'set' . ucfirst($property);
+					if (method_exists($instance, $method)) {
+						call_user_func(array(
+							$instance,
+							$method
+						), $value);
+					}
+				}
+			}
+		}
+		return $instance;
+	}
 
-    public function __toArray()
-    {
-        $r = get_object_vars($this);
-        $methods = get_class_methods($this);
-        foreach ($methods as $m) {
-            if (substr($m, 0, 3) == 'get') {
-                $r [lcfirst(substr($m, 3))] = @$this->{$m} ();
-            }
-        }
-        return $r;
-    }
+	public function __toArray()
+	{
+		$r = get_object_vars($this);
+		$methods = get_class_methods($this);
+		foreach ($methods as $m) {
+			if (substr($m, 0, 3) == 'get') {
+				$r [lcfirst(substr($m, 3))] = @$this->{$m} ();
+			}
+		}
+		return $r;
+	}
 
 }
 

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

Indentation +18 added lines, -18 removed lines

@@ -16,24 +16,24 @@
 interface iValueObject
 {
 
-    /**
-     * This static method is called for creating an instance of the class by
-     * passing the initiation values as an array.
-     *
-     * @static
-     * @abstract
-     *
-     * @param array $properties
-     *
-     * @return iValueObject
-     */
-    public static function __set_state(array $properties);
+	/**
+	 * This static method is called for creating an instance of the class by
+	 * passing the initiation values as an array.
+	 *
+	 * @static
+	 * @abstract
+	 *
+	 * @param array $properties
+	 *
+	 * @return iValueObject
+	 */
+	public static function __set_state(array $properties);
 
-    /**
-     * This method provides a string representation for the instance
-     *
-     * @return string
-     */
-    public function __toString();
+	/**
+	 * This method provides a string representation for the instance
+	 *
+	 * @return string
+	 */
+	public function __toString();
 }
 

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

Indentation +37 added lines, -37 removed lines

@@ -15,41 +15,41 @@
  */
 class ApiMethodInfo extends ValueObject
 {
-    /**
-     * @var string target url
-     */
-    public $url;
-    /**
-     * @var string
-     */
-    public $className;
-    /**
-     * @var string
-     */
-    public $methodName;
-    /**
-     * @var array parameters to be passed to the api method
-     */
-    public $parameters = array();
-    /**
-     * @var array information on parameters in the form of array(name => index)
-     */
-    public $arguments = array();
-    /**
-     * @var array default values for parameters if any
-     * in the form of array(index => value)
-     */
-    public $defaults = array();
-    /**
-     * @var array key => value pair of method meta information
-     */
-    public $metadata = array();
-    /**
-     * @var int access level
-     * 0 - @public - available for all
-     * 1 - @hybrid - both public and protected (enhanced info for authorized)
-     * 2 - @protected comment - only for authenticated users
-     * 3 - protected method - only for authenticated users
-     */
-    public $accessLevel = 0;
+	/**
+	 * @var string target url
+	 */
+	public $url;
+	/**
+	 * @var string
+	 */
+	public $className;
+	/**
+	 * @var string
+	 */
+	public $methodName;
+	/**
+	 * @var array parameters to be passed to the api method
+	 */
+	public $parameters = array();
+	/**
+	 * @var array information on parameters in the form of array(name => index)
+	 */
+	public $arguments = array();
+	/**
+	 * @var array default values for parameters if any
+	 * in the form of array(index => value)
+	 */
+	public $defaults = array();
+	/**
+	 * @var array key => value pair of method meta information
+	 */
+	public $metadata = array();
+	/**
+	 * @var int access level
+	 * 0 - @public - available for all
+	 * 1 - @hybrid - both public and protected (enhanced info for authorized)
+	 * 2 - @protected comment - only for authenticated users
+	 * 3 - protected method - only for authenticated users
+	 */
+	public $accessLevel = 0;
 }
\ No newline at end of file

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

Indentation +675 added lines, -675 removed lines

@@ -22,706 +22,706 @@
  */
 class Validator implements iValidate
 {
-    public static $holdException = false;
-    public static $exceptions = array();
+	public static $holdException = false;
+	public static $exceptions = array();
 
-    public static $preFilters = array(
-        //'*'            => 'some_global_filter', //applied to all parameters
-        'string' => 'trim', //apply filter function by type (string)
-        //'string'       => 'strip_tags',
-        //'string'       => 'htmlspecialchars',
-        //'int'          => 'abs',
-        //'float'        => 'abs',
-        //'CustomClass'  => 'MyFilterClass::custom',
-        //                  please note that you wont get an instance
-        //                  of CustomClass. you will get an array instead
-    );
+	public static $preFilters = array(
+		//'*'            => 'some_global_filter', //applied to all parameters
+		'string' => 'trim', //apply filter function by type (string)
+		//'string'       => 'strip_tags',
+		//'string'       => 'htmlspecialchars',
+		//'int'          => 'abs',
+		//'float'        => 'abs',
+		//'CustomClass'  => 'MyFilterClass::custom',
+		//                  please note that you wont get an instance
+		//                  of CustomClass. you will get an array instead
+	);
 
-    /**
-     * Validate alphabetic characters.
-     *
-     * Check that given value contains only alphabetic characters.
-     *
-     * @param                $input
-     * @param ValidationInfo $info
-     *
-     * @return string
-     *
-     * @throws Invalid
-     */
-    public static function alpha($input, ValidationInfo $info = null)
-    {
-        if (ctype_alpha($input)) {
-            return $input;
-        }
-        if ($info && $info->fix) {
-            //remove non alpha characters
-            return preg_replace("/[^a-z]/i", "", $input);
-        }
-        throw new Invalid('Expecting only alphabetic characters.');
-    }
+	/**
+	 * Validate alphabetic characters.
+	 *
+	 * Check that given value contains only alphabetic characters.
+	 *
+	 * @param                $input
+	 * @param ValidationInfo $info
+	 *
+	 * @return string
+	 *
+	 * @throws Invalid
+	 */
+	public static function alpha($input, ValidationInfo $info = null)
+	{
+		if (ctype_alpha($input)) {
+			return $input;
+		}
+		if ($info && $info->fix) {
+			//remove non alpha characters
+			return preg_replace("/[^a-z]/i", "", $input);
+		}
+		throw new Invalid('Expecting only alphabetic characters.');
+	}
 
-    /**
-     * Validate UUID strings.
-     *
-     * Check that given value contains only alpha numeric characters and the length is 36 chars.
-     *
-     * @param                $input
-     * @param ValidationInfo $info
-     *
-     * @return string
-     *
-     * @throws Invalid
-     */
-    public static function uuid($input, ValidationInfo $info = null)
-    {
-        if (is_string($input) && preg_match(
-                '/^\{?[0-9a-f]{8}\-?[0-9a-f]{4}\-?[0-9a-f]{4}\-?[0-9a-f]{4}\-?[0-9a-f]{12}\}?$/i',
-                $input
-            )) {
-            return strtolower($input);
-        }
-        throw new Invalid('Expecting a Universally Unique IDentifier (UUID) string.');
-    }
+	/**
+	 * Validate UUID strings.
+	 *
+	 * Check that given value contains only alpha numeric characters and the length is 36 chars.
+	 *
+	 * @param                $input
+	 * @param ValidationInfo $info
+	 *
+	 * @return string
+	 *
+	 * @throws Invalid
+	 */
+	public static function uuid($input, ValidationInfo $info = null)
+	{
+		if (is_string($input) && preg_match(
+				'/^\{?[0-9a-f]{8}\-?[0-9a-f]{4}\-?[0-9a-f]{4}\-?[0-9a-f]{4}\-?[0-9a-f]{12}\}?$/i',
+				$input
+			)) {
+			return strtolower($input);
+		}
+		throw new Invalid('Expecting a Universally Unique IDentifier (UUID) string.');
+	}
 
-    /**
-     * Validate alpha numeric characters.
-     *
-     * Check that given value contains only alpha numeric characters.
-     *
-     * @param                $input
-     * @param ValidationInfo $info
-     *
-     * @return string
-     *
-     * @throws Invalid
-     */
-    public static function alphanumeric($input, ValidationInfo $info = null)
-    {
-        if (ctype_alnum($input)) {
-            return $input;
-        }
-        if ($info && $info->fix) {
-            //remove non alpha numeric and space characters
-            return preg_replace("/[^a-z0-9 ]/i", "", $input);
-        }
-        throw new Invalid('Expecting only alpha numeric characters.');
-    }
+	/**
+	 * Validate alpha numeric characters.
+	 *
+	 * Check that given value contains only alpha numeric characters.
+	 *
+	 * @param                $input
+	 * @param ValidationInfo $info
+	 *
+	 * @return string
+	 *
+	 * @throws Invalid
+	 */
+	public static function alphanumeric($input, ValidationInfo $info = null)
+	{
+		if (ctype_alnum($input)) {
+			return $input;
+		}
+		if ($info && $info->fix) {
+			//remove non alpha numeric and space characters
+			return preg_replace("/[^a-z0-9 ]/i", "", $input);
+		}
+		throw new Invalid('Expecting only alpha numeric characters.');
+	}
 
-    /**
-     * Validate printable characters.
-     *
-     * Check that given value contains only printable characters.
-     *
-     * @param                $input
-     * @param ValidationInfo $info
-     *
-     * @return string
-     *
-     * @throws Invalid
-     */
-    public static function printable($input, ValidationInfo $info = null)
-    {
-        if (ctype_print($input)) {
-            return $input;
-        }
-        if ($info && $info->fix) {
-            //remove non printable characters
-            return preg_replace('/[\x00-\x1F\x80-\xFF]/', '', $input);
-        }
-        throw new Invalid('Expecting only printable characters.');
-    }
+	/**
+	 * Validate printable characters.
+	 *
+	 * Check that given value contains only printable characters.
+	 *
+	 * @param                $input
+	 * @param ValidationInfo $info
+	 *
+	 * @return string
+	 *
+	 * @throws Invalid
+	 */
+	public static function printable($input, ValidationInfo $info = null)
+	{
+		if (ctype_print($input)) {
+			return $input;
+		}
+		if ($info && $info->fix) {
+			//remove non printable characters
+			return preg_replace('/[\x00-\x1F\x80-\xFF]/', '', $input);
+		}
+		throw new Invalid('Expecting only printable characters.');
+	}
 
-    /**
-     * Validate hexadecimal digits.
-     *
-     * Check that given value contains only hexadecimal digits.
-     *
-     * @param                $input
-     * @param ValidationInfo $info
-     *
-     * @return string
-     *
-     * @throws Invalid
-     */
-    public static function hex($input, ValidationInfo $info = null)
-    {
-        if (ctype_xdigit($input)) {
-            return $input;
-        }
-        throw new Invalid('Expecting only hexadecimal digits.');
-    }
+	/**
+	 * Validate hexadecimal digits.
+	 *
+	 * Check that given value contains only hexadecimal digits.
+	 *
+	 * @param                $input
+	 * @param ValidationInfo $info
+	 *
+	 * @return string
+	 *
+	 * @throws Invalid
+	 */
+	public static function hex($input, ValidationInfo $info = null)
+	{
+		if (ctype_xdigit($input)) {
+			return $input;
+		}
+		throw new Invalid('Expecting only hexadecimal digits.');
+	}
 
-    /**
-     * Color specified as hexadecimals
-     *
-     * Check that given value contains only color.
-     *
-     * @param                     $input
-     * @param ValidationInfo|null $info
-     *
-     * @return string
-     * @throws Invalid
-     */
-    public static function color($input, ValidationInfo $info = null)
-    {
-        if (preg_match('/^#[a-f0-9]{6}$/i', $input)) {
-            return $input;
-        }
-        throw new Invalid('Expecting color as hexadecimal digits.');
-    }
+	/**
+	 * Color specified as hexadecimals
+	 *
+	 * Check that given value contains only color.
+	 *
+	 * @param                     $input
+	 * @param ValidationInfo|null $info
+	 *
+	 * @return string
+	 * @throws Invalid
+	 */
+	public static function color($input, ValidationInfo $info = null)
+	{
+		if (preg_match('/^#[a-f0-9]{6}$/i', $input)) {
+			return $input;
+		}
+		throw new Invalid('Expecting color as hexadecimal digits.');
+	}
 
-    /**
-     * Validate Telephone number
-     *
-     * Check if the given value is numeric with or without a `+` prefix
-     *
-     * @param                $input
-     * @param ValidationInfo $info
-     *
-     * @return string
-     *
-     * @throws Invalid
-     */
-    public static function tel($input, ValidationInfo $info = null)
-    {
-        if (is_numeric($input) && '-' != substr($input, 0, 1)) {
-            return $input;
-        }
-        throw new Invalid('Expecting phone number, a numeric value ' .
-            'with optional `+` prefix');
-    }
+	/**
+	 * Validate Telephone number
+	 *
+	 * Check if the given value is numeric with or without a `+` prefix
+	 *
+	 * @param                $input
+	 * @param ValidationInfo $info
+	 *
+	 * @return string
+	 *
+	 * @throws Invalid
+	 */
+	public static function tel($input, ValidationInfo $info = null)
+	{
+		if (is_numeric($input) && '-' != substr($input, 0, 1)) {
+			return $input;
+		}
+		throw new Invalid('Expecting phone number, a numeric value ' .
+			'with optional `+` prefix');
+	}
 
-    /**
-     * Validate Email
-     *
-     * Check if the given string is a valid email
-     *
-     * @param String         $input
-     * @param ValidationInfo $info
-     *
-     * @return string
-     * @throws Invalid
-     */
-    public static function email($input, ValidationInfo $info = null)
-    {
-        $r = filter_var($input, FILTER_VALIDATE_EMAIL);
-        if ($r) {
-            return $r;
-        } elseif ($info && $info->fix) {
-            $r = filter_var($input, FILTER_SANITIZE_EMAIL);
-            return static::email($r);
-        }
-        throw new Invalid('Expecting email in `name@example.com` format');
-    }
+	/**
+	 * Validate Email
+	 *
+	 * Check if the given string is a valid email
+	 *
+	 * @param String         $input
+	 * @param ValidationInfo $info
+	 *
+	 * @return string
+	 * @throws Invalid
+	 */
+	public static function email($input, ValidationInfo $info = null)
+	{
+		$r = filter_var($input, FILTER_VALIDATE_EMAIL);
+		if ($r) {
+			return $r;
+		} elseif ($info && $info->fix) {
+			$r = filter_var($input, FILTER_SANITIZE_EMAIL);
+			return static::email($r);
+		}
+		throw new Invalid('Expecting email in `name@example.com` format');
+	}
 
-    /**
-     * Validate IP Address
-     *
-     * Check if the given string is a valid ip address
-     *
-     * @param String         $input
-     * @param ValidationInfo $info
-     *
-     * @return string
-     * @throws Invalid
-     */
-    public static function ip($input, ValidationInfo $info = null)
-    {
-        $r = filter_var($input, FILTER_VALIDATE_IP);
-        if ($r) {
-            return $r;
-        }
+	/**
+	 * Validate IP Address
+	 *
+	 * Check if the given string is a valid ip address
+	 *
+	 * @param String         $input
+	 * @param ValidationInfo $info
+	 *
+	 * @return string
+	 * @throws Invalid
+	 */
+	public static function ip($input, ValidationInfo $info = null)
+	{
+		$r = filter_var($input, FILTER_VALIDATE_IP);
+		if ($r) {
+			return $r;
+		}
 
-        throw new Invalid('Expecting IP address in IPV6 or IPV4 format');
-    }
+		throw new Invalid('Expecting IP address in IPV6 or IPV4 format');
+	}
 
-    /**
-     * Validate Url
-     *
-     * Check if the given string is a valid url
-     *
-     * @param String         $input
-     * @param ValidationInfo $info
-     *
-     * @return string
-     * @throws Invalid
-     */
-    public static function url($input, ValidationInfo $info = null)
-    {
-        $r = filter_var($input, FILTER_VALIDATE_URL);
-        if ($r) {
-            return $r;
-        } elseif ($info && $info->fix) {
-            $r = filter_var($input, FILTER_SANITIZE_URL);
-            return static::url($r);
-        }
-        throw new Invalid('Expecting url in `http://example.com` format');
-    }
+	/**
+	 * Validate Url
+	 *
+	 * Check if the given string is a valid url
+	 *
+	 * @param String         $input
+	 * @param ValidationInfo $info
+	 *
+	 * @return string
+	 * @throws Invalid
+	 */
+	public static function url($input, ValidationInfo $info = null)
+	{
+		$r = filter_var($input, FILTER_VALIDATE_URL);
+		if ($r) {
+			return $r;
+		} elseif ($info && $info->fix) {
+			$r = filter_var($input, FILTER_SANITIZE_URL);
+			return static::url($r);
+		}
+		throw new Invalid('Expecting url in `http://example.com` format');
+	}
 
-    /**
-     * MySQL Date
-     *
-     * Check if the given string is a valid date in YYYY-MM-DD format
-     *
-     * @param String         $input
-     * @param ValidationInfo $info
-     *
-     * @return string
-     * @throws Invalid
-     */
-    public static function date($input, ValidationInfo $info = null)
-    {
-        if (
-            preg_match(
-                '#^(?P<year>\d{2}|\d{4})-(?P<month>\d{1,2})-(?P<day>\d{1,2})$#',
-                $input,
-                $date
-            )
-            && checkdate($date['month'], $date['day'], $date['year'])
-        ) {
-            return $input;
-        }
-        throw new Invalid(
-            'Expecting date in `YYYY-MM-DD` format, such as `'
-            . date("Y-m-d") . '`'
-        );
-    }
+	/**
+	 * MySQL Date
+	 *
+	 * Check if the given string is a valid date in YYYY-MM-DD format
+	 *
+	 * @param String         $input
+	 * @param ValidationInfo $info
+	 *
+	 * @return string
+	 * @throws Invalid
+	 */
+	public static function date($input, ValidationInfo $info = null)
+	{
+		if (
+			preg_match(
+				'#^(?P<year>\d{2}|\d{4})-(?P<month>\d{1,2})-(?P<day>\d{1,2})$#',
+				$input,
+				$date
+			)
+			&& checkdate($date['month'], $date['day'], $date['year'])
+		) {
+			return $input;
+		}
+		throw new Invalid(
+			'Expecting date in `YYYY-MM-DD` format, such as `'
+			. date("Y-m-d") . '`'
+		);
+	}
 
-    /**
-     * MySQL DateTime
-     *
-     * Check if the given string is a valid date and time in YYY-MM-DD HH:MM:SS format
-     *
-     * @param String         $input
-     * @param ValidationInfo $info
-     *
-     * @return string
-     * @throws Invalid
-     */
-    public static function datetime($input, ValidationInfo $info = null)
-    {
-        if (
-            preg_match('/^(?P<year>19\d\d|20\d\d)\-(?P<month>0[1-9]|1[0-2])\-' .
-                '(?P<day>0\d|[1-2]\d|3[0-1]) (?P<h>0\d|1\d|2[0-3]' .
-                ')\:(?P<i>[0-5][0-9])\:(?P<s>[0-5][0-9])$/',
-                $input, $date)
-            && checkdate($date['month'], $date['day'], $date['year'])
-        ) {
-            return $input;
-        }
-        throw new Invalid(
-            'Expecting date and time in `YYYY-MM-DD HH:MM:SS` format, such as `'
-            . date("Y-m-d H:i:s") . '`'
-        );
-    }
+	/**
+	 * MySQL DateTime
+	 *
+	 * Check if the given string is a valid date and time in YYY-MM-DD HH:MM:SS format
+	 *
+	 * @param String         $input
+	 * @param ValidationInfo $info
+	 *
+	 * @return string
+	 * @throws Invalid
+	 */
+	public static function datetime($input, ValidationInfo $info = null)
+	{
+		if (
+			preg_match('/^(?P<year>19\d\d|20\d\d)\-(?P<month>0[1-9]|1[0-2])\-' .
+				'(?P<day>0\d|[1-2]\d|3[0-1]) (?P<h>0\d|1\d|2[0-3]' .
+				')\:(?P<i>[0-5][0-9])\:(?P<s>[0-5][0-9])$/',
+				$input, $date)
+			&& checkdate($date['month'], $date['day'], $date['year'])
+		) {
+			return $input;
+		}
+		throw new Invalid(
+			'Expecting date and time in `YYYY-MM-DD HH:MM:SS` format, such as `'
+			. date("Y-m-d H:i:s") . '`'
+		);
+	}
 
-    /**
-     * Alias for Time
-     *
-     * Check if the given string is a valid time in HH:MM:SS format
-     *
-     * @param String         $input
-     * @param ValidationInfo $info
-     *
-     * @return string
-     * @throws Invalid
-     */
-    public static function time24($input, ValidationInfo $info = null)
-    {
-        return static::time($input, $info);
-    }
+	/**
+	 * Alias for Time
+	 *
+	 * Check if the given string is a valid time in HH:MM:SS format
+	 *
+	 * @param String         $input
+	 * @param ValidationInfo $info
+	 *
+	 * @return string
+	 * @throws Invalid
+	 */
+	public static function time24($input, ValidationInfo $info = null)
+	{
+		return static::time($input, $info);
+	}
 
-    /**
-     * Time
-     *
-     * Check if the given string is a valid time in HH:MM:SS format
-     *
-     * @param String         $input
-     * @param ValidationInfo $info
-     *
-     * @return string
-     * @throws Invalid
-     */
-    public static function time($input, ValidationInfo $info = null)
-    {
-        if (preg_match('/^([01]?[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$/', $input)) {
-            return $input;
-        }
-        throw new Invalid(
-            'Expecting time in `HH:MM:SS` format, such as `'
-            . date("H:i:s") . '`'
-        );
-    }
+	/**
+	 * Time
+	 *
+	 * Check if the given string is a valid time in HH:MM:SS format
+	 *
+	 * @param String         $input
+	 * @param ValidationInfo $info
+	 *
+	 * @return string
+	 * @throws Invalid
+	 */
+	public static function time($input, ValidationInfo $info = null)
+	{
+		if (preg_match('/^([01]?[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$/', $input)) {
+			return $input;
+		}
+		throw new Invalid(
+			'Expecting time in `HH:MM:SS` format, such as `'
+			. date("H:i:s") . '`'
+		);
+	}
 
-    /**
-     * Time in 12 hour format
-     *
-     * Check if the given string is a valid time 12 hour format
-     *
-     * @param String         $input
-     * @param ValidationInfo $info
-     *
-     * @return string
-     * @throws Invalid
-     */
-    public static function time12($input, ValidationInfo $info = null)
-    {
-        if (preg_match(
-            '/^([1-9]|1[0-2]|0[1-9]){1}(:[0-5][0-9])?\s?([aApP][mM]{1})?$/',
-            $input)
-        ) {
-            return $input;
-        }
-        throw new Invalid(
-            'Expecting time in 12 hour format, such as `08:00AM` and `10:05:11`'
-        );
-    }
+	/**
+	 * Time in 12 hour format
+	 *
+	 * Check if the given string is a valid time 12 hour format
+	 *
+	 * @param String         $input
+	 * @param ValidationInfo $info
+	 *
+	 * @return string
+	 * @throws Invalid
+	 */
+	public static function time12($input, ValidationInfo $info = null)
+	{
+		if (preg_match(
+			'/^([1-9]|1[0-2]|0[1-9]){1}(:[0-5][0-9])?\s?([aApP][mM]{1})?$/',
+			$input)
+		) {
+			return $input;
+		}
+		throw new Invalid(
+			'Expecting time in 12 hour format, such as `08:00AM` and `10:05:11`'
+		);
+	}
 
-    /**
-     * Unix Timestamp
-     *
-     * Check if the given value is a valid timestamp
-     *
-     * @param String         $input
-     * @param ValidationInfo $info
-     *
-     * @return int
-     * @throws Invalid
-     */
-    public static function timestamp($input, ValidationInfo $info = null)
-    {
-        if ((string)(int)$input == $input
-            && ($input <= PHP_INT_MAX)
-            && ($input >= ~PHP_INT_MAX)
-        ) {
-            return (int)$input;
-        }
-        throw new Invalid('Expecting unix timestamp, such as ' . time());
-    }
+	/**
+	 * Unix Timestamp
+	 *
+	 * Check if the given value is a valid timestamp
+	 *
+	 * @param String         $input
+	 * @param ValidationInfo $info
+	 *
+	 * @return int
+	 * @throws Invalid
+	 */
+	public static function timestamp($input, ValidationInfo $info = null)
+	{
+		if ((string)(int)$input == $input
+			&& ($input <= PHP_INT_MAX)
+			&& ($input >= ~PHP_INT_MAX)
+		) {
+			return (int)$input;
+		}
+		throw new Invalid('Expecting unix timestamp, such as ' . time());
+	}
 
-    /**
-     * Validate the given input
-     *
-     * Validates the input and attempts to fix it when fix is requested
-     *
-     * @param mixed          $input
-     * @param ValidationInfo $info
-     * @param null           $full
-     *
-     * @throws \Exception
-     * @return array|bool|float|int|mixed|null|number|string
-     */
-    public static function validate($input, ValidationInfo $info, $full = null)
-    {
-        $html = Scope::get('Restler')->responseFormat instanceof HtmlFormat;
-        $name = $html ? "<strong>$info->label</strong>" : "`$info->name`";
-        if (
-            isset(static::$preFilters['*']) &&
-            is_scalar($input) &&
-            is_callable($func = static::$preFilters['*'])
-        ) {
-            $input = $func($input);
-        }
-        if (
-            isset(static::$preFilters[$info->type]) &&
-            (is_scalar($input) || !empty($info->children)) &&
-            is_callable($func = static::$preFilters[$info->type])
-        ) {
-            $input = $func($input);
-        }
-        try {
-            if (is_null($input)) {
-                if ($info->required) {
-                    throw new RestException (400,
-                        "$name is required.");
-                }
-                return null;
-            }
-            $error = isset ($info->message)
-                ? $info->message
-                : "Invalid value specified for $name";
+	/**
+	 * Validate the given input
+	 *
+	 * Validates the input and attempts to fix it when fix is requested
+	 *
+	 * @param mixed          $input
+	 * @param ValidationInfo $info
+	 * @param null           $full
+	 *
+	 * @throws \Exception
+	 * @return array|bool|float|int|mixed|null|number|string
+	 */
+	public static function validate($input, ValidationInfo $info, $full = null)
+	{
+		$html = Scope::get('Restler')->responseFormat instanceof HtmlFormat;
+		$name = $html ? "<strong>$info->label</strong>" : "`$info->name`";
+		if (
+			isset(static::$preFilters['*']) &&
+			is_scalar($input) &&
+			is_callable($func = static::$preFilters['*'])
+		) {
+			$input = $func($input);
+		}
+		if (
+			isset(static::$preFilters[$info->type]) &&
+			(is_scalar($input) || !empty($info->children)) &&
+			is_callable($func = static::$preFilters[$info->type])
+		) {
+			$input = $func($input);
+		}
+		try {
+			if (is_null($input)) {
+				if ($info->required) {
+					throw new RestException (400,
+						"$name is required.");
+				}
+				return null;
+			}
+			$error = isset ($info->message)
+				? $info->message
+				: "Invalid value specified for $name";
 
-            //if a validation method is specified
-            if (!empty($info->method)) {
-                $method = $info->method;
-                $info->method = '';
-                $r = self::validate($input, $info);
-                return $info->apiClassInstance->{$method} ($r);
-            }
+			//if a validation method is specified
+			if (!empty($info->method)) {
+				$method = $info->method;
+				$info->method = '';
+				$r = self::validate($input, $info);
+				return $info->apiClassInstance->{$method} ($r);
+			}
 
-            // when type is an array check if it passes for any type
-            if (is_array($info->type)) {
-                //trace("types are ".print_r($info->type, true));
-                $types = $info->type;
-                foreach ($types as $type) {
-                    $info->type = $type;
-                    try {
-                        $r = self::validate($input, $info);
-                        if ($r !== false) {
-                            return $r;
-                        }
-                    } catch (RestException $e) {
-                        // just continue
-                    }
-                }
-                throw new RestException (400, $error);
-            }
+			// when type is an array check if it passes for any type
+			if (is_array($info->type)) {
+				//trace("types are ".print_r($info->type, true));
+				$types = $info->type;
+				foreach ($types as $type) {
+					$info->type = $type;
+					try {
+						$r = self::validate($input, $info);
+						if ($r !== false) {
+							return $r;
+						}
+					} catch (RestException $e) {
+						// just continue
+					}
+				}
+				throw new RestException (400, $error);
+			}
 
-            //patterns are supported only for non numeric types
-            if (isset ($info->pattern)
-                && $info->type != 'int'
-                && $info->type != 'float'
-                && $info->type != 'number'
-            ) {
-                if (!preg_match($info->pattern, $input)) {
-                    throw new RestException (400, $error);
-                }
-            }
+			//patterns are supported only for non numeric types
+			if (isset ($info->pattern)
+				&& $info->type != 'int'
+				&& $info->type != 'float'
+				&& $info->type != 'number'
+			) {
+				if (!preg_match($info->pattern, $input)) {
+					throw new RestException (400, $error);
+				}
+			}
 
-            if (isset ($info->choice)) {
-                if (!$info->required && empty($input)) {
-                    //since its optional, and empty let it pass.
-                    $input = null;
-                } elseif (is_array($input)) {
-                    foreach ($input as $i) {
-                        if (!in_array($i, $info->choice)) {
-                            $error .= ". Expected one of (" . implode(',', $info->choice) . ").";
-                            throw new RestException (400, $error);
-                        }
-                    }
-                } elseif (!in_array($input, $info->choice)) {
-                    $error .= ". Expected one of (" . implode(',', $info->choice) . ").";
-                    throw new RestException (400, $error);
-                }
-            }
+			if (isset ($info->choice)) {
+				if (!$info->required && empty($input)) {
+					//since its optional, and empty let it pass.
+					$input = null;
+				} elseif (is_array($input)) {
+					foreach ($input as $i) {
+						if (!in_array($i, $info->choice)) {
+							$error .= ". Expected one of (" . implode(',', $info->choice) . ").";
+							throw new RestException (400, $error);
+						}
+					}
+				} elseif (!in_array($input, $info->choice)) {
+					$error .= ". Expected one of (" . implode(',', $info->choice) . ").";
+					throw new RestException (400, $error);
+				}
+			}
 
-            if (method_exists($class = get_called_class(), $info->type) && $info->type != 'validate') {
-                if (!$info->required && empty($input)) {
-                    //optional parameter with a empty value assume null
-                    return null;
-                }
-                try {
-                    return call_user_func("$class::$info->type", $input, $info);
-                } catch (Invalid $e) {
-                    throw new RestException(400, $error . '. ' . $e->getMessage());
-                }
-            }
+			if (method_exists($class = get_called_class(), $info->type) && $info->type != 'validate') {
+				if (!$info->required && empty($input)) {
+					//optional parameter with a empty value assume null
+					return null;
+				}
+				try {
+					return call_user_func("$class::$info->type", $input, $info);
+				} catch (Invalid $e) {
+					throw new RestException(400, $error . '. ' . $e->getMessage());
+				}
+			}
 
-            switch ($info->type) {
-                case 'int' :
-                case 'float' :
-                case 'number' :
-                    if (!is_numeric($input)) {
-                        $error .= '. Expecting '
-                            . ($info->type == 'int' ? 'integer' : 'numeric')
-                            . ' value';
-                        break;
-                    }
-                    if ($info->type == 'int' && (int)$input != $input) {
-                        if ($info->fix) {
-                            $r = (int)$input;
-                        } else {
-                            $error .= '. Expecting integer value';
-                            break;
-                        }
-                    } else {
-                        $r = $info->numericValue($input);
-                    }
-                    if (isset ($info->min) && $r < $info->min) {
-                        if ($info->fix) {
-                            $r = $info->min;
-                        } else {
-                            $error .= ". Minimum required value is $info->min.";
-                            break;
-                        }
-                    }
-                    if (isset ($info->max) && $r > $info->max) {
-                        if ($info->fix) {
-                            $r = $info->max;
-                        } else {
-                            $error .= ". Maximum allowed value is $info->max.";
-                            break;
-                        }
-                    }
-                    return $r;
+			switch ($info->type) {
+				case 'int' :
+				case 'float' :
+				case 'number' :
+					if (!is_numeric($input)) {
+						$error .= '. Expecting '
+							. ($info->type == 'int' ? 'integer' : 'numeric')
+							. ' value';
+						break;
+					}
+					if ($info->type == 'int' && (int)$input != $input) {
+						if ($info->fix) {
+							$r = (int)$input;
+						} else {
+							$error .= '. Expecting integer value';
+							break;
+						}
+					} else {
+						$r = $info->numericValue($input);
+					}
+					if (isset ($info->min) && $r < $info->min) {
+						if ($info->fix) {
+							$r = $info->min;
+						} else {
+							$error .= ". Minimum required value is $info->min.";
+							break;
+						}
+					}
+					if (isset ($info->max) && $r > $info->max) {
+						if ($info->fix) {
+							$r = $info->max;
+						} else {
+							$error .= ". Maximum allowed value is $info->max.";
+							break;
+						}
+					}
+					return $r;
 
-                case 'string' :
-                case 'password' : //password fields with string
-                case 'search' : //search field with string
-                    if (is_bool($input)) $input = $input ? 'true' : 'false';
-                    if (!is_string($input)) {
-                        $error .= '. Expecting alpha numeric value';
-                        break;
-                    }
-                    if ($info->required && $input === '') {
-                        $error = "$name is required.";
-                        break;
-                    }
-                    $r = strlen($input);
-                    if (isset ($info->min) && $r < $info->min) {
-                        if ($info->fix) {
-                            $input = str_pad($input, $info->min, $input);
-                        } else {
-                            $char = $info->min > 1 ? 'characters' : 'character';
-                            $error .= ". Minimum $info->min $char required.";
-                            break;
-                        }
-                    }
-                    if (isset ($info->max) && $r > $info->max) {
-                        if ($info->fix) {
-                            $input = substr($input, 0, $info->max);
-                        } else {
-                            $char = $info->max > 1 ? 'characters' : 'character';
-                            $error .= ". Maximum $info->max $char allowed.";
-                            break;
-                        }
-                    }
-                    return $input;
+				case 'string' :
+				case 'password' : //password fields with string
+				case 'search' : //search field with string
+					if (is_bool($input)) $input = $input ? 'true' : 'false';
+					if (!is_string($input)) {
+						$error .= '. Expecting alpha numeric value';
+						break;
+					}
+					if ($info->required && $input === '') {
+						$error = "$name is required.";
+						break;
+					}
+					$r = strlen($input);
+					if (isset ($info->min) && $r < $info->min) {
+						if ($info->fix) {
+							$input = str_pad($input, $info->min, $input);
+						} else {
+							$char = $info->min > 1 ? 'characters' : 'character';
+							$error .= ". Minimum $info->min $char required.";
+							break;
+						}
+					}
+					if (isset ($info->max) && $r > $info->max) {
+						if ($info->fix) {
+							$input = substr($input, 0, $info->max);
+						} else {
+							$char = $info->max > 1 ? 'characters' : 'character';
+							$error .= ". Maximum $info->max $char allowed.";
+							break;
+						}
+					}
+					return $input;
 
-                case 'bool':
-                case 'boolean':
-                    if (is_bool($input)) {
-                        return $input;
-                    }
-                    if (is_numeric($input)) {
-                        if ($input == 1) {
-                            return true;
-                        }
-                        if ($input == 0) {
-                            return false;
-                        }
-                    } elseif (is_string($input)) {
-                        switch (strtolower($input)) {
-                            case 'true':
-                                return true;
-                            case 'false':
-                                return false;
-                        }
-                    }
-                    if ($info->fix) {
-                        return $input ? true : false;
-                    }
-                    $error .= '. Expecting boolean value';
-                    break;
-                case 'array':
-                    if ($info->fix && is_string($input)) {
-                        $input = explode(CommentParser::$arrayDelimiter, $input);
-                    }
-                    if (is_array($input)) {
-                        $contentType =
-                            Util::nestedValue($info, 'contentType') ?: null;
-                        if ($info->fix) {
-                            if ($contentType == 'indexed') {
-                                $input = $info->filterArray($input, true);
-                            } elseif ($contentType == 'associative') {
-                                $input = $info->filterArray($input, false);
-                            }
-                        } elseif (
-                            $contentType == 'indexed' &&
-                            array_values($input) != $input
-                        ) {
-                            $error .= '. Expecting a list of items but an item is given';
-                            break;
-                        } elseif (
-                            $contentType == 'associative' &&
-                            array_values($input) == $input &&
-                            count($input)
-                        ) {
-                            $error .= '. Expecting an item but a list is given';
-                            break;
-                        }
-                        $r = count($input);
-                        if (isset ($info->min) && $r < $info->min) {
-                            $item = $info->max > 1 ? 'items' : 'item';
-                            $error .= ". Minimum $info->min $item required.";
-                            break;
-                        }
-                        if (isset ($info->max) && $r > $info->max) {
-                            if ($info->fix) {
-                                $input = array_slice($input, 0, $info->max);
-                            } else {
-                                $item = $info->max > 1 ? 'items' : 'item';
-                                $error .= ". Maximum $info->max $item allowed.";
-                                break;
-                            }
-                        }
-                        if (
-                            isset($contentType) &&
-                            $contentType != 'associative' &&
-                            $contentType != 'indexed'
-                        ) {
-                            $name = $info->name;
-                            $info->type = $contentType;
-                            unset($info->contentType);
-                            unset($info->min);
-                            unset($info->max);
-                            foreach ($input as $key => $chinput) {
-                                $info->name = "{$name}[$key]";
-                                $input[$key] = static::validate($chinput, $info);
-                            }
-                        }
-                        return $input;
-                    } elseif (isset($contentType)) {
-                        $error .= '. Expecting items of type ' .
-                            ($html ? "<strong>$contentType</strong>" : "`$contentType`");
-                        break;
-                    }
-                    break;
-                case 'mixed':
-                case 'unknown_type':
-                case 'unknown':
-                case null: //treat as unknown
-                    return $input;
-                default :
-                    if (!is_array($input)) {
-                        break;
-                    }
-                    //do type conversion
-                    if (class_exists($info->type)) {
-                        $input = $info->filterArray($input, false);
-                        $implements = class_implements($info->type);
-                        if (
-                            is_array($implements) &&
-                            in_array('Luracast\\Restler\\Data\\iValueObject', $implements)
-                        ) {
-                            return call_user_func(
-                                "{$info->type}::__set_state", $input
-                            );
-                        }
-                        $class = $info->type;
-                        $instance = new $class();
-                        if (is_array($info->children)) {
-                            if (
-                                empty($input) ||
-                                !is_array($input) ||
-                                $input === array_values($input)
-                            ) {
-                                $error .= '. Expecting an item of type ' .
-                                    ($html ? "<strong>$info->type</strong>" : "`$info->type`");
-                                break;
-                            }
-                            foreach ($info->children as $key => $value) {
-                                $cv = new ValidationInfo($value);
-                                $cv->name = "{$info->name}[$key]";
-                                if (array_key_exists($key, $input) || $cv->required) {
-                                    $instance->{$key} = static::validate(
-                                        Util::nestedValue($input, $key),
-                                        $cv
-                                    );
-                                }
-                            }
-                        }
-                        return $instance;
-                    }
-            }
-            throw new RestException (400, $error);
-        } catch (\Exception $e) {
-            static::$exceptions[$info->name] = $e;
-            if (static::$holdException) {
-                return null;
-            }
-            throw $e;
-        }
-    }
+				case 'bool':
+				case 'boolean':
+					if (is_bool($input)) {
+						return $input;
+					}
+					if (is_numeric($input)) {
+						if ($input == 1) {
+							return true;
+						}
+						if ($input == 0) {
+							return false;
+						}
+					} elseif (is_string($input)) {
+						switch (strtolower($input)) {
+							case 'true':
+								return true;
+							case 'false':
+								return false;
+						}
+					}
+					if ($info->fix) {
+						return $input ? true : false;
+					}
+					$error .= '. Expecting boolean value';
+					break;
+				case 'array':
+					if ($info->fix && is_string($input)) {
+						$input = explode(CommentParser::$arrayDelimiter, $input);
+					}
+					if (is_array($input)) {
+						$contentType =
+							Util::nestedValue($info, 'contentType') ?: null;
+						if ($info->fix) {
+							if ($contentType == 'indexed') {
+								$input = $info->filterArray($input, true);
+							} elseif ($contentType == 'associative') {
+								$input = $info->filterArray($input, false);
+							}
+						} elseif (
+							$contentType == 'indexed' &&
+							array_values($input) != $input
+						) {
+							$error .= '. Expecting a list of items but an item is given';
+							break;
+						} elseif (
+							$contentType == 'associative' &&
+							array_values($input) == $input &&
+							count($input)
+						) {
+							$error .= '. Expecting an item but a list is given';
+							break;
+						}
+						$r = count($input);
+						if (isset ($info->min) && $r < $info->min) {
+							$item = $info->max > 1 ? 'items' : 'item';
+							$error .= ". Minimum $info->min $item required.";
+							break;
+						}
+						if (isset ($info->max) && $r > $info->max) {
+							if ($info->fix) {
+								$input = array_slice($input, 0, $info->max);
+							} else {
+								$item = $info->max > 1 ? 'items' : 'item';
+								$error .= ". Maximum $info->max $item allowed.";
+								break;
+							}
+						}
+						if (
+							isset($contentType) &&
+							$contentType != 'associative' &&
+							$contentType != 'indexed'
+						) {
+							$name = $info->name;
+							$info->type = $contentType;
+							unset($info->contentType);
+							unset($info->min);
+							unset($info->max);
+							foreach ($input as $key => $chinput) {
+								$info->name = "{$name}[$key]";
+								$input[$key] = static::validate($chinput, $info);
+							}
+						}
+						return $input;
+					} elseif (isset($contentType)) {
+						$error .= '. Expecting items of type ' .
+							($html ? "<strong>$contentType</strong>" : "`$contentType`");
+						break;
+					}
+					break;
+				case 'mixed':
+				case 'unknown_type':
+				case 'unknown':
+				case null: //treat as unknown
+					return $input;
+				default :
+					if (!is_array($input)) {
+						break;
+					}
+					//do type conversion
+					if (class_exists($info->type)) {
+						$input = $info->filterArray($input, false);
+						$implements = class_implements($info->type);
+						if (
+							is_array($implements) &&
+							in_array('Luracast\\Restler\\Data\\iValueObject', $implements)
+						) {
+							return call_user_func(
+								"{$info->type}::__set_state", $input
+							);
+						}
+						$class = $info->type;
+						$instance = new $class();
+						if (is_array($info->children)) {
+							if (
+								empty($input) ||
+								!is_array($input) ||
+								$input === array_values($input)
+							) {
+								$error .= '. Expecting an item of type ' .
+									($html ? "<strong>$info->type</strong>" : "`$info->type`");
+								break;
+							}
+							foreach ($info->children as $key => $value) {
+								$cv = new ValidationInfo($value);
+								$cv->name = "{$info->name}[$key]";
+								if (array_key_exists($key, $input) || $cv->required) {
+									$instance->{$key} = static::validate(
+										Util::nestedValue($input, $key),
+										$cv
+									);
+								}
+							}
+						}
+						return $instance;
+					}
+			}
+			throw new RestException (400, $error);
+		} catch (\Exception $e) {
+			static::$exceptions[$info->name] = $e;
+			if (static::$holdException) {
+				return null;
+			}
+			throw $e;
+		}
+	}
 }

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;
+	}
 }
 

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;
+	}
 }