view release on metacpan or  search on metacpan

docsrc/reference.xml  view on Meta::CPAN

    </refsect1>
   </refentry>
   
   <refentry id="model.api.ignore_fillinform_fields">
    <refnamediv>
     <refname>ignore_fillinform_fields</refname>
     <refpurpose>
      Fills in HTML Forms
     </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
     <synopsis>
  $model->ignore_fillinform_fields( qw/email name/ );
     </synopsis>
    </refsynopsisdiv>
    <refsect1>
     <title>Description</title>
     <para>
     All fields named in this call are NOT changed by fillinform.
    </para>
    </refsect1>
   </refentry>

   <refentry id="model.api.pnotes">
    <refnamediv>
     <refname>pnotes</refname>
     <refpurpose>
      Pass values from one method/handler to another
     </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
     <synopsis>
sub pkit_auth_credential {
  # ...
  $model->pnotes(user_id => $user_id);
  # ...
}
     </synopsis>
    </refsynopsisdiv>
    <refsect1>
     <title>Description</title>
     <para>
Wrapper to mod_perl's <literal>pnotes</literal> method, used to pass values from
one handler to another.
     </para>
     <para>
In the example above the <literal>user_id</literal> is set when the user
gets authenticated.
     </para>
    </refsect1>
   </refentry>
   <refentry id="model.api.output_convert">
    <refnamediv>
     <refname>output_convert</refname>
     <refpurpose>
      Outputs data for display, converting charset.
     </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
     <synopsis>
      $model->output_convert(output => {foo => $utf8_text},
			     input_charset => 'UTF-8');
     </synopsis>
    </refsynopsisdiv>
    <refsect1>
     <title>Description</title>
     <para>
      This is a wrapper to the <link linkend="model.api.output">output</link>
      method.  It converts the output from the character set specified by
      the charset argument to <link linkend="config.global.default_output_charset">default_output_charset</link>.  If the character set is not specified, then
      <link linkend="config.global.default_input_charset">default_input_charset</link> is used.
     </para>
    </refsect1>
    <refsect1>
     <title>Examples</title>
     <informalexample>
      <programlisting>
      # converts from UTF-8
      $model->output_convert(output => { key => $utf8_text },
			     charset => 'UTF-8');
      # converts from default_input_charset
      $model->output_convert(key => $text)
      </programlisting>
     </informalexample>
    </refsect1>
   </refentry>
   <refentry id="model.api.output">
    <refnamediv>
     <refname>output</refname>
     <refpurpose>
      Outputs data for display.
     </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
     <synopsis>
      $model->output(NAME => "John Doe");
     </synopsis>
    </refsynopsisdiv>
    <refsect1>
     <title>Description</title>
     <para>
      This is similar to the <ulink uri="http://kobesearch.cpan.org/search?dist=HTML-Template">HTML::Template</ulink> <literal>param</literal> method.  It is
      used to set the <link linkend="model.tags">model tags</link> in the
      PageKit templates..
     </para>
    </refsect1>
    <refsect1>
     <title>Examples</title>
     <informalexample>
      <programlisting>
  # set multiple paramaters
  $model->output(firstname => $firstname,
               lastname => $lastname);

  # set multiple paramaters with hash ref
  $model->output({firstname => $firstname,
               lastname => $lastname});

  # sets &lt;MODEL_LOOP NAME="foo"&gt;
  #       &lt;MODEL_VAR NAME="bar"/&gt;
  #       &lt;MODEL_VAR NAME="baz"/&gt;
  #      &lt;/MODEL_LOOP&gt;
  $model->output(foo => [
			 {bar => $bar1, baz => $baz1},
			 {bar => $bar2, baz => $baz2},
			]);
      </programlisting>
     </informalexample>
    </refsect1>
   </refentry>
   <refentry id="model.api.pkit_query">
    <refmeta>
     <refentrytitle>pkit_query</refentrytitle>
    </refmeta>
    <refnamediv>
     <refname>pkit_query</refname>
     <refpurpose>
      Wrapper to HTML::Template::query
     </refpurpose>