view release on metacpan or  search on metacpan

docsrc/reference.xml  view on Meta::CPAN

<literal><link linkend="config.page.page_session">page_session</link></literal>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry id="config.global.page_session_class">
     <term>page_session_class</term>
     <listitem>
      <para>
      Name for the Module, that is used to create the page_session objects.
      Defaults to <emphasis>Apache::SessionX</emphasis>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry id="config.global.post_max">
     <term>post_max</term>
     <listitem>
      <para>
Maximum size of file uploads, in bytes.  Defaults to 100,000,000 (100 MB).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry id="config.global.upload_tmp_dir">
     <term>upload_tmp_dir</term>
     <listitem>
      <para>
Temporary directory for file uploads. Defaults to whatever libapreq finds usefull. 
This options is only usefull if you use libapreq &gt;= 1.0. The temporary directory
usually needs to reside on the same filesystem as the location supplied to the 
upload object's <programlisting>link</programlisting> method. See the Apache::Request 
documentation for further information.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry id="config.global.protect_static">
     <term>protect_static</term>
     <listitem>
      <para>
      If set to <emphasis>yes</emphasis> static files can also be protected with the
      require_login attribute in the SECTION or PAGE tags.
      Set this option to <emphasis>no</emphasis> to be compatible to PageKit &lt; 1.09.
      Defaults to <emphasis>yes</emphasis>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry id="config.global.recent_login_timeout">
     <term>recent_login_timeout</term>
     <listitem>
      <para>
Seconds that user's session has to be inactive before a user is asked
to verify a password on pages with the <literal><link linkend="config.page.require_login">require_login</link></literal> attribute
set to <emphasis>recent</emphasis>. Defaults to 3600 (1 hour).
      </para>
     </listitem>
    </varlistentry>
   <varlistentry id="config.global.relaxed_parser">
    <term>relaxed_parser</term>
    <listitem>
     <para>
       If set to yes, this option allows template tags to be placed inside
HTML comments. It also permits spaces and newlines within the tag itself.
This option may be useful to HTML authors who would like to validate their
templates' HTML syntax prior to processing, or who use DTD-aware editing
tools.

      Defaults to <emphasis>no</emphasis>.
      <informalexample>
       <programlisting>
        relaxed_parser = "yes"

        # these tags are all allowed if relaxed_parser is enabled:
        &lt;MODEL_VAR NAME="x"&gt;
        &lt; MODEL_VAR NAME = 'x' &gt;
        &lt; MODEL_LOOP NAME = x &gt;
        &lt; PKIT_COMPONENT NAME = x /&gt;
        &lt;!-- MODEL_VAR NAME="x" --&gt;
        &lt;!--   CONTENT_VAR   NAME   =    "x"   /--&gt;
       </programlisting>
      </informalexample>
     </para>
    </listitem>
   </varlistentry>
    <varlistentry id="config.global.request_param_in_tmpl">
     <term>request_param_in_tmpl</term>
     <listitem>
      <para>
If set to yes, then <literal><link linkend="model.var">&lt;MODEL_VAR&gt;</link></literal> tags in template automatically get filled in
with corresponding request parameters across all pages.  Can be overriden
by the corresponding <link linkend="config.page.request_param_in_tmpl">page attribute</link>.  Defaults to <emphasis>no</emphasis>.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry id="config.global.request_class">
     <term>request_class</term>
     <listitem>
      <para>
      Name for the Module, that is used to create the request class objects.
      Defaults to <emphasis>Apache::Request::PageKit</emphasis>. Which is a 
      subclass of Apache::Request. A own subclass is usefull, if you like to
      change the data container for your requstparameter or modify them on
      init() or new(). 
      </para>
     </listitem>
    </varlistentry>

    <varlistentry id="config.global.session_class">
     <term>session_class</term>
     <listitem>
      <para>
      Name for the Module, that is used to create the session objects.
      Defaults to <emphasis>Apache::SessionX</emphasis>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry id="config.global.session_expires">
     <term>session_expires</term>
     <listitem>
      <para>
       Sets the expire time for the cookie that stores the session id on
       the user's computer.  If it is not set, then the expire time on the
       cookie will not be set, and the cookie will expire when the user closes

