/ 
ASP4-1.028
River stage one • 4 direct dependents • 4 total dependents
/ ASP4::ConfigNode::Web

NAME

ASP4::ConfigNode::Web - The $Config->web object.

SYNOPSIS

Given the following configuration...

{
  ...
  web: {
    application_name: "DefaultApp",
    application_root: "@ServerRoot@",
    www_root:         "@ServerRoot@/htdocs",
    handler_root:     "@ServerRoot@/handlers",
    page_cache_root:  "/tmp/PAGE_CACHE",
    handler_resolver: "ASP4::HandlerResolver",
    handler_runner:   "ASP4::HandlerRunner",
    filter_resolver:  "ASP4::FilterResolver",
    request_filters: [
      {
        uri_match:    "^/.*",
        filter_class: "My::Filter"
      }
    ],
    disable_persistence: [
      {
        uri_match:            "^/nostate/.*",
        disable_session:      true,
        disable_application:  false
      }
    ]
  }
  ...
}

You would access it like this:

$Config->web->application_name;           # 'MyApp'
$Config->web->application_root;           # '/usr/local/projects/mysite.com'
$Config->web->handler_root;               # '/usr/local/projects/mysite.com/handlers'
$Config->web->www_root;                   # '/usr/local/projects/mysite.com/htdocs'
$Config->web->page_cache_root;            # '/tmp/PAGE_CACHE'

You will never need to do this:
foreach my $filter ( $Config->web->request_filters )
{
  my $regexp  = $filter->uri_match;
  my $class   = $filter->class;
}# end foreach()

DESCRIPTION

ASP4::ConfigNode::Web provides access to the web portion of the configuration.

PUBLIC PROPERTIES

application_name

Returns the name of the application.

application_root

Returns the absolute path to the root of the application, i.e. /usr/local/projects/mysite.com

handler_root

Returns the absolute path to where the 'handlers' are installed, i.e. /usr/local/projects/mysite.com/handlers

www_root

Returns the absolute path to where the normal website files (ASP, images, css, javascripts, etc) are located, i.e. /usr/local/projects/mysite.com/htdocs

page_cache_root

Returns the absolute path to where 'compiled' ASP scripts are stored, i.e. /tmp/PAGE_CACHE

Since the 'compiled' ASP scripts are overwritten whenever the source ASP script has been changed on disk, the webserver process must have read/write access to this location.

It is recommended that a temporary path is used - '/tmp' on most Linux distributions.

request_filters

Returns a list of ConfigNodes that represent individual filter elements in the configuration.

router

*IF* you have defined a "routes" section in your config - like this:

...
"web": {
  ...
  "routes": [
    {
      "name":   "Wiki",
      "path":   "/:lang-:locale/{*page}",
      "target": "/wiki-page.asp",
      "defaults": {
        "page":   "home",
        "lang":   "en",
        "locale": "us"
      }
    }
  ]
  ...
}

Then the router property will return a Router::Generic object based on your routes.

You can access it from the $Config like this:

$Config->web->router

SEE ALSO

ASP4::RequestFilter

BUGS

It's possible that some bugs have found their way into this release.

Use RT http://rt.cpan.org/NoAuth/Bugs.html?Dist=ASP4 to submit bug reports.

HOMEPAGE

Please visit the ASP4 homepage at http://www.devstack.com/ to see examples of ASP4 in action.

AUTHOR

John Drago <jdrago_999@yahoo.com>

COPYRIGHT AND LICENSE

Copyright 2007 John Drago, All rights reserved.

This software is free software. It may be used and distributed under the same terms as Perl itself.