From: Karen Etheridge Date: Sun, 22 Jul 2012 07:22:42 +0000 (-0700) Subject: some doc cleanup X-Git-Tag: v0.021~24 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=65e03df094ba4c97b83364d50d61dd17a064d91c;p=catagits%2FWeb-Simple.git some doc cleanup --- diff --git a/lib/Web/Simple.pm b/lib/Web/Simple.pm index 29c9933..0dc06f1 100644 --- a/lib/Web/Simple.pm +++ b/lib/Web/Simple.pm @@ -213,10 +213,10 @@ array ref. If you return a subroutine with a prototype, the prototype is treated as a match specification - and if the test is passed, the body of the -sub is called as a method any matched arguments (see below for more details). +sub is called as a method and passed any matched arguments (see below for more details). -You can also return a plain subroutine which will be called with just $env -- remember that in this case if you need $self you -must- close over it. +You can also return a plain subroutine which will be called with just C<$env> +- remember that in this case if you need C<$self> you B close over it. If you return a normal object, L will simply return it upwards on the assumption that a response_filter (or some arbitrary L) @@ -240,8 +240,8 @@ This user object 'bubbles up' through all the wrapping middleware until it hits the C we defined, after which the return is converted to a true html response. -However, two types of object are treated specially - a Plack::App object -will have its C<->to_app> method called and be used as a dispatcher: +However, two types of object are treated specially - a C object +will have its C method called and be used as a dispatcher: sub dispatch_request { my $self = shift; @@ -249,7 +249,7 @@ will have its C<->to_app> method called and be used as a dispatcher: ... } -A Plack::Middleware object will be used as a filter for the rest of the +A L object will be used as a filter for the rest of the dispatch being returned into: ## responds to /admin/track_usage AND /admin/delete_accounts @@ -267,7 +267,7 @@ dispatch being returned into: }, } -Note that this is for the dispatch being -returned- to, so if you want to +Note that this is for the dispatch being B to, so if you want to provide it inline you need to do: ## ALSO responds to /admin/track_usage AND /admin/delete_accounts @@ -321,7 +321,7 @@ also match more than one part: sub (/domain/*/user/*) { my ($self, $domain, $user) = @_; -and so on. To match an arbitrary number of parts, use - +and so on. To match an arbitrary number of parts, use C<**>: sub (/page/**) { my ($self, $match) = @_; @@ -333,9 +333,9 @@ This will result in a single element for the entire match. Note that you can do to match an arbitrary number of parts up to but not including some final part. -Note: Since Web::Simple handles a concept of file extensions, * and ** +Note: Since Web::Simple handles a concept of file extensions, C<*> and C<**> matchers will not by default match things after a final dot, and this -can be modified by using *.* and **.* in the final position, i.e.: +can be modified by using C<*.*> and C<**.*> in the final position, e.g.: /one/* matches /one/two.three and captures "two" /one/*.* matches /one/two.three and captures "two.three" @@ -346,7 +346,7 @@ Finally, sub (/foo/...) { -Will match C on the beginning of the path -and- strip it. This is +Will match C on the beginning of the path B strip it. This is designed to be used to construct nested dispatch structures, but can also prove useful for having e.g. an optional language specification at the start of a path. @@ -402,7 +402,7 @@ when it is contained in this type of path match. It matches to an empty path. =head4 Naming your patch matches -Any */**/*.*/**.* match can be followed with :name to make it into a named +Any C<*>, C<**>, C<*.*>, or C<**.*> match can be followed with C<:name> to make it into a named match, so: sub (/*:one/*:two/*:three/*:four) { @@ -440,7 +440,7 @@ This makes it necessary to be explicit about the trailing slash. sub (.html) { will match .html from the path (assuming the subroutine itself returns -something, of course). This is normally used for rendering - e.g. +something, of course). This is normally used for rendering - e.g.: sub (.html) { response_filter { $self->render_html($_[1]) } @@ -463,7 +463,7 @@ The body spec will match if the request content is either application/x-www-form-urlencoded or multipart/form-data - the latter of which is required for uploads - see below. -The param spec is elements of one of the following forms - +The param spec is elements of one of the following forms: param~ # optional parameter param= # required parameter @@ -476,16 +476,16 @@ The param spec is elements of one of the following forms - * # include all other parameters in hashref @* # include all other parameters as multiple in hashref -separated by the & character. The arguments added to the request are -one per non-:/* parameter (scalar for normal, arrayref for multiple), -plus if any :/* specs exist a hashref containing those values. +separated by the C<&> character. The arguments added to the request are +one per non-C<:>/C<*> parameter (scalar for normal, arrayref for multiple), +plus if any C<:>/C<*> specs exist a hashref containing those values. Please note that if you specify a multiple type parameter match, you are ensured of getting an arrayref for the value, EVEN if the current incoming request has only one value. However if a parameter is specified as single and multiple values are found, the last one will be used. -For example to match a page parameter with an optional order_by parameter one +For example to match a C parameter with an optional C parameter one would write: sub (?page=&order_by~) { @@ -516,7 +516,7 @@ You can also mix these, so: my ($self, $foo, $bar, $params); where $bar is an arrayref (possibly an empty one), and $params contains -arrayref values for all parameters -not- mentioned and a scalar value for +arrayref values for all parameters B mentioned and a scalar value for the 'coffee' parameter. Note, in the case where you combine arrayref, single parameter and named @@ -597,7 +597,7 @@ which will never match! =head3 Whitespace -Note that for legibility you are permitted to use whitespace - +Note that for legibility you are permitted to use whitespace: sub (GET + /user/*) { @@ -612,7 +612,7 @@ If your dispatch specification causes your dispatch subroutine to receive a hash reference as its first argument, the contained named parameters will be accessible via C<%_>. -This can be used to access your path matches, if they're named: +This can be used to access your path matches, if they are named: sub (GET + /foo/:path_part) { [ 200, @@ -641,21 +641,21 @@ of parameters by their name: ], } -Note that only the first hash reference will be avaialble via C<%_>. If +Note that only the first hash reference will be available via C<%_>. If you receive additional hash references, you will need to access them as usual. =head3 Accessing the PSGI env hash In some cases you may wish to get the raw PSGI env hash - to do this, -you can either use a plain sub - +you can either use a plain sub: sub { my ($env) = @_; ... } -or use the PSGI_ENV constant exported to retrieve it: +or use the C constant exported to retrieve it from C<@_>: sub (GET + /foo + ?some_param=) { my $param = $_[1]; @@ -697,9 +697,9 @@ It creates and returns a special dispatcher that always matches, and instead of continuing dispatch re-delegates it to the start of the dispatch process, but with the path of the request altered to the supplied URL. -Thus if you receive a POST to '/some/url' and return a redispatch to -'/other/url', the dispatch behaviour will be exactly as if the same POST -request had been made to '/other/url' instead. +Thus if you receive a POST to C and return a redispatch to +C, the dispatch behaviour will be exactly as if the same POST +request had been made to C instead. Note, this is not the same as returning an HTTP 3xx redirect as a response; rather it is a much more efficient internal process. @@ -720,15 +720,15 @@ dispatch {} has gone away - instead, you write: ... } -Note that this method is still -returning- the dispatch code - just like -dispatch did. +Note that this method is still B the dispatch code - just like +C did. -Also note that you need the 'my $self = shift' since the magic $self +Also note that you need the C<< my $self = shift >> since the magic $self variable went away. =item * the magic $self variable went away. -Just add 'my $self = shift;' while writing your 'sub dispatch_request {' +Just add C<< my $self = shift; >> while writing your C<< sub dispatch_request { >> like a normal perl method. =item * subdispatch deleted - all dispatchers can now subdispatch