<?xml version="1.0"?><phpdoc><class name="assistant" extends="panemanager" undoc="false" access="private" package="Form"><file>c:/www/apache/doc2//form/assistant.inc</file><doc><author email="ulf.wendel@phpdoc.de">Ulf Wendel</author><inherited src="Array"/><overriden src="Array"/><description/><shortdescription>Assistant/wizard that guides a user through several forms.</shortdescription><version>$Id: assistant.inc,v 1.18 2000/12/19 13:34:14 uw Exp $</version></doc><function name="restoreAssistant" undoc="true" access="private"><doc><return type="void"/><overriden src="panemanager"/><description/><shortdescription>Restores the Assistant. Load the pages with values, sets validation flags etc.</shortdescription></doc></function><function name="setTemplatePath" undoc="false" access="public"><doc><parameter name="$template" type="string"/><return name="$ok" type="bool"/><throws>form_error</throws><description/><shortdescription>Sets the path to the templates</shortdescription></doc></function><function name="newTemplate" undoc="false" access="private"><doc><return name="" type="boolean"/><throws>form_error</throws><description/><shortdescription>Creates a new template object.</shortdescription></doc></function><function name="setTemplateFiles" undoc="false" access="public"><doc><see type="var">$template_files</see><parameter name="$files" type="array"/><return type="void"/><description/><shortdescription>Set the template files</shortdescription></doc></function><function name="get" undoc="true" access="public"><doc><see type="function">show()</see><return name="$html" type="string"/><overriden src="panemanager"/><description/><shortdescription>Returns the current page.</shortdescription></doc></function><function name="show" undoc="true" access="private"><doc><see type="function">show()</see><return type="void"/><overriden src="panemanager"/><description/><shortdescription>Prints and returns the HTML code of the assistant.</shortdescription><brother>get</brother></doc></function><function name="saveFormValues" undoc="false" access="private"><doc><return type="void"/><description/><shortdescription>Get the values of the last form.</shortdescription></doc></function><function name="loadFormValues" undoc="false" access="private"><doc><return type="void"/><description/><shortdescription>Load the form with values before we display it.</shortdescription></doc></function><function name="currentPageName" undoc="false" access="public"><doc><see type="function">isValid()</see><see type="function">currentPageID()</see><return name="$page_name" type="string"/><description/><shortdescription>Return the name of the current page</shortdescription></doc></function><function name="currentPageID" undoc="false" access="public"><doc><see type="function">isValid()</see><see type="function">currentPageName()</see><return name="$page_id" type="int"/><description>The first page defined with addPage() call gets the ID 0, the second 1 and so on.If a negative number is returned the help or exit button is pressed.</description><shortdescription>Returns the ID of the current page.</shortdescription></doc></function><function name="PageNametoPageID" undoc="false" access="private"><doc><see type="function">isValid()</see><parameter name="$page_name" type="string"/><return name="" type="integer"> -1: not found</return><throws>form_error</throws><description/><shortdescription>Returns the page_id (page__values/page_errors index) that belongs to a page name.</shortdescription></doc></function><function name="isValid" undoc="false" access="public"><doc><parameter name="$page" default="&amp;quot;&amp;quot;" type="string"/><return name="$ok" type="bool"/><description/><shortdescription>Are all pages valid, is the requested page valid?</shortdescription></doc></function><function name="getNeighbour" undoc="false" access="private"><doc><parameter name="$now" type="string"/><return name="" type="array"> ($prev, $next)</return><description/><shortdescription>Find the previous and the next element of the current element.</shortdescription></doc></function><function name="setPageErrors" undoc="false" access="private"><doc><return name="$ok" type="bool"/><description/><shortdescription>Sets the error flags of all pages.</shortdescription></doc></function><function name="updatePageErrors" undoc="false" access="public"><doc><parameter name="$pages" default="&amp;quot;&amp;quot;" type="mixed">of one page, or array of page names. The default of&#x0a;an empty string means all pages.</parameter><return name="$ok" type="boolean"/><description/><shortdescription>If you override some page_values in Init() you have to update the  page validation flags.</shortdescription></doc></function><function name="findSelected" undoc="false" access="private"><doc><see type="var">$selected</see><see type="var">$lastviewed</see><see type="function">findPosition()</see><return name="" type="boolean"/><description/><shortdescription>Saves the number of the selected Page to $this-&amp;gt;selected</shortdescription></doc></function><function name="findPosition" undoc="false" access="private"><doc><see type="function">findSelected()</see><return type="void"/><description>findSelected() searches the ID of the requested page. findPosition()tests wheter the user is allowed to see the requested page or ifhe should get rejected.</description><shortdescription>Find the page that was gets shown next.</shortdescription></doc></function><function name="getPageNames" undoc="false" access="public"><doc><return name="$pagenames" type="array"/><throws>form_error</throws><description>page_id =&amp;gt; name</description><shortdescription>Returns an array with the names of all pages.</shortdescription></doc></function><function name="addPage" undoc="true" access="public"><doc><parameter name="$pagedata" type="array"/><return name="$ok" type="bool"/><overriden src="panemanager"/><description/><shortdescription>Add a page to the assistant</shortdescription></doc></function><function name="setMode" undoc="false" access="public"><doc><parameter name="$mode" type="string"/><return type="void"/><description>If set to &amp;quot;strict&amp;quot; the user must complete a form before he gets to thenext tab. If set to &amp;quot;weak&amp;quot; he&amp;apos;s free to switch between the tabs.In both cases he&amp;apos;s not allowed to finish the assistant beforeall forms/tabs that are not declared as optional are without errors</description><shortdescription>Sets the &amp;quot;switching mode&amp;quot;.</shortdescription></doc></function><variable name="$classname" access="public" type="string">&amp;quot;assistant&amp;quot;<doc><overriden src="panemanager"/><description/><shortdescription>PHPLIB persistance helper, name of this class.</shortdescription></doc></variable><variable name="$persistent_slots" access="public" type="array">array(&amp;quot;page_errors&amp;quot;, &amp;quot;page_values&amp;quot;, &amp;quot;lastviewed&amp;quot;)<doc><overriden src="panemanager"/><description/><shortdescription>PHPLIB persistance helper, list of persistant &amp;quot;slots&amp;quot;.</shortdescription></doc></variable><variable name="$page_errors" access="private" type="array">array()<doc><description>- must be restored by a session! -</description><shortdescription>Array with status (isValid()) information of each page.</shortdescription></doc></variable><variable name="$lastviewed" access="private" type="integer"><doc><description>- must be restored by a session! -</description><shortdescription>Which page was shown last?</shortdescription></doc></variable><variable name="$selected" access="private" type="integer">-1<doc><description/><shortdescription>Which page was selected by the user?</shortdescription></doc></variable><variable name="$now" access="private" type="integer">-1<doc><description/><shortdescription>Which page will be show now?</shortdescription></doc></variable><variable name="$tpl" access="private" type="string">&amp;quot;&amp;quot;<doc><description/><shortdescription>Template object.</shortdescription></doc></variable><variable name="$template" access="private" type="string">&amp;quot;&amp;quot;<doc><description/><shortdescription>Path to the template files.</shortdescription></doc></variable><variable name="$unknowns" access="private" type="string">&amp;quot;remove&amp;quot;<doc><description/><shortdescription>How to handle unknowns.</shortdescription></doc></variable><variable name="$template_files" access="private" type="array">array(&#x0a;															&amp;quot;main&amp;quot;	=&amp;gt; &amp;quot;assistant_main.tpl&amp;quot;&#x0a;															#&amp;quot;tabs&amp;quot;	=&amp;gt; &amp;quot;assistant_tabs.html&amp;quot;&#x0a;												)<doc><see type="function">setTemplateFiles()</see><description/><shortdescription>Template files.</shortdescription></doc></variable><variable name="$mode" access="private" type="string">&amp;quot;strict&amp;quot;<doc><see type="function">setMode()</see><description/><shortdescription>&amp;quot;switching mode&amp;quot;</shortdescription></doc></variable><variable name="$buttonname" access="private" type="string">&amp;quot;assistant&amp;quot;<doc><overriden src="panemanager"/><description/><shortdescription>Nameprefix of all buttons generated by assistant.</shortdescription></doc></variable><variable name="$flag_specials" access="private" type="string">&amp;quot;&amp;quot;<doc><see type="function">get()</see><see type="function">findPosition()</see><description/><shortdescription>Flag, set if specials.</shortdescription></doc></variable><inherited src="panemanager" type="functions"><element>init</element><element>getresetbutton</element><element>getbutton</element><element>gettab</element><element>issethttpxvar</element><element>isfinishpressed</element><element>isexitpressed</element><element>ishelppressed</element><element>sethelp</element><element>setexitbutton</element><element>setfinishbutton</element><element>showtabs</element><element>setstart</element><element>setmethod</element><element>getstart</element><element>start</element><element>setfinish</element><element>getfinish</element><element>finish</element><element>arrayregexpkeysearch</element><element>setlabels</element><element>getpagevalues</element><element>getpagevalueswithtranslatednames</element></inherited><inherited src="form_commonobject" type="functions"><element>introspection</element></inherited><inherited src="panemanager" type="variables"><element>$page_values</element><element>$pages</element><element>$finish_button</element><element>$exit</element><element>$help</element><element>$method</element><element>$form_start</element><element>$form_end</element><element>$show_tabs</element><element>$labels</element><element>$show_prevnext</element></inherited><inherited src="form_commonobject" type="variables"><element>$cr_html</element><element>$exceptions</element></inherited><path><parent>panemanager</parent><parent>form_commonobject</parent></path><baseclass>form_commonobject</baseclass></class></phpdoc>