X-Git-Url: https://git.dogcows.com/gitweb?a=blobdiff_plain;f=lib%2FCGI%2FEx%2FApp.pod;h=8194920dcae1aa3e228bb8f382b82568ee0c06bc;hb=a2f50b1efd2bc986617e1de5f5a0bfd8a2953b0e;hp=59c5e21a35c0cafaadfb295c59beaddf588b8901;hpb=b6e904ff7b346908d0662aae9a9c5f7d976dd85e;p=chaz%2Fp5-CGI-Ex diff --git a/lib/CGI/Ex/App.pod b/lib/CGI/Ex/App.pod index 59c5e21..8194920 100644 --- a/lib/CGI/Ex/App.pod +++ b/lib/CGI/Ex/App.pod @@ -208,7 +208,7 @@ The nav_loop method will run as follows: # exits nav_loop if true ->morph - # check ->allow_morph + # check ->allow_morph (hook) # check ->allow_nested_morph # ->morph_package (hook - get the package to bless into) # ->fixup_after_morph if morph_package exists @@ -981,7 +981,7 @@ The following is the alphabetical list of methods and hooks. =over 4 -=item allow_morph (method) +=item allow_morph (hook) Should return true if this step is allowed to "morph" the current App object into another package. Default is false. It is passed a single @@ -1028,7 +1028,8 @@ steps to the end of the current path. =item auth_args (method) -Should return a hashref that will be passed to the new method of CGI::Ex::Auth. +Should return a hashref that will be passed to the auth_obj method +which should return a CGI::Ex::Auth compatible object. It is augmented with arguments that integrate it into CGI::Ex::App. See the get_valid_auth method and the CGI::Ex::Auth documentation. @@ -1051,6 +1052,11 @@ was successful - so this data can be defined but false. See the get_valid_auth method. +=item auth_obj (method) + +Passed auth_args. Should return a CGI::Ex::Auth compatible object. Default +is to call CGI::Ex::Auth->new with the passed args. + =item base_dir_abs (method) Used as the absolute base directory to find template, validation and conf files. @@ -1139,24 +1145,28 @@ load_conf is false).. Caches results in $self->{'conf'}. +If the conf_file can't be found, the method will die unless +conf_die_on_fail returns 0 (defaults to true). + +=item conf_args + +Used by conf_obj. + +Defaults to $self->{'conf_args'} which defaults to {}. Will have +paths => $self->conf_path added before passing to CGI::Ex::Conf->new. + =item conf_file (method) Used by conf for finding the configuration file to load. Defaults to $self->{'conf_file'} which defaults $self->name_module with the extention -returned by $self->conf_ext added on. For example, if name_module -returns "my_app" and conf_ext returns "ini" the value returned will +returned by $self->ext_conf added on. For example, if name_module +returns "my_app" and ext_conf returns "ini" the value returned will be "my_app.ini". The value returned can absolute. If the value will be searched for in the paths passed to conf_obj. -The conf_ext may be any of those extentions understood by CGI::Ex::Conf. - -=item conf_ext - -Used by the default conf_file method. Defaults to $self->{'conf_ext'} which -defaults to 'pl' meaning that the read configuration file should return a -valid perl hashref. +The ext_conf may be any of those extentions understood by CGI::Ex::Conf. =item conf_obj @@ -1172,13 +1182,6 @@ Defaults to $self->{'conf_path'} which defaults to base_dir_abs. Should be a path or an arrayref of paths to look the configuration file returned by conf_file when that file is not absolute. -=item conf_args - -Used by conf_obj. - -Defaults to $self->{'conf_args'} which defaults to {}. Will have -paths => $self->conf_path added before passing to CGI::Ex::Conf->new. - =item conf_validation Used by default conf method. @@ -1284,6 +1287,12 @@ hooks for the current and remaining steps. It is used to allow the unmorphed before returning. Also - the post_navigate method will still be called. +=item ext_conf + +Used by the default conf_file method. Defaults to $self->{'ext_conf'} which +defaults to 'pl' meaning that the read configuration file should return a +valid perl hashref. + =item ext_print (method) Added as suffix to "name_step" during the default file_print hook.