Code cleanup

This commit is contained in:
PJ Dietz 2015-03-04 19:06:16 -05:00
parent 42c0b87285
commit 2aadfe74b3
4 changed files with 20 additions and 19 deletions

View File

@ -2,7 +2,11 @@
<project version="4"> <project version="4">
<component name="ProjectCodeStyleSettingsManager"> <component name="ProjectCodeStyleSettingsManager">
<option name="PER_PROJECT_SETTINGS"> <option name="PER_PROJECT_SETTINGS">
<value /> <value>
<XML>
<option name="XML_LEGACY_SETTINGS_IMPORTED" value="true" />
</XML>
</value>
</option> </option>
<option name="PREFERRED_PROJECT_CODE_STYLE" value="Default (1)" /> <option name="PREFERRED_PROJECT_CODE_STYLE" value="Default (1)" />
</component> </component>

View File

@ -20,10 +20,10 @@ use pjdietz\WellRESTed\Interfaces\ResponseInterface;
* *
* To use Handler, create a subclass and implement the methods for any HTTP * To use Handler, create a subclass and implement the methods for any HTTP
* verbs you would like to support. (get() for GET, post() for POST, etc). * verbs you would like to support. (get() for GET, post() for POST, etc).
* <br /><br /> *
* - Access the request via the protected member $this->request<br /> * - Access the request via the protected member $this->request
* - Access a map of arguments via $this->args (e.g., URI path variables)<br /> * - Access a map of arguments via $this->args (e.g., URI path variables)
* - Modify $this->response to provide the response the instance will return<br /> * - Modify $this->response to provide the response the instance will return
*/ */
abstract class Handler implements HandlerInterface abstract class Handler implements HandlerInterface
{ {
@ -204,5 +204,4 @@ abstract class Handler implements HandlerInterface
} }
return false; return false;
} }
} }

View File

@ -46,10 +46,10 @@ class RouteBuilder
* Contruct and return an array of routes. * Contruct and return an array of routes.
* *
* If $data is a string, buildRoutes() will parse it as JSON with json_decode. * If $data is a string, buildRoutes() will parse it as JSON with json_decode.
* <br /><br /> *
* If $data is an array, buildRoutes() assumes each item in the array is * If $data is an array, buildRoutes() assumes each item in the array is
* an object it can translate into a route. * an object it can translate into a route.
* <br /><br /> *
* If $data is an object, buildRoutes() assumes it will have a "routes" * If $data is an object, buildRoutes() assumes it will have a "routes"
* property with an array value that is a collection of objects to * property with an array value that is a collection of objects to
* translate into routes. Any other properties will be read with * translate into routes. Any other properties will be read with
@ -92,11 +92,11 @@ class RouteBuilder
/** /**
* Parse an object and update the instances with the new configuration. * Parse an object and update the instances with the new configuration.
* *
* ->handlerNamespace is passed to setHandlerNamesapce() * handlerNamespace is passed to setHandlerNamesapce()
* <br /></br />
* ->variablePattern is passed to setDefaultVariablePattern() * variablePattern is passed to setDefaultVariablePattern()
* <br /><br /> *
* ->vars is passed to setTemplateVars() * vars is passed to setTemplateVars()
* *
* @param object * @param object
*/ */
@ -149,7 +149,7 @@ class RouteBuilder
* Keys are names of variables for use in URI template (do not include {}). * Keys are names of variables for use in URI template (do not include {}).
* Values are regex patterns or any of the following special names: SLUG, * Values are regex patterns or any of the following special names: SLUG,
* ALPHA, ALPHANUM, DIGIT, NUM. * ALPHA, ALPHANUM, DIGIT, NUM.
* <br /><br /> *
* If you wish to use additional named patterns, subclass RouteBuilder and * If you wish to use additional named patterns, subclass RouteBuilder and
* override getTemplateVariablePattern. * override getTemplateVariablePattern.
* *
@ -178,7 +178,7 @@ class RouteBuilder
* *
* $defaultVariablePattern may be a regex pattern or one of the following: * $defaultVariablePattern may be a regex pattern or one of the following:
* SLUG, ALPHA, ALPHANUM, DIGIT, NUM. * SLUG, ALPHA, ALPHANUM, DIGIT, NUM.
* <br /><br /> *
* If you wish to use additional named patterns, subclass RouteBuilder and * If you wish to use additional named patterns, subclass RouteBuilder and
* override getTemplateVariablePattern. * override getTemplateVariablePattern.
* *
@ -196,7 +196,7 @@ class RouteBuilder
* HandlerInterface to call getResponse() on if the route matches. "handler" * HandlerInterface to call getResponse() on if the route matches. "handler"
* may be fully qualified and begin with "\". If it does not begin with "\", * may be fully qualified and begin with "\". If it does not begin with "\",
* the instance's $handlerNamespace is affixed to the begining. * the instance's $handlerNamespace is affixed to the begining.
* <br /><br /> *
* $item must also contain a "path", "template", or "pattern" property to * $item must also contain a "path", "template", or "pattern" property to
* indicate how to create the StaticRoute, TemplateRoute, or RegexRoute. * indicate how to create the StaticRoute, TemplateRoute, or RegexRoute.
* *
@ -246,7 +246,7 @@ class RouteBuilder
* *
* The names SLUG, ALPHA, ALPHANUM, DIGIT, NUM convert to regex patterns. * The names SLUG, ALPHA, ALPHANUM, DIGIT, NUM convert to regex patterns.
* Anything else passes through as is. * Anything else passes through as is.
* <br /><br /> *
* If you wish to use additional named patterns, subclass RouteBuilder and * If you wish to use additional named patterns, subclass RouteBuilder and
* override getTemplateVariablePattern. * override getTemplateVariablePattern.
* *
@ -269,5 +269,4 @@ class RouteBuilder
return $variable; return $variable;
} }
} }
} }

View File

@ -73,5 +73,4 @@ class RegexRoute extends BaseRoute
{ {
return $this->pattern; return $this->pattern;
} }
} }