docsrc/reference.xml  view on Meta::CPAN

   </refentry>
   <refentry id="model.api.pkit_set_errorfont">
    <refnamediv>
     <refname>pkit_set_errorfont</refname>
     <refpurpose>
      Sets PKIT_ERRORSPAN tags
     </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
     <synopsis>
      $model->pkit_set_errorfont('state');

      # possible since version 1.08
      $model->pkit_set_errorfont( 'state', '#00ff00' );
     </synopsis>
    </refsynopsisdiv>
    <refsect1>
     <title>Description</title>
     <para>
     Superfluous since PageKit 1.08 please use <link linkend="model.api.pkit_set_errorspan">pkit_set_errorspan</link>.
     </para>
     <para>
      Sets the corresponding <link linkend="pkit.errorspan">PKIT_ERRORSPAN</link> tag in the template.  Useful
for implementing your own custom constraints. Since version 1.08 it is possible to select the errorstr. This
is done with the second parameter. The color must be a string thar starts with a # followed by exactly six hexdigits.
If you do not specify the errorstr, the string is taken from the
<literal><link linkend="config.global.default_errorstr">default_errorstr</link></literal>.
See also <link linkend="pkit.errorstr">PKIT_ERRORSTR</link>.
     </para>
    </refsect1>
   </refentry>

   <refentry id="model.api.pkit_set_errorspan">
    <refnamediv>
     <refname>pkit_set_errorspan</refname>
     <refpurpose>
      Sets PKIT_ERRORSPAN tags
     </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
     <synopsis>
      $model->pkit_set_errorspan('state');

      # possible since version 1.08
      $model->pkit_set_errorspan( 'state', '#00ff00' );
     </synopsis>
    </refsynopsisdiv>
    <refsect1>
     <title>Description</title>
     <para>
      Sets the corresponding <link linkend="pkit.errorspan">PKIT_ERRORSPAN</link> tag in the template.  Useful
for implementing your own custom constraints. Since version 1.08 it is possible to select the errorstr. This
is done with the second parameter. The color must be a string thar starts with a # followed by exactly six hexdigits.
If you do not specify the errorstr, the string is taken from the
<literal><link linkend="config.global.default_errorstr">default_errorstr</link></literal>.
See also <link linkend="pkit.errorstr">PKIT_ERRORSTR</link>.
     </para>
    </refsect1>

   </refentry>
   <refentry id="model.api.pkit_validate_input">
    <refnamediv>
     <refname>pkit_validate_input</refname>
     <refpurpose>
      Validates input from an HTML form.
     </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
     <synopsis><![CDATA[
  # very simple validation, just check to see if name field was filled out
  my $input_profile = {required => [ qw ( name ) ]};
  # validate user input
  unless($model->pkit_validate_input($input_profile)){
    # user must have not filled out name field, 
    # i.e. $apr->param('name') = $model->input('name') is
    # not set, so go back to original form
    # if you used a <PKIT_ERRORFONT NAME="name"> tag, then it will be set to
    # red
    $model->pkit_internal_redirect('orig_form');
    return;
  }
]]>
     </synopsis>
    </refsynopsisdiv>
    <refsect1>
     <title>Description</title>
     <para>
Takes an hash reference containing a <ulink url="http://kobesearch.cpan.org/search?dist=Data-FormValidator">Data::FormValidator</ulink> input profile
and returns true if the request parameters are valid.
     </para>
    </refsect1>
   </refentry>
   <refentry id="model.api.pkit_get_orig_uri">
    <refnamediv>
     <refname>pkit_get_orig_uri</refname>
     <refpurpose>
      Gets the original URI requested.
     </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
     <synopsis>
  my $orig_uri = $model->pkit_get_orig_uri;
     </synopsis>
    </refsynopsisdiv>
   </refentry>
   <refentry id="model.api.pkit_get_page_id">
    <refnamediv>
     <refname>pkit_get_page_id</refname>
     <refpurpose>
      Gets the page ID.
     </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
     <synopsis>
  my $page_id = $model->pkit_get_page_id;
     </synopsis>
    </refsynopsisdiv>
   </refentry>
   <refentry id="model.api.pkit_get_server_id">
    <refnamediv>
     <refname>pkit_get_server_id</refname>
     <refpurpose>
      Gets server ID.
     </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
     <synopsis>
  my $server_id = $model->pkit_get_server_id;
     </synopsis>
    </refsynopsisdiv>
    <refsect1>
     <title>Description</title>
     <para>