<?xml version="1.0" encoding="utf-8"?>
<project title="LDAP Account Manager" version="2.0.1&#10;">
  <file path="lib/font/verabi.php" generated-path="lib.font.verabi.html" hash="558fc8dd3966e4c99c6a5ab6ac7c50ec" package="PDF">
    <docblock line="0">
      <description>This file includes information about the Bitstream Vera font.</description>
      <long-description></long-description>
      <tag name="package" description="PDF" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="lib/font/vera.php" generated-path="lib.font.vera.html" hash="6673d5b56ca86e2ae069d2da679a6386" package="PDF">
    <docblock line="0">
      <description>This file includes information about the Bitstream Vera font.</description>
      <long-description></long-description>
      <tag name="package" description="PDF" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="lib/font/verab.php" generated-path="lib.font.verab.html" hash="e508250890555c3f6b95882195c66c5b" package="PDF">
    <docblock line="0">
      <description>This file includes information about the Bitstream Vera font.</description>
      <long-description></long-description>
      <tag name="package" description="PDF" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="lib/font/verai.php" generated-path="lib.font.verai.html" hash="13a25d06a4dc03a58ca3e738ff6a7333" package="PDF">
    <docblock line="0">
      <description>This file includes information about the Bitstream Vera font.</description>
      <long-description></long-description>
      <tag name="package" description="PDF" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="lib/profiles.inc" generated-path="lib.profiles.inc.html" hash="c07df3c81f339b8bd01cbe88278bae6b" package="profiles">
    <docblock line="0">
      <description>This file provides functions to load and save account profiles.</description>
      <long-description></long-description>
      <tag name="package" description="profiles" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <function namespace="" line="39" package="profiles">
      <name>getAccountProfiles</name>
      <full_name>\getAccountProfiles()</full_name>
      <docblock line="39">
        <description>Returns an array of string with all available profiles for the given account type</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="39" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;server profile name&lt;/p&gt;" line="39" type="string" variable="$profile">
          <type>string</type>
        </tag>
        <tag name="return" description="profile names" line="39" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$profile</name>
        <default>null</default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="73" package="profiles">
      <name>loadAccountProfile</name>
      <full_name>\loadAccountProfile()</full_name>
      <docblock line="73">
        <description>Loads an profile of the given account type</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;name of the profile (without .&lt;scope&gt; extension)&lt;/p&gt;&#10;" line="73" type="string" variable="$profile">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="73" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="return" description="hash array (attribute =&amp;gt; value)" line="73" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$profile</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="117" package="profiles">
      <name>saveAccountProfile</name>
      <full_name>\saveAccountProfile()</full_name>
      <docblock line="117">
        <description>Saves an hash array (attribute =&gt; value) to an account profile</description>
        <long-description>file is created, if needed</long-description>
        <tag name="param" description="&lt;p&gt;hash array (attribute =&gt; value)&lt;/p&gt;&#10;" line="117" type="array" variable="$attributes">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;name of the account profile (without .&lt;scope&gt; extension)&lt;/p&gt;&#10;" line="117" type="string" variable="$profile">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="117" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="return" description="true, if saving succeeded" line="117" type="boolean">
          <type>boolean</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$attributes</name>
        <default></default>
        <type>array</type>
      </argument>
      <argument line="0">
        <name>$profile</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="154" package="profiles">
      <name>delAccountProfile</name>
      <full_name>\delAccountProfile()</full_name>
      <docblock line="154">
        <description>Deletes an account profile</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;name of profile (Without .&lt;scope&gt; extension)&lt;/p&gt;&#10;" line="154" type="string" variable="$file">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="154" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="return" description="true if profile was deleted" line="154" type="boolean">
          <type>boolean</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$file</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="174" package="profiles">
      <name>copyAccountProfiles</name>
      <full_name>\copyAccountProfiles()</full_name>
      <docblock line="174">
        <description>Copies account profiles to other server profiles.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;account profile names&lt;/p&gt;" line="174" type="array" variable="$accountProfiles">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;account scope&lt;/p&gt;" line="174" type="String" variable="$scope">
          <type>String</type>
        </tag>
        <tag name="param" description="&lt;p&gt;destinations&lt;/p&gt;" line="174" type="array" variable="$dests">
          <type>array</type>
        </tag>
        <tag name="return" description="operation succeeded" line="174" type="boolean">
          <type>boolean</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$accountProfiles</name>
        <default></default>
        <type>array</type>
      </argument>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>String</type>
      </argument>
      <argument line="0">
        <name>$dests</name>
        <default>array()</default>
        <type>array</type>
      </argument>
    </function>
    <source> </source>
  </file>
  <file path="lib/ldap.inc" generated-path="lib.ldap.inc.html" hash="e9623173552d5ed90c686324d15af15e" package="LDAP">
    <docblock line="0">
      <description>ldap.inc provides basic functions to connect to the OpenLDAP server.</description>
      <long-description></long-description>
      <tag name="package" description="LDAP" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <function namespace="" line="40" package="LDAP">
      <name>convertHex2bin</name>
      <full_name>\convertHex2bin()</full_name>
      <docblock line="40">
        <description>Converts a HEX string to a binary value</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;HEX string&lt;/p&gt;" line="40" type="string" variable="$value">
          <type>string</type>
        </tag>
        <tag name="return" description="result binary" line="40" type="\binary">
          <type>\binary</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$value</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <class final="false" abstract="false" namespace="" line="50" package="LDAP">
      <extends/>
      <name>Ldap</name>
      <full_name>\Ldap</full_name>
      <docblock line="50">
        <description>Ldap manages connection to LDAP and includes several helper functions.</description>
        <long-description></long-description>
        <tag name="package" description="LDAP" line="50"/>
      </docblock>
      <property static="false" visibility="private" line="53" namespace="" package="LDAP">
        <name>$conf</name>
        <default></default>
        <docblock line="53">
          <description>Object of Config to access preferences</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="56" namespace="" package="LDAP">
        <name>$server</name>
        <default></default>
        <docblock line="56">
          <description>Server handle</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="59" namespace="" package="LDAP">
        <name>$is_connected</name>
        <default>false</default>
        <docblock line="59">
          <description>LDAP connection established</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="62" namespace="" package="LDAP">
        <name>$username</name>
        <default></default>
        <docblock line="62">
          <description>LDAP username used for bind</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="64" namespace="" package="LDAP">
        <name>$password</name>
        <default></default>
        <docblock line="64">
          <description>LDAP password used for bind</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="71" package="LDAP">
        <name>__construct</name>
        <full_name>\Ldap::__construct()</full_name>
        <docblock line="71">
          <description>Creates a new LDAP object.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;an object of class Config&lt;/p&gt;" line="71" type="object" variable="$config">
            <type>object</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$config</name>
          <default></default>
          <type>object</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="90" package="LDAP">
        <name>connect</name>
        <full_name>\Ldap::connect()</full_name>
        <docblock line="90">
          <description>Connects to the server using the given username and password</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;user name&lt;/p&gt;" line="90" type="string" variable="$user">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;password&lt;/p&gt;" line="90" type="string" variable="$passwd">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;specifies if anonymous binds are allowed&lt;/p&gt;" line="90" type="boolean" variable="$allowAnonymous">
            <type>boolean</type>
          </tag>
          <tag name="return" description="if connect succeeds the server handle is returned, else false" line="90" type="mixed">
            <type>mixed</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$user</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$passwd</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$allowAnonymous</name>
          <default>false</default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="126" package="LDAP">
        <name>close</name>
        <full_name>\Ldap::close()</full_name>
        <docblock line="126">
          <description>Closes connection to server</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="137" package="LDAP">
        <name>server</name>
        <full_name>\Ldap::server()</full_name>
        <docblock line="137">
          <description>Returns the LDAP connection handle</description>
          <long-description></long-description>
          <tag name="return" description="connection handle" line="137" type="object">
            <type>object</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="147" package="LDAP">
        <name>__sleep</name>
        <full_name>\Ldap::__sleep()</full_name>
        <docblock line="147">
          <description>Closes connection to LDAP server before serialization</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="154" package="LDAP">
        <name>__wakeup</name>
        <full_name>\Ldap::__wakeup()</full_name>
        <docblock line="154">
          <description>Reconnects to LDAP server when deserialized</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="195" package="LDAP">
        <name>encrypt</name>
        <full_name>\Ldap::encrypt()</full_name>
        <docblock line="195">
          <description>Encrypts a string</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;string to encrypt&lt;/p&gt;" line="195" type="string" variable="$data">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;prefix for cookie names&lt;/p&gt;" line="195" type="string" variable="$prefix">
            <type>string</type>
          </tag>
          <tag name="return" description="encrypted string" line="195" type="object">
            <type>object</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$data</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$prefix</name>
          <default>''</default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="222" package="LDAP">
        <name>decrypt</name>
        <full_name>\Ldap::decrypt()</full_name>
        <docblock line="222">
          <description>Decrypts a string</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;string to decrypt&lt;/p&gt;" line="222" type="object" variable="$data">
            <type>object</type>
          </tag>
          <tag name="param" description="&lt;p&gt;prefix for cookie names&lt;/p&gt;" line="222" type="string" variable="$prefix">
            <type>string</type>
          </tag>
          <tag name="return" description="decrypted string" line="222" type="string">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$data</name>
          <default></default>
          <type>object</type>
        </argument>
        <argument line="0">
          <name>$prefix</name>
          <default>''</default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="250" package="LDAP">
        <name>encrypt_login</name>
        <full_name>\Ldap::encrypt_login()</full_name>
        <docblock line="250">
          <description>Encrypts username and password</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;LDAP user name&lt;/p&gt;" line="250" type="string" variable="$username">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;LDAP password&lt;/p&gt;" line="250" type="string" variable="$password">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$username</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$password</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="261" package="LDAP">
        <name>decrypt_login</name>
        <full_name>\Ldap::decrypt_login()</full_name>
        <docblock line="261">
          <description>Decrypts username and password</description>
          <long-description></long-description>
          <tag name="return" description="array(user name, password)" line="261" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="270" package="LDAP">
        <name>destroy</name>
        <full_name>\Ldap::destroy()</full_name>
        <docblock line="270">
          <description>Closes connection to LDAP server and deletes encrypted username/password</description>
          <long-description></long-description>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/tools/serverInfo.inc" generated-path="lib.tools.serverInfo.inc.html" hash="c193a9e0f7e76dda35aec2d2f6e4cc7b" package="tools">
    <docblock line="0">
      <description>This file includes the server information tool specification.</description>
      <long-description></long-description>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="package" description="tools" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="36" package="tools">
      <extends/>
      <implements>\LAMTool</implements>
      <name>toolServerInformation</name>
      <full_name>\toolServerInformation</full_name>
      <docblock line="36">
        <description>Server information</description>
        <long-description></long-description>
        <tag name="package" description="tools" line="36"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="43" package="tools">
        <name>getName</name>
        <full_name>\toolServerInformation::getName()</full_name>
        <docblock line="43">
          <description>Returns the name of the tool.</description>
          <long-description></long-description>
          <tag name="return" description="name" line="43" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="52" package="tools">
        <name>getDescription</name>
        <full_name>\toolServerInformation::getDescription()</full_name>
        <docblock line="52">
          <description>returns a description text for the tool.</description>
          <long-description></long-description>
          <tag name="return" description="description" line="52" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="61" package="tools">
        <name>getLink</name>
        <full_name>\toolServerInformation::getLink()</full_name>
        <docblock line="61">
          <description>Returns a link to the tool page (relative to templates/).</description>
          <long-description></long-description>
          <tag name="return" description="link" line="61" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="70" package="tools">
        <name>getRequiresWriteAccess</name>
        <full_name>\toolServerInformation::getRequiresWriteAccess()</full_name>
        <docblock line="70">
          <description>Returns if the tool requires write access to LDAP.</description>
          <long-description></long-description>
          <tag name="return" description="true if write access is needed" line="70" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="79" package="tools">
        <name>getRequiresPasswordChangeRights</name>
        <full_name>\toolServerInformation::getRequiresPasswordChangeRights()</full_name>
        <docblock line="79">
          <description>Returns if the tool requires password change rights.</description>
          <long-description></long-description>
          <tag name="return" description="true if password change rights are needed" line="79" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="88" package="tools">
        <name>getImageLink</name>
        <full_name>\toolServerInformation::getImageLink()</full_name>
        <docblock line="88">
          <description>Returns the link to the tool image (relative to graphics/)</description>
          <long-description></long-description>
          <tag name="return" description="image URL" line="88" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="98" package="tools">
        <name>getPosition</name>
        <full_name>\toolServerInformation::getPosition()</full_name>
        <docblock line="98">
          <description>Returns the prefered position of this tool on the tools page.</description>
          <long-description>The position may be between 0 and 1000. 0 is the top position.</long-description>
          <tag name="return" description="prefered position" line="98" type="int">
            <type>int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="107" package="tools">
        <name>getSubTools</name>
        <full_name>\toolServerInformation::getSubTools()</full_name>
        <docblock line="107">
          <description>Returns a list of sub tools or an empty array.</description>
          <long-description></long-description>
          <tag name="return" description="list of subtools (LAMTool)" line="107" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="116" package="tools">
        <name>isVisible</name>
        <full_name>\toolServerInformation::isVisible()</full_name>
        <docblock line="116">
          <description>Returns if the tool is visible in the menu.</description>
          <long-description></long-description>
          <tag name="return" description="visible" line="116" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="125" package="tools">
        <name>isHideable</name>
        <full_name>\toolServerInformation::isHideable()</full_name>
        <docblock line="125">
          <description>Returns if a tool may be hidden by configuration in the LAM server profile.</description>
          <long-description></long-description>
          <tag name="return" description="hideable" line="125" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/tools/fileUpload.inc" generated-path="lib.tools.fileUpload.inc.html" hash="39bee5671778cc65e7624a78dd93564e" package="tools">
    <docblock line="0">
      <description>This file includes the file upload tool specification.</description>
      <long-description></long-description>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="package" description="tools" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="36" package="tools">
      <extends/>
      <implements>\LAMTool</implements>
      <name>toolFileUpload</name>
      <full_name>\toolFileUpload</full_name>
      <docblock line="36">
        <description>File upload</description>
        <long-description></long-description>
        <tag name="package" description="tools" line="36"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="43" package="tools">
        <name>getName</name>
        <full_name>\toolFileUpload::getName()</full_name>
        <docblock line="43">
          <description>Returns the name of the tool.</description>
          <long-description></long-description>
          <tag name="return" description="name" line="43" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="52" package="tools">
        <name>getDescription</name>
        <full_name>\toolFileUpload::getDescription()</full_name>
        <docblock line="52">
          <description>returns a description text for the tool.</description>
          <long-description></long-description>
          <tag name="return" description="description" line="52" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="61" package="tools">
        <name>getLink</name>
        <full_name>\toolFileUpload::getLink()</full_name>
        <docblock line="61">
          <description>Returns a link to the tool page (relative to templates/).</description>
          <long-description></long-description>
          <tag name="return" description="link" line="61" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="70" package="tools">
        <name>getRequiresWriteAccess</name>
        <full_name>\toolFileUpload::getRequiresWriteAccess()</full_name>
        <docblock line="70">
          <description>Returns if the tool requires write access to LDAP.</description>
          <long-description></long-description>
          <tag name="return" description="true if write access is needed" line="70" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="79" package="tools">
        <name>getRequiresPasswordChangeRights</name>
        <full_name>\toolFileUpload::getRequiresPasswordChangeRights()</full_name>
        <docblock line="79">
          <description>Returns if the tool requires password change rights.</description>
          <long-description></long-description>
          <tag name="return" description="true if password change rights are needed" line="79" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="88" package="tools">
        <name>getImageLink</name>
        <full_name>\toolFileUpload::getImageLink()</full_name>
        <docblock line="88">
          <description>Returns the link to the tool image (relative to graphics/)</description>
          <long-description></long-description>
          <tag name="return" description="image URL" line="88" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="98" package="tools">
        <name>getPosition</name>
        <full_name>\toolFileUpload::getPosition()</full_name>
        <docblock line="98">
          <description>Returns the prefered position of this tool on the tools page.</description>
          <long-description>The position may be between 0 and 1000. 0 is the top position.</long-description>
          <tag name="return" description="prefered position" line="98" type="int">
            <type>int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="107" package="tools">
        <name>getSubTools</name>
        <full_name>\toolFileUpload::getSubTools()</full_name>
        <docblock line="107">
          <description>Returns a list of sub tools or an empty array.</description>
          <long-description></long-description>
          <tag name="return" description="list of subtools (LAMTool)" line="107" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="116" package="tools">
        <name>isVisible</name>
        <full_name>\toolFileUpload::isVisible()</full_name>
        <docblock line="116">
          <description>Returns if the tool is visible in the menu.</description>
          <long-description></long-description>
          <tag name="return" description="visible" line="116" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="125" package="tools">
        <name>isHideable</name>
        <full_name>\toolFileUpload::isHideable()</full_name>
        <docblock line="125">
          <description>Returns if a tool may be hidden by configuration in the LAM server profile.</description>
          <long-description></long-description>
          <tag name="return" description="hideable" line="125" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/tools/pdfEdit.inc" generated-path="lib.tools.pdfEdit.inc.html" hash="7d78629556e4bf2b2de0e05aeb2f593a" package="tools">
    <docblock line="0">
      <description>This file includes the PDF editor tool specification.</description>
      <long-description></long-description>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="package" description="tools" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="36" package="tools">
      <extends/>
      <implements>\LAMTool</implements>
      <name>toolPDFEditor</name>
      <full_name>\toolPDFEditor</full_name>
      <docblock line="36">
        <description>PDF editor</description>
        <long-description></long-description>
        <tag name="package" description="tools" line="36"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="43" package="tools">
        <name>getName</name>
        <full_name>\toolPDFEditor::getName()</full_name>
        <docblock line="43">
          <description>Returns the name of the tool.</description>
          <long-description></long-description>
          <tag name="return" description="name" line="43" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="52" package="tools">
        <name>getDescription</name>
        <full_name>\toolPDFEditor::getDescription()</full_name>
        <docblock line="52">
          <description>returns a description text for the tool.</description>
          <long-description></long-description>
          <tag name="return" description="description" line="52" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="61" package="tools">
        <name>getLink</name>
        <full_name>\toolPDFEditor::getLink()</full_name>
        <docblock line="61">
          <description>Returns a link to the tool page (relative to templates/).</description>
          <long-description></long-description>
          <tag name="return" description="link" line="61" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="70" package="tools">
        <name>getRequiresWriteAccess</name>
        <full_name>\toolPDFEditor::getRequiresWriteAccess()</full_name>
        <docblock line="70">
          <description>Returns if the tool requires write access to LDAP.</description>
          <long-description></long-description>
          <tag name="return" description="true if write access is needed" line="70" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="79" package="tools">
        <name>getRequiresPasswordChangeRights</name>
        <full_name>\toolPDFEditor::getRequiresPasswordChangeRights()</full_name>
        <docblock line="79">
          <description>Returns if the tool requires password change rights.</description>
          <long-description></long-description>
          <tag name="return" description="true if password change rights are needed" line="79" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="88" package="tools">
        <name>getImageLink</name>
        <full_name>\toolPDFEditor::getImageLink()</full_name>
        <docblock line="88">
          <description>Returns the link to the tool image (relative to graphics/)</description>
          <long-description></long-description>
          <tag name="return" description="image URL" line="88" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="98" package="tools">
        <name>getPosition</name>
        <full_name>\toolPDFEditor::getPosition()</full_name>
        <docblock line="98">
          <description>Returns the prefered position of this tool on the tools page.</description>
          <long-description>The position may be between 0 and 1000. 0 is the top position.</long-description>
          <tag name="return" description="prefered position" line="98" type="int">
            <type>int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="107" package="tools">
        <name>getSubTools</name>
        <full_name>\toolPDFEditor::getSubTools()</full_name>
        <docblock line="107">
          <description>Returns a list of sub tools or an empty array.</description>
          <long-description></long-description>
          <tag name="return" description="list of subtools (LAMTool)" line="107" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="116" package="tools">
        <name>isVisible</name>
        <full_name>\toolPDFEditor::isVisible()</full_name>
        <docblock line="116">
          <description>Returns if the tool is visible in the menu.</description>
          <long-description></long-description>
          <tag name="return" description="visible" line="116" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="125" package="tools">
        <name>isHideable</name>
        <full_name>\toolPDFEditor::isHideable()</full_name>
        <docblock line="125">
          <description>Returns if a tool may be hidden by configuration in the LAM server profile.</description>
          <long-description></long-description>
          <tag name="return" description="hideable" line="125" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/tools/ouEditor.inc" generated-path="lib.tools.ouEditor.inc.html" hash="69d2514d6fa7ece3c9517df1d9c6f2a5" package="tools">
    <docblock line="0">
      <description>This file includes the OU editor tool specification.</description>
      <long-description></long-description>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="package" description="tools" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="36" package="tools">
      <extends/>
      <implements>\LAMTool</implements>
      <name>toolOUEditor</name>
      <full_name>\toolOUEditor</full_name>
      <docblock line="36">
        <description>OU editor</description>
        <long-description></long-description>
        <tag name="package" description="tools" line="36"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="43" package="tools">
        <name>getName</name>
        <full_name>\toolOUEditor::getName()</full_name>
        <docblock line="43">
          <description>Returns the name of the tool.</description>
          <long-description></long-description>
          <tag name="return" description="name" line="43" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="52" package="tools">
        <name>getDescription</name>
        <full_name>\toolOUEditor::getDescription()</full_name>
        <docblock line="52">
          <description>returns a description text for the tool.</description>
          <long-description></long-description>
          <tag name="return" description="description" line="52" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="61" package="tools">
        <name>getLink</name>
        <full_name>\toolOUEditor::getLink()</full_name>
        <docblock line="61">
          <description>Returns a link to the tool page (relative to templates/).</description>
          <long-description></long-description>
          <tag name="return" description="link" line="61" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="70" package="tools">
        <name>getRequiresWriteAccess</name>
        <full_name>\toolOUEditor::getRequiresWriteAccess()</full_name>
        <docblock line="70">
          <description>Returns if the tool requires write access to LDAP.</description>
          <long-description></long-description>
          <tag name="return" description="true if write access is needed" line="70" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="79" package="tools">
        <name>getRequiresPasswordChangeRights</name>
        <full_name>\toolOUEditor::getRequiresPasswordChangeRights()</full_name>
        <docblock line="79">
          <description>Returns if the tool requires password change rights.</description>
          <long-description></long-description>
          <tag name="return" description="true if password change rights are needed" line="79" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="88" package="tools">
        <name>getImageLink</name>
        <full_name>\toolOUEditor::getImageLink()</full_name>
        <docblock line="88">
          <description>Returns the link to the tool image (relative to graphics/)</description>
          <long-description></long-description>
          <tag name="return" description="image URL" line="88" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="98" package="tools">
        <name>getPosition</name>
        <full_name>\toolOUEditor::getPosition()</full_name>
        <docblock line="98">
          <description>Returns the prefered position of this tool on the tools page.</description>
          <long-description>The position may be between 0 and 1000. 0 is the top position.</long-description>
          <tag name="return" description="prefered position" line="98" type="int">
            <type>int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="107" package="tools">
        <name>getSubTools</name>
        <full_name>\toolOUEditor::getSubTools()</full_name>
        <docblock line="107">
          <description>Returns a list of sub tools or an empty array.</description>
          <long-description></long-description>
          <tag name="return" description="list of subtools (LAMTool)" line="107" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="116" package="tools">
        <name>isVisible</name>
        <full_name>\toolOUEditor::isVisible()</full_name>
        <docblock line="116">
          <description>Returns if the tool is visible in the menu.</description>
          <long-description></long-description>
          <tag name="return" description="visible" line="116" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="125" package="tools">
        <name>isHideable</name>
        <full_name>\toolOUEditor::isHideable()</full_name>
        <docblock line="125">
          <description>Returns if a tool may be hidden by configuration in the LAM server profile.</description>
          <long-description></long-description>
          <tag name="return" description="hideable" line="125" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/tools/profileEditor.inc" generated-path="lib.tools.profileEditor.inc.html" hash="611ea452d67a37e499c3ac25963807d3" package="tools">
    <docblock line="0">
      <description>This file includes the profile editor tool specification.</description>
      <long-description></long-description>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="package" description="tools" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="36" package="tools">
      <extends/>
      <implements>\LAMTool</implements>
      <name>toolProfileEditor</name>
      <full_name>\toolProfileEditor</full_name>
      <docblock line="36">
        <description>Profile editor</description>
        <long-description></long-description>
        <tag name="package" description="tools" line="36"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="43" package="tools">
        <name>getName</name>
        <full_name>\toolProfileEditor::getName()</full_name>
        <docblock line="43">
          <description>Returns the name of the tool.</description>
          <long-description></long-description>
          <tag name="return" description="name" line="43" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="52" package="tools">
        <name>getDescription</name>
        <full_name>\toolProfileEditor::getDescription()</full_name>
        <docblock line="52">
          <description>returns a description text for the tool.</description>
          <long-description></long-description>
          <tag name="return" description="description" line="52" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="61" package="tools">
        <name>getLink</name>
        <full_name>\toolProfileEditor::getLink()</full_name>
        <docblock line="61">
          <description>Returns a link to the tool page (relative to templates/).</description>
          <long-description></long-description>
          <tag name="return" description="link" line="61" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="70" package="tools">
        <name>getRequiresWriteAccess</name>
        <full_name>\toolProfileEditor::getRequiresWriteAccess()</full_name>
        <docblock line="70">
          <description>Returns if the tool requires write access to LDAP.</description>
          <long-description></long-description>
          <tag name="return" description="true if write access is needed" line="70" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="79" package="tools">
        <name>getRequiresPasswordChangeRights</name>
        <full_name>\toolProfileEditor::getRequiresPasswordChangeRights()</full_name>
        <docblock line="79">
          <description>Returns if the tool requires password change rights.</description>
          <long-description></long-description>
          <tag name="return" description="true if password change rights are needed" line="79" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="88" package="tools">
        <name>getImageLink</name>
        <full_name>\toolProfileEditor::getImageLink()</full_name>
        <docblock line="88">
          <description>Returns the link to the tool image (relative to graphics/)</description>
          <long-description></long-description>
          <tag name="return" description="image URL" line="88" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="98" package="tools">
        <name>getPosition</name>
        <full_name>\toolProfileEditor::getPosition()</full_name>
        <docblock line="98">
          <description>Returns the prefered position of this tool on the tools page.</description>
          <long-description>The position may be between 0 and 1000. 0 is the top position.</long-description>
          <tag name="return" description="prefered position" line="98" type="int">
            <type>int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="107" package="tools">
        <name>getSubTools</name>
        <full_name>\toolProfileEditor::getSubTools()</full_name>
        <docblock line="107">
          <description>Returns a list of sub tools or an empty array.</description>
          <long-description></long-description>
          <tag name="return" description="list of subtools (LAMTool)" line="107" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="116" package="tools">
        <name>isVisible</name>
        <full_name>\toolProfileEditor::isVisible()</full_name>
        <docblock line="116">
          <description>Returns if the tool is visible in the menu.</description>
          <long-description></long-description>
          <tag name="return" description="visible" line="116" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="125" package="tools">
        <name>isHideable</name>
        <full_name>\toolProfileEditor::isHideable()</full_name>
        <docblock line="125">
          <description>Returns if a tool may be hidden by configuration in the LAM server profile.</description>
          <long-description></long-description>
          <tag name="return" description="hideable" line="125" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/tools/tests.inc" generated-path="lib.tools.tests.inc.html" hash="2d743ecd184d79c391a4ed902ca65e74" package="tools">
    <docblock line="0">
      <description>This file includes the test tool specification.</description>
      <long-description></long-description>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="package" description="tools" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="36" package="tools">
      <extends/>
      <implements>\LAMTool</implements>
      <name>toolTests</name>
      <full_name>\toolTests</full_name>
      <docblock line="36">
        <description>Tests page</description>
        <long-description></long-description>
        <tag name="package" description="tools" line="36"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="43" package="tools">
        <name>getName</name>
        <full_name>\toolTests::getName()</full_name>
        <docblock line="43">
          <description>Returns the name of the tool.</description>
          <long-description></long-description>
          <tag name="return" description="name" line="43" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="52" package="tools">
        <name>getDescription</name>
        <full_name>\toolTests::getDescription()</full_name>
        <docblock line="52">
          <description>returns a description text for the tool.</description>
          <long-description></long-description>
          <tag name="return" description="description" line="52" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="61" package="tools">
        <name>getLink</name>
        <full_name>\toolTests::getLink()</full_name>
        <docblock line="61">
          <description>Returns a link to the tool page (relative to templates/).</description>
          <long-description></long-description>
          <tag name="return" description="link" line="61" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="70" package="tools">
        <name>getRequiresWriteAccess</name>
        <full_name>\toolTests::getRequiresWriteAccess()</full_name>
        <docblock line="70">
          <description>Returns if the tool requires write access to LDAP.</description>
          <long-description></long-description>
          <tag name="return" description="true if write access is needed" line="70" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="79" package="tools">
        <name>getRequiresPasswordChangeRights</name>
        <full_name>\toolTests::getRequiresPasswordChangeRights()</full_name>
        <docblock line="79">
          <description>Returns if the tool requires password change rights.</description>
          <long-description></long-description>
          <tag name="return" description="true if password change rights are needed" line="79" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="88" package="tools">
        <name>getImageLink</name>
        <full_name>\toolTests::getImageLink()</full_name>
        <docblock line="88">
          <description>Returns the link to the tool image (relative to graphics/)</description>
          <long-description></long-description>
          <tag name="return" description="image URL" line="88" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="98" package="tools">
        <name>getPosition</name>
        <full_name>\toolTests::getPosition()</full_name>
        <docblock line="98">
          <description>Returns the prefered position of this tool on the tools page.</description>
          <long-description>The position may be between 0 and 1000. 0 is the top position.</long-description>
          <tag name="return" description="prefered position" line="98" type="int">
            <type>int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="107" package="tools">
        <name>getSubTools</name>
        <full_name>\toolTests::getSubTools()</full_name>
        <docblock line="107">
          <description>Returns a list of sub tools or an empty array.</description>
          <long-description></long-description>
          <tag name="return" description="list of subtools (LAMTool)" line="107" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="129" package="tools">
        <name>isVisible</name>
        <full_name>\toolTests::isVisible()</full_name>
        <docblock line="129">
          <description>Returns if the tool is visible in the menu.</description>
          <long-description></long-description>
          <tag name="return" description="visible" line="129" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="138" package="tools">
        <name>isHideable</name>
        <full_name>\toolTests::isHideable()</full_name>
        <docblock line="138">
          <description>Returns if a tool may be hidden by configuration in the LAM server profile.</description>
          <long-description></long-description>
          <tag name="return" description="hideable" line="138" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/tools/schemaBrowser.inc" generated-path="lib.tools.schemaBrowser.inc.html" hash="dd2d3643970f1973f5b8fa39772f5f6e" package="tools">
    <docblock line="0">
      <description>This file includes the schema browser tool specification.</description>
      <long-description></long-description>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="package" description="tools" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="36" package="tools">
      <extends/>
      <implements>\LAMTool</implements>
      <name>toolSchemaBrowser</name>
      <full_name>\toolSchemaBrowser</full_name>
      <docblock line="36">
        <description>Schema browser</description>
        <long-description></long-description>
        <tag name="package" description="tools" line="36"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="43" package="tools">
        <name>getName</name>
        <full_name>\toolSchemaBrowser::getName()</full_name>
        <docblock line="43">
          <description>Returns the name of the tool.</description>
          <long-description></long-description>
          <tag name="return" description="name" line="43" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="52" package="tools">
        <name>getDescription</name>
        <full_name>\toolSchemaBrowser::getDescription()</full_name>
        <docblock line="52">
          <description>returns a description text for the tool.</description>
          <long-description></long-description>
          <tag name="return" description="description" line="52" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="61" package="tools">
        <name>getLink</name>
        <full_name>\toolSchemaBrowser::getLink()</full_name>
        <docblock line="61">
          <description>Returns a link to the tool page (relative to templates/).</description>
          <long-description></long-description>
          <tag name="return" description="link" line="61" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="70" package="tools">
        <name>getRequiresWriteAccess</name>
        <full_name>\toolSchemaBrowser::getRequiresWriteAccess()</full_name>
        <docblock line="70">
          <description>Returns if the tool requires write access to LDAP.</description>
          <long-description></long-description>
          <tag name="return" description="true if write access is needed" line="70" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="79" package="tools">
        <name>getRequiresPasswordChangeRights</name>
        <full_name>\toolSchemaBrowser::getRequiresPasswordChangeRights()</full_name>
        <docblock line="79">
          <description>Returns if the tool requires password change rights.</description>
          <long-description></long-description>
          <tag name="return" description="true if password change rights are needed" line="79" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="88" package="tools">
        <name>getImageLink</name>
        <full_name>\toolSchemaBrowser::getImageLink()</full_name>
        <docblock line="88">
          <description>Returns the link to the tool image (relative to graphics/)</description>
          <long-description></long-description>
          <tag name="return" description="image URL" line="88" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="98" package="tools">
        <name>getPosition</name>
        <full_name>\toolSchemaBrowser::getPosition()</full_name>
        <docblock line="98">
          <description>Returns the prefered position of this tool on the tools page.</description>
          <long-description>The position may be between 0 and 1000. 0 is the top position.</long-description>
          <tag name="return" description="prefered position" line="98" type="int">
            <type>int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="107" package="tools">
        <name>getSubTools</name>
        <full_name>\toolSchemaBrowser::getSubTools()</full_name>
        <docblock line="107">
          <description>Returns a list of sub tools or an empty array.</description>
          <long-description></long-description>
          <tag name="return" description="list of subtools (LAMTool)" line="107" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="116" package="tools">
        <name>isVisible</name>
        <full_name>\toolSchemaBrowser::isVisible()</full_name>
        <docblock line="116">
          <description>Returns if the tool is visible in the menu.</description>
          <long-description></long-description>
          <tag name="return" description="visible" line="116" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="125" package="tools">
        <name>isHideable</name>
        <full_name>\toolSchemaBrowser::isHideable()</full_name>
        <docblock line="125">
          <description>Returns if a tool may be hidden by configuration in the LAM server profile.</description>
          <long-description></long-description>
          <tag name="return" description="hideable" line="125" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/types/asteriskExt.inc" generated-path="lib.types.asteriskExt.inc.html" hash="e490cc35d321d3381bd1f2bd8528f3f2" package="types">
    <docblock line="0">
      <description>The account type for Asterisk extensions.</description>
      <long-description></long-description>
      <tag name="package" description="types" line="0"/>
      <tag name="author" description="Pozdnyak Pavel" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="39" package="types">
      <extends>\baseType</extends>
      <name>asteriskExt</name>
      <full_name>\asteriskExt</full_name>
      <docblock line="39">
        <description>The account type for Asterisk extensions.</description>
        <long-description></long-description>
        <tag name="package" description="types" line="39"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="44" package="types">
        <name>__construct</name>
        <full_name>\asteriskExt::__construct()</full_name>
        <docblock line="44">
          <description>Constructs a new domain type object.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="55" package="types">
        <name>getAlias</name>
        <full_name>\asteriskExt::getAlias()</full_name>
        <docblock line="55">
          <description>Returns the alias name of this account type.</description>
          <long-description></long-description>
          <tag name="return" description="alias name" line="55" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="64" package="types">
        <name>getDescription</name>
        <full_name>\asteriskExt::getDescription()</full_name>
        <docblock line="64">
          <description>Returns the description of this account type.</description>
          <long-description></long-description>
          <tag name="return" description="description" line="64" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="73" package="types">
        <name>getListClassName</name>
        <full_name>\asteriskExt::getListClassName()</full_name>
        <docblock line="73">
          <description>Returns the class name for the list object.</description>
          <long-description></long-description>
          <tag name="return" description="class name" line="73" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="82" package="types">
        <name>getDefaultListAttributes</name>
        <full_name>\asteriskExt::getDefaultListAttributes()</full_name>
        <docblock line="82">
          <description>Returns the default attribute list for this account type.</description>
          <long-description></long-description>
          <tag name="return" description="attribute list" line="82" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="92" package="types">
        <name>getListAttributeDescriptions</name>
        <full_name>\asteriskExt::getListAttributeDescriptions()</full_name>
        <docblock line="92">
          <description>Returns a list of attributes which have a translated description.</description>
          <long-description>This is used for the head row in the list view.</long-description>
          <tag name="return" description="list of descriptions" line="92" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="106" package="types">
        <name>getTitleBarTitle</name>
        <full_name>\asteriskExt::getTitleBarTitle()</full_name>
        <docblock line="106">
          <description>Returns the the title text for the title bar on the new/edit page.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account container&lt;/p&gt;" line="106" type="\accountContainer" variable="$container">
            <type>\accountContainer</type>
          </tag>
          <tag name="return" description="title text" line="106" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$container</name>
          <default></default>
          <type>\accountContainer</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="132" package="lists">
      <extends>\lamList</extends>
      <name>lamAsteriskExtList</name>
      <full_name>\lamAsteriskExtList</full_name>
      <docblock line="132">
        <description>Generates the list view.</description>
        <long-description></long-description>
        <tag name="package" description="lists" line="132"/>
        <tag name="author" description="Pozdnyak Pavel" line="132"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="140" package="lists">
        <name>__construct</name>
        <full_name>\lamAsteriskExtList::__construct()</full_name>
        <docblock line="140">
          <description>Constructor</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="140" type="string" variable="$type">
            <type>string</type>
          </tag>
          <tag name="return" description="list object" line="140" type="\lamList">
            <type>\lamList</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$type</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="154" package="lists">
        <name>listGetParams</name>
        <full_name>\lamAsteriskExtList::listGetParams()</full_name>
        <docblock line="154">
          <description>Forces the list view to show only specific attributes.</description>
          <long-description></long-description>
          <tag name="see" description="" line="154"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="167" package="lists">
        <name>listRefreshData</name>
        <full_name>\lamAsteriskExtList::listRefreshData()</full_name>
        <docblock line="167">
          <description>Groups the extensions.</description>
          <long-description>(non-PHPdoc)</long-description>
          <tag name="see" description="" line="167"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="192" package="lists">
        <name>normalizeLdapOutput</name>
        <full_name>\lamAsteriskExtList::normalizeLdapOutput()</full_name>
        <docblock line="192">
          <description>Groups the extensions.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;extension entries&lt;/p&gt;" line="192" type="array" variable="$entries">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$entries</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/types/mailAlias.inc" generated-path="lib.types.mailAlias.inc.html" hash="f0760b7c60512f1ba73bf1ad6e026083" package="types">
    <docblock line="0">
      <description>The account type for mail aliases.</description>
      <long-description></long-description>
      <tag name="package" description="types" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="36" package="types">
      <extends>\baseType</extends>
      <name>mailAlias</name>
      <full_name>\mailAlias</full_name>
      <docblock line="36">
        <description>The account type for mail aliases.</description>
        <long-description></long-description>
        <tag name="package" description="types" line="36"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="41" package="types">
        <name>__construct</name>
        <full_name>\mailAlias::__construct()</full_name>
        <docblock line="41">
          <description>Constructs a new alias type object.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="52" package="types">
        <name>getAlias</name>
        <full_name>\mailAlias::getAlias()</full_name>
        <docblock line="52">
          <description>Returns the alias name of this account type.</description>
          <long-description></long-description>
          <tag name="return" description="alias name" line="52" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="61" package="types">
        <name>getDescription</name>
        <full_name>\mailAlias::getDescription()</full_name>
        <docblock line="61">
          <description>Returns the description of this account type.</description>
          <long-description></long-description>
          <tag name="return" description="description" line="61" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="70" package="types">
        <name>getListClassName</name>
        <full_name>\mailAlias::getListClassName()</full_name>
        <docblock line="70">
          <description>Returns the class name for the list object.</description>
          <long-description></long-description>
          <tag name="return" description="class name" line="70" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="79" package="types">
        <name>getDefaultListAttributes</name>
        <full_name>\mailAlias::getDefaultListAttributes()</full_name>
        <docblock line="79">
          <description>Returns the default attribute list for this account type.</description>
          <long-description></long-description>
          <tag name="return" description="attribute list" line="79" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="89" package="types">
        <name>getListAttributeDescriptions</name>
        <full_name>\mailAlias::getListAttributeDescriptions()</full_name>
        <docblock line="89">
          <description>Returns a list of attributes which have a translated description.</description>
          <long-description>This is used for the head row in the list view.</long-description>
          <tag name="return" description="list of descriptions" line="89" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="102" package="types">
        <name>getTitleBarTitle</name>
        <full_name>\mailAlias::getTitleBarTitle()</full_name>
        <docblock line="102">
          <description>Returns the the title text for the title bar on the new/edit page.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account container&lt;/p&gt;" line="102" type="\accountContainer" variable="$container">
            <type>\accountContainer</type>
          </tag>
          <tag name="return" description="title text" line="102" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$container</name>
          <default></default>
          <type>\accountContainer</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="130" package="lists">
      <extends>\lamList</extends>
      <name>lamMailAliasList</name>
      <full_name>\lamMailAliasList</full_name>
      <docblock line="130">
        <description>Generates the list view.</description>
        <long-description></long-description>
        <tag name="package" description="lists" line="130"/>
        <tag name="author" description="Roland Gruber" line="130"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="138" package="lists">
        <name>__construct</name>
        <full_name>\lamMailAliasList::__construct()</full_name>
        <docblock line="138">
          <description>Constructor</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="138" type="string" variable="$type">
            <type>string</type>
          </tag>
          <tag name="return" description="list object" line="138" type="\lamList">
            <type>\lamList</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$type</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/types/host.inc" generated-path="lib.types.host.inc.html" hash="cc00769edbc086620d134a94043f778f" package="types">
    <docblock line="0">
      <description>The account type for host accounts (e.g. Samba).</description>
      <long-description></long-description>
      <tag name="package" description="types" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="36" package="types">
      <extends>\baseType</extends>
      <name>host</name>
      <full_name>\host</full_name>
      <docblock line="36">
        <description>The account type for host accounts (e.g. Samba).</description>
        <long-description></long-description>
        <tag name="package" description="types" line="36"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="41" package="types">
        <name>__construct</name>
        <full_name>\host::__construct()</full_name>
        <docblock line="41">
          <description>Constructs a new host type object.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="52" package="types">
        <name>getAlias</name>
        <full_name>\host::getAlias()</full_name>
        <docblock line="52">
          <description>Returns the alias name of this account type.</description>
          <long-description></long-description>
          <tag name="return" description="alias name" line="52" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="61" package="types">
        <name>getDescription</name>
        <full_name>\host::getDescription()</full_name>
        <docblock line="61">
          <description>Returns the description of this account type.</description>
          <long-description></long-description>
          <tag name="return" description="description" line="61" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="70" package="types">
        <name>getListClassName</name>
        <full_name>\host::getListClassName()</full_name>
        <docblock line="70">
          <description>Returns the class name for the list object.</description>
          <long-description></long-description>
          <tag name="return" description="class name" line="70" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="79" package="types">
        <name>getDefaultListAttributes</name>
        <full_name>\host::getDefaultListAttributes()</full_name>
        <docblock line="79">
          <description>Returns the default attribute list for this account type.</description>
          <long-description></long-description>
          <tag name="return" description="attribute list" line="79" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="89" package="types">
        <name>getListAttributeDescriptions</name>
        <full_name>\host::getListAttributeDescriptions()</full_name>
        <docblock line="89">
          <description>Returns a list of attributes which have a translated description.</description>
          <long-description>This is used for the head row in the list view.</long-description>
          <tag name="return" description="list of descriptions" line="89" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="107" package="types">
        <name>getTitleBarTitle</name>
        <full_name>\host::getTitleBarTitle()</full_name>
        <docblock line="107">
          <description>Returns the the title text for the title bar on the new/edit page.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account container&lt;/p&gt;" line="107" type="\accountContainer" variable="$container">
            <type>\accountContainer</type>
          </tag>
          <tag name="return" description="title text" line="107" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$container</name>
          <default></default>
          <type>\accountContainer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="140" package="types">
        <name>getTitleBarSubtitle</name>
        <full_name>\host::getTitleBarSubtitle()</full_name>
        <docblock line="140">
          <description>Returns the the title text for the title bar on the new/edit page.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account container&lt;/p&gt;" line="140" type="\accountContainer" variable="$container">
            <type>\accountContainer</type>
          </tag>
          <tag name="return" description="title text" line="140" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$container</name>
          <default></default>
          <type>\accountContainer</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="182" package="lists">
      <extends>\lamList</extends>
      <name>lamHostList</name>
      <full_name>\lamHostList</full_name>
      <docblock line="182">
        <description>Generates the list view.</description>
        <long-description></long-description>
        <tag name="package" description="lists" line="182"/>
        <tag name="author" description="Roland Gruber" line="182"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="190" package="lists">
        <name>__construct</name>
        <full_name>\lamHostList::__construct()</full_name>
        <docblock line="190">
          <description>Constructor</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="190" type="string" variable="$type">
            <type>string</type>
          </tag>
          <tag name="return" description="list object" line="190" type="\lamList">
            <type>\lamList</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$type</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/types/smbDomain.inc" generated-path="lib.types.smbDomain.inc.html" hash="e65ff259d582f01e049f4d4d9fa315c7" package="types">
    <docblock line="0">
      <description>The account type for Samba domains.</description>
      <long-description></long-description>
      <tag name="package" description="types" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="36" package="types">
      <extends>\baseType</extends>
      <name>smbDomain</name>
      <full_name>\smbDomain</full_name>
      <docblock line="36">
        <description>The account type for Samba domains.</description>
        <long-description></long-description>
        <tag name="package" description="types" line="36"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="41" package="types">
        <name>__construct</name>
        <full_name>\smbDomain::__construct()</full_name>
        <docblock line="41">
          <description>Constructs a new domain type object.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="52" package="types">
        <name>getAlias</name>
        <full_name>\smbDomain::getAlias()</full_name>
        <docblock line="52">
          <description>Returns the alias name of this account type.</description>
          <long-description></long-description>
          <tag name="return" description="alias name" line="52" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="61" package="types">
        <name>getDescription</name>
        <full_name>\smbDomain::getDescription()</full_name>
        <docblock line="61">
          <description>Returns the description of this account type.</description>
          <long-description></long-description>
          <tag name="return" description="description" line="61" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="70" package="types">
        <name>getListClassName</name>
        <full_name>\smbDomain::getListClassName()</full_name>
        <docblock line="70">
          <description>Returns the class name for the list object.</description>
          <long-description></long-description>
          <tag name="return" description="class name" line="70" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="79" package="types">
        <name>getDefaultListAttributes</name>
        <full_name>\smbDomain::getDefaultListAttributes()</full_name>
        <docblock line="79">
          <description>Returns the default attribute list for this account type.</description>
          <long-description></long-description>
          <tag name="return" description="attribute list" line="79" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="89" package="types">
        <name>getListAttributeDescriptions</name>
        <full_name>\smbDomain::getListAttributeDescriptions()</full_name>
        <docblock line="89">
          <description>Returns a list of attributes which have a translated description.</description>
          <long-description>This is used for the head row in the list view.</long-description>
          <tag name="return" description="list of descriptions" line="89" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="102" package="types">
        <name>getTitleBarTitle</name>
        <full_name>\smbDomain::getTitleBarTitle()</full_name>
        <docblock line="102">
          <description>Returns the the title text for the title bar on the new/edit page.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account container&lt;/p&gt;" line="102" type="\accountContainer" variable="$container">
            <type>\accountContainer</type>
          </tag>
          <tag name="return" description="title text" line="102" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$container</name>
          <default></default>
          <type>\accountContainer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="126" package="types">
        <name>getTitleBarSubtitle</name>
        <full_name>\smbDomain::getTitleBarSubtitle()</full_name>
        <docblock line="126">
          <description>Returns the the title text for the title bar on the new/edit page.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account container&lt;/p&gt;" line="126" type="\accountContainer" variable="$container">
            <type>\accountContainer</type>
          </tag>
          <tag name="return" description="title text" line="126" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$container</name>
          <default></default>
          <type>\accountContainer</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="156" package="lists">
      <extends>\lamList</extends>
      <name>lamSmbDomainList</name>
      <full_name>\lamSmbDomainList</full_name>
      <docblock line="156">
        <description>Generates the list view.</description>
        <long-description></long-description>
        <tag name="package" description="lists" line="156"/>
        <tag name="author" description="Roland Gruber" line="156"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="164" package="lists">
        <name>__construct</name>
        <full_name>\lamSmbDomainList::__construct()</full_name>
        <docblock line="164">
          <description>Constructor</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="164" type="string" variable="$type">
            <type>string</type>
          </tag>
          <tag name="return" description="list object" line="164" type="\lamList">
            <type>\lamList</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$type</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/types/group.inc" generated-path="lib.types.group.inc.html" hash="244c1baa3cfe9ac510c0c31a4b7c9029" package="types">
    <docblock line="0">
      <description>The account type for group accounts (e.g. Unix and Samba).</description>
      <long-description></long-description>
      <tag name="package" description="types" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="author" description="Ludek Finstrle" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="37" package="types">
      <extends>\baseType</extends>
      <name>group</name>
      <full_name>\group</full_name>
      <docblock line="37">
        <description>The account type for group accounts (e.g. Unix and Samba).</description>
        <long-description></long-description>
        <tag name="package" description="types" line="37"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="42" package="types">
        <name>__construct</name>
        <full_name>\group::__construct()</full_name>
        <docblock line="42">
          <description>Constructs a new group type object.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="53" package="types">
        <name>getAlias</name>
        <full_name>\group::getAlias()</full_name>
        <docblock line="53">
          <description>Returns the alias name of this account type.</description>
          <long-description></long-description>
          <tag name="return" description="alias name" line="53" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="62" package="types">
        <name>getDescription</name>
        <full_name>\group::getDescription()</full_name>
        <docblock line="62">
          <description>Returns the description of this account type.</description>
          <long-description></long-description>
          <tag name="return" description="description" line="62" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="71" package="types">
        <name>getListClassName</name>
        <full_name>\group::getListClassName()</full_name>
        <docblock line="71">
          <description>Returns the class name for the list object.</description>
          <long-description></long-description>
          <tag name="return" description="class name" line="71" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="80" package="types">
        <name>getDefaultListAttributes</name>
        <full_name>\group::getDefaultListAttributes()</full_name>
        <docblock line="80">
          <description>Returns the default attribute list for this account type.</description>
          <long-description></long-description>
          <tag name="return" description="attribute list" line="80" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="90" package="types">
        <name>getListAttributeDescriptions</name>
        <full_name>\group::getListAttributeDescriptions()</full_name>
        <docblock line="90">
          <description>Returns a list of attributes which have a translated description.</description>
          <long-description>This is used for the head row in the list view.</long-description>
          <tag name="return" description="list of descriptions" line="90" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="106" package="types">
        <name>getTitleBarTitle</name>
        <full_name>\group::getTitleBarTitle()</full_name>
        <docblock line="106">
          <description>Returns the the title text for the title bar on the new/edit page.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account container&lt;/p&gt;" line="106" type="\accountContainer" variable="$container">
            <type>\accountContainer</type>
          </tag>
          <tag name="return" description="title text" line="106" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$container</name>
          <default></default>
          <type>\accountContainer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="150" package="types">
        <name>getTitleBarSubtitle</name>
        <full_name>\group::getTitleBarSubtitle()</full_name>
        <docblock line="150">
          <description>Returns the the title text for the title bar on the new/edit page.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account container&lt;/p&gt;" line="150" type="\accountContainer" variable="$container">
            <type>\accountContainer</type>
          </tag>
          <tag name="return" description="title text" line="150" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$container</name>
          <default></default>
          <type>\accountContainer</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="188" package="lists">
      <extends>\lamList</extends>
      <name>lamGroupList</name>
      <full_name>\lamGroupList</full_name>
      <docblock line="188">
        <description>Generates the list view.</description>
        <long-description></long-description>
        <tag name="package" description="lists" line="188"/>
        <tag name="author" description="Roland Gruber" line="188"/>
      </docblock>
      <constant namespace="" line="197" package="lists">
        <name>TRANS_PRIMARY_OPTION_NAME</name>
        <full_name>\lamGroupList::TRANS_PRIMARY_OPTION_NAME</full_name>
        <value>"LG_TP"</value>
        <docblock line="197">
          <description>ID for config option</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <property static="false" visibility="private" line="191" namespace="" package="lists">
        <name>$use_primary</name>
        <default>false</default>
        <docblock line="191">
          <description>Controls if include primary group members into group memebers</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="193" namespace="" package="lists">
        <name>$primary_hash</name>
        <default>array()</default>
        <docblock line="193">
          <description>Primary group members hash</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="195" namespace="" package="lists">
        <name>$refresh_primary</name>
        <default>false</default>
        <docblock line="195">
          <description>Controls if primary group members needs refresh</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="199" namespace="" package="lists">
        <name>$include_primary</name>
        <default>false</default>
        <docblock line="199">
          <description>specifies if primary group members are visible</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="207" package="lists">
        <name>__construct</name>
        <full_name>\lamGroupList::__construct()</full_name>
        <docblock line="207">
          <description>Constructor</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="207" type="string" variable="$type">
            <type>string</type>
          </tag>
          <tag name="return" description="list object" line="207" type="\lamList">
            <type>\lamList</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$type</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="219" package="lists">
        <name>listGetParams</name>
        <full_name>\lamGroupList::listGetParams()</full_name>
        <docblock line="219">
          <description>Sets some internal parameters.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="233" package="lists">
        <name>listPrintTableCellContent</name>
        <full_name>\lamGroupList::listPrintTableCellContent()</full_name>
        <docblock line="233">
          <description>Prints the content of a cell in the account list for a given LDAP entry and attribute.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="233" type="array" variable="$entry">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;attribute name&lt;/p&gt;" line="233" type="string" variable="$attribute">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$entry</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="305" package="lists">
        <name>listRefreshData</name>
        <full_name>\lamGroupList::listRefreshData()</full_name>
        <docblock line="305">
          <description>Rereads the entries from LDAP.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="315" package="lists">
        <name>groupRefreshPrimary</name>
        <full_name>\lamGroupList::groupRefreshPrimary()</full_name>
        <docblock line="315">
          <description>Refreshes the primary group members list.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="341" package="lists">
        <name>listGetAllConfigOptions</name>
        <full_name>\lamGroupList::listGetAllConfigOptions()</full_name>
        <docblock line="341">
          <description>Returns a list of possible configuration options.</description>
          <long-description></long-description>
          <tag name="return" description="list of lamListOption objects" line="341" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="350" package="lists">
        <name>listConfigurationChanged</name>
        <full_name>\lamGroupList::listConfigurationChanged()</full_name>
        <docblock line="350">
          <description>Called when the configuration options changed.</description>
          <long-description></long-description>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/types/user.inc" generated-path="lib.types.user.inc.html" hash="08017d0ecae4d4c26edf68292efc2859" package="types">
    <docblock line="0">
      <description>The account type for user accounts (e.g. Unix, Samba and Kolab).</description>
      <long-description></long-description>
      <tag name="package" description="types" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="36" package="types">
      <extends>\baseType</extends>
      <name>user</name>
      <full_name>\user</full_name>
      <docblock line="36">
        <description>The account type for user accounts (e.g. Unix, Samba and Kolab).</description>
        <long-description></long-description>
        <tag name="package" description="types" line="36"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="41" package="types">
        <name>__construct</name>
        <full_name>\user::__construct()</full_name>
        <docblock line="41">
          <description>Constructs a new user type object.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="52" package="types">
        <name>getAlias</name>
        <full_name>\user::getAlias()</full_name>
        <docblock line="52">
          <description>Returns the alias name of this account type.</description>
          <long-description></long-description>
          <tag name="return" description="alias name" line="52" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="61" package="types">
        <name>getDescription</name>
        <full_name>\user::getDescription()</full_name>
        <docblock line="61">
          <description>Returns the description of this account type.</description>
          <long-description></long-description>
          <tag name="return" description="description" line="61" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="70" package="types">
        <name>getListClassName</name>
        <full_name>\user::getListClassName()</full_name>
        <docblock line="70">
          <description>Returns the class name for the list object.</description>
          <long-description></long-description>
          <tag name="return" description="class name" line="70" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="79" package="types">
        <name>getDefaultListAttributes</name>
        <full_name>\user::getDefaultListAttributes()</full_name>
        <docblock line="79">
          <description>Returns the default attribute list for this account type.</description>
          <long-description></long-description>
          <tag name="return" description="attribute list" line="79" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="89" package="types">
        <name>getListAttributeDescriptions</name>
        <full_name>\user::getListAttributeDescriptions()</full_name>
        <docblock line="89">
          <description>Returns a list of attributes which have a translated description.</description>
          <long-description>This is used for the head row in the list view.</long-description>
          <tag name="return" description="list of descriptions" line="89" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="114" package="types">
        <name>getTitleBarTitle</name>
        <full_name>\user::getTitleBarTitle()</full_name>
        <docblock line="114">
          <description>Returns the the title text for the title bar on the new/edit page.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account container&lt;/p&gt;" line="114" type="\accountContainer" variable="$container">
            <type>\accountContainer</type>
          </tag>
          <tag name="return" description="title text" line="114" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$container</name>
          <default></default>
          <type>\accountContainer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="184" package="types">
        <name>getTitleBarSubtitle</name>
        <full_name>\user::getTitleBarSubtitle()</full_name>
        <docblock line="184">
          <description>Returns the the title text for the title bar on the new/edit page.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account container&lt;/p&gt;" line="184" type="\accountContainer" variable="$container">
            <type>\accountContainer</type>
          </tag>
          <tag name="return" description="title text" line="184" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$container</name>
          <default></default>
          <type>\accountContainer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="221" package="types">
        <name>buildAccountStatusIcon</name>
        <full_name>\user::buildAccountStatusIcon()</full_name>
        <docblock line="221">
          <description>Builds the HTML code for the icon that shows the account status (locked/unlocked).</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account container&lt;/p&gt;" line="221" type="\accountContainer" variable="$container">
            <type>\accountContainer</type>
          </tag>
          <tag name="return" description="HTML code for icon" line="221" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$container</name>
          <default></default>
          <type>\accountContainer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="321" package="types">
        <name>buildAccountStatusDialogDiv</name>
        <full_name>\user::buildAccountStatusDialogDiv()</full_name>
        <docblock line="321">
          <description>Builds the dialog to (un)lock parts of an account.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Unix part is active&lt;/p&gt;" line="321" type="boolean" variable="$unixAvailable">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Unix part is locked&lt;/p&gt;" line="321" type="boolean" variable="$unixLocked">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Samba part is active&lt;/p&gt;" line="321" type="boolean" variable="$sambaAvailable">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Samba part is locked&lt;/p&gt;" line="321" type="boolean" variable="$sambaLocked">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;PPolicy part is active&lt;/p&gt;" line="321" type="boolean" variable="$ppolicyAvailable">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;PPolicy part is locked&lt;/p&gt;" line="321" type="boolean" variable="$ppolicyLocked">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Windows part is active&lt;/p&gt;" line="321" type="boolean" variable="$windowsAvailable">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Windows part is locked&lt;/p&gt;" line="321" type="boolean" variable="$windowsLocked">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$unixAvailable</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$unixLocked</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$sambaAvailable</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$sambaLocked</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$ppolicyAvailable</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$ppolicyLocked</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$windowsAvailable</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$windowsLocked</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="441" package="types">
        <name>runEditPagePostAction</name>
        <full_name>\user::runEditPagePostAction()</full_name>
        <docblock line="441">
          <description>This function is called after the edit page is processed and before the page content is generated.</description>
          <long-description>This can be used to run custom handlers after each page processing.</long-description>
          <tag name="param" description="&lt;p&gt;account container&lt;/p&gt;" line="441" type="\accountContainer" variable="$container">
            <type>\accountContainer</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$container</name>
          <default></default>
          <type>\accountContainer</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="502" package="lists">
      <extends>\lamList</extends>
      <name>lamUserList</name>
      <full_name>\lamUserList</full_name>
      <docblock line="502">
        <description>Generates the list view.</description>
        <long-description></long-description>
        <tag name="package" description="lists" line="502"/>
        <tag name="author" description="Roland Gruber" line="502"/>
      </docblock>
      <constant namespace="" line="514" package="lists">
        <name>TRANS_PRIMARY_OPTION_NAME</name>
        <full_name>\lamUserList::TRANS_PRIMARY_OPTION_NAME</full_name>
        <value>"LU_TP"</value>
        <docblock line="514">
          <description>ID for config option to translate primary group GIDs to group names</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="" line="516" package="lists">
        <name>ACCOUNT_STATUS_OPTION_NAME</name>
        <full_name>\lamUserList::ACCOUNT_STATUS_OPTION_NAME</full_name>
        <value>"LU_AS"</value>
        <docblock line="516">
          <description>ID for config option to show account status</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="" line="519" package="lists">
        <name>ATTR_ACCOUNT_STATUS</name>
        <full_name>\lamUserList::ATTR_ACCOUNT_STATUS</full_name>
        <value>'lam_virtual_account_status'</value>
        <docblock line="519">
          <description>virtual attribute name for account status column</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <property static="false" visibility="private" line="505" namespace="" package="lists">
        <name>$trans_primary</name>
        <default>false</default>
        <docblock line="505">
          <description>Controls if GID number is translated to group name</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="508" namespace="" package="lists">
        <name>$showAccountStatus</name>
        <default>false</default>
        <docblock line="508">
          <description>Controls if the account status is shown</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="511" namespace="" package="lists">
        <name>$trans_primary_hash</name>
        <default>array()</default>
        <docblock line="511">
          <description>translates GID to group name</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="527" package="lists">
        <name>__construct</name>
        <full_name>\lamUserList::__construct()</full_name>
        <docblock line="527">
          <description>Constructor</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="527" type="string" variable="$type">
            <type>string</type>
          </tag>
          <tag name="return" description="list object" line="527" type="\lamList">
            <type>\lamList</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$type</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="539" package="lists">
        <name>listGetParams</name>
        <full_name>\lamUserList::listGetParams()</full_name>
        <docblock line="539">
          <description>Sets some internal parameters.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="550" package="lists">
        <name>listRefreshData</name>
        <full_name>\lamUserList::listRefreshData()</full_name>
        <docblock line="550">
          <description>Rereads the entries from LDAP.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="563" package="lists">
        <name>refreshPrimaryGroupTranslation</name>
        <full_name>\lamUserList::refreshPrimaryGroupTranslation()</full_name>
        <docblock line="563">
          <description>Refreshes the GID to group name cache.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="581" package="lists">
        <name>listPrintTableCellContent</name>
        <full_name>\lamUserList::listPrintTableCellContent()</full_name>
        <docblock line="581">
          <description>Prints the content of a cell in the account list for a given LDAP entry and attribute.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="581" type="array" variable="$entry">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;attribute name&lt;/p&gt;" line="581" type="string" variable="$attribute">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$entry</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="667" package="lists">
        <name>getAdditionalTools</name>
        <full_name>\lamUserList::getAdditionalTools()</full_name>
        <docblock line="667">
          <description>Returns a list of lamListTool objects to display next to the edit/delete buttons.</description>
          <long-description></long-description>
          <tag name="return" description="tools" line="667" type="\lamListTool[]">
            <type>\lamListTool[]</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="680" package="lists">
        <name>listGetAllConfigOptions</name>
        <full_name>\lamUserList::listGetAllConfigOptions()</full_name>
        <docblock line="680">
          <description>Returns a list of possible configuration options.</description>
          <long-description></long-description>
          <tag name="return" description="list of lamListOption objects" line="680" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="690" package="lists">
        <name>listConfigurationChanged</name>
        <full_name>\lamUserList::listConfigurationChanged()</full_name>
        <docblock line="690">
          <description>Called when the configuration options changed.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="711" package="lists">
        <name>listGetAttributeDescriptionList</name>
        <full_name>\lamUserList::listGetAttributeDescriptionList()</full_name>
        <docblock line="711">
          <description>Returns an hash array containing with all attributes to be shown and their descriptions.</description>
          <long-description>&lt;br&gt;Format: array(attribute =&gt; description)
&lt;br&gt;
&lt;br&gt;The user list may display an additional account status column</long-description>
          <tag name="return" description="attribute list" line="711" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="728" package="lists">
        <name>canBeFiltered</name>
        <full_name>\lamUserList::canBeFiltered()</full_name>
        <docblock line="728">
          <description>Returns if the given attribute can be filtered.</description>
          <long-description>If filtering is not possible then no filter box will be displayed.
&lt;br&gt;
&lt;br&gt;The user list allows no filtering for account status.</long-description>
          <tag name="param" description="&lt;p&gt;attribute name&lt;/p&gt;" line="728" type="String" variable="$attr">
            <type>String</type>
          </tag>
          <tag name="return" description="filtering possible" line="728" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attr</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="746" package="lists">
        <name>getAdditionalLDAPAttributesToRead</name>
        <full_name>\lamUserList::getAdditionalLDAPAttributesToRead()</full_name>
        <docblock line="746">
          <description>Returns a list of additional LDAP attributes that should be read.</description>
          <long-description>This can be used to show additional data even if the user selected other attributes to show in the list.
&lt;br&gt;
&lt;br&gt;The user list reads pwdAccountLockedTime, sambaAcctFlags and userPassword</long-description>
          <tag name="return" description="additional attribute names" line="746" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="761" package="lists">
        <name>injectAccountStatusAttribute</name>
        <full_name>\lamUserList::injectAccountStatusAttribute()</full_name>
        <docblock line="761">
          <description>Injects values for the virtual account status attribute to make it sortable.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="786" package="lists">
        <name>printAccountStatus</name>
        <full_name>\lamUserList::printAccountStatus()</full_name>
        <docblock line="786">
          <description>Prints the account status.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="786" type="array" variable="$attrs">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attrs</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="862" package="lists">
        <name>isUnixAvailable</name>
        <full_name>\lamUserList::isUnixAvailable()</full_name>
        <docblock line="862">
          <description>Returns if the Unix part exists.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="862" type="array" variable="$attrs">
            <type>array</type>
          </tag>
          <tag name="return" description="Unix part exists" line="862" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attrs</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="872" package="lists">
        <name>isUnixLocked</name>
        <full_name>\lamUserList::isUnixLocked()</full_name>
        <docblock line="872">
          <description>Returns if the Unix part is locked.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="872" type="array" variable="$attrs">
            <type>array</type>
          </tag>
          <tag name="return" description="Unix part locked" line="872" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attrs</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="882" package="lists">
        <name>isSambaAvailable</name>
        <full_name>\lamUserList::isSambaAvailable()</full_name>
        <docblock line="882">
          <description>Returns if the Samba part exists.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="882" type="array" variable="$attrs">
            <type>array</type>
          </tag>
          <tag name="return" description="Samba part exists" line="882" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attrs</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="892" package="lists">
        <name>isSambaLocked</name>
        <full_name>\lamUserList::isSambaLocked()</full_name>
        <docblock line="892">
          <description>Returns if the Samba part is locked.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="892" type="array" variable="$attrs">
            <type>array</type>
          </tag>
          <tag name="return" description="Samba part is locked" line="892" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attrs</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="902" package="lists">
        <name>isPPolicyAvailable</name>
        <full_name>\lamUserList::isPPolicyAvailable()</full_name>
        <docblock line="902">
          <description>Returns if the PPolicy part exists.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="902" type="array" variable="$attrs">
            <type>array</type>
          </tag>
          <tag name="return" description="PPolicy part exists" line="902" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attrs</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="912" package="lists">
        <name>isPPolicyLocked</name>
        <full_name>\lamUserList::isPPolicyLocked()</full_name>
        <docblock line="912">
          <description>Returns if the PPolicy part is locked.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="912" type="array" variable="$attrs">
            <type>array</type>
          </tag>
          <tag name="return" description="PPolicy part is locked" line="912" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attrs</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="922" package="lists">
        <name>isWindowsAvailable</name>
        <full_name>\lamUserList::isWindowsAvailable()</full_name>
        <docblock line="922">
          <description>Returns if the Windows part exists.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="922" type="array" variable="$attrs">
            <type>array</type>
          </tag>
          <tag name="return" description="Windows part exists" line="922" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attrs</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="932" package="lists">
        <name>isWindowsLocked</name>
        <full_name>\lamUserList::isWindowsLocked()</full_name>
        <docblock line="932">
          <description>Returns if the Windows part is locked.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="932" type="array" variable="$attrs">
            <type>array</type>
          </tag>
          <tag name="return" description="Windows part is locked" line="932" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attrs</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/types/dhcp.inc" generated-path="lib.types.dhcp.inc.html" hash="40b8b8aa73d4f6311c95dcad8344d543" package="types">
    <docblock line="0">
      <description>The account type for DHCP</description>
      <long-description></long-description>
      <tag name="package" description="types" line="0"/>
      <tag name="author" description="Thomas Manninger" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="39" package="types">
      <extends>\baseType</extends>
      <name>dhcp</name>
      <full_name>\dhcp</full_name>
      <docblock line="39">
        <description>The account type for DHCP</description>
        <long-description></long-description>
        <tag name="package" description="types" line="39"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="44" package="types">
        <name>__construct</name>
        <full_name>\dhcp::__construct()</full_name>
        <docblock line="44">
          <description>Constructs a new DHCP type object.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="55" package="types">
        <name>getAlias</name>
        <full_name>\dhcp::getAlias()</full_name>
        <docblock line="55">
          <description>Returns the alias name of this account type.</description>
          <long-description></long-description>
          <tag name="return" description="alias name" line="55" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="64" package="types">
        <name>getDescription</name>
        <full_name>\dhcp::getDescription()</full_name>
        <docblock line="64">
          <description>Returns the description of this account type.</description>
          <long-description></long-description>
          <tag name="return" description="description" line="64" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="73" package="types">
        <name>getListClassName</name>
        <full_name>\dhcp::getListClassName()</full_name>
        <docblock line="73">
          <description>Returns the class name for the list object.</description>
          <long-description></long-description>
          <tag name="return" description="class name" line="73" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="82" package="types">
        <name>getDefaultListAttributes</name>
        <full_name>\dhcp::getDefaultListAttributes()</full_name>
        <docblock line="82">
          <description>Returns the default attribute list for this account type.</description>
          <long-description></long-description>
          <tag name="return" description="attribute list" line="82" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="92" package="types">
        <name>getListAttributeDescriptions</name>
        <full_name>\dhcp::getListAttributeDescriptions()</full_name>
        <docblock line="92">
          <description>Returns a list of attributes which have a translated description.</description>
          <long-description>This is used for the head row in the list view.</long-description>
          <tag name="return" description="list of descriptions" line="92" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="106" package="types">
        <name>getTitleBarTitle</name>
        <full_name>\dhcp::getTitleBarTitle()</full_name>
        <docblock line="106">
          <description>Returns the the title text for the title bar on the new/edit page.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account container&lt;/p&gt;" line="106" type="\accountContainer" variable="$container">
            <type>\accountContainer</type>
          </tag>
          <tag name="return" description="title text" line="106" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$container</name>
          <default></default>
          <type>\accountContainer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="130" package="types">
        <name>getTitleBarSubtitle</name>
        <full_name>\dhcp::getTitleBarSubtitle()</full_name>
        <docblock line="130">
          <description>Returns the the title text for the title bar on the new/edit page.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account container&lt;/p&gt;" line="130" type="\accountContainer" variable="$container">
            <type>\accountContainer</type>
          </tag>
          <tag name="return" description="title text" line="130" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$container</name>
          <default></default>
          <type>\accountContainer</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="159" package="lists">
      <extends>\lamList</extends>
      <name>lamDHCPList</name>
      <full_name>\lamDHCPList</full_name>
      <docblock line="159">
        <description>Generates the list view.</description>
        <long-description></long-description>
        <tag name="package" description="lists" line="159"/>
        <tag name="author" description="Thomas Manninger" line="159"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="167" package="lists">
        <name>__construct</name>
        <full_name>\lamDHCPList::__construct()</full_name>
        <docblock line="167">
          <description>Constructor</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="167" type="string" variable="$type">
            <type>string</type>
          </tag>
          <tag name="return" description="list object" line="167" type="\lamList">
            <type>\lamList</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$type</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="183" package="lists">
        <name>listPrintTableCellContent</name>
        <full_name>\lamDHCPList::listPrintTableCellContent()</full_name>
        <docblock line="183">
          <description>Prints the content of a cell in the account list for a given LDAP entry and attribute.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="183" type="array" variable="$entry">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;attribute name&lt;/p&gt;" line="183" type="string" variable="$attribute">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$entry</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="246" package="lists">
        <name>addExtraInputElementsToTopArea</name>
        <full_name>\lamDHCPList::addExtraInputElementsToTopArea()</full_name>
        <docblock line="246">
          <description>Add DCP main settings button.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;left part&lt;/p&gt;" line="246" type="\htmlGroup" variable="$left">
            <type>\htmlGroup</type>
          </tag>
          <tag name="param" description="&lt;p&gt;right part&lt;/p&gt;" line="246" type="\htmlGroup" variable="$right">
            <type>\htmlGroup</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$left</name>
          <default></default>
          <type>\htmlGroup</type>
        </argument>
        <argument line="0">
          <name>$right</name>
          <default></default>
          <type>\htmlGroup</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="260" package="lists">
        <name>listDoPost</name>
        <full_name>\lamDHCPList::listDoPost()</full_name>
        <docblock line="260">
          <description>Manages all POST actions (e.g. button pressed) for the account lists.</description>
          <long-description></long-description>
          <tag name="return" description="HTML fragment to insert into beginning of account list" line="260" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/types/netgroup.inc" generated-path="lib.types.netgroup.inc.html" hash="3e5481ee65f5972b82ec488e239c2795" package="types">
    <docblock line="0">
      <description>The account type for NIS netgroups.</description>
      <long-description></long-description>
      <tag name="package" description="types" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="36" package="types">
      <extends>\baseType</extends>
      <name>netgroup</name>
      <full_name>\netgroup</full_name>
      <docblock line="36">
        <description>The account type for NIS netgroups.</description>
        <long-description></long-description>
        <tag name="package" description="types" line="36"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="41" package="types">
        <name>__construct</name>
        <full_name>\netgroup::__construct()</full_name>
        <docblock line="41">
          <description>Constructs a new group type object.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="52" package="types">
        <name>getAlias</name>
        <full_name>\netgroup::getAlias()</full_name>
        <docblock line="52">
          <description>Returns the alias name of this account type.</description>
          <long-description></long-description>
          <tag name="return" description="alias name" line="52" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="61" package="types">
        <name>getDescription</name>
        <full_name>\netgroup::getDescription()</full_name>
        <docblock line="61">
          <description>Returns the description of this account type.</description>
          <long-description></long-description>
          <tag name="return" description="description" line="61" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="70" package="types">
        <name>getListClassName</name>
        <full_name>\netgroup::getListClassName()</full_name>
        <docblock line="70">
          <description>Returns the class name for the list object.</description>
          <long-description></long-description>
          <tag name="return" description="class name" line="70" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="79" package="types">
        <name>getDefaultListAttributes</name>
        <full_name>\netgroup::getDefaultListAttributes()</full_name>
        <docblock line="79">
          <description>Returns the default attribute list for this account type.</description>
          <long-description></long-description>
          <tag name="return" description="attribute list" line="79" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="89" package="types">
        <name>getListAttributeDescriptions</name>
        <full_name>\netgroup::getListAttributeDescriptions()</full_name>
        <docblock line="89">
          <description>Returns a list of attributes which have a translated description.</description>
          <long-description>This is used for the head row in the list view.</long-description>
          <tag name="return" description="list of descriptions" line="89" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="104" package="types">
        <name>getTitleBarTitle</name>
        <full_name>\netgroup::getTitleBarTitle()</full_name>
        <docblock line="104">
          <description>Returns the the title text for the title bar on the new/edit page.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account container&lt;/p&gt;" line="104" type="\accountContainer" variable="$container">
            <type>\accountContainer</type>
          </tag>
          <tag name="return" description="title text" line="104" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$container</name>
          <default></default>
          <type>\accountContainer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="128" package="types">
        <name>getTitleBarSubtitle</name>
        <full_name>\netgroup::getTitleBarSubtitle()</full_name>
        <docblock line="128">
          <description>Returns the the title text for the title bar on the new/edit page.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account container&lt;/p&gt;" line="128" type="\accountContainer" variable="$container">
            <type>\accountContainer</type>
          </tag>
          <tag name="return" description="title text" line="128" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$container</name>
          <default></default>
          <type>\accountContainer</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="158" package="lists">
      <extends>\lamList</extends>
      <name>lamNetgroupList</name>
      <full_name>\lamNetgroupList</full_name>
      <docblock line="158">
        <description>Generates the list view.</description>
        <long-description></long-description>
        <tag name="package" description="lists" line="158"/>
        <tag name="author" description="Roland Gruber" line="158"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="166" package="lists">
        <name>__construct</name>
        <full_name>\lamNetgroupList::__construct()</full_name>
        <docblock line="166">
          <description>Constructor</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="166" type="string" variable="$type">
            <type>string</type>
          </tag>
          <tag name="return" description="list object" line="166" type="\lamList">
            <type>\lamList</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$type</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/account.inc" generated-path="lib.account.inc.html" hash="3887e483b00820401e092b8caa5db0fb" package="lib">
    <docblock line="0">
      <description>This provides several helper function for the account modules.</description>
      <long-description></long-description>
      <tag name="author" description="Tilo Lutz" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="package" description="lib" line="0"/>
    </docblock>
    <function namespace="" line="42" package="lib">
      <name>array_delete</name>
      <full_name>\array_delete()</full_name>
      <docblock line="42">
        <description>This function will return all values from $array without values of $values.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;list of values which should be removed&lt;/p&gt;" line="42" type="array" variable="$values">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;list of original values&lt;/p&gt;" line="42" type="array" variable="$array">
          <type>array</type>
        </tag>
        <tag name="return" description="list of remaining values" line="42" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$values</name>
        <default></default>
        <type>array</type>
      </argument>
      <argument line="0">
        <name>$array</name>
        <default></default>
        <type>array</type>
      </argument>
    </function>
    <function namespace="" line="61" package="lib">
      <name>in_array_ignore_case</name>
      <full_name>\in_array_ignore_case()</full_name>
      <docblock line="61">
        <description>Checks if a string exists in an array, ignoring case.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;search string&lt;/p&gt;" line="61" type="String" variable="$needle">
          <type>String</type>
        </tag>
        <tag name="param" description="&lt;p&gt;array&lt;/p&gt;" line="61" type="array" variable="$haystack">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$needle</name>
        <default></default>
        <type>String</type>
      </argument>
      <argument line="0">
        <name>$haystack</name>
        <default></default>
        <type>array</type>
      </argument>
    </function>
    <function namespace="" line="77" package="lib">
      <name>getdays</name>
      <full_name>\getdays()</full_name>
      <docblock line="77">
        <description>This function will return the days from 1.1.1970 until now.</description>
        <long-description></long-description>
        <tag name="return" description="of days" line="77" type="\number">
          <type>\number</type>
        </tag>
      </docblock>
    </function>
    <function namespace="" line="89" package="lib">
      <name>smbflag</name>
      <full_name>\smbflag()</full_name>
      <docblock line="89">
        <description>Takes a list of Samba flags and creates the corresponding flag string.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;is an array of Samba flags (e.g. X or D)&lt;/p&gt;&#10;" line="89" type="array" variable="$input">
          <type>array</type>
        </tag>
        <tag name="return" description="Samba flag string" line="89" type="string">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$input</name>
        <default></default>
        <type>array</type>
      </argument>
    </function>
    <function namespace="" line="112" package="lib">
      <name>lmPassword</name>
      <full_name>\lmPassword()</full_name>
      <docblock line="112">
        <description>Generates the LM hash of a password.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;password original password&lt;/p&gt;" line="112" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="return" description="password hash" line="112" type="string">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$password</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="126" package="lib">
      <name>ntPassword</name>
      <full_name>\ntPassword()</full_name>
      <docblock line="126">
        <description>Generates the NT hash of a password.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;password original password&lt;/p&gt;" line="126" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="return" description="password hash" line="126" type="string">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$password</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="146" package="lib">
      <name>pwd_hash</name>
      <full_name>\pwd_hash()</full_name>
      <docblock line="146">
        <description>Returns the hash value of a plain text password.</description>
        <long-description></long-description>
        <tag name="see" description="" line="146"/>
        <tag name="param" description="&lt;p&gt;the password string&lt;/p&gt;" line="146" type="string" variable="$password">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;marks the hash as enabled/disabled (e.g. by prefixing &quot;!&quot;)&lt;/p&gt;&#10;" line="146" type="boolean" variable="$enabled">
          <type>boolean</type>
        </tag>
        <tag name="param" description="&lt;p&gt;password hash type (CRYPT, CRYPT-SHA512, SHA, SSHA, MD5, SMD5, PLAIN)&lt;/p&gt;&#10;" line="146" type="string" variable="$hashType">
          <type>string</type>
        </tag>
        <tag name="return" description="the password hash" line="146" type="string">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$password</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$enabled</name>
        <default>true</default>
        <type>boolean</type>
      </argument>
      <argument line="0">
        <name>$hashType</name>
        <default>'SSHA'</default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="188" package="lib">
      <name>getSupportedHashTypes</name>
      <full_name>\getSupportedHashTypes()</full_name>
      <docblock line="188">
        <description>Returns the list of supported hash types (e.g. SSHA).</description>
        <long-description></long-description>
        <tag name="return" description="hash types" line="188" type="array">
          <type>array</type>
        </tag>
      </docblock>
    </function>
    <function namespace="" line="203" package="lib">
      <name>generateSalt</name>
      <full_name>\generateSalt()</full_name>
      <docblock line="203">
        <description>Calculates a password salt of the given legth.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;salt length&lt;/p&gt;" line="203" type="int" variable="$len">
          <type>int</type>
        </tag>
        <tag name="return" description="the salt string" line="203" type="String">
          <type>String</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$len</name>
        <default></default>
        <type>int</type>
      </argument>
    </function>
    <function namespace="" line="219" package="lib">
      <name>pwd_enable</name>
      <full_name>\pwd_enable()</full_name>
      <docblock line="219">
        <description>Marks an password hash as enabled and returns the new hash string</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;hash value to enable&lt;/p&gt;" line="219" type="string" variable="$hash">
          <type>string</type>
        </tag>
        <tag name="return" description="enabled password hash" line="219" type="string">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$hash</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="244" package="lib">
      <name>pwd_disable</name>
      <full_name>\pwd_disable()</full_name>
      <docblock line="244">
        <description>Marks an password hash as disabled and returns the new hash string</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;hash value to disable&lt;/p&gt;" line="244" type="string" variable="$hash">
          <type>string</type>
        </tag>
        <tag name="return" description="disabled hash value" line="244" type="string">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$hash</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="270" package="lib">
      <name>pwd_is_lockable</name>
      <full_name>\pwd_is_lockable()</full_name>
      <docblock line="270">
        <description>Checks if a Unix password can be locked.</description>
        <long-description>This checks if the password is not plain text but e.g. contains {SSHA}.</long-description>
        <tag name="param" description="&lt;p&gt;password value&lt;/p&gt;" line="270" type="String" variable="$password">
          <type>String</type>
        </tag>
        <tag name="return" description="can be locked" line="270" type="boolean">
          <type>boolean</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$password</name>
        <default></default>
        <type>String</type>
      </argument>
    </function>
    <function namespace="" line="283" package="lib">
      <name>pwd_is_enabled</name>
      <full_name>\pwd_is_enabled()</full_name>
      <docblock line="283">
        <description>Checks if a password hash is enabled/disabled</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;password hash to check&lt;/p&gt;" line="283" type="string" variable="$hash">
          <type>string</type>
        </tag>
        <tag name="return" description="true if the password is marked as enabled" line="283" type="boolean">
          <type>boolean</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$hash</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="300" package="lib">
      <name>generateRandomPassword</name>
      <full_name>\generateRandomPassword()</full_name>
      <docblock line="300">
        <description>Generates a random password with 12 digits.</description>
        <long-description></long-description>
        <tag name="return" description="password" line="300" type="String">
          <type>String</type>
        </tag>
      </docblock>
    </function>
    <function namespace="" line="329" package="lib">
      <name>checkPasswordHash</name>
      <full_name>\checkPasswordHash()</full_name>
      <docblock line="329">
        <description>Checks if the given password mathes the crypto hash.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;type hash type (must be one of getSupportedHashTypes())&lt;/p&gt;&#10;" line="329" type="String" variable="">
          <type>String</type>
        </tag>
        <tag name="param" description="&lt;p&gt;password hash value&lt;/p&gt;" line="329" type="\unknown_type" variable="$hash">
          <type>\unknown_type</type>
        </tag>
        <tag name="param" description="&lt;p&gt;plain text password to check&lt;/p&gt;" line="329" type="\unknown_type" variable="$password">
          <type>\unknown_type</type>
        </tag>
        <tag name="see" description="" line="329"/>
      </docblock>
      <argument line="0">
        <name>$type</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$hash</name>
        <default></default>
        <type>\unknown_type</type>
      </argument>
      <argument line="0">
        <name>$password</name>
        <default></default>
        <type>\unknown_type</type>
      </argument>
    </function>
    <function namespace="" line="379" package="lib">
      <name>search_domains</name>
      <full_name>\search_domains()</full_name>
      <docblock line="379">
        <description>Returns an array with all Samba 3 domain entries under the given suffix</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;LDAP handle (if null then $_SESSION['ldap']-&gt;server() is used)&lt;/p&gt;&#10;" line="379" type="\handle" variable="">
          <type>\handle</type>
        </tag>
        <tag name="param" description="&lt;p&gt;LDAP suffix to search (if null then $_SESSION['config']-&gt;get_Suffix('smbDomain') is used)&lt;/p&gt;&#10;" line="379" type="String" variable="$suffix">
          <type>String</type>
        </tag>
        <tag name="return" description="list of samba3domain objects" line="379" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$server</name>
        <default>null</default>
        <type/>
      </argument>
      <argument line="0">
        <name>$suffix</name>
        <default>null</default>
        <type>String</type>
      </argument>
    </function>
    <function namespace="" line="448" package="lib">
      <name>get_preg</name>
      <full_name>\get_preg()</full_name>
      <docblock line="448">
        <description>Checks if a given value matches the selected regular expression.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;value to check&lt;/p&gt;" line="448" type="string" variable="$argument">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;pattern name&lt;/p&gt;" line="448" type="string" variable="$regexp">
          <type>string</type>
        </tag>
        <tag name="return" description="true if matches, otherwise false" line="448" type="boolean">
          <type>boolean</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$argument</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$regexp</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="614" package="lib">
      <name>escapeDN</name>
      <full_name>\escapeDN()</full_name>
      <docblock line="614">
        <description>Escapes any special characters in an LDAP DN.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;DN&lt;/p&gt;" line="614" type="String" variable="$dn">
          <type>String</type>
        </tag>
        <tag name="return" description="escaped DN" line="614" type="String">
          <type>String</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$dn</name>
        <default></default>
        <type>String</type>
      </argument>
    </function>
    <function namespace="" line="633" package="lib">
      <name>searchLDAPByAttribute</name>
      <full_name>\searchLDAPByAttribute()</full_name>
      <docblock line="633">
        <description>This will search the given LDAP suffix for all entries which have the given attribute.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;attribute name (may be null)&lt;/p&gt;&#10;" line="633" type="String" variable="$name">
          <type>String</type>
        </tag>
        <tag name="param" description="&lt;p&gt;attribute value&lt;/p&gt;" line="633" type="String" variable="$value">
          <type>String</type>
        </tag>
        <tag name="param" description="&lt;p&gt;object class (may be null)&lt;/p&gt;&#10;" line="633" type="String" variable="$objectClass">
          <type>String</type>
        </tag>
        <tag name="param" description="&lt;p&gt;list of attributes to return&lt;/p&gt;" line="633" type="array" variable="$attributes">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;account types&lt;/p&gt;" line="633" type="array" variable="$scopes">
          <type>array</type>
        </tag>
        <tag name="return" description="list of found entries" line="633" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$name</name>
        <default></default>
        <type>String</type>
      </argument>
      <argument line="0">
        <name>$value</name>
        <default></default>
        <type>String</type>
      </argument>
      <argument line="0">
        <name>$objectClass</name>
        <default></default>
        <type>String</type>
      </argument>
      <argument line="0">
        <name>$attributes</name>
        <default></default>
        <type>array</type>
      </argument>
      <argument line="0">
        <name>$scopes</name>
        <default></default>
        <type>array</type>
      </argument>
    </function>
    <function namespace="" line="675" package="lib">
      <name>searchLDAPByFilter</name>
      <full_name>\searchLDAPByFilter()</full_name>
      <docblock line="675">
        <description>This will search the given LDAP suffix for all entries which match the given filter.</description>
        <long-description></long-description>
        <tag name="param" description="" line="675" type="String" variable="$filter">
          <type>String</type>
        </tag>
        <tag name="param" description="&lt;p&gt;list of attributes to return&lt;/p&gt;" line="675" type="array" variable="$attributes">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;account types&lt;/p&gt;" line="675" type="array" variable="$scopes">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;get only attributes but no values (default: false)&lt;/p&gt;&#10;" line="675" type="boolean" variable="$attrsOnly">
          <type>boolean</type>
        </tag>
        <tag name="return" description="list of found entries" line="675" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$filter</name>
        <default></default>
        <type>String</type>
      </argument>
      <argument line="0">
        <name>$attributes</name>
        <default></default>
        <type>array</type>
      </argument>
      <argument line="0">
        <name>$scopes</name>
        <default></default>
        <type>array</type>
      </argument>
      <argument line="0">
        <name>$attrsOnly</name>
        <default>false</default>
        <type>boolean</type>
      </argument>
    </function>
    <function namespace="" line="705" package="lib">
      <name>searchLDAP</name>
      <full_name>\searchLDAP()</full_name>
      <docblock line="705">
        <description>Runs an LDAP search.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;LDAP suffix&lt;/p&gt;" line="705" type="String" variable="$suffix">
          <type>String</type>
        </tag>
        <tag name="param" description="&lt;p&gt;filter&lt;/p&gt;" line="705" type="String" variable="$filter">
          <type>String</type>
        </tag>
        <tag name="param" description="&lt;p&gt;list of attributes to return&lt;/p&gt;" line="705" type="array" variable="$attributes">
          <type>array</type>
        </tag>
        <tag name="return" description="list of found entries" line="705" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$suffix</name>
        <default></default>
        <type>String</type>
      </argument>
      <argument line="0">
        <name>$filter</name>
        <default></default>
        <type>String</type>
      </argument>
      <argument line="0">
        <name>$attributes</name>
        <default></default>
        <type>array</type>
      </argument>
    </function>
    <function namespace="" line="728" package="lib">
      <name>ldapGetDN</name>
      <full_name>\ldapGetDN()</full_name>
      <docblock line="728">
        <description>Returns the given DN.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;DN&lt;/p&gt;" line="728" type="String" variable="$dn">
          <type>String</type>
        </tag>
        <tag name="param" description="&lt;p&gt;list of attributes to fetch&lt;/p&gt;" line="728" type="array" variable="$attributes">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;LDAP handle (optional for admin interface pages)&lt;/p&gt;&#10;" line="728" type="\handle" variable="$handle">
          <type>\handle</type>
        </tag>
        <tag name="return" description="attributes or null if not found" line="728" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$dn</name>
        <default></default>
        <type>String</type>
      </argument>
      <argument line="0">
        <name>$attributes</name>
        <default>array('dn')</default>
        <type>array</type>
      </argument>
      <argument line="0">
        <name>$handle</name>
        <default>null</default>
        <type>\handle</type>
      </argument>
    </function>
    <function namespace="" line="750" package="lib">
      <name>getLastLDAPError</name>
      <full_name>\getLastLDAPError()</full_name>
      <docblock line="750">
        <description>Returns the parameters for a StatusMessage of the last LDAP search.</description>
        <long-description></long-description>
        <tag name="return" description="parameters for StatusMessage or null if all was ok" line="750" type="array">
          <type>array</type>
        </tag>
      </docblock>
    </function>
    <function namespace="" line="779" package="lib">
      <name>cleanLDAPResult</name>
      <full_name>\cleanLDAPResult()</full_name>
      <docblock line="779">
        <description>Cleans the result of an LDAP search.</description>
        <long-description>This will remove all 'count' entries and also all numeric array keys.</long-description>
        <tag name="param" description="&lt;p&gt;LDAP entries in format $entries[entry number][attribute name][attribute values]&lt;/p&gt;&#10;" line="779" type="array" variable="$entries">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$entries</name>
        <default></default>
        <type>array</type>
      </argument>
    </function>
    <function namespace="" line="810" package="lib">
      <name>getAbstractDN</name>
      <full_name>\getAbstractDN()</full_name>
      <docblock line="810">
        <description>Transforms a DN into a more user friendly format.</description>
        <long-description>E.g. "dc=company,dc=de" is transformed to "company &gt; de".</long-description>
        <tag name="param" description="&lt;p&gt;DN&lt;/p&gt;" line="810" type="String" variable="$dn">
          <type>String</type>
        </tag>
        <tag name="return" description="transformed DN" line="810" type="String">
          <type>String</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$dn</name>
        <default></default>
        <type>String</type>
      </argument>
    </function>
    <function namespace="" line="831" package="lib">
      <name>compareDN</name>
      <full_name>\compareDN()</full_name>
      <docblock line="831">
        <description>Helper function to sort DNs.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;first argument to compare&lt;/p&gt;" line="831" type="string" variable="$a">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;second argument to compare&lt;/p&gt;" line="831" type="string" variable="$b">
          <type>string</type>
        </tag>
        <tag name="return" description="0 if equal, 1 if $a is greater, -1 if $b is greater" line="831" type="integer">
          <type>integer</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$a</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$b</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="865" package="lib">
      <name>formatLDAPTimestamp</name>
      <full_name>\formatLDAPTimestamp()</full_name>
      <docblock line="865">
        <description>Formats an LDAP time string (e.g. from createTimestamp).</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;LDAP time value&lt;/p&gt;" line="865" type="String" variable="$time">
          <type>String</type>
        </tag>
        <tag name="return" description="formated time" line="865" type="String">
          <type>String</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$time</name>
        <default></default>
        <type>String</type>
      </argument>
    </function>
    <function namespace="" line="875" package="lib">
      <name>obfuscateText</name>
      <full_name>\obfuscateText()</full_name>
      <docblock line="875">
        <description>Simple function to obfuscate strings.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;text to obfuscate&lt;/p&gt;" line="875" type="String" variable="$text">
          <type>String</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$text</name>
        <default></default>
        <type>String</type>
      </argument>
    </function>
    <function namespace="" line="887" package="lib">
      <name>deobfuscateText</name>
      <full_name>\deobfuscateText()</full_name>
      <docblock line="887">
        <description>Simple function to deobfuscate strings.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;text to deobfuscate&lt;/p&gt;" line="887" type="String" variable="$text">
          <type>String</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$text</name>
        <default></default>
        <type>String</type>
      </argument>
    </function>
    <function namespace="" line="900" package="lib">
      <name>isObfuscatedText</name>
      <full_name>\isObfuscatedText()</full_name>
      <docblock line="900">
        <description>Checks if the given text is obfuscated.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;text to check&lt;/p&gt;" line="900" type="String" variable="$text">
          <type>String</type>
        </tag>
        <tag name="return" description="obfuscated or not" line="900" type="boolean">
          <type>boolean</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$text</name>
        <default></default>
        <type>String</type>
      </argument>
    </function>
    <function namespace="" line="919" package="lib">
      <name>extractRDNAttribute</name>
      <full_name>\extractRDNAttribute()</full_name>
      <docblock line="919">
        <description>Extracts the RDN attribute name from a given DN.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;DN&lt;/p&gt;" line="919" type="String" variable="$dn">
          <type>String</type>
        </tag>
        <tag name="return" description="RDN attribute name" line="919" type="String">
          <type>String</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$dn</name>
        <default></default>
        <type>String</type>
      </argument>
    </function>
    <function namespace="" line="931" package="lib">
      <name>extractRDNValue</name>
      <full_name>\extractRDNValue()</full_name>
      <docblock line="931">
        <description>Extracts the RDN attribute value from a given DN.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;DN&lt;/p&gt;" line="931" type="String" variable="$dn">
          <type>String</type>
        </tag>
        <tag name="return" description="RDN attribute value" line="931" type="String">
          <type>String</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$dn</name>
        <default></default>
        <type>String</type>
      </argument>
    </function>
    <function namespace="" line="944" package="lib">
      <name>extractDNSuffix</name>
      <full_name>\extractDNSuffix()</full_name>
      <docblock line="944">
        <description>Extracts the DN suffix from a given DN.</description>
        <long-description>E.g. ou=people,dc=test,dc=com will result in dc=test,dc=com.</long-description>
        <tag name="param" description="&lt;p&gt;DN&lt;/p&gt;" line="944" type="String" variable="$dn">
          <type>String</type>
        </tag>
        <tag name="return" description="DN suffix" line="944" type="String">
          <type>String</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$dn</name>
        <default></default>
        <type>String</type>
      </argument>
    </function>
    <function namespace="" line="957" package="lib">
      <name>sendPasswordMail</name>
      <full_name>\sendPasswordMail()</full_name>
      <docblock line="957">
        <description>Sends the password mail.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;new password&lt;/p&gt;" line="957" type="String" variable="$pwd">
          <type>String</type>
        </tag>
        <tag name="param" description="&lt;p&gt;LDAP attributes of user&lt;/p&gt;" line="957" type="array" variable="$user">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;recipient address (optional, $user['mail'][0] used by default)&lt;/p&gt;&#10;" line="957" type="String" variable="$recipient">
          <type>String</type>
        </tag>
        <tag name="return" description="list of arrays that can be used to create status messages" line="957" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$pwd</name>
        <default></default>
        <type>String</type>
      </argument>
      <argument line="0">
        <name>$user</name>
        <default></default>
        <type>array</type>
      </argument>
      <argument line="0">
        <name>$recipient</name>
        <default>null</default>
        <type>String</type>
      </argument>
    </function>
    <function namespace="" line="1011" package="lib">
      <name>createEMailHeaders</name>
      <full_name>\createEMailHeaders()</full_name>
      <docblock line="1011">
        <description>Generates the email header text for the given parameters.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;FROM address&lt;/p&gt;" line="1011" type="String" variable="$from">
          <type>String</type>
        </tag>
        <tag name="param" description="&lt;p&gt;mail is formatted as HTML or plain text&lt;/p&gt;" line="1011" type="boolean" variable="$isHTML">
          <type>boolean</type>
        </tag>
        <tag name="param" description="&lt;p&gt;reply-to address (optional)&lt;/p&gt;&#10;" line="1011" type="String" variable="$replyTo">
          <type>String</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$from</name>
        <default></default>
        <type>String</type>
      </argument>
      <argument line="0">
        <name>$isHTML</name>
        <default></default>
        <type>boolean</type>
      </argument>
      <argument line="0">
        <name>$replyTo</name>
        <default>null</default>
        <type>String</type>
      </argument>
    </function>
    <function namespace="" line="1041" package="lib">
      <name>base64EncodeForEMail</name>
      <full_name>\base64EncodeForEMail()</full_name>
      <docblock line="1041">
        <description>Returns a base64 encoded string of the given values in a fomat that is used in emails.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;value to encode&lt;/p&gt;" line="1041" type="String" variable="$value">
          <type>String</type>
        </tag>
        <tag name="return" description="base64 encoded value" line="1041" type="String">
          <type>String</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$value</name>
        <default></default>
        <type>String</type>
      </argument>
    </function>
    <function namespace="" line="1079" package="lib">
      <name>getRandomNumber</name>
      <full_name>\getRandomNumber()</full_name>
      <docblock line="1079">
        <description>Returns a random number.</description>
        <long-description></long-description>
        <tag name="return" description="random number" line="1079" type="int">
          <type>int</type>
        </tag>
      </docblock>
    </function>
    <function namespace="" line="1093" package="lib">
      <name>getLDAPSSLCertificate</name>
      <full_name>\getLDAPSSLCertificate()</full_name>
      <docblock line="1093">
        <description>Connects to the LDAP server and extracts the certificates.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;server name&lt;/p&gt;" line="1093" type="String" variable="$server">
          <type>String</type>
        </tag>
        <tag name="param" description="&lt;p&gt;server port&lt;/p&gt;" line="1093" type="String" variable="$port">
          <type>String</type>
        </tag>
        <tag name="return" description="false on error and certificate if extracted successfully" line="1093" type="mixed">
          <type>mixed</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$server</name>
        <default></default>
        <type>String</type>
      </argument>
      <argument line="0">
        <name>$port</name>
        <default></default>
        <type>String</type>
      </argument>
    </function>
    <function namespace="" line="1127" package="lib">
      <name>getExtendedLDAPErrorMessage</name>
      <full_name>\getExtendedLDAPErrorMessage()</full_name>
      <docblock line="1127">
        <description>Returns the extended LDAP error message if any.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;LDAP server handle&lt;/p&gt;" line="1127" type="\handle" variable="$server">
          <type>\handle</type>
        </tag>
        <tag name="return" description="error message" line="1127" type="String">
          <type>String</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$server</name>
        <default></default>
        <type>\handle</type>
      </argument>
    </function>
    <class final="false" abstract="false" namespace="" line="411" package="modules">
      <extends/>
      <name>samba3domain</name>
      <full_name>\samba3domain</full_name>
      <docblock line="411">
        <description>Represents a Samba 3 domain entry</description>
        <long-description></long-description>
        <tag name="package" description="modules" line="411"/>
      </docblock>
      <property static="false" visibility="public" line="414" namespace="" package="modules">
        <name>$dn</name>
        <default></default>
        <docblock line="414">
          <description>DN</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="417" namespace="" package="modules">
        <name>$name</name>
        <default></default>
        <docblock line="417">
          <description>Domain name</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="420" namespace="" package="modules">
        <name>$SID</name>
        <default></default>
        <docblock line="420">
          <description>Domain SID</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="423" namespace="" package="modules">
        <name>$nextRID</name>
        <default></default>
        <docblock line="423">
          <description>Next RID</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="426" namespace="" package="modules">
        <name>$nextUserRID</name>
        <default></default>
        <docblock line="426">
          <description>Next user RID</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="429" namespace="" package="modules">
        <name>$nextGroupRID</name>
        <default></default>
        <docblock line="429">
          <description>Next group RID</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="432" namespace="" package="modules">
        <name>$RIDbase</name>
        <default>1000</default>
        <docblock line="432">
          <description>RID base to calculate RIDs, default 1000</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="435" namespace="" package="modules">
        <name>$minPwdAge</name>
        <default></default>
        <docblock line="435">
          <description>seconds after the password can be changed</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="438" namespace="" package="modules">
        <name>$maxPwdAge</name>
        <default></default>
        <docblock line="438">
          <description>seconds after the password must be changed</description>
          <long-description></long-description>
        </docblock>
      </property>
    </class>
    <class final="false" abstract="false" namespace="" line="1051" package="lib">
      <extends/>
      <name>moduleCache</name>
      <full_name>\moduleCache</full_name>
      <docblock line="1051">
        <description>Caches module objects.</description>
        <long-description>This improves performance if the same module does not need to be created multiple times (calling get_metaData() each time).</long-description>
        <tag name="author" description="Roland Gruber" line="1051"/>
      </docblock>
      <property static="true" visibility="private" line="1054" namespace="" package="lib">
        <name>$cache</name>
        <default>array()</default>
        <docblock line="1054">
          <description>module cache ("name:scope" =&gt; module)</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="1062" package="lib">
        <name>getModule</name>
        <full_name>\moduleCache::getModule()</full_name>
        <docblock line="1062">
          <description>Returns a new/cached module with the given name and scope.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;module name&lt;/p&gt;" line="1062" type="String" variable="$name">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;module scope (e.g. user)&lt;/p&gt;&#10;" line="1062" type="String" variable="$scope">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/html.inc" generated-path="lib.html.inc.html" hash="f2c21d0a8dd7566f344912ef7275e474" package="metaHTML">
    <docblock line="0">
      <description>Interface between modules and other parts of LAM.</description>
      <long-description></long-description>
      <tag name="package" description="metaHTML" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="true" namespace="" line="37" package="metaHTML">
      <extends/>
      <name>htmlElement</name>
      <full_name>\htmlElement</full_name>
      <docblock line="37">
        <description>Represents a HTML element.</description>
        <long-description>This is used to build HTML code by using objects.</long-description>
        <tag name="package" description="metaHTML" line="37"/>
      </docblock>
      <constant namespace="" line="40" package="metaHTML">
        <name>ALIGN_TOP</name>
        <full_name>\htmlElement::ALIGN_TOP</full_name>
        <value>0</value>
        <docblock line="40">
          <description>align to top</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="" line="42" package="metaHTML">
        <name>ALIGN_LEFT</name>
        <full_name>\htmlElement::ALIGN_LEFT</full_name>
        <value>1</value>
        <docblock line="42">
          <description>align to left</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="" line="44" package="metaHTML">
        <name>ALIGN_RIGHT</name>
        <full_name>\htmlElement::ALIGN_RIGHT</full_name>
        <value>2</value>
        <docblock line="44">
          <description>align to right</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="" line="46" package="metaHTML">
        <name>ALIGN_BOTTOM</name>
        <full_name>\htmlElement::ALIGN_BOTTOM</full_name>
        <value>3</value>
        <docblock line="46">
          <description>align to bottom</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="" line="48" package="metaHTML">
        <name>ALIGN_CENTER</name>
        <full_name>\htmlElement::ALIGN_CENTER</full_name>
        <value>4</value>
        <docblock line="48">
          <description>align to center</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="" line="51" package="metaHTML">
        <name>VALIDATE_NUMERIC</name>
        <full_name>\htmlElement::VALIDATE_NUMERIC</full_name>
        <value>'numeric'</value>
        <docblock line="51">
          <description>validation rule to allow only numbers ([0-9]+)</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="" line="53" package="metaHTML">
        <name>VALIDATE_NUMERIC_WITH_NEGATIVE</name>
        <full_name>\htmlElement::VALIDATE_NUMERIC_WITH_NEGATIVE</full_name>
        <value>'numericWithNegative'</value>
        <docblock line="53">
          <description>validation rule to allow positive/negative numbers ([-]?[0-9]+)</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <property static="false" visibility="public" line="56" namespace="" package="metaHTML">
        <name>$alignment</name>
        <default>null</default>
        <docblock line="56">
          <description>alignment when inside a table</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="58" namespace="" package="metaHTML">
        <name>$colspan</name>
        <default>null</default>
        <docblock line="58">
          <description>colspan if inside a table</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="60" namespace="" package="metaHTML">
        <name>$rowspan</name>
        <default>null</default>
        <docblock line="60">
          <description>rowspan if inside a table</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="62" namespace="" package="metaHTML">
        <name>$cssClasses</name>
        <default>array()</default>
        <docblock line="62">
          <description>CSS classes</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="64" namespace="" package="metaHTML">
        <name>$tableCellCssClasses</name>
        <default>array()</default>
        <docblock line="64">
          <description>table cell CSS classes</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="true" static="false" visibility="public" namespace="" line="77" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlElement::generateHTML()</full_name>
        <docblock line="77">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="77" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="77" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="77" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="77" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="77" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="77" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="77" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="84" package="metaHTML">
        <name>getAlignmentString</name>
        <full_name>\htmlElement::getAlignmentString()</full_name>
        <docblock line="84">
          <description>Returns the HTML attributes for the alignment.</description>
          <long-description></long-description>
          <tag name="return" description="alignment HTML attributes (e.g. align=&amp;quot;right&amp;quot; valign=&amp;quot;top&amp;quot;)" line="84" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="113" package="metaHTML">
        <name>getColspanString</name>
        <full_name>\htmlElement::getColspanString()</full_name>
        <docblock line="113">
          <description>Returns the HTML attribute for the colspan.</description>
          <long-description></long-description>
          <tag name="return" description="colspan HTML attribute (e.g. colspan=3)" line="113" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="125" package="metaHTML">
        <name>getRowspanString</name>
        <full_name>\htmlElement::getRowspanString()</full_name>
        <docblock line="125">
          <description>Returns the HTML attribute for the rowspan.</description>
          <long-description></long-description>
          <tag name="return" description="rowspan HTML attribute (e.g. rowspan=3)" line="125" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="137" package="metaHTML">
        <name>setCSSClasses</name>
        <full_name>\htmlElement::setCSSClasses()</full_name>
        <docblock line="137">
          <description>Adds CSS classes to this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;CSS class names&lt;/p&gt;" line="137" type="array" variable="$classes">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$classes</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="146" package="metaHTML">
        <name>setTableCellCSSClasses</name>
        <full_name>\htmlElement::setTableCellCSSClasses()</full_name>
        <docblock line="146">
          <description>Adds CSS classes to the surrounding table cell for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;CSS class names&lt;/p&gt;" line="146" type="array" variable="$classes">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$classes</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="155" package="metaHTML">
        <name>getTableCellCSSClasses</name>
        <full_name>\htmlElement::getTableCellCSSClasses()</full_name>
        <docblock line="155">
          <description>Returns the CSS classes of the surrounding table cell for this element.</description>
          <long-description></long-description>
          <tag name="return" description="CSS classes" line="155" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="166" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlTable</name>
      <full_name>\htmlTable</full_name>
      <docblock line="166">
        <description>Structures elements using a table.</description>
        <long-description>This is used to build HTML code by using objects.</long-description>
        <tag name="package" description="metaHTML" line="166"/>
      </docblock>
      <constant namespace="" line="169" package="metaHTML">
        <name>footer</name>
        <full_name>\htmlTable::footer</full_name>
        <value>"&lt;/table&gt;\n"</value>
        <docblock line="169">
          <description>table footer</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="" line="171" package="metaHTML">
        <name>newLine</name>
        <full_name>\htmlTable::newLine</full_name>
        <value>"&lt;/tr&gt;&lt;tr&gt;\n"</value>
        <docblock line="171">
          <description>new line</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <property static="false" visibility="private" line="174" namespace="" package="metaHTML">
        <name>$elements</name>
        <default>array()</default>
        <docblock line="174">
          <description>list of subelements</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="176" namespace="" package="metaHTML">
        <name>$rowOpen</name>
        <default>false</default>
        <docblock line="176">
          <description>specifies if currently a row is open</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="178" namespace="" package="metaHTML">
        <name>$width</name>
        <default>null</default>
        <docblock line="178">
          <description>table width</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="180" namespace="" package="metaHTML">
        <name>$id</name>
        <default>null</default>
        <docblock line="180">
          <description>HTML ID</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="188" package="metaHTML">
        <name>__construct</name>
        <full_name>\htmlTable::__construct()</full_name>
        <docblock line="188">
          <description>Constructor</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;table width (e.g. 100%)&lt;/p&gt;&#10;" line="188" type="String" variable="$width">
            <type>String</type>
          </tag>
          <tag name="see" description="" line="188"/>
        </docblock>
        <argument line="0">
          <name>$width</name>
          <default>null</default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$id</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="200" package="metaHTML">
        <name>addElement</name>
        <full_name>\htmlTable::addElement()</full_name>
        <docblock line="200">
          <description>Adds an element to the table. The element may be a htmlElement object or a simple String.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;htmlElement object or a simple String&lt;/p&gt;" line="200" type="mixed" variable="$element">
            <type>mixed</type>
          </tag>
          <tag name="param" description="&lt;p&gt;adds a new line after the element (optional, default false)&lt;/p&gt;&#10;" line="200" type="boolean" variable="$newLine">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;specifies if this is a head or body element (default: body)&lt;/p&gt;&#10;" line="200" type="boolean" variable="$isTableHeadElement">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$element</name>
          <default></default>
          <type>mixed</type>
        </argument>
        <argument line="0">
          <name>$newLine</name>
          <default>false</default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$isTableHeadElement</name>
          <default>false</default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="244" package="metaHTML">
        <name>addNewLine</name>
        <full_name>\htmlTable::addNewLine()</full_name>
        <docblock line="244">
          <description>Adds another line to the table.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="264" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlTable::generateHTML()</full_name>
        <docblock line="264">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="264" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="264" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="264" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="264" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="264" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="264" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="264" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="305" package="metaHTML">
        <name>mergeTableElements</name>
        <full_name>\htmlTable::mergeTableElements()</full_name>
        <docblock line="305">
          <description>Merges the content of another htmlTable object into this table.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;table to get elements&lt;/p&gt;" line="305" type="" variable="$table"/>
        </docblock>
        <argument line="0">
          <name>$table</name>
          <default></default>
          <type>mixed</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="338" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlTableRow</name>
      <full_name>\htmlTableRow</full_name>
      <docblock line="338">
        <description>A row inside a htmlTable.</description>
        <long-description>This is used to build HTML code by using objects.</long-description>
        <tag name="see" description="" line="338"/>
        <tag name="package" description="metaHTML" line="338"/>
      </docblock>
      <property static="false" visibility="private" line="341" namespace="" package="metaHTML">
        <name>$cells</name>
        <default></default>
        <docblock line="341">
          <description>table cells</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="349" package="metaHTML">
        <name>__construct</name>
        <full_name>\htmlTableRow::__construct()</full_name>
        <docblock line="349">
          <description>Constructor</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of htmlElements&lt;/p&gt;" line="349" type="array" variable="$cells">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="349"/>
        </docblock>
        <argument line="0">
          <name>$cells</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="364" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlTableRow::generateHTML()</full_name>
        <docblock line="364">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="364" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="364" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="364" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="364" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="364" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="364" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="364" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="391" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlInputField</name>
      <full_name>\htmlInputField</full_name>
      <docblock line="391">
        <description>A standard input field.</description>
        <long-description>This is used to build HTML code by using objects.</long-description>
        <tag name="package" description="metaHTML" line="391"/>
      </docblock>
      <property static="false" visibility="protected" line="394" namespace="" package="metaHTML">
        <name>$fieldName</name>
        <default></default>
        <docblock line="394">
          <description>unique field name</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="396" namespace="" package="metaHTML">
        <name>$fieldValue</name>
        <default></default>
        <docblock line="396">
          <description>field value</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="398" namespace="" package="metaHTML">
        <name>$fieldSize</name>
        <default>30</default>
        <docblock line="398">
          <description>field size (default 30)</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="400" namespace="" package="metaHTML">
        <name>$fieldMaxLength</name>
        <default>255</default>
        <docblock line="400">
          <description>field max length (default 255)</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="402" namespace="" package="metaHTML">
        <name>$onKeyPress</name>
        <default>null</default>
        <docblock line="402">
          <description>on keypress event</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="404" namespace="" package="metaHTML">
        <name>$isPassword</name>
        <default>false</default>
        <docblock line="404">
          <description>password field</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="406" namespace="" package="metaHTML">
        <name>$isEnabled</name>
        <default>true</default>
        <docblock line="406">
          <description>enabled or disabled</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="408" namespace="" package="metaHTML">
        <name>$obfuscate</name>
        <default>false</default>
        <docblock line="408">
          <description>indicates that the value should be saved in obfuscated form</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="410" namespace="" package="metaHTML">
        <name>$transient</name>
        <default>false</default>
        <docblock line="410">
          <description>indicates that this field should not automatically be saved in the self service or server profile</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="412" namespace="" package="metaHTML">
        <name>$required</name>
        <default>false</default>
        <docblock line="412">
          <description>required field</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="414" namespace="" package="metaHTML">
        <name>$validationRule</name>
        <default>null</default>
        <docblock line="414">
          <description>validation rule</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="416" namespace="" package="metaHTML">
        <name>$autocomplete</name>
        <default>false</default>
        <docblock line="416">
          <description>enable autocomplete</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="418" namespace="" package="metaHTML">
        <name>$autocompleteMultiValue</name>
        <default>false</default>
        <docblock line="418">
          <description>multiple values in one field</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="420" namespace="" package="metaHTML">
        <name>$autocompleteMultiValueSeparatorExp</name>
        <default>null</default>
        <docblock line="420">
          <description>separator expression for multiple values in one field</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="422" namespace="" package="metaHTML">
        <name>$autocompleteMultiValueSeparator</name>
        <default>null</default>
        <docblock line="422">
          <description>separator for multiple values in one field</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="424" namespace="" package="metaHTML">
        <name>$autocompleteValues</name>
        <default>array()</default>
        <docblock line="424">
          <description>autocompletion suggestions</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="426" namespace="" package="metaHTML">
        <name>$autocompleteMinLength</name>
        <default>1</default>
        <docblock line="426">
          <description>autocomplete start at this input length</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="428" namespace="" package="metaHTML">
        <name>$showCalendar</name>
        <default>false</default>
        <docblock line="428">
          <description>show calendar</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="430" namespace="" package="metaHTML">
        <name>$calendarFormat</name>
        <default>''</default>
        <docblock line="430">
          <description>calendar format</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="432" namespace="" package="metaHTML">
        <name>$title</name>
        <default>null</default>
        <docblock line="432">
          <description>title attribute</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="441" package="metaHTML">
        <name>__construct</name>
        <full_name>\htmlInputField::__construct()</full_name>
        <docblock line="441">
          <description>Constructor</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;unique field name&lt;/p&gt;" line="441" type="String" variable="$fieldName">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;value of input field (optional)&lt;/p&gt;&#10;" line="441" type="String" variable="$fieldValue">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;maximum input length&lt;/p&gt;" line="441" type="String" variable="$fieldSize">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$fieldName</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$fieldValue</name>
          <default>null</default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$fieldSize</name>
          <default>null</default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="463" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlInputField::generateHTML()</full_name>
        <docblock line="463">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="463" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="463" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="463" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="463" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="463" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="463" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="463" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="579" package="metaHTML">
        <name>setFieldMaxLength</name>
        <full_name>\htmlInputField::setFieldMaxLength()</full_name>
        <docblock line="579">
          <description>Sets the maximum field length.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;length&lt;/p&gt;" line="579" type="int" variable="$fieldMaxLength">
            <type>int</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$fieldMaxLength</name>
          <default></default>
          <type>int</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="588" package="metaHTML">
        <name>setFieldSize</name>
        <full_name>\htmlInputField::setFieldSize()</full_name>
        <docblock line="588">
          <description>Sets the field size.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;size&lt;/p&gt;" line="588" type="int" variable="$fieldSize">
            <type>int</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$fieldSize</name>
          <default></default>
          <type>int</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="597" package="metaHTML">
        <name>setIsPassword</name>
        <full_name>\htmlInputField::setIsPassword()</full_name>
        <docblock line="597">
          <description>Specifies if this is a password field.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;password field&lt;/p&gt;" line="597" type="boolean" variable="$isPassword">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$isPassword</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="606" package="metaHTML">
        <name>setIsEnabled</name>
        <full_name>\htmlInputField::setIsEnabled()</full_name>
        <docblock line="606">
          <description>Specifies if this component is enabled and accepts user modification.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;enabled if true&lt;/p&gt;" line="606" type="boolean" variable="$isEnabled">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$isEnabled</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="615" package="metaHTML">
        <name>setObfuscate</name>
        <full_name>\htmlInputField::setObfuscate()</full_name>
        <docblock line="615">
          <description>Specifies if the value should be saved in obfuscated form (e.g. self service profile).</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;obfuscate value&lt;/p&gt;" line="615" type="boolean" variable="$obfuscate">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$obfuscate</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="624" package="metaHTML">
        <name>setTransient</name>
        <full_name>\htmlInputField::setTransient()</full_name>
        <docblock line="624">
          <description>Specifies that the value should not be automatically saved when used in self service or server profile (default: false).</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;transient field&lt;/p&gt;" line="624" type="boolean" variable="$transient">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$transient</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="633" package="metaHTML">
        <name>setRequired</name>
        <full_name>\htmlInputField::setRequired()</full_name>
        <docblock line="633">
          <description>Specifies if the input field is required.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;required&lt;/p&gt;" line="633" type="boolean" variable="$required">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$required</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="643" package="metaHTML">
        <name>setValidationRule</name>
        <full_name>\htmlInputField::setValidationRule()</full_name>
        <docblock line="643">
          <description>Specifies the validation rule (e.g. htmlElement::VALIDATE_NUMERIC) for this field.</description>
          <long-description>This rule is checked on client side when the input field looses focus.</long-description>
          <tag name="param" description="&lt;p&gt;rule name&lt;/p&gt;" line="643" type="boolean" variable="$rule">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rule</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="656" package="metaHTML">
        <name>enableAutocompletion</name>
        <full_name>\htmlInputField::enableAutocompletion()</full_name>
        <docblock line="656">
          <description>Enables autocompletion for this input field.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of values to suggest&lt;/p&gt;" line="656" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;autocompletion starts after this number of caracters entered (default 1; 0 means immediate start)&lt;/p&gt;&#10;" line="656" type="int" variable="$minLength">
            <type>int</type>
          </tag>
          <tag name="param" description="&lt;p&gt;allow multiple autocompletion values in the same fields (default: false)&lt;/p&gt;&#10;" line="656" type="boolean" variable="$multiValue">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;separator expression if multiple autocompletion values are allowed (default &quot;,\s*&quot;)&lt;/p&gt;&#10;" line="656" type="String" variable="$multiSeparator">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;separator for two values (default &quot;, &quot;)&lt;/p&gt;&#10;" line="656" type="String" variable="$multiSeparator">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$minLength</name>
          <default>1</default>
          <type>int</type>
        </argument>
        <argument line="0">
          <name>$multiValue</name>
          <default>false</default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$multiSeparatorExp</name>
          <default>',\s*'</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$multiSeparator</name>
          <default>', '</default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="673" package="metaHTML">
        <name>setOnKeyPress</name>
        <full_name>\htmlInputField::setOnKeyPress()</full_name>
        <docblock line="673">
          <description>Sets the JavaScript for the onKeyPress event.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;JavaScript code&lt;/p&gt;" line="673" type="String" variable="$onKeyPress">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$onKeyPress</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="682" package="metaHTML">
        <name>showCalendar</name>
        <full_name>\htmlInputField::showCalendar()</full_name>
        <docblock line="682">
          <description>Shows a calendar when the field is selected.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;calendar format (e.g. yyyy-mm-dd)&lt;/p&gt;&#10;" line="682" type="String" variable="$format">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$format</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="692" package="metaHTML">
        <name>setTitle</name>
        <full_name>\htmlInputField::setTitle()</full_name>
        <docblock line="692">
          <description>Sets the title for the input field.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;title value&lt;/p&gt;" line="692" type="String" variable="$title">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$title</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="703" package="metaHTML">
      <extends>\htmlInputField</extends>
      <name>htmlTableExtendedInputField</name>
      <full_name>\htmlTableExtendedInputField</full_name>
      <docblock line="703">
        <description>An extended input field that combines label, input field and help.</description>
        <long-description>This is used to build HTML code by using objects.</long-description>
        <tag name="package" description="metaHTML" line="703"/>
      </docblock>
      <property static="false" visibility="private" line="706" namespace="" package="metaHTML">
        <name>$label</name>
        <default></default>
        <docblock line="706">
          <description>Descriptive label</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="708" namespace="" package="metaHTML">
        <name>$helpID</name>
        <default></default>
        <docblock line="708">
          <description>help ID</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="718" package="metaHTML">
        <name>__construct</name>
        <full_name>\htmlTableExtendedInputField::__construct()</full_name>
        <docblock line="718">
          <description>Constructor</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;descriptive label&lt;/p&gt;" line="718" type="String" variable="$label">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;unique field name&lt;/p&gt;" line="718" type="String" variable="$fieldName">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;value of input field (optional)&lt;/p&gt;&#10;" line="718" type="String" variable="$fieldValue">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;help ID (optional)&lt;/p&gt;&#10;" line="718" type="String" variable="$helpID">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$label</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$fieldName</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$fieldValue</name>
          <default>null</default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$helpID</name>
          <default>null</default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="735" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlTableExtendedInputField::generateHTML()</full_name>
        <docblock line="735">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="735" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="735" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="735" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="735" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="735" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="735" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="735" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="764" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlHelpLink</name>
      <full_name>\htmlHelpLink</full_name>
      <docblock line="764">
        <description>Renders a help link.</description>
        <long-description>This is used to build HTML code by using objects.</long-description>
        <tag name="package" description="metaHTML" line="764"/>
      </docblock>
      <property static="false" visibility="private" line="767" namespace="" package="metaHTML">
        <name>$helpID</name>
        <default></default>
        <docblock line="767">
          <description>help ID</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="769" namespace="" package="metaHTML">
        <name>$module</name>
        <default></default>
        <docblock line="769">
          <description>module name if it should be forced</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="771" namespace="" package="metaHTML">
        <name>$scope</name>
        <default></default>
        <docblock line="771">
          <description>account type if it should be forced</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="780" package="metaHTML">
        <name>__construct</name>
        <full_name>\htmlHelpLink::__construct()</full_name>
        <docblock line="780">
          <description>Constructor</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;help ID&lt;/p&gt;" line="780" type="String" variable="$helpID">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;module name (optional, only if value from generateHTML() should be overwritten)&lt;/p&gt;&#10;" line="780" type="String" variable="$module">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;account type (e.g. user) (optional, only if value from generateHTML() should be overwritten)&lt;/p&gt;&#10;" line="780" type="String" variable="$scope">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$helpID</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$module</name>
          <default>null</default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default>null</default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="797" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlHelpLink::generateHTML()</full_name>
        <docblock line="797">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="797" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="797" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="797" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="797" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="797" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="797" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="797" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="818" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlButton</name>
      <full_name>\htmlButton</full_name>
      <docblock line="818">
        <description>Simple button.</description>
        <long-description>This is used to build HTML code by using objects.</long-description>
        <tag name="package" description="metaHTML" line="818"/>
      </docblock>
      <property static="false" visibility="protected" line="821" namespace="" package="metaHTML">
        <name>$name</name>
        <default></default>
        <docblock line="821">
          <description>button name</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="823" namespace="" package="metaHTML">
        <name>$value</name>
        <default></default>
        <docblock line="823">
          <description>button text or image</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="825" namespace="" package="metaHTML">
        <name>$isImageButton</name>
        <default></default>
        <docblock line="825">
          <description>image button or text button</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="827" namespace="" package="metaHTML">
        <name>$title</name>
        <default>null</default>
        <docblock line="827">
          <description>title</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="829" namespace="" package="metaHTML">
        <name>$isEnabled</name>
        <default>true</default>
        <docblock line="829">
          <description>enabled or disabled</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="831" namespace="" package="metaHTML">
        <name>$iconClass</name>
        <default>null</default>
        <docblock line="831">
          <description>icon class (CSS) for buttons with icon + text</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="833" namespace="" package="metaHTML">
        <name>$onClick</name>
        <default>null</default>
        <docblock line="833">
          <description>onclick event</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="842" package="metaHTML">
        <name>__construct</name>
        <full_name>\htmlButton::__construct()</full_name>
        <docblock line="842">
          <description>Constructor.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;button name&lt;/p&gt;" line="842" type="String" variable="$name">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;button text or image (16x16px, relative to graphics folder)&lt;/p&gt;&#10;" line="842" type="String" variable="$value">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;image or text button (default text)&lt;/p&gt;&#10;" line="842" type="String" variable="$isImageButton">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$value</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$isImageButton</name>
          <default>false</default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="859" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlButton::generateHTML()</full_name>
        <docblock line="859">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="859" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="859" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="859" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="859" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="859" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="859" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="859" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="921" package="metaHTML">
        <name>setTitle</name>
        <full_name>\htmlButton::setTitle()</full_name>
        <docblock line="921">
          <description>Sets the button title (tooltip).</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;title&lt;/p&gt;" line="921" type="String" variable="$title">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$title</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="930" package="metaHTML">
        <name>setIsEnabled</name>
        <full_name>\htmlButton::setIsEnabled()</full_name>
        <docblock line="930">
          <description>Specifies if this component is enabled and accepts user modification.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;enabled if true&lt;/p&gt;" line="930" type="boolean" variable="$isEnabled">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$isEnabled</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="940" package="metaHTML">
        <name>setIconClass</name>
        <full_name>\htmlButton::setIconClass()</full_name>
        <docblock line="940">
          <description>Sets an additional icon for a text button.</description>
          <long-description>The icon class is a CSS class that specifies the icon image (e.g. "deleteButton" in layout.css).</long-description>
          <tag name="param" description="&lt;p&gt;icon class&lt;/p&gt;" line="940" type="String" variable="$iconClass">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$iconClass</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="950" package="metaHTML">
        <name>setOnClick</name>
        <full_name>\htmlButton::setOnClick()</full_name>
        <docblock line="950">
          <description>Sets the onclick event code.</description>
          <long-description>This makes this button a simple button that does not submit a form.</long-description>
          <tag name="param" description="&lt;p&gt;JS code&lt;/p&gt;" line="950" type="String" variable="$onClick">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$onClick</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="962" package="metaHTML">
      <extends>\htmlButton</extends>
      <name>htmlAccountPageButton</name>
      <full_name>\htmlAccountPageButton</full_name>
      <docblock line="962">
        <description>Prints a button for the account pages.</description>
        <long-description>This is used to build HTML code by using objects.</long-description>
        <tag name="package" description="metaHTML" line="962"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="973" package="metaHTML">
        <name>__construct</name>
        <full_name>\htmlAccountPageButton::__construct()</full_name>
        <docblock line="973">
          <description>Constructor</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;module name which renders next page&lt;/p&gt;" line="973" type="String" variable="$targetModule">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;name of next page&lt;/p&gt;" line="973" type="String" variable="$targetPage">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;identifier for button&lt;/p&gt;" line="973" type="String" variable="$identifier">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;button text or image (16x16px, relative to graphics folder)&lt;/p&gt;&#10;" line="973" type="String" variable="$value">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;image or text button (default text)&lt;/p&gt;&#10;" line="973" type="String" variable="$isImageButton">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$targetModule</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$targetPage</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$identifier</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$value</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$isImageButton</name>
          <default>false</default>
          <type>String</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="986" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlSelect</name>
      <full_name>\htmlSelect</full_name>
      <docblock line="986">
        <description>Represents a select box.</description>
        <long-description>This is used to build HTML code by using objects.</long-description>
        <tag name="package" description="metaHTML" line="986"/>
      </docblock>
      <property static="false" visibility="private" line="989" namespace="" package="metaHTML">
        <name>$name</name>
        <default></default>
        <docblock line="989">
          <description>name of select field</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="991" namespace="" package="metaHTML">
        <name>$size</name>
        <default></default>
        <docblock line="991">
          <description>size</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="993" namespace="" package="metaHTML">
        <name>$multiSelect</name>
        <default>false</default>
        <docblock line="993">
          <description>allows multi-selection</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="995" namespace="" package="metaHTML">
        <name>$elements</name>
        <default></default>
        <docblock line="995">
          <description>elements</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="997" namespace="" package="metaHTML">
        <name>$selectedElements</name>
        <default>array()</default>
        <docblock line="997">
          <description>selected elements</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="999" namespace="" package="metaHTML">
        <name>$hasDescriptiveElements</name>
        <default>false</default>
        <docblock line="999">
          <description>descriptive elements</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1001" namespace="" package="metaHTML">
        <name>$containsOptgroups</name>
        <default>false</default>
        <docblock line="1001">
          <description>contains optgroups</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1003" namespace="" package="metaHTML">
        <name>$sortElements</name>
        <default>true</default>
        <docblock line="1003">
          <description>sorting enabled</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1005" namespace="" package="metaHTML">
        <name>$rightToLeftTextDirection</name>
        <default>false</default>
        <docblock line="1005">
          <description>right to left text direction</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1007" namespace="" package="metaHTML">
        <name>$isEnabled</name>
        <default>true</default>
        <docblock line="1007">
          <description>enabled or disabled</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1009" namespace="" package="metaHTML">
        <name>$width</name>
        <default>''</default>
        <docblock line="1009">
          <description>width of input element</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1011" namespace="" package="metaHTML">
        <name>$transformSingleSelect</name>
        <default>true</default>
        <docblock line="1011">
          <description>transform select boxes with one element to text</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1013" namespace="" package="metaHTML">
        <name>$onchangeEvent</name>
        <default>null</default>
        <docblock line="1013">
          <description>onchange event</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1015" namespace="" package="metaHTML">
        <name>$transient</name>
        <default>false</default>
        <docblock line="1015">
          <description>indicates that this field should not automatically be saved in the self service or server profile</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="1017" namespace="" package="metaHTML">
        <name>$tableRowsToHide</name>
        <default>array()</default>
        <docblock line="1017">
          <description>list of enclosing table rows to hide when checked</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="1019" namespace="" package="metaHTML">
        <name>$tableRowsToShow</name>
        <default>array()</default>
        <docblock line="1019">
          <description>list of enclosing table rows to show when checked</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1040" package="metaHTML">
        <name>__construct</name>
        <full_name>\htmlSelect::__construct()</full_name>
        <docblock line="1040">
          <description>Constructor.</description>
          <long-description>&lt;br&gt;Examples:
&lt;br&gt;
&lt;br&gt;$select = new htmlSelect('myName', array('value1', 'value2'), array('value1'));
&lt;br&gt;
&lt;br&gt;$select = new htmlSelect('myName', array('label1' =&gt; 'value1', 'label2' =&gt; 'value2'), array('value1'));
&lt;br&gt;$select-&gt;setHasDescriptiveElements(true);
&lt;br&gt;
&lt;br&gt;$select = new htmlSelect('myName', array('optgroupLabel' =&gt; array('value1', 'value2')), array('value1'));
&lt;br&gt;$select-&gt;setHasDescriptiveElements(true);
&lt;br&gt;$select-&gt;setContainsOptgroups(true);</long-description>
          <tag name="param" description="&lt;p&gt;element name&lt;/p&gt;" line="1040" type="String" variable="$name">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of elements array(label =&gt; value) or array(value1, value2) or array('optgroup' =&gt; array(...))&lt;/p&gt;&#10;" line="1040" type="array" variable="$elements">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of selected elements (optional, default none)&lt;/p&gt;&#10;" line="1040" type="array" variable="$selectedElements">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;size (optional, default = 1)&lt;/p&gt;&#10;" line="1040" type="int" variable="$size">
            <type>int</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$elements</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedElements</name>
          <default>array()</default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$size</name>
          <default>1</default>
          <type>int</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1060" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlSelect::generateHTML()</full_name>
        <docblock line="1060">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="1060" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="1060" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="1060" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="1060" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="1060" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="1060" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="1060" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1147" package="metaHTML">
        <name>printOptionsHTML</name>
        <full_name>\htmlSelect::printOptionsHTML()</full_name>
        <docblock line="1147">
          <description>Prints the HTML code of the option tags.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of options&lt;/p&gt;" line="1147" type="array" variable="$elements">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$elements</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1185" package="metaHTML">
        <name>setHasDescriptiveElements</name>
        <full_name>\htmlSelect::setHasDescriptiveElements()</full_name>
        <docblock line="1185">
          <description>Specifies if the elements are just a simple list or an assoziative array (default: simple list).</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;activates descriptive elements&lt;/p&gt;" line="1185" type="boolean" variable="$hasDescriptiveElements">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$hasDescriptiveElements</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1194" package="metaHTML">
        <name>setContainsOptgroups</name>
        <full_name>\htmlSelect::setContainsOptgroups()</full_name>
        <docblock line="1194">
          <description>Specifies if the elements are divided into optgroups.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;activates optgroups&lt;/p&gt;" line="1194" type="boolean" variable="$containsOptgroups">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$containsOptgroups</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1203" package="metaHTML">
        <name>setMultiSelect</name>
        <full_name>\htmlSelect::setMultiSelect()</full_name>
        <docblock line="1203">
          <description>Specifies if multi-selection is enabled (default: disabled).</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;allows multi-selection&lt;/p&gt;&#10;" line="1203" type="boolean" variable="$multiSelect">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$multiSelect</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1212" package="metaHTML">
        <name>setSortElements</name>
        <full_name>\htmlSelect::setSortElements()</full_name>
        <docblock line="1212">
          <description>Specifies if the elemets should be sorted (default: sort).</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;sort elements&lt;/p&gt;" line="1212" type="boolean" variable="$sortElements">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$sortElements</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1221" package="metaHTML">
        <name>setRightToLeftTextDirection</name>
        <full_name>\htmlSelect::setRightToLeftTextDirection()</full_name>
        <docblock line="1221">
          <description>Specifies if the text direction should be set to right to left.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;if true use right to left direction&lt;/p&gt;" line="1221" type="boolean" variable="$rightToLeftTextDirection">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rightToLeftTextDirection</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1230" package="metaHTML">
        <name>setIsEnabled</name>
        <full_name>\htmlSelect::setIsEnabled()</full_name>
        <docblock line="1230">
          <description>Specifies if this component is enabled and accepts user modification.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;enabled if true&lt;/p&gt;" line="1230" type="boolean" variable="$isEnabled">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$isEnabled</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1239" package="metaHTML">
        <name>setWidth</name>
        <full_name>\htmlSelect::setWidth()</full_name>
        <docblock line="1239">
          <description>Specifies the width of this selection box.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;width (e.g. 20em)&lt;/p&gt;&#10;" line="1239" type="String" variable="$width">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$width</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1248" package="metaHTML">
        <name>setTransformSingleSelect</name>
        <full_name>\htmlSelect::setTransformSingleSelect()</full_name>
        <docblock line="1248">
          <description>Specifies if select boxes that contain only a single element should be transformed to a simple text field.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;transform single options to text&lt;/p&gt;" line="1248" type="boolean" variable="$transformSingleSelect">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$transformSingleSelect</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1257" package="metaHTML">
        <name>setOnchangeEvent</name>
        <full_name>\htmlSelect::setOnchangeEvent()</full_name>
        <docblock line="1257">
          <description>Sets the JavaScript code for the onchange event.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;onchange event code (e.g. myfunction();)&lt;/p&gt;&#10;" line="1257" type="String" variable="$onchangeEvent">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$onchangeEvent</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1266" package="metaHTML">
        <name>setTransient</name>
        <full_name>\htmlSelect::setTransient()</full_name>
        <docblock line="1266">
          <description>Specifies that the value should not be automatically saved when used in self service or server profile (default: false).</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;transient field&lt;/p&gt;" line="1266" type="boolean" variable="$transient">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$transient</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1284" package="metaHTML">
        <name>setTableRowsToHide</name>
        <full_name>\htmlSelect::setTableRowsToHide()</full_name>
        <docblock line="1284">
          <description>This will hide the given table rows when the select is changed to the specified value.</description>
          <long-description>The given IDs can be of any e.g. input element. Starting from this element
the first parent "&lt;tr&gt;" element will be used to show/hide.
&lt;br&gt;
&lt;br&gt;
&lt;br&gt;Example: &lt;tr&gt;&lt;td&gt;&lt;input type="checkbox" id="mycheckbox"&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;br&gt; Using "mycheckbox" will use this "tr" to hide/show.
&lt;br&gt;
&lt;br&gt; Example for $tableRowsToHide:
&lt;br&gt; array('yes' =&gt; array('option1', 'option2'), 'no' =&gt; array('option3'))</long-description>
          <tag name="param" description="&lt;p&gt;array of select value =&gt; array of IDs of child elements to hide&lt;/p&gt;&#10;" line="1284" type="array" variable="$tableRowsToHide">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$tableRowsToHide</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1302" package="metaHTML">
        <name>setTableRowsToShow</name>
        <full_name>\htmlSelect::setTableRowsToShow()</full_name>
        <docblock line="1302">
          <description>This will show the given table rows when the select is changed to the specified value.</description>
          <long-description>The given IDs can be of any e.g. input element. Starting from this element
the first parent "&lt;tr&gt;" element will be used to show/hide.
&lt;br&gt;
&lt;br&gt;
&lt;br&gt;Example: &lt;tr&gt;&lt;td&gt;&lt;input type="checkbox" id="mycheckbox"&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;br&gt; Using "mycheckbox" will use this "tr" to hide/show.
&lt;br&gt;
&lt;br&gt; Example for $tableRowsToShow:
&lt;br&gt; array('yes' =&gt; array('option1', 'option2'), 'no' =&gt; array('option3'))</long-description>
          <tag name="param" description="&lt;p&gt;array of select value =&gt; array of IDs of child elements to show&lt;/p&gt;&#10;" line="1302" type="array" variable="$tableRowsToShow">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$tableRowsToShow</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1311" package="metaHTML">
        <name>printCodeForShowHideTableRows</name>
        <full_name>\htmlSelect::printCodeForShowHideTableRows()</full_name>
        <docblock line="1311">
          <description>Creates the JavaScript code to hide/show table rows based on the select value.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;onChange code&lt;/p&gt;" line="1311" type="String" variable="$onChange">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$onChange</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="1363" package="metaHTML">
      <extends>\htmlSelect</extends>
      <name>htmlTableExtendedSelect</name>
      <full_name>\htmlTableExtendedSelect</full_name>
      <docblock line="1363">
        <description>Select with label and help link.</description>
        <long-description>This is used to build HTML code by using objects.</long-description>
        <tag name="package" description="metaHTML" line="1363"/>
      </docblock>
      <property static="false" visibility="private" line="1366" namespace="" package="metaHTML">
        <name>$label</name>
        <default></default>
        <docblock line="1366">
          <description>descriptive label</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1368" namespace="" package="metaHTML">
        <name>$helpID</name>
        <default></default>
        <docblock line="1368">
          <description>help ID</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1380" package="metaHTML">
        <name>__construct</name>
        <full_name>\htmlTableExtendedSelect::__construct()</full_name>
        <docblock line="1380">
          <description>Constructor.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;element name&lt;/p&gt;" line="1380" type="String" variable="$name">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of elememts&lt;/p&gt;" line="1380" type="array" variable="$elements">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of selected elements&lt;/p&gt;" line="1380" type="array" variable="$selectedElements">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;descriptive label&lt;/p&gt;" line="1380" type="String" variable="$label">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;help ID (optional, default none)&lt;/p&gt;&#10;" line="1380" type="String" variable="$helpID">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;size (optional, default = 1)&lt;/p&gt;&#10;" line="1380" type="int" variable="$size">
            <type>int</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$elements</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedElements</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$label</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$helpID</name>
          <default>null</default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$size</name>
          <default>1</default>
          <type>int</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1397" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlTableExtendedSelect::generateHTML()</full_name>
        <docblock line="1397">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="1397" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="1397" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="1397" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="1397" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="1397" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="1397" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="1397" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="1419" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlRadio</name>
      <full_name>\htmlRadio</full_name>
      <docblock line="1419">
        <description>Represents a radio selection.</description>
        <long-description>This is used to build HTML code by using objects.</long-description>
        <tag name="package" description="metaHTML" line="1419"/>
      </docblock>
      <property static="false" visibility="private" line="1422" namespace="" package="metaHTML">
        <name>$name</name>
        <default></default>
        <docblock line="1422">
          <description>name of select field</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1424" namespace="" package="metaHTML">
        <name>$elements</name>
        <default></default>
        <docblock line="1424">
          <description>elements</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1426" namespace="" package="metaHTML">
        <name>$selectedElement</name>
        <default>null</default>
        <docblock line="1426">
          <description>selected element</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1428" namespace="" package="metaHTML">
        <name>$isEnabled</name>
        <default>true</default>
        <docblock line="1428">
          <description>enabled or disabled</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1430" namespace="" package="metaHTML">
        <name>$onchangeEvent</name>
        <default>null</default>
        <docblock line="1430">
          <description>on change code</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1443" package="metaHTML">
        <name>__construct</name>
        <full_name>\htmlRadio::__construct()</full_name>
        <docblock line="1443">
          <description>Constructor.</description>
          <long-description>&lt;br&gt;Examples:
&lt;br&gt;
&lt;br&gt;$radio = new htmlRadio('myName', array('label1' =&gt; 'value1', 'label2' =&gt; 'value2'), array('value1'));</long-description>
          <tag name="param" description="&lt;p&gt;element name&lt;/p&gt;" line="1443" type="String" variable="$name">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of elements array(label =&gt; value)&lt;/p&gt;&#10;" line="1443" type="array" variable="$elements">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;value of selected element (optional, default none)&lt;/p&gt;&#10;" line="1443" type="String" variable="$selectedElement">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$elements</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedElement</name>
          <default>null</default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1462" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlRadio::generateHTML()</full_name>
        <docblock line="1462">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="1462" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="1462" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="1462" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="1462" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="1462" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="1462" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="1462" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1504" package="metaHTML">
        <name>setIsEnabled</name>
        <full_name>\htmlRadio::setIsEnabled()</full_name>
        <docblock line="1504">
          <description>Specifies if this component is enabled and accepts user modification.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;enabled if true&lt;/p&gt;" line="1504" type="boolean" variable="$isEnabled">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$isEnabled</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1513" package="metaHTML">
        <name>setOnchangeEvent</name>
        <full_name>\htmlRadio::setOnchangeEvent()</full_name>
        <docblock line="1513">
          <description>Sets the JavaScript code for the onchange event.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;onchange event code (e.g. myfunction();)&lt;/p&gt;&#10;" line="1513" type="String" variable="$onchangeEvent">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$onchangeEvent</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="1524" package="metaHTML">
      <extends>\htmlRadio</extends>
      <name>htmlTableExtendedRadio</name>
      <full_name>\htmlTableExtendedRadio</full_name>
      <docblock line="1524">
        <description>Radio list with descriptive label and help link.</description>
        <long-description>This is used to build HTML code by using objects.</long-description>
        <tag name="package" description="metaHTML" line="1524"/>
      </docblock>
      <property static="false" visibility="private" line="1527" namespace="" package="metaHTML">
        <name>$label</name>
        <default></default>
        <docblock line="1527">
          <description>descriptive label</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1529" namespace="" package="metaHTML">
        <name>$helpID</name>
        <default></default>
        <docblock line="1529">
          <description>help ID</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1540" package="metaHTML">
        <name>__construct</name>
        <full_name>\htmlTableExtendedRadio::__construct()</full_name>
        <docblock line="1540">
          <description>Constructor.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;descriptive label&lt;/p&gt;" line="1540" type="String" variable="$label">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;element name&lt;/p&gt;" line="1540" type="String" variable="$name">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of elements array(label =&gt; value)&lt;/p&gt;&#10;" line="1540" type="array" variable="$elements">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;value of selected element (optional, default none)&lt;/p&gt;&#10;" line="1540" type="String" variable="$selectedElement">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;help ID&lt;/p&gt;" line="1540" type="String" variable="$helpID">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$label</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$elements</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedElement</name>
          <default>null</default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$helpID</name>
          <default>null</default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1558" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlTableExtendedRadio::generateHTML()</full_name>
        <docblock line="1558">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="1558" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="1558" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="1558" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="1558" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="1558" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="1558" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="1558" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="1582" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlOutputText</name>
      <full_name>\htmlOutputText</full_name>
      <docblock line="1582">
        <description>Prints the text and escapes contained HTML code by default.</description>
        <long-description>This is used to build HTML code by using objects.</long-description>
        <tag name="package" description="metaHTML" line="1582"/>
      </docblock>
      <property static="false" visibility="private" line="1585" namespace="" package="metaHTML">
        <name>$string</name>
        <default></default>
        <docblock line="1585">
          <description>the text to print</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1587" namespace="" package="metaHTML">
        <name>$escapeHTML</name>
        <default></default>
        <docblock line="1587">
          <description>specifies if HTML code should be escaped</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1589" namespace="" package="metaHTML">
        <name>$isBold</name>
        <default>false</default>
        <docblock line="1589">
          <description>bold text</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1591" namespace="" package="metaHTML">
        <name>$markAsRequired</name>
        <default>false</default>
        <docblock line="1591">
          <description>mark as required</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1593" namespace="" package="metaHTML">
        <name>$noWrap</name>
        <default>false</default>
        <docblock line="1593">
          <description>no wrap</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1601" package="metaHTML">
        <name>__construct</name>
        <full_name>\htmlOutputText::__construct()</full_name>
        <docblock line="1601">
          <description>Constructor.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;output text&lt;/p&gt;" line="1601" type="String" variable="$string">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;escape HTML code (default yes)&lt;/p&gt;&#10;" line="1601" type="boolean" variable="$escapeHTML">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$string</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$escapeHTML</name>
          <default>true</default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1617" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlOutputText::generateHTML()</full_name>
        <docblock line="1617">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="1617" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="1617" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="1617" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="1617" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="1617" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="1617" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="1617" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1649" package="metaHTML">
        <name>setIsBold</name>
        <full_name>\htmlOutputText::setIsBold()</full_name>
        <docblock line="1649">
          <description>Specifies if the whole text should be printed in bold.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;bold text&lt;/p&gt;" line="1649" type="boolean" variable="$isBold">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$isBold</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1658" package="metaHTML">
        <name>setMarkAsRequired</name>
        <full_name>\htmlOutputText::setMarkAsRequired()</full_name>
        <docblock line="1658">
          <description>Adds a marker that indicates a required field.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;add marker&lt;/p&gt;" line="1658" type="boolean" variable="$markAsRequired">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$markAsRequired</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1667" package="metaHTML">
        <name>setNoWrap</name>
        <full_name>\htmlOutputText::setNoWrap()</full_name>
        <docblock line="1667">
          <description>Specifies if word wrap is allowed for this text.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;no wrapping if set to true (default false)&lt;/p&gt;&#10;" line="1667" type="boolean" variable="$noWrap">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$noWrap</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="1678" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlInputCheckbox</name>
      <full_name>\htmlInputCheckbox</full_name>
      <docblock line="1678">
        <description>Prints the HTML code for a checkbox.</description>
        <long-description>This is used to build HTML code by using objects.</long-description>
        <tag name="package" description="metaHTML" line="1678"/>
      </docblock>
      <property static="false" visibility="protected" line="1681" namespace="" package="metaHTML">
        <name>$name</name>
        <default></default>
        <docblock line="1681">
          <description>unique name of input element</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="1683" namespace="" package="metaHTML">
        <name>$checked</name>
        <default></default>
        <docblock line="1683">
          <description>value</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="1685" namespace="" package="metaHTML">
        <name>$isEnabled</name>
        <default>true</default>
        <docblock line="1685">
          <description>enabled or disabled</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="1687" namespace="" package="metaHTML">
        <name>$tableRowsToHide</name>
        <default>array()</default>
        <docblock line="1687">
          <description>list of enclosing table rows to hide when checked</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="1689" namespace="" package="metaHTML">
        <name>$tableRowsToShow</name>
        <default>array()</default>
        <docblock line="1689">
          <description>list of enclosing table rows to show when checked</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1691" namespace="" package="metaHTML">
        <name>$transient</name>
        <default>false</default>
        <docblock line="1691">
          <description>indicates that this field should not automatically be saved in the self service or server profile</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1700" package="metaHTML">
        <name>__construct</name>
        <full_name>\htmlInputCheckbox::__construct()</full_name>
        <docblock line="1700">
          <description>Constructor.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;unique name&lt;/p&gt;" line="1700" type="String" variable="$name">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;checked&lt;/p&gt;" line="1700" type="boolean" variable="$checked">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$checked</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1716" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlInputCheckbox::generateHTML()</full_name>
        <docblock line="1716">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="1716" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="1716" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="1716" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="1716" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="1716" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="1716" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="1716" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1789" package="metaHTML">
        <name>setIsEnabled</name>
        <full_name>\htmlInputCheckbox::setIsEnabled()</full_name>
        <docblock line="1789">
          <description>Specifies if this component is enabled and accepts user modification.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;enabled if true&lt;/p&gt;" line="1789" type="boolean" variable="$isEnabled">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$isEnabled</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1804" package="metaHTML">
        <name>setTableRowsToHide</name>
        <full_name>\htmlInputCheckbox::setTableRowsToHide()</full_name>
        <docblock line="1804">
          <description>This will hide the given table rows when the checkbox is checked.</description>
          <long-description>The given IDs can be of any e.g. input element. Starting from this element
the first parent "&lt;tr&gt;" element will be used to show/hide.
&lt;br&gt;
&lt;br&gt;
&lt;br&gt;Example: &lt;tr&gt;&lt;td&gt;&lt;input type="checkbox" id="mycheckbox"&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;br&gt; Using "mycheckbox" will use this "tr" to hide/show.</long-description>
          <tag name="param" description="&lt;p&gt;IDs of child elements to hide&lt;/p&gt;" line="1804" type="array" variable="$tableRowsToHide">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$tableRowsToHide</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1819" package="metaHTML">
        <name>setTableRowsToShow</name>
        <full_name>\htmlInputCheckbox::setTableRowsToShow()</full_name>
        <docblock line="1819">
          <description>This will show the given table rows when the checkbox is checked.</description>
          <long-description>The given IDs can be of any e.g. input element. Starting from this element
the first parent "&lt;tr&gt;" element will be used to show/hide.
&lt;br&gt;
&lt;br&gt;
&lt;br&gt;Example: &lt;tr&gt;&lt;td&gt;&lt;input type="checkbox" id="mycheckbox"&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;br&gt; Using "mycheckbox" will use this "tr" to hide/show.</long-description>
          <tag name="param" description="&lt;p&gt;IDs of child elements to show&lt;/p&gt;" line="1819" type="array" variable="$tableRowsToShow">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$tableRowsToShow</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1828" package="metaHTML">
        <name>setTransient</name>
        <full_name>\htmlInputCheckbox::setTransient()</full_name>
        <docblock line="1828">
          <description>Specifies that the value should not be automatically saved when used in self service or server profile (default: false).</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;transient field&lt;/p&gt;" line="1828" type="boolean" variable="$transient">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$transient</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="1839" package="metaHTML">
      <extends>\htmlInputCheckbox</extends>
      <name>htmlTableExtendedInputCheckbox</name>
      <full_name>\htmlTableExtendedInputCheckbox</full_name>
      <docblock line="1839">
        <description>Checkbox with descriptive label and help link.</description>
        <long-description>This is used to build HTML code by using objects.</long-description>
        <tag name="package" description="metaHTML" line="1839"/>
      </docblock>
      <property static="false" visibility="private" line="1842" namespace="" package="metaHTML">
        <name>$label</name>
        <default></default>
        <docblock line="1842">
          <description>descriptive label</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1844" namespace="" package="metaHTML">
        <name>$helpID</name>
        <default></default>
        <docblock line="1844">
          <description>help ID</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1846" namespace="" package="metaHTML">
        <name>$labelFirst</name>
        <default></default>
        <docblock line="1846">
          <description>specifies if label is printed before the checkbox</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1857" package="metaHTML">
        <name>__construct</name>
        <full_name>\htmlTableExtendedInputCheckbox::__construct()</full_name>
        <docblock line="1857">
          <description>Constructor.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;unique name&lt;/p&gt;" line="1857" type="String" variable="$name">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;checked&lt;/p&gt;" line="1857" type="boolean" variable="$checked">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;descriptive label&lt;/p&gt;" line="1857" type="String" variable="$label">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;help ID&lt;/p&gt;" line="1857" type="String" variable="$helpID">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;specifies if the label is at the beginning or at the end (optional, default beginning)&lt;/p&gt;&#10;" line="1857" type="boolean" variable="$labelFirst">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$checked</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$label</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$helpID</name>
          <default>null</default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$labelFirst</name>
          <default>true</default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1875" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlTableExtendedInputCheckbox::generateHTML()</full_name>
        <docblock line="1875">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="1875" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="1875" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="1875" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="1875" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="1875" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="1875" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="1875" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="1907" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlInputFileUpload</name>
      <full_name>\htmlInputFileUpload</full_name>
      <docblock line="1907">
        <description>Prints the HTML code for a file upload field.</description>
        <long-description>This is used to build HTML code by using objects.</long-description>
        <tag name="package" description="metaHTML" line="1907"/>
      </docblock>
      <property static="false" visibility="private" line="1910" namespace="" package="metaHTML">
        <name>$name</name>
        <default></default>
        <docblock line="1910">
          <description>unique name of input element</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1912" namespace="" package="metaHTML">
        <name>$isEnabled</name>
        <default>true</default>
        <docblock line="1912">
          <description>enabled or disabled</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1919" package="metaHTML">
        <name>__construct</name>
        <full_name>\htmlInputFileUpload::__construct()</full_name>
        <docblock line="1919">
          <description>Constructor.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;unique name&lt;/p&gt;" line="1919" type="String" variable="$name">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1934" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlInputFileUpload::generateHTML()</full_name>
        <docblock line="1934">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="1934" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="1934" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="1934" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="1934" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="1934" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="1934" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="1934" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1950" package="metaHTML">
        <name>setIsEnabled</name>
        <full_name>\htmlInputFileUpload::setIsEnabled()</full_name>
        <docblock line="1950">
          <description>Specifies if this component is enabled and accepts user modification.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;enabled if true&lt;/p&gt;" line="1950" type="boolean" variable="$isEnabled">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$isEnabled</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="1961" package="metaHTML">
      <extends>\htmlInputFileUpload</extends>
      <name>htmlTableExtendedInputFileUpload</name>
      <full_name>\htmlTableExtendedInputFileUpload</full_name>
      <docblock line="1961">
        <description>File upload with descriptive label and help link.</description>
        <long-description>This is used to build HTML code by using objects.</long-description>
        <tag name="package" description="metaHTML" line="1961"/>
      </docblock>
      <property static="false" visibility="private" line="1964" namespace="" package="metaHTML">
        <name>$label</name>
        <default></default>
        <docblock line="1964">
          <description>descriptive label</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1966" namespace="" package="metaHTML">
        <name>$helpID</name>
        <default></default>
        <docblock line="1966">
          <description>help ID</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1975" package="metaHTML">
        <name>__construct</name>
        <full_name>\htmlTableExtendedInputFileUpload::__construct()</full_name>
        <docblock line="1975">
          <description>Constructor.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;unique name&lt;/p&gt;" line="1975" type="String" variable="$name">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;descriptive label&lt;/p&gt;" line="1975" type="String" variable="$label">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;help ID&lt;/p&gt;" line="1975" type="String" variable="$helpID">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$label</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$helpID</name>
          <default>null</default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1992" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlTableExtendedInputFileUpload::generateHTML()</full_name>
        <docblock line="1992">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="1992" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="1992" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="1992" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="1992" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="1992" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="1992" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="1992" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="2014" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlInputTextarea</name>
      <full_name>\htmlInputTextarea</full_name>
      <docblock line="2014">
        <description>Prints the HTML code for a textarea.</description>
        <long-description>This is used to build HTML code by using objects.</long-description>
        <tag name="package" description="metaHTML" line="2014"/>
      </docblock>
      <property static="false" visibility="private" line="2017" namespace="" package="metaHTML">
        <name>$name</name>
        <default></default>
        <docblock line="2017">
          <description>unique name of input element</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="2019" namespace="" package="metaHTML">
        <name>$value</name>
        <default></default>
        <docblock line="2019">
          <description>value</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="2021" namespace="" package="metaHTML">
        <name>$colCount</name>
        <default></default>
        <docblock line="2021">
          <description>column count</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="2023" namespace="" package="metaHTML">
        <name>$rowCount</name>
        <default></default>
        <docblock line="2023">
          <description>row count</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="2025" namespace="" package="metaHTML">
        <name>$isEnabled</name>
        <default>true</default>
        <docblock line="2025">
          <description>enabled or disabled</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="2027" namespace="" package="metaHTML">
        <name>$richEdit</name>
        <default>false</default>
        <docblock line="2027">
          <description>specifies if LAM should display this field whith a WYSIWYG editor</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2037" package="metaHTML">
        <name>__construct</name>
        <full_name>\htmlInputTextarea::__construct()</full_name>
        <docblock line="2037">
          <description>Constructor.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;unique name&lt;/p&gt;" line="2037" type="String" variable="$name">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;value&lt;/p&gt;" line="2037" type="String" variable="$value">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;number of characters per line&lt;/p&gt;" line="2037" type="int" variable="$colCount">
            <type>int</type>
          </tag>
          <tag name="param" description="&lt;p&gt;number of rows&lt;/p&gt;" line="2037" type="int" variable="$rowCount">
            <type>int</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$value</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$colCount</name>
          <default></default>
          <type>int</type>
        </argument>
        <argument line="0">
          <name>$rowCount</name>
          <default></default>
          <type>int</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2055" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlInputTextarea::generateHTML()</full_name>
        <docblock line="2055">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="2055" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="2055" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="2055" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="2055" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="2055" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="2055" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="2055" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2083" package="metaHTML">
        <name>setIsEnabled</name>
        <full_name>\htmlInputTextarea::setIsEnabled()</full_name>
        <docblock line="2083">
          <description>Specifies if this component is enabled and accepts user modification.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;enabled if true&lt;/p&gt;" line="2083" type="boolean" variable="$isEnabled">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$isEnabled</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2094" package="metaHTML">
        <name>setIsRichEdit</name>
        <full_name>\htmlInputTextarea::setIsRichEdit()</full_name>
        <docblock line="2094">
          <description>Specifies if the textarea should be displayed whith a WYSIWYG editor.</description>
          <long-description>&lt;br&gt;This requires that the page which displays the textarea also includes the ckeditor JS.
&lt;br&gt;Rich editing is disabled by default.</long-description>
          <tag name="param" description="&lt;p&gt;rich edit or standard&lt;/p&gt;" line="2094" type="boolean" variable="$richEdit">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$richEdit</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="2105" package="metaHTML">
      <extends>\htmlInputTextarea</extends>
      <name>htmlTableExtendedInputTextarea</name>
      <full_name>\htmlTableExtendedInputTextarea</full_name>
      <docblock line="2105">
        <description>Text area with label and help link.</description>
        <long-description>This is used to build HTML code by using objects.</long-description>
        <tag name="package" description="metaHTML" line="2105"/>
      </docblock>
      <property static="false" visibility="private" line="2108" namespace="" package="metaHTML">
        <name>$label</name>
        <default></default>
        <docblock line="2108">
          <description>descriptive label</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="2110" namespace="" package="metaHTML">
        <name>$helpID</name>
        <default></default>
        <docblock line="2110">
          <description>help ID</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="2112" namespace="" package="metaHTML">
        <name>$required</name>
        <default>false</default>
        <docblock line="2112">
          <description>required field</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2124" package="metaHTML">
        <name>__construct</name>
        <full_name>\htmlTableExtendedInputTextarea::__construct()</full_name>
        <docblock line="2124">
          <description>Constructor.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;unique name&lt;/p&gt;" line="2124" type="String" variable="$name">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;value&lt;/p&gt;" line="2124" type="String" variable="$value">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;number of characters per line&lt;/p&gt;" line="2124" type="int" variable="$colCount">
            <type>int</type>
          </tag>
          <tag name="param" description="&lt;p&gt;number of rows&lt;/p&gt;" line="2124" type="int" variable="$rowCount">
            <type>int</type>
          </tag>
          <tag name="param" description="&lt;p&gt;descriptive label&lt;/p&gt;" line="2124" type="String" variable="$label">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;help ID&lt;/p&gt;" line="2124" type="String" variable="$helpID">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$value</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$colCount</name>
          <default></default>
          <type>int</type>
        </argument>
        <argument line="0">
          <name>$rowCount</name>
          <default></default>
          <type>int</type>
        </argument>
        <argument line="0">
          <name>$label</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$helpID</name>
          <default>null</default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2142" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlTableExtendedInputTextarea::generateHTML()</full_name>
        <docblock line="2142">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="2142" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="2142" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="2142" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="2142" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="2142" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="2142" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="2142" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2167" package="metaHTML">
        <name>setRequired</name>
        <full_name>\htmlTableExtendedInputTextarea::setRequired()</full_name>
        <docblock line="2167">
          <description>Specifies if this input field must be filled.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;required or not&lt;/p&gt;" line="2167" type="boolean" variable="$required">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$required</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="2178" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlImage</name>
      <full_name>\htmlImage</full_name>
      <docblock line="2178">
        <description>Prints the HTML code for an image.</description>
        <long-description>This is used to build HTML code by using objects.</long-description>
        <tag name="package" description="metaHTML" line="2178"/>
      </docblock>
      <property static="false" visibility="private" line="2181" namespace="" package="metaHTML">
        <name>$path</name>
        <default></default>
        <docblock line="2181">
          <description>path to image</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="2183" namespace="" package="metaHTML">
        <name>$width</name>
        <default></default>
        <docblock line="2183">
          <description>width</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="2185" namespace="" package="metaHTML">
        <name>$height</name>
        <default></default>
        <docblock line="2185">
          <description>height</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="2187" namespace="" package="metaHTML">
        <name>$alt</name>
        <default></default>
        <docblock line="2187">
          <description>alt text</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2197" package="metaHTML">
        <name>__construct</name>
        <full_name>\htmlImage::__construct()</full_name>
        <docblock line="2197">
          <description>Constructor.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;image location&lt;/p&gt;" line="2197" type="String" variable="$path">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;image width (optional, default original size)&lt;/p&gt;&#10;" line="2197" type="int" variable="$width">
            <type>int</type>
          </tag>
          <tag name="param" description="&lt;p&gt;image height (optional, default original size)&lt;/p&gt;&#10;" line="2197" type="int" variable="$height">
            <type>int</type>
          </tag>
          <tag name="param" description="&lt;p&gt;alt text (optional)&lt;/p&gt;&#10;" line="2197" type="String" variable="$alt">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$path</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$width</name>
          <default>null</default>
          <type>int</type>
        </argument>
        <argument line="0">
          <name>$height</name>
          <default>null</default>
          <type>int</type>
        </argument>
        <argument line="0">
          <name>$alt</name>
          <default>' '</default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2215" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlImage::generateHTML()</full_name>
        <docblock line="2215">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="2215" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="2215" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="2215" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="2215" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="2215" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="2215" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="2215" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="2237" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlSpacer</name>
      <full_name>\htmlSpacer</full_name>
      <docblock line="2237">
        <description>Adds an empty space with given width and height.</description>
        <long-description>This is used to build HTML code by using objects.</long-description>
        <tag name="package" description="metaHTML" line="2237"/>
      </docblock>
      <property static="false" visibility="private" line="2240" namespace="" package="metaHTML">
        <name>$width</name>
        <default></default>
        <docblock line="2240">
          <description>width of spacer in px</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="2242" namespace="" package="metaHTML">
        <name>$height</name>
        <default></default>
        <docblock line="2242">
          <description>height of spacer in px</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2250" package="metaHTML">
        <name>__construct</name>
        <full_name>\htmlSpacer::__construct()</full_name>
        <docblock line="2250">
          <description>Constructor.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;width (e.g. 10px)&lt;/p&gt;&#10;" line="2250" type="String" variable="$width">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;height (e.g. 10px)&lt;/p&gt;&#10;" line="2250" type="String" variable="$height">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$width</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$height</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2266" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlSpacer::generateHTML()</full_name>
        <docblock line="2266">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="2266" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="2266" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="2266" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="2266" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="2266" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="2266" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="2266" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="2286" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlStatusMessage</name>
      <full_name>\htmlStatusMessage</full_name>
      <docblock line="2286">
        <description>Prints a status message (e.g. error message).</description>
        <long-description>This is used to build HTML code by using objects.</long-description>
        <tag name="package" description="metaHTML" line="2286"/>
      </docblock>
      <property static="false" visibility="private" line="2289" namespace="" package="metaHTML">
        <name>$type</name>
        <default></default>
        <docblock line="2289">
          <description>message type (e.g. ERROR)</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="2291" namespace="" package="metaHTML">
        <name>$title</name>
        <default></default>
        <docblock line="2291">
          <description>message title</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="2293" namespace="" package="metaHTML">
        <name>$text</name>
        <default></default>
        <docblock line="2293">
          <description>message text</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="2295" namespace="" package="metaHTML">
        <name>$params</name>
        <default></default>
        <docblock line="2295">
          <description>message parameters</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2305" package="metaHTML">
        <name>__construct</name>
        <full_name>\htmlStatusMessage::__construct()</full_name>
        <docblock line="2305">
          <description>Constructor.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;message type (e.g. ERROR)&lt;/p&gt;&#10;" line="2305" type="String" variable="$type">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;message title&lt;/p&gt;" line="2305" type="String" variable="$title">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;message (optional)&lt;/p&gt;&#10;" line="2305" type="String" variable="$text">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;additional message parameters&lt;/p&gt;" line="2305" type="array" variable="$params">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$type</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$title</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$text</name>
          <default>null</default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$params</name>
          <default>null</default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2323" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlStatusMessage::generateHTML()</full_name>
        <docblock line="2323">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="2323" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="2323" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="2323" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="2323" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="2323" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="2323" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="2323" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="2335" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlFieldset</name>
      <full_name>\htmlFieldset</full_name>
      <docblock line="2335">
        <description>Generates a fieldset.</description>
        <long-description>This is used to build HTML code by using objects.</long-description>
        <tag name="package" description="metaHTML" line="2335"/>
      </docblock>
      <property static="false" visibility="private" line="2338" namespace="" package="metaHTML">
        <name>$content</name>
        <default></default>
        <docblock line="2338">
          <description>fieldset content</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="2340" namespace="" package="metaHTML">
        <name>$label</name>
        <default>null</default>
        <docblock line="2340">
          <description>descriptive label</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="2342" namespace="" package="metaHTML">
        <name>$labelImage</name>
        <default>null</default>
        <docblock line="2342">
          <description>label image</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2351" package="metaHTML">
        <name>__construct</name>
        <full_name>\htmlFieldset::__construct()</full_name>
        <docblock line="2351">
          <description>Constructor.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;content to display inside fieldset&lt;/p&gt;" line="2351" type="\htmlElement" variable="$content">
            <type>\htmlElement</type>
          </tag>
          <tag name="param" description="&lt;p&gt;label&lt;/p&gt;" line="2351" type="String" variable="$label">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;image to put before label&lt;/p&gt;" line="2351" type="String" variable="$labelImage">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$content</name>
          <default></default>
          <type>\htmlElement</type>
        </argument>
        <argument line="0">
          <name>$label</name>
          <default>null</default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$labelImage</name>
          <default>null</default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2368" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlFieldset::generateHTML()</full_name>
        <docblock line="2368">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="2368" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="2368" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="2368" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="2368" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="2368" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="2368" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="2368" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="2397" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlTitle</name>
      <full_name>\htmlTitle</full_name>
      <docblock line="2397">
        <description>Generates a title line. This is used for page titles.</description>
        <long-description>This is used to build HTML code by using objects.</long-description>
        <tag name="package" description="metaHTML" line="2397"/>
      </docblock>
      <property static="false" visibility="private" line="2400" namespace="" package="metaHTML">
        <name>$label</name>
        <default>null</default>
        <docblock line="2400">
          <description>descriptive label</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2407" package="metaHTML">
        <name>__construct</name>
        <full_name>\htmlTitle::__construct()</full_name>
        <docblock line="2407">
          <description>Constructor.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;label&lt;/p&gt;" line="2407" type="String" variable="$label">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$label</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2424" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlTitle::generateHTML()</full_name>
        <docblock line="2424">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="2424" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="2424" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="2424" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="2424" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="2424" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="2424" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="2424" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="2440" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlSubTitle</name>
      <full_name>\htmlSubTitle</full_name>
      <docblock line="2440">
        <description>Generates a subtitle line. This is used to group multiple fields.</description>
        <long-description>This is used to build HTML code by using objects.</long-description>
        <tag name="package" description="metaHTML" line="2440"/>
      </docblock>
      <property static="false" visibility="private" line="2443" namespace="" package="metaHTML">
        <name>$label</name>
        <default>null</default>
        <docblock line="2443">
          <description>descriptive label</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="2445" namespace="" package="metaHTML">
        <name>$image</name>
        <default>null</default>
        <docblock line="2445">
          <description>optional image</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="2447" namespace="" package="metaHTML">
        <name>$id</name>
        <default>null</default>
        <docblock line="2447">
          <description>optional ID for this element (e.g. to use for JavaScript)</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2456" package="metaHTML">
        <name>__construct</name>
        <full_name>\htmlSubTitle::__construct()</full_name>
        <docblock line="2456">
          <description>Constructor.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;label&lt;/p&gt;" line="2456" type="String" variable="$label">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;optional image&lt;/p&gt;" line="2456" type="String" variable="$image">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;optional ID for this element (e.g. to use for JavaScript)&lt;/p&gt;&#10;" line="2456" type="String" variable="$id">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$label</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$image</name>
          <default>null</default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$id</name>
          <default>null</default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2475" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlSubTitle::generateHTML()</full_name>
        <docblock line="2475">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="2475" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="2475" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="2475" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="2475" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="2475" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="2475" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="2475" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="2498" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlHiddenInput</name>
      <full_name>\htmlHiddenInput</full_name>
      <docblock line="2498">
        <description>Generates a hidden input field.</description>
        <long-description>This is used to build HTML code by using objects.</long-description>
        <tag name="package" description="metaHTML" line="2498"/>
      </docblock>
      <property static="false" visibility="private" line="2501" namespace="" package="metaHTML">
        <name>$name</name>
        <default>null</default>
        <docblock line="2501">
          <description>field name</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="2503" namespace="" package="metaHTML">
        <name>$value</name>
        <default>null</default>
        <docblock line="2503">
          <description>field value</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2511" package="metaHTML">
        <name>__construct</name>
        <full_name>\htmlHiddenInput::__construct()</full_name>
        <docblock line="2511">
          <description>Constructor.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;input name&lt;/p&gt;" line="2511" type="String" variable="$name">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;input value&lt;/p&gt;" line="2511" type="String" variable="$value">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$value</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2527" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlHiddenInput::generateHTML()</full_name>
        <docblock line="2527">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="2527" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="2527" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="2527" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="2527" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="2527" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="2527" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="2527" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="2540" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlLink</name>
      <full_name>\htmlLink</full_name>
      <docblock line="2540">
        <description>Generates a link.</description>
        <long-description>The link can include an optional image in front of the link text.</long-description>
        <tag name="package" description="metaHTML" line="2540"/>
      </docblock>
      <property static="false" visibility="private" line="2543" namespace="" package="metaHTML">
        <name>$text</name>
        <default>null</default>
        <docblock line="2543">
          <description>link text</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="2545" namespace="" package="metaHTML">
        <name>$target</name>
        <default>null</default>
        <docblock line="2545">
          <description>link target</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="2547" namespace="" package="metaHTML">
        <name>$image</name>
        <default>null</default>
        <docblock line="2547">
          <description>optional image</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="2549" namespace="" package="metaHTML">
        <name>$title</name>
        <default>null</default>
        <docblock line="2549">
          <description>title</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="2551" namespace="" package="metaHTML">
        <name>$targetWindow</name>
        <default>null</default>
        <docblock line="2551">
          <description>target window</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="2553" namespace="" package="metaHTML">
        <name>$onClick</name>
        <default>null</default>
        <docblock line="2553">
          <description>onClick event</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="2555" namespace="" package="metaHTML">
        <name>$showAsButton</name>
        <default>false</default>
        <docblock line="2555">
          <description>show as button</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2565" package="metaHTML">
        <name>__construct</name>
        <full_name>\htmlLink::__construct()</full_name>
        <docblock line="2565">
          <description>Constructor.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;label&lt;/p&gt;" line="2565" type="String" variable="$text">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;target URL&lt;/p&gt;" line="2565" type="String" variable="$target">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;URL of optional image&lt;/p&gt;" line="2565" type="String" variable="$image">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;shows this like as a button&lt;/p&gt;" line="2565" type="boolean" variable="$showAsButton">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$text</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$target</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$image</name>
          <default>null</default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$showAsButton</name>
          <default>false</default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2583" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlLink::generateHTML()</full_name>
        <docblock line="2583">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="2583" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="2583" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="2583" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="2583" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="2583" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="2583" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="2583" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2625" package="metaHTML">
        <name>setTitle</name>
        <full_name>\htmlLink::setTitle()</full_name>
        <docblock line="2625">
          <description>Sets the link title.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;title&lt;/p&gt;" line="2625" type="String" variable="$title">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$title</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2634" package="metaHTML">
        <name>setTargetWindow</name>
        <full_name>\htmlLink::setTargetWindow()</full_name>
        <docblock line="2634">
          <description>Sets the target window (e.g. _blank).</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;target window (e.g. _blank)&lt;/p&gt;&#10;" line="2634" type="String" variable="$window">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$window</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2643" package="metaHTML">
        <name>setOnClick</name>
        <full_name>\htmlLink::setOnClick()</full_name>
        <docblock line="2643">
          <description>Sets the onClick event.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;JavaScript code&lt;/p&gt;" line="2643" type="String" variable="$event">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$event</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="2656" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlGroup</name>
      <full_name>\htmlGroup</full_name>
      <docblock line="2656">
        <description>Groups multiple htmlElements.</description>
        <long-description>This is useful if multiple elements should be included in a single table cell.
The HTML code of the subelements is printed in the order they were added. No additional code is added.</long-description>
        <tag name="package" description="metaHTML" line="2656"/>
      </docblock>
      <property static="false" visibility="private" line="2659" namespace="" package="metaHTML">
        <name>$subelements</name>
        <default>array()</default>
        <docblock line="2659">
          <description>link text</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2672" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlGroup::generateHTML()</full_name>
        <docblock line="2672">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="2672" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="2672" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="2672" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="2672" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="2672" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="2672" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="2672" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2685" package="metaHTML">
        <name>addElement</name>
        <full_name>\htmlGroup::addElement()</full_name>
        <docblock line="2685">
          <description>Adds a subelement.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;subelement&lt;/p&gt;" line="2685" type="\htmlElement" variable="$sub">
            <type>\htmlElement</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$sub</name>
          <default></default>
          <type>\htmlElement</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="2696" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlHorizontalLine</name>
      <full_name>\htmlHorizontalLine</full_name>
      <docblock line="2696">
        <description>Prints a horizontal line.</description>
        <long-description>This is used to build HTML code by using objects.</long-description>
        <tag name="package" description="metaHTML" line="2696"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2709" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlHorizontalLine::generateHTML()</full_name>
        <docblock line="2709">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="2709" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="2709" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="2709" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="2709" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="2709" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="2709" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="2709" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="2722" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlDiv</name>
      <full_name>\htmlDiv</full_name>
      <docblock line="2722">
        <description>Creates a simple DIV element.</description>
        <long-description>This is used to build HTML code by using objects.</long-description>
        <tag name="package" description="metaHTML" line="2722"/>
      </docblock>
      <property static="false" visibility="private" line="2725" namespace="" package="metaHTML">
        <name>$id</name>
        <default>null</default>
        <docblock line="2725">
          <description>unique ID</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="2727" namespace="" package="metaHTML">
        <name>$content</name>
        <default>null</default>
        <docblock line="2727">
          <description>htmlElement that generates inner content</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2736" package="metaHTML">
        <name>__construct</name>
        <full_name>\htmlDiv::__construct()</full_name>
        <docblock line="2736">
          <description>Constructor.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;unique ID&lt;/p&gt;" line="2736" type="String" variable="$id">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;inner content&lt;/p&gt;" line="2736" type="\htmlElement" variable="$content">
            <type>\htmlElement</type>
          </tag>
          <tag name="param" description="&lt;p&gt;CSS classes&lt;/p&gt;" line="2736" type="array" variable="$classes">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$id</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$content</name>
          <default></default>
          <type>\htmlElement</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2752" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlDiv::generateHTML()</full_name>
        <docblock line="2752">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="2752" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="2752" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="2752" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="2752" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="2752" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="2752" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="2752" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="2776" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlJavaScript</name>
      <full_name>\htmlJavaScript</full_name>
      <docblock line="2776">
        <description>Creates a JavaScript element.</description>
        <long-description>This is used to build HTML code by using objects.</long-description>
        <tag name="package" description="metaHTML" line="2776"/>
      </docblock>
      <property static="false" visibility="private" line="2779" namespace="" package="metaHTML">
        <name>$content</name>
        <default>null</default>
        <docblock line="2779">
          <description>htmlElement that generates inner content</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2786" package="metaHTML">
        <name>__construct</name>
        <full_name>\htmlJavaScript::__construct()</full_name>
        <docblock line="2786">
          <description>Constructor.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;script&lt;/p&gt;" line="2786" type="String" variable="$content">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$content</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2801" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlJavaScript::generateHTML()</full_name>
        <docblock line="2801">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="2801" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="2801" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="2801" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="2801" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="2801" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="2801" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="2801" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="2816" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlEqualWidth</name>
      <full_name>\htmlEqualWidth</full_name>
      <docblock line="2816">
        <description>Sets all given elements to the same width.</description>
        <long-description>This is used to build HTML code by using objects.</long-description>
        <tag name="package" description="metaHTML" line="2816"/>
      </docblock>
      <property static="false" visibility="private" line="2819" namespace="" package="metaHTML">
        <name>$elements</name>
        <default>array()</default>
        <docblock line="2819">
          <description>list of element IDs</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2826" package="metaHTML">
        <name>__construct</name>
        <full_name>\htmlEqualWidth::__construct()</full_name>
        <docblock line="2826">
          <description>Constructor.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of element IDs&lt;/p&gt;" line="2826" type="array" variable="$elements">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$elements</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2843" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlEqualWidth::generateHTML()</full_name>
        <docblock line="2843">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="2843" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="2843" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="2843" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="2843" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="2843" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="2843" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="2843" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="2868" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlEqualHeight</name>
      <full_name>\htmlEqualHeight</full_name>
      <docblock line="2868">
        <description>Sets all given elements to the same height.</description>
        <long-description>This is used to build HTML code by using objects.</long-description>
        <tag name="package" description="metaHTML" line="2868"/>
      </docblock>
      <property static="false" visibility="private" line="2871" namespace="" package="metaHTML">
        <name>$elements</name>
        <default>array()</default>
        <docblock line="2871">
          <description>list of element IDs</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2878" package="metaHTML">
        <name>__construct</name>
        <full_name>\htmlEqualHeight::__construct()</full_name>
        <docblock line="2878">
          <description>Constructor.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of element IDs&lt;/p&gt;" line="2878" type="array" variable="$elements">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$elements</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2895" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlEqualHeight::generateHTML()</full_name>
        <docblock line="2895">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="2895" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="2895" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="2895" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="2895" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="2895" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="2895" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="2895" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="2920" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlSortableList</name>
      <full_name>\htmlSortableList</full_name>
      <docblock line="2920">
        <description>Creates a list of elements that can be sorted by the user via drag'n'drop.</description>
        <long-description>This is used to build HTML code by using objects.</long-description>
        <tag name="package" description="metaHTML" line="2920"/>
      </docblock>
      <property static="false" visibility="private" line="2923" namespace="" package="metaHTML">
        <name>$elements</name>
        <default>array()</default>
        <docblock line="2923">
          <description>list of elements</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="2925" namespace="" package="metaHTML">
        <name>$id</name>
        <default>''</default>
        <docblock line="2925">
          <description>HTML ID</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="2927" namespace="" package="metaHTML">
        <name>$elementWidth</name>
        <default>''</default>
        <docblock line="2927">
          <description>element width</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="2929" namespace="" package="metaHTML">
        <name>$onUpdate</name>
        <default>null</default>
        <docblock line="2929">
          <description>on update event</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2938" package="metaHTML">
        <name>__construct</name>
        <full_name>\htmlSortableList::__construct()</full_name>
        <docblock line="2938">
          <description>Constructor.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of element IDs (HTML special chars must be escaped already)&lt;/p&gt;&#10;" line="2938" type="array" variable="$elements">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;HTML ID&lt;/p&gt;" line="2938" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;width of elements (default 250px)&lt;/p&gt;&#10;" line="2938" type="String" variable="$elementWidth">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$elements</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$id</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$elementWidth</name>
          <default>'250px'</default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2955" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlSortableList::generateHTML()</full_name>
        <docblock line="2955">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="2955" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="2955" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="2955" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="2955" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="2955" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="2955" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="2955" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2994" package="metaHTML">
        <name>setOnUpdate</name>
        <full_name>\htmlSortableList::setOnUpdate()</full_name>
        <docblock line="2994">
          <description>Sets the JS code that is executed when the element order was changed.</description>
          <long-description>The code can access the variables event and ui. See JQueryUI docs for details.
ui.item.data('posOrig') will contain the original position of the moved element.</long-description>
          <tag name="param" description="&lt;p&gt;JS code&lt;/p&gt;" line="2994" type="String" variable="$onUpdate">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$onUpdate</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="3004" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlAccordion</name>
      <full_name>\htmlAccordion</full_name>
      <docblock line="3004">
        <description>Creates a list of content elements in accordion style.</description>
        <long-description>HTML special characters must be escaped before providing to htmlAccordion.</long-description>
      </docblock>
      <property static="false" visibility="private" line="3006" namespace="" package="metaHTML">
        <name>$id</name>
        <default>null</default>
        <docblock line="3006">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="3007" namespace="" package="metaHTML">
        <name>$elements</name>
        <default>null</default>
        <docblock line="3007">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="3008" namespace="" package="metaHTML">
        <name>$openInitial</name>
        <default>'1'</default>
        <docblock line="3008">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="3009" namespace="" package="metaHTML">
        <name>$collapsible</name>
        <default>false</default>
        <docblock line="3009">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="3019" package="metaHTML">
        <name>__construct</name>
        <full_name>\htmlAccordion::__construct()</full_name>
        <docblock line="3019">
          <description>Constructor.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;HTML ID&lt;/p&gt;" line="3019" type="String" variable="$id">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of content elements array('title' =&gt; htmlElement)&lt;/p&gt;&#10;" line="3019" type="array" variable="$elements">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;index of element that is initially opened (default: 0), set to 'false' to close all&lt;/p&gt;&#10;" line="3019" type="String" variable="$openInitial">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;specifies if all elements may be closed at the same time (default: false, true if $openInitial is false)&lt;/p&gt;&#10;" line="3019" type="boolean" variable="$collapsible">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$id</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$elements</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$openInitial</name>
          <default>'0'</default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$collapsible</name>
          <default>false</default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="3042" package="metaHTML">
        <name>generateHTML</name>
        <full_name>\htmlAccordion::generateHTML()</full_name>
        <docblock line="3042">
          <description>Prints the HTML code for this element.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="3042" type="string" variable="$module">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of meta-HTML elements&lt;/p&gt;&#10;" line="3042" type="array" variable="$input">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="3042" type="array" variable="$values">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="3042" type="boolean" variable="$restricted">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="3042" type="integer" variable="$tabindex">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="3042" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="3042" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$module</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$restricted</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/upgrade.inc" generated-path="lib.upgrade.inc.html" hash="f34d33a378bf09e5cfbb1678d0153f68" package="main">
    <docblock line="0">
      <description>This file includes functions to upgrade the pdf/profiles configuration files.</description>
      <long-description></long-description>
      <tag name="package" description="main" line="0"/>
      <tag name="author" description="Christian Kropp" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <function namespace="" line="40" package="main">
      <name>testPermissions</name>
      <full_name>\testPermissions()</full_name>
      <docblock line="40">
        <description>check the write/read permission for the upgrade</description>
        <long-description></long-description>
        <tag name="return" description="- permission messages" line="40" type="array">
          <type>array</type>
        </tag>
      </docblock>
    </function>
    <function namespace="" line="56" package="main">
      <name>testPermissionRecursive</name>
      <full_name>\testPermissionRecursive()</full_name>
      <docblock line="56">
        <description>Recursively checks the permissions in a directory.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;directory&lt;/p&gt;" line="56" type="String" variable="$dir">
          <type>String</type>
        </tag>
        <tag name="return" description="list of files/directories with wrong permission" line="56" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$dir</name>
        <default></default>
        <type>String</type>
      </argument>
    </function>
    <function namespace="" line="86" package="main">
      <name>containsFiles</name>
      <full_name>\containsFiles()</full_name>
      <docblock line="86">
        <description>Checks if the given directory contains files.</description>
        <long-description>This is used to check if config files need to be migrated.</long-description>
        <tag name="param" description="&lt;p&gt;directory path&lt;/p&gt;" line="86" type="String" variable="$dir">
          <type>String</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$dir</name>
        <default></default>
        <type>String</type>
      </argument>
    </function>
    <function namespace="" line="109" package="main">
      <name>upgradeConfigToServerProfileFolders</name>
      <full_name>\upgradeConfigToServerProfileFolders()</full_name>
      <docblock line="109">
        <description>Saves an hash array (attribute =&gt; value) to an account profile</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;server profiles&lt;/p&gt;" line="109" type="array" variable="$profiles">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$profiles</name>
        <default></default>
        <type>array</type>
      </argument>
    </function>
    <function namespace="" line="146" package="main">
      <name>copyConfigTemplates</name>
      <full_name>\copyConfigTemplates()</full_name>
      <docblock line="146">
        <description>Saves an hash array (attribute =&gt; value) to an account profile</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;server profiles&lt;/p&gt;" line="146" type="array" variable="$profiles">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$profiles</name>
        <default></default>
        <type>array</type>
      </argument>
    </function>
    <function namespace="" line="163" package="main">
      <name>recursiveCopy</name>
      <full_name>\recursiveCopy()</full_name>
      <docblock line="163">
        <description>Copy a file or recursively copy a directory</description>
        <long-description></long-description>
        <tag name="param" description="&lt;ul&gt;&#10;&lt;li&gt;source path to file or directory&lt;/li&gt;&#10;&lt;/ul&gt;&#10;" line="163" type="string" variable="$src">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;ul&gt;&#10;&lt;li&gt;destination path to file or directory&lt;/li&gt;&#10;&lt;/ul&gt;&#10;" line="163" type="string" variable="$dst">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;ul&gt;&#10;&lt;li&gt;server profiles (used to avoid copying of newly created folders)&lt;/li&gt;&#10;&lt;/ul&gt;&#10;" line="163" type="array" variable="$profiles">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;copy only files that start with the given filter&lt;/p&gt;" line="163" type="string" variable="$fileFilter">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;overwrite existing files&lt;/p&gt;" line="163" type="boolean" variable="$overwrite">
          <type>boolean</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$src</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$dst</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$profiles</name>
        <default></default>
        <type>array</type>
      </argument>
      <argument line="0">
        <name>$fileFilter</name>
        <default>null</default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$overwrite</name>
        <default>true</default>
        <type>boolean</type>
      </argument>
    </function>
    <function namespace="" line="200" package="main">
      <name>recursiveDelete</name>
      <full_name>\recursiveDelete()</full_name>
      <docblock line="200">
        <description>Delete a file or recursively delete a directory</description>
        <long-description></long-description>
        <tag name="param" description="&lt;ul&gt;&#10;&lt;li&gt;path to file or directory&lt;/li&gt;&#10;&lt;/ul&gt;&#10;" line="200" type="string" variable="$src">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;ul&gt;&#10;&lt;li&gt;server profiles (used to avoid copying of newly created folders)&lt;/li&gt;&#10;&lt;/ul&gt;&#10;" line="200" type="array" variable="$profiles">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$src</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$profiles</name>
        <default></default>
        <type>array</type>
      </argument>
    </function>
    <source> </source>
  </file>
  <file path="lib/tools.inc" generated-path="lib.tools.inc.html" hash="8f9587b6ddbc355a5e8f24fb5d801440" package="tools">
    <docblock line="0">
      <description>This file includes functions to manage LAM tools.</description>
      <long-description></long-description>
      <tag name="package" description="tools" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <function namespace="" line="37" package="tools">
      <name>getTools</name>
      <full_name>\getTools()</full_name>
      <docblock line="37">
        <description>Returns the tools which are available for LAM.</description>
        <long-description></long-description>
        <tag name="return" description="list of LAMtool classes" line="37" type="array">
          <type>array</type>
        </tag>
      </docblock>
    </function>
    <interface namespace="" line="70" package="tools">
      <name>LAMTool</name>
      <full_name>\LAMTool</full_name>
      <docblock line="70">
        <description>Represents a tool.</description>
        <long-description>LAM will scan lib/tools/*.inc for classes which implement this interface. This alows to
dynamically plugin additional tools. There will be an entry on the tools page inside LAM
for each found class (if it matches the security level).
A LAMTool only specifies name, description and location of a tool. The tool functionality
is provided by the tool's target page.</long-description>
        <tag name="author" description="Roland Gruber" line="70"/>
        <tag name="package" description="tools" line="70"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="77" package="tools">
        <name>getName</name>
        <full_name>\LAMTool::getName()</full_name>
        <docblock line="77">
          <description>Returns the name of the tool.</description>
          <long-description></long-description>
          <tag name="return" description="name" line="77" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="84" package="tools">
        <name>getDescription</name>
        <full_name>\LAMTool::getDescription()</full_name>
        <docblock line="84">
          <description>returns a description text for the tool.</description>
          <long-description></long-description>
          <tag name="return" description="description" line="84" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="91" package="tools">
        <name>getLink</name>
        <full_name>\LAMTool::getLink()</full_name>
        <docblock line="91">
          <description>Returns a link to the tool page (relative to templates/).</description>
          <long-description></long-description>
          <tag name="return" description="link" line="91" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="98" package="tools">
        <name>getRequiresWriteAccess</name>
        <full_name>\LAMTool::getRequiresWriteAccess()</full_name>
        <docblock line="98">
          <description>Returns if the tool requires write access to LDAP.</description>
          <long-description></long-description>
          <tag name="return" description="true if write access is needed" line="98" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="105" package="tools">
        <name>getRequiresPasswordChangeRights</name>
        <full_name>\LAMTool::getRequiresPasswordChangeRights()</full_name>
        <docblock line="105">
          <description>Returns if the tool requires password change rights.</description>
          <long-description></long-description>
          <tag name="return" description="true if password change rights are needed" line="105" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="112" package="tools">
        <name>getImageLink</name>
        <full_name>\LAMTool::getImageLink()</full_name>
        <docblock line="112">
          <description>Returns the link to the tool image (relative to graphics/)</description>
          <long-description></long-description>
          <tag name="return" description="image URL" line="112" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="120" package="tools">
        <name>getPosition</name>
        <full_name>\LAMTool::getPosition()</full_name>
        <docblock line="120">
          <description>Returns the prefered position of this tool on the tools page.</description>
          <long-description>The position may be between 0 and 1000. 0 is the top position.</long-description>
          <tag name="return" description="prefered position" line="120" type="int">
            <type>int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="127" package="tools">
        <name>getSubTools</name>
        <full_name>\LAMTool::getSubTools()</full_name>
        <docblock line="127">
          <description>Returns a list of sub tools or an empty array.</description>
          <long-description></long-description>
          <tag name="return" description="list of subtools (LAMTool)" line="127" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="134" package="tools">
        <name>isVisible</name>
        <full_name>\LAMTool::isVisible()</full_name>
        <docblock line="134">
          <description>Returns if the tool is visible in the menu.</description>
          <long-description></long-description>
          <tag name="return" description="visible" line="134" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="141" package="tools">
        <name>isHideable</name>
        <full_name>\LAMTool::isHideable()</full_name>
        <docblock line="141">
          <description>Returns if a tool may be hidden by configuration in the LAM server profile.</description>
          <long-description></long-description>
          <tag name="return" description="hideable" line="141" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
    </interface>
    <class final="false" abstract="false" namespace="" line="151" package="tools">
      <extends/>
      <name>LAMSubTool</name>
      <full_name>\LAMSubTool</full_name>
      <docblock line="151">
        <description>Represents a subtool.</description>
        <long-description></long-description>
        <tag name="author" description="Roland Gruber" line="151"/>
        <tag name="package" description="tools" line="151"/>
      </docblock>
      <property static="false" visibility="public" line="154" namespace="" package="tools">
        <name>$name</name>
        <default></default>
        <docblock line="154">
          <description>visible tool name</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="156" namespace="" package="tools">
        <name>$description</name>
        <default></default>
        <docblock line="156">
          <description>tool description</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="158" namespace="" package="tools">
        <name>$link</name>
        <default></default>
        <docblock line="158">
          <description>tool link (relative to templates/)</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="160" namespace="" package="tools">
        <name>$image</name>
        <default></default>
        <docblock line="160">
          <description>image URL (relative to graphics/)</description>
          <long-description></long-description>
        </docblock>
      </property>
    </class>
    <source> </source>
  </file>
  <file path="lib/fpdf.php" generated-path="lib.fpdf.html" hash="52e877a2c57c8d7dba92bd4432d80092" package="main">
    <docblock line="0">
      <description></description>
      <long-description></long-description>
    </docblock>
    <constant namespace="" line="10" package="main">
      <name>FPDF_VERSION</name>
      <full_name>\\FPDF_VERSION</full_name>
      <value>'1.7'</value>
      <docblock line="10">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <class final="false" abstract="false" namespace="" line="12" package="main">
      <extends/>
      <name>FPDF</name>
      <full_name>\FPDF</full_name>
      <docblock line="12">
        <description></description>
        <long-description></long-description>
      </docblock>
      <property static="false" visibility="public" line="14" namespace="" package="main">
        <name>$page</name>
        <default></default>
        <docblock line="14">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="15" namespace="" package="main">
        <name>$n</name>
        <default></default>
        <docblock line="15">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="16" namespace="" package="main">
        <name>$offsets</name>
        <default></default>
        <docblock line="16">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="17" namespace="" package="main">
        <name>$buffer</name>
        <default></default>
        <docblock line="17">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="18" namespace="" package="main">
        <name>$pages</name>
        <default></default>
        <docblock line="18">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="19" namespace="" package="main">
        <name>$state</name>
        <default></default>
        <docblock line="19">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="20" namespace="" package="main">
        <name>$compress</name>
        <default></default>
        <docblock line="20">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="21" namespace="" package="main">
        <name>$k</name>
        <default></default>
        <docblock line="21">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="22" namespace="" package="main">
        <name>$DefOrientation</name>
        <default></default>
        <docblock line="22">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="23" namespace="" package="main">
        <name>$CurOrientation</name>
        <default></default>
        <docblock line="23">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="24" namespace="" package="main">
        <name>$StdPageSizes</name>
        <default></default>
        <docblock line="24">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="25" namespace="" package="main">
        <name>$DefPageSize</name>
        <default></default>
        <docblock line="25">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="26" namespace="" package="main">
        <name>$CurPageSize</name>
        <default></default>
        <docblock line="26">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="27" namespace="" package="main">
        <name>$PageSizes</name>
        <default></default>
        <docblock line="27">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="28" namespace="" package="main">
        <name>$wPt</name>
        <default></default>
        <docblock line="28">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="28" namespace="" package="main">
        <name>$hPt</name>
        <default></default>
        <docblock line="28">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="29" namespace="" package="main">
        <name>$w</name>
        <default></default>
        <docblock line="29">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="29" namespace="" package="main">
        <name>$h</name>
        <default></default>
        <docblock line="29">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="30" namespace="" package="main">
        <name>$lMargin</name>
        <default></default>
        <docblock line="30">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="31" namespace="" package="main">
        <name>$tMargin</name>
        <default></default>
        <docblock line="31">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="32" namespace="" package="main">
        <name>$rMargin</name>
        <default></default>
        <docblock line="32">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="33" namespace="" package="main">
        <name>$bMargin</name>
        <default></default>
        <docblock line="33">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="34" namespace="" package="main">
        <name>$cMargin</name>
        <default></default>
        <docblock line="34">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="35" namespace="" package="main">
        <name>$x</name>
        <default></default>
        <docblock line="35">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="35" namespace="" package="main">
        <name>$y</name>
        <default></default>
        <docblock line="35">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="36" namespace="" package="main">
        <name>$lasth</name>
        <default></default>
        <docblock line="36">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="37" namespace="" package="main">
        <name>$LineWidth</name>
        <default></default>
        <docblock line="37">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="38" namespace="" package="main">
        <name>$fontpath</name>
        <default></default>
        <docblock line="38">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="39" namespace="" package="main">
        <name>$CoreFonts</name>
        <default></default>
        <docblock line="39">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="40" namespace="" package="main">
        <name>$fonts</name>
        <default></default>
        <docblock line="40">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="41" namespace="" package="main">
        <name>$FontFiles</name>
        <default></default>
        <docblock line="41">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="42" namespace="" package="main">
        <name>$diffs</name>
        <default></default>
        <docblock line="42">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="43" namespace="" package="main">
        <name>$FontFamily</name>
        <default></default>
        <docblock line="43">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="44" namespace="" package="main">
        <name>$FontStyle</name>
        <default></default>
        <docblock line="44">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="45" namespace="" package="main">
        <name>$underline</name>
        <default></default>
        <docblock line="45">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="46" namespace="" package="main">
        <name>$CurrentFont</name>
        <default></default>
        <docblock line="46">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="47" namespace="" package="main">
        <name>$FontSizePt</name>
        <default></default>
        <docblock line="47">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="48" namespace="" package="main">
        <name>$FontSize</name>
        <default></default>
        <docblock line="48">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="49" namespace="" package="main">
        <name>$DrawColor</name>
        <default></default>
        <docblock line="49">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="50" namespace="" package="main">
        <name>$FillColor</name>
        <default></default>
        <docblock line="50">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="51" namespace="" package="main">
        <name>$TextColor</name>
        <default></default>
        <docblock line="51">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="52" namespace="" package="main">
        <name>$ColorFlag</name>
        <default></default>
        <docblock line="52">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="53" namespace="" package="main">
        <name>$ws</name>
        <default></default>
        <docblock line="53">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="54" namespace="" package="main">
        <name>$images</name>
        <default></default>
        <docblock line="54">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="55" namespace="" package="main">
        <name>$PageLinks</name>
        <default></default>
        <docblock line="55">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="56" namespace="" package="main">
        <name>$links</name>
        <default></default>
        <docblock line="56">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="57" namespace="" package="main">
        <name>$AutoPageBreak</name>
        <default></default>
        <docblock line="57">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="58" namespace="" package="main">
        <name>$PageBreakTrigger</name>
        <default></default>
        <docblock line="58">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="59" namespace="" package="main">
        <name>$InHeader</name>
        <default></default>
        <docblock line="59">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="60" namespace="" package="main">
        <name>$InFooter</name>
        <default></default>
        <docblock line="60">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="61" namespace="" package="main">
        <name>$ZoomMode</name>
        <default></default>
        <docblock line="61">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="62" namespace="" package="main">
        <name>$LayoutMode</name>
        <default></default>
        <docblock line="62">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="63" namespace="" package="main">
        <name>$title</name>
        <default></default>
        <docblock line="63">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="64" namespace="" package="main">
        <name>$subject</name>
        <default></default>
        <docblock line="64">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="65" namespace="" package="main">
        <name>$author</name>
        <default></default>
        <docblock line="65">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="66" namespace="" package="main">
        <name>$keywords</name>
        <default></default>
        <docblock line="66">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="67" namespace="" package="main">
        <name>$creator</name>
        <default></default>
        <docblock line="67">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="68" namespace="" package="main">
        <name>$AliasNbPages</name>
        <default></default>
        <docblock line="68">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="69" namespace="" package="main">
        <name>$PDFVersion</name>
        <default></default>
        <docblock line="69">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="76" package="main">
        <name>FPDF</name>
        <full_name>\FPDF::FPDF()</full_name>
        <docblock line="76">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$orientation</name>
          <default>'P'</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$unit</name>
          <default>'mm'</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$size</name>
          <default>'A4'</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="170" package="main">
        <name>SetMargins</name>
        <full_name>\FPDF::SetMargins()</full_name>
        <docblock line="170">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$left</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$top</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$right</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="180" package="main">
        <name>SetLeftMargin</name>
        <full_name>\FPDF::SetLeftMargin()</full_name>
        <docblock line="180">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$margin</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="188" package="main">
        <name>SetTopMargin</name>
        <full_name>\FPDF::SetTopMargin()</full_name>
        <docblock line="188">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$margin</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="194" package="main">
        <name>SetRightMargin</name>
        <full_name>\FPDF::SetRightMargin()</full_name>
        <docblock line="194">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$margin</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="200" package="main">
        <name>SetAutoPageBreak</name>
        <full_name>\FPDF::SetAutoPageBreak()</full_name>
        <docblock line="200">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$auto</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$margin</name>
          <default>0</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="208" package="main">
        <name>SetDisplayMode</name>
        <full_name>\FPDF::SetDisplayMode()</full_name>
        <docblock line="208">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$zoom</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$layout</name>
          <default>'default'</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="221" package="main">
        <name>SetCompression</name>
        <full_name>\FPDF::SetCompression()</full_name>
        <docblock line="221">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$compress</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="230" package="main">
        <name>SetTitle</name>
        <full_name>\FPDF::SetTitle()</full_name>
        <docblock line="230">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$title</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$isUTF8</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="238" package="main">
        <name>SetSubject</name>
        <full_name>\FPDF::SetSubject()</full_name>
        <docblock line="238">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$subject</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$isUTF8</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="246" package="main">
        <name>SetAuthor</name>
        <full_name>\FPDF::SetAuthor()</full_name>
        <docblock line="246">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$author</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$isUTF8</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="254" package="main">
        <name>SetKeywords</name>
        <full_name>\FPDF::SetKeywords()</full_name>
        <docblock line="254">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$keywords</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$isUTF8</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="262" package="main">
        <name>SetCreator</name>
        <full_name>\FPDF::SetCreator()</full_name>
        <docblock line="262">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$creator</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$isUTF8</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="270" package="main">
        <name>AliasNbPages</name>
        <full_name>\FPDF::AliasNbPages()</full_name>
        <docblock line="270">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$alias</name>
          <default>'{nb}'</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="276" package="main">
        <name>Error</name>
        <full_name>\FPDF::Error()</full_name>
        <docblock line="276">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$msg</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="282" package="main">
        <name>Open</name>
        <full_name>\FPDF::Open()</full_name>
        <docblock line="282">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="288" package="main">
        <name>Close</name>
        <full_name>\FPDF::Close()</full_name>
        <docblock line="288">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="305" package="main">
        <name>AddPage</name>
        <full_name>\FPDF::AddPage()</full_name>
        <docblock line="305">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$orientation</name>
          <default>''</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$size</name>
          <default>''</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="374" package="main">
        <name>Header</name>
        <full_name>\FPDF::Header()</full_name>
        <docblock line="374">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="379" package="main">
        <name>Footer</name>
        <full_name>\FPDF::Footer()</full_name>
        <docblock line="379">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="384" package="main">
        <name>PageNo</name>
        <full_name>\FPDF::PageNo()</full_name>
        <docblock line="384">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="390" package="main">
        <name>SetDrawColor</name>
        <full_name>\FPDF::SetDrawColor()</full_name>
        <docblock line="390">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$r</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$g</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$b</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="401" package="main">
        <name>SetFillColor</name>
        <full_name>\FPDF::SetFillColor()</full_name>
        <docblock line="401">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$r</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$g</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$b</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="413" package="main">
        <name>SetTextColor</name>
        <full_name>\FPDF::SetTextColor()</full_name>
        <docblock line="413">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$r</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$g</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$b</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="423" package="main">
        <name>GetStringWidth</name>
        <full_name>\FPDF::GetStringWidth()</full_name>
        <docblock line="423">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$s</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="435" package="main">
        <name>SetLineWidth</name>
        <full_name>\FPDF::SetLineWidth()</full_name>
        <docblock line="435">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$width</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="443" package="main">
        <name>Line</name>
        <full_name>\FPDF::Line()</full_name>
        <docblock line="443">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$x1</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$y1</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$x2</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$y2</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="449" package="main">
        <name>Rect</name>
        <full_name>\FPDF::Rect()</full_name>
        <docblock line="449">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$x</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$y</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$w</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$h</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$style</name>
          <default>''</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="461" package="main">
        <name>AddFont</name>
        <full_name>\FPDF::AddFont()</full_name>
        <docblock line="461">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$family</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$style</name>
          <default>''</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$file</name>
          <default>''</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="497" package="main">
        <name>SetFont</name>
        <full_name>\FPDF::SetFont()</full_name>
        <docblock line="497">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$family</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$style</name>
          <default>''</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$size</name>
          <default>0</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="547" package="main">
        <name>SetFontSize</name>
        <full_name>\FPDF::SetFontSize()</full_name>
        <docblock line="547">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$size</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="558" package="main">
        <name>AddLink</name>
        <full_name>\FPDF::AddLink()</full_name>
        <docblock line="558">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="566" package="main">
        <name>SetLink</name>
        <full_name>\FPDF::SetLink()</full_name>
        <docblock line="566">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$link</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$y</name>
          <default>0</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$page</name>
          <default>-1</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="576" package="main">
        <name>Link</name>
        <full_name>\FPDF::Link()</full_name>
        <docblock line="576">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$x</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$y</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$w</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$h</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$link</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="582" package="main">
        <name>Text</name>
        <full_name>\FPDF::Text()</full_name>
        <docblock line="582">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$x</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$y</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$txt</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="593" package="main">
        <name>AcceptPageBreak</name>
        <full_name>\FPDF::AcceptPageBreak()</full_name>
        <docblock line="593">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="599" package="main">
        <name>Cell</name>
        <full_name>\FPDF::Cell()</full_name>
        <docblock line="599">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$w</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$h</name>
          <default>0</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$txt</name>
          <default>''</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$border</name>
          <default>0</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$ln</name>
          <default>0</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$align</name>
          <default>''</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$fill</name>
          <default>false</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$link</name>
          <default>''</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="678" package="main">
        <name>MultiCell</name>
        <full_name>\FPDF::MultiCell()</full_name>
        <docblock line="678">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$w</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$h</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$txt</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$border</name>
          <default>0</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$align</name>
          <default>'J'</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$fill</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="791" package="main">
        <name>Write</name>
        <full_name>\FPDF::Write()</full_name>
        <docblock line="791">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$h</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$txt</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$link</name>
          <default>''</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="872" package="main">
        <name>Ln</name>
        <full_name>\FPDF::Ln()</full_name>
        <docblock line="872">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$h</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="882" package="main">
        <name>Image</name>
        <full_name>\FPDF::Image()</full_name>
        <docblock line="882">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$file</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$x</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$y</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$w</name>
          <default>0</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$h</name>
          <default>0</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$type</name>
          <default>''</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$link</name>
          <default>''</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="945" package="main">
        <name>GetX</name>
        <full_name>\FPDF::GetX()</full_name>
        <docblock line="945">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="951" package="main">
        <name>SetX</name>
        <full_name>\FPDF::SetX()</full_name>
        <docblock line="951">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$x</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="960" package="main">
        <name>GetY</name>
        <full_name>\FPDF::GetY()</full_name>
        <docblock line="960">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="966" package="main">
        <name>SetY</name>
        <full_name>\FPDF::SetY()</full_name>
        <docblock line="966">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$y</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="976" package="main">
        <name>SetXY</name>
        <full_name>\FPDF::SetXY()</full_name>
        <docblock line="976">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$x</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$y</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="983" package="main">
        <name>Output</name>
        <full_name>\FPDF::Output()</full_name>
        <docblock line="983">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default>''</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$dest</name>
          <default>''</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1045" package="main">
        <name>_dochecks</name>
        <full_name>\FPDF::_dochecks()</full_name>
        <docblock line="1045">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1058" package="main">
        <name>_checkoutput</name>
        <full_name>\FPDF::_checkoutput()</full_name>
        <docblock line="1058">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1078" package="main">
        <name>_getpagesize</name>
        <full_name>\FPDF::_getpagesize()</full_name>
        <docblock line="1078">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$size</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1097" package="main">
        <name>_beginpage</name>
        <full_name>\FPDF::_beginpage()</full_name>
        <docblock line="1097">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$orientation</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$size</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1137" package="main">
        <name>_endpage</name>
        <full_name>\FPDF::_endpage()</full_name>
        <docblock line="1137">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1142" package="main">
        <name>_loadfont</name>
        <full_name>\FPDF::_loadfont()</full_name>
        <docblock line="1142">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$font</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1152" package="main">
        <name>_escape</name>
        <full_name>\FPDF::_escape()</full_name>
        <docblock line="1152">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$s</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1162" package="main">
        <name>_textstring</name>
        <full_name>\FPDF::_textstring()</full_name>
        <docblock line="1162">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$s</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1168" package="main">
        <name>_UTF8toUTF16</name>
        <full_name>\FPDF::_UTF8toUTF16()</full_name>
        <docblock line="1168">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$s</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1201" package="main">
        <name>_dounderline</name>
        <full_name>\FPDF::_dounderline()</full_name>
        <docblock line="1201">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$x</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$y</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$txt</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1210" package="main">
        <name>_parsejpg</name>
        <full_name>\FPDF::_parsejpg()</full_name>
        <docblock line="1210">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$file</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1229" package="main">
        <name>_parsepng</name>
        <full_name>\FPDF::_parsepng()</full_name>
        <docblock line="1229">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$file</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1240" package="main">
        <name>_parsepngstream</name>
        <full_name>\FPDF::_parsepngstream()</full_name>
        <docblock line="1240">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$f</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$file</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1365" package="main">
        <name>_readstream</name>
        <full_name>\FPDF::_readstream()</full_name>
        <docblock line="1365">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$f</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$n</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1382" package="main">
        <name>_readint</name>
        <full_name>\FPDF::_readint()</full_name>
        <docblock line="1382">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$f</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1389" package="main">
        <name>_parsegif</name>
        <full_name>\FPDF::_parsegif()</full_name>
        <docblock line="1389">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$file</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1428" package="main">
        <name>_newobj</name>
        <full_name>\FPDF::_newobj()</full_name>
        <docblock line="1428">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1436" package="main">
        <name>_putstream</name>
        <full_name>\FPDF::_putstream()</full_name>
        <docblock line="1436">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$s</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1443" package="main">
        <name>_out</name>
        <full_name>\FPDF::_out()</full_name>
        <docblock line="1443">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$s</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1452" package="main">
        <name>_putpages</name>
        <full_name>\FPDF::_putpages()</full_name>
        <docblock line="1452">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1525" package="main">
        <name>_putfonts</name>
        <full_name>\FPDF::_putfonts()</full_name>
        <docblock line="1525">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1619" package="main">
        <name>_putimages</name>
        <full_name>\FPDF::_putimages()</full_name>
        <docblock line="1619">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1629" package="main">
        <name>_putimage</name>
        <full_name>\FPDF::_putimage()</full_name>
        <docblock line="1629">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$info</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1681" package="main">
        <name>_putxobjectdict</name>
        <full_name>\FPDF::_putxobjectdict()</full_name>
        <docblock line="1681">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1687" package="main">
        <name>_putresourcedict</name>
        <full_name>\FPDF::_putresourcedict()</full_name>
        <docblock line="1687">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1699" package="main">
        <name>_putresources</name>
        <full_name>\FPDF::_putresources()</full_name>
        <docblock line="1699">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1712" package="main">
        <name>_putinfo</name>
        <full_name>\FPDF::_putinfo()</full_name>
        <docblock line="1712">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1728" package="main">
        <name>_putcatalog</name>
        <full_name>\FPDF::_putcatalog()</full_name>
        <docblock line="1728">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1748" package="main">
        <name>_putheader</name>
        <full_name>\FPDF::_putheader()</full_name>
        <docblock line="1748">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1753" package="main">
        <name>_puttrailer</name>
        <full_name>\FPDF::_puttrailer()</full_name>
        <docblock line="1753">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1760" package="main">
        <name>_enddoc</name>
        <full_name>\FPDF::_enddoc()</full_name>
        <docblock line="1760">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
    </class>
    <parse_markers>
      <error line="0" code="PPC:ERR-50000">No summary was found for this file</error>
      <error line="12" code="PPC:ERR-50005">No summary for class \FPDF</error>
      <error line="14" code="PPC:ERR-50007">No summary for property $page</error>
      <error line="15" code="PPC:ERR-50007">No summary for property $n</error>
      <error line="16" code="PPC:ERR-50007">No summary for property $offsets</error>
      <error line="17" code="PPC:ERR-50007">No summary for property $buffer</error>
      <error line="18" code="PPC:ERR-50007">No summary for property $pages</error>
      <error line="19" code="PPC:ERR-50007">No summary for property $state</error>
      <error line="20" code="PPC:ERR-50007">No summary for property $compress</error>
      <error line="21" code="PPC:ERR-50007">No summary for property $k</error>
      <error line="22" code="PPC:ERR-50007">No summary for property $DefOrientation</error>
      <error line="23" code="PPC:ERR-50007">No summary for property $CurOrientation</error>
      <error line="24" code="PPC:ERR-50007">No summary for property $StdPageSizes</error>
      <error line="25" code="PPC:ERR-50007">No summary for property $DefPageSize</error>
      <error line="26" code="PPC:ERR-50007">No summary for property $CurPageSize</error>
      <error line="27" code="PPC:ERR-50007">No summary for property $PageSizes</error>
      <error line="28" code="PPC:ERR-50007">No summary for property $wPt</error>
      <error line="28" code="PPC:ERR-50007">No summary for property $hPt</error>
      <error line="29" code="PPC:ERR-50007">No summary for property $w</error>
      <error line="29" code="PPC:ERR-50007">No summary for property $h</error>
      <error line="30" code="PPC:ERR-50007">No summary for property $lMargin</error>
      <error line="31" code="PPC:ERR-50007">No summary for property $tMargin</error>
      <error line="32" code="PPC:ERR-50007">No summary for property $rMargin</error>
      <error line="33" code="PPC:ERR-50007">No summary for property $bMargin</error>
      <error line="34" code="PPC:ERR-50007">No summary for property $cMargin</error>
      <error line="35" code="PPC:ERR-50007">No summary for property $x</error>
      <error line="35" code="PPC:ERR-50007">No summary for property $y</error>
      <error line="36" code="PPC:ERR-50007">No summary for property $lasth</error>
      <error line="37" code="PPC:ERR-50007">No summary for property $LineWidth</error>
      <error line="38" code="PPC:ERR-50007">No summary for property $fontpath</error>
      <error line="39" code="PPC:ERR-50007">No summary for property $CoreFonts</error>
      <error line="40" code="PPC:ERR-50007">No summary for property $fonts</error>
      <error line="41" code="PPC:ERR-50007">No summary for property $FontFiles</error>
      <error line="42" code="PPC:ERR-50007">No summary for property $diffs</error>
      <error line="43" code="PPC:ERR-50007">No summary for property $FontFamily</error>
      <error line="44" code="PPC:ERR-50007">No summary for property $FontStyle</error>
      <error line="45" code="PPC:ERR-50007">No summary for property $underline</error>
      <error line="46" code="PPC:ERR-50007">No summary for property $CurrentFont</error>
      <error line="47" code="PPC:ERR-50007">No summary for property $FontSizePt</error>
      <error line="48" code="PPC:ERR-50007">No summary for property $FontSize</error>
      <error line="49" code="PPC:ERR-50007">No summary for property $DrawColor</error>
      <error line="50" code="PPC:ERR-50007">No summary for property $FillColor</error>
      <error line="51" code="PPC:ERR-50007">No summary for property $TextColor</error>
      <error line="52" code="PPC:ERR-50007">No summary for property $ColorFlag</error>
      <error line="53" code="PPC:ERR-50007">No summary for property $ws</error>
      <error line="54" code="PPC:ERR-50007">No summary for property $images</error>
      <error line="55" code="PPC:ERR-50007">No summary for property $PageLinks</error>
      <error line="56" code="PPC:ERR-50007">No summary for property $links</error>
      <error line="57" code="PPC:ERR-50007">No summary for property $AutoPageBreak</error>
      <error line="58" code="PPC:ERR-50007">No summary for property $PageBreakTrigger</error>
      <error line="59" code="PPC:ERR-50007">No summary for property $InHeader</error>
      <error line="60" code="PPC:ERR-50007">No summary for property $InFooter</error>
      <error line="61" code="PPC:ERR-50007">No summary for property $ZoomMode</error>
      <error line="62" code="PPC:ERR-50007">No summary for property $LayoutMode</error>
      <error line="63" code="PPC:ERR-50007">No summary for property $title</error>
      <error line="64" code="PPC:ERR-50007">No summary for property $subject</error>
      <error line="65" code="PPC:ERR-50007">No summary for property $author</error>
      <error line="66" code="PPC:ERR-50007">No summary for property $keywords</error>
      <error line="67" code="PPC:ERR-50007">No summary for property $creator</error>
      <error line="68" code="PPC:ERR-50007">No summary for property $AliasNbPages</error>
      <error line="69" code="PPC:ERR-50007">No summary for property $PDFVersion</error>
      <error line="76" code="PPC:ERR-50008">No summary for method FPDF()</error>
      <error line="170" code="PPC:ERR-50008">No summary for method SetMargins()</error>
      <error line="180" code="PPC:ERR-50008">No summary for method SetLeftMargin()</error>
      <error line="188" code="PPC:ERR-50008">No summary for method SetTopMargin()</error>
      <error line="194" code="PPC:ERR-50008">No summary for method SetRightMargin()</error>
      <error line="200" code="PPC:ERR-50008">No summary for method SetAutoPageBreak()</error>
      <error line="208" code="PPC:ERR-50008">No summary for method SetDisplayMode()</error>
      <error line="221" code="PPC:ERR-50008">No summary for method SetCompression()</error>
      <error line="230" code="PPC:ERR-50008">No summary for method SetTitle()</error>
      <error line="238" code="PPC:ERR-50008">No summary for method SetSubject()</error>
      <error line="246" code="PPC:ERR-50008">No summary for method SetAuthor()</error>
      <error line="254" code="PPC:ERR-50008">No summary for method SetKeywords()</error>
      <error line="262" code="PPC:ERR-50008">No summary for method SetCreator()</error>
      <error line="270" code="PPC:ERR-50008">No summary for method AliasNbPages()</error>
      <error line="276" code="PPC:ERR-50008">No summary for method Error()</error>
      <error line="282" code="PPC:ERR-50008">No summary for method Open()</error>
      <error line="288" code="PPC:ERR-50008">No summary for method Close()</error>
      <error line="305" code="PPC:ERR-50008">No summary for method AddPage()</error>
      <error line="374" code="PPC:ERR-50008">No summary for method Header()</error>
      <error line="379" code="PPC:ERR-50008">No summary for method Footer()</error>
      <error line="384" code="PPC:ERR-50008">No summary for method PageNo()</error>
      <error line="390" code="PPC:ERR-50008">No summary for method SetDrawColor()</error>
      <error line="401" code="PPC:ERR-50008">No summary for method SetFillColor()</error>
      <error line="413" code="PPC:ERR-50008">No summary for method SetTextColor()</error>
      <error line="423" code="PPC:ERR-50008">No summary for method GetStringWidth()</error>
      <error line="435" code="PPC:ERR-50008">No summary for method SetLineWidth()</error>
      <error line="443" code="PPC:ERR-50008">No summary for method Line()</error>
      <error line="449" code="PPC:ERR-50008">No summary for method Rect()</error>
      <error line="461" code="PPC:ERR-50008">No summary for method AddFont()</error>
      <error line="497" code="PPC:ERR-50008">No summary for method SetFont()</error>
      <error line="547" code="PPC:ERR-50008">No summary for method SetFontSize()</error>
      <error line="558" code="PPC:ERR-50008">No summary for method AddLink()</error>
      <error line="566" code="PPC:ERR-50008">No summary for method SetLink()</error>
      <error line="576" code="PPC:ERR-50008">No summary for method Link()</error>
      <error line="582" code="PPC:ERR-50008">No summary for method Text()</error>
      <error line="593" code="PPC:ERR-50008">No summary for method AcceptPageBreak()</error>
      <error line="599" code="PPC:ERR-50008">No summary for method Cell()</error>
      <error line="678" code="PPC:ERR-50008">No summary for method MultiCell()</error>
      <error line="791" code="PPC:ERR-50008">No summary for method Write()</error>
      <error line="872" code="PPC:ERR-50008">No summary for method Ln()</error>
      <error line="882" code="PPC:ERR-50008">No summary for method Image()</error>
      <error line="945" code="PPC:ERR-50008">No summary for method GetX()</error>
      <error line="951" code="PPC:ERR-50008">No summary for method SetX()</error>
      <error line="960" code="PPC:ERR-50008">No summary for method GetY()</error>
      <error line="966" code="PPC:ERR-50008">No summary for method SetY()</error>
      <error line="976" code="PPC:ERR-50008">No summary for method SetXY()</error>
      <error line="983" code="PPC:ERR-50008">No summary for method Output()</error>
      <error line="1045" code="PPC:ERR-50008">No summary for method _dochecks()</error>
      <error line="1058" code="PPC:ERR-50008">No summary for method _checkoutput()</error>
      <error line="1078" code="PPC:ERR-50008">No summary for method _getpagesize()</error>
      <error line="1097" code="PPC:ERR-50008">No summary for method _beginpage()</error>
      <error line="1137" code="PPC:ERR-50008">No summary for method _endpage()</error>
      <error line="1142" code="PPC:ERR-50008">No summary for method _loadfont()</error>
      <error line="1152" code="PPC:ERR-50008">No summary for method _escape()</error>
      <error line="1162" code="PPC:ERR-50008">No summary for method _textstring()</error>
      <error line="1168" code="PPC:ERR-50008">No summary for method _UTF8toUTF16()</error>
      <error line="1201" code="PPC:ERR-50008">No summary for method _dounderline()</error>
      <error line="1210" code="PPC:ERR-50008">No summary for method _parsejpg()</error>
      <error line="1229" code="PPC:ERR-50008">No summary for method _parsepng()</error>
      <error line="1240" code="PPC:ERR-50008">No summary for method _parsepngstream()</error>
      <error line="1365" code="PPC:ERR-50008">No summary for method _readstream()</error>
      <error line="1382" code="PPC:ERR-50008">No summary for method _readint()</error>
      <error line="1389" code="PPC:ERR-50008">No summary for method _parsegif()</error>
      <error line="1428" code="PPC:ERR-50008">No summary for method _newobj()</error>
      <error line="1436" code="PPC:ERR-50008">No summary for method _putstream()</error>
      <error line="1443" code="PPC:ERR-50008">No summary for method _out()</error>
      <error line="1452" code="PPC:ERR-50008">No summary for method _putpages()</error>
      <error line="1525" code="PPC:ERR-50008">No summary for method _putfonts()</error>
      <error line="1619" code="PPC:ERR-50008">No summary for method _putimages()</error>
      <error line="1629" code="PPC:ERR-50008">No summary for method _putimage()</error>
      <error line="1681" code="PPC:ERR-50008">No summary for method _putxobjectdict()</error>
      <error line="1687" code="PPC:ERR-50008">No summary for method _putresourcedict()</error>
      <error line="1699" code="PPC:ERR-50008">No summary for method _putresources()</error>
      <error line="1712" code="PPC:ERR-50008">No summary for method _putinfo()</error>
      <error line="1728" code="PPC:ERR-50008">No summary for method _putcatalog()</error>
      <error line="1748" code="PPC:ERR-50008">No summary for method _putheader()</error>
      <error line="1753" code="PPC:ERR-50008">No summary for method _puttrailer()</error>
      <error line="1760" code="PPC:ERR-50008">No summary for method _enddoc()</error>
    </parse_markers>
    <source> </source>
  </file>
  <file path="lib/types.inc" generated-path="lib.types.inc.html" hash="9bd360b877504118ff364814401d622d" package="types">
    <docblock line="0">
      <description>This file is the interface to the different account types.</description>
      <long-description></long-description>
      <tag name="package" description="types" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <function namespace="" line="56" package="types">
      <name>getTypes</name>
      <full_name>\getTypes()</full_name>
      <docblock line="56">
        <description>Returns a list of available account types.</description>
        <long-description></long-description>
        <tag name="return" description="list of types" line="56" type="array">
          <type>array</type>
        </tag>
      </docblock>
    </function>
    <function namespace="" line="75" package="types">
      <name>getTypeAlias</name>
      <full_name>\getTypeAlias()</full_name>
      <docblock line="75">
        <description>Returns the alias name of an account type.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;type name&lt;/p&gt;" line="75" type="string" variable="$type">
          <type>string</type>
        </tag>
        <tag name="return" description="type alias" line="75" type="string">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$type</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="86" package="types">
      <name>getTypeDescription</name>
      <full_name>\getTypeDescription()</full_name>
      <docblock line="86">
        <description>Returns the description of an account type.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;type name&lt;/p&gt;" line="86" type="string" variable="$type">
          <type>string</type>
        </tag>
        <tag name="return" description="type description" line="86" type="string">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$type</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="97" package="types">
      <name>getListClassName</name>
      <full_name>\getListClassName()</full_name>
      <docblock line="97">
        <description>Returns the class name for the list object.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="97" type="string" variable="$type">
          <type>string</type>
        </tag>
        <tag name="return" description="class name" line="97" type="string">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$type</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="109" package="types">
      <name>getDefaultListAttributes</name>
      <full_name>\getDefaultListAttributes()</full_name>
      <docblock line="109">
        <description>Returns the default attribute list for an account type.</description>
        <long-description>It is used as default value for the configuration editor.</long-description>
        <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="109" type="string" variable="$type">
          <type>string</type>
        </tag>
        <tag name="return" description="attribute list" line="109" type="string">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$type</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="121" package="types">
      <name>getListAttributeDescriptions</name>
      <full_name>\getListAttributeDescriptions()</full_name>
      <docblock line="121">
        <description>Returns a list of attributes which have a translated description.</description>
        <long-description>This is used for the head row in the list view.</long-description>
        <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="121" type="string" variable="$type">
          <type>string</type>
        </tag>
        <tag name="return" description="list of descriptions" line="121" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$type</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <source> </source>
  </file>
  <file path="lib/selfService.inc" generated-path="lib.selfService.inc.html" hash="c339ec506c13d42d9330d138ac2b66e6" package="selfService">
    <docblock line="0">
      <description>Interface between modules and self service pages.</description>
      <long-description>This file also includes the self service profile class and helper functions.</long-description>
      <tag name="package" description="selfService" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <function namespace="" line="43" package="selfService">
      <name>isLAMProVersion</name>
      <full_name>\isLAMProVersion()</full_name>
      <docblock line="43">
        <description>Returns if this is a LAM Pro installation.</description>
        <long-description></long-description>
        <tag name="return" description="LAM Pro installation" line="43" type="boolean">
          <type>boolean</type>
        </tag>
      </docblock>
    </function>
    <function namespace="" line="55" package="selfService">
      <name>getSelfServiceSearchAttributes</name>
      <full_name>\getSelfServiceSearchAttributes()</full_name>
      <docblock line="55">
        <description>Returns a list of possible search attributes for the self service.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="55" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="return" description="attributes" line="55" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="75" package="selfService">
      <name>getSelfServiceFieldSettings</name>
      <full_name>\getSelfServiceFieldSettings()</full_name>
      <docblock line="75">
        <description>Returns the field settings for the self service.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="75" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="return" description="settings" line="75" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="97" package="selfService">
      <name>getSelfServiceOptions</name>
      <full_name>\getSelfServiceOptions()</full_name>
      <docblock line="97">
        <description>Returns meta HTML code for each self service field.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="97" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;input fields (array(&lt;moduleName&gt; =&gt; array(&lt;field1&gt;, &lt;field2&gt;, ...)))&lt;/p&gt;&#10;" line="97" type="array" variable="$fields">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;LDAP attributes (attribute names in lower case)&lt;/p&gt;&#10;" line="97" type="array" variable="$attributes">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;indicates that the user is only allowed to change his password and no LDAP content is readable&lt;/p&gt;" line="97" type="boolean" variable="$passwordChangeOnly">
          <type>boolean</type>
        </tag>
        <tag name="param" description="&lt;p&gt;list of read-only fields&lt;/p&gt;&#10;" line="97" type="array" variable="$readOnlyFields">
          <type>array</type>
        </tag>
        <tag name="return" description="meta HTML code (array(&amp;lt;moduleName&amp;gt; =&amp;gt; htmlTableRow))" line="97" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$fields</name>
        <default></default>
        <type>array</type>
      </argument>
      <argument line="0">
        <name>$attributes</name>
        <default></default>
        <type>array</type>
      </argument>
      <argument line="0">
        <name>$passwordChangeOnly</name>
        <default></default>
        <type>boolean</type>
      </argument>
      <argument line="0">
        <name>$readOnlyFields</name>
        <default></default>
        <type>array</type>
      </argument>
    </function>
    <function namespace="" line="127" package="selfService">
      <name>checkSelfServiceOptions</name>
      <full_name>\checkSelfServiceOptions()</full_name>
      <docblock line="127">
        <description>Checks if all input values are correct and returns the LDAP commands which should be executed.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="127" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;input fields (array(&lt;moduleName&gt; =&gt; array(&lt;field1&gt;, &lt;field2&gt;, ...)))&lt;/p&gt;&#10;" line="127" type="string" variable="$fields">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="127" type="array" variable="$attributes">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;indicates that the user is only allowed to change his password and no LDAP content is readable&lt;/p&gt;" line="127" type="boolean" variable="$passwordChangeOnly">
          <type>boolean</type>
        </tag>
        <tag name="param" description="&lt;p&gt;list of read-only fields&lt;/p&gt;&#10;" line="127" type="array" variable="$readOnlyFields">
          <type>array</type>
        </tag>
        <tag name="return" description="messages and LDAP commands (array(&amp;#039;messages&amp;#039; =&amp;gt; array(), &amp;#039;add&amp;#039; =&amp;gt; array(), &amp;#039;del&amp;#039; =&amp;gt; array(), &amp;#039;mod&amp;#039; =&amp;gt; array()))" line="127" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$fields</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$attributes</name>
        <default></default>
        <type>array</type>
      </argument>
      <argument line="0">
        <name>$passwordChangeOnly</name>
        <default></default>
        <type>boolean</type>
      </argument>
      <argument line="0">
        <name>$readOnlyFields</name>
        <default></default>
        <type>array</type>
      </argument>
    </function>
    <function namespace="" line="156" package="selfService">
      <name>getSelfServiceProfiles</name>
      <full_name>\getSelfServiceProfiles()</full_name>
      <docblock line="156">
        <description>Returns a list of all available self service profiles (without .conf)</description>
        <long-description></long-description>
        <tag name="return" description="profile names (array(&amp;lt;account type&amp;gt; =&amp;gt; array(&amp;lt;profile1&amp;gt;, &amp;lt;profile2&amp;gt;, ...)))" line="156" type="array">
          <type>array</type>
        </tag>
      </docblock>
    </function>
    <function namespace="" line="183" package="selfService">
      <name>loadSelfServiceProfile</name>
      <full_name>\loadSelfServiceProfile()</full_name>
      <docblock line="183">
        <description>Loads all settings of a self service profile.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;profile name&lt;/p&gt;" line="183" type="string" variable="$name">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="183" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="return" description="true if file was readable" line="183" type="\selfServiceProfile">
          <type>\selfServiceProfile</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$name</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="216" package="selfService">
      <name>saveSelfServiceProfile</name>
      <full_name>\saveSelfServiceProfile()</full_name>
      <docblock line="216">
        <description>Saves a self service profile.</description>
        <long-description>File is created, if needed</long-description>
        <tag name="param" description="&lt;p&gt;name of the account profile&lt;/p&gt;" line="216" type="string" variable="$name">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="216" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;self service profile&lt;/p&gt;" line="216" type="\selfServiceProfile" variable="$profile">
          <type>\selfServiceProfile</type>
        </tag>
        <tag name="return" description="true, if saving succeeded" line="216" type="boolean">
          <type>boolean</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$name</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$profile</name>
        <default></default>
        <type>\selfServiceProfile</type>
      </argument>
    </function>
    <function namespace="" line="244" package="selfService">
      <name>isSelfServiceProfileWritable</name>
      <full_name>\isSelfServiceProfileWritable()</full_name>
      <docblock line="244">
        <description>Checks if a service profile is writable.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;profile name&lt;/p&gt;" line="244" type="string" variable="$name">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="244" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="return" description="true if file is writable" line="244" type="boolean">
          <type>boolean</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$name</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="259" package="selfService">
      <name>getSelfServiceSettings</name>
      <full_name>\getSelfServiceSettings()</full_name>
      <docblock line="259">
        <description>Returns a hash array (module name =&gt; elements) of all module options for the configuration page.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="259" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;currently edited profile&lt;/p&gt;" line="259" type="\selfServiceProfile" variable="$profile">
          <type>\selfServiceProfile</type>
        </tag>
        <tag name="return" description="configuration options" line="259" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$profile</name>
        <default></default>
        <type>\selfServiceProfile</type>
      </argument>
    </function>
    <function namespace="" line="277" package="selfService">
      <name>checkSelfServiceSettings</name>
      <full_name>\checkSelfServiceSettings()</full_name>
      <docblock line="277">
        <description>Checks if the self service settings are valid</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="277" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;hash array containing all options (name =&gt; array(...))&lt;/p&gt;&#10;" line="277" type="array" variable="$options">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;profile&lt;/p&gt;" line="277" type="\selfServiceProfile" variable="$profile">
          <type>\selfServiceProfile</type>
        </tag>
        <tag name="return" description="list of error messages" line="277" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$options</name>
        <default></default>
        <type>array</type>
      </argument>
      <argument line="0">
        <name>$profile</name>
        <default></default>
        <type>\selfServiceProfile</type>
      </argument>
    </function>
    <class final="false" abstract="false" namespace="" line="294" package="selfService">
      <extends/>
      <name>selfServiceProfile</name>
      <full_name>\selfServiceProfile</full_name>
      <docblock line="294">
        <description>Includes all settings of a self service profile.</description>
        <long-description></long-description>
        <tag name="package" description="selfService" line="294"/>
      </docblock>
      <property static="false" visibility="public" line="297" namespace="" package="selfService">
        <name>$serverURL</name>
        <default></default>
        <docblock line="297">
          <description>server address</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="300" namespace="" package="selfService">
        <name>$useTLS</name>
        <default></default>
        <docblock line="300">
          <description>use TLS</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="303" namespace="" package="selfService">
        <name>$LDAPSuffix</name>
        <default></default>
        <docblock line="303">
          <description>LDAP suffix</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="306" namespace="" package="selfService">
        <name>$LDAPUser</name>
        <default></default>
        <docblock line="306">
          <description>LDAP user DN</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="309" namespace="" package="selfService">
        <name>$LDAPPassword</name>
        <default></default>
        <docblock line="309">
          <description>LDAP password</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="312" namespace="" package="selfService">
        <name>$searchAttribute</name>
        <default></default>
        <docblock line="312">
          <description>LDAP search attribute</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="315" namespace="" package="selfService">
        <name>$httpAuthentication</name>
        <default></default>
        <docblock line="315">
          <description>HTTP authentication</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="318" namespace="" package="selfService">
        <name>$pageHeader</name>
        <default></default>
        <docblock line="318">
          <description>header for self service pages</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="321" namespace="" package="selfService">
        <name>$additionalCSS</name>
        <default></default>
        <docblock line="321">
          <description>list of additional CSS links (separated by \n)</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="324" namespace="" package="selfService">
        <name>$loginCaption</name>
        <default></default>
        <docblock line="324">
          <description>describing text for user login</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="327" namespace="" package="selfService">
        <name>$loginAttributeText</name>
        <default></default>
        <docblock line="327">
          <description>describing text for search attribute</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="330" namespace="" package="selfService">
        <name>$mainPageText</name>
        <default></default>
        <docblock line="330">
          <description>describing text for self service main page</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="339" namespace="" package="selfService">
        <name>$inputFields</name>
        <default></default>
        <docblock line="339">
          <description>input fields
Format: array(
&lt;br&gt; array(array('name' =&gt; &lt;group name 1&gt;, 'fields' =&gt; array(&lt;field1&gt;, &lt;field2&gt;))),
&lt;br&gt; array(array('name' =&gt; &lt;group name 2&gt;, 'fields' =&gt; array(&lt;field3&gt;, &lt;field4&gt;)))
&lt;br&gt; )</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="344" namespace="" package="selfService">
        <name>$readOnlyFields</name>
        <default></default>
        <docblock line="344">
          <description>List of fields that are set in read-only mode.</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="347" namespace="" package="selfService">
        <name>$moduleSettings</name>
        <default></default>
        <docblock line="347">
          <description>configuration settings of modules</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="354" package="selfService">
        <name>__construct</name>
        <full_name>\selfServiceProfile::__construct()</full_name>
        <docblock line="354">
          <description>Constructor</description>
          <long-description></long-description>
          <tag name="return" description="" line="354" type="\selfServiceProfile">
            <type>\selfServiceProfile</type>
          </tag>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/lamPDF.inc" generated-path="lib.lamPDF.inc.html" hash="0b14cce81906f1ee3eda0da19a4a8099" package="PDF">
    <docblock line="0">
      <description>LDAP Account Manager PDF printing library. It consists of lamPDF class,
the createModulePDF() function that may be called by other pages
and furthermore some helper functions.</description>
      <long-description></long-description>
      <tag name="author" description="Michael Duergner" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="package" description="PDF" line="0"/>
    </docblock>
    <constant namespace="" line="70" package="PDF">
      <name>FPDF_FONTPATH</name>
      <full_name>\\FPDF_FONTPATH</full_name>
      <value>dirname(__FILE__) . '/font/'</value>
      <docblock line="70">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <class final="false" abstract="false" namespace="" line="41" package="PDF">
      <extends>\UFPDF</extends>
      <name>lamPDF</name>
      <full_name>\lamPDF</full_name>
      <docblock line="41">
        <description>Creates a LAM information page in PDF format.</description>
        <long-description></long-description>
        <tag name="package" description="PDF" line="41"/>
        <tag name="author" description="Michael Duergner" line="41"/>
        <tag name="author" description="Roland Gruber" line="41"/>
      </docblock>
      <property static="false" visibility="private" line="46" namespace="" package="PDF">
        <name>$page_definitions</name>
        <default></default>
        <docblock line="46">
          <description>format settings for page layout</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="51" namespace="" package="PDF">
        <name>$fontName</name>
        <default></default>
        <docblock line="51">
          <description>current active font name</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="57" namespace="" package="PDF">
        <name>$fontList</name>
        <default>array('BitstreamVeraSans-Roman' =&gt; array('vera.php', 'verab.php', 'verabi.php', 'verai.php'))</default>
        <docblock line="57">
          <description>list of supported fonts
format: &lt;font name&gt; =&gt; array(&lt;file for default font style&gt;, &lt;file for bold&gt;, &lt;italic&gt;, &lt;bold italic&gt;)</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="67" package="PDF">
        <name>__construct</name>
        <full_name>\lamPDF::__construct()</full_name>
        <docblock line="67">
          <description>Creates a new lamPDF object.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;page settings&lt;/p&gt;" line="67" type="array" variable="$page_definitions">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;font name&lt;/p&gt;" line="67" type="String" variable="$fontName">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$page_definitions</name>
          <default>array()</default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$fontName</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="93" package="PDF">
        <name>header</name>
        <full_name>\lamPDF::header()</full_name>
        <docblock line="93">
          <description>Creates the PDF page header.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="120" package="PDF">
        <name>footer</name>
        <full_name>\lamPDF::footer()</full_name>
        <docblock line="120">
          <description>Creates the PDF page footer.</description>
          <long-description></long-description>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/config.inc" generated-path="lib.config.inc.html" hash="35f801378e94b7b5ed53bab55b6c1011" package="configuration">
    <docblock line="0">
      <description>This file includes functions to manage the configuration files.</description>
      <long-description></long-description>
      <tag name="package" description="configuration" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="author" description="Thomas Manninger" line="0"/>
    </docblock>
    <function namespace="" line="43" package="configuration">
      <name>setSSLCaCert</name>
      <full_name>\setSSLCaCert()</full_name>
      <docblock line="43">
        <description>Sets the environment variables for custom SSL CA certificates.</description>
        <long-description></long-description>
      </docblock>
    </function>
    <function namespace="" line="57" package="configuration">
      <name>setlanguage</name>
      <full_name>\setlanguage()</full_name>
      <docblock line="57">
        <description>Sets language settings for automatic translation</description>
        <long-description></long-description>
      </docblock>
    </function>
    <function namespace="" line="80" package="configuration">
      <name>checkChmod</name>
      <full_name>\checkChmod()</full_name>
      <docblock line="80">
        <description>Checks whether a specific flag in the rights string is set.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;read,write or execute&lt;/p&gt;" line="80" type="" variable="$right"/>
        <tag name="param" description="&lt;p&gt;owner,group or other&lt;/p&gt;" line="80" type="" variable="$target"/>
        <tag name="param" description="&lt;p&gt;the chmod rights&lt;/p&gt;" line="80" type="" variable="$chmod"/>
        <tag name="return" description="if the chmod $right for $target were set" line="80" type="\true,">
          <type>\true,</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$right</name>
        <default></default>
        <type>mixed</type>
      </argument>
      <argument line="0">
        <name>$target</name>
        <default></default>
        <type>mixed</type>
      </argument>
      <argument line="0">
        <name>$chmod</name>
        <default></default>
        <type>mixed</type>
      </argument>
    </function>
    <function namespace="" line="116" package="configuration">
      <name>getConfigProfiles</name>
      <full_name>\getConfigProfiles()</full_name>
      <docblock line="116">
        <description>Returns an array of string with all available configuration profiles (without .conf)</description>
        <long-description></long-description>
        <tag name="return" description="profile names" line="116" type="array">
          <type>array</type>
        </tag>
      </docblock>
    </function>
    <function namespace="" line="139" package="configuration">
      <name>deleteConfigProfile</name>
      <full_name>\deleteConfigProfile()</full_name>
      <docblock line="139">
        <description>Deletes the given server profile.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;profile name&lt;/p&gt;" line="139" type="String" variable="$name">
          <type>String</type>
        </tag>
        <tag name="return" description="null if success or error message if failed" line="139" type="String">
          <type>String</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$name</name>
        <default></default>
        <type>String</type>
      </argument>
    </function>
    <function namespace="" line="179" package="configuration">
      <name>LAMVersion</name>
      <full_name>\LAMVersion()</full_name>
      <docblock line="179">
        <description>Returns the version number of this LAM installation.</description>
        <long-description>Format: &lt;major version&gt;.&lt;minor version&gt;.&lt;patch level&gt;
&lt;br&gt; Major/minor version are always numbers, patch level may contain letters for inofficial releases only (e.g. 0.5.alpha1).</long-description>
        <tag name="return" description="version number" line="179" type="string">
          <type>string</type>
        </tag>
      </docblock>
    </function>
    <function namespace="" line="197" package="configuration">
      <name>metaRefresh</name>
      <full_name>\metaRefresh()</full_name>
      <docblock line="197">
        <description>Prints a meta refresh page</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;the URL of the target page&lt;/p&gt;" line="197" type="string" variable="$page">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$page</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="223" package="configuration">
      <name>isAccountTypeHidden</name>
      <full_name>\isAccountTypeHidden()</full_name>
      <docblock line="223">
        <description>Checks if the given account type is hidden.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;account type (e.g. user)&lt;/p&gt;&#10;" line="223" type="String" variable="$type">
          <type>String</type>
        </tag>
        <tag name="return" description="is hidden" line="223" type="boolean">
          <type>boolean</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$type</name>
        <default></default>
        <type>String</type>
      </argument>
    </function>
    <class final="false" abstract="false" namespace="" line="233" package="configuration">
      <extends/>
      <name>LAMConfig</name>
      <full_name>\LAMConfig</full_name>
      <docblock line="233">
        <description>This class manages .conf files.</description>
        <long-description></long-description>
        <tag name="package" description="configuration" line="233"/>
      </docblock>
      <constant namespace="" line="236" package="configuration">
        <name>ACCESS_ALL</name>
        <full_name>\LAMConfig::ACCESS_ALL</full_name>
        <value>100</value>
        <docblock line="236">
          <description></description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="" line="237" package="configuration">
        <name>ACCESS_PASSWORD_CHANGE</name>
        <full_name>\LAMConfig::ACCESS_PASSWORD_CHANGE</full_name>
        <value>20</value>
        <docblock line="237">
          <description></description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="" line="238" package="configuration">
        <name>ACCESS_READ_ONLY</name>
        <full_name>\LAMConfig::ACCESS_READ_ONLY</full_name>
        <value>0</value>
        <docblock line="238">
          <description></description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="" line="241" package="configuration">
        <name>SAVE_OK</name>
        <full_name>\LAMConfig::SAVE_OK</full_name>
        <value>0</value>
        <docblock line="241">
          <description></description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="" line="242" package="configuration">
        <name>SAVE_FAIL</name>
        <full_name>\LAMConfig::SAVE_FAIL</full_name>
        <value>1</value>
        <docblock line="242">
          <description></description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="" line="245" package="configuration">
        <name>LOGIN_LIST</name>
        <full_name>\LAMConfig::LOGIN_LIST</full_name>
        <value>'list'</value>
        <docblock line="245">
          <description></description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="" line="246" package="configuration">
        <name>LOGIN_SEARCH</name>
        <full_name>\LAMConfig::LOGIN_SEARCH</full_name>
        <value>'search'</value>
        <docblock line="246">
          <description></description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="" line="249" package="configuration">
        <name>LINE_SEPARATOR</name>
        <full_name>\LAMConfig::LINE_SEPARATOR</full_name>
        <value>'+::+'</value>
        <docblock line="249">
          <description>line separator</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <property static="false" visibility="private" line="252" namespace="" package="configuration">
        <name>$ServerURL</name>
        <default></default>
        <docblock line="252">
          <description>Server address (e.g. ldap://127.0.0.1:389)</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="255" namespace="" package="configuration">
        <name>$useTLS</name>
        <default></default>
        <docblock line="255">
          <description>enables/disables TLS encryption</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="258" namespace="" package="configuration">
        <name>$Admins</name>
        <default></default>
        <docblock line="258">
          <description>Array of string: users with admin rights</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="261" namespace="" package="configuration">
        <name>$Passwd</name>
        <default></default>
        <docblock line="261">
          <description>Password to edit preferences</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="264" namespace="" package="configuration">
        <name>$treesuffix</name>
        <default></default>
        <docblock line="264">
          <description>LDAP suffix for tree view</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="267" namespace="" package="configuration">
        <name>$defaultLanguage</name>
        <default></default>
        <docblock line="267">
          <description>Default language</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="270" namespace="" package="configuration">
        <name>$moduleSettings</name>
        <default>array()</default>
        <docblock line="270">
          <description>module settings</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="273" namespace="" package="configuration">
        <name>$typeSettings</name>
        <default>array()</default>
        <docblock line="273">
          <description>type settings</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="276" namespace="" package="configuration">
        <name>$toolSettings</name>
        <default>array()</default>
        <docblock line="276">
          <description>tool settings</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="284" namespace="" package="configuration">
        <name>$scriptPath</name>
        <default></default>
        <docblock line="284">
          <description>Path to external lamdaemon script on server where it is executed</description>
          <long-description>This is used for managing quota and home directories.
optional setting, may not be defined</long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="289" namespace="" package="configuration">
        <name>$scriptRights</name>
        <default>'750'</default>
        <docblock line="289">
          <description>The rights for the home directory</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="297" namespace="" package="configuration">
        <name>$scriptServer</name>
        <default></default>
        <docblock line="297">
          <description>Servers where lamdaemon script is executed</description>
          <long-description>This is used for managing quota and home directories.
optional setting, may not be defined</long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="300" namespace="" package="configuration">
        <name>$cachetimeout</name>
        <default></default>
        <docblock line="300">
          <description>LDAP cache timeout</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="303" namespace="" package="configuration">
        <name>$searchLimit</name>
        <default>0</default>
        <docblock line="303">
          <description>LDAP search limit</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="306" namespace="" package="configuration">
        <name>$activeTypes</name>
        <default>"user,group,host,smbDomain"</default>
        <docblock line="306">
          <description>Active account types</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="309" namespace="" package="configuration">
        <name>$file</name>
        <default></default>
        <docblock line="309">
          <description>Name of configuration file</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="312" namespace="" package="configuration">
        <name>$accessLevel</name>
        <default>\LAMconfig::ACCESS_ALL</default>
        <docblock line="312">
          <description>access level</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="315" namespace="" package="configuration">
        <name>$loginMethod</name>
        <default>\LAMconfig::LOGIN_LIST</default>
        <docblock line="315">
          <description>login method</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="318" namespace="" package="configuration">
        <name>$loginSearchSuffix</name>
        <default>'dc=yourdomain,dc=org'</default>
        <docblock line="318">
          <description>search suffix for login</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="321" namespace="" package="configuration">
        <name>$loginSearchFilter</name>
        <default>'uid=%USER%'</default>
        <docblock line="321">
          <description>search filter for login</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="324" namespace="" package="configuration">
        <name>$loginSearchDN</name>
        <default>''</default>
        <docblock line="324">
          <description>bind user for login search</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="327" namespace="" package="configuration">
        <name>$loginSearchPassword</name>
        <default>''</default>
        <docblock line="327">
          <description>bind password for login search</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="330" namespace="" package="configuration">
        <name>$httpAuthentication</name>
        <default>'false'</default>
        <docblock line="330">
          <description>specifies if HTTP authentication should be used</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="333" namespace="" package="configuration">
        <name>$lamProMailFrom</name>
        <default>''</default>
        <docblock line="333">
          <description>email address for sender of password reset mails</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="336" namespace="" package="configuration">
        <name>$lamProMailReplyTo</name>
        <default>''</default>
        <docblock line="336">
          <description>reply-to email address for password reset mails</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="339" namespace="" package="configuration">
        <name>$lamProMailSubject</name>
        <default>''</default>
        <docblock line="339">
          <description>subject for password reset mails</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="342" namespace="" package="configuration">
        <name>$lamProMailIsHTML</name>
        <default>'false'</default>
        <docblock line="342">
          <description>treat password reset mail body as HTML</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="345" namespace="" package="configuration">
        <name>$lamProMailText</name>
        <default>''</default>
        <docblock line="345">
          <description>mail body for password reset mails</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="348" namespace="" package="configuration">
        <name>$settings</name>
        <default>array("ServerURL", "useTLS", "Passwd", "Admins", "treesuffix", "defaultLanguage", "scriptPath", "scriptServer", "scriptRights", "cachetimeout", "modules", "activeTypes", "types", "tools", "accessLevel", 'loginMethod', 'loginSearchSuffix', 'loginSearchFilter', 'searchLimit', 'lamProMailFrom', 'lamProMailReplyTo', 'lamProMailSubject', 'lamProMailText', 'lamProMailIsHTML', 'httpAuthentication', 'loginSearchDN', 'loginSearchPassword')</default>
        <docblock line="348">
          <description>List of all settings in config file</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="360" package="configuration">
        <name>__construct</name>
        <full_name>\LAMConfig::__construct()</full_name>
        <docblock line="360">
          <description>Loads preferences from config file</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;file name without &quot;.conf&quot; (e.g. lam)&lt;/p&gt;&#10;" line="360" type="String" variable="$file">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$file</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="379" package="configuration">
        <name>reload</name>
        <full_name>\LAMConfig::reload()</full_name>
        <docblock line="379">
          <description>Reloads preferences from config file</description>
          <long-description></long-description>
          <tag name="return" description="true if file was readable" line="379" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="455" package="configuration">
        <name>save</name>
        <full_name>\LAMConfig::save()</full_name>
        <docblock line="455">
          <description>Saves preferences to config file</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="580" package="configuration">
        <name>getName</name>
        <full_name>\LAMConfig::getName()</full_name>
        <docblock line="580">
          <description>Returns the name of the config file</description>
          <long-description></long-description>
          <tag name="return" description="name" line="580" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="589" package="configuration">
        <name>isWritable</name>
        <full_name>\LAMConfig::isWritable()</full_name>
        <docblock line="589">
          <description>Returns if the file can be written on the filesystem.</description>
          <long-description></long-description>
          <tag name="return" description="true if file is writable" line="589" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="598" package="configuration">
        <name>getPath</name>
        <full_name>\LAMConfig::getPath()</full_name>
        <docblock line="598">
          <description>Returns the path to the config file.</description>
          <long-description></long-description>
          <tag name="return" description="path on filesystem" line="598" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="609" package="configuration">
        <name>get_ServerURL</name>
        <full_name>\LAMConfig::get_ServerURL()</full_name>
        <docblock line="609">
          <description>Returns the server address as string</description>
          <long-description></long-description>
          <tag name="return" description="server address" line="609" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="619" package="configuration">
        <name>set_ServerURL</name>
        <full_name>\LAMConfig::set_ServerURL()</full_name>
        <docblock line="619">
          <description>Sets the server address</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;new server address&lt;/p&gt;" line="619" type="string" variable="$value">
            <type>string</type>
          </tag>
          <tag name="return" description="true if $value has correct format" line="619" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$value</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="630" package="configuration">
        <name>getUseTLS</name>
        <full_name>\LAMConfig::getUseTLS()</full_name>
        <docblock line="630">
          <description>Returns if TLS is activated.</description>
          <long-description></long-description>
          <tag name="return" description="yes or no" line="630" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="640" package="configuration">
        <name>setUseTLS</name>
        <full_name>\LAMConfig::setUseTLS()</full_name>
        <docblock line="640">
          <description>Sets if TLS is activated.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;yes or no&lt;/p&gt;" line="640" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="return" description="true if $useTLS has correct format" line="640" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$useTLS</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="654" package="configuration">
        <name>get_Admins</name>
        <full_name>\LAMConfig::get_Admins()</full_name>
        <docblock line="654">
          <description>Returns an array of string with all admin names</description>
          <long-description></long-description>
          <tag name="return" description="the admin names" line="654" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="663" package="configuration">
        <name>get_Adminstring</name>
        <full_name>\LAMConfig::get_Adminstring()</full_name>
        <docblock line="663">
          <description>Returns all admin users seperated by semicolons</description>
          <long-description></long-description>
          <tag name="return" description="the admin string" line="663" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="673" package="configuration">
        <name>set_Adminstring</name>
        <full_name>\LAMConfig::set_Adminstring()</full_name>
        <docblock line="673">
          <description>Sets the admin string</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;new admin string that contains all admin users seperated by semicolons&lt;/p&gt;" line="673" type="string" variable="$value">
            <type>string</type>
          </tag>
          <tag name="return" description="true if $value has correct format" line="673" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$value</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="688" package="configuration">
        <name>check_Passwd</name>
        <full_name>\LAMConfig::check_Passwd()</full_name>
        <docblock line="688">
          <description>Checks if the given password matches.</description>
          <long-description></long-description>
          <tag name="param" description="" line="688" type="String" variable="$password">
            <type>String</type>
          </tag>
          <tag name="return" description="true, if matches" line="688" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$password</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="708" package="configuration">
        <name>set_Passwd</name>
        <full_name>\LAMConfig::set_Passwd()</full_name>
        <docblock line="708">
          <description>Sets the preferences wizard password</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;new password&lt;/p&gt;" line="708" type="string" variable="$value">
            <type>string</type>
          </tag>
          <tag name="return" description="true if $value has correct format" line="708" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$value</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="729" package="configuration">
        <name>hashPassword</name>
        <full_name>\LAMConfig::hashPassword()</full_name>
        <docblock line="729">
          <description>Returns the hashed password.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;password&lt;/p&gt;" line="729" type="String" variable="$password">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;salt&lt;/p&gt;" line="729" type="String" variable="$salt">
            <type>String</type>
          </tag>
          <tag name="return" description="hash value" line="729" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$password</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$salt</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="739" package="configuration">
        <name>get_Suffix</name>
        <full_name>\LAMConfig::get_Suffix()</full_name>
        <docblock line="739">
          <description>Returns the LDAP suffix for the given account type</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="739" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="the LDAP suffix" line="739" type="string">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="755" package="configuration">
        <name>set_Suffix</name>
        <full_name>\LAMConfig::set_Suffix()</full_name>
        <docblock line="755">
          <description>Sets the LDAP suffix where accounts are saved</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="755" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;new LDAP suffix&lt;/p&gt;" line="755" type="string" variable="$value">
            <type>string</type>
          </tag>
          <tag name="return" description="true if $value has correct format" line="755" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$value</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="775" package="configuration">
        <name>get_listAttributes</name>
        <full_name>\LAMConfig::get_listAttributes()</full_name>
        <docblock line="775">
          <description>Returns the list of attributes to show in user list</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="775" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="the attribute list" line="775" type="string">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="786" package="configuration">
        <name>set_listAttributes</name>
        <full_name>\LAMConfig::set_listAttributes()</full_name>
        <docblock line="786">
          <description>Sets the list of attributes to show in user list</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;new attribute string&lt;/p&gt;" line="786" type="string" variable="$value">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="786" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="true if $value has correct format" line="786" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$value</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="801" package="configuration">
        <name>get_defaultLanguage</name>
        <full_name>\LAMConfig::get_defaultLanguage()</full_name>
        <docblock line="801">
          <description>Returns the default language string</description>
          <long-description></long-description>
          <tag name="return" description="default language" line="801" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="811" package="configuration">
        <name>set_defaultLanguage</name>
        <full_name>\LAMConfig::set_defaultLanguage()</full_name>
        <docblock line="811">
          <description>Sets the default language string</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;new default language&lt;/p&gt;" line="811" type="string" variable="$value">
            <type>string</type>
          </tag>
          <tag name="return" description="true if $value has correct format" line="811" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$value</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="822" package="configuration">
        <name>get_scriptPath</name>
        <full_name>\LAMConfig::get_scriptPath()</full_name>
        <docblock line="822">
          <description>Returns the path to the external script</description>
          <long-description></long-description>
          <tag name="return" description="script path" line="822" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="832" package="configuration">
        <name>set_scriptPath</name>
        <full_name>\LAMConfig::set_scriptPath()</full_name>
        <docblock line="832">
          <description>Sets the path to the external script</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;new script path&lt;/p&gt;" line="832" type="string" variable="$value">
            <type>string</type>
          </tag>
          <tag name="return" description="true if $value has correct format" line="832" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$value</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="844" package="configuration">
        <name>get_scriptServers</name>
        <full_name>\LAMConfig::get_scriptServers()</full_name>
        <docblock line="844">
          <description>Returns the servers of the external script as a Array</description>
          <long-description></long-description>
          <tag name="return" description="script servers" line="844" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="854" package="configuration">
        <name>set_scriptServers</name>
        <full_name>\LAMConfig::set_scriptServers()</full_name>
        <docblock line="854">
          <description>Sets the servers of the external script</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;new script servers&lt;/p&gt;" line="854" type="string" variable="$value">
            <type>string</type>
          </tag>
          <tag name="return" description="true if $value has correct format" line="854" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$value</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="909" package="configuration">
        <name>get_scriptRights</name>
        <full_name>\LAMConfig::get_scriptRights()</full_name>
        <docblock line="909">
          <description>Returns the chmod value for new home directories.</description>
          <long-description></long-description>
          <tag name="return" description="rights" line="909" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="920" package="configuration">
        <name>set_scriptRights</name>
        <full_name>\LAMConfig::set_scriptRights()</full_name>
        <docblock line="920">
          <description>Sets the rights for the home directory.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;the rights&lt;/p&gt;" line="920" type="string" variable="$chmod">
            <type>string</type>
          </tag>
          <tag name="return" description="true if values has correct format" line="920" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$chmod</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="936" package="configuration">
        <name>get_cacheTimeout</name>
        <full_name>\LAMConfig::get_cacheTimeout()</full_name>
        <docblock line="936">
          <description>Returns the LDAP cache timeout in minutes</description>
          <long-description></long-description>
          <tag name="return" description="cache time" line="936" type="integer">
            <type>integer</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="946" package="configuration">
        <name>get_cacheTimeoutSec</name>
        <full_name>\LAMConfig::get_cacheTimeoutSec()</full_name>
        <docblock line="946">
          <description>Returns the LDAP cache timeout in seconds</description>
          <long-description></long-description>
          <tag name="return" description="cache time" line="946" type="integer">
            <type>integer</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="956" package="configuration">
        <name>set_cacheTimeout</name>
        <full_name>\LAMConfig::set_cacheTimeout()</full_name>
        <docblock line="956">
          <description>Sets the LDAP cache timeout in minutes (0,1,2,5,10,15)</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;new cache timeout&lt;/p&gt;" line="956" type="integer" variable="$value">
            <type>integer</type>
          </tag>
          <tag name="return" description="true if $value has correct format" line="956" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$value</name>
          <default></default>
          <type>integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="969" package="configuration">
        <name>get_searchLimit</name>
        <full_name>\LAMConfig::get_searchLimit()</full_name>
        <docblock line="969">
          <description>Returns the LDAP search limit.</description>
          <long-description></long-description>
          <tag name="return" description="search limit" line="969" type="integer">
            <type>integer</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="979" package="configuration">
        <name>set_searchLimit</name>
        <full_name>\LAMConfig::set_searchLimit()</full_name>
        <docblock line="979">
          <description>Sets the LDAP search limit.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;new search limit&lt;/p&gt;" line="979" type="integer" variable="$value">
            <type>integer</type>
          </tag>
          <tag name="return" description="true if $value has correct format" line="979" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$value</name>
          <default></default>
          <type>integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="993" package="configuration">
        <name>get_AccountModules</name>
        <full_name>\LAMConfig::get_AccountModules()</full_name>
        <docblock line="993">
          <description>Returns an array of all selected account modules</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="993" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="user modules" line="993" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1016" package="configuration">
        <name>set_AccountModules</name>
        <full_name>\LAMConfig::set_AccountModules()</full_name>
        <docblock line="1016">
          <description>Sets the selected account modules</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;array with module names (not aliases!)&lt;/p&gt;&#10;" line="1016" type="array" variable="$modules">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="1016" type="string" variable="$scope">
            <type>string</type>
          </tag>
          <tag name="return" description="true if $modules has correct format" line="1016" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$modules</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1036" package="configuration">
        <name>set_moduleSettings</name>
        <full_name>\LAMConfig::set_moduleSettings()</full_name>
        <docblock line="1036">
          <description>Sets the settings for the account modules.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of module setting array(name =&gt; value)&lt;/p&gt;&#10;" line="1036" type="array" variable="$settings">
            <type>array</type>
          </tag>
          <tag name="return" description="true if $settings has correct format" line="1036" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$settings</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1047" package="configuration">
        <name>get_moduleSettings</name>
        <full_name>\LAMConfig::get_moduleSettings()</full_name>
        <docblock line="1047">
          <description>Returns a list of saved module settings</description>
          <long-description></long-description>
          <tag name="return" description="list of settings: array(name =&amp;gt; value)" line="1047" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1056" package="configuration">
        <name>get_ActiveTypes</name>
        <full_name>\LAMConfig::get_ActiveTypes()</full_name>
        <docblock line="1056">
          <description>Returns a list of active account types.</description>
          <long-description></long-description>
          <tag name="return" description="list of types" line="1056" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1066" package="configuration">
        <name>set_ActiveTypes</name>
        <full_name>\LAMConfig::set_ActiveTypes()</full_name>
        <docblock line="1066">
          <description>Sets the list of active types.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of types&lt;/p&gt;" line="1066" type="array" variable="">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$types</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1076" package="configuration">
        <name>set_typeSettings</name>
        <full_name>\LAMConfig::set_typeSettings()</full_name>
        <docblock line="1076">
          <description>Sets the settings for the account types.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of type setting array(name =&gt; value)&lt;/p&gt;&#10;" line="1076" type="array" variable="$settings">
            <type>array</type>
          </tag>
          <tag name="return" description="true if $settings has correct format" line="1076" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$settings</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1087" package="configuration">
        <name>get_typeSettings</name>
        <full_name>\LAMConfig::get_typeSettings()</full_name>
        <docblock line="1087">
          <description>Returns a list of saved type settings</description>
          <long-description></long-description>
          <tag name="return" description="list of settings: array(name =&amp;gt; value)" line="1087" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1096" package="configuration">
        <name>getToolSettings</name>
        <full_name>\LAMConfig::getToolSettings()</full_name>
        <docblock line="1096">
          <description>Returns the tool settings.</description>
          <long-description></long-description>
          <tag name="return" description="$toolSettings tool settings" line="1096" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1106" package="configuration">
        <name>setToolSettings</name>
        <full_name>\LAMConfig::setToolSettings()</full_name>
        <docblock line="1106">
          <description>Sets the tool settings.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;tool settings&lt;/p&gt;" line="1106" type="array" variable="$toolSettings">
            <type>array</type>
          </tag>
          <tag name="return" description="true if ok" line="1106" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$toolSettings</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1117" package="configuration">
        <name>getAccessLevel</name>
        <full_name>\LAMConfig::getAccessLevel()</full_name>
        <docblock line="1117">
          <description>Returns the access level for this profile.</description>
          <long-description></long-description>
          <tag name="return" description="level" line="1117" type="int">
            <type>int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1126" package="configuration">
        <name>setAccessLevel</name>
        <full_name>\LAMConfig::setAccessLevel()</full_name>
        <docblock line="1126">
          <description>Sets the access level for this profile.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;level&lt;/p&gt;" line="1126" type="int" variable="$level">
            <type>int</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$level</name>
          <default></default>
          <type>int</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1137" package="configuration">
        <name>getLoginMethod</name>
        <full_name>\LAMConfig::getLoginMethod()</full_name>
        <docblock line="1137">
          <description>Returns the login method.</description>
          <long-description></long-description>
          <tag name="return" description="login method" line="1137" type="String">
            <type>String</type>
          </tag>
          <tag name="see" description="" line="1137"/>
          <tag name="see" description="" line="1137"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1146" package="configuration">
        <name>setLoginMethod</name>
        <full_name>\LAMConfig::setLoginMethod()</full_name>
        <docblock line="1146">
          <description>Sets the login method.</description>
          <long-description></long-description>
          <tag name="param" description="" line="1146" type="String" variable="$loginMethod">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$loginMethod</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1155" package="configuration">
        <name>getLoginSearchFilter</name>
        <full_name>\LAMConfig::getLoginSearchFilter()</full_name>
        <docblock line="1155">
          <description>Returns the login search filter.</description>
          <long-description></long-description>
          <tag name="return" description="search filter" line="1155" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1164" package="configuration">
        <name>setLoginSearchFilter</name>
        <full_name>\LAMConfig::setLoginSearchFilter()</full_name>
        <docblock line="1164">
          <description>Sets the login search filter.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;search filter&lt;/p&gt;" line="1164" type="String" variable="$loginSearchFilter">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$loginSearchFilter</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1173" package="configuration">
        <name>getLoginSearchSuffix</name>
        <full_name>\LAMConfig::getLoginSearchSuffix()</full_name>
        <docblock line="1173">
          <description>Returns the login search suffix.</description>
          <long-description></long-description>
          <tag name="return" description="suffix" line="1173" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1182" package="configuration">
        <name>setLoginSearchSuffix</name>
        <full_name>\LAMConfig::setLoginSearchSuffix()</full_name>
        <docblock line="1182">
          <description>Sets the login search suffix.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;suffix&lt;/p&gt;" line="1182" type="String" variable="$loginSearchSuffix">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$loginSearchSuffix</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1192" package="configuration">
        <name>setLoginSearchDN</name>
        <full_name>\LAMConfig::setLoginSearchDN()</full_name>
        <docblock line="1192">
          <description>Sets the DN for the login search bind user.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;DN&lt;/p&gt;" line="1192" type="String" variable="$loginSearchDN">
            <type>String</type>
          </tag>
          <tag name="return" description="true if DN is valid" line="1192" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$loginSearchDN</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1205" package="configuration">
        <name>getLoginSearchDN</name>
        <full_name>\LAMConfig::getLoginSearchDN()</full_name>
        <docblock line="1205">
          <description>Returns the DN for the login search bind user.</description>
          <long-description></long-description>
          <tag name="return" description="DN" line="1205" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1214" package="configuration">
        <name>setLoginSearchPassword</name>
        <full_name>\LAMConfig::setLoginSearchPassword()</full_name>
        <docblock line="1214">
          <description>Sets the password for the login search bind user.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;password&lt;/p&gt;" line="1214" type="String" variable="$loginSearchPassword">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$loginSearchPassword</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1223" package="configuration">
        <name>getLoginSearchPassword</name>
        <full_name>\LAMConfig::getLoginSearchPassword()</full_name>
        <docblock line="1223">
          <description>Returns the password for the login search bind user.</description>
          <long-description></long-description>
          <tag name="return" description="password" line="1223" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1232" package="configuration">
        <name>getHttpAuthentication</name>
        <full_name>\LAMConfig::getHttpAuthentication()</full_name>
        <docblock line="1232">
          <description>Returns if HTTP authentication should be used.</description>
          <long-description></long-description>
          <tag name="return" description="$httpAuthentication use HTTP authentication (&amp;#039;true&amp;#039; or &amp;#039;false&amp;#039;)" line="1232" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1241" package="configuration">
        <name>setHttpAuthentication</name>
        <full_name>\LAMConfig::setHttpAuthentication()</full_name>
        <docblock line="1241">
          <description>Specifies if HTTP authentication should be used.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;use HTTP authentication ('true' or 'false')&lt;/p&gt;&#10;" line="1241" type="String" variable="$httpAuthentication">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$httpAuthentication</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1250" package="configuration">
        <name>getLamProMailFrom</name>
        <full_name>\LAMConfig::getLamProMailFrom()</full_name>
        <docblock line="1250">
          <description>Returns the sender address for password reset mails.</description>
          <long-description></long-description>
          <tag name="return" description="mail address" line="1250" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1260" package="configuration">
        <name>setLamProMailFrom</name>
        <full_name>\LAMConfig::setLamProMailFrom()</full_name>
        <docblock line="1260">
          <description>Sets the sender address for password reset mails.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;mail address&lt;/p&gt;" line="1260" type="String" variable="$lamProMailFrom">
            <type>String</type>
          </tag>
          <tag name="return" description="true if address is valid" line="1260" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$lamProMailFrom</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1273" package="configuration">
        <name>getLamProMailReplyTo</name>
        <full_name>\LAMConfig::getLamProMailReplyTo()</full_name>
        <docblock line="1273">
          <description>Returns the reply-to address for password reset mails.</description>
          <long-description></long-description>
          <tag name="return" description="mail address" line="1273" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1283" package="configuration">
        <name>setLamProMailReplyTo</name>
        <full_name>\LAMConfig::setLamProMailReplyTo()</full_name>
        <docblock line="1283">
          <description>Sets the reply-to address for password reset mails.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;mail address&lt;/p&gt;" line="1283" type="String" variable="$lamProMailReplyTo">
            <type>String</type>
          </tag>
          <tag name="return" description="true if address is valid" line="1283" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$lamProMailReplyTo</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1296" package="configuration">
        <name>getLamProMailSubject</name>
        <full_name>\LAMConfig::getLamProMailSubject()</full_name>
        <docblock line="1296">
          <description>Returns the subject for password reset mails.</description>
          <long-description></long-description>
          <tag name="return" description="subject" line="1296" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1305" package="configuration">
        <name>setLamProMailSubject</name>
        <full_name>\LAMConfig::setLamProMailSubject()</full_name>
        <docblock line="1305">
          <description>Sets the subject for password reset mails.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;subject&lt;/p&gt;" line="1305" type="String" variable="$lamProMailSubject">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$lamProMailSubject</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1314" package="configuration">
        <name>getLamProMailIsHTML</name>
        <full_name>\LAMConfig::getLamProMailIsHTML()</full_name>
        <docblock line="1314">
          <description>Returns if the password reset mail content should be treated as HTML.</description>
          <long-description></long-description>
          <tag name="return" description="HTML or text" line="1314" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1323" package="configuration">
        <name>setLamProMailIsHTML</name>
        <full_name>\LAMConfig::setLamProMailIsHTML()</full_name>
        <docblock line="1323">
          <description>Sets if the password reset mail content should be treated as HTML.</description>
          <long-description></long-description>
          <tag name="param" description="" line="1323" type="boolean" variable="$lamProMailIsHTML">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$lamProMailIsHTML</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1332" package="configuration">
        <name>getLamProMailText</name>
        <full_name>\LAMConfig::getLamProMailText()</full_name>
        <docblock line="1332">
          <description>Returns the mail body for password reset mails.</description>
          <long-description></long-description>
          <tag name="return" description="body" line="1332" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1341" package="configuration">
        <name>setLamProMailText</name>
        <full_name>\LAMConfig::setLamProMailText()</full_name>
        <docblock line="1341">
          <description>Sets the mail body for password reset mails.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;body&lt;/p&gt;" line="1341" type="String" variable="$lamProMailText">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$lamProMailText</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="1353" package="configuration">
      <extends/>
      <name>LAMCfgMain</name>
      <full_name>\LAMCfgMain</full_name>
      <docblock line="1353">
        <description>This class manages config.cfg.</description>
        <long-description></long-description>
        <tag name="package" description="configuration" line="1353"/>
      </docblock>
      <property static="false" visibility="public" line="1356" namespace="" package="configuration">
        <name>$default</name>
        <default></default>
        <docblock line="1356">
          <description>Default profile</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1359" namespace="" package="configuration">
        <name>$password</name>
        <default></default>
        <docblock line="1359">
          <description>Password to change config.cfg</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="1362" namespace="" package="configuration">
        <name>$sessionTimeout</name>
        <default></default>
        <docblock line="1362">
          <description>Time of inactivity before session times out (minutes)</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="1365" namespace="" package="configuration">
        <name>$logLevel</name>
        <default></default>
        <docblock line="1365">
          <description>log level</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="1368" namespace="" package="configuration">
        <name>$logDestination</name>
        <default></default>
        <docblock line="1368">
          <description>log destination ("SYSLOG":syslog, "/.</description>
          <long-description>..":file, "NONE":none)</long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="1371" namespace="" package="configuration">
        <name>$allowedHosts</name>
        <default></default>
        <docblock line="1371">
          <description>list of hosts which may access LAM</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="1374" namespace="" package="configuration">
        <name>$passwordMinLength</name>
        <default>0</default>
        <docblock line="1374">
          <description>minimum length for passwords</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="1377" namespace="" package="configuration">
        <name>$passwordMinUpper</name>
        <default>0</default>
        <docblock line="1377">
          <description>minimum uppercase characters</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="1380" namespace="" package="configuration">
        <name>$passwordMinLower</name>
        <default>0</default>
        <docblock line="1380">
          <description>minimum lowercase characters</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="1383" namespace="" package="configuration">
        <name>$passwordMinNumeric</name>
        <default>0</default>
        <docblock line="1383">
          <description>minimum numeric characters</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="1386" namespace="" package="configuration">
        <name>$passwordMinSymbol</name>
        <default>0</default>
        <docblock line="1386">
          <description>minimum symbol characters</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="1389" namespace="" package="configuration">
        <name>$passwordMinClasses</name>
        <default>0</default>
        <docblock line="1389">
          <description>minimum character classes (upper, lower, numeric, symbols)</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1392" namespace="" package="configuration">
        <name>$conffile</name>
        <default></default>
        <docblock line="1392">
          <description>path to config file</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1395" namespace="" package="configuration">
        <name>$uploadedSSLCaCert</name>
        <default>null</default>
        <docblock line="1395">
          <description>uploaded SSL certificate that is stored to disk on save()</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1398" namespace="" package="configuration">
        <name>$delSSLCaCert</name>
        <default>false</default>
        <docblock line="1398">
          <description>SSL certificate should be deleted on save()</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1401" namespace="" package="configuration">
        <name>$settings</name>
        <default>array("password", "default", "sessionTimeout", "logLevel", "logDestination", "allowedHosts", "passwordMinLength", "passwordMinUpper", "passwordMinLower", "passwordMinNumeric", "passwordMinClasses", "passwordMinSymbol")</default>
        <docblock line="1401">
          <description>list of data fields to save in config file</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1409" package="configuration">
        <name>__construct</name>
        <full_name>\LAMCfgMain::__construct()</full_name>
        <docblock line="1409">
          <description>Loads preferences from config file</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1424" package="configuration">
        <name>reload</name>
        <full_name>\LAMCfgMain::reload()</full_name>
        <docblock line="1424">
          <description>Reloads preferences from config file config.cfg</description>
          <long-description></long-description>
          <tag name="return" description="true if file was readable" line="1424" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1450" package="configuration">
        <name>save</name>
        <full_name>\LAMCfgMain::save()</full_name>
        <docblock line="1450">
          <description>Saves preferences to config file config.cfg</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1525" package="configuration">
        <name>setPassword</name>
        <full_name>\LAMCfgMain::setPassword()</full_name>
        <docblock line="1525">
          <description>Sets a new config password.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;new password&lt;/p&gt;" line="1525" type="String" variable="$password">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$password</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1539" package="configuration">
        <name>checkPassword</name>
        <full_name>\LAMCfgMain::checkPassword()</full_name>
        <docblock line="1539">
          <description>Checks if the given password matches.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;password&lt;/p&gt;" line="1539" type="String" variable="$password">
            <type>String</type>
          </tag>
          <tag name="return" description="true, if password matches" line="1539" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$password</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1560" package="configuration">
        <name>hashPassword</name>
        <full_name>\LAMCfgMain::hashPassword()</full_name>
        <docblock line="1560">
          <description>Returns the hashed password.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;password&lt;/p&gt;" line="1560" type="String" variable="$password">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;salt&lt;/p&gt;" line="1560" type="String" variable="$salt">
            <type>String</type>
          </tag>
          <tag name="return" description="hash value" line="1560" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$password</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$salt</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1569" package="configuration">
        <name>isWritable</name>
        <full_name>\LAMCfgMain::isWritable()</full_name>
        <docblock line="1569">
          <description>Returns if the configuration file is writable.</description>
          <long-description></long-description>
          <tag name="return" description="writable" line="1569" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1578" package="configuration">
        <name>isConfigFileExisting</name>
        <full_name>\LAMCfgMain::isConfigFileExisting()</full_name>
        <docblock line="1578">
          <description>Returns if the configuration file is existing.</description>
          <long-description></long-description>
          <tag name="return" description="exists" line="1578" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1587" package="configuration">
        <name>getSSLCaCertPath</name>
        <full_name>\LAMCfgMain::getSSLCaCertPath()</full_name>
        <docblock line="1587">
          <description>Returns the path to the SSL CA certificate file that overrides the system certificates.</description>
          <long-description></long-description>
          <tag name="return" description="path to certificate file or null if certificate is not overridden" line="1587" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1600" package="configuration">
        <name>getInternalSSLCaCertFileName</name>
        <full_name>\LAMCfgMain::getInternalSSLCaCertFileName()</full_name>
        <docblock line="1600">
          <description>Returns the file name that will be used internally to store the CA file.</description>
          <long-description></long-description>
          <tag name="return" description="file name" line="1600" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1610" package="configuration">
        <name>uploadSSLCaCert</name>
        <full_name>\LAMCfgMain::uploadSSLCaCert()</full_name>
        <docblock line="1610">
          <description>Uploads a new SSL CA cert.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;file content in DER/PEM format&lt;/p&gt;&#10;" line="1610" type="String" variable="$cert">
            <type>String</type>
          </tag>
          <tag name="return" description="TRUE if format is correct, error message if file is not accepted" line="1610" type="mixed">
            <type>mixed</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$cert</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1639" package="configuration">
        <name>getSSLCaCertTempFileName</name>
        <full_name>\LAMCfgMain::getSSLCaCertTempFileName()</full_name>
        <docblock line="1639">
          <description>Returns the name of a temporary file in tmp that contains the SSL certificate.</description>
          <long-description>The file contains either the stored data in serverCerts or the uploaded data.</long-description>
          <tag name="return" description="file name or null if no certificate was set" line="1639" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1669" package="configuration">
        <name>deleteSSLCaCert</name>
        <full_name>\LAMCfgMain::deleteSSLCaCert()</full_name>
        <docblock line="1669">
          <description>Marks a single or all SSL CA certificate files for deletion.</description>
          <long-description>The changes take effect on save().</long-description>
          <tag name="param" description="&lt;p&gt;certificate index, null deletes all certificates (default: null)&lt;/p&gt;&#10;" line="1669" type="int" variable="$index">
            <type>int</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$index</name>
          <default>null</default>
          <type>int</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1692" package="configuration">
        <name>getSSLCaCertificates</name>
        <full_name>\LAMCfgMain::getSSLCaCertificates()</full_name>
        <docblock line="1692">
          <description>Returns a list of all CA certificates.</description>
          <long-description></long-description>
          <tag name="return" description="list of certificates as output of openssl_x509_parse()" line="1692" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1712" package="configuration">
        <name>getSSLCaCertificateContent</name>
        <full_name>\LAMCfgMain::getSSLCaCertificateContent()</full_name>
        <docblock line="1712">
          <description>Returns the content of the certificate file or uploaded data.</description>
          <long-description></long-description>
          <tag name="return" description="null or certificate content" line="1712" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1737" package="configuration">
        <name>splitSSLCaCertificateContent</name>
        <full_name>\LAMCfgMain::splitSSLCaCertificateContent()</full_name>
        <docblock line="1737">
          <description>Splits the certificate content into single PEM data chunks.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;PEM file content&lt;/p&gt;" line="1737" type="String" variable="$content">
            <type>String</type>
          </tag>
          <tag name="return" description="one element for each certificate chunk" line="1737" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$content</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/ufpdf.php" generated-path="lib.ufpdf.html" hash="5c65c26a80d0335242c25be28495d1d4" package="PDF">
    <docblock line="0">
      <description>This file includes UFPDF which adds Unicode support to FPDF.</description>
      <long-description></long-description>
      <tag name="author" description="Steven Wittens" line="0"/>
      <tag name="author" description="Andrea Rossato" line="0"/>
      <tag name="package" description="PDF" line="0"/>
    </docblock>
    <constant namespace="" line="27" package="PDF">
      <name>UFPDF_VERSION</name>
      <full_name>\\UFPDF_VERSION</full_name>
      <value>'0.1'</value>
      <docblock line="27">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <class final="false" abstract="false" namespace="" line="35" package="PDF">
      <extends>\FPDF</extends>
      <name>UFPDF</name>
      <full_name>\UFPDF</full_name>
      <docblock line="35">
        <description>Main UFPDF class for creating Unicode PDF documents</description>
        <long-description></long-description>
        <tag name="package" description="PDF" line="35"/>
        <tag name="see" description="" line="35"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="43" package="PDF">
        <name>UFPDF</name>
        <full_name>\UFPDF::UFPDF()</full_name>
        <docblock line="43">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$orientation</name>
          <default>'P'</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$unit</name>
          <default>'mm'</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$format</name>
          <default>'A4'</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="48" package="PDF">
        <name>GetStringWidth</name>
        <full_name>\UFPDF::GetStringWidth()</full_name>
        <docblock line="48">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$s</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="71" package="PDF">
        <name>AddFont</name>
        <full_name>\UFPDF::AddFont()</full_name>
        <docblock line="71">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$family</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$style</name>
          <default>''</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$file</name>
          <default>''</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="100" package="PDF">
        <name>Text</name>
        <full_name>\UFPDF::Text()</full_name>
        <docblock line="100">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$x</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$y</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$txt</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="111" package="PDF">
        <name>AcceptPageBreak</name>
        <full_name>\UFPDF::AcceptPageBreak()</full_name>
        <docblock line="111">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="117" package="PDF">
        <name>Cell</name>
        <full_name>\UFPDF::Cell()</full_name>
        <docblock line="117">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$w</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$h</name>
          <default>0</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$txt</name>
          <default>''</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$border</name>
          <default>0</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$ln</name>
          <default>0</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$align</name>
          <default>'J'</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$fill</name>
          <default>0</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$link</name>
          <default>''</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="197" package="PDF">
        <name>MultiCell</name>
        <full_name>\UFPDF::MultiCell()</full_name>
        <docblock line="197">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$w</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$h</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$txt</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$border</name>
          <default>0</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$align</name>
          <default>'J'</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$fill</name>
          <default>0</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="322" package="PDF">
        <name>Write</name>
        <full_name>\UFPDF::Write()</full_name>
        <docblock line="322">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$h</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$txt</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$link</name>
          <default>''</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="405" package="PDF">
        <name>AliasNbPages</name>
        <full_name>\UFPDF::AliasNbPages()</full_name>
        <docblock line="405">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$alias</name>
          <default>'{nb}'</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="417" package="PDF">
        <name>_puttruetypeunicode</name>
        <full_name>\UFPDF::_puttruetypeunicode()</full_name>
        <docblock line="417">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$font</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="479" package="PDF">
        <name>_dounderlineU</name>
        <full_name>\UFPDF::_dounderlineU()</full_name>
        <docblock line="479">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$x</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$y</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$width</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$txt</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="488" package="PDF">
        <name>_textstring</name>
        <full_name>\UFPDF::_textstring()</full_name>
        <docblock line="488">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$s</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="496" package="PDF">
        <name>_escapetext</name>
        <full_name>\UFPDF::_escapetext()</full_name>
        <docblock line="496">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$s</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="504" package="PDF">
        <name>_putinfo</name>
        <full_name>\UFPDF::_putinfo()</full_name>
        <docblock line="504">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="520" package="PDF">
        <name>_putpages</name>
        <full_name>\UFPDF::_putpages()</full_name>
        <docblock line="520">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="595" package="PDF">
        <name>utf8_to_utf16be</name>
        <full_name>\UFPDF::utf8_to_utf16be()</full_name>
        <docblock line="595">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$txt</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$bom</name>
          <default>true</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="695" package="PDF">
        <name>code2utf</name>
        <full_name>\UFPDF::code2utf()</full_name>
        <docblock line="695">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$num</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="703" package="PDF">
        <name>strlen</name>
        <full_name>\UFPDF::strlen()</full_name>
        <docblock line="703">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$s</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="707" package="PDF">
        <name>utf8_substr</name>
        <full_name>\UFPDF::utf8_substr()</full_name>
        <docblock line="707">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$str</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$start</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="725" package="PDF">
        <name>utf8_to_codepoints</name>
        <full_name>\UFPDF::utf8_to_codepoints()</full_name>
        <docblock line="725">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$txt</name>
          <default></default>
          <type/>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/kolabGroup.inc" generated-path="lib.modules.kolabGroup.inc.html" hash="a273e13c69fffa7b9c62a0dab9c3dcdb" package="modules">
    <docblock line="0">
      <description>Manages Kolab group accounts.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="35" package="modules">
      <extends>\baseModule</extends>
      <name>kolabGroup</name>
      <full_name>\kolabGroup</full_name>
      <docblock line="35">
        <description>Manages Kolab group accounts.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="35"/>
      </docblock>
      <property static="false" visibility="private" line="38" namespace="" package="modules">
        <name>$mailCache</name>
        <default>null</default>
        <docblock line="38">
          <description>cache for mail attribute</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="40" namespace="" package="modules">
        <name>$mailHostCache</name>
        <default>null</default>
        <docblock line="40">
          <description>cache for mailHost values</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="47" package="modules">
        <name>__construct</name>
        <full_name>\kolabGroup::__construct()</full_name>
        <docblock line="47">
          <description>Creates a new kolabGroup object.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account type (user, group, host)&lt;/p&gt;&#10;" line="47" type="string" variable="$scope">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="60" package="modules">
        <name>get_metaData</name>
        <full_name>\kolabGroup::get_metaData()</full_name>
        <docblock line="60">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="60" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="60"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="157" package="modules">
        <name>load_Messages</name>
        <full_name>\kolabGroup::load_Messages()</full_name>
        <docblock line="157">
          <description>This function fills the $messages variable with output messages from this module.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="173" package="modules">
        <name>display_html_attributes</name>
        <full_name>\kolabGroup::display_html_attributes()</full_name>
        <docblock line="173">
          <description>Returns the HTML meta data for the main account page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="173" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="212" package="modules">
        <name>process_attributes</name>
        <full_name>\kolabGroup::process_attributes()</full_name>
        <docblock line="212">
          <description>Processes user input of the primary module page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="212" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="264" package="modules">
        <name>display_html_delete</name>
        <full_name>\kolabGroup::display_html_delete()</full_name>
        <docblock line="264">
          <description>This function will create the meta HTML code to show a page to mark an account for deletion.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="264" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="283" package="modules">
        <name>process_delete</name>
        <full_name>\kolabGroup::process_delete()</full_name>
        <docblock line="283">
          <description>Write variables into object and do some regex checks</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="302" package="modules">
        <name>save_attributes</name>
        <full_name>\kolabGroup::save_attributes()</full_name>
        <docblock line="302">
          <description>Returns a list of modifications which have to be made to the LDAP account.</description>
          <long-description></long-description>
          <tag name="return" description="list of modifications&#10;&amp;lt;br&amp;gt;This function returns an array with 3 entries:&#10;&amp;lt;br&amp;gt;array( DN1 (&amp;#039;add&amp;#039; =&amp;gt; array($attr), &amp;#039;remove&amp;#039; =&amp;gt; array($attr), &amp;#039;modify&amp;#039; =&amp;gt; array($attr)), DN2 .... )&#10;&amp;lt;br&amp;gt;DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)&#10;&amp;lt;br&amp;gt;&amp;quot;add&amp;quot; are attributes which have to be added to LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;remove&amp;quot; are attributes which have to be removed from LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;modify&amp;quot; are attributes which have to been modified in LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;info&amp;quot; are values with informational value (e.g. to be used later by pre/postModify actions)" line="302" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="315" package="modules">
        <name>load_profile</name>
        <full_name>\kolabGroup::load_profile()</full_name>
        <docblock line="315">
          <description>Loads the values of an account profile into internal variables.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;hash array with profile values (identifier =&gt; value)&lt;/p&gt;&#10;" line="315" type="array" variable="$profile">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$profile</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="335" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>\kolabGroup::build_uploadAccounts()</full_name>
        <docblock line="335">
          <description>In this function the LDAP account is built up.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) from user input&lt;/p&gt;&#10;" line="335" type="array" variable="$rawAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)&lt;/p&gt;&#10;" line="335" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) which are later added to LDAP&lt;/p&gt;&#10;" line="335" type="array" variable="$partialAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="335" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages if any" line="335" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rawAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$partialAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="398" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\kolabGroup::get_pdfEntries()</full_name>
        <docblock line="398">
          <description>Returns a list of PDF entries</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="411" package="modules">
        <name>manageMail</name>
        <full_name>\kolabGroup::manageMail()</full_name>
        <docblock line="411">
          <description>Returns if the mail attribute should be managed.</description>
          <long-description></long-description>
          <tag name="return" description="manage mail attribute" line="411" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="427" package="modules">
        <name>loadMailCache</name>
        <full_name>\kolabGroup::loadMailCache()</full_name>
        <docblock line="427">
          <description>Loads the list of email addresses into the cache.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="443" package="modules">
        <name>loadMailHostCache</name>
        <full_name>\kolabGroup::loadMailHostCache()</full_name>
        <docblock line="443">
          <description>Loads the list of mail hosts into the cache.</description>
          <long-description></long-description>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/asteriskAccount.inc" generated-path="lib.modules.asteriskAccount.inc.html" hash="53af8bf48c1b4e24bbc23ff4761ca8e4" package="modules">
    <docblock line="0">
      <description>Manages the Asterisk extension of user accounts.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Pavel Pozdnyak" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="40" package="modules">
      <extends>\baseModule</extends>
      <implements>\passwordService</implements>
      <name>asteriskAccount</name>
      <full_name>\asteriskAccount</full_name>
      <docblock line="40">
        <description>Manages the Asterisk extension of user accounts.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="40"/>
      </docblock>
      <constant namespace="" line="42" package="modules">
        <name>ASTERISK_DEFAULT_REALM</name>
        <full_name>\asteriskAccount::ASTERISK_DEFAULT_REALM</full_name>
        <value>"asterisk"</value>
        <docblock line="42">
          <description></description>
          <long-description></long-description>
        </docblock>
      </constant>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="49" package="modules">
        <name>__construct</name>
        <full_name>\asteriskAccount::__construct()</full_name>
        <docblock line="49">
          <description>Creates a new asteriskAccount object.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account type (user, group, host)&lt;/p&gt;&#10;" line="49" type="string" variable="$scope">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="60" package="modules">
        <name>get_metaData</name>
        <full_name>\asteriskAccount::get_metaData()</full_name>
        <docblock line="60">
          <description>Returns meta data that is interpreted by parent class.</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="60" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="616" package="modules">
        <name>load_Messages</name>
        <full_name>\asteriskAccount::load_Messages()</full_name>
        <docblock line="616">
          <description>This function fills the error message array with messages</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="647" package="modules">
        <name>display_html_attributes</name>
        <full_name>\asteriskAccount::display_html_attributes()</full_name>
        <docblock line="647">
          <description>Returns the HTML meta data for the main account page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="647" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="976" package="modules">
        <name>process_attributes</name>
        <full_name>\asteriskAccount::process_attributes()</full_name>
        <docblock line="976">
          <description>Write variables into object and do some regex checks</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1176" package="modules">
        <name>save_attributes</name>
        <full_name>\asteriskAccount::save_attributes()</full_name>
        <docblock line="1176">
          <description>Returns a list of modifications which have to be made to the LDAP account.</description>
          <long-description></long-description>
          <tag name="return" description="list of modifications&#10;&amp;lt;br&amp;gt;This function returns an array with 3 entries:&#10;&amp;lt;br&amp;gt;array( DN1 (&amp;#039;add&amp;#039; =&amp;gt; array($attr), &amp;#039;remove&amp;#039; =&amp;gt; array($attr), &amp;#039;modify&amp;#039; =&amp;gt; array($attr)), DN2 .... )&#10;&amp;lt;br&amp;gt;DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)&#10;&amp;lt;br&amp;gt;&amp;quot;add&amp;quot; are attributes which have to be added to LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;remove&amp;quot; are attributes which have to be removed from LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;modify&amp;quot; are attributes which have to been modified in LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;info&amp;quot; are values with informational value (e.g. to be used later by pre/postModify actions)" line="1176" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1186" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\asteriskAccount::get_pdfEntries()</full_name>
        <docblock line="1186">
          <description>Returns a list of PDF entries</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1233" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>\asteriskAccount::build_uploadAccounts()</full_name>
        <docblock line="1233">
          <description>In this function the LDAP account is built up.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) from user input&lt;/p&gt;&#10;" line="1233" type="array" variable="$rawAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)&lt;/p&gt;&#10;" line="1233" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) which are later added to LDAP&lt;/p&gt;&#10;" line="1233" type="array" variable="$partialAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="1233" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages if any" line="1233" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rawAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$partialAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1447" package="modules">
        <name>managesPasswordAttributes</name>
        <full_name>\asteriskAccount::managesPasswordAttributes()</full_name>
        <docblock line="1447">
          <description>This method specifies if a module manages password attributes.</description>
          <long-description></long-description>
          <tag name="see" description="" line="1447"/>
          <tag name="return" description="true if this module manages password attributes" line="1447" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1459" package="modules">
        <name>supportsForcePasswordChange</name>
        <full_name>\asteriskAccount::supportsForcePasswordChange()</full_name>
        <docblock line="1459">
          <description>Specifies if this module supports to force that a user must change his password on next login.</description>
          <long-description></long-description>
          <tag name="return" description="force password change supported" line="1459" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1474" package="modules">
        <name>passwordChangeRequested</name>
        <full_name>\asteriskAccount::passwordChangeRequested()</full_name>
        <docblock line="1474">
          <description>This function is called whenever the password should be changed. Account modules
must change their password attributes only if the modules list contains their module name.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;new password&lt;/p&gt;" line="1474" type="String" variable="$password">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of modules for which the password should be changed&lt;/p&gt;" line="1474" type="" variable="$modules"/>
          <tag name="param" description="&lt;p&gt;force the user to change his password at next login&lt;/p&gt;" line="1474" type="boolean" variable="$forcePasswordChange">
            <type>boolean</type>
          </tag>
          <tag name="return" description="list of error messages if any as parameter array for StatusMessage&#10;&#9;&#9;   e.g. return arrray(array(&amp;#039;ERROR&amp;#039;, &amp;#039;Password change failed.&amp;#039;))" line="1474" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="1474"/>
        </docblock>
        <argument line="0">
          <name>$password</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$modules</name>
          <default></default>
          <type>mixed</type>
        </argument>
        <argument line="0">
          <name>$forcePasswordChange</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="1490" package="modules">
        <name>buildPasswordString</name>
        <full_name>\asteriskAccount::buildPasswordString()</full_name>
        <docblock line="1490">
          <description>Builds the password string for the password attribute.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="1490" type="array" variable="$attributes">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;module configuration settings&lt;/p&gt;" line="1490" type="array" variable="$moduleSettings">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;password&lt;/p&gt;" line="1490" type="String" variable="$password">
            <type>String</type>
          </tag>
          <tag name="return" description="value for password attribute" line="1490" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$moduleSettings</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$password</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="private" namespace="" line="1505" package="modules">
        <name>hashPassword</name>
        <full_name>\asteriskAccount::hashPassword()</full_name>
        <docblock line="1505">
          <description>Hashes a password value to Asterisk format.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;password&lt;/p&gt;" line="1505" type="String" variable="$password">
            <type>String</type>
          </tag>
          <tag name="return" description="hash" line="1505" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$password</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1526" package="modules">
        <name>checkSelfServiceOptions</name>
        <full_name>\asteriskAccount::checkSelfServiceOptions()</full_name>
        <docblock line="1526">
          <description>Checks if all input values are correct and returns the LDAP attributes which should be changed.</description>
          <long-description>&lt;br&gt;Return values:
&lt;br&gt;messages: array of parameters to create status messages
&lt;br&gt;add: array of attributes to add
&lt;br&gt;del: array of attributes to remove
&lt;br&gt;mod: array of attributes to modify
&lt;br&gt;info: array of values with informational value (e.g. to be used later by pre/postModify actions)

Calling this method does not require the existence of an enclosing {@link accountContainer}.</long-description>
          <tag name="param" description="&lt;p&gt;input fields&lt;/p&gt;" line="1526" type="string" variable="$fields">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="1526" type="array" variable="$attributes">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;indicates that the user is only allowed to change his password and no LDAP content is readable&lt;/p&gt;" line="1526" type="boolean" variable="$passwordChangeOnly">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of read-only fields&lt;/p&gt;&#10;" line="1526" type="array" variable="$readOnlyFields">
            <type>array</type>
          </tag>
          <tag name="return" description="messages and attributes (array(&amp;#039;messages&amp;#039; =&amp;gt; array(), &amp;#039;add&amp;#039; =&amp;gt; array(&amp;#039;mail&amp;#039; =&amp;gt; array(&amp;#039;test@test.com&amp;#039;)), &amp;#039;del&amp;#039; =&amp;gt; array(), &amp;#039;mod&amp;#039; =&amp;gt; array(), &amp;#039;info&amp;#039; =&amp;gt; array()))" line="1526" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$fields</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$passwordChangeOnly</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$readOnlyFields</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/account.inc" generated-path="lib.modules.account.inc.html" hash="edf7f37ce9556d6c6cecb5d59af40def" package="modules">
    <docblock line="0">
      <description>Manages the object class "account" for users and hosts.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Tilo Lutz" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="author" description="Michael Duergner" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="39" package="modules">
      <extends>\baseModule</extends>
      <name>account</name>
      <full_name>\account</full_name>
      <docblock line="39">
        <description>Manages the object class "account" for users and hosts.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="39"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="48" package="modules">
        <name>get_metaData</name>
        <full_name>\account::get_metaData()</full_name>
        <docblock line="48">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="48" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="48"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="116" package="modules">
        <name>load_Messages</name>
        <full_name>\account::load_Messages()</full_name>
        <docblock line="116">
          <description>This function fills the message array.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="128" package="modules">
        <name>module_complete</name>
        <full_name>\account::module_complete()</full_name>
        <docblock line="128">
          <description>This functions returns true if all needed settings are done.</description>
          <long-description></long-description>
          <tag name="return" description="true if LDAP operation can be done" line="128" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="139" package="modules">
        <name>getButtonStatus</name>
        <full_name>\account::getButtonStatus()</full_name>
        <docblock line="139">
          <description>Controls if the module button the account page is visible and activated.</description>
          <long-description></long-description>
          <tag name="return" description="status (&amp;quot;enabled&amp;quot;, &amp;quot;disabled&amp;quot;, &amp;quot;hidden&amp;quot;)" line="139" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="162" package="modules">
        <name>save_attributes</name>
        <full_name>\account::save_attributes()</full_name>
        <docblock line="162">
          <description>Returns a list of modifications which have to be made to the LDAP account.</description>
          <long-description></long-description>
          <tag name="return" description="list of modifications&#10;&amp;lt;br&amp;gt;This function returns an array with 3 entries:&#10;&amp;lt;br&amp;gt;array( DN1 (&amp;#039;add&amp;#039; =&amp;gt; array($attr), &amp;#039;remove&amp;#039; =&amp;gt; array($attr), &amp;#039;modify&amp;#039; =&amp;gt; array($attr)), DN2 .... )&#10;&amp;lt;br&amp;gt;DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)&#10;&amp;lt;br&amp;gt;&amp;quot;add&amp;quot; are attributes which have to be added to LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;remove&amp;quot; are attributes which have to be removed from LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;modify&amp;quot; are attributes which have to been modified in LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;info&amp;quot; are values with informational value (e.g. to be used later by pre/postModify actions)" line="162" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="179" package="modules">
        <name>process_attributes</name>
        <full_name>\account::process_attributes()</full_name>
        <docblock line="179">
          <description>Processes user input of the primary module page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="179" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="198" package="modules">
        <name>display_html_attributes</name>
        <full_name>\account::display_html_attributes()</full_name>
        <docblock line="198">
          <description>Returns the HTML meta data for the main account page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="198" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="230" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\account::get_pdfEntries()</full_name>
        <docblock line="230">
          <description>Returns the PDF entries for this module.</description>
          <long-description></long-description>
          <tag name="return" description="list of possible PDF entries" line="230" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="252" package="modules">
        <name>get_uploadColumns</name>
        <full_name>\account::get_uploadColumns()</full_name>
        <docblock line="252">
          <description>Returns an array containing all input columns for the file upload.</description>
          <long-description>Syntax:
&lt;br&gt; array(
&lt;br&gt;  string: name,  // fixed non-translated name which is used as column name (should be of format: &lt;module name&gt;_&lt;column name&gt;)
&lt;br&gt;  string: description,  // short descriptive name
&lt;br&gt;  string: help,  // help ID
&lt;br&gt;  string: example,  // example value
&lt;br&gt;  boolean: required  // true, if user must set a value for this column
&lt;br&gt; )</long-description>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="252" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="column list" line="252" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="274" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>\account::build_uploadAccounts()</full_name>
        <docblock line="274">
          <description>In this function the LDAP account is built up.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) from user input&lt;/p&gt;&#10;" line="274" type="array" variable="$rawAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)&lt;/p&gt;&#10;" line="274" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) which are later added to LDAP&lt;/p&gt;&#10;" line="274" type="array" variable="$partialAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="274" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages if any" line="274" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rawAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$partialAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/ieee802device.inc" generated-path="lib.modules.ieee802device.inc.html" hash="9f721a849ac00bae33a375c7b4a8df2d" package="modules">
    <docblock line="0">
      <description>Provides MAC addresses for hosts.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="35" package="modules">
      <extends>\baseModule</extends>
      <name>ieee802device</name>
      <full_name>\ieee802device</full_name>
      <docblock line="35">
        <description>Provides MAC addresses for hosts.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="35"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="44" package="modules">
        <name>get_metaData</name>
        <full_name>\ieee802device::get_metaData()</full_name>
        <docblock line="44">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="44" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="44"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="87" package="modules">
        <name>load_Messages</name>
        <full_name>\ieee802device::load_Messages()</full_name>
        <docblock line="87">
          <description>This function fills the error message array with messages</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="97" package="modules">
        <name>display_html_attributes</name>
        <full_name>\ieee802device::display_html_attributes()</full_name>
        <docblock line="97">
          <description>Returns the HTML meta data for the main account page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="97" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="131" package="modules">
        <name>process_attributes</name>
        <full_name>\ieee802device::process_attributes()</full_name>
        <docblock line="131">
          <description>Processes user input of the primary module page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="131" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="174" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>\ieee802device::build_uploadAccounts()</full_name>
        <docblock line="174">
          <description>In this function the LDAP account is built up.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) from user input&lt;/p&gt;&#10;" line="174" type="array" variable="$rawAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)&lt;/p&gt;&#10;" line="174" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) which are later added to LDAP&lt;/p&gt;&#10;" line="174" type="array" variable="$partialAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="174" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages if any" line="174" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rawAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$partialAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="203" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\ieee802device::get_pdfEntries()</full_name>
        <docblock line="203">
          <description>Returns the PDF entries for this module.</description>
          <long-description></long-description>
          <tag name="return" description="list of possible PDF entries" line="203" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/puppetClient.inc" generated-path="lib.modules.puppetClient.inc.html" hash="e58bff948676091c09a3137bedc249c5" package="modules">
    <docblock line="0">
      <description>Manages Puppet configuration options.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="37" package="modules">
      <extends>\baseModule</extends>
      <name>puppetClient</name>
      <full_name>\puppetClient</full_name>
      <docblock line="37">
        <description>Manages Puppet configuration options.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="37"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="44" package="modules">
        <name>__construct</name>
        <full_name>\puppetClient::__construct()</full_name>
        <docblock line="44">
          <description>Creates a new authorizedServiceObject object.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account type (user, group, host)&lt;/p&gt;&#10;" line="44" type="string" variable="$scope">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="56" package="modules">
        <name>get_metaData</name>
        <full_name>\puppetClient::get_metaData()</full_name>
        <docblock line="56">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="56" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="176" package="modules">
        <name>load_Messages</name>
        <full_name>\puppetClient::load_Messages()</full_name>
        <docblock line="176">
          <description>This function fills the error message array with messages</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="198" package="modules">
        <name>save_attributes</name>
        <full_name>\puppetClient::save_attributes()</full_name>
        <docblock line="198">
          <description>Returns a list of modifications which have to be made to the LDAP account.</description>
          <long-description></long-description>
          <tag name="return" description="list of modifications&#10;&amp;lt;br&amp;gt;This function returns an array with 3 entries:&#10;&amp;lt;br&amp;gt;array( DN1 (&amp;#039;add&amp;#039; =&amp;gt; array($attr), &amp;#039;remove&amp;#039; =&amp;gt; array($attr), &amp;#039;modify&amp;#039; =&amp;gt; array($attr)), DN2 .... )&#10;&amp;lt;br&amp;gt;DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)&#10;&amp;lt;br&amp;gt;&amp;quot;add&amp;quot; are attributes which have to be added to LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;remove&amp;quot; are attributes which have to be removed from LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;modify&amp;quot; are attributes which have to been modified in LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;info&amp;quot; are values with informational value (e.g. to be used later by pre/postModify actions)" line="198" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="211" package="modules">
        <name>display_html_attributes</name>
        <full_name>\puppetClient::display_html_attributes()</full_name>
        <docblock line="211">
          <description>Returns the HTML meta data for the main account page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="211" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="285" package="modules">
        <name>process_attributes</name>
        <full_name>\puppetClient::process_attributes()</full_name>
        <docblock line="285">
          <description>Processes user input of the primary module page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="285" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="362" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>\puppetClient::build_uploadAccounts()</full_name>
        <docblock line="362">
          <description>In this function the LDAP account is built up.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) from user input&lt;/p&gt;&#10;" line="362" type="array" variable="$rawAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)&lt;/p&gt;&#10;" line="362" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) which are later added to LDAP&lt;/p&gt;&#10;" line="362" type="array" variable="$partialAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="362" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages if any" line="362" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rawAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$partialAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="418" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\puppetClient::get_pdfEntries()</full_name>
        <docblock line="418">
          <description>Returns the PDF entries for this module.</description>
          <long-description></long-description>
          <tag name="return" description="list of possible PDF entries" line="418" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="455" package="modules">
        <name>get_profileOptions</name>
        <full_name>\puppetClient::get_profileOptions()</full_name>
        <docblock line="455">
          <description>This function defines what attributes will be used in the account profiles and their appearance in the profile editor.</description>
          <long-description>Calling this method does not require the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
The return value is an object implementing htmlElement.&lt;br&gt;
The field name are used as keywords to load
and save profiles. We recommend to use the module name as prefix for them
(e.g. posixAccount_homeDirectory) to avoid naming conflicts.</long-description>
          <tag name="return" description="meta HTML object" line="455" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
          <tag name="see" description="" line="455"/>
          <tag name="see" description="" line="455"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="469" package="modules">
        <name>load_profile</name>
        <full_name>\puppetClient::load_profile()</full_name>
        <docblock line="469">
          <description>Loads the values of an account profile into internal variables.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;hash array with profile values (identifier =&gt; value)&lt;/p&gt;&#10;" line="469" type="array" variable="$profile">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$profile</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="497" package="modules">
        <name>getPossibleParentNodes</name>
        <full_name>\puppetClient::getPossibleParentNodes()</full_name>
        <docblock line="497">
          <description>Reurns a list of valid parent nodes for this node.</description>
          <long-description></long-description>
          <tag name="return" description="parent nodes (e.g. array(&amp;#039;node1&amp;#039;, &amp;#039;node2&amp;#039;))" line="497" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/windowsHost.inc" generated-path="lib.modules.windowsHost.inc.html" hash="df1c33c3581f4c43bb5845b55b7911c1" package="modules">
    <docblock line="0">
      <description>Manages Windows AD (e.g. Samba 4) hosts.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="35" package="modules">
      <extends>\baseModule</extends>
      <name>windowsHost</name>
      <full_name>\windowsHost</full_name>
      <docblock line="35">
        <description>Manages Windows AD (e.g. Samba 4) hosts.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="35"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="44" package="modules">
        <name>get_metaData</name>
        <full_name>\windowsHost::get_metaData()</full_name>
        <docblock line="44">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="44" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="44"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="123" package="modules">
        <name>load_Messages</name>
        <full_name>\windowsHost::load_Messages()</full_name>
        <docblock line="123">
          <description>This function fills the $messages variable with output messages from this module.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="133" package="modules">
        <name>display_html_attributes</name>
        <full_name>\windowsHost::display_html_attributes()</full_name>
        <docblock line="133">
          <description>Returns the HTML meta data for the main account page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="133" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="163" package="modules">
        <name>process_attributes</name>
        <full_name>\windowsHost::process_attributes()</full_name>
        <docblock line="163">
          <description>Processes user input of the primary module page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="163" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="190" package="modules">
        <name>display_html_managedBy</name>
        <full_name>\windowsHost::display_html_managedBy()</full_name>
        <docblock line="190">
          <description>This function will create the meta HTML code to show a page to change the member attribute.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="190" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="230" package="modules">
        <name>process_managedBy</name>
        <full_name>\windowsHost::process_managedBy()</full_name>
        <docblock line="230">
          <description>Processes user input of the members page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="230" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="247" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>\windowsHost::build_uploadAccounts()</full_name>
        <docblock line="247">
          <description>In this function the LDAP account is built up.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) from user input&lt;/p&gt;&#10;" line="247" type="array" variable="$rawAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)&lt;/p&gt;&#10;" line="247" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) which are later added to LDAP&lt;/p&gt;&#10;" line="247" type="array" variable="$partialAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="247" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages if any" line="247" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rawAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$partialAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="285" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\windowsHost::get_pdfEntries()</full_name>
        <docblock line="285">
          <description>Returns a list of PDF entries</description>
          <long-description></long-description>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/posixGroup.inc" generated-path="lib.modules.posixGroup.inc.html" hash="9631deaae7682566b2892e0ad16976da" package="modules">
    <docblock line="0">
      <description>Manages Unix accounts for groups.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Tilo Lutz" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="author" description="Michael Duergner" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="40" package="modules">
      <extends>\baseModule</extends>
      <implements>\passwordService</implements>
      <name>posixGroup</name>
      <full_name>\posixGroup</full_name>
      <docblock line="40">
        <description>Manages the object class "posixGroup" for groups.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="40"/>
      </docblock>
      <property static="false" visibility="private" line="43" namespace="" package="modules">
        <name>$changegids</name>
        <default></default>
        <docblock line="43">
          <description>change GIDs of users and hosts?</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="45" namespace="" package="modules">
        <name>$manageCnAttribute</name>
        <default>true</default>
        <docblock line="45">
          <description>specifies if the cn attribute should be managed by this module</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="47" namespace="" package="modules">
        <name>$manageDescriptionAttribute</name>
        <default>true</default>
        <docblock line="47">
          <description>specifies if the description attribute should be managed by this module</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="49" namespace="" package="modules">
        <name>$cachedGIDList</name>
        <default>null</default>
        <docblock line="49">
          <description>cache for existing GID numbers</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="51" namespace="" package="modules">
        <name>$cachedUserToGIDList</name>
        <default>null</default>
        <docblock line="51">
          <description>cache for existing users and their GIDs</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="53" namespace="" package="modules">
        <name>$cachedGroupNameList</name>
        <default>null</default>
        <docblock line="53">
          <description>cache for existing groups</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="64" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>\posixGroup::build_uploadAccounts()</full_name>
        <docblock line="64">
          <description>In this function the LDAP account is built up.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) from user input&lt;/p&gt;&#10;" line="64" type="array" variable="$rawAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)&lt;/p&gt;&#10;" line="64" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) which are later added to LDAP&lt;/p&gt;&#10;" line="64" type="array" variable="$partialAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="64" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages if any" line="64" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rawAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$partialAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="144" package="modules">
        <name>delete_attributes</name>
        <full_name>\posixGroup::delete_attributes()</full_name>
        <docblock line="144">
          <description>Checks if the group which should be deleted is still used as primary group.</description>
          <long-description></long-description>
          <tag name="return" description="of LDAP operations, same as for save_attributes()" line="144" type="\List">
            <type>\List</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="170" package="modules">
        <name>display_html_attributes</name>
        <full_name>\posixGroup::display_html_attributes()</full_name>
        <docblock line="170">
          <description>Returns the HTML meta data for the main account page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="170" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="170"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="260" package="modules">
        <name>display_html_user</name>
        <full_name>\posixGroup::display_html_user()</full_name>
        <docblock line="260">
          <description>Displays selections to add or remove users from current group.</description>
          <long-description></long-description>
          <tag name="return" description="meta HTML output" line="260" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="349" package="modules">
        <name>get_metaData</name>
        <full_name>\posixGroup::get_metaData()</full_name>
        <docblock line="349">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="349" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="524" package="modules">
        <name>get_configOptions</name>
        <full_name>\posixGroup::get_configOptions()</full_name>
        <docblock line="524">
          <description>Returns a list of elements for the configuration.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account types (user, group, host)&lt;/p&gt;&#10;" line="524" type="array" variable="$scopes">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of all modules and active scopes&lt;/p&gt;" line="524" type="array" variable="$allScopes">
            <type>array</type>
          </tag>
          <tag name="return" description="configuration elements" line="524" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$scopes</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$allScopes</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="538" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\posixGroup::get_pdfEntries()</full_name>
        <docblock line="538">
          <description>Returns the PDF entries for this module.</description>
          <long-description></long-description>
          <tag name="return" description="list of possible PDF entries" line="538" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="558" package="modules">
        <name>init</name>
        <full_name>\posixGroup::init()</full_name>
        <docblock line="558">
          <description>This functin will be called when the module will be loaded</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;the name of the {@link accountContainer} object ($_SESSION[$base])&lt;/p&gt;&#10;" line="558" type="String" variable="$base">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$base</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="568" package="modules">
        <name>load_Messages</name>
        <full_name>\posixGroup::load_Messages()</full_name>
        <docblock line="568">
          <description>This function fills the $messages variable with output messages from this module.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="593" package="modules">
        <name>module_complete</name>
        <full_name>\posixGroup::module_complete()</full_name>
        <docblock line="593">
          <description>This functions is used to check if all settings for this module have been made.</description>
          <long-description></long-description>
          <tag name="return" description="true, if settings are complete" line="593" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="612" package="modules">
        <name>getButtonStatus</name>
        <full_name>\posixGroup::getButtonStatus()</full_name>
        <docblock line="612">
          <description>Controls if the module button the account page is visible and activated.</description>
          <long-description></long-description>
          <tag name="return" description="status (&amp;quot;enabled&amp;quot;, &amp;quot;disabled&amp;quot;, &amp;quot;hidden&amp;quot;)" line="612" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="630" package="modules">
        <name>process_attributes</name>
        <full_name>\posixGroup::process_attributes()</full_name>
        <docblock line="630">
          <description>Processes user input of the primary module page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="630" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="781" package="modules">
        <name>process_user</name>
        <full_name>\posixGroup::process_user()</full_name>
        <docblock line="781">
          <description>Processes user input of the user selection page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="781" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="806" package="modules">
        <name>save_attributes</name>
        <full_name>\posixGroup::save_attributes()</full_name>
        <docblock line="806">
          <description>Returns a list of modifications which have to be made to the LDAP account.</description>
          <long-description></long-description>
          <tag name="return" description="list of modifications&#10;&amp;lt;br&amp;gt;This function returns an array with 3 entries:&#10;&amp;lt;br&amp;gt;array( DN1 (&amp;#039;add&amp;#039; =&amp;gt; array($attr), &amp;#039;remove&amp;#039; =&amp;gt; array($attr), &amp;#039;modify&amp;#039; =&amp;gt; array($attr)), DN2 .... )&#10;&amp;lt;br&amp;gt;DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)&#10;&amp;lt;br&amp;gt;&amp;quot;add&amp;quot; are attributes which have to be added to LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;remove&amp;quot; are attributes which have to be removed from LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;modify&amp;quot; are attributes which have to been modified in LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;info&amp;quot; are values with informational value (e.g. to be used later by pre/postModify actions)" line="806" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="834" package="modules">
        <name>load_profile</name>
        <full_name>\posixGroup::load_profile()</full_name>
        <docblock line="834">
          <description>Loads the values of an account profile into internal variables.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;hash array with profile values (identifier =&gt; value)&lt;/p&gt;&#10;" line="834" type="array" variable="$profile">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$profile</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="859" package="modules">
        <name>check_configOptions</name>
        <full_name>\posixGroup::check_configOptions()</full_name>
        <docblock line="859">
          <description>Checks input values of module settings.</description>
          <long-description>Calling this method does not require the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
If the input data is invalid the return value is an array that contains subarrays to build StatusMessages ('message type', 'message head', 'message text').
&lt;br&gt;If no errors occured the function returns an empty array.</long-description>
          <tag name="param" description="&lt;p&gt;list of account types which are used&lt;/p&gt;" line="859" type="array" variable="$scopes">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;hash array (option name =&gt; value) that contains the input. The option values are all arrays containing one or more elements.&lt;/p&gt;&#10;" line="859" type="array" variable="$options">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages" line="859" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="859"/>
        </docblock>
        <argument line="0">
          <name>$scopes</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$options</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="897" package="modules">
        <name>getNextGIDs</name>
        <full_name>\posixGroup::getNextGIDs()</full_name>
        <docblock line="897">
          <description>Returns one or more free GID numbers.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Number of needed free GIDs.&lt;/p&gt;" line="897" type="integer" variable="$count">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of error messages where errors can be added&lt;/p&gt;" line="897" type="array" variable="$errors">
            <type>array</type>
          </tag>
          <tag name="return" description="Null if no GIDs are free else an array of free GIDs." line="897" type="mixed">
            <type>mixed</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$count</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$errors</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="955" package="modules">
        <name>getNextSambaPoolGIDs</name>
        <full_name>\posixGroup::getNextSambaPoolGIDs()</full_name>
        <docblock line="955">
          <description>Gets the free GID numbers from an Samba pool entry in LDAP.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;number of needed free GIDs.&lt;/p&gt;" line="955" type="integer" variable="$count">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of error messages where errors can be added&lt;/p&gt;" line="955" type="array" variable="$errors">
            <type>array</type>
          </tag>
          <tag name="return" description="null if no GIDs are free else an array of free GIDs" line="955" type="mixed">
            <type>mixed</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$count</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$errors</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="982" package="modules">
        <name>managesPasswordAttributes</name>
        <full_name>\posixGroup::managesPasswordAttributes()</full_name>
        <docblock line="982">
          <description>This method specifies if a module manages password attributes.</description>
          <long-description></long-description>
          <tag name="see" description="" line="982"/>
          <tag name="return" description="true if this module manages password attributes" line="982" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="991" package="modules">
        <name>supportsForcePasswordChange</name>
        <full_name>\posixGroup::supportsForcePasswordChange()</full_name>
        <docblock line="991">
          <description>Specifies if this module supports to force that a user must change his password on next login.</description>
          <long-description></long-description>
          <tag name="return" description="force password change supported" line="991" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1006" package="modules">
        <name>passwordChangeRequested</name>
        <full_name>\posixGroup::passwordChangeRequested()</full_name>
        <docblock line="1006">
          <description>This function is called whenever the password should be changed. Account modules
must change their password attributes only if the modules list contains their module name.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;new password&lt;/p&gt;" line="1006" type="String" variable="$password">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of modules for which the password should be changed&lt;/p&gt;" line="1006" type="" variable="$modules"/>
          <tag name="param" description="&lt;p&gt;force the user to change his password at next login&lt;/p&gt;" line="1006" type="boolean" variable="$forcePasswordChange">
            <type>boolean</type>
          </tag>
          <tag name="return" description="list of error messages if any as parameter array for StatusMessage&#10;              e.g. return arrray(array(&amp;#039;ERROR&amp;#039;, &amp;#039;Password change failed.&amp;#039;))" line="1006" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="1006"/>
        </docblock>
        <argument line="0">
          <name>$password</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$modules</name>
          <default></default>
          <type>mixed</type>
        </argument>
        <argument line="0">
          <name>$forcePasswordChange</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1019" package="modules">
        <name>getGIDs</name>
        <full_name>\posixGroup::getGIDs()</full_name>
        <docblock line="1019">
          <description>Returns a list of existing GID numbers.</description>
          <long-description></long-description>
          <tag name="return" description="list of GID numbers" line="1019" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1043" package="modules">
        <name>getUsers</name>
        <full_name>\posixGroup::getUsers()</full_name>
        <docblock line="1043">
          <description>Returns a list of existing users and their GID numbers and cn.</description>
          <long-description></long-description>
          <tag name="return" description="list in format array(uid =&amp;gt; array(&amp;#039;gid&amp;#039; =&amp;gt; 123, &amp;#039;cn&amp;#039; =&amp;gt; &amp;#039;Some user&amp;#039;))" line="1043" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1062" package="modules">
        <name>groupNameExists</name>
        <full_name>\posixGroup::groupNameExists()</full_name>
        <docblock line="1062">
          <description>Checks if the given group name already exists in LDAP.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;group name&lt;/p&gt;" line="1062" type="String" variable="$groupName">
            <type>String</type>
          </tag>
          <tag name="return" description="true if already exists" line="1062" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$groupName</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1071" package="modules">
        <name>getGroupNames</name>
        <full_name>\posixGroup::getGroupNames()</full_name>
        <docblock line="1071">
          <description>Returns a list of all group names in LDAP.</description>
          <long-description></long-description>
          <tag name="return" description="group names" line="1071" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/dhcp_settings.inc" generated-path="lib.modules.dhcp_settings.inc.html" hash="20d327c5414278668d5b389b2e248f97" package="modules">
    <docblock line="0">
      <description>Manages DHCP entries.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Thomas Manninger" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <function namespace="" line="49" package="modules">
      <name>check_ip</name>
      <full_name>\check_ip()</full_name>
      <docblock line="49">
        <description>Checks if the given IP is valid.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;IP address&lt;/p&gt;" line="49" type="String" variable="$ip">
          <type>String</type>
        </tag>
        <tag name="param" description="&lt;p&gt;IP must be a subnet&lt;/p&gt;" line="49" type="boolean" variable="$subnet">
          <type>boolean</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$ip</name>
        <default></default>
        <type>String</type>
      </argument>
      <argument line="0">
        <name>$subnet</name>
        <default>false</default>
        <type>boolean</type>
      </argument>
    </function>
    <class final="false" abstract="false" namespace="" line="79" package="modules">
      <extends>\baseModule</extends>
      <name>dhcp_settings</name>
      <full_name>\dhcp_settings</full_name>
      <docblock line="79">
        <description>Manages DHCP entries.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="79"/>
      </docblock>
      <property static="false" visibility="private" line="82" namespace="" package="modules">
        <name>$all_netbios_node_types</name>
        <default></default>
        <docblock line="82">
          <description>all netbios node types</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="84" namespace="" package="modules">
        <name>$allowDenyOptions</name>
        <default></default>
        <docblock line="84">
          <description>unknown-client options</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="86" namespace="" package="modules">
        <name>$attributes</name>
        <default></default>
        <docblock line="86">
          <description>LDAP attributes</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="93" package="modules">
        <name>__construct</name>
        <full_name>\dhcp_settings::__construct()</full_name>
        <docblock line="93">
          <description>Creates a new dhcp_settings object.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="93" type="string" variable="$scope">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="115" package="modules">
        <name>get_metaData</name>
        <full_name>\dhcp_settings::get_metaData()</full_name>
        <docblock line="115">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="115" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="310" package="modules">
        <name>load_Messages</name>
        <full_name>\dhcp_settings::load_Messages()</full_name>
        <docblock line="310">
          <description>This function fills the message array.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="347" package="modules">
        <name>save_attributes</name>
        <full_name>\dhcp_settings::save_attributes()</full_name>
        <docblock line="347">
          <description>Returns a list of modifications which have to be made to the LDAP account.</description>
          <long-description></long-description>
          <tag name="return" description="list of modifications&#10;&amp;lt;br&amp;gt;This function returns an array with 3 entries:&#10;&amp;lt;br&amp;gt;array( DN1 (&amp;#039;add&amp;#039; =&amp;gt; array($attr), &amp;#039;remove&amp;#039; =&amp;gt; array($attr), &amp;#039;modify&amp;#039; =&amp;gt; array($attr)), DN2 .... )&#10;&amp;lt;br&amp;gt;DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)&#10;&amp;lt;br&amp;gt;&amp;quot;add&amp;quot; are attributes which have to be added to LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;remove&amp;quot; are attributes which have to be removed from LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;modify&amp;quot; are attributes which have to been modified in LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;info&amp;quot; are values with informational value (e.g. to be used later by pre/postModify actions)" line="347" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="364" package="modules">
        <name>process_attributes</name>
        <full_name>\dhcp_settings::process_attributes()</full_name>
        <docblock line="364">
          <description>Processes user input of the primary module page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="364" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="504" package="modules">
        <name>checkSubnetMask</name>
        <full_name>\dhcp_settings::checkSubnetMask()</full_name>
        <docblock line="504">
          <description>Checks if the subnet mask is valid.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;subnet mask&lt;/p&gt;" line="504" type="String" variable="$mask">
            <type>String</type>
          </tag>
          <tag name="return" description="correct or incorrect" line="504" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$mask</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="524" package="modules">
        <name>calculateNetMask</name>
        <full_name>\dhcp_settings::calculateNetMask()</full_name>
        <docblock line="524">
          <description>Calculates the net mask from the subnet.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;subnet&lt;/p&gt;" line="524" type="String" variable="$subnet">
            <type>String</type>
          </tag>
          <tag name="return" description="netmask" line="524" type="integer">
            <type>integer</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$subnet</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="539" package="modules">
        <name>display_html_attributes</name>
        <full_name>\dhcp_settings::display_html_attributes()</full_name>
        <docblock line="539">
          <description>Returns the HTML meta data for the main account page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="539" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="622" package="modules">
        <name>load_profile</name>
        <full_name>\dhcp_settings::load_profile()</full_name>
        <docblock line="622">
          <description>Loads the values of an account profile into internal variables.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;hash array with profile values (identifier =&gt; value)&lt;/p&gt;&#10;" line="622" type="array" variable="$profile">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$profile</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="655" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\dhcp_settings::get_pdfEntries()</full_name>
        <docblock line="655">
          <description>Returns the PDF entries for this module.</description>
          <long-description></long-description>
          <tag name="return" description="list of possible PDF entries" line="655" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="689" package="modules">
        <name>getDHCPOption</name>
        <full_name>\dhcp_settings::getDHCPOption()</full_name>
        <docblock line="689">
          <description>Returns a DHCP option.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;option name&lt;/p&gt;" line="689" type="String" variable="$name">
            <type>String</type>
          </tag>
          <tag name="return" description="value" line="689" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="710" package="modules">
        <name>setDHCPOption</name>
        <full_name>\dhcp_settings::setDHCPOption()</full_name>
        <docblock line="710">
          <description>Sets a DHCP option.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;option name&lt;/p&gt;" line="710" type="String" variable="$name">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;option value&lt;/p&gt;" line="710" type="String" variable="$value">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$value</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="730" package="modules">
        <name>getDefaultLeaseTime</name>
        <full_name>\dhcp_settings::getDefaultLeaseTime()</full_name>
        <docblock line="730">
          <description>Returns the default lease time.</description>
          <long-description></long-description>
          <tag name="return" description="time" line="730" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="748" package="modules">
        <name>setDefaultLeaseTime</name>
        <full_name>\dhcp_settings::setDefaultLeaseTime()</full_name>
        <docblock line="748">
          <description>Sets the default lease time.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;time&lt;/p&gt;" line="748" type="String" variable="$time">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$time</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="768" package="modules">
        <name>getUnknownClients</name>
        <full_name>\dhcp_settings::getUnknownClients()</full_name>
        <docblock line="768">
          <description>Returns the unknown clients option.</description>
          <long-description></long-description>
          <tag name="return" description="unknown clients value" line="768" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="787" package="modules">
        <name>setUnknownClients</name>
        <full_name>\dhcp_settings::setUnknownClients()</full_name>
        <docblock line="787">
          <description>Sets the unknown clients option.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;allow/deny&lt;/p&gt;&#10;" line="787" type="String" variable="$option">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$option</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="808" package="modules">
        <name>getMaxLeaseTime</name>
        <full_name>\dhcp_settings::getMaxLeaseTime()</full_name>
        <docblock line="808">
          <description>Returns the maximum lease time.</description>
          <long-description></long-description>
          <tag name="return" description="time" line="808" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="826" package="modules">
        <name>setMaxLeaseTime</name>
        <full_name>\dhcp_settings::setMaxLeaseTime()</full_name>
        <docblock line="826">
          <description>Sets the maximum lease time.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;time&lt;/p&gt;" line="826" type="String" variable="$time">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$time</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="850" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>\dhcp_settings::build_uploadAccounts()</full_name>
        <docblock line="850">
          <description>In this function the LDAP account is built up.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) from user input&lt;/p&gt;&#10;" line="850" type="array" variable="$rawAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)&lt;/p&gt;&#10;" line="850" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) which are later added to LDAP&lt;/p&gt;&#10;" line="850" type="array" variable="$partialAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="850" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages if any" line="850" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rawAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$partialAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/eduPerson.inc" generated-path="lib.modules.eduPerson.inc.html" hash="b6ca5797f002a3063775333f7d2f8ed6" package="modules">
    <docblock line="0">
      <description>Manages the eduPerson extension for user accounts.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="35" package="modules">
      <extends>\baseModule</extends>
      <name>eduPerson</name>
      <full_name>\eduPerson</full_name>
      <docblock line="35">
        <description>Manages the eduPerson extension for user accounts.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="35"/>
      </docblock>
      <property static="false" visibility="private" line="38" namespace="" package="modules">
        <name>$affiliationTypes</name>
        <default>array('faculty', 'student', 'staff', 'alum', 'member', 'affiliate', 'employee', 'library-walk-in')</default>
        <docblock line="38">
          <description>possible affiliation types</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="46" package="modules">
        <name>__construct</name>
        <full_name>\eduPerson::__construct()</full_name>
        <docblock line="46">
          <description>Creates a new eduPerson object.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account type (user, group, host)&lt;/p&gt;&#10;" line="46" type="string" variable="$scope">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="58" package="modules">
        <name>get_metaData</name>
        <full_name>\eduPerson::get_metaData()</full_name>
        <docblock line="58">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="58" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="58"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="235" package="modules">
        <name>load_Messages</name>
        <full_name>\eduPerson::load_Messages()</full_name>
        <docblock line="235">
          <description>This function fills the error message array with messages</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="254" package="modules">
        <name>module_complete</name>
        <full_name>\eduPerson::module_complete()</full_name>
        <docblock line="254">
          <description>This functions return true if all needed settings are done.</description>
          <long-description></long-description>
          <tag name="return" description="true, if all is ok" line="254" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="266" package="modules">
        <name>display_html_attributes</name>
        <full_name>\eduPerson::display_html_attributes()</full_name>
        <docblock line="266">
          <description>Returns the HTML meta data for the main account page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="266" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="492" package="modules">
        <name>process_attributes</name>
        <full_name>\eduPerson::process_attributes()</full_name>
        <docblock line="492">
          <description>Processes user input of the primary module page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="492" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="623" package="modules">
        <name>load_profile</name>
        <full_name>\eduPerson::load_profile()</full_name>
        <docblock line="623">
          <description>Loads the values of an account profile into internal variables.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;hash array with profile values (identifier =&gt; value)&lt;/p&gt;&#10;" line="623" type="array" variable="$profile">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$profile</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="642" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>\eduPerson::build_uploadAccounts()</full_name>
        <docblock line="642">
          <description>In this function the LDAP account is built up.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) from user input&lt;/p&gt;&#10;" line="642" type="array" variable="$rawAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)&lt;/p&gt;&#10;" line="642" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) which are later added to LDAP&lt;/p&gt;&#10;" line="642" type="array" variable="$partialAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="642" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages if any" line="642" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rawAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$partialAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="764" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\eduPerson::get_pdfEntries()</full_name>
        <docblock line="764">
          <description>Returns the PDF entries for this module.</description>
          <long-description></long-description>
          <tag name="return" description="list of possible PDF entries" line="764" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/quota.inc" generated-path="lib.modules.quota.inc.html" hash="0867a7d0886e938726c31ca7f84d0315" package="modules">
    <docblock line="0">
      <description>Manages quotas for users and groups.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Tilo Lutz" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="author" description="Michael Duergner" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="40" package="modules">
      <extends>\baseModule</extends>
      <name>quota</name>
      <full_name>\quota</full_name>
      <docblock line="40">
        <description>Manages quotas for users and groups.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="40"/>
      </docblock>
      <property static="true" visibility="private" line="43" namespace="" package="modules">
        <name>$SPLIT_DELIMITER</name>
        <default>"###x##y##x###"</default>
        <docblock line="43">
          <description>delimiter for lamdaemon commands</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="true" visibility="private" line="45" namespace="" package="modules">
        <name>$QUOTA_PREFIX</name>
        <default>'QUOTA_ENTRY '</default>
        <docblock line="45">
          <description>prefix for lamdaemon results</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="154" namespace="" package="modules">
        <name>$quota</name>
        <default></default>
        <docblock line="154">
          <description>Saves the quota settings</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="49" package="modules">
        <name>load_Messages</name>
        <full_name>\quota::load_Messages()</full_name>
        <docblock line="49">
          <description>this functin fills the error message array with messages</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="73" package="modules">
        <name>get_metaData</name>
        <full_name>\quota::get_metaData()</full_name>
        <docblock line="73">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="73" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="73"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="160" package="modules">
        <name>initQuotas</name>
        <full_name>\quota::initQuotas()</full_name>
        <docblock line="160">
          <description>Initializes the quota values.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="203" package="modules">
        <name>getCn</name>
        <full_name>\quota::getCn()</full_name>
        <docblock line="203">
          <description>Gets the cn from the Unix group module.</description>
          <long-description></long-description>
          <tag name="return" description="cn attribute" line="203" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="222" package="modules">
        <name>module_ready</name>
        <full_name>\quota::module_ready()</full_name>
        <docblock line="222">
          <description>This function is used to check if this module page can be displayed.</description>
          <long-description>It returns false if a module depends on data from other modules which was not yet entered.</long-description>
          <tag name="return" description="true, if page can be displayed" line="222" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="244" package="modules">
        <name>postModifyActions</name>
        <full_name>\quota::postModifyActions()</full_name>
        <docblock line="244">
          <description>Quotas are set in postmodify.</description>
          <long-description></long-description>
          <tag name="see" description="" line="244"/>
          <tag name="param" description="&lt;p&gt;is new account&lt;/p&gt;" line="244" type="boolean" variable="$newAccount">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;LDAP attributes of this entry&lt;/p&gt;" line="244" type="array" variable="$attributes">
            <type>array</type>
          </tag>
          <tag name="return" description="array which contains status messages. Each entry is an array containing the status message parameters." line="244" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$newAccount</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="283" package="modules">
        <name>preDeleteActions</name>
        <full_name>\quota::preDeleteActions()</full_name>
        <docblock line="283">
          <description>Allows the module to run commands before the LDAP entry is deleted.</description>
          <long-description></long-description>
          <tag name="return" description="Array which contains status messages. Each entry is an array containing the status message parameters." line="283" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="323" package="modules">
        <name>process_attributes</name>
        <full_name>\quota::process_attributes()</full_name>
        <docblock line="323">
          <description>Processes user input of the primary module page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="323" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="370" package="modules">
        <name>display_html_attributes</name>
        <full_name>\quota::display_html_attributes()</full_name>
        <docblock line="370">
          <description>Returns the HTML meta data for the main account page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="370" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="454" package="modules">
        <name>replaceSpecialChars</name>
        <full_name>\quota::replaceSpecialChars()</full_name>
        <docblock line="454">
          <description>Replaces special characters in HTML name values.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;input string&lt;/p&gt;" line="454" type="string" variable="$input">
            <type>string</type>
          </tag>
          <tag name="return" description="output string" line="454" type="string">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="464" package="modules">
        <name>get_profileOptions</name>
        <full_name>\quota::get_profileOptions()</full_name>
        <docblock line="464">
          <description>Returns a list of elements for the account profiles.</description>
          <long-description></long-description>
          <tag name="return" description="profile elements" line="464" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="545" package="modules">
        <name>check_profileOptions</name>
        <full_name>\quota::check_profileOptions()</full_name>
        <docblock line="545">
          <description>Checks input values of account profiles.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;a hash array (name =&gt; value) containing the options&lt;/p&gt;&#10;" line="545" type="array" variable="$options">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages (array(type, title, text)) to generate StatusMessages, if any" line="545" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$options</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="586" package="modules">
        <name>load_profile</name>
        <full_name>\quota::load_profile()</full_name>
        <docblock line="586">
          <description>Loads the values of an account profile into internal variables.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;hash array with profile values (identifier =&gt; value)&lt;/p&gt;&#10;" line="586" type="array" variable="$profile">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$profile</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="608" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\quota::get_pdfEntries()</full_name>
        <docblock line="608">
          <description>Returns the PDF entries for this module.</description>
          <long-description></long-description>
          <tag name="return" description="list of possible PDF entries" line="608" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="663" package="modules">
        <name>get_uploadColumns</name>
        <full_name>\quota::get_uploadColumns()</full_name>
        <docblock line="663">
          <description>Returns an array containing all input columns for the file upload.</description>
          <long-description>Syntax:
&lt;br&gt; array(
&lt;br&gt;  string: name,  // fixed non-translated name which is used as column name (should be of format: &lt;module name&gt;_&lt;column name&gt;)
&lt;br&gt;  string: description,  // short descriptive name
&lt;br&gt;  string: help,  // help ID
&lt;br&gt;  string: example,  // example value
&lt;br&gt;  boolean: required  // true, if user must set a value for this column
&lt;br&gt; )</long-description>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="663" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="column list" line="663" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="715" package="modules">
        <name>doUploadPostActions</name>
        <full_name>\quota::doUploadPostActions()</full_name>
        <docblock line="715">
          <description>This function executes one post upload action.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;array containing one account in each element&lt;/p&gt;" line="715" type="array" variable="$data">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;array(&lt;column_name&gt; =&gt; &lt;column number&gt;)&lt;/p&gt;&#10;" line="715" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of accounts which were not created successfully&lt;/p&gt;" line="715" type="array" variable="$failed">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;variable to store temporary data between two post actions&lt;/p&gt;" line="715" type="array" variable="$temp">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of LDAP entries&lt;/p&gt;" line="715" type="array" variable="$accounts">
            <type>array</type>
          </tag>
          <tag name="return" description="current status&#10;&amp;lt;br&amp;gt; array (&#10;&amp;lt;br&amp;gt;  &amp;#039;status&amp;#039; =&amp;gt; &amp;#039;finished&amp;#039; | &amp;#039;inProgress&amp;#039;&#10;&amp;lt;br&amp;gt;  &amp;#039;progress&amp;#039; =&amp;gt; 0..100&#10;&amp;lt;br&amp;gt;  &amp;#039;errors&amp;#039; =&amp;gt; array (&amp;lt;array of parameters for StatusMessage&amp;gt;)&#10;&amp;lt;br&amp;gt; )" line="715" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$data</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$failed</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$temp</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$accounts</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/sambaSamAccount.inc" generated-path="lib.modules.sambaSamAccount.inc.html" hash="bc6d1ef8463289c23f4f6a62181b9973" package="modules">
    <docblock line="0">
      <description>Manages Samba 3 accounts for users and hosts.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Tilo Lutz" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="author" description="Michael Duergner" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="42" package="modules">
      <extends>\baseModule</extends>
      <implements>\passwordService</implements>
      <name>sambaSamAccount</name>
      <full_name>\sambaSamAccount</full_name>
      <docblock line="42">
        <description>Manages the object class "sambaSamAccount" for users and hosts.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="42"/>
      </docblock>
      <property static="false" visibility="private" line="46" namespace="" package="modules">
        <name>$nopwd</name>
        <default></default>
        <docblock line="46">
          <description>use no password?</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="48" namespace="" package="modules">
        <name>$noexpire</name>
        <default></default>
        <docblock line="48">
          <description>password does not expire?</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="50" namespace="" package="modules">
        <name>$deactivated</name>
        <default></default>
        <docblock line="50">
          <description>account deactivated?</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="52" namespace="" package="modules">
        <name>$groupRids</name>
        <default></default>
        <docblock line="52">
          <description>array of well known group rids</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="54" namespace="" package="modules">
        <name>$userRids</name>
        <default></default>
        <docblock line="54">
          <description>array of well known user rids</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="56" namespace="" package="modules">
        <name>$hex2bitstring</name>
        <default>array('0' =&gt; '0000', '1' =&gt; '0001', '2' =&gt; '0010', '3' =&gt; '0011', '4' =&gt; '0100', '5' =&gt; '0101', '6' =&gt; '0110', '7' =&gt; '0111', '8' =&gt; '1000', '9' =&gt; '1001', 'A' =&gt; '1010', 'B' =&gt; '1011', 'C' =&gt; '1100', 'D' =&gt; '1101', 'E' =&gt; '1110', 'F' =&gt; '1111')</default>
        <docblock line="56">
          <description>HEX to binary conversion table</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="60" namespace="" package="modules">
        <name>$expirePassword</name>
        <default>false</default>
        <docblock line="60">
          <description>specifies if the password should be expired</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="62" namespace="" package="modules">
        <name>$cachedHostList</name>
        <default>null</default>
        <docblock line="62">
          <description>host cache to reduce LDAP queries</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="64" namespace="" package="modules">
        <name>$cachedGroupSIDList</name>
        <default>null</default>
        <docblock line="64">
          <description>group cache to reduce LDAP queries</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="66" namespace="" package="modules">
        <name>$cachedDomainList</name>
        <default>null</default>
        <docblock line="66">
          <description>cache for domain list</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="true" visibility="private" line="68" namespace="" package="modules">
        <name>$SPLIT_DELIMITER</name>
        <default>"###x##y##x###"</default>
        <docblock line="68">
          <description>delimiter for lamdaemon commands</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="76" package="modules">
        <name>__construct</name>
        <full_name>\sambaSamAccount::__construct()</full_name>
        <docblock line="76">
          <description>Creates a new sambaSamAccount object.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account type (user, group, host)&lt;/p&gt;&#10;" line="76" type="string" variable="$scope">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="92" package="modules">
        <name>load_Messages</name>
        <full_name>\sambaSamAccount::load_Messages()</full_name>
        <docblock line="92">
          <description>this functin fills the error message array with messages</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="132" package="modules">
        <name>get_metaData</name>
        <full_name>\sambaSamAccount::get_metaData()</full_name>
        <docblock line="132">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="132" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="132"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="604" package="modules">
        <name>init</name>
        <full_name>\sambaSamAccount::init()</full_name>
        <docblock line="604">
          <description>Initializes the module after it became part of an accountContainer</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;the name of the accountContainer object ($_SESSION[$base])&lt;/p&gt;&#10;" line="604" type="string" variable="$base">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$base</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="618" package="modules">
        <name>module_ready</name>
        <full_name>\sambaSamAccount::module_ready()</full_name>
        <docblock line="618">
          <description>This function is used to check if this module page can be displayed.</description>
          <long-description>It returns false if a module depends on data from other modules which was not yet entered.</long-description>
          <tag name="return" description="true, if page can be displayed" line="618" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="633" package="modules">
        <name>module_complete</name>
        <full_name>\sambaSamAccount::module_complete()</full_name>
        <docblock line="633">
          <description>This function is used to check if all settings for this module have been made.</description>
          <long-description></long-description>
          <tag name="see" description="" line="633"/>
          <tag name="return" description="true, if settings are complete" line="633" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="655" package="modules">
        <name>load_attributes</name>
        <full_name>\sambaSamAccount::load_attributes()</full_name>
        <docblock line="655">
          <description>This function loads the LDAP attributes for this module.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;attribute list&lt;/p&gt;" line="655" type="array" variable="$attr">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attr</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="682" package="modules">
        <name>save_attributes</name>
        <full_name>\sambaSamAccount::save_attributes()</full_name>
        <docblock line="682">
          <description>Returns a list of modifications which have to be made to the LDAP account.</description>
          <long-description></long-description>
          <tag name="return" description="list of modifications&#10;&amp;lt;br&amp;gt;This function returns an array with 3 entries:&#10;&amp;lt;br&amp;gt;array( DN1 (&amp;#039;add&amp;#039; =&amp;gt; array($attr), &amp;#039;remove&amp;#039; =&amp;gt; array($attr), &amp;#039;modify&amp;#039; =&amp;gt; array($attr)), DN2 .... )&#10;&amp;lt;br&amp;gt;DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)&#10;&amp;lt;br&amp;gt;&amp;quot;add&amp;quot; are attributes which have to be added to LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;remove&amp;quot; are attributes which have to be removed from LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;modify&amp;quot; are attributes which have to been modified in LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;info&amp;quot; are values with informational value (e.g. to be used later by pre/postModify actions)" line="682" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="704" package="modules">
        <name>process_attributes</name>
        <full_name>\sambaSamAccount::process_attributes()</full_name>
        <docblock line="704">
          <description>Processes user input of the primary module page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="704" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="890" package="modules">
        <name>process_sambaUserWorkstations</name>
        <full_name>\sambaSamAccount::process_sambaUserWorkstations()</full_name>
        <docblock line="890">
          <description>Processes user input of the primary module page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="890" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="946" package="modules">
        <name>process_logonHours</name>
        <full_name>\sambaSamAccount::process_logonHours()</full_name>
        <docblock line="946">
          <description>Processes user input of the logon hours page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="946" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="972" package="modules">
        <name>process_time</name>
        <full_name>\sambaSamAccount::process_time()</full_name>
        <docblock line="972">
          <description>Processes user input of the time selection page.</description>
          <long-description></long-description>
          <tag name="return" description="list of info/error messages" line="972" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1041" package="modules">
        <name>process_terminalServer</name>
        <full_name>\sambaSamAccount::process_terminalServer()</full_name>
        <docblock line="1041">
          <description>Processes user input of the terminal server page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="1041" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1072" package="modules">
        <name>display_html_attributes</name>
        <full_name>\sambaSamAccount::display_html_attributes()</full_name>
        <docblock line="1072">
          <description>Returns the HTML meta data for the main account page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="1072" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1296" package="modules">
        <name>display_html_sambaUserWorkstations</name>
        <full_name>\sambaSamAccount::display_html_sambaUserWorkstations()</full_name>
        <docblock line="1296">
          <description>This function will create the HTML page to edit the allowed workstations.</description>
          <long-description></long-description>
          <tag name="return" description="meta HTML code" line="1296" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1344" package="modules">
        <name>display_html_logonHours</name>
        <full_name>\sambaSamAccount::display_html_logonHours()</full_name>
        <docblock line="1344">
          <description>This function will create the HTML page to edit logon hours.</description>
          <long-description></long-description>
          <tag name="return" description="meta HTML code" line="1344" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1417" package="modules">
        <name>display_html_time</name>
        <full_name>\sambaSamAccount::display_html_time()</full_name>
        <docblock line="1417">
          <description>This function will create the meta HTML code to show a page to change time values.</description>
          <long-description></long-description>
          <tag name="return" description="meta HTML code" line="1417" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1467" package="modules">
        <name>display_html_terminalServer</name>
        <full_name>\sambaSamAccount::display_html_terminalServer()</full_name>
        <docblock line="1467">
          <description>This function will create the HTML page to edit the terminal server options.</description>
          <long-description></long-description>
          <tag name="return" description="meta HTML code" line="1467" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1553" package="modules">
        <name>display_html_profilePath</name>
        <full_name>\sambaSamAccount::display_html_profilePath()</full_name>
        <docblock line="1553">
          <description>Displays manage profile path page.</description>
          <long-description></long-description>
          <tag name="return" description="meta HTML code" line="1553" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1626" package="modules">
        <name>process_profilePath</name>
        <full_name>\sambaSamAccount::process_profilePath()</full_name>
        <docblock line="1626">
          <description>Processes user input of the profile path check page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="1626" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1699" package="modules">
        <name>get_profileOptions</name>
        <full_name>\sambaSamAccount::get_profileOptions()</full_name>
        <docblock line="1699">
          <description>Returns a list of elements for the account profiles.</description>
          <long-description></long-description>
          <tag name="return" description="profile elements" line="1699" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1781" package="modules">
        <name>load_profile</name>
        <full_name>\sambaSamAccount::load_profile()</full_name>
        <docblock line="1781">
          <description>Loads the values of an account profile into internal variables.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;hash array with profile values (identifier =&gt; value)&lt;/p&gt;&#10;" line="1781" type="array" variable="$profile">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$profile</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1872" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\sambaSamAccount::get_pdfEntries()</full_name>
        <docblock line="1872">
          <description>Returns the PDF entries for this module.</description>
          <long-description></long-description>
          <tag name="return" description="list of possible PDF entries" line="1872" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1959" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>\sambaSamAccount::build_uploadAccounts()</full_name>
        <docblock line="1959">
          <description>In this function the LDAP account is built up.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) from user input&lt;/p&gt;&#10;" line="1959" type="array" variable="$rawAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)&lt;/p&gt;&#10;" line="1959" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) which are later added to LDAP&lt;/p&gt;&#10;" line="1959" type="array" variable="$partialAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="1959" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages if any" line="1959" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rawAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$partialAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2279" package="modules">
        <name>getSelfServiceOptions</name>
        <full_name>\sambaSamAccount::getSelfServiceOptions()</full_name>
        <docblock line="2279">
          <description>Returns the meta HTML code for each input field.</description>
          <long-description>format: array(&lt;field1&gt; =&gt; array(&lt;META HTML&gt;), ...)
It is not possible to display help links.</long-description>
          <tag name="param" description="&lt;p&gt;list of active fields&lt;/p&gt;" line="2279" type="array" variable="$fields">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;attributes of LDAP account&lt;/p&gt;" line="2279" type="array" variable="$attributes">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;indicates that the user is only allowed to change his password and no LDAP content is readable&lt;/p&gt;" line="2279" type="boolean" variable="$passwordChangeOnly">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of read-only fields&lt;/p&gt;&#10;" line="2279" type="array" variable="$readOnlyFields">
            <type>array</type>
          </tag>
          <tag name="return" description="list of meta HTML elements (field name =&amp;gt; htmlTableRow)" line="2279" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$fields</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$passwordChangeOnly</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$readOnlyFields</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2320" package="modules">
        <name>checkSelfServiceOptions</name>
        <full_name>\sambaSamAccount::checkSelfServiceOptions()</full_name>
        <docblock line="2320">
          <description>Checks if all input values are correct and returns the LDAP attributes which should be changed.</description>
          <long-description>&lt;br&gt;Return values:
&lt;br&gt;messages: array of parameters to create status messages
&lt;br&gt;add: array of attributes to add
&lt;br&gt;del: array of attributes to remove
&lt;br&gt;mod: array of attributes to modify
&lt;br&gt;info: array of values with informational value (e.g. to be used later by pre/postModify actions)

Calling this method does not require the existence of an enclosing {@link accountContainer}.</long-description>
          <tag name="param" description="&lt;p&gt;input fields&lt;/p&gt;" line="2320" type="string" variable="$fields">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="2320" type="array" variable="$attributes">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;indicates that the user is only allowed to change his password and no LDAP content is readable&lt;/p&gt;" line="2320" type="boolean" variable="$passwordChangeOnly">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of read-only fields&lt;/p&gt;&#10;" line="2320" type="array" variable="$readOnlyFields">
            <type>array</type>
          </tag>
          <tag name="return" description="messages and attributes (array(&amp;#039;messages&amp;#039; =&amp;gt; array(), &amp;#039;add&amp;#039; =&amp;gt; array(&amp;#039;mail&amp;#039; =&amp;gt; array(&amp;#039;test@test.com&amp;#039;)), &amp;#039;del&amp;#039; =&amp;gt; array(), &amp;#039;mod&amp;#039; =&amp;gt; array(), &amp;#039;info&amp;#039; =&amp;gt; array()))" line="2320" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$fields</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$passwordChangeOnly</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$readOnlyFields</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2388" package="modules">
        <name>managesPasswordAttributes</name>
        <full_name>\sambaSamAccount::managesPasswordAttributes()</full_name>
        <docblock line="2388">
          <description>This method specifies if a module manages password attributes.</description>
          <long-description></long-description>
          <tag name="see" description="" line="2388"/>
          <tag name="return" description="true if this module manages password attributes" line="2388" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2399" package="modules">
        <name>supportsForcePasswordChange</name>
        <full_name>\sambaSamAccount::supportsForcePasswordChange()</full_name>
        <docblock line="2399">
          <description>Specifies if this module supports to force that a user must change his password on next login.</description>
          <long-description></long-description>
          <tag name="return" description="force password change supported" line="2399" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2414" package="modules">
        <name>passwordChangeRequested</name>
        <full_name>\sambaSamAccount::passwordChangeRequested()</full_name>
        <docblock line="2414">
          <description>This function is called whenever the password should be changed. Account modules
must change their password attributes only if the modules list contains their module name.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;new password&lt;/p&gt;" line="2414" type="String" variable="$password">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of modules for which the password should be changed&lt;/p&gt;" line="2414" type="" variable="$modules"/>
          <tag name="param" description="&lt;p&gt;force the user to change his password at next login&lt;/p&gt;" line="2414" type="boolean" variable="$forcePasswordChange">
            <type>boolean</type>
          </tag>
          <tag name="return" description="list of error messages if any as parameter array for StatusMessage&#10;              e.g. return arrray(array(&amp;#039;ERROR&amp;#039;, &amp;#039;Password change failed.&amp;#039;))" line="2414" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="2414"/>
        </docblock>
        <argument line="0">
          <name>$password</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$modules</name>
          <default></default>
          <type>mixed</type>
        </argument>
        <argument line="0">
          <name>$forcePasswordChange</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="2435" package="modules">
        <name>getGroupName</name>
        <full_name>\sambaSamAccount::getGroupName()</full_name>
        <docblock line="2435">
          <description>Returns the group name of the group with the given group ID.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;group ID&lt;/p&gt;" line="2435" type="String" variable="$groupID">
            <type>String</type>
          </tag>
          <tag name="return" description="group name" line="2435" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$groupID</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="2449" package="modules">
        <name>getPasswordMustChangeTime</name>
        <full_name>\sambaSamAccount::getPasswordMustChangeTime()</full_name>
        <docblock line="2449">
          <description>Returns the time when the user needs to change his password.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of domain objects&lt;/p&gt;" line="2449" type="array" variable="$domains">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;selected domain name&lt;/p&gt;" line="2449" type="String" variable="$selectedDomain">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$domains</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedDomain</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="2481" package="modules">
        <name>getPasswordCanChangeTime</name>
        <full_name>\sambaSamAccount::getPasswordCanChangeTime()</full_name>
        <docblock line="2481">
          <description>Returns the time when the user can change his password.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of domain objects&lt;/p&gt;" line="2481" type="array" variable="$domains">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;selected domain name&lt;/p&gt;" line="2481" type="String" variable="$selectedDomain">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$domains</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedDomain</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="2508" package="modules">
        <name>getHostList</name>
        <full_name>\sambaSamAccount::getHostList()</full_name>
        <docblock line="2508">
          <description>Returns a list of existing hosts.</description>
          <long-description></long-description>
          <tag name="return" description="host names" line="2508" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="2524" package="modules">
        <name>getGroupSIDList</name>
        <full_name>\sambaSamAccount::getGroupSIDList()</full_name>
        <docblock line="2524">
          <description>Returns a list of existing hosts.</description>
          <long-description></long-description>
          <tag name="return" description="host names" line="2524" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="2543" package="modules">
        <name>getDomains</name>
        <full_name>\sambaSamAccount::getDomains()</full_name>
        <docblock line="2543">
          <description>Returns a list of existing Samba 3 domains.</description>
          <long-description></long-description>
          <tag name="return" description="list of samba3domain objects" line="2543" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2559" package="modules">
        <name>setExpirationDate</name>
        <full_name>\sambaSamAccount::setExpirationDate()</full_name>
        <docblock line="2559">
          <description>Sets the expiration date of this account.</description>
          <long-description>If all parameters are null the expiration date will be removed.</long-description>
          <tag name="param" description="&lt;p&gt;year (e.g. 2040)&lt;/p&gt;&#10;" line="2559" type="String" variable="$year">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;month (e.g. 8)&lt;/p&gt;&#10;" line="2559" type="String" variable="$month">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;day (e.g. 27)&lt;/p&gt;&#10;" line="2559" type="String" variable="$day">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$year</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$month</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$day</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2573" package="modules">
        <name>isExtensionEnabled</name>
        <full_name>\sambaSamAccount::isExtensionEnabled()</full_name>
        <docblock line="2573">
          <description>Returns if the Samba extension is enabled.</description>
          <long-description></long-description>
          <tag name="return" description="Samba extension is active" line="2573" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2582" package="modules">
        <name>isDeactivated</name>
        <full_name>\sambaSamAccount::isDeactivated()</full_name>
        <docblock line="2582">
          <description>Returns if the Samba part of the current account is deactivated.</description>
          <long-description></long-description>
          <tag name="return" description="account is locked" line="2582" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2589" package="modules">
        <name>deactivate</name>
        <full_name>\sambaSamAccount::deactivate()</full_name>
        <docblock line="2589">
          <description>Deactivates this account.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2601" package="modules">
        <name>activate</name>
        <full_name>\sambaSamAccount::activate()</full_name>
        <docblock line="2601">
          <description>Activates this account.</description>
          <long-description></long-description>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/posixAccount.inc" generated-path="lib.modules.posixAccount.inc.html" hash="ec2d4829295e4a770352019e31e8d31c" package="modules">
    <docblock line="0">
      <description>Manages Unix accounts for users and hosts.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Tilo Lutz" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="author" description="Michael Duergner" line="0"/>
      <tag name="author" description="Thomas Manninger" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="40" package="modules">
      <extends>\baseModule</extends>
      <implements>\passwordService</implements>
      <name>posixAccount</name>
      <full_name>\posixAccount</full_name>
      <docblock line="40">
        <description>Manages the object class "posixAccount" for users and hosts.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="40"/>
      </docblock>
      <property static="true" visibility="private" line="44" namespace="" package="modules">
        <name>$SPLIT_DELIMITER</name>
        <default>"###x##y##x###"</default>
        <docblock line="44">
          <description>delimiter for lamdaemon commands</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="48" namespace="" package="modules">
        <name>$groups</name>
        <default></default>
        <docblock line="48">
          <description>current group list</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="50" namespace="" package="modules">
        <name>$groups_orig</name>
        <default></default>
        <docblock line="50">
          <description>original group list</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="54" namespace="" package="modules">
        <name>$gonList</name>
        <default>array()</default>
        <docblock line="54">
          <description>current group of names list</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="56" namespace="" package="modules">
        <name>$gonList_orig</name>
        <default>array()</default>
        <docblock line="56">
          <description>original group of names list</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="58" namespace="" package="modules">
        <name>$lamdaemonServers</name>
        <default>array()</default>
        <docblock line="58">
          <description>lamdaemon servers</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="60" namespace="" package="modules">
        <name>$groupCache</name>
        <default>null</default>
        <docblock line="60">
          <description>cache for group objects</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="62" namespace="" package="modules">
        <name>$gonCache</name>
        <default>null</default>
        <docblock line="62">
          <description>cache for group of names objects</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="64" namespace="" package="modules">
        <name>$clearTextPassword</name>
        <default></default>
        <docblock line="64">
          <description>clear text password</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="66" namespace="" package="modules">
        <name>$cachedUIDList</name>
        <default>null</default>
        <docblock line="66">
          <description>caches the list of known UIDs</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="68" namespace="" package="modules">
        <name>$cachedUserNameList</name>
        <default>null</default>
        <docblock line="68">
          <description>caches the list of known user names</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="71" namespace="" package="modules">
        <name>$umlautReplacements</name>
        <default>array('ä' =&gt; 'ae', 'Ä' =&gt; 'Ae', 'ö' =&gt; 'oe', 'Ö' =&gt; 'Oe', 'ü' =&gt; 'ue', 'Ü' =&gt; 'Ue', 'ß' =&gt; 'ss', 'é' =&gt; 'e', 'è' =&gt; 'e', 'ô' =&gt; 'o', 'ç' =&gt; 'c')</default>
        <docblock line="71">
          <description>replacements for common umlauts</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="81" package="modules">
        <name>__construct</name>
        <full_name>\posixAccount::__construct()</full_name>
        <docblock line="81">
          <description>Creates a new windowsPosixGroup object.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account type (user, group, host)&lt;/p&gt;&#10;" line="81" type="string" variable="$scope">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="91" package="modules">
        <name>load_Messages</name>
        <full_name>\posixAccount::load_Messages()</full_name>
        <docblock line="91">
          <description>This function fills the error message array with messages.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="141" package="modules">
        <name>get_metaData</name>
        <full_name>\posixAccount::get_metaData()</full_name>
        <docblock line="141">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="141" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="141"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="563" package="modules">
        <name>init</name>
        <full_name>\posixAccount::init()</full_name>
        <docblock line="563">
          <description>Initializes the module after it became part of an accountContainer</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;the name of the accountContainer object ($_SESSION[$base])&lt;/p&gt;&#10;" line="563" type="string" variable="$base">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$base</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="582" package="modules">
        <name>module_complete</name>
        <full_name>\posixAccount::module_complete()</full_name>
        <docblock line="582">
          <description>This functions is used to check if all settings for this module have been made.</description>
          <long-description></long-description>
          <tag name="return" description="true, if settings are complete" line="582" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="600" package="modules">
        <name>load_attributes</name>
        <full_name>\posixAccount::load_attributes()</full_name>
        <docblock line="600">
          <description>This function loads all needed LDAP attributes.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of attributes&lt;/p&gt;" line="600" type="array" variable="$attr">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attr</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="635" package="modules">
        <name>save_attributes</name>
        <full_name>\posixAccount::save_attributes()</full_name>
        <docblock line="635">
          <description>Returns a list of modifications which have to be made to the LDAP account.</description>
          <long-description></long-description>
          <tag name="return" description="list of modifications&#10;&amp;lt;br&amp;gt;This function returns an array with 3 entries:&#10;&amp;lt;br&amp;gt;array( DN1 (&amp;#039;add&amp;#039; =&amp;gt; array($attr), &amp;#039;remove&amp;#039; =&amp;gt; array($attr), &amp;#039;modify&amp;#039; =&amp;gt; array($attr)), DN2 .... )&#10;&amp;lt;br&amp;gt;DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)&#10;&amp;lt;br&amp;gt;&amp;quot;add&amp;quot; are attributes which have to be added to LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;remove&amp;quot; are attributes which have to be removed from LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;modify&amp;quot; are attributes which have to been modified in LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;info&amp;quot; are values with informational value (e.g. to be used later by pre/postModify actions)" line="635" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="724" package="modules">
        <name>postModifyActions</name>
        <full_name>\posixAccount::postModifyActions()</full_name>
        <docblock line="724">
          <description>Runs the postmodify actions.</description>
          <long-description></long-description>
          <tag name="see" description="" line="724"/>
          <tag name="param" description="" line="724" type="boolean" variable="$newAccount">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;LDAP attributes of this entry&lt;/p&gt;" line="724" type="array" variable="$attributes">
            <type>array</type>
          </tag>
          <tag name="return" description="array which contains status messages. Each entry is an array containing the status message parameters." line="724" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$newAccount</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="872" package="modules">
        <name>delete_attributes</name>
        <full_name>\posixAccount::delete_attributes()</full_name>
        <docblock line="872">
          <description>Additional LDAP operations on delete.</description>
          <long-description></long-description>
          <tag name="return" description="of LDAP operations, same as for save_attributes()" line="872" type="\List">
            <type>\List</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="903" package="modules">
        <name>preDeleteActions</name>
        <full_name>\posixAccount::preDeleteActions()</full_name>
        <docblock line="903">
          <description>Allows the module to run commands before the LDAP entry is deleted.</description>
          <long-description></long-description>
          <tag name="return" description="Array which contains status messages. Each entry is an array containing the status message parameters." line="903" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="948" package="modules">
        <name>process_attributes</name>
        <full_name>\posixAccount::process_attributes()</full_name>
        <docblock line="948">
          <description>Processes user input of the primary module page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="948" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1157" package="modules">
        <name>checkASCII</name>
        <full_name>\posixAccount::checkASCII()</full_name>
        <docblock line="1157">
          <description>Checks if an attribute contains only ASCII charaters and replaces invalid characters.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;attribute value&lt;/p&gt;" line="1157" type="string" variable="$attribute">
            <type>string</type>
          </tag>
          <tag name="return" description="attribute value with replaced non-ASCII characters" line="1157" type="string">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1179" package="modules">
        <name>process_group</name>
        <full_name>\posixAccount::process_group()</full_name>
        <docblock line="1179">
          <description>Processes user input of the group selection page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="1179" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1209" package="modules">
        <name>process_homedir</name>
        <full_name>\posixAccount::process_homedir()</full_name>
        <docblock line="1209">
          <description>Processes user input of the homedir check page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="1209" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1276" package="modules">
        <name>display_html_attributes</name>
        <full_name>\posixAccount::display_html_attributes()</full_name>
        <docblock line="1276">
          <description>Returns the HTML meta data for the main account page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="1276" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1430" package="modules">
        <name>display_html_delete</name>
        <full_name>\posixAccount::display_html_delete()</full_name>
        <docblock line="1430">
          <description>Displays the delete homedir option for the delete page.</description>
          <long-description></long-description>
          <tag name="return" description="meta HTML code" line="1430" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1444" package="modules">
        <name>display_html_group</name>
        <full_name>\posixAccount::display_html_group()</full_name>
        <docblock line="1444">
          <description>Displays the group selection.</description>
          <long-description></long-description>
          <tag name="return" description="meta HTML code" line="1444" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1549" package="modules">
        <name>display_html_homedir</name>
        <full_name>\posixAccount::display_html_homedir()</full_name>
        <docblock line="1549">
          <description>Displays the delete homedir option for the homedir page.</description>
          <long-description></long-description>
          <tag name="return" description="meta HTML code" line="1549" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1621" package="modules">
        <name>get_profileOptions</name>
        <full_name>\posixAccount::get_profileOptions()</full_name>
        <docblock line="1621">
          <description>Returns a list of elements for the account profiles.</description>
          <long-description></long-description>
          <tag name="return" description="elements" line="1621" type="\profile">
            <type>\profile</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1690" package="modules">
        <name>load_profile</name>
        <full_name>\posixAccount::load_profile()</full_name>
        <docblock line="1690">
          <description>Loads the values of an account profile into internal variables.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;hash array with profile values (identifier =&gt; value)&lt;/p&gt;&#10;" line="1690" type="array" variable="$profile">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$profile</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1737" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\posixAccount::get_pdfEntries()</full_name>
        <docblock line="1737">
          <description>Returns the PDF entries for this module.</description>
          <long-description></long-description>
          <tag name="return" description="list of possible PDF entries" line="1737" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1779" package="modules">
        <name>check_configOptions</name>
        <full_name>\posixAccount::check_configOptions()</full_name>
        <docblock line="1779">
          <description>Checks input values of module settings.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of account types which are used&lt;/p&gt;" line="1779" type="array" variable="$scopes">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;hash array containing the settings (array('option' =&gt; array('value')))&lt;/p&gt;&#10;" line="1779" type="array" variable="$options">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages" line="1779" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$scopes</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$options</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1854" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>\posixAccount::build_uploadAccounts()</full_name>
        <docblock line="1854">
          <description>In this function the LDAP account is built up.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) from user input&lt;/p&gt;&#10;" line="1854" type="array" variable="$rawAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)&lt;/p&gt;&#10;" line="1854" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) which are later added to LDAP&lt;/p&gt;&#10;" line="1854" type="array" variable="$partialAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="1854" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages if any" line="1854" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rawAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$partialAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2136" package="modules">
        <name>doUploadPostActions</name>
        <full_name>\posixAccount::doUploadPostActions()</full_name>
        <docblock line="2136">
          <description>This function executes one post upload action.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;array containing one account in each element&lt;/p&gt;" line="2136" type="array" variable="$data">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;array(&lt;column_name&gt; =&gt; &lt;column number&gt;)&lt;/p&gt;&#10;" line="2136" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of accounts which were not created successfully&lt;/p&gt;" line="2136" type="array" variable="$failed">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;variable to store temporary data between two post actions&lt;/p&gt;" line="2136" type="array" variable="$temp">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of LDAP entries&lt;/p&gt;" line="2136" type="array" variable="$accounts">
            <type>array</type>
          </tag>
          <tag name="return" description="current status&#10;&amp;lt;br&amp;gt; array (&#10;&amp;lt;br&amp;gt;  &amp;#039;status&amp;#039; =&amp;gt; &amp;#039;finished&amp;#039; | &amp;#039;inProgress&amp;#039;&#10;&amp;lt;br&amp;gt;  &amp;#039;progress&amp;#039; =&amp;gt; 0..100&#10;&amp;lt;br&amp;gt;  &amp;#039;errors&amp;#039; =&amp;gt; array (&amp;lt;array of parameters for StatusMessage&amp;gt;)&#10;&amp;lt;br&amp;gt; )" line="2136" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$data</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$failed</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$temp</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$accounts</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2317" package="modules">
        <name>getNextUIDs</name>
        <full_name>\posixAccount::getNextUIDs()</full_name>
        <docblock line="2317">
          <description>Returns one or more free UID numbers.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Number of needed free UIDs.&lt;/p&gt;" line="2317" type="integer" variable="$count">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of error messages where errors can be added&lt;/p&gt;" line="2317" type="array" variable="$errors">
            <type>array</type>
          </tag>
          <tag name="return" description="Null if no UIDs are free else an array of free UIDs." line="2317" type="mixed">
            <type>mixed</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$count</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$errors</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="2384" package="modules">
        <name>getNextSambaPoolUIDs</name>
        <full_name>\posixAccount::getNextSambaPoolUIDs()</full_name>
        <docblock line="2384">
          <description>Gets the free UID numbers from an Samba pool entry in LDAP.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;number of needed free UIDs.&lt;/p&gt;" line="2384" type="integer" variable="$count">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of error messages where errors can be added&lt;/p&gt;" line="2384" type="array" variable="$errors">
            <type>array</type>
          </tag>
          <tag name="return" description="null if no UIDs are free else an array of free UIDs" line="2384" type="mixed">
            <type>mixed</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$count</name>
          <default></default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$errors</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2421" package="modules">
        <name>getSelfServiceOptions</name>
        <full_name>\posixAccount::getSelfServiceOptions()</full_name>
        <docblock line="2421">
          <description>Returns the meta HTML code for each input field.</description>
          <long-description>format: array(&lt;field1&gt; =&gt; array(&lt;META HTML&gt;), ...)
It is not possible to display help links.</long-description>
          <tag name="param" description="&lt;p&gt;list of active fields&lt;/p&gt;" line="2421" type="array" variable="$fields">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;attributes of LDAP account&lt;/p&gt;" line="2421" type="array" variable="$attributes">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;indicates that the user is only allowed to change his password and no LDAP content is readable&lt;/p&gt;" line="2421" type="boolean" variable="$passwordChangeOnly">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of read-only fields&lt;/p&gt;&#10;" line="2421" type="array" variable="$readOnlyFields">
            <type>array</type>
          </tag>
          <tag name="return" description="list of meta HTML elements (field name =&amp;gt; htmlTableRow)" line="2421" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$fields</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$passwordChangeOnly</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$readOnlyFields</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2482" package="modules">
        <name>checkSelfServiceOptions</name>
        <full_name>\posixAccount::checkSelfServiceOptions()</full_name>
        <docblock line="2482">
          <description>Checks if all input values are correct and returns the LDAP attributes which should be changed.</description>
          <long-description>&lt;br&gt;Return values:
&lt;br&gt;messages: array of parameters to create status messages
&lt;br&gt;add: array of attributes to add
&lt;br&gt;del: array of attributes to remove
&lt;br&gt;mod: array of attributes to modify
&lt;br&gt;"info" are values with informational value (e.g. to be used later by pre/postModify actions)

Calling this method does not require the existence of an enclosing {@link accountContainer}.</long-description>
          <tag name="param" description="&lt;p&gt;input fields&lt;/p&gt;" line="2482" type="string" variable="$fields">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="2482" type="array" variable="$attributes">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;indicates that the user is only allowed to change his password and no LDAP content is readable&lt;/p&gt;" line="2482" type="boolean" variable="$passwordChangeOnly">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of read-only fields&lt;/p&gt;&#10;" line="2482" type="array" variable="$readOnlyFields">
            <type>array</type>
          </tag>
          <tag name="return" description="messages and attributes (array(&amp;#039;messages&amp;#039; =&amp;gt; array(), &amp;#039;add&amp;#039; =&amp;gt; array(&amp;#039;mail&amp;#039; =&amp;gt; array(&amp;#039;test@test.com&amp;#039;)), &amp;#039;del&amp;#039; =&amp;gt; array(), &amp;#039;mod&amp;#039; =&amp;gt; array(), &amp;#039;info&amp;#039; =&amp;gt; array()))" line="2482" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$fields</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$passwordChangeOnly</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$readOnlyFields</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2542" package="modules">
        <name>managesPasswordAttributes</name>
        <full_name>\posixAccount::managesPasswordAttributes()</full_name>
        <docblock line="2542">
          <description>This method specifies if a module manages password attributes.</description>
          <long-description></long-description>
          <tag name="see" description="" line="2542"/>
          <tag name="return" description="true if this module manages password attributes" line="2542" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2551" package="modules">
        <name>supportsForcePasswordChange</name>
        <full_name>\posixAccount::supportsForcePasswordChange()</full_name>
        <docblock line="2551">
          <description>Specifies if this module supports to force that a user must change his password on next login.</description>
          <long-description></long-description>
          <tag name="return" description="force password change supported" line="2551" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2566" package="modules">
        <name>passwordChangeRequested</name>
        <full_name>\posixAccount::passwordChangeRequested()</full_name>
        <docblock line="2566">
          <description>This function is called whenever the password should be changed. Account modules
must change their password attributes only if the modules list contains their module name.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;new password&lt;/p&gt;" line="2566" type="String" variable="$password">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of modules for which the password should be changed&lt;/p&gt;" line="2566" type="" variable="$modules"/>
          <tag name="param" description="&lt;p&gt;force the user to change his password at next login&lt;/p&gt;" line="2566" type="boolean" variable="$forcePasswordChange">
            <type>boolean</type>
          </tag>
          <tag name="return" description="list of error messages if any as parameter array for StatusMessage&#10;              e.g. return arrray(array(&amp;#039;ERROR&amp;#039;, &amp;#039;Password change failed.&amp;#039;))" line="2566" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="2566"/>
        </docblock>
        <argument line="0">
          <name>$password</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$modules</name>
          <default></default>
          <type>mixed</type>
        </argument>
        <argument line="0">
          <name>$forcePasswordChange</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="2581" package="modules">
        <name>getGID</name>
        <full_name>\posixAccount::getGID()</full_name>
        <docblock line="2581">
          <description>Returns the group ID of the given group.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;group name&lt;/p&gt;" line="2581" type="String" variable="$groupname">
            <type>String</type>
          </tag>
          <tag name="return" description="GID" line="2581" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$groupname</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="2595" package="modules">
        <name>getGroupName</name>
        <full_name>\posixAccount::getGroupName()</full_name>
        <docblock line="2595">
          <description>Returns the group name of the group with the given group ID.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;group ID&lt;/p&gt;" line="2595" type="String" variable="$groupID">
            <type>String</type>
          </tag>
          <tag name="return" description="group name" line="2595" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$groupID</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="2609" package="modules">
        <name>getGroupDN</name>
        <full_name>\posixAccount::getGroupDN()</full_name>
        <docblock line="2609">
          <description>Returns the group DN of the given group.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;group name&lt;/p&gt;" line="2609" type="String" variable="$groupname">
            <type>String</type>
          </tag>
          <tag name="return" description="DN" line="2609" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$groupname</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="2622" package="modules">
        <name>findGroups</name>
        <full_name>\posixAccount::findGroups()</full_name>
        <docblock line="2622">
          <description>Finds all existing LDAP groups.</description>
          <long-description></long-description>
          <tag name="return" description="groups array(array(gidnumber, cn), array(gidnumber, cn), ...)" line="2622" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="2642" package="modules">
        <name>findGroupOfNames</name>
        <full_name>\posixAccount::findGroupOfNames()</full_name>
        <docblock line="2642">
          <description>Finds all existing LDAP group of names.</description>
          <long-description></long-description>
          <tag name="return" description="groups array(dn =&amp;gt; array(&amp;#039;cn&amp;#039; =&amp;gt; array(&amp;#039;groupName&amp;#039;), &amp;#039;objectClass&amp;#039; =&amp;gt; array(&amp;#039;top&amp;#039;, &amp;#039;groupOfNames&amp;#039;)))" line="2642" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="2671" package="modules">
        <name>getUIDs</name>
        <full_name>\posixAccount::getUIDs()</full_name>
        <docblock line="2671">
          <description>Returns a list of existing UID numbers.</description>
          <long-description></long-description>
          <tag name="return" description="list of UID numbers" line="2671" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="2713" package="modules">
        <name>userNameExists</name>
        <full_name>\posixAccount::userNameExists()</full_name>
        <docblock line="2713">
          <description>Checks if the given user name already exists in LDAP.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;user name&lt;/p&gt;" line="2713" type="String" variable="$userName">
            <type>String</type>
          </tag>
          <tag name="return" description="true if already exists" line="2713" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$userName</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="2722" package="modules">
        <name>getUserNames</name>
        <full_name>\posixAccount::getUserNames()</full_name>
        <docblock line="2722">
          <description>Returns a list of all user names in LDAP.</description>
          <long-description></long-description>
          <tag name="return" description="user names" line="2722" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="2762" package="modules">
        <name>areGroupOfNamesActive</name>
        <full_name>\posixAccount::areGroupOfNamesActive()</full_name>
        <docblock line="2762">
          <description>Returns if LAM manages group of names entries.</description>
          <long-description></long-description>
          <tag name="return" description="group of names are active" line="2762" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="2788" package="modules">
        <name>getUserNameSuggestion</name>
        <full_name>\posixAccount::getUserNameSuggestion()</full_name>
        <docblock line="2788">
          <description>Returns a suggestion for the user name.</description>
          <long-description>By deafult this wil be the first character of the first name plus the last name.</long-description>
          <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="2788" type="array" variable="$attrs">
            <type>array</type>
          </tag>
          <tag name="return" description="user name" line="2788" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attrs</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2827" package="modules">
        <name>isLockable</name>
        <full_name>\posixAccount::isLockable()</full_name>
        <docblock line="2827">
          <description>Returns if this account can be locked.</description>
          <long-description>This is the case if a hashed password is set ("{" at the beginning).</long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2839" package="modules">
        <name>isLocked</name>
        <full_name>\posixAccount::isLocked()</full_name>
        <docblock line="2839">
          <description>Returns if the Unix part of the current account is locked.</description>
          <long-description></long-description>
          <tag name="return" description="password is locked" line="2839" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2846" package="modules">
        <name>lock</name>
        <full_name>\posixAccount::lock()</full_name>
        <docblock line="2846">
          <description>Locks the user password of this account.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2856" package="modules">
        <name>unlock</name>
        <full_name>\posixAccount::unlock()</full_name>
        <docblock line="2856">
          <description>Unlocks the user password of this account.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2866" package="modules">
        <name>removeFromUnixGroups</name>
        <full_name>\posixAccount::removeFromUnixGroups()</full_name>
        <docblock line="2866">
          <description>Removes all Unix group memberships from this user.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2873" package="modules">
        <name>removeFromGONGroups</name>
        <full_name>\posixAccount::removeFromGONGroups()</full_name>
        <docblock line="2873">
          <description>Removes all group of names memberships from this user.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="2887" package="modules">
        <name>getNextUserName</name>
        <full_name>\posixAccount::getNextUserName()</full_name>
        <docblock line="2887">
          <description>Returns the next possible user name based on the given one.</description>
          <long-description>If the user name does not end with a number then a "2" is added.
User names with numbers at the end are simply increased by one.
&lt;br&gt;
&lt;br&gt;Attention: This user name might still be in use. This needs to be checked separately.</long-description>
          <tag name="param" description="&lt;p&gt;user name&lt;/p&gt;" line="2887" type="String" variable="$userName">
            <type>String</type>
          </tag>
          <tag name="return" description="new user name" line="2887" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$userName</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="2940" package="modules">
        <name>getShells</name>
        <full_name>\posixAccount::getShells()</full_name>
        <docblock line="2940">
          <description>Returns the list of possible login shells.</description>
          <long-description></long-description>
          <tag name="return" description="login shells" line="2940" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="2968" package="modules">
        <name>manageCn</name>
        <full_name>\posixAccount::manageCn()</full_name>
        <docblock line="2968">
          <description>Returns if the cn attribute should be managed.</description>
          <long-description>If Windows modules are active then cn will not be managed.</long-description>
          <tag name="return" description="manage cn attribute" line="2968" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="2986" package="modules">
        <name>isOptional</name>
        <full_name>\posixAccount::isOptional()</full_name>
        <docblock line="2986">
          <description>Returns if the Unix part can be added and removed.</description>
          <long-description></long-description>
          <tag name="return" description="is optional" line="2986" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="2996" package="modules">
        <name>getPasswordAttrName</name>
        <full_name>\posixAccount::getPasswordAttrName()</full_name>
        <docblock line="2996">
          <description>Returns the password attribute.</description>
          <long-description>Usually, this is userPassword. If Windows modules are active this is unixUserPassword.</long-description>
          <tag name="return" description="attribute name" line="2996" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="3013" package="modules">
        <name>getHomedirAttrName</name>
        <full_name>\posixAccount::getHomedirAttrName()</full_name>
        <docblock line="3013">
          <description>Returns the home directory attribute.</description>
          <long-description>Usually, this is homeDirectory. If Windows modules are active this is unixHomeDirectory.</long-description>
          <tag name="return" description="attribute name" line="3013" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/windowsUser.inc" generated-path="lib.modules.windowsUser.inc.html" hash="4d5fd3ab5405482325b398c56ee1e15b" package="modules">
    <docblock line="0">
      <description>Manages Windows AD (e.g. Samba 4) users.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="35" package="modules">
      <extends>\baseModule</extends>
      <implements>\passwordService</implements>
      <name>windowsUser</name>
      <full_name>\windowsUser</full_name>
      <docblock line="35">
        <description>Manages Windows AD (e.g. Samba 4) users.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="35"/>
      </docblock>
      <constant namespace="" line="38" package="modules">
        <name>DEFAULT_ACCOUNT_CONTROL</name>
        <full_name>\windowsUser::DEFAULT_ACCOUNT_CONTROL</full_name>
        <value>512</value>
        <docblock line="38">
          <description>initial account flags</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="" line="40" package="modules">
        <name>AC_PWD_NEVER_EXPIRES</name>
        <full_name>\windowsUser::AC_PWD_NEVER_EXPIRES</full_name>
        <value>65536</value>
        <docblock line="40">
          <description>password never expires</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="" line="42" package="modules">
        <name>AC_SMARTCARD_REQUIRED</name>
        <full_name>\windowsUser::AC_SMARTCARD_REQUIRED</full_name>
        <value>262144</value>
        <docblock line="42">
          <description>login requires smartcard</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="" line="44" package="modules">
        <name>AC_ACCOUNT_DISABLED</name>
        <full_name>\windowsUser::AC_ACCOUNT_DISABLED</full_name>
        <value>2</value>
        <docblock line="44">
          <description>account is disabled</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="" line="46" package="modules">
        <name>AC_LOCKED_OUT</name>
        <full_name>\windowsUser::AC_LOCKED_OUT</full_name>
        <value>16</value>
        <docblock line="46">
          <description>currently locked out, read only flag</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <property static="false" visibility="private" line="49" namespace="" package="modules">
        <name>$groupList</name>
        <default>array()</default>
        <docblock line="49">
          <description>current group of names list</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="51" namespace="" package="modules">
        <name>$groupList_orig</name>
        <default>array()</default>
        <docblock line="51">
          <description>original group of names list</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="53" namespace="" package="modules">
        <name>$groupCache</name>
        <default>null</default>
        <docblock line="53">
          <description>cache for groups</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="55" namespace="" package="modules">
        <name>$pwdLastSet</name>
        <default>null</default>
        <docblock line="55">
          <description>option for forcing password change, used in postModifyActions</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="57" namespace="" package="modules">
        <name>$clearTextPassword</name>
        <default></default>
        <docblock line="57">
          <description>clear text password</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="67" package="modules">
        <name>get_metaData</name>
        <full_name>\windowsUser::get_metaData()</full_name>
        <docblock line="67">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="67" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="67"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="432" package="modules">
        <name>init</name>
        <full_name>\windowsUser::init()</full_name>
        <docblock line="432">
          <description>Initializes the module after it became part of an accountContainer</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;the name of the accountContainer object ($_SESSION[$base])&lt;/p&gt;&#10;" line="432" type="string" variable="$base">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$base</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="442" package="modules">
        <name>load_Messages</name>
        <full_name>\windowsUser::load_Messages()</full_name>
        <docblock line="442">
          <description>This function fills the $messages variable with output messages from this module.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="474" package="modules">
        <name>load_attributes</name>
        <full_name>\windowsUser::load_attributes()</full_name>
        <docblock line="474">
          <description>This function loads all needed LDAP attributes.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of attributes&lt;/p&gt;" line="474" type="array" variable="$attr">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attr</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="500" package="modules">
        <name>save_attributes</name>
        <full_name>\windowsUser::save_attributes()</full_name>
        <docblock line="500">
          <description>Returns a list of modifications which have to be made to the LDAP account.</description>
          <long-description></long-description>
          <tag name="return" description="list of modifications&#10;&amp;lt;br&amp;gt;This function returns an array with 3 entries:&#10;&amp;lt;br&amp;gt;array( DN1 (&amp;#039;add&amp;#039; =&amp;gt; array($attr), &amp;#039;remove&amp;#039; =&amp;gt; array($attr), &amp;#039;modify&amp;#039; =&amp;gt; array($attr)), DN2 .... )&#10;&amp;lt;br&amp;gt;DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)&#10;&amp;lt;br&amp;gt;&amp;quot;add&amp;quot; are attributes which have to be added to LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;remove&amp;quot; are attributes which have to be removed from LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;modify&amp;quot; are attributes which have to been modified in LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;info&amp;quot; are values with informational value (e.g. to be used later by pre/postModify actions)" line="500" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="512" package="modules">
        <name>display_html_attributes</name>
        <full_name>\windowsUser::display_html_attributes()</full_name>
        <docblock line="512">
          <description>Returns the HTML meta data for the main account page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="512" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="609" package="modules">
        <name>process_attributes</name>
        <full_name>\windowsUser::process_attributes()</full_name>
        <docblock line="609">
          <description>Processes user input of the primary module page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="609" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="717" package="modules">
        <name>display_html_group</name>
        <full_name>\windowsUser::display_html_group()</full_name>
        <docblock line="717">
          <description>Displays the group selection.</description>
          <long-description></long-description>
          <tag name="return" description="meta HTML code" line="717" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="784" package="modules">
        <name>process_group</name>
        <full_name>\windowsUser::process_group()</full_name>
        <docblock line="784">
          <description>Processes user input of the group selection page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="784" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="804" package="modules">
        <name>postModifyActions</name>
        <full_name>\windowsUser::postModifyActions()</full_name>
        <docblock line="804">
          <description>Runs the postmodify actions.</description>
          <long-description></long-description>
          <tag name="see" description="" line="804"/>
          <tag name="param" description="" line="804" type="boolean" variable="$newAccount">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;LDAP attributes of this entry&lt;/p&gt;" line="804" type="array" variable="$attributes">
            <type>array</type>
          </tag>
          <tag name="return" description="array which contains status messages. Each entry is an array containing the status message parameters." line="804" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$newAccount</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="860" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>\windowsUser::build_uploadAccounts()</full_name>
        <docblock line="860">
          <description>In this function the LDAP account is built up.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) from user input&lt;/p&gt;&#10;" line="860" type="array" variable="$rawAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)&lt;/p&gt;&#10;" line="860" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) which are later added to LDAP&lt;/p&gt;&#10;" line="860" type="array" variable="$partialAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="860" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages if any" line="860" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rawAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$partialAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1110" package="modules">
        <name>doUploadPostActions</name>
        <full_name>\windowsUser::doUploadPostActions()</full_name>
        <docblock line="1110">
          <description>This function executes one post upload action.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;array containing one account in each element&lt;/p&gt;" line="1110" type="array" variable="$data">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;array(&lt;column_name&gt; =&gt; &lt;column number&gt;)&lt;/p&gt;&#10;" line="1110" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of accounts which were not created successfully&lt;/p&gt;" line="1110" type="array" variable="$failed">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;variable to store temporary data between two post actions&lt;/p&gt;" line="1110" type="array" variable="$temp">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of LDAP entries&lt;/p&gt;" line="1110" type="array" variable="$accounts">
            <type>array</type>
          </tag>
          <tag name="return" description="current status&#10;&amp;lt;br&amp;gt; array (&#10;&amp;lt;br&amp;gt;  &amp;#039;status&amp;#039; =&amp;gt; &amp;#039;finished&amp;#039; | &amp;#039;inProgress&amp;#039;&#10;&amp;lt;br&amp;gt;  &amp;#039;progress&amp;#039; =&amp;gt; 0..100&#10;&amp;lt;br&amp;gt;  &amp;#039;errors&amp;#039; =&amp;gt; array (&amp;lt;array of parameters for StatusMessage&amp;gt;)&#10;&amp;lt;br&amp;gt; )" line="1110" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$data</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$failed</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$temp</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$accounts</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1213" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\windowsUser::get_pdfEntries()</full_name>
        <docblock line="1213">
          <description>Returns a list of PDF entries</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1275" package="modules">
        <name>get_profileOptions</name>
        <full_name>\windowsUser::get_profileOptions()</full_name>
        <docblock line="1275">
          <description>Returns a list of elements for the account profiles.</description>
          <long-description></long-description>
          <tag name="return" description="profile elements" line="1275" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1294" package="modules">
        <name>load_profile</name>
        <full_name>\windowsUser::load_profile()</full_name>
        <docblock line="1294">
          <description>Loads the values of an account profile into internal variables.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;hash array with profile values (identifier =&gt; value)&lt;/p&gt;&#10;" line="1294" type="array" variable="$profile">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$profile</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1314" package="modules">
        <name>getSelfServiceOptions</name>
        <full_name>\windowsUser::getSelfServiceOptions()</full_name>
        <docblock line="1314">
          <description>Returns the meta HTML code for each input field.</description>
          <long-description>format: array(&lt;field1&gt; =&gt; array(&lt;META HTML&gt;), ...)
It is not possible to display help links.</long-description>
          <tag name="param" description="&lt;p&gt;list of active fields&lt;/p&gt;" line="1314" type="array" variable="$fields">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;attributes of LDAP account&lt;/p&gt;" line="1314" type="array" variable="$attributes">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;indicates that the user is only allowed to change his password and no LDAP content is readable&lt;/p&gt;" line="1314" type="boolean" variable="$passwordChangeOnly">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of read-only fields&lt;/p&gt;&#10;" line="1314" type="array" variable="$readOnlyFields">
            <type>array</type>
          </tag>
          <tag name="return" description="list of meta HTML elements (field name =&amp;gt; htmlTableRow)" line="1314" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$fields</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$passwordChangeOnly</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$readOnlyFields</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1364" package="modules">
        <name>checkSelfServiceOptions</name>
        <full_name>\windowsUser::checkSelfServiceOptions()</full_name>
        <docblock line="1364">
          <description>Checks if all input values are correct and returns the LDAP attributes which should be changed.</description>
          <long-description>&lt;br&gt;Return values:
&lt;br&gt;messages: array of parameters to create status messages
&lt;br&gt;add: array of attributes to add
&lt;br&gt;del: array of attributes to remove
&lt;br&gt;mod: array of attributes to modify
&lt;br&gt;info: array of values with informational value (e.g. to be used later by pre/postModify actions)

Calling this method does not require the existence of an enclosing {@link accountContainer}.</long-description>
          <tag name="param" description="&lt;p&gt;input fields&lt;/p&gt;" line="1364" type="string" variable="$fields">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="1364" type="array" variable="$attributes">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;indicates that the user is only allowed to change his password and no LDAP content is readable&lt;/p&gt;" line="1364" type="boolean" variable="$passwordChangeOnly">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of read-only fields&lt;/p&gt;&#10;" line="1364" type="array" variable="$readOnlyFields">
            <type>array</type>
          </tag>
          <tag name="return" description="messages and attributes (array(&amp;#039;messages&amp;#039; =&amp;gt; array(), &amp;#039;add&amp;#039; =&amp;gt; array(&amp;#039;mail&amp;#039; =&amp;gt; array(&amp;#039;test@test.com&amp;#039;)), &amp;#039;del&amp;#039; =&amp;gt; array(), &amp;#039;mod&amp;#039; =&amp;gt; array(), &amp;#039;info&amp;#039; =&amp;gt; array()))" line="1364" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$fields</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$passwordChangeOnly</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$readOnlyFields</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1414" package="modules">
        <name>setSelfServicePassword</name>
        <full_name>\windowsUser::setSelfServicePassword()</full_name>
        <docblock line="1414">
          <description>Sets the user password in self service.</description>
          <long-description>Since the change requires the old password we need to run ldapmodify for this task.

Enter description here ...</long-description>
          <tag name="param" description="&lt;p&gt;return value for checkSelfServiceOptions() (used to add message if any)&lt;/p&gt;&#10;" line="1414" type="array" variable="$return">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="1414" type="array" variable="$attributes">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$return</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1483" package="modules">
        <name>managesPasswordAttributes</name>
        <full_name>\windowsUser::managesPasswordAttributes()</full_name>
        <docblock line="1483">
          <description>This method specifies if a module manages password attributes. The module alias will
then appear as option in the GUI.</description>
          <long-description>&lt;br&gt;If the module only wants to get notified about password changes then return false.</long-description>
          <tag name="return" description="true if this module manages password attributes" line="1483" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1492" package="modules">
        <name>supportsForcePasswordChange</name>
        <full_name>\windowsUser::supportsForcePasswordChange()</full_name>
        <docblock line="1492">
          <description>Specifies if this module supports to force that a user must change his password on next login.</description>
          <long-description></long-description>
          <tag name="return" description="force password change supported" line="1492" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1506" package="modules">
        <name>passwordChangeRequested</name>
        <full_name>\windowsUser::passwordChangeRequested()</full_name>
        <docblock line="1506">
          <description>This function is called whenever the password should be changed. Account modules
must change their password attributes only if the modules list contains their module name.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;new password&lt;/p&gt;" line="1506" type="String" variable="$password">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of modules for which the password should be changed&lt;/p&gt;" line="1506" type="array" variable="$modules">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;force the user to change his password at next login&lt;/p&gt;" line="1506" type="boolean" variable="$forcePasswordChange">
            <type>boolean</type>
          </tag>
          <tag name="return" description="list of error messages if any as parameter array for StatusMessage&#10;              e.g. return arrray(array(&amp;#039;ERROR&amp;#039;, &amp;#039;Password change failed.&amp;#039;))" line="1506" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$password</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$modules</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$forcePasswordChange</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="1526" package="modules">
        <name>pwdAttributeValue</name>
        <full_name>\windowsUser::pwdAttributeValue()</full_name>
        <docblock line="1526">
          <description>Creates the LDAP password value.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;password&lt;/p&gt;" line="1526" type="String" variable="$password">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$password</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="1536" package="modules">
        <name>isDeactivated</name>
        <full_name>\windowsUser::isDeactivated()</full_name>
        <docblock line="1536">
          <description>Returns if the account is currently deactivated.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="1536" type="array" variable="$attrs">
            <type>array</type>
          </tag>
          <tag name="return" description="is deactivated" line="1536" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attrs</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1550" package="modules">
        <name>setIsDeactivated</name>
        <full_name>\windowsUser::setIsDeactivated()</full_name>
        <docblock line="1550">
          <description>Sets if the account is currently deactivated.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;is deactivated&lt;/p&gt;" line="1550" type="boolean" variable="$deactivated">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;LDAP attributes to modify (default $this-&gt;attributes)&lt;/p&gt;&#10;" line="1550" type="array" variable="$attrs">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$deactivated</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$attrs</name>
          <default>null</default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="private" namespace="" line="1574" package="modules">
        <name>isLockedOut</name>
        <full_name>\windowsUser::isLockedOut()</full_name>
        <docblock line="1574">
          <description>Returns if the account is currently locked out.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="1574" type="array" variable="$attrs">
            <type>array</type>
          </tag>
          <tag name="return" description="is locked out" line="1574" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attrs</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="1587" package="modules">
        <name>unlock</name>
        <full_name>\windowsUser::unlock()</full_name>
        <docblock line="1587">
          <description>Unlocks the account.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;LDAP attributes to modify&lt;/p&gt;" line="1587" type="array" variable="$attrs">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attrs</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="1603" package="modules">
        <name>isSmartCardRequired</name>
        <full_name>\windowsUser::isSmartCardRequired()</full_name>
        <docblock line="1603">
          <description>Returns if the account requires a smartcard to login.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="1603" type="array" variable="$attrs">
            <type>array</type>
          </tag>
          <tag name="return" description="requires a smartcard" line="1603" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attrs</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="1617" package="modules">
        <name>setIsSmartCardRequired</name>
        <full_name>\windowsUser::setIsSmartCardRequired()</full_name>
        <docblock line="1617">
          <description>Sets if the account requires a smartcard to login.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;LDAP attributes to modify&lt;/p&gt;" line="1617" type="array" variable="$attrs">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;requires a smartcard&lt;/p&gt;" line="1617" type="boolean" variable="$requireCard">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attrs</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$requireCard</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="1638" package="modules">
        <name>isNeverExpiring</name>
        <full_name>\windowsUser::isNeverExpiring()</full_name>
        <docblock line="1638">
          <description>Returns if the account never expires.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="1638" type="array" variable="$attrs">
            <type>array</type>
          </tag>
          <tag name="return" description="never expires" line="1638" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attrs</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="1652" package="modules">
        <name>setIsNeverExpiring</name>
        <full_name>\windowsUser::setIsNeverExpiring()</full_name>
        <docblock line="1652">
          <description>Sets if the account never expires.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;LDAP attributes to modify&lt;/p&gt;" line="1652" type="array" variable="$attrs">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;never expires&lt;/p&gt;" line="1652" type="boolean" variable="$neverExpires">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attrs</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$neverExpires</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1672" package="modules">
        <name>findGroups</name>
        <full_name>\windowsUser::findGroups()</full_name>
        <docblock line="1672">
          <description>Finds all existing groups.</description>
          <long-description></long-description>
          <tag name="return" description="group DNs" line="1672" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
    </class>
    <markers>
      <todo line="1335">remove this workaround when self service allows to specify the list of active modules</todo>
      <todo line="1391">remove this workaround when self service allows to specify the list of active modules</todo>
    </markers>
    <source> </source>
  </file>
  <file path="lib/modules/kolabUser.inc" generated-path="lib.modules.kolabUser.inc.html" hash="0935023ae0ea49fc6702e3fc1aba0c37" package="modules">
    <docblock line="0">
      <description>Manages Kolab user accounts.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="35" package="modules">
      <extends>\baseModule</extends>
      <name>kolabUser</name>
      <full_name>\kolabUser</full_name>
      <docblock line="35">
        <description>Manages Kolab user accounts.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="35"/>
      </docblock>
      <property static="false" visibility="private" line="38" namespace="" package="modules">
        <name>$invitationPolicies</name>
        <default></default>
        <docblock line="38">
          <description>list of invitation policies</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="45" package="modules">
        <name>__construct</name>
        <full_name>\kolabUser::__construct()</full_name>
        <docblock line="45">
          <description>Creates a new kolabUser object.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account type (user, group, host)&lt;/p&gt;&#10;" line="45" type="string" variable="$scope">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="66" package="modules">
        <name>get_metaData</name>
        <full_name>\kolabUser::get_metaData()</full_name>
        <docblock line="66">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="66" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="66"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="210" package="modules">
        <name>load_Messages</name>
        <full_name>\kolabUser::load_Messages()</full_name>
        <docblock line="210">
          <description>This function fills the error message array with messages</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="230" package="modules">
        <name>display_html_attributes</name>
        <full_name>\kolabUser::display_html_attributes()</full_name>
        <docblock line="230">
          <description>Returns the HTML meta data for the main account page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="230" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="373" package="modules">
        <name>process_attributes</name>
        <full_name>\kolabUser::process_attributes()</full_name>
        <docblock line="373">
          <description>Processes user input of the primary module page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="373" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="495" package="modules">
        <name>display_html_deleteUser</name>
        <full_name>\kolabUser::display_html_deleteUser()</full_name>
        <docblock line="495">
          <description>This function will create the meta HTML code to show a page to mark an account for deletion.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="495" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="509" package="modules">
        <name>process_deleteUser</name>
        <full_name>\kolabUser::process_deleteUser()</full_name>
        <docblock line="509">
          <description>Write variables into object and do some regex checks</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="521" package="modules">
        <name>module_complete</name>
        <full_name>\kolabUser::module_complete()</full_name>
        <docblock line="521">
          <description>This function returns true if all needed settings are done.</description>
          <long-description></long-description>
          <tag name="return" description="if account can be saved" line="521" type="\true,">
            <type>\true,</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="550" package="modules">
        <name>save_attributes</name>
        <full_name>\kolabUser::save_attributes()</full_name>
        <docblock line="550">
          <description>Returns a list of modifications which have to be made to the LDAP account.</description>
          <long-description></long-description>
          <tag name="return" description="list of modifications&#10;&amp;lt;br&amp;gt;This function returns an array with 3 entries:&#10;&amp;lt;br&amp;gt;array( DN1 (&amp;#039;add&amp;#039; =&amp;gt; array($attr), &amp;#039;remove&amp;#039; =&amp;gt; array($attr), &amp;#039;modify&amp;#039; =&amp;gt; array($attr)), DN2 .... )&#10;&amp;lt;br&amp;gt;DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)&#10;&amp;lt;br&amp;gt;&amp;quot;add&amp;quot; are attributes which have to be added to LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;remove&amp;quot; are attributes which have to be removed from LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;modify&amp;quot; are attributes which have to been modified in LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;info&amp;quot; are values with informational value (e.g. to be used later by pre/postModify actions)" line="550" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="567" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>\kolabUser::build_uploadAccounts()</full_name>
        <docblock line="567">
          <description>In this function the LDAP account is built up.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) from user input&lt;/p&gt;&#10;" line="567" type="array" variable="$rawAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)&lt;/p&gt;&#10;" line="567" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) which are later added to LDAP&lt;/p&gt;&#10;" line="567" type="array" variable="$partialAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="567" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages if any" line="567" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rawAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$partialAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="699" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\kolabUser::get_pdfEntries()</full_name>
        <docblock line="699">
          <description>Returns the PDF entries for this module.</description>
          <long-description></long-description>
          <tag name="return" description="list of possible PDF entries" line="699" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="738" package="modules">
        <name>getSelfServiceOptions</name>
        <full_name>\kolabUser::getSelfServiceOptions()</full_name>
        <docblock line="738">
          <description>Returns the meta HTML code for each input field.</description>
          <long-description>format: array(&lt;field1&gt; =&gt; array(&lt;META HTML&gt;), ...)
It is not possible to display help links.</long-description>
          <tag name="param" description="&lt;p&gt;list of active fields&lt;/p&gt;" line="738" type="array" variable="$fields">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;attributes of LDAP account&lt;/p&gt;" line="738" type="array" variable="$attributes">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;indicates that the user is only allowed to change his password and no LDAP content is readable&lt;/p&gt;" line="738" type="boolean" variable="$passwordChangeOnly">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of read-only fields&lt;/p&gt;&#10;" line="738" type="array" variable="$readOnlyFields">
            <type>array</type>
          </tag>
          <tag name="return" description="list of meta HTML elements (field name =&amp;gt; htmlTableRow)" line="738" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$fields</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$passwordChangeOnly</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$readOnlyFields</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="862" package="modules">
        <name>checkSelfServiceOptions</name>
        <full_name>\kolabUser::checkSelfServiceOptions()</full_name>
        <docblock line="862">
          <description>Checks if all input values are correct and returns the LDAP attributes which should be changed.</description>
          <long-description>&lt;br&gt;Return values:
&lt;br&gt;messages: array of parameters to create status messages
&lt;br&gt;add: array of attributes to add
&lt;br&gt;del: array of attributes to remove
&lt;br&gt;mod: array of attributes to modify
&lt;br&gt;info: array of values with informational value (e.g. to be used later by pre/postModify actions)

Calling this method does not require the existence of an enclosing {@link accountContainer}.</long-description>
          <tag name="param" description="&lt;p&gt;input fields&lt;/p&gt;" line="862" type="string" variable="$fields">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="862" type="array" variable="$attributes">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;indicates that the user is only allowed to change his password and no LDAP content is readable&lt;/p&gt;" line="862" type="boolean" variable="$passwordChangeOnly">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of read-only fields&lt;/p&gt;&#10;" line="862" type="array" variable="$readOnlyFields">
            <type>array</type>
          </tag>
          <tag name="return" description="messages and attributes (array(&amp;#039;messages&amp;#039; =&amp;gt; array(), &amp;#039;add&amp;#039; =&amp;gt; array(&amp;#039;mail&amp;#039; =&amp;gt; array(&amp;#039;test@test.com&amp;#039;)), &amp;#039;del&amp;#039; =&amp;gt; array(), &amp;#039;mod&amp;#039; =&amp;gt; array(), &amp;#039;info&amp;#039; =&amp;gt; array()))" line="862" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$fields</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$passwordChangeOnly</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$readOnlyFields</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/range.inc" generated-path="lib.modules.range.inc.html" hash="58ad152969b431860783edd204849842" package="modules">
    <docblock line="0">
      <description>Manages DHCP ranges for DHCP server.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Thomas Manninger" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="41" package="modules">
      <extends>\baseModule</extends>
      <name>range</name>
      <full_name>\range</full_name>
      <docblock line="41">
        <description>Manages DHCP ranges for DHCP server.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="41"/>
      </docblock>
      <property static="false" visibility="public" line="44" namespace="" package="modules">
        <name>$subnet</name>
        <default></default>
        <docblock line="44">
          <description>subnet</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="47" namespace="" package="modules">
        <name>$ranges</name>
        <default></default>
        <docblock line="47">
          <description>ranges</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="50" namespace="" package="modules">
        <name>$processed</name>
        <default></default>
        <docblock line="50">
          <description>Range -&gt; Function attibute_processed already running?</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="53" namespace="" package="modules">
        <name>$overlaped</name>
        <default></default>
        <docblock line="53">
          <description>For check, if IPs overlaped.</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="62" package="modules">
        <name>get_metaData</name>
        <full_name>\range::get_metaData()</full_name>
        <docblock line="62">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="62" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="62"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="106" package="modules">
        <name>load_Messages</name>
        <full_name>\range::load_Messages()</full_name>
        <docblock line="106">
          <description>This function fills the error message array with messages.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="true" visibility="private" namespace="" line="118" package="modules">
        <name>calculateSubnet</name>
        <full_name>\range::calculateSubnet()</full_name>
        <docblock line="118">
          <description>Calculates the subnet for a given IP and netmask.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;IP address&lt;/p&gt;" line="118" type="String" variable="$ip">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;network mask&lt;/p&gt;" line="118" type="String" variable="$mask">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$ip</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$mask</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="131" package="modules">
        <name>check_range</name>
        <full_name>\range::check_range()</full_name>
        <docblock line="131">
          <description>Checks if the first IP is smaller than the second IP.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;first ip&lt;/p&gt;" line="131" type="String" variable="$first_ip">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;second ip&lt;/p&gt;" line="131" type="String" variable="$second_ip">
            <type>String</type>
          </tag>
          <tag name="return" description="if it&amp;#039;s a valid Range, else false;" line="131" type="\true,">
            <type>\true,</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$first_ip</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$second_ip</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="154" package="modules">
        <name>check_subnet_range</name>
        <full_name>\range::check_subnet_range()</full_name>
        <docblock line="154">
          <description>Check if an IP address is in the correct subnet.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;IP address&lt;/p&gt;" line="154" type="String" variable="$ip">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;subnet&lt;/p&gt;" line="154" type="String" variable="$subnet">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;network mask&lt;/p&gt;" line="154" type="String" variable="$mask">
            <type>String</type>
          </tag>
          <tag name="return" description="if the range and subnet valid, else false" line="154" type="true">
            <type>true</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$ip</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$subnet</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$mask</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="169" package="modules">
        <name>overlaped_range</name>
        <full_name>\range::overlaped_range()</full_name>
        <docblock line="169">
          <description>Checked, if Ranges are overlaped.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;ip&lt;/p&gt;" line="169" type="\first" variable="">
            <type>\first</type>
          </tag>
          <tag name="param" description="&lt;p&gt;ip&lt;/p&gt;" line="169" type="\second" variable="">
            <type>\second</type>
          </tag>
          <tag name="return" description="if overlaped, else true." line="169" type="\false,">
            <type>\false,</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$ip</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$ipB</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="192" package="modules">
        <name>reset_overlaped_range</name>
        <full_name>\range::reset_overlaped_range()</full_name>
        <docblock line="192">
          <description>Reset the overlaped_range() function</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="201" package="modules">
        <name>getButtonStatus</name>
        <full_name>\range::getButtonStatus()</full_name>
        <docblock line="201">
          <description>Controls if the module button the account page is visible and activated.</description>
          <long-description></long-description>
          <tag name="return" description="status (&amp;quot;enabled&amp;quot;, &amp;quot;disabled&amp;quot;, &amp;quot;hidden&amp;quot;)" line="201" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="215" package="modules">
        <name>load_attributes</name>
        <full_name>\range::load_attributes()</full_name>
        <docblock line="215">
          <description>This function loads all needed LDAP attributes.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of attributes&lt;/p&gt;" line="215" type="array" variable="$attr">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attr</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="242" package="modules">
        <name>reload_ranges</name>
        <full_name>\range::reload_ranges()</full_name>
        <docblock line="242">
          <description>Adapt the Ranges with the subnet.</description>
          <long-description></long-description>
          <tag name="return" description="if ranges were edit." line="242" type="\true,">
            <type>\true,</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="283" package="modules">
        <name>process_attributes</name>
        <full_name>\range::process_attributes()</full_name>
        <docblock line="283">
          <description>Processes user input of the primary module page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="283" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="391" package="modules">
        <name>display_html_attributes</name>
        <full_name>\range::display_html_attributes()</full_name>
        <docblock line="391">
          <description>Returns the HTML meta data for the main account page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="391" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="467" package="modules">
        <name>save_attributes</name>
        <full_name>\range::save_attributes()</full_name>
        <docblock line="467">
          <description>Returns a list of modifications which have to be made to the LDAP account.</description>
          <long-description></long-description>
          <tag name="return" description="list of modifications&#10;&amp;lt;br&amp;gt;This function returns an array with 3 entries:&#10;&amp;lt;br&amp;gt;array( DN1 (&amp;#039;add&amp;#039; =&amp;gt; array($attr), &amp;#039;remove&amp;#039; =&amp;gt; array($attr), &amp;#039;modify&amp;#039; =&amp;gt; array($attr)), DN2 .... )&#10;&amp;lt;br&amp;gt;DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)&#10;&amp;lt;br&amp;gt;&amp;quot;add&amp;quot; are attributes which have to be added to LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;remove&amp;quot; are attributes which have to be removed from LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;modify&amp;quot; are attributes which have to been modified in LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;info&amp;quot; are values with informational value (e.g. to be used later by pre/postModify actions)" line="467" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="482" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\range::get_pdfEntries()</full_name>
        <docblock line="482">
          <description>Returns the PDF entries for this module.</description>
          <long-description></long-description>
          <tag name="return" description="list of possible PDF entries" line="482" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/ddns.inc" generated-path="lib.modules.ddns.inc.html" hash="d5f24b737263b26159c0a9f0401cc54b" package="modules">
    <docblock line="0">
      <description>Manages DDNS entries.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Thomas Manninger" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="40" package="modules">
      <extends>\baseModule</extends>
      <name>ddns</name>
      <full_name>\ddns</full_name>
      <docblock line="40">
        <description>Manages DDNS entries.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="40"/>
      </docblock>
      <property static="false" visibility="public" line="43" namespace="" package="modules">
        <name>$ddns</name>
        <default>array()</default>
        <docblock line="43">
          <description>standard DDNS settings</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="51" package="modules">
        <name>get_metaData</name>
        <full_name>\ddns::get_metaData()</full_name>
        <docblock line="51">
          <description>Returns meta data that is interpreted by parent class.</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="51" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="141" package="modules">
        <name>load_Messages</name>
        <full_name>\ddns::load_Messages()</full_name>
        <docblock line="141">
          <description>This function fills the message array.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="155" package="modules">
        <name>module_complete</name>
        <full_name>\ddns::module_complete()</full_name>
        <docblock line="155">
          <description>This functions returns true if all needed settings are done.</description>
          <long-description></long-description>
          <tag name="return" description="true if LDAP operation can be done" line="155" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="193" package="modules">
        <name>save_attributes</name>
        <full_name>\ddns::save_attributes()</full_name>
        <docblock line="193">
          <description>Returns a list of modifications which have to be made to the LDAP account.</description>
          <long-description></long-description>
          <tag name="return" description="list of modifications&#10;&amp;lt;br&amp;gt;This function returns an array with 3 entries:&#10;&amp;lt;br&amp;gt;array( DN1 (&amp;#039;add&amp;#039; =&amp;gt; array($attr), &amp;#039;remove&amp;#039; =&amp;gt; array($attr), &amp;#039;modify&amp;#039; =&amp;gt; array($attr)), DN2 .... )&#10;&amp;lt;br&amp;gt;DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)&#10;&amp;lt;br&amp;gt;&amp;quot;add&amp;quot; are attributes which have to be added to LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;remove&amp;quot; are attributes which have to be removed from LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;modify&amp;quot; are attributes which have to been modified in LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;info&amp;quot; are values with informational value (e.g. to be used later by pre/postModify actions)" line="193" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="200" package="modules">
        <name>check_if_ddns_is_enable</name>
        <full_name>\ddns::check_if_ddns_is_enable()</full_name>
        <docblock line="200">
          <description>This function check if ddns is enable.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="229" package="modules">
        <name>process_attributes</name>
        <full_name>\ddns::process_attributes()</full_name>
        <docblock line="229">
          <description>Processes user input of the primary module page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="229" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="252" package="modules">
        <name>process_attributes_mainSettings</name>
        <full_name>\ddns::process_attributes_mainSettings()</full_name>
        <docblock line="252">
          <description>Process for mainsettings</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="289" package="modules">
        <name>process_attributes_account</name>
        <full_name>\ddns::process_attributes_account()</full_name>
        <docblock line="289">
          <description>Process for account</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="348" package="modules">
        <name>display_html_attributes</name>
        <full_name>\ddns::display_html_attributes()</full_name>
        <docblock line="348">
          <description>Returns the HTML meta data for the main account page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="348" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="403" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\ddns::get_pdfEntries()</full_name>
        <docblock line="403">
          <description>Returns the PDF entries for this module.</description>
          <long-description></long-description>
          <tag name="return" description="list of possible PDF entries" line="403" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="428" package="modules">
        <name>getDNSServer</name>
        <full_name>\ddns::getDNSServer()</full_name>
        <docblock line="428">
          <description>Returns the IP of the DNS server.</description>
          <long-description></long-description>
          <tag name="return" description="IP address" line="428" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="451" package="modules">
        <name>getZoneNames</name>
        <full_name>\ddns::getZoneNames()</full_name>
        <docblock line="451">
          <description>Returns the zone names.</description>
          <long-description></long-description>
          <tag name="return" description="zone names array(zone, reverse zone)" line="451" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="479" package="modules">
        <name>isDynDNSActivated</name>
        <full_name>\ddns::isDynDNSActivated()</full_name>
        <docblock line="479">
          <description>Returns if DDNS is activated.</description>
          <long-description></long-description>
          <tag name="return" description="activated" line="479" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="497" package="modules">
        <name>setDynDNSActivated</name>
        <full_name>\ddns::setDynDNSActivated()</full_name>
        <docblock line="497">
          <description>Sets if DDNS is activated.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;activated&lt;/p&gt;" line="497" type="boolean" variable="$activated">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$activated</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="519" package="modules">
        <name>addFixIPs</name>
        <full_name>\ddns::addFixIPs()</full_name>
        <docblock line="519">
          <description>Returns if fixed IPs are added to DDNS.</description>
          <long-description></long-description>
          <tag name="return" description="add fixed IPs" line="519" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="537" package="modules">
        <name>setFixIPs</name>
        <full_name>\ddns::setFixIPs()</full_name>
        <docblock line="537">
          <description>Sets if client updates are ignored.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;add fixed IPs&lt;/p&gt;" line="537" type="boolean" variable="$add">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$add</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="556" package="modules">
        <name>isIgnoreClientUpdates</name>
        <full_name>\ddns::isIgnoreClientUpdates()</full_name>
        <docblock line="556">
          <description>Returns if client updates are ignored.</description>
          <long-description></long-description>
          <tag name="return" description="ignore client updates" line="556" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="574" package="modules">
        <name>setIgnoreClientUpdates</name>
        <full_name>\ddns::setIgnoreClientUpdates()</full_name>
        <docblock line="574">
          <description>Sets if client updates are ignored.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;ignore client updates&lt;/p&gt;" line="574" type="boolean" variable="$ignore">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$ignore</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="596" package="modules">
        <name>getUpdateKey</name>
        <full_name>\ddns::getUpdateKey()</full_name>
        <docblock line="596">
          <description>Returns the key for DNS updates.</description>
          <long-description></long-description>
          <tag name="return" description="key" line="596" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="614" package="modules">
        <name>setUpdateKey</name>
        <full_name>\ddns::setUpdateKey()</full_name>
        <docblock line="614">
          <description>Sets the key for DNS updates.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;key&lt;/p&gt;" line="614" type="String" variable="$key">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$key</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="639" package="modules">
        <name>load_attributes</name>
        <full_name>\ddns::load_attributes()</full_name>
        <docblock line="639">
          <description>This function loads the LDAP attributes when an account should be loaded.</description>
          <long-description>Calling this method requires the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
By default this method loads the object classes and accounts which are specified in {@link getManagedObjectClasses()}
and {@link getManagedAttributes()}.</long-description>
          <tag name="param" description="&lt;p&gt;array like the array returned by get_ldap_attributes(dn of account) but without count indices&lt;/p&gt;&#10;" line="639" type="array" variable="$attributes">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="652" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>\ddns::build_uploadAccounts()</full_name>
        <docblock line="652">
          <description>In this function the LDAP account is built up.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) from user input&lt;/p&gt;&#10;" line="652" type="array" variable="$rawAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)&lt;/p&gt;&#10;" line="652" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) which are later added to LDAP&lt;/p&gt;&#10;" line="652" type="array" variable="$partialAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="652" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages if any" line="652" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rawAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$partialAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/sambaGroupMapping.inc" generated-path="lib.modules.sambaGroupMapping.inc.html" hash="399265bbbf55e055d4fcd5eb0ec0c402" package="modules">
    <docblock line="0">
      <description>Manages Samba 3 accounts for groups.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Tilo Lutz" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="author" description="Michael Duergner" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="40" package="modules">
      <extends>\baseModule</extends>
      <name>sambaGroupMapping</name>
      <full_name>\sambaGroupMapping</full_name>
      <docblock line="40">
        <description>Manages the object class "sambaGroupMapping" for groups.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="40"/>
      </docblock>
      <property static="false" visibility="private" line="44" namespace="" package="modules">
        <name>$rids</name>
        <default></default>
        <docblock line="44">
          <description>Array of well known RIDs</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="46" namespace="" package="modules">
        <name>$sambaGroupTypes</name>
        <default></default>
        <docblock line="46">
          <description>Array of sambaGroupTypes</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="48" namespace="" package="modules">
        <name>$cachedDomainList</name>
        <default>null</default>
        <docblock line="48">
          <description>cache for domain list</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="50" namespace="" package="modules">
        <name>$sidCache</name>
        <default>null</default>
        <docblock line="50">
          <description>cache for existing Samba entries (array(dn =&gt; cn))</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="57" package="modules">
        <name>__construct</name>
        <full_name>\sambaGroupMapping::__construct()</full_name>
        <docblock line="57">
          <description>Creates a new module for Samba 3 groups.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="57" type="string" variable="$scope">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="87" package="modules">
        <name>get_metaData</name>
        <full_name>\sambaGroupMapping::get_metaData()</full_name>
        <docblock line="87">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="87" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="87"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="176" package="modules">
        <name>getGID</name>
        <full_name>\sambaGroupMapping::getGID()</full_name>
        <docblock line="176">
          <description>Gets the GID number from the Unix group module.</description>
          <long-description></long-description>
          <tag name="return" description="GID number" line="176" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="194" package="modules">
        <name>getCn</name>
        <full_name>\sambaGroupMapping::getCn()</full_name>
        <docblock line="194">
          <description>Gets the cn from the Unix group module.</description>
          <long-description></long-description>
          <tag name="return" description="cn attribute" line="194" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="231" package="modules">
        <name>get_uploadColumns</name>
        <full_name>\sambaGroupMapping::get_uploadColumns()</full_name>
        <docblock line="231">
          <description>Returns an array containing all input columns for the file upload.</description>
          <long-description>Calling this method does not require the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
This funtion returns an array which contains subarrays which represent an upload column.
&lt;b&gt;Syntax of column arrays:&lt;/b&gt;
&lt;br&gt;
&lt;br&gt; array(
&lt;br&gt;  string: name,  // fixed non-translated name which is used as column name (should be of format: &lt;module name&gt;_&lt;column name&gt;)
&lt;br&gt;  string: description,  // short descriptive name
&lt;br&gt;  string: help,  // help ID
&lt;br&gt;  string: example,  // example value
&lt;br&gt;  string: values, // possible input values (optional)
&lt;br&gt;  string: default, // default value (optional)
&lt;br&gt;  boolean: required  // true, if user must set a value for this column
&lt;br&gt;  boolean: unique // true if all values of this column must be different values (optional, default: "false")
&lt;br&gt; )</long-description>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="231" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="column list" line="231" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="231"/>
        </docblock>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="256" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>\sambaGroupMapping::build_uploadAccounts()</full_name>
        <docblock line="256">
          <description>In this function the LDAP account is built up.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) from user input&lt;/p&gt;&#10;" line="256" type="array" variable="$rawAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)&lt;/p&gt;&#10;" line="256" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) which are later added to LDAP&lt;/p&gt;&#10;" line="256" type="array" variable="$partialAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="256" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages if any" line="256" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rawAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$partialAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="326" package="modules">
        <name>display_html_attributes</name>
        <full_name>\sambaGroupMapping::display_html_attributes()</full_name>
        <docblock line="326">
          <description>Returns the HTML meta data for the main account page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="326" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="425" package="modules">
        <name>display_html_members</name>
        <full_name>\sambaGroupMapping::display_html_members()</full_name>
        <docblock line="425">
          <description>This function will create the meta HTML code to show a page to add members.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="425" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="508" package="modules">
        <name>process_members</name>
        <full_name>\sambaGroupMapping::process_members()</full_name>
        <docblock line="508">
          <description>Processes user input of the members page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="508" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="523" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\sambaGroupMapping::get_pdfEntries()</full_name>
        <docblock line="523">
          <description>Returns the PDF entries for this module.</description>
          <long-description></long-description>
          <tag name="return" description="list of possible PDF entries" line="523" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="553" package="modules">
        <name>get_profileOptions</name>
        <full_name>\sambaGroupMapping::get_profileOptions()</full_name>
        <docblock line="553">
          <description>Returns a list of elements for the account profiles.</description>
          <long-description></long-description>
          <tag name="return" description="profile elements" line="553" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="573" package="modules">
        <name>load_profile</name>
        <full_name>\sambaGroupMapping::load_profile()</full_name>
        <docblock line="573">
          <description>Loads the values of an account profile into internal variables.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;hash array with profile values (identifier =&gt; value)&lt;/p&gt;&#10;" line="573" type="array" variable="$profile">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$profile</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="588" package="modules">
        <name>load_Messages</name>
        <full_name>\sambaGroupMapping::load_Messages()</full_name>
        <docblock line="588">
          <description>this functin fills the error message array with messages</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="601" package="modules">
        <name>module_ready</name>
        <full_name>\sambaGroupMapping::module_ready()</full_name>
        <docblock line="601">
          <description>This function is used to check if this module page can be displayed.</description>
          <long-description>It returns false if a module depends on data from other modules which was not yet entered.</long-description>
          <tag name="return" description="true, if page can be displayed" line="601" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="615" package="modules">
        <name>module_complete</name>
        <full_name>\sambaGroupMapping::module_complete()</full_name>
        <docblock line="615">
          <description>This function is used to check if all settings for this module have been made.</description>
          <long-description></long-description>
          <tag name="see" description="" line="615"/>
          <tag name="return" description="true, if settings are complete" line="615" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="631" package="modules">
        <name>process_attributes</name>
        <full_name>\sambaGroupMapping::process_attributes()</full_name>
        <docblock line="631">
          <description>Processes user input of the primary module page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="631" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="701" package="modules">
        <name>save_attributes</name>
        <full_name>\sambaGroupMapping::save_attributes()</full_name>
        <docblock line="701">
          <description>Returns a list of modifications which have to be made to the LDAP account.</description>
          <long-description></long-description>
          <tag name="return" description="list of modifications&#10;&amp;lt;br&amp;gt;This function returns an array with 3 entries:&#10;&amp;lt;br&amp;gt;array( DN1 (&amp;#039;add&amp;#039; =&amp;gt; array($attr), &amp;#039;remove&amp;#039; =&amp;gt; array($attr), &amp;#039;modify&amp;#039; =&amp;gt; array($attr)), DN2 .... )&#10;&amp;lt;br&amp;gt;DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)&#10;&amp;lt;br&amp;gt;&amp;quot;add&amp;quot; are attributes which have to be added to LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;remove&amp;quot; are attributes which have to be removed from LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;modify&amp;quot; are attributes which have to been modified in LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;info&amp;quot; are values with informational value (e.g. to be used later by pre/postModify actions)" line="701" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="713" package="modules">
        <name>getDomains</name>
        <full_name>\sambaGroupMapping::getDomains()</full_name>
        <docblock line="713">
          <description>Returns a list of existing Samba 3 domains.</description>
          <long-description></long-description>
          <tag name="return" description="list of samba3domain objects" line="713" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="724" package="modules">
        <name>loadSIDCache</name>
        <full_name>\sambaGroupMapping::loadSIDCache()</full_name>
        <docblock line="724">
          <description>Loads the list of Samba accounts into the cache.</description>
          <long-description></long-description>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/shadowAccount.inc" generated-path="lib.modules.shadowAccount.inc.html" hash="6c95a9c15d9937a63083cca46de2757f" package="modules">
    <docblock line="0">
      <description>Manages Unix shadow accounts for users.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Tilo Lutz" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="author" description="Michael Duergner" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="39" package="modules">
      <extends>\baseModule</extends>
      <implements>\passwordService</implements>
      <name>shadowAccount</name>
      <full_name>\shadowAccount</full_name>
      <docblock line="39">
        <description>Manages the object class "shadowAccount" for users.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="39"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="46" package="modules">
        <name>__construct</name>
        <full_name>\shadowAccount::__construct()</full_name>
        <docblock line="46">
          <description>Creates a new shadowAccount object.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account type (user, group, host)&lt;/p&gt;&#10;" line="46" type="string" variable="$scope">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="55" package="modules">
        <name>load_Messages</name>
        <full_name>\shadowAccount::load_Messages()</full_name>
        <docblock line="55">
          <description>This function builds up the message array.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="77" package="modules">
        <name>get_metaData</name>
        <full_name>\shadowAccount::get_metaData()</full_name>
        <docblock line="77">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="77" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="77"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="246" package="modules">
        <name>save_attributes</name>
        <full_name>\shadowAccount::save_attributes()</full_name>
        <docblock line="246">
          <description>Returns a list of modifications which have to be made to the LDAP account.</description>
          <long-description></long-description>
          <tag name="return" description="list of modifications&#10;&amp;lt;br&amp;gt;This function returns an array with 3 entries:&#10;&amp;lt;br&amp;gt;array( DN1 (&amp;#039;add&amp;#039; =&amp;gt; array($attr), &amp;#039;remove&amp;#039; =&amp;gt; array($attr), &amp;#039;modify&amp;#039; =&amp;gt; array($attr)), DN2 .... )&#10;&amp;lt;br&amp;gt;DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)&#10;&amp;lt;br&amp;gt;&amp;quot;add&amp;quot; are attributes which have to be added to LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;remove&amp;quot; are attributes which have to be removed from LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;modify&amp;quot; are attributes which have to been modified in LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;info&amp;quot; are values with informational value (e.g. to be used later by pre/postModify actions)" line="246" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="260" package="modules">
        <name>process_attributes</name>
        <full_name>\shadowAccount::process_attributes()</full_name>
        <docblock line="260">
          <description>Processes user input of the primary module page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="260" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="297" package="modules">
        <name>display_html_attributes</name>
        <full_name>\shadowAccount::display_html_attributes()</full_name>
        <docblock line="297">
          <description>This function will create the meta HTML code to show a page with all attributes.</description>
          <long-description></long-description>
          <tag name="return" description="meta HTML code" line="297" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="382" package="modules">
        <name>process_expire</name>
        <full_name>\shadowAccount::process_expire()</full_name>
        <docblock line="382">
          <description>Processes user input of the expiration page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="382" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="434" package="modules">
        <name>display_html_expire</name>
        <full_name>\shadowAccount::display_html_expire()</full_name>
        <docblock line="434">
          <description>This function will create the meta HTML code to show a page with the expiration date.</description>
          <long-description></long-description>
          <tag name="return" description="meta HTML code" line="434" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="480" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\shadowAccount::get_pdfEntries()</full_name>
        <docblock line="480">
          <description>Returns the PDF entries for this module.</description>
          <long-description></long-description>
          <tag name="return" description="list of possible PDF entries" line="480" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="508" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>\shadowAccount::build_uploadAccounts()</full_name>
        <docblock line="508">
          <description>In this function the LDAP account is built up.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) from user input&lt;/p&gt;&#10;" line="508" type="array" variable="$rawAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)&lt;/p&gt;&#10;" line="508" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) which are later added to LDAP&lt;/p&gt;&#10;" line="508" type="array" variable="$partialAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="508" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages if any" line="508" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rawAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$partialAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="588" package="modules">
        <name>load_profile</name>
        <full_name>\shadowAccount::load_profile()</full_name>
        <docblock line="588">
          <description>Loads the values of an account profile into internal variables.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;hash array with profile values (identifier =&gt; value)&lt;/p&gt;&#10;" line="588" type="array" variable="$profile">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$profile</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="612" package="modules">
        <name>managesPasswordAttributes</name>
        <full_name>\shadowAccount::managesPasswordAttributes()</full_name>
        <docblock line="612">
          <description>This method specifies if a module manages password attributes.</description>
          <long-description></long-description>
          <tag name="see" description="" line="612"/>
          <tag name="return" description="true if this module manages password attributes" line="612" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="622" package="modules">
        <name>supportsForcePasswordChange</name>
        <full_name>\shadowAccount::supportsForcePasswordChange()</full_name>
        <docblock line="622">
          <description>Specifies if this module supports to force that a user must change his password on next login.</description>
          <long-description></long-description>
          <tag name="return" description="force password change supported" line="622" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="637" package="modules">
        <name>passwordChangeRequested</name>
        <full_name>\shadowAccount::passwordChangeRequested()</full_name>
        <docblock line="637">
          <description>This function is called whenever the password should be changed. Account modules
must change their password attributes only if the modules list contains their module name.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;new password&lt;/p&gt;" line="637" type="String" variable="$password">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of modules for which the password should be changed&lt;/p&gt;" line="637" type="" variable="$modules"/>
          <tag name="param" description="&lt;p&gt;force the user to change his password at next login&lt;/p&gt;" line="637" type="boolean" variable="$forcePasswordChange">
            <type>boolean</type>
          </tag>
          <tag name="return" description="list of error messages if any as parameter array for StatusMessage&#10;              e.g. return arrray(array(&amp;#039;ERROR&amp;#039;, &amp;#039;Password change failed.&amp;#039;))" line="637" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="637"/>
        </docblock>
        <argument line="0">
          <name>$password</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$modules</name>
          <default></default>
          <type>mixed</type>
        </argument>
        <argument line="0">
          <name>$forcePasswordChange</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="659" package="modules">
        <name>setExpirationDate</name>
        <full_name>\shadowAccount::setExpirationDate()</full_name>
        <docblock line="659">
          <description>Sets the expiration date of this account.</description>
          <long-description>If all parameters are null the expiration date will be removed.</long-description>
          <tag name="param" description="&lt;p&gt;year (e.g. 2040)&lt;/p&gt;&#10;" line="659" type="String" variable="$year">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;month (e.g. 8)&lt;/p&gt;&#10;" line="659" type="String" variable="$month">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;day (e.g. 27)&lt;/p&gt;&#10;" line="659" type="String" variable="$day">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$year</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$month</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$day</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/ldapPublicKey.inc" generated-path="lib.modules.ldapPublicKey.inc.html" hash="0e0f7f6de1686813a0a4538c17ef75c3" package="modules">
    <docblock line="0">
      <description>Manages SSH public keys.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="author" description="Andrew Dibble &amp;lt;adibble@mobitv.com&amp;gt;" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="36" package="modules">
      <extends>\baseModule</extends>
      <name>ldapPublicKey</name>
      <full_name>\ldapPublicKey</full_name>
      <docblock line="36">
        <description>Manages SSH public keys.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="36"/>
      </docblock>
      <constant namespace="" line="39" package="modules">
        <name>SESS_KEY_LIST</name>
        <full_name>\ldapPublicKey::SESS_KEY_LIST</full_name>
        <value>'ldapPublicKey_keyList'</value>
        <docblock line="39">
          <description>session variable for existing keys in self service</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="48" package="modules">
        <name>get_metaData</name>
        <full_name>\ldapPublicKey::get_metaData()</full_name>
        <docblock line="48">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="48" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="48"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="101" package="modules">
        <name>load_Messages</name>
        <full_name>\ldapPublicKey::load_Messages()</full_name>
        <docblock line="101">
          <description>This function fills the message array.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="110" package="modules">
        <name>display_html_attributes</name>
        <full_name>\ldapPublicKey::display_html_attributes()</full_name>
        <docblock line="110">
          <description>Returns the HTML meta data for the main account page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="110" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="154" package="modules">
        <name>process_attributes</name>
        <full_name>\ldapPublicKey::process_attributes()</full_name>
        <docblock line="154">
          <description>Processes user input of the primary module page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="154" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="202" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>\ldapPublicKey::build_uploadAccounts()</full_name>
        <docblock line="202">
          <description>In this function the LDAP account is built up.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) from user input&lt;/p&gt;&#10;" line="202" type="array" variable="$rawAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)&lt;/p&gt;&#10;" line="202" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) which are later added to LDAP&lt;/p&gt;&#10;" line="202" type="array" variable="$partialAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="202" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages if any" line="202" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rawAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$partialAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="222" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\ldapPublicKey::get_pdfEntries()</full_name>
        <docblock line="222">
          <description>Returns a list of PDF entries</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="244" package="modules">
        <name>getSelfServiceOptions</name>
        <full_name>\ldapPublicKey::getSelfServiceOptions()</full_name>
        <docblock line="244">
          <description>Returns the meta HTML code for each input field.</description>
          <long-description>format: array(&lt;field1&gt; =&gt; array(&lt;META HTML&gt;), ...)
It is not possible to display help links.</long-description>
          <tag name="param" description="&lt;p&gt;list of active fields&lt;/p&gt;" line="244" type="array" variable="$fields">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;attributes of LDAP account&lt;/p&gt;" line="244" type="array" variable="$attributes">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;indicates that the user is only allowed to change his password and no LDAP content is readable&lt;/p&gt;" line="244" type="boolean" variable="$passwordChangeOnly">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of read-only fields&lt;/p&gt;&#10;" line="244" type="array" variable="$readOnlyFields">
            <type>array</type>
          </tag>
          <tag name="return" description="list of meta HTML elements (field name =&amp;gt; htmlTableRow)" line="244" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$fields</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$passwordChangeOnly</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$readOnlyFields</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="280" package="modules">
        <name>getSelfServiceKeys</name>
        <full_name>\ldapPublicKey::getSelfServiceKeys()</full_name>
        <docblock line="280">
          <description>Returns the meta HTML code to display the key area.</description>
          <long-description>This also includes the file upload.</long-description>
          <tag name="return" description="key content" line="280" type="\htmlTable">
            <type>\htmlTable</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="true" visibility="private" namespace="" line="323" package="modules">
        <name>getSelfServiceKeysJSBlock</name>
        <full_name>\ldapPublicKey::getSelfServiceKeysJSBlock()</full_name>
        <docblock line="323">
          <description>Returns the Java Script functions to manage the keys.</description>
          <long-description></long-description>
          <tag name="return" description="JS block" line="323" type="\htmlJavaScript">
            <type>\htmlJavaScript</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="418" package="modules">
        <name>checkSelfServiceOptions</name>
        <full_name>\ldapPublicKey::checkSelfServiceOptions()</full_name>
        <docblock line="418">
          <description>Checks if all input values are correct and returns the LDAP attributes which should be changed.</description>
          <long-description>&lt;br&gt;Return values:
&lt;br&gt;messages: array of parameters to create status messages
&lt;br&gt;add: array of attributes to add
&lt;br&gt;del: array of attributes to remove
&lt;br&gt;mod: array of attributes to modify
&lt;br&gt;info: array of values with informational value (e.g. to be used later by pre/postModify actions)

Calling this method does not require the existence of an enclosing {@link accountContainer}.</long-description>
          <tag name="param" description="&lt;p&gt;input fields&lt;/p&gt;" line="418" type="string" variable="$fields">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="418" type="array" variable="$attributes">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;indicates that the user is only allowed to change his password and no LDAP content is readable&lt;/p&gt;" line="418" type="boolean" variable="$passwordChangeOnly">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of read-only fields&lt;/p&gt;&#10;" line="418" type="array" variable="$readOnlyFields">
            <type>array</type>
          </tag>
          <tag name="return" description="messages and attributes (array(&amp;#039;messages&amp;#039; =&amp;gt; array(), &amp;#039;add&amp;#039; =&amp;gt; array(&amp;#039;mail&amp;#039; =&amp;gt; array(&amp;#039;test@test.com&amp;#039;)), &amp;#039;del&amp;#039; =&amp;gt; array(), &amp;#039;mod&amp;#039; =&amp;gt; array(), &amp;#039;info&amp;#039; =&amp;gt; array()))" line="418" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$fields</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$passwordChangeOnly</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$readOnlyFields</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="472" package="modules">
        <name>handleAjaxRequest</name>
        <full_name>\ldapPublicKey::handleAjaxRequest()</full_name>
        <docblock line="472">
          <description>Manages AJAX requests.</description>
          <long-description>This function may be called with or without an account container.</long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="508" package="modules">
        <name>ajaxUpload</name>
        <full_name>\ldapPublicKey::ajaxUpload()</full_name>
        <docblock line="508">
          <description>Handles an AJAX file upload and prints the JSON result.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="546" package="modules">
        <name>ajaxDeleteSelfServiceKey</name>
        <full_name>\ldapPublicKey::ajaxDeleteSelfServiceKey()</full_name>
        <docblock line="546">
          <description>Manages the deletion of a key.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;JSON data&lt;/p&gt;" line="546" type="array" variable="$data">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$data</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="574" package="modules">
        <name>invalidAjaxRequest</name>
        <full_name>\ldapPublicKey::invalidAjaxRequest()</full_name>
        <docblock line="574">
          <description>Invalid AJAX request received.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;error message&lt;/p&gt;" line="574" type="String" variable="$message">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$message</name>
          <default>null</default>
          <type>String</type>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/windowsPosixGroup.inc" generated-path="lib.modules.windowsPosixGroup.inc.html" hash="616272e52336361022018e2490966a00" package="modules">
    <docblock line="0">
      <description>Manages Unix groups in Windows LDAP schema.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="38" package="modules">
      <extends>\posixGroup</extends>
      <name>windowsPosixGroup</name>
      <full_name>\windowsPosixGroup</full_name>
      <docblock line="38">
        <description>Manages Unix groups in Windows LDAP schema.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="38"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="45" package="modules">
        <name>__construct</name>
        <full_name>\windowsPosixGroup::__construct()</full_name>
        <docblock line="45">
          <description>Creates a new windowsPosixGroup object.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account type (user, group, host)&lt;/p&gt;&#10;" line="45" type="string" variable="$scope">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="62" package="modules">
        <name>get_metaData</name>
        <full_name>\windowsPosixGroup::get_metaData()</full_name>
        <docblock line="62">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="62" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="62"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="80" package="modules">
        <name>getButtonStatus</name>
        <full_name>\windowsPosixGroup::getButtonStatus()</full_name>
        <docblock line="80">
          <description>Controls if the module button the account page is visible and activated.</description>
          <long-description></long-description>
          <tag name="return" description="status (&amp;quot;enabled&amp;quot;, &amp;quot;disabled&amp;quot;, &amp;quot;hidden&amp;quot;)" line="80" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="89" package="modules">
        <name>module_complete</name>
        <full_name>\windowsPosixGroup::module_complete()</full_name>
        <docblock line="89">
          <description>This functions is used to check if all settings for this module have been made.</description>
          <long-description></long-description>
          <tag name="return" description="true, if settings are complete" line="89" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/nisnetgroup.inc" generated-path="lib.modules.nisnetgroup.inc.html" hash="d2d3fc0b586fb829e99182d9a501c9a5" package="modules">
    <docblock line="0">
      <description>Manages entries based on the object class nisNetgroup.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="36" package="modules">
      <extends>\baseModule</extends>
      <name>nisnetgroup</name>
      <full_name>\nisnetgroup</full_name>
      <docblock line="36">
        <description>Manages entries based on the object class nisNetgroup.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="36"/>
      </docblock>
      <property static="false" visibility="private" line="40" namespace="" package="modules">
        <name>$cachedUserList</name>
        <default>null</default>
        <docblock line="40">
          <description>user cache</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="42" namespace="" package="modules">
        <name>$cachedHostList</name>
        <default>null</default>
        <docblock line="42">
          <description>host cache</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="44" namespace="" package="modules">
        <name>$cachedGroupList</name>
        <default>null</default>
        <docblock line="44">
          <description>group cache</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="53" package="modules">
        <name>get_metaData</name>
        <full_name>\nisnetgroup::get_metaData()</full_name>
        <docblock line="53">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="53" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="53"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="143" package="modules">
        <name>load_Messages</name>
        <full_name>\nisnetgroup::load_Messages()</full_name>
        <docblock line="143">
          <description>This function fills the $messages variable with output messages from this module.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="162" package="modules">
        <name>save_attributes</name>
        <full_name>\nisnetgroup::save_attributes()</full_name>
        <docblock line="162">
          <description>Returns a list of modifications which have to be made to the LDAP account.</description>
          <long-description></long-description>
          <tag name="return" description="list of modifications&#10;&amp;lt;br&amp;gt;This function returns an array with 3 entries:&#10;&amp;lt;br&amp;gt;array( DN1 (&amp;#039;add&amp;#039; =&amp;gt; array($attr), &amp;#039;remove&amp;#039; =&amp;gt; array($attr), &amp;#039;modify&amp;#039; =&amp;gt; array($attr)), DN2 .... )&#10;&amp;lt;br&amp;gt;DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)&#10;&amp;lt;br&amp;gt;&amp;quot;add&amp;quot; are attributes which have to be added to LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;remove&amp;quot; are attributes which have to be removed from LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;modify&amp;quot; are attributes which have to been modified in LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;info&amp;quot; are values with informational value (e.g. to be used later by pre/postModify actions)" line="162" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="181" package="modules">
        <name>display_html_attributes</name>
        <full_name>\nisnetgroup::display_html_attributes()</full_name>
        <docblock line="181">
          <description>Returns the HTML meta data for the main account page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="181" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="292" package="modules">
        <name>process_attributes</name>
        <full_name>\nisnetgroup::process_attributes()</full_name>
        <docblock line="292">
          <description>Processes user input of the primary module page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="292" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="363" package="modules">
        <name>display_html_group</name>
        <full_name>\nisnetgroup::display_html_group()</full_name>
        <docblock line="363">
          <description>Displays the group selection.</description>
          <long-description></long-description>
          <tag name="return" description="meta HTML code" line="363" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="405" package="modules">
        <name>process_group</name>
        <full_name>\nisnetgroup::process_group()</full_name>
        <docblock line="405">
          <description>Processes user input of the group selection page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="405" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="424" package="modules">
        <name>display_html_select</name>
        <full_name>\nisnetgroup::display_html_select()</full_name>
        <docblock line="424">
          <description>Displays the host/user selection.</description>
          <long-description></long-description>
          <tag name="return" description="meta HTML code" line="424" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="500" package="modules">
        <name>process_select</name>
        <full_name>\nisnetgroup::process_select()</full_name>
        <docblock line="500">
          <description>Processes user input of the host/user selection page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="500" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="519" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>\nisnetgroup::build_uploadAccounts()</full_name>
        <docblock line="519">
          <description>In this function the LDAP account is built up.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) from user input&lt;/p&gt;&#10;" line="519" type="array" variable="$rawAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)&lt;/p&gt;&#10;" line="519" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) which are later added to LDAP&lt;/p&gt;&#10;" line="519" type="array" variable="$partialAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="519" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages if any" line="519" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rawAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$partialAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="560" package="modules">
        <name>module_complete</name>
        <full_name>\nisnetgroup::module_complete()</full_name>
        <docblock line="560">
          <description>This functions is used to check if all settings for this module have been made.</description>
          <long-description></long-description>
          <tag name="return" description="true, if settings are complete" line="560" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="572" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\nisnetgroup::get_pdfEntries()</full_name>
        <docblock line="572">
          <description>Returns a list of PDF entries</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="603" package="modules">
        <name>getGroupList</name>
        <full_name>\nisnetgroup::getGroupList()</full_name>
        <docblock line="603">
          <description>Returns a list of existing NIS net groups.</description>
          <long-description></long-description>
          <tag name="return" description="group names" line="603" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="619" package="modules">
        <name>getUserList</name>
        <full_name>\nisnetgroup::getUserList()</full_name>
        <docblock line="619">
          <description>Returns a list of existing users.</description>
          <long-description></long-description>
          <tag name="return" description="user names" line="619" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="635" package="modules">
        <name>getHostList</name>
        <full_name>\nisnetgroup::getHostList()</full_name>
        <docblock line="635">
          <description>Returns a list of existing hosts.</description>
          <long-description></long-description>
          <tag name="return" description="host names" line="635" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/sambaDomain.inc" generated-path="lib.modules.sambaDomain.inc.html" hash="fce6d1f011bc67b871d62cf0f1acc655" package="modules">
    <docblock line="0">
      <description>Manages Samba 3 domain entries.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="35" package="modules">
      <extends>\baseModule</extends>
      <name>sambaDomain</name>
      <full_name>\sambaDomain</full_name>
      <docblock line="35">
        <description>Manages Samba 3 domain entries.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="35"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="44" package="modules">
        <name>get_metaData</name>
        <full_name>\sambaDomain::get_metaData()</full_name>
        <docblock line="44">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="44" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="44"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="200" package="modules">
        <name>load_Messages</name>
        <full_name>\sambaDomain::load_Messages()</full_name>
        <docblock line="200">
          <description>This function fills the error message array with messages</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="226" package="modules">
        <name>display_html_attributes</name>
        <full_name>\sambaDomain::display_html_attributes()</full_name>
        <docblock line="226">
          <description>Returns the HTML meta data for the main account page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="226" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="395" package="modules">
        <name>process_attributes</name>
        <full_name>\sambaDomain::process_attributes()</full_name>
        <docblock line="395">
          <description>Processes user input of the primary module page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="395" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="557" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>\sambaDomain::build_uploadAccounts()</full_name>
        <docblock line="557">
          <description>In this function the LDAP account is built up.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) from user input&lt;/p&gt;&#10;" line="557" type="array" variable="$rawAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)&lt;/p&gt;&#10;" line="557" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) which are later added to LDAP&lt;/p&gt;&#10;" line="557" type="array" variable="$partialAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="557" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages if any" line="557" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rawAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$partialAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="636" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\sambaDomain::get_pdfEntries()</full_name>
        <docblock line="636">
          <description>Returns the PDF entries for this module.</description>
          <long-description></long-description>
          <tag name="return" description="list of possible PDF entries" line="636" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/inetOrgPerson.inc" generated-path="lib.modules.inetOrgPerson.inc.html" hash="8b8efcd7cf831b2fff3ba890272a389d" package="modules">
    <docblock line="0">
      <description>Manages the atrributes of object class inetOrgPerson.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Tilo Lutz" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="author" description="Michael Duergner" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="38" package="modules">
      <extends>\baseModule</extends>
      <implements>\passwordService</implements>
      <name>inetOrgPerson</name>
      <full_name>\inetOrgPerson</full_name>
      <docblock line="38">
        <description>This module manages LDAP attributes of the object class inetOrgPerson (e.g. name and address).</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="38"/>
      </docblock>
      <constant namespace="" line="58" package="modules">
        <name>SESS_CERTIFICATES_LIST</name>
        <full_name>\inetOrgPerson::SESS_CERTIFICATES_LIST</full_name>
        <value>'inetOrgPerson_certificatesList'</value>
        <docblock line="58">
          <description>session variable for existing user certificates in self service</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <property static="false" visibility="private" line="41" namespace="" package="modules">
        <name>$cachedManagers</name>
        <default>null</default>
        <docblock line="41">
          <description>caches the list of possible managers</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="43" namespace="" package="modules">
        <name>$clearTextPassword</name>
        <default>null</default>
        <docblock line="43">
          <description>clear text password</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="45" namespace="" package="modules">
        <name>$departmentCache</name>
        <default>null</default>
        <docblock line="45">
          <description>cache for departments</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="47" namespace="" package="modules">
        <name>$oCache</name>
        <default>null</default>
        <docblock line="47">
          <description>organization cache</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="49" namespace="" package="modules">
        <name>$ouCache</name>
        <default>null</default>
        <docblock line="49">
          <description>organizational unit cache</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="51" namespace="" package="modules">
        <name>$titleCache</name>
        <default>null</default>
        <docblock line="51">
          <description>title cache</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="53" namespace="" package="modules">
        <name>$employeeTypeCache</name>
        <default>null</default>
        <docblock line="53">
          <description>employee type cache</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="55" namespace="" package="modules">
        <name>$businessCategoryCache</name>
        <default>null</default>
        <docblock line="55">
          <description>business category cache</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="63" package="modules">
        <name>load_Messages</name>
        <full_name>\inetOrgPerson::load_Messages()</full_name>
        <docblock line="63">
          <description>This function fills the message array.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="110" package="modules">
        <name>get_metaData</name>
        <full_name>\inetOrgPerson::get_metaData()</full_name>
        <docblock line="110">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="110" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="110"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="924" package="modules">
        <name>module_complete</name>
        <full_name>\inetOrgPerson::module_complete()</full_name>
        <docblock line="924">
          <description>This functions return true if all needed settings are done.</description>
          <long-description></long-description>
          <tag name="return" description="true, if all is ok" line="924" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="947" package="modules">
        <name>getButtonStatus</name>
        <full_name>\inetOrgPerson::getButtonStatus()</full_name>
        <docblock line="947">
          <description>Controls if the module button the account page is visible and activated.</description>
          <long-description></long-description>
          <tag name="return" description="status (&amp;quot;enabled&amp;quot;, &amp;quot;disabled&amp;quot;, &amp;quot;hidden&amp;quot;)" line="947" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="970" package="modules">
        <name>save_attributes</name>
        <full_name>\inetOrgPerson::save_attributes()</full_name>
        <docblock line="970">
          <description>Returns a list of modifications which have to be made to the LDAP account.</description>
          <long-description></long-description>
          <tag name="return" description="list of modifications&#10;&amp;lt;br&amp;gt;This function returns an array with 3 entries:&#10;&amp;lt;br&amp;gt;array( DN1 (&amp;#039;add&amp;#039; =&amp;gt; array($attr), &amp;#039;remove&amp;#039; =&amp;gt; array($attr), &amp;#039;modify&amp;#039; =&amp;gt; array($attr)), DN2 .... )&#10;&amp;lt;br&amp;gt;DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)&#10;&amp;lt;br&amp;gt;&amp;quot;add&amp;quot; are attributes which have to be added to LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;remove&amp;quot; are attributes which have to be removed from LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;modify&amp;quot; are attributes which have to been modified in LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;info&amp;quot; are values with informational value (e.g. to be used later by pre/postModify actions)" line="970" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1011" package="modules">
        <name>process_attributes</name>
        <full_name>\inetOrgPerson::process_attributes()</full_name>
        <docblock line="1011">
          <description>Processes user input of the primary module page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="1011" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1394" package="modules">
        <name>display_html_attributes</name>
        <full_name>\inetOrgPerson::display_html_attributes()</full_name>
        <docblock line="1394">
          <description>Returns the HTML meta data for the main account page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="1394" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2118" package="modules">
        <name>process_photo</name>
        <full_name>\inetOrgPerson::process_photo()</full_name>
        <docblock line="2118">
          <description>Sets a new photo.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2140" package="modules">
        <name>display_html_photo</name>
        <full_name>\inetOrgPerson::display_html_photo()</full_name>
        <docblock line="2140">
          <description>Displays the photo upload page.</description>
          <long-description></long-description>
          <tag name="return" description="meta HTML code" line="2140" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2155" package="modules">
        <name>display_html_manager</name>
        <full_name>\inetOrgPerson::display_html_manager()</full_name>
        <docblock line="2155">
          <description>This function will create the meta HTML code to show a page to change the manager attribute.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="2155" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2232" package="modules">
        <name>process_manager</name>
        <full_name>\inetOrgPerson::process_manager()</full_name>
        <docblock line="2232">
          <description>Processes user input of the manager page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="2232" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2257" package="modules">
        <name>display_html_userCertificate</name>
        <full_name>\inetOrgPerson::display_html_userCertificate()</full_name>
        <docblock line="2257">
          <description>Displays the certificate upload page.</description>
          <long-description></long-description>
          <tag name="return" description="meta HTML code" line="2257" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2315" package="modules">
        <name>process_userCertificate</name>
        <full_name>\inetOrgPerson::process_userCertificate()</full_name>
        <docblock line="2315">
          <description>Sets a new certificate or deletes old ones.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2356" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\inetOrgPerson::get_pdfEntries()</full_name>
        <docblock line="2356">
          <description>Returns the PDF entries for this module.</description>
          <long-description></long-description>
          <tag name="return" description="list of possible PDF entries" line="2356" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2396" package="modules">
        <name>load_profile</name>
        <full_name>\inetOrgPerson::load_profile()</full_name>
        <docblock line="2396">
          <description>Loads the values of an account profile into internal variables.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;hash array with profile values (identifier =&gt; value)&lt;/p&gt;&#10;" line="2396" type="array" variable="$profile">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$profile</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2459" package="modules">
        <name>check_profileOptions</name>
        <full_name>\inetOrgPerson::check_profileOptions()</full_name>
        <docblock line="2459">
          <description>Checks input values of account profiles.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;a hash array (name =&gt; value) containing the options&lt;/p&gt;&#10;" line="2459" type="array" variable="$options">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages (array(type, title, text)) to generate StatusMessages, if any" line="2459" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$options</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2497" package="modules">
        <name>get_uploadColumns</name>
        <full_name>\inetOrgPerson::get_uploadColumns()</full_name>
        <docblock line="2497">
          <description>Returns an array containing all input columns for the file upload.</description>
          <long-description>Syntax:
&lt;br&gt; array(
&lt;br&gt;  string: name,  // fixed non-translated name which is used as column name (should be of format: &lt;module name&gt;_&lt;column name&gt;)
&lt;br&gt;  string: description,  // short descriptive name
&lt;br&gt;  string: help,  // help ID
&lt;br&gt;  string: example,  // example value
&lt;br&gt;  boolean: required  // true, if user must set a value for this column
&lt;br&gt; )</long-description>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="2497" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="column list" line="2497" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2537" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>\inetOrgPerson::build_uploadAccounts()</full_name>
        <docblock line="2537">
          <description>In this function the LDAP account is built up.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) from user input&lt;/p&gt;&#10;" line="2537" type="array" variable="$rawAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)&lt;/p&gt;&#10;" line="2537" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) which are later added to LDAP&lt;/p&gt;&#10;" line="2537" type="array" variable="$partialAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="2537" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages if any" line="2537" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rawAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$partialAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2857" package="modules">
        <name>doUploadPostActions</name>
        <full_name>\inetOrgPerson::doUploadPostActions()</full_name>
        <docblock line="2857">
          <description>This function executes one post upload action.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;array containing one account in each element&lt;/p&gt;" line="2857" type="array" variable="$data">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;array(&lt;column_name&gt; =&gt; &lt;column number&gt;)&lt;/p&gt;&#10;" line="2857" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of accounts which were not created successfully&lt;/p&gt;" line="2857" type="array" variable="$failed">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;variable to store temporary data between two post actions&lt;/p&gt;" line="2857" type="array" variable="$temp">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of LDAP entries&lt;/p&gt;" line="2857" type="array" variable="$accounts">
            <type>array</type>
          </tag>
          <tag name="return" description="current status&#10;&amp;lt;br&amp;gt; array (&#10;&amp;lt;br&amp;gt;  &amp;#039;status&amp;#039; =&amp;gt; &amp;#039;finished&amp;#039; | &amp;#039;inProgress&amp;#039;&#10;&amp;lt;br&amp;gt;  &amp;#039;progress&amp;#039; =&amp;gt; 0..100&#10;&amp;lt;br&amp;gt;  &amp;#039;errors&amp;#039; =&amp;gt; array (&amp;lt;array of parameters for StatusMessage&amp;gt;)&#10;&amp;lt;br&amp;gt; )" line="2857" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$data</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$failed</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$temp</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$accounts</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2912" package="modules">
        <name>getSelfServiceOptions</name>
        <full_name>\inetOrgPerson::getSelfServiceOptions()</full_name>
        <docblock line="2912">
          <description>Returns the meta HTML code for each input field.</description>
          <long-description>format: array(&lt;field1&gt; =&gt; array(&lt;META HTML&gt;), ...)
It is not possible to display help links.</long-description>
          <tag name="param" description="&lt;p&gt;list of active fields&lt;/p&gt;" line="2912" type="array" variable="$fields">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;attributes of LDAP account&lt;/p&gt;" line="2912" type="array" variable="$attributes">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;indicates that the user is only allowed to change his password and no LDAP content is readable&lt;/p&gt;" line="2912" type="boolean" variable="$passwordChangeOnly">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of read-only fields&lt;/p&gt;&#10;" line="2912" type="array" variable="$readOnlyFields">
            <type>array</type>
          </tag>
          <tag name="return" description="list of meta HTML elements (field name =&amp;gt; htmlTableRow)" line="2912" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$fields</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$passwordChangeOnly</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$readOnlyFields</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="3225" package="modules">
        <name>getSelfServiceUserCertificates</name>
        <full_name>\inetOrgPerson::getSelfServiceUserCertificates()</full_name>
        <docblock line="3225">
          <description>Returns the meta HTML code to display the certificate area.</description>
          <long-description>This also includes the file upload.</long-description>
          <tag name="return" description="certificate content" line="3225" type="\htmlTable">
            <type>\htmlTable</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="true" visibility="private" namespace="" line="3273" package="modules">
        <name>getSelfServiceUserCertificatesJSBlock</name>
        <full_name>\inetOrgPerson::getSelfServiceUserCertificatesJSBlock()</full_name>
        <docblock line="3273">
          <description>Returns the Java Script functions to manage the certificates.</description>
          <long-description></long-description>
          <tag name="return" description="JS block" line="3273" type="\htmlJavaScript">
            <type>\htmlJavaScript</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="3341" package="modules">
        <name>checkSelfServiceOptions</name>
        <full_name>\inetOrgPerson::checkSelfServiceOptions()</full_name>
        <docblock line="3341">
          <description>Checks if all input values are correct and returns the LDAP attributes which should be changed.</description>
          <long-description>&lt;br&gt;Return values:
&lt;br&gt;messages: array of parameters to create status messages
&lt;br&gt;add: array of attributes to add
&lt;br&gt;del: array of attributes to remove
&lt;br&gt;mod: array of attributes to modify
&lt;br&gt;info: array of values with informational value (e.g. to be used later by pre/postModify actions)

Calling this method does not require the existence of an enclosing {@link accountContainer}.</long-description>
          <tag name="param" description="&lt;p&gt;input fields&lt;/p&gt;" line="3341" type="string" variable="$fields">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="3341" type="array" variable="$attributes">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;indicates that the user is only allowed to change his password and no LDAP content is readable&lt;/p&gt;" line="3341" type="boolean" variable="$passwordChangeOnly">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of read-only fields&lt;/p&gt;&#10;" line="3341" type="array" variable="$readOnlyFields">
            <type>array</type>
          </tag>
          <tag name="return" description="messages and attributes (array(&amp;#039;messages&amp;#039; =&amp;gt; array(), &amp;#039;add&amp;#039; =&amp;gt; array(&amp;#039;mail&amp;#039; =&amp;gt; array(&amp;#039;test@test.com&amp;#039;)), &amp;#039;del&amp;#039; =&amp;gt; array(), &amp;#039;mod&amp;#039; =&amp;gt; array(), &amp;#039;info&amp;#039; =&amp;gt; array()))" line="3341" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$fields</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$passwordChangeOnly</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$readOnlyFields</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="3610" package="modules">
        <name>handleAjaxRequest</name>
        <full_name>\inetOrgPerson::handleAjaxRequest()</full_name>
        <docblock line="3610">
          <description>Manages AJAX requests.</description>
          <long-description>This function may be called with or without an account container.</long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="3629" package="modules">
        <name>ajaxUpload</name>
        <full_name>\inetOrgPerson::ajaxUpload()</full_name>
        <docblock line="3629">
          <description>Handles an AJAX file upload and prints the JSON result.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="3668" package="modules">
        <name>ajaxDeleteSelfServiceUserCertificate</name>
        <full_name>\inetOrgPerson::ajaxDeleteSelfServiceUserCertificate()</full_name>
        <docblock line="3668">
          <description>Manages the deletion of a certificate.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;JSON data&lt;/p&gt;" line="3668" type="array" variable="$data">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$data</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="3696" package="modules">
        <name>invalidAjaxRequest</name>
        <full_name>\inetOrgPerson::invalidAjaxRequest()</full_name>
        <docblock line="3696">
          <description>Invalid AJAX request received.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;error message&lt;/p&gt;" line="3696" type="String" variable="$message">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$message</name>
          <default>null</default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="3709" package="modules">
        <name>managesPasswordAttributes</name>
        <full_name>\inetOrgPerson::managesPasswordAttributes()</full_name>
        <docblock line="3709">
          <description>This method specifies if a module manages password attributes.</description>
          <long-description></long-description>
          <tag name="see" description="" line="3709"/>
          <tag name="return" description="true if this module manages password attributes" line="3709" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="3722" package="modules">
        <name>supportsForcePasswordChange</name>
        <full_name>\inetOrgPerson::supportsForcePasswordChange()</full_name>
        <docblock line="3722">
          <description>Specifies if this module supports to force that a user must change his password on next login.</description>
          <long-description></long-description>
          <tag name="return" description="force password change supported" line="3722" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="3737" package="modules">
        <name>passwordChangeRequested</name>
        <full_name>\inetOrgPerson::passwordChangeRequested()</full_name>
        <docblock line="3737">
          <description>This function is called whenever the password should be changed. Account modules
must change their password attributes only if the modules list contains their module name.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;new password&lt;/p&gt;" line="3737" type="String" variable="$password">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of modules for which the password should be changed&lt;/p&gt;" line="3737" type="" variable="$modules"/>
          <tag name="param" description="&lt;p&gt;force the user to change his password at next login&lt;/p&gt;" line="3737" type="boolean" variable="$forcePasswordChange">
            <type>boolean</type>
          </tag>
          <tag name="return" description="list of error messages if any as parameter array for StatusMessage&#10;              e.g. return arrray(array(&amp;#039;ERROR&amp;#039;, &amp;#039;Password change failed.&amp;#039;))" line="3737" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="3737"/>
        </docblock>
        <argument line="0">
          <name>$password</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$modules</name>
          <default></default>
          <type>mixed</type>
        </argument>
        <argument line="0">
          <name>$forcePasswordChange</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="3751" package="modules">
        <name>getManagers</name>
        <full_name>\inetOrgPerson::getManagers()</full_name>
        <docblock line="3751">
          <description>Returns a list of possible managers.</description>
          <long-description></long-description>
          <tag name="return" description="list of format array(abstract DN =&amp;gt; DN)" line="3751" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="3771" package="modules">
        <name>initCache</name>
        <full_name>\inetOrgPerson::initCache()</full_name>
        <docblock line="3771">
          <description>Loads cached data from LDAP such as departmets etc.</description>
          <long-description></long-description>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/systemQuotas.inc" generated-path="lib.modules.systemQuotas.inc.html" hash="e82d9463ec00ed5b5fe39fd29ebccb75" package="modules">
    <docblock line="0">
      <description>Manages user quotas with the object class systemQuotas.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="35" package="modules">
      <extends>\baseModule</extends>
      <name>systemQuotas</name>
      <full_name>\systemQuotas</full_name>
      <docblock line="35">
        <description>Manages user quotas with the object class systemQuotas.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="35"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="44" package="modules">
        <name>get_metaData</name>
        <full_name>\systemQuotas::get_metaData()</full_name>
        <docblock line="44">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="44" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="44"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="89" package="modules">
        <name>load_Messages</name>
        <full_name>\systemQuotas::load_Messages()</full_name>
        <docblock line="89">
          <description>This function fills the $messages variable with output messages from this module.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="111" package="modules">
        <name>display_html_attributes</name>
        <full_name>\systemQuotas::display_html_attributes()</full_name>
        <docblock line="111">
          <description>Returns the HTML meta data for the main account page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="111" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="178" package="modules">
        <name>process_attributes</name>
        <full_name>\systemQuotas::process_attributes()</full_name>
        <docblock line="178">
          <description>Processes user input of the primary module page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="178" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="234" package="modules">
        <name>checkQuota</name>
        <full_name>\systemQuotas::checkQuota()</full_name>
        <docblock line="234">
          <description>Checks if the quota parameters are valid.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;mountpoint&lt;/p&gt;" line="234" type="String" variable="$path">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;soft block limit&lt;/p&gt;" line="234" type="int" variable="$softBlock">
            <type>int</type>
          </tag>
          <tag name="param" description="&lt;p&gt;hard block limit&lt;/p&gt;" line="234" type="int" variable="$hardBlock">
            <type>int</type>
          </tag>
          <tag name="param" description="&lt;p&gt;soft inode limit&lt;/p&gt;" line="234" type="int" variable="$softInode">
            <type>int</type>
          </tag>
          <tag name="param" description="&lt;p&gt;hard inode limit&lt;/p&gt;" line="234" type="int" variable="$hardInode">
            <type>int</type>
          </tag>
          <tag name="param" description="&lt;p&gt;position is upload table&lt;/p&gt;" line="234" type="boolean" variable="$uploadIndex">
            <type>boolean</type>
          </tag>
          <tag name="return" description="array where error messages are returned" line="234" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$path</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$softBlock</name>
          <default></default>
          <type>int</type>
        </argument>
        <argument line="0">
          <name>$hardBlock</name>
          <default></default>
          <type>int</type>
        </argument>
        <argument line="0">
          <name>$softInode</name>
          <default></default>
          <type>int</type>
        </argument>
        <argument line="0">
          <name>$hardInode</name>
          <default></default>
          <type>int</type>
        </argument>
        <argument line="0">
          <name>$uploadIndex</name>
          <default>null</default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="315" package="modules">
        <name>check_profileOptions</name>
        <full_name>\systemQuotas::check_profileOptions()</full_name>
        <docblock line="315">
          <description>Checks input values of account profiles.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;a hash array (name =&gt; value) containing the options&lt;/p&gt;&#10;" line="315" type="array" variable="$options">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages (array(type, title, text)) to generate StatusMessages, if any" line="315" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$options</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="333" package="modules">
        <name>load_profile</name>
        <full_name>\systemQuotas::load_profile()</full_name>
        <docblock line="333">
          <description>Loads the values of an account profile into internal variables.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;hash array with profile values (identifier =&gt; value)&lt;/p&gt;&#10;" line="333" type="array" variable="$profile">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$profile</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="350" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>\systemQuotas::build_uploadAccounts()</full_name>
        <docblock line="350">
          <description>In this function the LDAP account is built up.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) from user input&lt;/p&gt;&#10;" line="350" type="array" variable="$rawAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)&lt;/p&gt;&#10;" line="350" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) which are later added to LDAP&lt;/p&gt;&#10;" line="350" type="array" variable="$partialAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="350" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages if any" line="350" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rawAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$partialAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="371" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\systemQuotas::get_pdfEntries()</full_name>
        <docblock line="371">
          <description>Returns a list of PDF entries</description>
          <long-description></long-description>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/freeRadius.inc" generated-path="lib.modules.freeRadius.inc.html" hash="e3c1425abc51704bd88107052e40440e" package="modules">
    <docblock line="0">
      <description>Manages FreeRadius accounts.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="35" package="modules">
      <extends>\baseModule</extends>
      <name>freeRadius</name>
      <full_name>\freeRadius</full_name>
      <docblock line="35">
        <description>Manages FreeRadius accounts.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="35"/>
      </docblock>
      <property static="true" visibility="private" line="38" namespace="" package="modules">
        <name>$monthList</name>
        <default>array('01' =&gt; 'Jan', '02' =&gt; 'Feb', '03' =&gt; 'Mar', '04' =&gt; 'Apr', '05' =&gt; 'May', '06' =&gt; 'Jun', '07' =&gt; 'Jul', '08' =&gt; 'Aug', '09' =&gt; 'Sep', '10' =&gt; 'Oct', '11' =&gt; 'Nov', '12' =&gt; 'Dec')</default>
        <docblock line="38">
          <description>list of possible months</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="48" package="modules">
        <name>__construct</name>
        <full_name>\freeRadius::__construct()</full_name>
        <docblock line="48">
          <description>Creates a new freeRadius object.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account type (user, group, host)&lt;/p&gt;&#10;" line="48" type="string" variable="$scope">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="60" package="modules">
        <name>get_metaData</name>
        <full_name>\freeRadius::get_metaData()</full_name>
        <docblock line="60">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="60" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="60"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="241" package="modules">
        <name>load_Messages</name>
        <full_name>\freeRadius::load_Messages()</full_name>
        <docblock line="241">
          <description>This function fills the error message array with messages</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="261" package="modules">
        <name>display_html_attributes</name>
        <full_name>\freeRadius::display_html_attributes()</full_name>
        <docblock line="261">
          <description>Returns the HTML meta data for the main account page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="261" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="356" package="modules">
        <name>process_attributes</name>
        <full_name>\freeRadius::process_attributes()</full_name>
        <docblock line="356">
          <description>Processes user input of the primary module page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="356" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="429" package="modules">
        <name>display_html_expiration</name>
        <full_name>\freeRadius::display_html_expiration()</full_name>
        <docblock line="429">
          <description>This function will create the meta HTML code to show a page to change the expiration date.</description>
          <long-description></long-description>
          <tag name="return" description="meta HTML code" line="429" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="489" package="modules">
        <name>process_expiration</name>
        <full_name>\freeRadius::process_expiration()</full_name>
        <docblock line="489">
          <description>Processes user input of the time selection page.</description>
          <long-description></long-description>
          <tag name="return" description="list of info/error messages" line="489" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="527" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>\freeRadius::build_uploadAccounts()</full_name>
        <docblock line="527">
          <description>In this function the LDAP account is built up.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) from user input&lt;/p&gt;&#10;" line="527" type="array" variable="$rawAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)&lt;/p&gt;&#10;" line="527" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) which are later added to LDAP&lt;/p&gt;&#10;" line="527" type="array" variable="$partialAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="527" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages if any" line="527" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rawAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$partialAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="614" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\freeRadius::get_pdfEntries()</full_name>
        <docblock line="614">
          <description>Returns the PDF entries for this module.</description>
          <long-description></long-description>
          <tag name="return" description="list of possible PDF entries" line="614" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="633" package="modules">
        <name>check_profileOptions</name>
        <full_name>\freeRadius::check_profileOptions()</full_name>
        <docblock line="633">
          <description>Checks input values of account profiles.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;a hash array (name =&gt; value) containing the options&lt;/p&gt;&#10;" line="633" type="array" variable="$options">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages (array(type, title, text)) to generate StatusMessages, if any" line="633" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$options</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="655" package="modules">
        <name>load_profile</name>
        <full_name>\freeRadius::load_profile()</full_name>
        <docblock line="655">
          <description>Loads the values of an account profile into internal variables.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;hash array with profile values (identifier =&gt; value)&lt;/p&gt;&#10;" line="655" type="array" variable="$profile">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$profile</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="671" package="modules">
        <name>formatExpirationDate</name>
        <full_name>\freeRadius::formatExpirationDate()</full_name>
        <docblock line="671">
          <description>Formats the expiration date attribute.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;date value&lt;/p&gt;" line="671" type="String" variable="$date">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$date</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/asteriskExtension.inc" generated-path="lib.modules.asteriskExtension.inc.html" hash="1d215ec460a6b35281289779d79675fc" package="modules">
    <docblock line="0">
      <description>Manages Asterisk extensions.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Pavel Pozdniak" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="41" package="modules">
      <extends>\baseModule</extends>
      <name>asteriskExtension</name>
      <full_name>\asteriskExtension</full_name>
      <docblock line="41">
        <description>Manages Asterisk extensions.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="41"/>
      </docblock>
      <property static="false" visibility="private" line="44" namespace="" package="modules">
        <name>$filterOwnerForAsteriskAccounts</name>
        <default>true</default>
        <docblock line="44">
          <description>if true then only Asterisk accounts are shown as possible owners</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="47" namespace="" package="modules">
        <name>$searchOwnersInTreeSuffix</name>
        <default>false</default>
        <docblock line="47">
          <description>if true then the tree suffix will be used to search potential owners</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="49" namespace="" package="modules">
        <name>$extensionRows</name>
        <default>array()</default>
        <docblock line="49">
          <description>Contains all attributes information for set of accounts</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="51" namespace="" package="modules">
        <name>$extensionRowsOrig</name>
        <default>array()</default>
        <docblock line="51">
          <description>Contains all original attributes information for set of accounts</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="53" namespace="" package="modules">
        <name>$extensionOwners</name>
        <default>array()</default>
        <docblock line="53">
          <description>extension owners</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="55" namespace="" package="modules">
        <name>$addRuleFlag</name>
        <default>false</default>
        <docblock line="55">
          <description>flag if new rule should be added</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="62" package="modules">
        <name>get_metaData</name>
        <full_name>\asteriskExtension::get_metaData()</full_name>
        <docblock line="62">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="62" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="177" package="modules">
        <name>load_Messages</name>
        <full_name>\asteriskExtension::load_Messages()</full_name>
        <docblock line="177">
          <description>This function fills the error message array with messages</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="195" package="modules">
        <name>display_html_attributes</name>
        <full_name>\asteriskExtension::display_html_attributes()</full_name>
        <docblock line="195">
          <description>This function will create the meta HTML code to show a page with all attributes.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="195" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="224" package="modules">
        <name>render_exten_owners_set_controls</name>
        <full_name>\asteriskExtension::render_exten_owners_set_controls()</full_name>
        <docblock line="224">
          <description>This function prints management elements to manipulate owners of an extension.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;container&lt;/p&gt;" line="224" type="\htmlTable" variable="">
            <type>\htmlTable</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$renderContainer</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="250" package="modules">
        <name>load_extension_parts</name>
        <full_name>\asteriskExtension::load_extension_parts()</full_name>
        <docblock line="250">
          <description>Loads all related extension entries.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;extension name&lt;/p&gt;" line="250" type="String" variable="$extension">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$extension</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="273" package="modules">
        <name>render_extensions_by_priority</name>
        <full_name>\asteriskExtension::render_extensions_by_priority()</full_name>
        <docblock line="273">
          <description>Generates the meta HTML for the rules.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;extension name&lt;/p&gt;" line="273" type="String" variable="$extension">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;container&lt;/p&gt;" line="273" type="\htmlTable" variable="$renderContainer">
            <type>\htmlTable</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$extension</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$renderContainer</name>
          <default></default>
          <type>\htmlTable</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="353" package="modules">
        <name>render_extension</name>
        <full_name>\asteriskExtension::render_extension()</full_name>
        <docblock line="353">
          <description>Generates the meta HTML for a single rule.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;attributes of rule&lt;/p&gt;" line="353" type="array" variable="$extensLine">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;rule position&lt;/p&gt;" line="353" type="int" variable="$placeInList">
            <type>int</type>
          </tag>
          <tag name="param" description="&lt;p&gt;container&lt;/p&gt;" line="353" type="\htmlTable" variable="$renderContainer">
            <type>\htmlTable</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$extensLine</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$placeInList</name>
          <default></default>
          <type>int</type>
        </argument>
        <argument line="0">
          <name>$renderContainer</name>
          <default></default>
          <type>\htmlTable</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="379" package="modules">
        <name>array_sort</name>
        <full_name>\asteriskExtension::array_sort()</full_name>
        <docblock line="379">
          <description>Sorts an array of arrays by the given key.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;array&lt;/p&gt;" line="379" type="array" variable="$array">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;key&lt;/p&gt;" line="379" type="String" variable="$on">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;order (SORT_ASC or SORT_DESC)&lt;/p&gt;&#10;" line="379" type="String" variable="$order">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$array</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$on</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$order</name>
          <default>'SORT_ASC'</default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="417" package="modules">
        <name>display_html_user</name>
        <full_name>\asteriskExtension::display_html_user()</full_name>
        <docblock line="417">
          <description>Displays a list of possible owners of this extension.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="417" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="489" package="modules">
        <name>process_user</name>
        <full_name>\asteriskExtension::process_user()</full_name>
        <docblock line="489">
          <description>Processes user input of the user selection page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="489" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="522" package="modules">
        <name>isMoveToNewSuffix</name>
        <full_name>\asteriskExtension::isMoveToNewSuffix()</full_name>
        <docblock line="522">
          <description>Returns if the extension was moved to another OU.</description>
          <long-description></long-description>
          <tag name="return" description="true if moved" line="522" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="537" package="modules">
        <name>isExtensionOwnerSet</name>
        <full_name>\asteriskExtension::isExtensionOwnerSet()</full_name>
        <docblock line="537">
          <description>Returns true if at least one owner is set and false otherwise</description>
          <long-description></long-description>
          <tag name="return" description="true if one or more owners" line="537" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="549" package="modules">
        <name>process_attributes</name>
        <full_name>\asteriskExtension::process_attributes()</full_name>
        <docblock line="549">
          <description>Writes variables into object and does some regex checks.</description>
          <long-description></long-description>
          <tag name="return" description="error messages" line="549" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="603" package="modules">
        <name>processExtensionRows</name>
        <full_name>\asteriskExtension::processExtensionRows()</full_name>
        <docblock line="603">
          <description>Processes the rule data.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;extension name&lt;/p&gt;" line="603" type="String" variable="$extensionName">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;extension context&lt;/p&gt;" line="603" type="String" variable="$extensionContext">
            <type>String</type>
          </tag>
          <tag name="return" description="error messages" line="603" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$extensionName</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$extensionContext</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="644" package="modules">
        <name>setDefaultExtensionOwner</name>
        <full_name>\asteriskExtension::setDefaultExtensionOwner()</full_name>
        <docblock line="644">
          <description>Set extension owner as current logged in user.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="655" package="modules">
        <name>getDefaultExtensionOwner</name>
        <full_name>\asteriskExtension::getDefaultExtensionOwner()</full_name>
        <docblock line="655">
          <description>Returns the default extension owner.</description>
          <long-description></long-description>
          <tag name="return" description="owner" line="655" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="672" package="modules">
        <name>processSingleExtension</name>
        <full_name>\asteriskExtension::processSingleExtension()</full_name>
        <docblock line="672">
          <description>Fills the fileds of a single extension row.</description>
          <long-description>In Asterisk it would only be an extension name,a priority,an application, but LDAP spicific
add to processing context field.</long-description>
          <tag name="param" description="&lt;ul&gt;&#10;&lt;li&gt;hash array to store single extension properties;&lt;/li&gt;&#10;&lt;/ul&gt;&#10;" line="672" type="array" variable="$extRow">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;extension name&lt;/p&gt;" line="672" type="String" variable="$extensionName">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;extension context&lt;/p&gt;" line="672" type="String" variable="$extensionContext">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;ul&gt;&#10;&lt;li&gt;counter to distinguish single extensuion properties from $_POST&lt;/li&gt;&#10;&lt;/ul&gt;&#10;" line="672" type="int" variable="$entryCounter">
            <type>int</type>
          </tag>
          <tag name="param" description="&lt;ul&gt;&#10;&lt;li&gt;it is the variable where actual number of extension rules wuld be aggregated&lt;/li&gt;&#10;&lt;/ul&gt;&#10;" line="672" type="int" variable="$extensionPriorityCntr">
            <type>int</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$extRow</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$extensionName</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$extensionContext</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$entryCounter</name>
          <default></default>
          <type>int</type>
        </argument>
        <argument line="0">
          <name>$extensionPriorityCntr</name>
          <default></default>
          <type>int</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="713" package="modules">
        <name>processPriorityChange</name>
        <full_name>\asteriskExtension::processPriorityChange()</full_name>
        <docblock line="713">
          <description>Reorders the rules if the user clicked on a move button.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="734" package="modules">
        <name>isThisExtensionPresented</name>
        <full_name>\asteriskExtension::isThisExtensionPresented()</full_name>
        <docblock line="734">
          <description>Search by extension name and retun true if fields with this extension name exists
and false otherwise.</description>
          <long-description>Equal extension names are allowed in different OUs.</long-description>
          <tag name="param" description="&lt;p&gt;extension name&lt;/p&gt;" line="734" type="String" variable="$extension">
            <type>String</type>
          </tag>
          <tag name="return" description="true if there are entries with this extension name." line="734" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$extension</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="758" package="modules">
        <name>generateNextExtensionName</name>
        <full_name>\asteriskExtension::generateNextExtensionName()</full_name>
        <docblock line="758">
          <description>This function searches in the base subtree and finds all extensions names within.</description>
          <long-description>The generation algorithm is the naive one, so only work when extension is numbers.
All extension name is sorted and new extension name will be greates on + 1.</long-description>
          <tag name="return" description="suggested extension name" line="758" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="793" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\asteriskExtension::get_pdfEntries()</full_name>
        <docblock line="793">
          <description>Returns a list of PDF entries</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="844" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>\asteriskExtension::build_uploadAccounts()</full_name>
        <docblock line="844">
          <description>In this function the LDAP account is built up.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) from user input&lt;/p&gt;&#10;" line="844" type="array" variable="$rawAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)&lt;/p&gt;&#10;" line="844" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) which are later added to LDAP&lt;/p&gt;&#10;" line="844" type="array" variable="$partialAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="844" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages if any" line="844" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rawAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$partialAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="896" package="modules">
        <name>moveExtentionToNewSuffix</name>
        <full_name>\asteriskExtension::moveExtentionToNewSuffix()</full_name>
        <docblock line="896">
          <description>Get list of all applications for given extension and move it into new suffix.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;attributes of original extension&lt;/p&gt;" line="896" type="array" variable="$rowOrig">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages" line="896" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rowOrig</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="930" package="modules">
        <name>save_attributes</name>
        <full_name>\asteriskExtension::save_attributes()</full_name>
        <docblock line="930">
          <description>Returns a list of modifications which have to be made to the LDAP account.</description>
          <long-description>Calling this method requires the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;

&lt;br&gt;This function returns an array with 3 entries:
&lt;br&gt;array( DN1 ('add' =&gt; array($attr), 'remove' =&gt; array($attr), 'modify' =&gt; array($attr)), DN2 .... )
&lt;br&gt;DN is the DN to change. It is possible to change several DNs (e.g. create a new user and add him
to some groups via attribute memberUid)&lt;br&gt;
&lt;br&gt;&lt;b&gt;"add"&lt;/b&gt; are attributes which have to be added to the LDAP entry
&lt;br&gt;&lt;b&gt;"remove"&lt;/b&gt; are attributes which have to be removed from the LDAP entry
&lt;br&gt;&lt;b&gt;"modify"&lt;/b&gt; are attributes which have to be modified in the LDAP entry
&lt;br&gt;&lt;b&gt;"notchanged"&lt;/b&gt; are attributes which stay unchanged
&lt;br&gt;&lt;b&gt;"info"&lt;/b&gt; values with informational value (e.g. to be used later by pre/postModify actions)
&lt;br&gt;
&lt;br&gt;This builds the required comands from $this-attributes and $this-&gt;orig.</long-description>
          <tag name="return" description="list of modifications" line="930" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="989" package="modules">
        <name>postDeleteActions</name>
        <full_name>\asteriskExtension::postDeleteActions()</full_name>
        <docblock line="989">
          <description>Runs ufter main deltete procedure was done and do postmorten for other parts of extension
wtith priority &gt; 1.</description>
          <long-description></long-description>
          <tag name="return" description="error messages" line="989" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/generalInformation.inc" generated-path="lib.modules.generalInformation.inc.html" hash="f591c0c33582dcb5498fd59dcda7fdfe" package="modules">
    <docblock line="0">
      <description>Shows general information like the creation time of an account.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="35" package="modules">
      <extends>\baseModule</extends>
      <name>generalInformation</name>
      <full_name>\generalInformation</full_name>
      <docblock line="35">
        <description>Shows general information like the creation time of an account.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="35"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="44" package="modules">
        <name>get_metaData</name>
        <full_name>\generalInformation::get_metaData()</full_name>
        <docblock line="44">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="44" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="44"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="65" package="modules">
        <name>display_html_attributes</name>
        <full_name>\generalInformation::display_html_attributes()</full_name>
        <docblock line="65">
          <description>Returns the HTML meta data for the main account page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="65" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="121" package="modules">
        <name>process_attributes</name>
        <full_name>\generalInformation::process_attributes()</full_name>
        <docblock line="121">
          <description>Processes user input of the primary module page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="121" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/sambaSamAccount/sambaMungedDial.inc" generated-path="lib.modules.sambaSamAccount.sambaMungedDial.inc.html" hash="3705fc3908439bcedb6a3e873febbfc9" package="modules">
    <docblock line="0">
      <description>Manages terminal server settings for Samba 3.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Cajus Pollmeier" line="0"/>
    </docblock>
    <constant namespace="" line="32" package="modules">
      <name>"SAMBA_MUNGEDDIAL_FILEHEADER"</name>
      <full_name>\\"SAMBA_MUNGEDDIAL_FILEHEADER"</full_name>
      <value>"20002000200020002000200020002000" . "20002000200020002000200020002000" . "20002000200020002000200020002000" . "20002000200020002000200020002000" . "20002000200020002000200020002000" . "20002000200020002000200020002000" . "5000"</value>
      <docblock line="32">
        <description>File header</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="43" package="modules">
      <name>"SAMBA_MUNGEDDIAL_FILEHEADER_OLD"</name>
      <full_name>\\"SAMBA_MUNGEDDIAL_FILEHEADER_OLD"</full_name>
      <value>"6d000800200020002000200020002000" . "20002000200020002000200020002000" . "20002000200020002000200064000100" . "20002000200020002000200020002000" . "20002000200020002000200020002000" . "20002000200020002000200020002000" . "50001000"</value>
      <docblock line="43">
        <description>File header for old format.</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <class final="false" abstract="false" namespace="" line="57" package="modules">
      <extends/>
      <name>sambaMungedDial</name>
      <full_name>\sambaMungedDial</full_name>
      <docblock line="57">
        <description>Manages terminal server settings for Samba 3.</description>
        <long-description></long-description>
        <tag name="author" description="Cajus Pollmeier" line="57"/>
        <tag name="package" description="modules" line="57"/>
      </docblock>
      <property static="false" visibility="public" line="60" namespace="" package="modules">
        <name>$ctx</name>
        <default>array('CtxCfgPresent' =&gt; '551e0bb0', 'CtxCfgFlags1' =&gt; '00e00010', 'CtxCallback' =&gt; '', 'CtxShadow' =&gt; '01000000', 'CtxMaxConnectionTime' =&gt; '', 'CtxMaxDisconnectionTime' =&gt; '', 'CtxMaxIdleTime' =&gt; '', 'CtxKeyboardLayout' =&gt; '', 'CtxMinEncryptionLevel' =&gt; '00', 'CtxWorkDirectory' =&gt; '', 'CtxNWLogonServer' =&gt; '', 'CtxWFHomeDir' =&gt; '', 'CtxWFHomeDirDrive' =&gt; '', 'CtxWFProfilePath' =&gt; '', 'CtxInitialProgram' =&gt; '', 'CtxCallbackNumber' =&gt; '')</default>
        <docblock line="60">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="79" namespace="" package="modules">
        <name>$ctxattributes</name>
        <default>array("CtxCfgPresent", "CtxCfgFlags1", "CtxCallback", "CtxShadow", "CtxMaxConnectionTime", "CtxMaxDisconnectionTime", "CtxMaxIdleTime", "CtxKeyboardLayout", "CtxMinEncryptionLevel", "CtxWorkDirectory", "CtxNWLogonServer", "CtxWFHomeDir", "CtxWFHomeDirDrive", "CtxWFProfilePath", "CtxInitialProgram", "CtxCallbackNumber")</default>
        <docblock line="79">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="87" namespace="" package="modules">
        <name>$stringParams</name>
        <default>array("CtxWorkDirectory", "CtxNWLogonServer", "CtxWFHomeDir", "CtxWFHomeDirDrive", "CtxWFProfilePath", "CtxInitialProgram", "CtxCallbackNumber")</default>
        <docblock line="87">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="92" namespace="" package="modules">
        <name>$timeParams</name>
        <default>array("CtxMaxConnectionTime", "CtxMaxDisconnectionTime", "CtxMaxIdleTime")</default>
        <docblock line="92">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="94" namespace="" package="modules">
        <name>$old_behavior</name>
        <default>false</default>
        <docblock line="94">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="97" package="modules">
        <name>strhex</name>
        <full_name>\sambaMungedDial::strhex()</full_name>
        <docblock line="97">
          <description>strhex</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$string</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="109" package="modules">
        <name>hexstr</name>
        <full_name>\sambaMungedDial::hexstr()</full_name>
        <docblock line="109">
          <description>hexstr</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$hex</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="121" package="modules">
        <name>endian</name>
        <full_name>\sambaMungedDial::endian()</full_name>
        <docblock line="121">
          <description>endian</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$src</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="127" package="modules">
        <name>genTime</name>
        <full_name>\sambaMungedDial::genTime()</full_name>
        <docblock line="127">
          <description>genTime</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$minutes</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="135" package="modules">
        <name>readTime</name>
        <full_name>\sambaMungedDial::readTime()</full_name>
        <docblock line="135">
          <description>readTime</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$time</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="147" package="modules">
        <name>to8bit</name>
        <full_name>\sambaMungedDial::to8bit()</full_name>
        <docblock line="147">
          <description>to8bit</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$string</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="162" package="modules">
        <name>is_samba_path</name>
        <full_name>\sambaMungedDial::is_samba_path()</full_name>
        <docblock line="162">
          <description>Checks if this is a valid Samba path.</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$path</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="176" package="modules">
        <name>encode_munged</name>
        <full_name>\sambaMungedDial::encode_munged()</full_name>
        <docblock line="176">
          <description>Encode full MungedDial-String</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$params</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="212" package="modules">
        <name>munge</name>
        <full_name>\sambaMungedDial::munge()</full_name>
        <docblock line="212">
          <description>Setup parameter given by paramName to MungedDial-Format</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$paramName</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$paramValue</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$isString</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="250" package="modules">
        <name>decode_munged</name>
        <full_name>\sambaMungedDial::decode_munged()</full_name>
        <docblock line="250">
          <description>Takes a base64-encoded MungedDial-String and returns an array of included parameters and values</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$munge</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="305" package="modules">
        <name>load</name>
        <full_name>\sambaMungedDial::load()</full_name>
        <docblock line="305">
          <description>function takes a base64-encoded sambaMungedDial</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$mungedDial</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="311" package="modules">
        <name>getMunged</name>
        <full_name>\sambaMungedDial::getMunged()</full_name>
        <docblock line="311">
          <description>Returns ready-to-run mungedDialString to be filled into ldap</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="325" package="modules">
        <name>getOnDemandFlags</name>
        <full_name>\sambaMungedDial::getOnDemandFlags()</full_name>
        <docblock line="325">
          <description>Returns array of flags, which can be set on-demand with activated java-script</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="336" package="modules">
        <name>getTsLogin</name>
        <full_name>\sambaMungedDial::getTsLogin()</full_name>
        <docblock line="336">
          <description>Gets Terminal-Server-Login value: enabled/disabled</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="350" package="modules">
        <name>setTsLogin</name>
        <full_name>\sambaMungedDial::setTsLogin()</full_name>
        <docblock line="350">
          <description>Sets Terminal-Server-Login value: enabled/disabled</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$checked</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="364" package="modules">
        <name>getBrokenConn</name>
        <full_name>\sambaMungedDial::getBrokenConn()</full_name>
        <docblock line="364">
          <description>gets Broken-Connection value: disconnect/reset</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="377" package="modules">
        <name>setBrokenConn</name>
        <full_name>\sambaMungedDial::setBrokenConn()</full_name>
        <docblock line="377">
          <description>sets Broken-Connection value: disconnect/reset</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$checked</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="391" package="modules">
        <name>getReConn</name>
        <full_name>\sambaMungedDial::getReConn()</full_name>
        <docblock line="391">
          <description>gets Reconnection value: from any client/from previous client only</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="404" package="modules">
        <name>setReConn</name>
        <full_name>\sambaMungedDial::setReConn()</full_name>
        <docblock line="404">
          <description>sets Reconnection value: from any client/from previous client only</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$checked</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="418" package="modules">
        <name>getInheritMode</name>
        <full_name>\sambaMungedDial::getInheritMode()</full_name>
        <docblock line="418">
          <description>gets Inherit-config-from-client value: enabled/disabled</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="430" package="modules">
        <name>setInheritMode</name>
        <full_name>\sambaMungedDial::setInheritMode()</full_name>
        <docblock line="430">
          <description>sets Inherit-config-from-client value: enabled/disabled</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$checked</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="446" package="modules">
        <name>getShadow</name>
        <full_name>\sambaMungedDial::getShadow()</full_name>
        <docblock line="446">
          <description>gets shadow value (enum): 0-4
0: disabled
1: input on, notify on
2: input on, notify off
3: input off, notify on
4: input off, notify off</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="457" package="modules">
        <name>setShadow</name>
        <full_name>\sambaMungedDial::setShadow()</full_name>
        <docblock line="457">
          <description>sets shadow value</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$checked</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$value</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="469" package="modules">
        <name>getConnectClientDrives</name>
        <full_name>\sambaMungedDial::getConnectClientDrives()</full_name>
        <docblock line="469">
          <description>gets connect-client-drive-at-logon value: enabled/disabled</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="482" package="modules">
        <name>setConnectClientDrives</name>
        <full_name>\sambaMungedDial::setConnectClientDrives()</full_name>
        <docblock line="482">
          <description>sets connect-client-drive-at-logon value: enabled/disabled</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$checked</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="495" package="modules">
        <name>getConnectClientPrinters</name>
        <full_name>\sambaMungedDial::getConnectClientPrinters()</full_name>
        <docblock line="495">
          <description>gets connect-client-printers-at-logon value: enabled/disabled</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="508" package="modules">
        <name>setConnectClientPrinters</name>
        <full_name>\sambaMungedDial::setConnectClientPrinters()</full_name>
        <docblock line="508">
          <description>sets connect-client-printers-at-logon value: enabled/disabled</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$checked</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="522" package="modules">
        <name>getDefaultPrinter</name>
        <full_name>\sambaMungedDial::getDefaultPrinter()</full_name>
        <docblock line="522">
          <description>gets set-client-printer-to-default value: enabled/disabled</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="535" package="modules">
        <name>setDefaultPrinter</name>
        <full_name>\sambaMungedDial::setDefaultPrinter()</full_name>
        <docblock line="535">
          <description>sets set-client-printer-to-default value: enabled/disabled</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$checked</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="549" package="modules">
        <name>getCtxMaxConnectionTimeF</name>
        <full_name>\sambaMungedDial::getCtxMaxConnectionTimeF()</full_name>
        <docblock line="549">
          <description>SMARTY: gets the checkbox state of "Connection"</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="562" package="modules">
        <name>setCtxMaxConnectionTimeF</name>
        <full_name>\sambaMungedDial::setCtxMaxConnectionTimeF()</full_name>
        <docblock line="562">
          <description>SMARTY: sets the checkbox "Connection" to unchecked</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$checked</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="570" package="modules">
        <name>getCtxMaxDisconnectionTimeF</name>
        <full_name>\sambaMungedDial::getCtxMaxDisconnectionTimeF()</full_name>
        <docblock line="570">
          <description>SMARTY: gets the checkbox state of "Disconnection"</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="583" package="modules">
        <name>setCtxMaxDisconnectionTimeF</name>
        <full_name>\sambaMungedDial::setCtxMaxDisconnectionTimeF()</full_name>
        <docblock line="583">
          <description>SMARTY: sets the checkbox "Disconnection" to unchecked</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$checked</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="591" package="modules">
        <name>getCtxMaxIdleTimeF</name>
        <full_name>\sambaMungedDial::getCtxMaxIdleTimeF()</full_name>
        <docblock line="591">
          <description>SMARTY: gets the checkbox state of "Idle"</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="604" package="modules">
        <name>setCtxMaxIdleTimeF</name>
        <full_name>\sambaMungedDial::setCtxMaxIdleTimeF()</full_name>
        <docblock line="604">
          <description>SMARTY: sets the checkbox "Idle" to unchecked</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$checked</name>
          <default></default>
          <type/>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/asteriskVoicemail.inc" generated-path="lib.modules.asteriskVoicemail.inc.html" hash="eb4b8e848006e8ded07bbc6b4f857d5e" package="modules">
    <docblock line="0">
      <description>Manages the Asterisk extension of user accounts.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Pavel Pozdnyak" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="40" package="modules">
      <extends>\baseModule</extends>
      <implements>\passwordService</implements>
      <name>asteriskVoicemail</name>
      <full_name>\asteriskVoicemail</full_name>
      <docblock line="40">
        <description>Manages the Asterisk extension of user accounts.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="40"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="47" package="modules">
        <name>__construct</name>
        <full_name>\asteriskVoicemail::__construct()</full_name>
        <docblock line="47">
          <description>Creates a new asteriskVoicemail object.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account type (user, group, host)&lt;/p&gt;&#10;" line="47" type="string" variable="$scope">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="58" package="modules">
        <name>get_metaData</name>
        <full_name>\asteriskVoicemail::get_metaData()</full_name>
        <docblock line="58">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="58" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="198" package="modules">
        <name>load_Messages</name>
        <full_name>\asteriskVoicemail::load_Messages()</full_name>
        <docblock line="198">
          <description>This function fills the error message array with messages</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="223" package="modules">
        <name>display_html_attributes</name>
        <full_name>\asteriskVoicemail::display_html_attributes()</full_name>
        <docblock line="223">
          <description>Returns the HTML meta data for the main account page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="223" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="296" package="modules">
        <name>process_attributes</name>
        <full_name>\asteriskVoicemail::process_attributes()</full_name>
        <docblock line="296">
          <description>Write variables into object and do some regex checks</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="386" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\asteriskVoicemail::get_pdfEntries()</full_name>
        <docblock line="386">
          <description>Returns a list of PDF entries</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="407" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>\asteriskVoicemail::build_uploadAccounts()</full_name>
        <docblock line="407">
          <description>In this function the LDAP account is built up.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) from user input&lt;/p&gt;&#10;" line="407" type="array" variable="$rawAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)&lt;/p&gt;&#10;" line="407" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) which are later added to LDAP&lt;/p&gt;&#10;" line="407" type="array" variable="$partialAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="407" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages if any" line="407" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rawAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$partialAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="487" package="modules">
        <name>module_complete</name>
        <full_name>\asteriskVoicemail::module_complete()</full_name>
        <docblock line="487">
          <description>This functions returns true if all needed settings are done.</description>
          <long-description></long-description>
          <tag name="return" description="true if LDAP operation can be done" line="487" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="508" package="modules">
        <name>save_attributes</name>
        <full_name>\asteriskVoicemail::save_attributes()</full_name>
        <docblock line="508">
          <description>Returns a list of modifications which have to be made to the LDAP account.</description>
          <long-description></long-description>
          <tag name="return" description="list of modifications&#10;&amp;lt;br&amp;gt;This function returns an array with 3 entries:&#10;&amp;lt;br&amp;gt;array( DN1 (&amp;#039;add&amp;#039; =&amp;gt; array($attr), &amp;#039;remove&amp;#039; =&amp;gt; array($attr), &amp;#039;modify&amp;#039; =&amp;gt; array($attr)), DN2 .... )&#10;&amp;lt;br&amp;gt;DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)&#10;&amp;lt;br&amp;gt;&amp;quot;add&amp;quot; are attributes which have to be added to LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;remove&amp;quot; are attributes which have to be removed from LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;modify&amp;quot; are attributes which have to been modified in LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;info&amp;quot; are values with informational value (e.g. to be used later by pre/postModify actions)" line="508" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="522" package="modules">
        <name>managesPasswordAttributes</name>
        <full_name>\asteriskVoicemail::managesPasswordAttributes()</full_name>
        <docblock line="522">
          <description>This method specifies if a module manages password attributes.</description>
          <long-description></long-description>
          <tag name="see" description="" line="522"/>
          <tag name="return" description="true if this module manages password attributes" line="522" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="534" package="modules">
        <name>supportsForcePasswordChange</name>
        <full_name>\asteriskVoicemail::supportsForcePasswordChange()</full_name>
        <docblock line="534">
          <description>Specifies if this module supports to force that a user must change his password on next login.</description>
          <long-description></long-description>
          <tag name="return" description="force password change supported" line="534" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="549" package="modules">
        <name>passwordChangeRequested</name>
        <full_name>\asteriskVoicemail::passwordChangeRequested()</full_name>
        <docblock line="549">
          <description>This function is called whenever the password should be changed. Account modules
must change their password attributes only if the modules list contains their module name.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;new password&lt;/p&gt;" line="549" type="String" variable="$password">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of modules for which the password should be changed&lt;/p&gt;" line="549" type="" variable="$modules"/>
          <tag name="param" description="&lt;p&gt;force the user to change his password at next login&lt;/p&gt;" line="549" type="boolean" variable="$forcePasswordChange">
            <type>boolean</type>
          </tag>
          <tag name="return" description="list of error messages if any as parameter array for StatusMessage&#10;&#9;&#9;   e.g. return arrray(array(&amp;#039;ERROR&amp;#039;, &amp;#039;Password change failed.&amp;#039;))" line="549" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="549"/>
        </docblock>
        <argument line="0">
          <name>$password</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$modules</name>
          <default></default>
          <type>mixed</type>
        </argument>
        <argument line="0">
          <name>$forcePasswordChange</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="574" package="modules">
        <name>checkSelfServiceOptions</name>
        <full_name>\asteriskVoicemail::checkSelfServiceOptions()</full_name>
        <docblock line="574">
          <description>Checks if all input values are correct and returns the LDAP attributes which should be changed.</description>
          <long-description>&lt;br&gt;Return values:
&lt;br&gt;messages: array of parameters to create status messages
&lt;br&gt;add: array of attributes to add
&lt;br&gt;del: array of attributes to remove
&lt;br&gt;mod: array of attributes to modify
&lt;br&gt;info: array of values with informational value (e.g. to be used later by pre/postModify actions)

Calling this method does not require the existence of an enclosing {@link accountContainer}.</long-description>
          <tag name="param" description="&lt;p&gt;input fields&lt;/p&gt;" line="574" type="string" variable="$fields">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="574" type="array" variable="$attributes">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;indicates that the user is only allowed to change his password and no LDAP content is readable&lt;/p&gt;" line="574" type="boolean" variable="$passwordChangeOnly">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of read-only fields&lt;/p&gt;&#10;" line="574" type="array" variable="$readOnlyFields">
            <type>array</type>
          </tag>
          <tag name="return" description="messages and attributes (array(&amp;#039;messages&amp;#039; =&amp;gt; array(), &amp;#039;add&amp;#039; =&amp;gt; array(&amp;#039;mail&amp;#039; =&amp;gt; array(&amp;#039;test@test.com&amp;#039;)), &amp;#039;del&amp;#039; =&amp;gt; array(), &amp;#039;mod&amp;#039; =&amp;gt; array(), &amp;#039;info&amp;#039; =&amp;gt; array()))" line="574" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$fields</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$passwordChangeOnly</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$readOnlyFields</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/inetLocalMailRecipient.inc" generated-path="lib.modules.inetLocalMailRecipient.inc.html" hash="82b354e711be7ce61bac356400191607" package="modules">
    <docblock line="0">
      <description>Provides mail routing for user accounts.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="35" package="modules">
      <extends>\baseModule</extends>
      <name>inetLocalMailRecipient</name>
      <full_name>\inetLocalMailRecipient</full_name>
      <docblock line="35">
        <description>Provides mail routing for users.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="35"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="44" package="modules">
        <name>get_metaData</name>
        <full_name>\inetLocalMailRecipient::get_metaData()</full_name>
        <docblock line="44">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="44" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="44"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="122" package="modules">
        <name>load_Messages</name>
        <full_name>\inetLocalMailRecipient::load_Messages()</full_name>
        <docblock line="122">
          <description>This function fills the error message array with messages</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="136" package="modules">
        <name>display_html_attributes</name>
        <full_name>\inetLocalMailRecipient::display_html_attributes()</full_name>
        <docblock line="136">
          <description>Returns the HTML meta data for the main account page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="136" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="170" package="modules">
        <name>process_attributes</name>
        <full_name>\inetLocalMailRecipient::process_attributes()</full_name>
        <docblock line="170">
          <description>Processes user input of the primary module page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="170" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="244" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>\inetLocalMailRecipient::build_uploadAccounts()</full_name>
        <docblock line="244">
          <description>In this function the LDAP account is built up.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) from user input&lt;/p&gt;&#10;" line="244" type="array" variable="$rawAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)&lt;/p&gt;&#10;" line="244" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) which are later added to LDAP&lt;/p&gt;&#10;" line="244" type="array" variable="$partialAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="244" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages if any" line="244" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rawAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$partialAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="297" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\inetLocalMailRecipient::get_pdfEntries()</full_name>
        <docblock line="297">
          <description>Returns the PDF entries for this module.</description>
          <long-description></long-description>
          <tag name="return" description="list of possible PDF entries" line="297" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/imapAccess.inc" generated-path="lib.modules.imapAccess.inc.html" hash="a11c0efe1e1e1703081f3995dc285289" package="modules">
    <docblock line="0">
      <description>Manages mailboxes on an IMAP server.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Pavel Pozdniak" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="39" package="modules">
      <extends>\baseModule</extends>
      <name>imapAccess</name>
      <full_name>\imapAccess</full_name>
      <docblock line="39">
        <description>Manages mailboxes on an IMAP server.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="39"/>
        <tag name="author" description="Pavel Pozdniak" line="39"/>
        <tag name="author" description="Roland Gruber" line="39"/>
      </docblock>
      <property static="false" visibility="private" line="42" namespace="" package="modules">
        <name>$profileQuotaLimit</name>
        <default>null</default>
        <docblock line="42">
          <description>quota limit from profile</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="51" package="modules">
        <name>get_metaData</name>
        <full_name>\imapAccess::get_metaData()</full_name>
        <docblock line="51">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="51" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="51"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="157" package="modules">
        <name>load_Messages</name>
        <full_name>\imapAccess::load_Messages()</full_name>
        <docblock line="157">
          <description>This function fills the error message array with messages</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="176" package="modules">
        <name>display_html_attributes</name>
        <full_name>\imapAccess::display_html_attributes()</full_name>
        <docblock line="176">
          <description>Returns the HTML meta data for the main account page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="176" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="261" package="modules">
        <name>display_html_password</name>
        <full_name>\imapAccess::display_html_password()</full_name>
        <docblock line="261">
          <description>Returns the HTML meta data for the password page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="261" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="287" package="modules">
        <name>renderQuotasForMailbox</name>
        <full_name>\imapAccess::renderQuotasForMailbox()</full_name>
        <docblock line="287">
          <description>Display the mailbox quota.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;structure that contained information to be displayed&lt;/p&gt;" line="287" type="\htmlTable" variable="$htmlTable">
            <type>\htmlTable</type>
          </tag>
          <tag name="param" description="&lt;p&gt;stream to open IMAP session&lt;/p&gt;" line="287" type="\stream" variable="$mbox">
            <type>\stream</type>
          </tag>
          <tag name="param" description="&lt;p&gt;user name to connect to IMAP server&lt;/p&gt;" line="287" type="String" variable="$username">
            <type>String</type>
          </tag>
          <tag name="return" description="table with added information about user quotas or controls to add quota" line="287" type="\htmlTable">
            <type>\htmlTable</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$htmlTable</name>
          <default></default>
          <type>\htmlTable</type>
        </argument>
        <argument line="0">
          <name>$mbox</name>
          <default></default>
          <type>\stream</type>
        </argument>
        <argument line="0">
          <name>$username</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="323" package="modules">
        <name>process_attributes</name>
        <full_name>\imapAccess::process_attributes()</full_name>
        <docblock line="323">
          <description>Processes user input of the primary module page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="323" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="433" package="modules">
        <name>load_profile</name>
        <full_name>\imapAccess::load_profile()</full_name>
        <docblock line="433">
          <description>Loads the values of an account profile into internal variables.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;hash array with profile values (identifier =&gt; value)&lt;/p&gt;&#10;" line="433" type="array" variable="$profile">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$profile</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="446" package="modules">
        <name>getAdminPassword</name>
        <full_name>\imapAccess::getAdminPassword()</full_name>
        <docblock line="446">
          <description>Returns the admin password.</description>
          <long-description></long-description>
          <tag name="return" description="password" line="446" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="464" package="modules">
        <name>doLogin</name>
        <full_name>\imapAccess::doLogin()</full_name>
        <docblock line="464">
          <description>Checks the password given by user and save it as session parameter.</description>
          <long-description></long-description>
          <tag name="return" description="list of error messages" line="464" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="489" package="modules">
        <name>getServerAddress</name>
        <full_name>\imapAccess::getServerAddress()</full_name>
        <docblock line="489">
          <description>This function returns the IMAP server address including encryption options.</description>
          <long-description></long-description>
          <tag name="return" description="server address" line="489" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="520" package="modules">
        <name>getMailboxPrefix</name>
        <full_name>\imapAccess::getMailboxPrefix()</full_name>
        <docblock line="520">
          <description>This function returns the prefix for mailboxes.</description>
          <long-description>If no prefix was given during configuration then "user" will be used (default for Cyrus).</long-description>
          <tag name="return" description="prefix" line="520" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="536" package="modules">
        <name>isWrongDomain</name>
        <full_name>\imapAccess::isWrongDomain()</full_name>
        <docblock line="536">
          <description>This function checks if the domain of the mailbox is not in the list of domains listed in the configuration.</description>
          <long-description>If it is in the list then it returns false, otherwise returns true. If the list of domains is not set then it returns true.</long-description>
          <tag name="param" description="&lt;p&gt;email domain&lt;/p&gt;" line="536" type="String" variable="$email_domain">
            <type>String</type>
          </tag>
          <tag name="return" description="true if domains match" line="536" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$email_domain</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="558" package="modules">
        <name>getSep</name>
        <full_name>\imapAccess::getSep()</full_name>
        <docblock line="558">
          <description>Returns the path separator.</description>
          <long-description></long-description>
          <tag name="return" description="separator char" line="558" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/fixed_ip.inc" generated-path="lib.modules.fixed_ip.inc.html" hash="f4a73f378104a00a40943f4239aa443e" package="modules">
    <docblock line="0">
      <description>Manages DHCP host entries.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Thomas Manninger" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="41" package="modules">
      <extends>\baseModule</extends>
      <name>fixed_ip</name>
      <full_name>\fixed_ip</full_name>
      <docblock line="41">
        <description>Manages DHCP host entries.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="41"/>
      </docblock>
      <property static="false" visibility="public" line="44" namespace="" package="modules">
        <name>$fixed_ip</name>
        <default></default>
        <docblock line="44">
          <description>fixed ips</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="47" namespace="" package="modules">
        <name>$processed</name>
        <default>false</default>
        <docblock line="47">
          <description>already processed?</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="50" namespace="" package="modules">
        <name>$overlapd</name>
        <default></default>
        <docblock line="50">
          <description>for check if IPs overlap</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="53" namespace="" package="modules">
        <name>$orig_ips</name>
        <default>array()</default>
        <docblock line="53">
          <description>original IPs</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="56" namespace="" package="modules">
        <name>$attributes</name>
        <default></default>
        <docblock line="56">
          <description>LDAP attributes</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="65" package="modules">
        <name>get_metaData</name>
        <full_name>\fixed_ip::get_metaData()</full_name>
        <docblock line="65">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="65" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="65"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="112" package="modules">
        <name>load_Messages</name>
        <full_name>\fixed_ip::load_Messages()</full_name>
        <docblock line="112">
          <description>This function fills the error message array with messages.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="121" package="modules">
        <name>getButtonStatus</name>
        <full_name>\fixed_ip::getButtonStatus()</full_name>
        <docblock line="121">
          <description>Controls if the module button the account page is visible and activated.</description>
          <long-description></long-description>
          <tag name="return" description="status (&amp;quot;enabled&amp;quot;, &amp;quot;disabled&amp;quot;, &amp;quot;hidden&amp;quot;)" line="121" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="139" package="modules">
        <name>overlapd_ip</name>
        <full_name>\fixed_ip::overlapd_ip()</full_name>
        <docblock line="139">
          <description>Checked, if ips are overlapd.</description>
          <long-description></long-description>
          <tag name="param" description="" line="139" type="\ip" variable="">
            <type>\ip</type>
          </tag>
          <tag name="return" description="if overlapd, else true." line="139" type="\false,">
            <type>\false,</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$ip</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="153" package="modules">
        <name>reset_overlapd_ip</name>
        <full_name>\fixed_ip::reset_overlapd_ip()</full_name>
        <docblock line="153">
          <description>Reset the overlapd_range() function</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="164" package="modules">
        <name>check_mac</name>
        <full_name>\fixed_ip::check_mac()</full_name>
        <docblock line="164">
          <description>Check, if a mac address is invalid</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;adress&lt;/p&gt;" line="164" type="\mac" variable="">
            <type>\mac</type>
          </tag>
          <tag name="return" description="if mac is invalid" line="164" type="\true,">
            <type>\true,</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$mac</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="186" package="modules">
        <name>reload_ips</name>
        <full_name>\fixed_ip::reload_ips()</full_name>
        <docblock line="186">
          <description>Adapt the fixed ip with the subnet.</description>
          <long-description></long-description>
          <tag name="return" description="if ip were edit." line="186" type="\true,">
            <type>\true,</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="212" package="modules">
        <name>load_attributes</name>
        <full_name>\fixed_ip::load_attributes()</full_name>
        <docblock line="212">
          <description>This function loads all needed LDAP attributes.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of attributes&lt;/p&gt;" line="212" type="array" variable="$attr">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attr</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="244" package="modules">
        <name>process_attributes</name>
        <full_name>\fixed_ip::process_attributes()</full_name>
        <docblock line="244">
          <description>Processes user input of the primary module page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="244" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="345" package="modules">
        <name>display_html_attributes</name>
        <full_name>\fixed_ip::display_html_attributes()</full_name>
        <docblock line="345">
          <description>Returns the HTML meta data for the main account page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="345" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="462" package="modules">
        <name>save_attributes</name>
        <full_name>\fixed_ip::save_attributes()</full_name>
        <docblock line="462">
          <description>Returns a list of modifications which have to be made to the LDAP account.</description>
          <long-description></long-description>
          <tag name="return" description="list of modifications&#10;&amp;lt;br&amp;gt;This function returns an array with 3 entries:&#10;&amp;lt;br&amp;gt;array( DN1 (&amp;#039;add&amp;#039; =&amp;gt; array($attr), &amp;#039;remove&amp;#039; =&amp;gt; array($attr), &amp;#039;modify&amp;#039; =&amp;gt; array($attr)), DN2 .... )&#10;&amp;lt;br&amp;gt;DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)&#10;&amp;lt;br&amp;gt;&amp;quot;add&amp;quot; are attributes which have to be added to LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;remove&amp;quot; are attributes which have to be removed from LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;modify&amp;quot; are attributes which have to been modified in LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;info&amp;quot; are values with informational value (e.g. to be used later by pre/postModify actions)" line="462" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="475" package="modules">
        <name>postModifyActions</name>
        <full_name>\fixed_ip::postModifyActions()</full_name>
        <docblock line="475">
          <description>This function is overwritten because the fixed IPs are set after the ldap_add command.</description>
          <long-description></long-description>
          <tag name="see" description="" line="475"/>
          <tag name="param" description="" line="475" type="boolean" variable="$newAccount">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;LDAP attributes of this entry&lt;/p&gt;" line="475" type="array" variable="$attributes">
            <type>array</type>
          </tag>
          <tag name="return" description="array which contains status messages. Each entry is an array containing the status message parameters." line="475" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$newAccount</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="554" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\fixed_ip::get_pdfEntries()</full_name>
        <docblock line="554">
          <description>Returns the PDF entries for this module.</description>
          <long-description></long-description>
          <tag name="return" description="list of possible PDF entries" line="554" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="588" package="modules">
        <name>extractIP</name>
        <full_name>\fixed_ip::extractIP()</full_name>
        <docblock line="588">
          <description>Extracts the IP from a list of DHCP statements.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;values of dhcpStatements attribute&lt;/p&gt;" line="588" type="array" variable="$dhcpStatements">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$dhcpStatements</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="607" package="modules">
        <name>setIP</name>
        <full_name>\fixed_ip::setIP()</full_name>
        <docblock line="607">
          <description>Sets the IP in a list of DHCP statements.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;values of dhcpStatements attribute&lt;/p&gt;" line="607" type="array" variable="$dhcpStatements">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;new IP&lt;/p&gt;" line="607" type="String" variable="$ip">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$dhcpStatements</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ip</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="624" package="modules">
        <name>isActive</name>
        <full_name>\fixed_ip::isActive()</full_name>
        <docblock line="624">
          <description>Returns if this host is active.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;values of dhcpStatements attribute&lt;/p&gt;" line="624" type="array" variable="$dhcpStatements">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$dhcpStatements</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="645" package="modules">
        <name>setActive</name>
        <full_name>\fixed_ip::setActive()</full_name>
        <docblock line="645">
          <description>Sets if this host is active.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;values of dhcpStatements attribute&lt;/p&gt;" line="645" type="array" variable="$dhcpStatements">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;is active&lt;/p&gt;" line="645" type="boolean" variable="$active">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$dhcpStatements</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$active</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/authorizedServiceObject.inc" generated-path="lib.modules.authorizedServiceObject.inc.html" hash="6fbebe7dba16b5c1a524b6275b0be83c" package="modules">
    <docblock line="0">
      <description>Provides Authorized Service for accounts.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="J de Jong" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="38" package="modules">
      <extends>\baseModule</extends>
      <name>authorizedServiceObject</name>
      <full_name>\authorizedServiceObject</full_name>
      <docblock line="38">
        <description>Provides Authorized Service for accounts.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="38"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="45" package="modules">
        <name>__construct</name>
        <full_name>\authorizedServiceObject::__construct()</full_name>
        <docblock line="45">
          <description>Creates a new authorizedServiceObject object.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account type (user, group, host)&lt;/p&gt;&#10;" line="45" type="string" variable="$scope">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="57" package="modules">
        <name>get_metaData</name>
        <full_name>\authorizedServiceObject::get_metaData()</full_name>
        <docblock line="57">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="57" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="121" package="modules">
        <name>load_Messages</name>
        <full_name>\authorizedServiceObject::load_Messages()</full_name>
        <docblock line="121">
          <description>This function fills the error message array with messages</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="138" package="modules">
        <name>save_attributes</name>
        <full_name>\authorizedServiceObject::save_attributes()</full_name>
        <docblock line="138">
          <description>Returns a list of modifications which have to be made to the LDAP account.</description>
          <long-description></long-description>
          <tag name="return" description="list of modifications&#10;&amp;lt;br&amp;gt;This function returns an array with 3 entries:&#10;&amp;lt;br&amp;gt;array( DN1 (&amp;#039;add&amp;#039; =&amp;gt; array($attr), &amp;#039;remove&amp;#039; =&amp;gt; array($attr), &amp;#039;modify&amp;#039; =&amp;gt; array($attr)), DN2 .... )&#10;&amp;lt;br&amp;gt;DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)&#10;&amp;lt;br&amp;gt;&amp;quot;add&amp;quot; are attributes which have to be added to LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;remove&amp;quot; are attributes which have to be removed from LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;modify&amp;quot; are attributes which have to been modified in LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;info&amp;quot; are values with informational value (e.g. to be used later by pre/postModify actions)" line="138" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="151" package="modules">
        <name>display_html_attributes</name>
        <full_name>\authorizedServiceObject::display_html_attributes()</full_name>
        <docblock line="151">
          <description>Returns the HTML meta data for the main account page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="151" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="208" package="modules">
        <name>process_attributes</name>
        <full_name>\authorizedServiceObject::process_attributes()</full_name>
        <docblock line="208">
          <description>Processes user input of the primary module page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="208" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="261" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>\authorizedServiceObject::build_uploadAccounts()</full_name>
        <docblock line="261">
          <description>In this function the LDAP account is built up.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) from user input&lt;/p&gt;&#10;" line="261" type="array" variable="$rawAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)&lt;/p&gt;&#10;" line="261" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) which are later added to LDAP&lt;/p&gt;&#10;" line="261" type="array" variable="$partialAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="261" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages if any" line="261" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rawAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$partialAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="289" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\authorizedServiceObject::get_pdfEntries()</full_name>
        <docblock line="289">
          <description>Returns the PDF entries for this module.</description>
          <long-description></long-description>
          <tag name="return" description="list of possible PDF entries" line="289" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="302" package="modules">
        <name>load_profile</name>
        <full_name>\authorizedServiceObject::load_profile()</full_name>
        <docblock line="302">
          <description>Loads the values of an account profile into internal variables.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;hash array with profile values (identifier =&gt; value)&lt;/p&gt;&#10;" line="302" type="array" variable="$profile">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$profile</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/windowsGroup.inc" generated-path="lib.modules.windowsGroup.inc.html" hash="d1e582a781c32d782bd2b869caeeec8d" package="modules">
    <docblock line="0">
      <description>Manages Windows AD (e.g. Samba 4) groups.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="35" package="modules">
      <extends>\baseModule</extends>
      <name>windowsGroup</name>
      <full_name>\windowsGroup</full_name>
      <docblock line="35">
        <description>Manages Windows AD (e.g. Samba 4) groups.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="35"/>
      </docblock>
      <constant namespace="" line="43" package="modules">
        <name>TYPE_SECURITY</name>
        <full_name>\windowsGroup::TYPE_SECURITY</full_name>
        <value>'security'</value>
        <docblock line="43">
          <description>security group</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="" line="45" package="modules">
        <name>TYPE_DISTRIBUTION</name>
        <full_name>\windowsGroup::TYPE_DISTRIBUTION</full_name>
        <value>'distribution'</value>
        <docblock line="45">
          <description>email list</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="" line="47" package="modules">
        <name>SCOPE_DOMAIN_LOCAL</name>
        <full_name>\windowsGroup::SCOPE_DOMAIN_LOCAL</full_name>
        <value>'domain'</value>
        <docblock line="47">
          <description>domain local group</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="" line="49" package="modules">
        <name>SCOPE_GLOBAL</name>
        <full_name>\windowsGroup::SCOPE_GLOBAL</full_name>
        <value>'global'</value>
        <docblock line="49">
          <description>global group</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="" line="51" package="modules">
        <name>SCOPE_UNIVERSAL</name>
        <full_name>\windowsGroup::SCOPE_UNIVERSAL</full_name>
        <value>'universal'</value>
        <docblock line="51">
          <description>universal group</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <property static="false" visibility="private" line="38" namespace="" package="modules">
        <name>$groupTypes</name>
        <default></default>
        <docblock line="38">
          <description>possible group types (e.g. distribution)</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="40" namespace="" package="modules">
        <name>$groupScopes</name>
        <default></default>
        <docblock line="40">
          <description>possible group scopes (e.g. universal)</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="58" package="modules">
        <name>__construct</name>
        <full_name>\windowsGroup::__construct()</full_name>
        <docblock line="58">
          <description>Creates a new module for Samba 3 groups.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="58" type="string" variable="$scope">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="79" package="modules">
        <name>get_metaData</name>
        <full_name>\windowsGroup::get_metaData()</full_name>
        <docblock line="79">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="79" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="79"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="256" package="modules">
        <name>load_Messages</name>
        <full_name>\windowsGroup::load_Messages()</full_name>
        <docblock line="256">
          <description>This function fills the $messages variable with output messages from this module.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="272" package="modules">
        <name>display_html_attributes</name>
        <full_name>\windowsGroup::display_html_attributes()</full_name>
        <docblock line="272">
          <description>Returns the HTML meta data for the main account page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="272" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="377" package="modules">
        <name>process_attributes</name>
        <full_name>\windowsGroup::process_attributes()</full_name>
        <docblock line="377">
          <description>Processes user input of the primary module page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="377" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="430" package="modules">
        <name>display_html_managedBy</name>
        <full_name>\windowsGroup::display_html_managedBy()</full_name>
        <docblock line="430">
          <description>This function will create the meta HTML code to show a page to change the member attribute.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="430" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="470" package="modules">
        <name>process_managedBy</name>
        <full_name>\windowsGroup::process_managedBy()</full_name>
        <docblock line="470">
          <description>Processes user input of the members page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="470" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="483" package="modules">
        <name>display_html_user</name>
        <full_name>\windowsGroup::display_html_user()</full_name>
        <docblock line="483">
          <description>This function will create the meta HTML code to show a page to change the member attribute.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="483" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="570" package="modules">
        <name>process_user</name>
        <full_name>\windowsGroup::process_user()</full_name>
        <docblock line="570">
          <description>Processes user input of the members page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="570" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="607" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>\windowsGroup::build_uploadAccounts()</full_name>
        <docblock line="607">
          <description>In this function the LDAP account is built up.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) from user input&lt;/p&gt;&#10;" line="607" type="array" variable="$rawAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)&lt;/p&gt;&#10;" line="607" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) which are later added to LDAP&lt;/p&gt;&#10;" line="607" type="array" variable="$partialAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="607" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages if any" line="607" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rawAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$partialAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="711" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\windowsGroup::get_pdfEntries()</full_name>
        <docblock line="711">
          <description>Returns a list of PDF entries</description>
          <long-description></long-description>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/nisMailAlias.inc" generated-path="lib.modules.nisMailAlias.inc.html" hash="badb27f599275f53195926fefa9023ac" package="modules">
    <docblock line="0">
      <description>Provides NIS mail alias management.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="35" package="modules">
      <extends>\baseModule</extends>
      <name>nisMailAlias</name>
      <full_name>\nisMailAlias</full_name>
      <docblock line="35">
        <description>Provides NIS mail alias management.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="35"/>
      </docblock>
      <property static="false" visibility="private" line="38" namespace="" package="modules">
        <name>$cachedMailList</name>
        <default>null</default>
        <docblock line="38">
          <description>mail cache</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="47" package="modules">
        <name>get_metaData</name>
        <full_name>\nisMailAlias::get_metaData()</full_name>
        <docblock line="47">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="47" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="47"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="113" package="modules">
        <name>load_Messages</name>
        <full_name>\nisMailAlias::load_Messages()</full_name>
        <docblock line="113">
          <description>This function fills the error message array with messages</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="132" package="modules">
        <name>save_attributes</name>
        <full_name>\nisMailAlias::save_attributes()</full_name>
        <docblock line="132">
          <description>Returns a list of modifications which have to be made to the LDAP account.</description>
          <long-description></long-description>
          <tag name="return" description="list of modifications&#10;&amp;lt;br&amp;gt;This function returns an array with 3 entries:&#10;&amp;lt;br&amp;gt;array( DN1 (&amp;#039;add&amp;#039; =&amp;gt; array($attr), &amp;#039;remove&amp;#039; =&amp;gt; array($attr), &amp;#039;modify&amp;#039; =&amp;gt; array($attr)), DN2 .... )&#10;&amp;lt;br&amp;gt;DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)&#10;&amp;lt;br&amp;gt;&amp;quot;add&amp;quot; are attributes which have to be added to LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;remove&amp;quot; are attributes which have to be removed from LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;modify&amp;quot; are attributes which have to been modified in LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;info&amp;quot; are values with informational value (e.g. to be used later by pre/postModify actions)" line="132" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="145" package="modules">
        <name>display_html_attributes</name>
        <full_name>\nisMailAlias::display_html_attributes()</full_name>
        <docblock line="145">
          <description>Returns the HTML meta data for the main account page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="145" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="199" package="modules">
        <name>process_attributes</name>
        <full_name>\nisMailAlias::process_attributes()</full_name>
        <docblock line="199">
          <description>Processes user input of the primary module page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="199" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="249" package="modules">
        <name>display_html_select</name>
        <full_name>\nisMailAlias::display_html_select()</full_name>
        <docblock line="249">
          <description>Displays the host/user selection.</description>
          <long-description></long-description>
          <tag name="return" description="meta HTML code" line="249" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="297" package="modules">
        <name>process_select</name>
        <full_name>\nisMailAlias::process_select()</full_name>
        <docblock line="297">
          <description>Processes user input of the host/user selection page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="297" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="316" package="modules">
        <name>getButtonStatus</name>
        <full_name>\nisMailAlias::getButtonStatus()</full_name>
        <docblock line="316">
          <description>Controls if the module button the account page is visible and activated.</description>
          <long-description></long-description>
          <tag name="return" description="status (&amp;quot;enabled&amp;quot;, &amp;quot;disabled&amp;quot;, &amp;quot;hidden&amp;quot;)" line="316" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="336" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>\nisMailAlias::build_uploadAccounts()</full_name>
        <docblock line="336">
          <description>In this function the LDAP account is built up.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) from user input&lt;/p&gt;&#10;" line="336" type="array" variable="$rawAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)&lt;/p&gt;&#10;" line="336" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) which are later added to LDAP&lt;/p&gt;&#10;" line="336" type="array" variable="$partialAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="336" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages if any" line="336" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rawAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$partialAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="375" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\nisMailAlias::get_pdfEntries()</full_name>
        <docblock line="375">
          <description>Returns the PDF entries for this module.</description>
          <long-description></long-description>
          <tag name="return" description="list of possible PDF entries" line="375" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="387" package="modules">
        <name>getMailList</name>
        <full_name>\nisMailAlias::getMailList()</full_name>
        <docblock line="387">
          <description>Returns a list of existing email addresses.</description>
          <long-description></long-description>
          <tag name="return" description="email addresses" line="387" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules/hostObject.inc" generated-path="lib.modules.hostObject.inc.html" hash="083f59c9ea1de48c9401d778b875207a" package="modules">
    <docblock line="0">
      <description>Manages the hosts to which a user may login.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="35" package="modules">
      <extends>\baseModule</extends>
      <name>hostObject</name>
      <full_name>\hostObject</full_name>
      <docblock line="35">
        <description>Manages the hosts to which a user may login.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="35"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="42" package="modules">
        <name>__construct</name>
        <full_name>\hostObject::__construct()</full_name>
        <docblock line="42">
          <description>Creates a new hostObject object.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account type (user, group, host)&lt;/p&gt;&#10;" line="42" type="string" variable="$scope">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="55" package="modules">
        <name>get_metaData</name>
        <full_name>\hostObject::get_metaData()</full_name>
        <docblock line="55">
          <description>Returns meta data that is interpreted by parent class</description>
          <long-description></long-description>
          <tag name="return" description="array with meta data" line="55" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="55"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="102" package="modules">
        <name>load_Messages</name>
        <full_name>\hostObject::load_Messages()</full_name>
        <docblock line="102">
          <description>This function fills the error message array with messages</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="119" package="modules">
        <name>save_attributes</name>
        <full_name>\hostObject::save_attributes()</full_name>
        <docblock line="119">
          <description>Returns a list of modifications which have to be made to the LDAP account.</description>
          <long-description></long-description>
          <tag name="return" description="list of modifications&#10;&amp;lt;br&amp;gt;This function returns an array with 3 entries:&#10;&amp;lt;br&amp;gt;array( DN1 (&amp;#039;add&amp;#039; =&amp;gt; array($attr), &amp;#039;remove&amp;#039; =&amp;gt; array($attr), &amp;#039;modify&amp;#039; =&amp;gt; array($attr)), DN2 .... )&#10;&amp;lt;br&amp;gt;DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)&#10;&amp;lt;br&amp;gt;&amp;quot;add&amp;quot; are attributes which have to be added to LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;remove&amp;quot; are attributes which have to be removed from LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;modify&amp;quot; are attributes which have to been modified in LDAP entry&#10;&amp;lt;br&amp;gt;&amp;quot;info&amp;quot; are values with informational value (e.g. to be used later by pre/postModify actions)" line="119" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="132" package="modules">
        <name>display_html_attributes</name>
        <full_name>\hostObject::display_html_attributes()</full_name>
        <docblock line="132">
          <description>Returns the HTML meta data for the main account page.</description>
          <long-description></long-description>
          <tag name="return" description="HTML meta data" line="132" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="173" package="modules">
        <name>process_attributes</name>
        <full_name>\hostObject::process_attributes()</full_name>
        <docblock line="173">
          <description>Processes user input of the primary module page.</description>
          <long-description>It checks if all input values are correct and updates the associated LDAP attributes.</long-description>
          <tag name="return" description="list of info/error messages" line="173" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="224" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>\hostObject::build_uploadAccounts()</full_name>
        <docblock line="224">
          <description>In this function the LDAP account is built up.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) from user input&lt;/p&gt;&#10;" line="224" type="array" variable="$rawAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)&lt;/p&gt;&#10;" line="224" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) which are later added to LDAP&lt;/p&gt;&#10;" line="224" type="array" variable="$partialAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="224" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages if any" line="224" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rawAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$partialAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="253" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\hostObject::get_pdfEntries()</full_name>
        <docblock line="253">
          <description>Returns the PDF entries for this module.</description>
          <long-description></long-description>
          <tag name="return" description="list of possible PDF entries" line="253" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="264" package="modules">
        <name>load_profile</name>
        <full_name>\hostObject::load_profile()</full_name>
        <docblock line="264">
          <description>Loads the values of an account profile into internal variables.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;hash array with profile values (identifier =&gt; value)&lt;/p&gt;&#10;" line="264" type="array" variable="$profile">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$profile</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/xml_parser.inc" generated-path="lib.xml_parser.inc.html" hash="92aee2c4a0e0305cf0862c2389ce0a6f" package="PDF">
    <docblock line="0">
      <description>Simple XML parser.</description>
      <long-description></long-description>
      <tag name="author" description="Michael Duergner" line="0"/>
      <tag name="package" description="PDF" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="36" package="PDF">
      <extends/>
      <name>xmlParser</name>
      <full_name>\xmlParser</full_name>
      <docblock line="36">
        <description>Simple XML parser.</description>
        <long-description></long-description>
        <tag name="author" description="Michael Duergner" line="36"/>
        <tag name="package" description="PDF" line="36"/>
      </docblock>
      <property static="false" visibility="private" line="39" namespace="" package="PDF">
        <name>$xmlParser</name>
        <default></default>
        <docblock line="39">
          <description>XML parser</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="44" package="PDF">
        <name>__construct</name>
        <full_name>\xmlParser::__construct()</full_name>
        <docblock line="44">
          <description>Constructor</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="57" package="PDF">
        <name>parse</name>
        <full_name>\xmlParser::parse()</full_name>
        <docblock line="57">
          <description>Starts the parsing.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;file name&lt;/p&gt;" line="57" type="String" variable="$filename">
            <type>String</type>
          </tag>
          <tag name="return" description="XML structure" line="57" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$filename</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/baseType.inc" generated-path="lib.baseType.inc.html" hash="69ce5e350b3bc35ee96baa70e7c285f0" package="types">
    <docblock line="0">
      <description>This is the parent class of all account types.</description>
      <long-description></long-description>
      <tag name="package" description="types" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="36" package="types">
      <extends/>
      <name>baseType</name>
      <full_name>\baseType</full_name>
      <docblock line="36">
        <description>This is the parent class of all account types.</description>
        <long-description></long-description>
        <tag name="package" description="types" line="36"/>
      </docblock>
      <property static="false" visibility="public" line="39" namespace="" package="types">
        <name>$LABEL_CREATE_ANOTHER_ACCOUNT</name>
        <default></default>
        <docblock line="39">
          <description>label to create another account</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="41" namespace="" package="types">
        <name>$LABEL_BACK_TO_ACCOUNT_LIST</name>
        <default></default>
        <docblock line="41">
          <description>label to return to account list</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="46" package="types">
        <name>__construct</name>
        <full_name>\baseType::__construct()</full_name>
        <docblock line="46">
          <description>Creates a new type object.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="57" package="types">
        <name>getAlias</name>
        <full_name>\baseType::getAlias()</full_name>
        <docblock line="57">
          <description>Returns the alias name of this account type.</description>
          <long-description>This function must be overwritten by the child classes.</long-description>
          <tag name="return" description="alias name" line="57" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="67" package="types">
        <name>getDescription</name>
        <full_name>\baseType::getDescription()</full_name>
        <docblock line="67">
          <description>Returns the description of this account type.</description>
          <long-description>This function must be overwritten by the child classes.</long-description>
          <tag name="return" description="description" line="67" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="76" package="types">
        <name>getListClassName</name>
        <full_name>\baseType::getListClassName()</full_name>
        <docblock line="76">
          <description>Returns the class name for the list object.</description>
          <long-description></long-description>
          <tag name="return" description="class name" line="76" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="86" package="types">
        <name>getDefaultListAttributes</name>
        <full_name>\baseType::getDefaultListAttributes()</full_name>
        <docblock line="86">
          <description>Returns the default attribute list for this account type.</description>
          <long-description>This function must be overwritten by the child classes.</long-description>
          <tag name="return" description="attribute list" line="86" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="96" package="types">
        <name>getListAttributeDescriptions</name>
        <full_name>\baseType::getListAttributeDescriptions()</full_name>
        <docblock line="96">
          <description>Returns a list of attributes which have a translated description.</description>
          <long-description>This is used for the head row in the list view.</long-description>
          <tag name="return" description="list of descriptions" line="96" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="105" package="types">
        <name>supportsFileUpload</name>
        <full_name>\baseType::supportsFileUpload()</full_name>
        <docblock line="105">
          <description>Returns if entries of this type may be created via file upload.</description>
          <long-description></long-description>
          <tag name="return" description="true, if file upload is supported" line="105" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="115" package="types">
        <name>getTitleBarTitle</name>
        <full_name>\baseType::getTitleBarTitle()</full_name>
        <docblock line="115">
          <description>Returns the the title text for the title bar on the new/edit page.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account container&lt;/p&gt;" line="115" type="\accountContainer" variable="$container">
            <type>\accountContainer</type>
          </tag>
          <tag name="return" description="title text" line="115" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$container</name>
          <default></default>
          <type>\accountContainer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="128" package="types">
        <name>getTitleBarSubtitle</name>
        <full_name>\baseType::getTitleBarSubtitle()</full_name>
        <docblock line="128">
          <description>Returns the the title text for the title bar on the new/edit page.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account container&lt;/p&gt;" line="128" type="\accountContainer" variable="$container">
            <type>\accountContainer</type>
          </tag>
          <tag name="return" description="title text" line="128" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$container</name>
          <default></default>
          <type>\accountContainer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="137" package="types">
        <name>getSuffixList</name>
        <full_name>\baseType::getSuffixList()</full_name>
        <docblock line="137">
          <description>Returns a list of LDAP suffixes for this type.</description>
          <long-description></long-description>
          <tag name="return" description="sorted list of possible suffixes for this type." line="137" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="178" package="types">
        <name>runEditPagePostAction</name>
        <full_name>\baseType::runEditPagePostAction()</full_name>
        <docblock line="178">
          <description>This function is called after the edit page is processed and before the page content is generated.</description>
          <long-description>This can be used to run custom handlers after each page processing.</long-description>
          <tag name="param" description="&lt;p&gt;account container&lt;/p&gt;" line="178" type="\accountContainer" variable="$container">
            <type>\accountContainer</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$container</name>
          <default></default>
          <type>\accountContainer</type>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/checkEnvironment.inc" generated-path="lib.checkEnvironment.inc.html" hash="6fc114e9896c15eaef872900d117f21e" package="main">
    <docblock line="0">
      <description>Checks if the environment fits to run LAM.</description>
      <long-description>This code checks if the PHP version is ok, the required extensions are active
and the memory limit is high enough.</long-description>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="package" description="main" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="lib/pdfstruct.inc" generated-path="lib.pdfstruct.inc.html" hash="217f55914436874c1778b21f658ed9aa" package="PDF">
    <docblock line="0">
      <description>Functions to manage the PDF structures.</description>
      <long-description></long-description>
      <tag name="author" description="Michael Duergner" line="0"/>
      <tag name="package" description="PDF" line="0"/>
    </docblock>
    <function namespace="" line="49" package="PDF">
      <name>getPDFStructureDefinitions</name>
      <full_name>\getPDFStructureDefinitions()</full_name>
      <docblock line="49">
        <description>This function will return all available PDF structure definitions for the submitted
account scope.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;The account scope the PDF structure definitions should be&#10;returned.&lt;/p&gt;" line="49" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;server profile name&lt;/p&gt;" line="49" type="string" variable="$profile">
          <type>string</type>
        </tag>
        <tag name="return" description="$scope All available PDF structure definitions for the submitted account&#10;scope. Each entry is a string being the filename that may be passed to the&#10;createModulePDF() function as second argument." line="49" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$scope</name>
        <default>"user"</default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$profile</name>
        <default>null</default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="78" package="PDF">
      <name>loadPDFStructureDefinitions</name>
      <full_name>\loadPDFStructureDefinitions()</full_name>
      <docblock line="78">
        <description>This function is used to get pdf structure from xml file.</description>
        <long-description>Used in createModulePDF.</long-description>
        <tag name="param" description="&lt;p&gt;The account scope for wich the PDF structure should be returned.&lt;/p&gt;" line="78" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;Structure name of selected scope wich should be returned.&lt;/p&gt;" line="78" type="string" variable="$pdf_structure">
          <type>string</type>
        </tag>
        <tag name="return" description="PDF structure" line="78" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$scope</name>
        <default>'user'</default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$pdf_structure</name>
        <default>'default'</default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="106" package="PDF">
      <name>savePDFStructureDefinitions</name>
      <full_name>\savePDFStructureDefinitions()</full_name>
      <docblock line="106">
        <description>Saves PDF structure definitions to XML file in format: &lt;name&gt;.&lt;scope&gt;.xml</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="106" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;Name of definition&lt;/p&gt;" line="106" type="string" variable="$definition">
          <type>string</type>
        </tag>
        <tag name="return" description="&amp;quot;no perms&amp;quot; if access denied or &amp;quot;ok&amp;quot;." line="106" type="string">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$definition</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="164" package="PDF">
      <name>deletePDFStructureDefinition</name>
      <full_name>\deletePDFStructureDefinition()</full_name>
      <docblock line="164">
        <description>Deletes XML file with PDF structure definitions.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="164" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;Name of definition to delete&lt;/p&gt;" line="164" type="string" variable="$definition">
          <type>string</type>
        </tag>
        <tag name="return" description="True if file was deleted or false if a problem occured." line="164" type="boolean">
          <type>boolean</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$definition</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="182" package="PDF">
      <name>getAvailableLogos</name>
      <full_name>\getAvailableLogos()</full_name>
      <docblock line="182">
        <description>This function returns an array with all aviliable logo images.</description>
        <long-description></long-description>
        <tag name="return" description="list of logo files" line="182" type="array">
          <type>array</type>
        </tag>
      </docblock>
    </function>
    <function namespace="" line="208" package="PDF">
      <name>copyPdfProfiles</name>
      <full_name>\copyPdfProfiles()</full_name>
      <docblock line="208">
        <description>Copies PDF profiles to other server profiles.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;PDF profile names&lt;/p&gt;" line="208" type="array" variable="$pdfProfiles">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;account scope&lt;/p&gt;" line="208" type="String" variable="$scope">
          <type>String</type>
        </tag>
        <tag name="param" description="&lt;p&gt;destinations&lt;/p&gt;" line="208" type="array" variable="$dests">
          <type>array</type>
        </tag>
        <tag name="return" description="operation succeeded" line="208" type="boolean">
          <type>boolean</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$pdfProfiles</name>
        <default></default>
        <type>array</type>
      </argument>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>String</type>
      </argument>
      <argument line="0">
        <name>$dests</name>
        <default>array()</default>
        <type>array</type>
      </argument>
    </function>
    <source> </source>
  </file>
  <file path="lib/lists.inc" generated-path="lib.lists.inc.html" hash="dfb9b31c5ff002c16285d6ac8e3d38ed" package="lists">
    <docblock line="0">
      <description>This file includes functions to manage the list views.</description>
      <long-description></long-description>
      <tag name="package" description="lists" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="47" package="lists">
      <extends/>
      <name>lamList</name>
      <full_name>\lamList</full_name>
      <docblock line="47">
        <description>Generates the list view.</description>
        <long-description></long-description>
        <tag name="package" description="lists" line="47"/>
        <tag name="author" description="Roland Gruber" line="47"/>
      </docblock>
      <constant namespace="" line="98" package="lists">
        <name>LIST_SIZE_OPTION_NAME</name>
        <full_name>\lamList::LIST_SIZE_OPTION_NAME</full_name>
        <value>"L_SIZE"</value>
        <docblock line="98">
          <description>ID for list size config option</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="" line="101" package="lists">
        <name>VIRTUAL_ATTRIBUTE_PREFIX</name>
        <full_name>\lamList::VIRTUAL_ATTRIBUTE_PREFIX</full_name>
        <value>'lam_virtual_'</value>
        <docblock line="101">
          <description>prefix for virtual (non-LDAP) attributes</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <property static="false" visibility="protected" line="50" namespace="" package="lists">
        <name>$type</name>
        <default></default>
        <docblock line="50">
          <description>Account type</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="53" namespace="" package="lists">
        <name>$page</name>
        <default>1</default>
        <docblock line="53">
          <description>current page number</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="56" namespace="" package="lists">
        <name>$attrArray</name>
        <default>array()</default>
        <docblock line="56">
          <description>list of LDAP attributes</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="59" namespace="" package="lists">
        <name>$descArray</name>
        <default>array()</default>
        <docblock line="59">
          <description>list of attribute descriptions</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="62" namespace="" package="lists">
        <name>$maxPageEntries</name>
        <default>30</default>
        <docblock line="62">
          <description>maximum count of entries per page</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="65" namespace="" package="lists">
        <name>$sortColumn</name>
        <default></default>
        <docblock line="65">
          <description>sort column name</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="68" namespace="" package="lists">
        <name>$sortDirection</name>
        <default>1</default>
        <docblock line="68">
          <description>sort direction: 1 for ascending, -1 for descending</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="71" namespace="" package="lists">
        <name>$suffix</name>
        <default></default>
        <docblock line="71">
          <description>LDAP suffix</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="74" namespace="" package="lists">
        <name>$refresh</name>
        <default>true</default>
        <docblock line="74">
          <description>refresh page switch</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="77" namespace="" package="lists">
        <name>$entries</name>
        <default></default>
        <docblock line="77">
          <description>LDAP entries</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="80" namespace="" package="lists">
        <name>$sortMapping</name>
        <default></default>
        <docblock line="80">
          <description>sort mapping for entries array(original index =&gt; sorted index)</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="83" namespace="" package="lists">
        <name>$filters</name>
        <default>array()</default>
        <docblock line="83">
          <description>list of filters (attribute name =&gt; filter input)</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="86" namespace="" package="lists">
        <name>$possibleSuffixes</name>
        <default></default>
        <docblock line="86">
          <description>list of possible LDAP suffixes(organizational units)</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="89" namespace="" package="lists">
        <name>$labels</name>
        <default></default>
        <docblock line="89">
          <description>list of account specific labels</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="92" namespace="" package="lists">
        <name>$configOptions</name>
        <default></default>
        <docblock line="92">
          <description>configuration options</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="95" namespace="" package="lists">
        <name>$tabindex</name>
        <default>1</default>
        <docblock line="95">
          <description>tabindex for GUI elements</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="109" package="lists">
        <name>__construct</name>
        <full_name>\lamList::__construct()</full_name>
        <docblock line="109">
          <description>Constructor</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="109" type="string" variable="$type">
            <type>string</type>
          </tag>
          <tag name="return" description="list object" line="109" type="\lamList">
            <type>\lamList</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$type</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="123" package="lists">
        <name>listReadOptionsFromCookie</name>
        <full_name>\lamList::listReadOptionsFromCookie()</full_name>
        <docblock line="123">
          <description>Reads the list options from the cookie value.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="149" package="lists">
        <name>showPage</name>
        <full_name>\lamList::showPage()</full_name>
        <docblock line="149">
          <description>Prints the HTML code to display the list view.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="208" package="lists">
        <name>listBuildFilter</name>
        <full_name>\lamList::listBuildFilter()</full_name>
        <docblock line="208">
          <description>Builds the regular expressions from the filter values.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="242" package="lists">
        <name>listCreateSortMapping</name>
        <full_name>\lamList::listCreateSortMapping()</full_name>
        <docblock line="242">
          <description>Determines the sort mapping and stores it in $this-&gt;sortMapping.</description>
          <long-description>The sort mapping is used to display the right rows when the account table is created.</long-description>
          <tag name="param" description="&lt;p&gt;the account list&lt;/p&gt;" line="242" type="array" variable="$info">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$info</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="281" package="lists">
        <name>listDrawNavigationBar</name>
        <full_name>\lamList::listDrawNavigationBar()</full_name>
        <docblock line="281">
          <description>Draws a navigation bar to switch between pages</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;number of account entries&lt;/p&gt;" line="281" type="integer" variable="$count">
            <type>integer</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$count</name>
          <default></default>
          <type>integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="336" package="lists">
        <name>getFilterAsTextForURL</name>
        <full_name>\lamList::getFilterAsTextForURL()</full_name>
        <docblock line="336">
          <description>Returns the filter as text to be used as URL parameter.</description>
          <long-description></long-description>
          <tag name="return" description="filter text" line="336" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="347" package="lists">
        <name>listPrintTableHeader</name>
        <full_name>\lamList::listPrintTableHeader()</full_name>
        <docblock line="347">
          <description>Prints the attribute and filter row at the account table head</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="415" package="lists">
        <name>canBeFiltered</name>
        <full_name>\lamList::canBeFiltered()</full_name>
        <docblock line="415">
          <description>Returns if the given attribute can be filtered.</description>
          <long-description>If filtering is not possible then no filter box will be displayed.
By default all attributes can be filtered.</long-description>
          <tag name="param" description="&lt;p&gt;attribute name&lt;/p&gt;" line="415" type="String" variable="$attr">
            <type>String</type>
          </tag>
          <tag name="return" description="filtering possible" line="415" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attr</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="424" package="lists">
        <name>listPrintTableBody</name>
        <full_name>\lamList::listPrintTableBody()</full_name>
        <docblock line="424">
          <description>Prints the entry list</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;entries&lt;/p&gt;" line="424" type="array" variable="$info">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$info</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="480" package="lists">
        <name>listPrintToolLinks</name>
        <full_name>\lamList::listPrintToolLinks()</full_name>
        <docblock line="480">
          <description>Prints the tool image links (e.g. edit and delete) for each account.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="480" type="array" variable="$account">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;account ID&lt;/p&gt;" line="480" type="String" variable="$id">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$account</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$id</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="520" package="lists">
        <name>listPrintTableCellContent</name>
        <full_name>\lamList::listPrintTableCellContent()</full_name>
        <docblock line="520">
          <description>Prints the content of a cell in the account list for a given LDAP entry and attribute.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="520" type="array" variable="$entry">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;attribute name&lt;/p&gt;" line="520" type="string" variable="$attribute">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$entry</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="539" package="lists">
        <name>listDoPost</name>
        <full_name>\lamList::listDoPost()</full_name>
        <docblock line="539">
          <description>Manages all POST actions (e.g. button pressed) for the account lists.</description>
          <long-description></long-description>
          <tag name="return" description="HTML fragment to insert into beginning of account list" line="539" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="657" package="lists">
        <name>showPDFPage</name>
        <full_name>\lamList::showPDFPage()</full_name>
        <docblock line="657">
          <description>Shows the page where the user may select the PDF options.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account ID&lt;/p&gt;" line="657" type="String" variable="$id">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$id</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="722" package="lists">
        <name>listShowOUSelection</name>
        <full_name>\lamList::listShowOUSelection()</full_name>
        <docblock line="722">
          <description>Prints a combobox with possible sub-DNs.</description>
          <long-description></long-description>
          <tag name="return" description="OU selection (may be empty)" line="722" type="\htmlGroup">
            <type>\htmlGroup</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="746" package="lists">
        <name>listPrintButtons</name>
        <full_name>\lamList::listPrintButtons()</full_name>
        <docblock line="746">
          <description>Prints the create and delete buttons.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;true if only the create button should be displayed&lt;/p&gt;" line="746" type="boolean" variable="$createOnly">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;HTML tabindex counter&lt;/p&gt;" line="746" type="int" variable="$tabindex">
            <type>int</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$createOnly</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="801" package="lists">
        <name>addExtraInputElementsToTopArea</name>
        <full_name>\lamList::addExtraInputElementsToTopArea()</full_name>
        <docblock line="801">
          <description>Can be used by subclasses to add e.g. additional buttons to the top area.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;left part&lt;/p&gt;" line="801" type="\htmlGroup" variable="$left">
            <type>\htmlGroup</type>
          </tag>
          <tag name="param" description="&lt;p&gt;right part&lt;/p&gt;" line="801" type="\htmlGroup" variable="$right">
            <type>\htmlGroup</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$left</name>
          <default></default>
          <type>\htmlGroup</type>
        </argument>
        <argument line="0">
          <name>$right</name>
          <default></default>
          <type>\htmlGroup</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="808" package="lists">
        <name>listPrintHeader</name>
        <full_name>\lamList::listPrintHeader()</full_name>
        <docblock line="808">
          <description>Prints the HTML header.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="815" package="lists">
        <name>listPrintFooter</name>
        <full_name>\lamList::listPrintFooter()</full_name>
        <docblock line="815">
          <description>Prints the HTML footer.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="837" package="lists">
        <name>listGetAttributeDescriptionList</name>
        <full_name>\lamList::listGetAttributeDescriptionList()</full_name>
        <docblock line="837">
          <description>Returns an hash array containing with all attributes to be shown and their descriptions.</description>
          <long-description>Format: array(attribute =&gt; description)</long-description>
          <tag name="return" description="attribute list" line="837" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="872" package="lists">
        <name>listGetParams</name>
        <full_name>\lamList::listGetParams()</full_name>
        <docblock line="872">
          <description>Sets some internal parameters.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="922" package="lists">
        <name>listRefreshData</name>
        <full_name>\lamList::listRefreshData()</full_name>
        <docblock line="922">
          <description>Rereads the entries from LDAP.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="960" package="lists">
        <name>buildLDAPAttributeFilter</name>
        <full_name>\lamList::buildLDAPAttributeFilter()</full_name>
        <docblock line="960">
          <description>Builds the LDAP filter based on the filter entries in the GUI.</description>
          <long-description></long-description>
          <tag name="return" description="LDAP filter" line="960" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="972" package="lists">
        <name>forceRefresh</name>
        <full_name>\lamList::forceRefresh()</full_name>
        <docblock line="972">
          <description>Forces a refresh of the LDAP data.</description>
          <long-description>Function must be called before $this-&gt;refresh option is checked to load new LDAP data (e.g. in listGetParams).</long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="985" package="lists">
        <name>getAdditionalLDAPAttributesToRead</name>
        <full_name>\lamList::getAdditionalLDAPAttributesToRead()</full_name>
        <docblock line="985">
          <description>Returns a list of additional LDAP attributes that should be read.</description>
          <long-description>This can be used to show additional data even if the user selected other attributes to show in the list.</long-description>
          <tag name="return" description="additional attribute names" line="985" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="994" package="lists">
        <name>getAdditionalTools</name>
        <full_name>\lamList::getAdditionalTools()</full_name>
        <docblock line="994">
          <description>Returns a list of lamListTool objects to display next to the edit/delete buttons.</description>
          <long-description></long-description>
          <tag name="return" description="tools" line="994" type="\lamListTool[]">
            <type>\lamListTool[]</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1003" package="lists">
        <name>listGetAllConfigOptions</name>
        <full_name>\lamList::listGetAllConfigOptions()</full_name>
        <docblock line="1003">
          <description>Returns a list of possible configuration options.</description>
          <long-description></long-description>
          <tag name="return" description="list of lamListOption objects" line="1003" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1013" package="lists">
        <name>listPrintConfigurationPage</name>
        <full_name>\lamList::listPrintConfigurationPage()</full_name>
        <docblock line="1013">
          <description>Prints the list configuration page.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1036" package="lists">
        <name>listGetConfigOptionByID</name>
        <full_name>\lamList::listGetConfigOptionByID()</full_name>
        <docblock line="1036">
          <description>Returns the configuration option with the given ID.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;ID&lt;/p&gt;" line="1036" type="String" variable="$ID">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$ID</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1048" package="lists">
        <name>listConfigurationChanged</name>
        <full_name>\lamList::listConfigurationChanged()</full_name>
        <docblock line="1048">
          <description>Called when the configuration options changed.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1059" package="lists">
        <name>listPrintRedirectMessages</name>
        <full_name>\lamList::listPrintRedirectMessages()</full_name>
        <docblock line="1059">
          <description>Prints messages when another page (e.g. delete/upload) redirects to the list view.</description>
          <long-description></long-description>
        </docblock>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="1085" package="lists">
      <extends/>
      <name>lamListTool</name>
      <full_name>\lamListTool</full_name>
      <docblock line="1085">
        <description>Represents a tool which can be included in the account lists.</description>
        <long-description></long-description>
        <tag name="package" description="lists" line="1085"/>
        <tag name="author" description="Roland Gruber" line="1085"/>
      </docblock>
      <property static="false" visibility="private" line="1088" namespace="" package="lists">
        <name>$name</name>
        <default></default>
        <docblock line="1088">
          <description>tool name</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1090" namespace="" package="lists">
        <name>$image</name>
        <default></default>
        <docblock line="1090">
          <description>tool image</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1092" namespace="" package="lists">
        <name>$target</name>
        <default></default>
        <docblock line="1092">
          <description>link target</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1102" package="lists">
        <name>__construct</name>
        <full_name>\lamListTool::__construct()</full_name>
        <docblock line="1102">
          <description>Constructor</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;tool name&lt;/p&gt;" line="1102" type="String" variable="$name">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;image file&lt;/p&gt;" line="1102" type="String" variable="$image">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;target page&lt;/p&gt;" line="1102" type="String" variable="$target">
            <type>String</type>
          </tag>
          <tag name="return" description="tool object" line="1102" type="\lamListTool">
            <type>\lamListTool</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$image</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$target</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1114" package="lists">
        <name>getImage</name>
        <full_name>\lamListTool::getImage()</full_name>
        <docblock line="1114">
          <description>Returns the name of the tool image.</description>
          <long-description>The image is returned without path (e.g. mytool.png). All images must reside in the graphics folder.</long-description>
          <tag name="return" description="image name" line="1114" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1124" package="lists">
        <name>getName</name>
        <full_name>\lamListTool::getName()</full_name>
        <docblock line="1124">
          <description>Returns the tool name.</description>
          <long-description>This is used for the tool tip.</long-description>
          <tag name="return" description="name" line="1124" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1134" package="lists">
        <name>getLinkTarget</name>
        <full_name>\lamListTool::getLinkTarget()</full_name>
        <docblock line="1134">
          <description>Returns the PHP file (relative to 'templates/lists') which will be the target for this tool.</description>
          <long-description>The target page will be opened with two GET parameters: DN and type (e.g. user)</long-description>
          <tag name="return" description="page file (e.g. &amp;#039;mytool.php&amp;#039;)" line="1134" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
    </class>
    <class final="false" abstract="true" namespace="" line="1146" package="lists">
      <extends/>
      <name>lamListOption</name>
      <full_name>\lamListOption</full_name>
      <docblock line="1146">
        <description>Represents a list configuration option.</description>
        <long-description></long-description>
        <tag name="package" description="lists" line="1146"/>
        <tag name="author" description="Roland Gruber" line="1146"/>
      </docblock>
      <property static="false" visibility="private" line="1149" namespace="" package="lists">
        <name>$ID</name>
        <default></default>
        <docblock line="1149">
          <description>unique ID</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1151" namespace="" package="lists">
        <name>$value</name>
        <default></default>
        <docblock line="1151">
          <description>option value</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1159" package="lists">
        <name>__construct</name>
        <full_name>\lamListOption::__construct()</full_name>
        <docblock line="1159">
          <description>Creates a new config option.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;unique ID&lt;/p&gt;" line="1159" type="String" variable="$ID">
            <type>String</type>
          </tag>
          <tag name="return" description="config option" line="1159" type="\lamConfigOption">
            <type>\lamConfigOption</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$ID</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1168" package="lists">
        <name>getID</name>
        <full_name>\lamListOption::getID()</full_name>
        <docblock line="1168">
          <description>Returns the option ID.</description>
          <long-description></long-description>
          <tag name="return" description="ID" line="1168" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="true" static="false" visibility="public" namespace="" line="1177" package="lists">
        <name>fillFromPostData</name>
        <full_name>\lamListOption::fillFromPostData()</full_name>
        <docblock line="1177">
          <description>Fills the config option from POST data.</description>
          <long-description></long-description>
          <tag name="return" description="list of StatusMessages (array(&amp;lt;type&amp;gt;, &amp;lt;head line&amp;gt;, &amp;lt;body&amp;gt;))" line="1177" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1184" package="lists">
        <name>getValue</name>
        <full_name>\lamListOption::getValue()</full_name>
        <docblock line="1184">
          <description>Returns the option value. The value must not contain "=" and ";".</description>
          <long-description></long-description>
          <tag name="return" description="value" line="1184" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1193" package="lists">
        <name>setValue</name>
        <full_name>\lamListOption::setValue()</full_name>
        <docblock line="1193">
          <description>Sets the config option value. The value must not contain "=" and ";".</description>
          <long-description></long-description>
          <tag name="param" description="" line="1193" type="String" variable="$value">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$value</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="true" static="false" visibility="public" namespace="" line="1205" package="lists">
        <name>getMetaHTML</name>
        <full_name>\lamListOption::getMetaHTML()</full_name>
        <docblock line="1205">
          <description>Returns the meta HTML data to display this option.</description>
          <long-description></long-description>
          <tag name="return" description="meta HTML" line="1205" type="\htmlTable">
            <type>\htmlTable</type>
          </tag>
        </docblock>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="1215" package="lists">
      <extends>\lamListOption</extends>
      <name>lamBooleanListOption</name>
      <full_name>\lamBooleanListOption</full_name>
      <docblock line="1215">
        <description>Boolean option for list configuration.</description>
        <long-description></long-description>
        <tag name="package" description="lists" line="1215"/>
        <tag name="author" description="Roland Gruber" line="1215"/>
      </docblock>
      <property static="false" visibility="private" line="1218" namespace="" package="lists">
        <name>$name</name>
        <default></default>
        <docblock line="1218">
          <description>option name</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1227" package="lists">
        <name>__construct</name>
        <full_name>\lamBooleanListOption::__construct()</full_name>
        <docblock line="1227">
          <description>Creates a new boolean option.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;name to show on config page&lt;/p&gt;" line="1227" type="String" variable="$name">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;unique ID&lt;/p&gt;" line="1227" type="String" variable="$ID">
            <type>String</type>
          </tag>
          <tag name="return" description="config option" line="1227" type="\lamBooleanListOption">
            <type>\lamBooleanListOption</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$ID</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1237" package="lists">
        <name>isSelected</name>
        <full_name>\lamBooleanListOption::isSelected()</full_name>
        <docblock line="1237">
          <description>Returns if this option is selected.</description>
          <long-description></long-description>
          <tag name="return" description="true, if selected" line="1237" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1246" package="lists">
        <name>fillFromPostData</name>
        <full_name>\lamBooleanListOption::fillFromPostData()</full_name>
        <docblock line="1246">
          <description>Fills the config option from POST data.</description>
          <long-description></long-description>
          <tag name="return" description="list of StatusMessages (array(&amp;lt;type&amp;gt;, &amp;lt;head line&amp;gt;, &amp;lt;body&amp;gt;))" line="1246" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1260" package="lists">
        <name>getMetaHTML</name>
        <full_name>\lamBooleanListOption::getMetaHTML()</full_name>
        <docblock line="1260">
          <description>Returns the meta HTML data to display this option.</description>
          <long-description></long-description>
          <tag name="return" description="meta HTML" line="1260" type="\htmlTable">
            <type>\htmlTable</type>
          </tag>
        </docblock>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="1274" package="lists">
      <extends>\lamListOption</extends>
      <name>lamSelectListOption</name>
      <full_name>\lamSelectListOption</full_name>
      <docblock line="1274">
        <description>Boolean option for list configuration.</description>
        <long-description></long-description>
        <tag name="package" description="lists" line="1274"/>
        <tag name="author" description="Roland Gruber" line="1274"/>
      </docblock>
      <property static="false" visibility="private" line="1277" namespace="" package="lists">
        <name>$name</name>
        <default></default>
        <docblock line="1277">
          <description>option name</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1279" namespace="" package="lists">
        <name>$options</name>
        <default></default>
        <docblock line="1279">
          <description>possible select options</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1281" namespace="" package="lists">
        <name>$helpID</name>
        <default></default>
        <docblock line="1281">
          <description>help ID</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1291" package="lists">
        <name>__construct</name>
        <full_name>\lamSelectListOption::__construct()</full_name>
        <docblock line="1291">
          <description>Creates a new selection list option.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;name to show on config page&lt;/p&gt;" line="1291" type="String" variable="$name">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of possible values&lt;/p&gt;" line="1291" type="array" variable="$options">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;unique ID&lt;/p&gt;" line="1291" type="String" variable="$ID">
            <type>String</type>
          </tag>
          <tag name="return" description="config option" line="1291" type="\lamBooleanListOption">
            <type>\lamBooleanListOption</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$options</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ID</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1302" package="lists">
        <name>setHelpID</name>
        <full_name>\lamSelectListOption::setHelpID()</full_name>
        <docblock line="1302">
          <description>Sets the help ID.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;help ID&lt;/p&gt;" line="1302" type="\Strign" variable="$id">
            <type>\Strign</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$id</name>
          <default></default>
          <type>\Strign</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1311" package="lists">
        <name>fillFromPostData</name>
        <full_name>\lamSelectListOption::fillFromPostData()</full_name>
        <docblock line="1311">
          <description>Fills the config option from POST data.</description>
          <long-description></long-description>
          <tag name="return" description="list of StatusMessages (array(&amp;lt;type&amp;gt;, &amp;lt;head line&amp;gt;, &amp;lt;body&amp;gt;))" line="1311" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1325" package="lists">
        <name>getMetaHTML</name>
        <full_name>\lamSelectListOption::getMetaHTML()</full_name>
        <docblock line="1325">
          <description>Returns the meta HTML data to display this option.</description>
          <long-description></long-description>
          <tag name="return" description="meta HTML" line="1325" type="\htmlTable">
            <type>\htmlTable</type>
          </tag>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/pdf.inc" generated-path="lib.pdf.inc.html" hash="0b0f83f13e2792b4c1a065f9b37be34e" package="PDF">
    <docblock line="0">
      <description>LDAP Account Manager PDF printing library. It consists of lamPDF class,
the createModulePDF() function that may be called by other pages
and furthermore some helper functions.</description>
      <long-description></long-description>
      <tag name="author" description="Michael Duergner" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="package" description="PDF" line="0"/>
    </docblock>
    <constant namespace="" line="35" package="PDF">
      <name>LAMPDF_LINEWIDTH</name>
      <full_name>\\LAMPDF_LINEWIDTH</full_name>
      <value>190</value>
      <docblock line="35">
        <description>PDF line width</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <function namespace="" line="57" package="PDF">
      <name>createModulePDF</name>
      <full_name>\createModulePDF()</full_name>
      <docblock line="57">
        <description>This function creates the PDF output of one or more accounts.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;A numbered array containing all accounts the PDF page should&#10;be created for. The entries of the array must be AccountContainer objects.&lt;/p&gt;" line="57" type="array" variable="$accounts">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;The filename of the structure definition that should be used&#10;to create the PDF page. If not submitted the 'default.user' structure definition&#10;for the appropriate account type.&lt;/p&gt;" line="57" type="string" variable="$pdf_structure">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;returns the PDF output as String value instead of writing it to a file&lt;/p&gt;" line="57" type="" variable="$returnAsString"/>
        <tag name="return" description="PDF file name" line="57" type="String">
          <type>String</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$accounts</name>
        <default></default>
        <type>array</type>
      </argument>
      <argument line="0">
        <name>$pdf_structure</name>
        <default>"default"</default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$returnAsString</name>
        <default>false</default>
        <type>mixed</type>
      </argument>
    </function>
    <function namespace="" line="169" package="PDF">
      <name>getSectionHeadline</name>
      <full_name>\getSectionHeadline()</full_name>
      <docblock line="169">
        <description>Creates a section headline.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;section name&lt;/p&gt;" line="169" type="string" variable="$line">
          <type>string</type>
        </tag>
        <tag name="return" description="XML code for headline" line="169" type="string">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$line</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="189" package="PDF">
      <name>processLine</name>
      <full_name>\processLine()</full_name>
      <docblock line="189">
        <description>Creates the XML code for an PDF entry.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;XML code of PDF entry&lt;/p&gt;" line="189" type="string" variable="$line">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;True if this is the first column&lt;/p&gt;" line="189" type="boolean" variable="$first_td">
          <type>boolean</type>
        </tag>
        <tag name="param" description="&lt;p&gt;font name&lt;/p&gt;" line="189" type="String" variable="$fontName">
          <type>String</type>
        </tag>
        <tag name="return" description="XML codes" line="189" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$line</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$first_td</name>
        <default>true</default>
        <type>boolean</type>
      </argument>
      <argument line="0">
        <name>$fontName</name>
        <default></default>
        <type>String</type>
      </argument>
    </function>
    <function namespace="" line="265" package="PDF">
      <name>processFormatTags</name>
      <full_name>\processFormatTags()</full_name>
      <docblock line="265">
        <description>Formats the XML code.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;XML code of PDF entry&lt;/p&gt;" line="265" type="string" variable="$line">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;style commands&lt;/p&gt;" line="265" type="string" variable="$style">
          <type>string</type>
        </tag>
        <tag name="return" description="XML code" line="265" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$line</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$style</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="298" package="PDF">
      <name>processAttributes</name>
      <full_name>\processAttributes()</full_name>
      <docblock line="298">
        <description>Processes width, height and alignment attributes.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;attributes&lt;/p&gt;" line="298" type="string" variable="$attrs">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;XML code&lt;/p&gt;" line="298" type="array" variable="$return">
          <type>array</type>
        </tag>
        <tag name="return" description="XML code" line="298" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$attrs</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$return</name>
        <default>array()</default>
        <type>array</type>
      </argument>
    </function>
    <source> </source>
  </file>
  <file path="lib/3rdParty/phpseclib/PHP/Compat/Function/str_split.php" generated-path="lib.3rdParty.phpseclib.PHP.Compat.Function.str_split.html" hash="d2cbe83a5e5112f78f82679a268b124d" package="PHP_Compat">
    <docblock line="0">
      <description>Replace str_split()</description>
      <long-description></long-description>
      <tag name="category" description="PHP" line="0"/>
      <tag name="package" description="PHP_Compat" line="0"/>
      <tag name="license" description="LGPL - http://www.gnu.org/licenses/lgpl.html" line="0"/>
      <tag name="copyright" description="2004-2007 Aidan Lister &amp;lt;aidan@php.net&amp;gt;, Arpad Ray &amp;lt;arpad@php.net&amp;gt;" line="0"/>
      <tag name="link" description="http://php.net/function.str_split" line="0"/>
      <tag name="author" description="Aidan Lister &amp;lt;aidan@php.net&amp;gt;" line="0"/>
      <tag name="version" description="$Revision: 3620 $" line="0"/>
      <tag name="since" description="PHP 5" line="0"/>
      <tag name="require" description="PHP 4.0.0 (user_error)" line="0"/>
    </docblock>
    <function namespace="" line="15" package="PHP_Compat">
      <name>php_compat_str_split</name>
      <full_name>\php_compat_str_split()</full_name>
      <docblock line="15">
        <description></description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$string</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$split_length</name>
        <default>1</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="55" package="PHP_Compat">
      <name>str_split</name>
      <full_name>\str_split()</full_name>
      <docblock line="55">
        <description></description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$string</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$split_length</name>
        <default>1</default>
        <type/>
      </argument>
    </function>
    <source> </source>
  </file>
  <file path="lib/3rdParty/phpseclib/PHP/Compat/Function/bcpowmod.php" generated-path="lib.3rdParty.phpseclib.PHP.Compat.Function.bcpowmod.html" hash="2718ab9ac22e715aab512fe2a4ccee84" package="PHP_Compat">
    <docblock line="0">
      <description>Replace bcpowmod()</description>
      <long-description></long-description>
      <tag name="category" description="PHP" line="0"/>
      <tag name="package" description="PHP_Compat" line="0"/>
      <tag name="license" description="LGPL - http://www.gnu.org/licenses/lgpl.html" line="0"/>
      <tag name="copyright" description="2004-2007 Aidan Lister &amp;lt;aidan@php.net&amp;gt;, Arpad Ray &amp;lt;arpad@php.net&amp;gt;" line="0"/>
      <tag name="link" description="http://php.net/function.bcpowmod" line="0"/>
      <tag name="author" description="Sara Golemon &amp;lt;pollita@php.net&amp;gt;" line="0"/>
      <tag name="version" description="$Revision: 4105 $" line="0"/>
      <tag name="since" description="PHP 5.0.0" line="0"/>
      <tag name="require" description="PHP 4.0.0 (user_error)" line="0"/>
    </docblock>
    <function namespace="" line="18" package="PHP_Compat">
      <name>php_compat_bcpowmod</name>
      <full_name>\php_compat_bcpowmod()</full_name>
      <docblock line="18">
        <description></description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$x</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$y</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$modulus</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$scale</name>
        <default>0</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="62" package="PHP_Compat">
      <name>bcpowmod</name>
      <full_name>\bcpowmod()</full_name>
      <docblock line="62">
        <description></description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$x</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$y</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$modulus</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$scale</name>
        <default>0</default>
        <type/>
      </argument>
    </function>
    <source> </source>
  </file>
  <file path="lib/3rdParty/phpseclib/PHP/Compat/Function/array_fill.php" generated-path="lib.3rdParty.phpseclib.PHP.Compat.Function.array_fill.html" hash="0a4909a7081ee84a72df5bc450aa0f75" package="PHP_Compat">
    <docblock line="0">
      <description>Replace array_fill()</description>
      <long-description></long-description>
      <tag name="category" description="PHP" line="0"/>
      <tag name="package" description="PHP_Compat" line="0"/>
      <tag name="license" description="MIT License" line="0" link="http://www.opensource.org/licenses/mit-license.html"/>
      <tag name="copyright" description="2004-2007 Aidan Lister &amp;lt;aidan@php.net&amp;gt;, Arpad Ray &amp;lt;arpad@php.net&amp;gt;" line="0"/>
      <tag name="link" description="http://php.net/function.array_fill" line="0"/>
      <tag name="author" description="Jim Wigginton &amp;lt;terrafrost@php.net&amp;gt;" line="0"/>
      <tag name="version" description="$Revision: 4105 $" line="0"/>
      <tag name="since" description="PHP 4.2.0" line="0"/>
    </docblock>
    <function namespace="" line="17" package="PHP_Compat">
      <name>php_compat_array_fill</name>
      <full_name>\php_compat_array_fill()</full_name>
      <docblock line="17">
        <description></description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$start_index</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$num</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$value</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="37" package="PHP_Compat">
      <name>array_fill</name>
      <full_name>\array_fill()</full_name>
      <docblock line="37">
        <description></description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$start_index</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$num</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$value</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <source> </source>
  </file>
  <file path="lib/3rdParty/phpseclib/Net/SSH1.php" generated-path="lib.3rdParty.phpseclib.Net.SSH1.html" hash="754f94a0f8a09338469e4d466ec4cb25" package="Net_SSH1">
    <docblock line="0">
      <description>Pure-PHP implementation of SSHv1.</description>
      <long-description>PHP versions 4 and 5

Here's a short example of how to use this library:
&lt;code&gt;
&lt;?php
   include('Net/SSH1.php');

   $ssh = new Net_SSH1('www.domain.tld');
   if (!$ssh-&gt;login('username', 'password')) {
       exit('Login Failed');
   }

   echo $ssh-&gt;exec('ls -la');
?&gt;
&lt;/code&gt;

Here's another short example:
&lt;code&gt;
&lt;?php
   include('Net/SSH1.php');

   $ssh = new Net_SSH1('www.domain.tld');
   if (!$ssh-&gt;login('username', 'password')) {
       exit('Login Failed');
   }

   echo $ssh-&gt;read('username@username:~$');
   $ssh-&gt;write("ls -la\n");
   echo $ssh-&gt;read('username@username:~$');
?&gt;
&lt;/code&gt;

More information on the SSHv1 specification can be found by reading
{@link http://www.snailbook.com/docs/protocol-1.5.txt protocol-1.5.txt}.

LICENSE: Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.</long-description>
      <tag name="category" description="Net" line="0"/>
      <tag name="package" description="Net_SSH1" line="0"/>
      <tag name="author" description="Jim Wigginton &amp;lt;terrafrost@php.net&amp;gt;" line="0"/>
      <tag name="copyright" description="MMVII Jim Wigginton" line="0"/>
      <tag name="license" description="MIT License" line="0" link="http://www.opensource.org/licenses/mit-license.html"/>
      <tag name="version" description="$Id: SSH1.php 4506 2012-05-20 09:53:15Z gruberroland $" line="0"/>
      <tag name="link" description="http://phpseclib.sourceforge.net" line="0"/>
    </docblock>
    <constant namespace="" line="112" package="Net_SSH1">
      <name>NET_SSH1_CIPHER_NONE</name>
      <full_name>\\NET_SSH1_CIPHER_NONE</full_name>
      <value>0</value>
      <docblock line="112">
        <description>No encryption</description>
        <long-description>Not supported.</long-description>
      </docblock>
    </constant>
    <constant namespace="" line="118" package="Net_SSH1">
      <name>NET_SSH1_CIPHER_IDEA</name>
      <full_name>\\NET_SSH1_CIPHER_IDEA</full_name>
      <value>1</value>
      <docblock line="118">
        <description>IDEA in CFB mode</description>
        <long-description>Not supported.</long-description>
      </docblock>
    </constant>
    <constant namespace="" line="122" package="Net_SSH1">
      <name>NET_SSH1_CIPHER_DES</name>
      <full_name>\\NET_SSH1_CIPHER_DES</full_name>
      <value>2</value>
      <docblock line="122">
        <description>DES in CBC mode</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="128" package="Net_SSH1">
      <name>NET_SSH1_CIPHER_3DES</name>
      <full_name>\\NET_SSH1_CIPHER_3DES</full_name>
      <value>3</value>
      <docblock line="128">
        <description>Triple-DES in CBC mode</description>
        <long-description>All implementations are required to support this</long-description>
      </docblock>
    </constant>
    <constant namespace="" line="135" package="Net_SSH1">
      <name>NET_SSH1_CIPHER_BROKEN_TSS</name>
      <full_name>\\NET_SSH1_CIPHER_BROKEN_TSS</full_name>
      <value>4</value>
      <docblock line="135">
        <description>TRI's Simple Stream encryption CBC</description>
        <long-description>Not supported nor is it defined in the official SSH1 specs.  OpenSSH, however, does define it (see cipher.h),
although it doesn't use it (see cipher.c)</long-description>
      </docblock>
    </constant>
    <constant namespace="" line="158" package="Net_SSH1">
      <name>NET_SSH1_CIPHER_BLOWFISH</name>
      <full_name>\\NET_SSH1_CIPHER_BLOWFISH</full_name>
      <value>6</value>
      <docblock line="158">
        <description>Blowfish</description>
        <long-description>Not supported nor is it defined in the official SSH1 specs.  OpenSSH, however, defines it (see cipher.h) and
uses it (see cipher.c)</long-description>
      </docblock>
    </constant>
    <constant namespace="" line="170" package="Net_SSH1">
      <name>NET_SSH1_AUTH_RHOSTS</name>
      <full_name>\\NET_SSH1_AUTH_RHOSTS</full_name>
      <value>1</value>
      <docblock line="170">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="174" package="Net_SSH1">
      <name>NET_SSH1_AUTH_RSA</name>
      <full_name>\\NET_SSH1_AUTH_RSA</full_name>
      <value>2</value>
      <docblock line="174">
        <description>pure RSA authentication</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="180" package="Net_SSH1">
      <name>NET_SSH1_AUTH_PASSWORD</name>
      <full_name>\\NET_SSH1_AUTH_PASSWORD</full_name>
      <value>3</value>
      <docblock line="180">
        <description>password authentication</description>
        <long-description>This is the only method that is supported by this library.</long-description>
      </docblock>
    </constant>
    <constant namespace="" line="184" package="Net_SSH1">
      <name>NET_SSH1_AUTH_RHOSTS_RSA</name>
      <full_name>\\NET_SSH1_AUTH_RHOSTS_RSA</full_name>
      <value>4</value>
      <docblock line="184">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="193" package="Net_SSH1">
      <name>NET_SSH1_TTY_OP_END</name>
      <full_name>\\NET_SSH1_TTY_OP_END</full_name>
      <value>0</value>
      <docblock line="193">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="202" package="Net_SSH1">
      <name>NET_SSH1_RESPONSE_TYPE</name>
      <full_name>\\NET_SSH1_RESPONSE_TYPE</full_name>
      <value>1</value>
      <docblock line="202">
        <description>The Response Type</description>
        <long-description></long-description>
        <tag name="see" description="" line="202"/>
        <tag name="access" description="private" line="202"/>
      </docblock>
    </constant>
    <constant namespace="" line="210" package="Net_SSH1">
      <name>NET_SSH1_RESPONSE_DATA</name>
      <full_name>\\NET_SSH1_RESPONSE_DATA</full_name>
      <value>2</value>
      <docblock line="210">
        <description>The Response Data</description>
        <long-description></long-description>
        <tag name="see" description="" line="210"/>
        <tag name="access" description="private" line="210"/>
      </docblock>
    </constant>
    <constant namespace="" line="218" package="Net_SSH1">
      <name>NET_SSH1_MASK_CONSTRUCTOR</name>
      <full_name>\\NET_SSH1_MASK_CONSTRUCTOR</full_name>
      <value>1</value>
      <docblock line="218">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="219" package="Net_SSH1">
      <name>NET_SSH1_MASK_LOGIN</name>
      <full_name>\\NET_SSH1_MASK_LOGIN</full_name>
      <value>2</value>
      <docblock line="219">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="220" package="Net_SSH1">
      <name>NET_SSH1_MASK_SHELL</name>
      <full_name>\\NET_SSH1_MASK_SHELL</full_name>
      <value>4</value>
      <docblock line="220">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="230" package="Net_SSH1">
      <name>NET_SSH1_LOG_SIMPLE</name>
      <full_name>\\NET_SSH1_LOG_SIMPLE</full_name>
      <value>1</value>
      <docblock line="230">
        <description>Returns the message numbers</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="234" package="Net_SSH1">
      <name>NET_SSH1_LOG_COMPLEX</name>
      <full_name>\\NET_SSH1_LOG_COMPLEX</full_name>
      <value>2</value>
      <docblock line="234">
        <description>Returns the message content</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="244" package="Net_SSH1">
      <name>NET_SSH1_READ_SIMPLE</name>
      <full_name>\\NET_SSH1_READ_SIMPLE</full_name>
      <value>1</value>
      <docblock line="244">
        <description>Returns when a string matching $expect exactly is found</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="248" package="Net_SSH1">
      <name>NET_SSH1_READ_REGEX</name>
      <full_name>\\NET_SSH1_READ_REGEX</full_name>
      <value>2</value>
      <docblock line="248">
        <description>Returns when a string matching the regular expression $expect is found</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="1229" package="Net_SSH1">
      <name>$value</name>
      <full_name>\\$value</full_name>
      <value>$key</value>
      <docblock line="1229">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <class final="false" abstract="false" namespace="" line="259" package="Net_SSH1">
      <extends/>
      <name>Net_SSH1</name>
      <full_name>\Net_SSH1</full_name>
      <docblock line="259">
        <description>Pure-PHP implementation of SSHv1.</description>
        <long-description></long-description>
        <tag name="author" description="Jim Wigginton &amp;lt;terrafrost@php.net&amp;gt;" line="259"/>
        <tag name="version" description="" line="259"/>
        <tag name="access" description="public" line="259"/>
        <tag name="package" description="Net_SSH1" line="259"/>
      </docblock>
      <property static="false" visibility="public" line="266" namespace="" package="Net_SSH1">
        <name>$identifier</name>
        <default>'SSH-1.5-phpseclib'</default>
        <docblock line="266">
          <description>The SSH identifier</description>
          <long-description></long-description>
          <tag name="var" description="" line="266" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="266"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="274" namespace="" package="Net_SSH1">
        <name>$fsock</name>
        <default></default>
        <docblock line="274">
          <description>The Socket Object</description>
          <long-description></long-description>
          <tag name="var" description="" line="274" type="Object" variable="">
            <type>Object</type>
          </tag>
          <tag name="access" description="private" line="274"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="282" namespace="" package="Net_SSH1">
        <name>$crypto</name>
        <default>false</default>
        <docblock line="282">
          <description>The cryptography object</description>
          <long-description></long-description>
          <tag name="var" description="" line="282" type="Object" variable="">
            <type>Object</type>
          </tag>
          <tag name="access" description="private" line="282"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="293" namespace="" package="Net_SSH1">
        <name>$bitmap</name>
        <default>0</default>
        <docblock line="293">
          <description>Execution Bitmap</description>
          <long-description>The bits that are set represent functions that have been called already.  This is used to determine
if a requisite function has been successfully executed.  If not, an error should be thrown.</long-description>
          <tag name="var" description="" line="293" type="Integer" variable="">
            <type>Integer</type>
          </tag>
          <tag name="access" description="private" line="293"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="304" namespace="" package="Net_SSH1">
        <name>$server_key_public_exponent</name>
        <default></default>
        <docblock line="304">
          <description>The Server Key Public Exponent</description>
          <long-description>Logged for debug purposes</long-description>
          <tag name="see" description="" line="304"/>
          <tag name="var" description="" line="304" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="304"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="315" namespace="" package="Net_SSH1">
        <name>$server_key_public_modulus</name>
        <default></default>
        <docblock line="315">
          <description>The Server Key Public Modulus</description>
          <long-description>Logged for debug purposes</long-description>
          <tag name="see" description="" line="315"/>
          <tag name="var" description="" line="315" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="315"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="326" namespace="" package="Net_SSH1">
        <name>$host_key_public_exponent</name>
        <default></default>
        <docblock line="326">
          <description>The Host Key Public Exponent</description>
          <long-description>Logged for debug purposes</long-description>
          <tag name="see" description="" line="326"/>
          <tag name="var" description="" line="326" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="326"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="337" namespace="" package="Net_SSH1">
        <name>$host_key_public_modulus</name>
        <default></default>
        <docblock line="337">
          <description>The Host Key Public Modulus</description>
          <long-description>Logged for debug purposes</long-description>
          <tag name="see" description="" line="337"/>
          <tag name="var" description="" line="337" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="337"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="348" namespace="" package="Net_SSH1">
        <name>$supported_ciphers</name>
        <default>array(NET_SSH1_CIPHER_NONE =&gt; 'No encryption', NET_SSH1_CIPHER_IDEA =&gt; 'IDEA in CFB mode', NET_SSH1_CIPHER_DES =&gt; 'DES in CBC mode', NET_SSH1_CIPHER_3DES =&gt; 'Triple-DES in CBC mode', NET_SSH1_CIPHER_BROKEN_TSS =&gt; 'TRI\'s Simple Stream encryption CBC', NET_SSH1_CIPHER_RC4 =&gt; 'RC4', NET_SSH1_CIPHER_BLOWFISH =&gt; 'Blowfish')</default>
        <docblock line="348">
          <description>Supported Ciphers</description>
          <long-description>Logged for debug purposes</long-description>
          <tag name="see" description="" line="348"/>
          <tag name="var" description="" line="348" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="348"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="367" namespace="" package="Net_SSH1">
        <name>$supported_authentications</name>
        <default>array(NET_SSH1_AUTH_RHOSTS =&gt; '.rhosts or /etc/hosts.equiv', NET_SSH1_AUTH_RSA =&gt; 'pure RSA authentication', NET_SSH1_AUTH_PASSWORD =&gt; 'password authentication', NET_SSH1_AUTH_RHOSTS_RSA =&gt; '.rhosts with RSA host authentication')</default>
        <docblock line="367">
          <description>Supported Authentications</description>
          <long-description>Logged for debug purposes</long-description>
          <tag name="see" description="" line="367"/>
          <tag name="var" description="" line="367" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="367"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="381" namespace="" package="Net_SSH1">
        <name>$server_identification</name>
        <default>''</default>
        <docblock line="381">
          <description>Server Identification</description>
          <long-description></long-description>
          <tag name="see" description="" line="381"/>
          <tag name="var" description="" line="381" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="381"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="390" namespace="" package="Net_SSH1">
        <name>$protocol_flags</name>
        <default>array()</default>
        <docblock line="390">
          <description>Protocol Flags</description>
          <long-description></long-description>
          <tag name="see" description="" line="390"/>
          <tag name="var" description="" line="390" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="390"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="399" namespace="" package="Net_SSH1">
        <name>$protocol_flag_log</name>
        <default>array()</default>
        <docblock line="399">
          <description>Protocol Flag Log</description>
          <long-description></long-description>
          <tag name="see" description="" line="399"/>
          <tag name="var" description="" line="399" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="399"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="408" namespace="" package="Net_SSH1">
        <name>$message_log</name>
        <default>array()</default>
        <docblock line="408">
          <description>Message Log</description>
          <long-description></long-description>
          <tag name="see" description="" line="408"/>
          <tag name="var" description="" line="408" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="408"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="417" namespace="" package="Net_SSH1">
        <name>$interactive_buffer</name>
        <default>''</default>
        <docblock line="417">
          <description>Interactive Buffer</description>
          <long-description></long-description>
          <tag name="see" description="" line="417"/>
          <tag name="var" description="" line="417" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="417"/>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="431" package="Net_SSH1">
        <name>Net_SSH1</name>
        <full_name>\Net_SSH1::Net_SSH1()</full_name>
        <docblock line="431">
          <description>Default Constructor.</description>
          <long-description>Connects to an SSHv1 server</long-description>
          <tag name="param" description="" line="431" type="String" variable="$host">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Integer $port&lt;/p&gt;&#10;" line="431" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Integer $timeout&lt;/p&gt;&#10;" line="431" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Integer $cipher&lt;/p&gt;&#10;" line="431" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="431" type="\Net_SSH1">
            <type>\Net_SSH1</type>
          </tag>
          <tag name="access" description="public" line="431"/>
        </docblock>
        <argument line="0">
          <name>$host</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$port</name>
          <default>22</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$timeout</name>
          <default>10</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$cipher</name>
          <default>NET_SSH1_CIPHER_3DES</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="618" package="Net_SSH1">
        <name>login</name>
        <full_name>\Net_SSH1::login()</full_name>
        <docblock line="618">
          <description>Login</description>
          <long-description></long-description>
          <tag name="param" description="" line="618" type="String" variable="$username">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;String $password&lt;/p&gt;&#10;" line="618" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="618" type="Boolean">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="public" line="618"/>
        </docblock>
        <argument line="0">
          <name>$username</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$password</name>
          <default>''</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="687" package="Net_SSH1">
        <name>exec</name>
        <full_name>\Net_SSH1::exec()</full_name>
        <docblock line="687">
          <description>Executes a command on a non-interactive shell, returns the output, and quits.</description>
          <long-description>An SSH1 server will close the connection after a command has been executed on a non-interactive shell.  SSH2
servers don't, however, this isn't an SSH2 client.  The way this works, on the server, is by initiating a
shell with the -s option, as discussed in the following links:

{@link http://www.faqs.org/docs/bashman/bashref_65.html http://www.faqs.org/docs/bashman/bashref_65.html}
{@link http://www.faqs.org/docs/bashman/bashref_62.html http://www.faqs.org/docs/bashman/bashref_62.html}

To execute further commands, a new Net_SSH1 object will need to be created.

Returns false on failure and the output, otherwise.</long-description>
          <tag name="see" description="" line="687"/>
          <tag name="see" description="" line="687"/>
          <tag name="param" description="" line="687" type="String" variable="$cmd">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="687" type="mixed">
            <type>mixed</type>
          </tag>
          <tag name="access" description="public" line="687"/>
        </docblock>
        <argument line="0">
          <name>$cmd</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$block</name>
          <default>true</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="734" package="Net_SSH1">
        <name>_initShell</name>
        <full_name>\Net_SSH1::_initShell()</full_name>
        <docblock line="734">
          <description>Creates an interactive shell</description>
          <long-description></long-description>
          <tag name="see" description="" line="734"/>
          <tag name="see" description="" line="734"/>
          <tag name="return" description="" line="734" type="Boolean">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="private" line="734"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="775" package="Net_SSH1">
        <name>write</name>
        <full_name>\Net_SSH1::write()</full_name>
        <docblock line="775">
          <description>Inputs a command into an interactive shell.</description>
          <long-description></long-description>
          <tag name="see" description="" line="775"/>
          <tag name="param" description="" line="775" type="String" variable="$cmd">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="775" type="Boolean">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="public" line="775"/>
        </docblock>
        <argument line="0">
          <name>$cmd</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="792" package="Net_SSH1">
        <name>read</name>
        <full_name>\Net_SSH1::read()</full_name>
        <docblock line="792">
          <description>Returns the output of an interactive shell when there's a match for $expect</description>
          <long-description>$expect can take the form of a string literal or, if $mode == NET_SSH1_READ_REGEX,
a regular expression.</long-description>
          <tag name="see" description="" line="792"/>
          <tag name="param" description="" line="792" type="String" variable="$expect">
            <type>String</type>
          </tag>
          <tag name="param" description="" line="792" type="Integer" variable="$mode">
            <type>Integer</type>
          </tag>
          <tag name="return" description="" line="792" type="Boolean">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="public" line="792"/>
        </docblock>
        <argument line="0">
          <name>$expect</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$mode</name>
          <default>NET_SSH1_READ_SIMPLE</default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="827" package="Net_SSH1">
        <name>interactiveWrite</name>
        <full_name>\Net_SSH1::interactiveWrite()</full_name>
        <docblock line="827">
          <description>Inputs a command into an interactive shell.</description>
          <long-description></long-description>
          <tag name="see" description="" line="827"/>
          <tag name="param" description="" line="827" type="String" variable="$cmd">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="827" type="Boolean">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="public" line="827"/>
        </docblock>
        <argument line="0">
          <name>$cmd</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="862" package="Net_SSH1">
        <name>interactiveRead</name>
        <full_name>\Net_SSH1::interactiveRead()</full_name>
        <docblock line="862">
          <description>Returns the output of an interactive shell when no more output is available.</description>
          <long-description>Requires PHP 4.3.0 or later due to the use of the stream_select() function.  If you see stuff like
"00m", you're seeing ANSI escape codes.  According to
{@link http://support.microsoft.com/kb/101875 How to Enable ANSI.SYS in a Command Window}, "Windows NT
does not support ANSI escape sequences in Win32 Console applications", so if you're a Windows user,
there's not going to be much recourse.</long-description>
          <tag name="see" description="" line="862"/>
          <tag name="return" description="" line="862" type="String">
            <type>String</type>
          </tag>
          <tag name="access" description="public" line="862"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="889" package="Net_SSH1">
        <name>disconnect</name>
        <full_name>\Net_SSH1::disconnect()</full_name>
        <docblock line="889">
          <description>Disconnect</description>
          <long-description></long-description>
          <tag name="access" description="public" line="889"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="902" package="Net_SSH1">
        <name>__destruct</name>
        <full_name>\Net_SSH1::__destruct()</full_name>
        <docblock line="902">
          <description>Destructor.</description>
          <long-description>Will be called, automatically, if you're supporting just PHP5.  If you're supporting PHP4, you'll need to call
disconnect().</long-description>
          <tag name="access" description="public" line="902"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="913" package="Net_SSH1">
        <name>_disconnect</name>
        <full_name>\Net_SSH1::_disconnect()</full_name>
        <docblock line="913">
          <description>Disconnect</description>
          <long-description></long-description>
          <tag name="param" description="" line="913" type="String" variable="$msg">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="913"/>
        </docblock>
        <argument line="0">
          <name>$msg</name>
          <default>'Client Quit'</default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="946" package="Net_SSH1">
        <name>_get_binary_packet</name>
        <full_name>\Net_SSH1::_get_binary_packet()</full_name>
        <docblock line="946">
          <description>Gets Binary Packets</description>
          <long-description>See 'The Binary Packet Protocol' of protocol-1.5.txt for more info.

Also, this function could be improved upon by adding detection for the following exploit:
http://www.securiteam.com/securitynews/5LP042K3FY.html</long-description>
          <tag name="see" description="" line="946"/>
          <tag name="return" description="" line="946" type="Array">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="946"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1004" package="Net_SSH1">
        <name>_send_binary_packet</name>
        <full_name>\Net_SSH1::_send_binary_packet()</full_name>
        <docblock line="1004">
          <description>Sends Binary Packets</description>
          <long-description>Returns true on success, false on failure.</long-description>
          <tag name="see" description="" line="1004"/>
          <tag name="param" description="" line="1004" type="String" variable="$data">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="1004" type="Boolean">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="private" line="1004"/>
        </docblock>
        <argument line="0">
          <name>$data</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1056" package="Net_SSH1">
        <name>_crc</name>
        <full_name>\Net_SSH1::_crc()</full_name>
        <docblock line="1056">
          <description>Cyclic Redundancy Check (CRC)</description>
          <long-description>PHP's crc32 function is implemented slightly differently than the one that SSH v1 uses, so
we've reimplemented it. A more detailed discussion of the differences can be found after
$crc_lookup_table's initialization.</long-description>
          <tag name="see" description="" line="1056"/>
          <tag name="see" description="" line="1056"/>
          <tag name="param" description="" line="1056" type="String" variable="$data">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="1056" type="Integer">
            <type>Integer</type>
          </tag>
          <tag name="access" description="private" line="1056"/>
        </docblock>
        <argument line="0">
          <name>$data</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1153" package="Net_SSH1">
        <name>_string_shift</name>
        <full_name>\Net_SSH1::_string_shift()</full_name>
        <docblock line="1153">
          <description>String Shift</description>
          <long-description>Inspired by array_shift</long-description>
          <tag name="param" description="" line="1153" type="String" variable="$string">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Integer $index&lt;/p&gt;&#10;" line="1153" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="1153" type="String">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="1153"/>
        </docblock>
        <argument line="0">
          <name>$string</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$index</name>
          <default>1</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1173" package="Net_SSH1">
        <name>_rsa_crypt</name>
        <full_name>\Net_SSH1::_rsa_crypt()</full_name>
        <docblock line="1173">
          <description>RSA Encrypt</description>
          <long-description>Returns mod(pow($m, $e), $n), where $n should be the product of two (large) primes $p and $q and where $e
should be a number with the property that gcd($e, ($p - 1) * ($q - 1)) == 1.  Could just make anything that
calls this call modexp, instead, but I think this makes things clearer, maybe...</long-description>
          <tag name="see" description="" line="1173"/>
          <tag name="param" description="" line="1173" type="\Math_BigInteger" variable="$m">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="param" description="" line="1173" type="Array" variable="$key">
            <type>Array</type>
          </tag>
          <tag name="return" description="" line="1173" type="\Math_BigInteger">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="access" description="private" line="1173"/>
        </docblock>
        <argument line="0">
          <name>$m</name>
          <default></default>
          <type>\Math_BigInteger</type>
        </argument>
        <argument line="0">
          <name>$key</name>
          <default></default>
          <type>Array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1223" package="Net_SSH1">
        <name>_define_array</name>
        <full_name>\Net_SSH1::_define_array()</full_name>
        <docblock line="1223">
          <description>Define Array</description>
          <long-description>Takes any number of arrays whose indices are integers and whose values are strings and defines a bunch of
named constants from it, using the value as the name of the constant and the index as the value of the constant.
If any of the constants that would be defined already exists, none of the constants will be defined.</long-description>
          <tag name="param" description="" line="1223" type="Array" variable="$array">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="1223"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1245" package="Net_SSH1">
        <name>getLog</name>
        <full_name>\Net_SSH1::getLog()</full_name>
        <docblock line="1245">
          <description>Returns a log of the packets that have been sent and received.</description>
          <long-description>Returns a string if NET_SSH2_LOGGING == NET_SSH2_LOG_COMPLEX, an array if NET_SSH2_LOGGING == NET_SSH2_LOG_SIMPLE and false if !defined('NET_SSH2_LOGGING')</long-description>
          <tag name="access" description="public" line="1245"/>
          <tag name="return" description="or Array" line="1245" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1271" package="Net_SSH1">
        <name>_format_log</name>
        <full_name>\Net_SSH1::_format_log()</full_name>
        <docblock line="1271">
          <description>Formats a log for printing</description>
          <long-description></long-description>
          <tag name="param" description="" line="1271" type="Array" variable="$message_log">
            <type>Array</type>
          </tag>
          <tag name="param" description="" line="1271" type="Array" variable="$message_number_log">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="1271"/>
          <tag name="return" description="" line="1271" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$message_log</name>
          <default></default>
          <type>Array</type>
        </argument>
        <argument line="0">
          <name>$message_number_log</name>
          <default></default>
          <type>Array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1315" package="Net_SSH1">
        <name>getServerKeyPublicExponent</name>
        <full_name>\Net_SSH1::getServerKeyPublicExponent()</full_name>
        <docblock line="1315">
          <description>Return the server key public exponent</description>
          <long-description>Returns, by default, the base-10 representation.  If $raw_output is set to true, returns, instead,
the raw bytes.  This behavior is similar to PHP's md5() function.</long-description>
          <tag name="param" description="&lt;p&gt;Boolean $raw_output&lt;/p&gt;&#10;" line="1315" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="1315" type="String">
            <type>String</type>
          </tag>
          <tag name="access" description="public" line="1315"/>
        </docblock>
        <argument line="0">
          <name>$raw_output</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1330" package="Net_SSH1">
        <name>getServerKeyPublicModulus</name>
        <full_name>\Net_SSH1::getServerKeyPublicModulus()</full_name>
        <docblock line="1330">
          <description>Return the server key public modulus</description>
          <long-description>Returns, by default, the base-10 representation.  If $raw_output is set to true, returns, instead,
the raw bytes.  This behavior is similar to PHP's md5() function.</long-description>
          <tag name="param" description="&lt;p&gt;Boolean $raw_output&lt;/p&gt;&#10;" line="1330" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="1330" type="String">
            <type>String</type>
          </tag>
          <tag name="access" description="public" line="1330"/>
        </docblock>
        <argument line="0">
          <name>$raw_output</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1345" package="Net_SSH1">
        <name>getHostKeyPublicExponent</name>
        <full_name>\Net_SSH1::getHostKeyPublicExponent()</full_name>
        <docblock line="1345">
          <description>Return the host key public exponent</description>
          <long-description>Returns, by default, the base-10 representation.  If $raw_output is set to true, returns, instead,
the raw bytes.  This behavior is similar to PHP's md5() function.</long-description>
          <tag name="param" description="&lt;p&gt;Boolean $raw_output&lt;/p&gt;&#10;" line="1345" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="1345" type="String">
            <type>String</type>
          </tag>
          <tag name="access" description="public" line="1345"/>
        </docblock>
        <argument line="0">
          <name>$raw_output</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1360" package="Net_SSH1">
        <name>getHostKeyPublicModulus</name>
        <full_name>\Net_SSH1::getHostKeyPublicModulus()</full_name>
        <docblock line="1360">
          <description>Return the host key public modulus</description>
          <long-description>Returns, by default, the base-10 representation.  If $raw_output is set to true, returns, instead,
the raw bytes.  This behavior is similar to PHP's md5() function.</long-description>
          <tag name="param" description="&lt;p&gt;Boolean $raw_output&lt;/p&gt;&#10;" line="1360" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="1360" type="String">
            <type>String</type>
          </tag>
          <tag name="access" description="public" line="1360"/>
        </docblock>
        <argument line="0">
          <name>$raw_output</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1376" package="Net_SSH1">
        <name>getSupportedCiphers</name>
        <full_name>\Net_SSH1::getSupportedCiphers()</full_name>
        <docblock line="1376">
          <description>Return a list of ciphers supported by SSH1 server.</description>
          <long-description>Just because a cipher is supported by an SSH1 server doesn't mean it's supported by this library. If $raw_output
is set to true, returns, instead, an array of constants.  ie. instead of array('Triple-DES in CBC mode'), you'll
get array(NET_SSH1_CIPHER_3DES).</long-description>
          <tag name="param" description="&lt;p&gt;Boolean $raw_output&lt;/p&gt;&#10;" line="1376" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="1376" type="Array">
            <type>Array</type>
          </tag>
          <tag name="access" description="public" line="1376"/>
        </docblock>
        <argument line="0">
          <name>$raw_output</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1392" package="Net_SSH1">
        <name>getSupportedAuthentications</name>
        <full_name>\Net_SSH1::getSupportedAuthentications()</full_name>
        <docblock line="1392">
          <description>Return a list of authentications supported by SSH1 server.</description>
          <long-description>Just because a cipher is supported by an SSH1 server doesn't mean it's supported by this library. If $raw_output
is set to true, returns, instead, an array of constants.  ie. instead of array('password authentication'), you'll
get array(NET_SSH1_AUTH_PASSWORD).</long-description>
          <tag name="param" description="&lt;p&gt;Boolean $raw_output&lt;/p&gt;&#10;" line="1392" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="1392" type="Array">
            <type>Array</type>
          </tag>
          <tag name="access" description="public" line="1392"/>
        </docblock>
        <argument line="0">
          <name>$raw_output</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1403" package="Net_SSH1">
        <name>getServerIdentification</name>
        <full_name>\Net_SSH1::getServerIdentification()</full_name>
        <docblock line="1403">
          <description>Return the server identification.</description>
          <long-description></long-description>
          <tag name="return" description="" line="1403" type="String">
            <type>String</type>
          </tag>
          <tag name="access" description="public" line="1403"/>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/3rdParty/phpseclib/Net/SSH2.php" generated-path="lib.3rdParty.phpseclib.Net.SSH2.html" hash="6f13dcae07cbedc80ccb805b4603f0e9" package="Net_SSH2">
    <docblock line="0">
      <description>Pure-PHP implementation of SSHv2.</description>
      <long-description>PHP versions 4 and 5

Here are some examples of how to use this library:
&lt;code&gt;
&lt;?php
   include('Net/SSH2.php');

   $ssh = new Net_SSH2('www.domain.tld');
   if (!$ssh-&gt;login('username', 'password')) {
       exit('Login Failed');
   }

   echo $ssh-&gt;exec('pwd');
   echo $ssh-&gt;exec('ls -la');
?&gt;
&lt;/code&gt;

&lt;code&gt;
&lt;?php
   include('Crypt/RSA.php');
   include('Net/SSH2.php');

   $key = new Crypt_RSA();
   //$key-&gt;setPassword('whatever');
   $key-&gt;loadKey(file_get_contents('privatekey'));

   $ssh = new Net_SSH2('www.domain.tld');
   if (!$ssh-&gt;login('username', $key)) {
       exit('Login Failed');
   }

   echo $ssh-&gt;read('username@username:~$');
   $ssh-&gt;write("ls -la\n");
   echo $ssh-&gt;read('username@username:~$');
?&gt;
&lt;/code&gt;

LICENSE: Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.</long-description>
      <tag name="category" description="Net" line="0"/>
      <tag name="package" description="Net_SSH2" line="0"/>
      <tag name="author" description="Jim Wigginton &amp;lt;terrafrost@php.net&amp;gt;" line="0"/>
      <tag name="copyright" description="MMVII Jim Wigginton" line="0"/>
      <tag name="license" description="MIT License" line="0" link="http://www.opensource.org/licenses/mit-license.html"/>
      <tag name="version" description="$Id: SSH2.php 4119 2011-05-31 16:32:25Z gruberroland $" line="0"/>
      <tag name="link" description="http://phpseclib.sourceforge.net" line="0"/>
    </docblock>
    <constant namespace="" line="109" package="Net_SSH2">
      <name>NET_SSH2_MASK_CONSTRUCTOR</name>
      <full_name>\\NET_SSH2_MASK_CONSTRUCTOR</full_name>
      <value>1</value>
      <docblock line="109">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="110" package="Net_SSH2">
      <name>NET_SSH2_MASK_LOGIN</name>
      <full_name>\\NET_SSH2_MASK_LOGIN</full_name>
      <value>2</value>
      <docblock line="110">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="111" package="Net_SSH2">
      <name>NET_SSH2_MASK_SHELL</name>
      <full_name>\\NET_SSH2_MASK_SHELL</full_name>
      <value>4</value>
      <docblock line="111">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="130" package="Net_SSH2">
      <name>NET_SSH2_CHANNEL_EXEC</name>
      <full_name>\\NET_SSH2_CHANNEL_EXEC</full_name>
      <value>0</value>
      <docblock line="130">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="131" package="Net_SSH2">
      <name>NET_SSH2_CHANNEL_SHELL</name>
      <full_name>\\NET_SSH2_CHANNEL_SHELL</full_name>
      <value>1</value>
      <docblock line="131">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="141" package="Net_SSH2">
      <name>NET_SSH2_LOG_SIMPLE</name>
      <full_name>\\NET_SSH2_LOG_SIMPLE</full_name>
      <value>1</value>
      <docblock line="141">
        <description>Returns the message numbers</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="145" package="Net_SSH2">
      <name>NET_SSH2_LOG_COMPLEX</name>
      <full_name>\\NET_SSH2_LOG_COMPLEX</full_name>
      <value>2</value>
      <docblock line="145">
        <description>Returns the message content</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="155" package="Net_SSH2">
      <name>NET_SSH2_READ_SIMPLE</name>
      <full_name>\\NET_SSH2_READ_SIMPLE</full_name>
      <value>1</value>
      <docblock line="155">
        <description>Returns when a string matching $expect exactly is found</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="159" package="Net_SSH2">
      <name>NET_SSH2_READ_REGEX</name>
      <full_name>\\NET_SSH2_READ_REGEX</full_name>
      <value>2</value>
      <docblock line="159">
        <description>Returns when a string matching the regular expression $expect is found</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="2319" package="Net_SSH2">
      <name>$value</name>
      <full_name>\\$value</full_name>
      <value>$key</value>
      <docblock line="2319">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <class final="false" abstract="false" namespace="" line="170" package="Net_SSH2">
      <extends/>
      <name>Net_SSH2</name>
      <full_name>\Net_SSH2</full_name>
      <docblock line="170">
        <description>Pure-PHP implementation of SSHv2.</description>
        <long-description></long-description>
        <tag name="author" description="Jim Wigginton &amp;lt;terrafrost@php.net&amp;gt;" line="170"/>
        <tag name="version" description="" line="170"/>
        <tag name="access" description="public" line="170"/>
        <tag name="package" description="Net_SSH2" line="170"/>
      </docblock>
      <property static="false" visibility="public" line="177" namespace="" package="Net_SSH2">
        <name>$identifier</name>
        <default>'SSH-2.0-phpseclib_0.2'</default>
        <docblock line="177">
          <description>The SSH identifier</description>
          <long-description></long-description>
          <tag name="var" description="" line="177" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="177"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="185" namespace="" package="Net_SSH2">
        <name>$fsock</name>
        <default></default>
        <docblock line="185">
          <description>The Socket Object</description>
          <long-description></long-description>
          <tag name="var" description="" line="185" type="Object" variable="">
            <type>Object</type>
          </tag>
          <tag name="access" description="private" line="185"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="196" namespace="" package="Net_SSH2">
        <name>$bitmap</name>
        <default>0</default>
        <docblock line="196">
          <description>Execution Bitmap</description>
          <long-description>The bits that are set reprsent functions that have been called already.  This is used to determine
if a requisite function has been successfully executed.  If not, an error should be thrown.</long-description>
          <tag name="var" description="" line="196" type="Integer" variable="">
            <type>Integer</type>
          </tag>
          <tag name="access" description="private" line="196"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="206" namespace="" package="Net_SSH2">
        <name>$errors</name>
        <default>array()</default>
        <docblock line="206">
          <description>Error information</description>
          <long-description></long-description>
          <tag name="see" description="" line="206"/>
          <tag name="see" description="" line="206"/>
          <tag name="var" description="" line="206" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="206"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="215" namespace="" package="Net_SSH2">
        <name>$server_identifier</name>
        <default>''</default>
        <docblock line="215">
          <description>Server Identifier</description>
          <long-description></long-description>
          <tag name="see" description="" line="215"/>
          <tag name="var" description="" line="215" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="215"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="224" namespace="" package="Net_SSH2">
        <name>$kex_algorithms</name>
        <default></default>
        <docblock line="224">
          <description>Key Exchange Algorithms</description>
          <long-description></long-description>
          <tag name="see" description="" line="224"/>
          <tag name="var" description="" line="224" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="224"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="233" namespace="" package="Net_SSH2">
        <name>$server_host_key_algorithms</name>
        <default></default>
        <docblock line="233">
          <description>Server Host Key Algorithms</description>
          <long-description></long-description>
          <tag name="see" description="" line="233"/>
          <tag name="var" description="" line="233" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="233"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="242" namespace="" package="Net_SSH2">
        <name>$encryption_algorithms_client_to_server</name>
        <default></default>
        <docblock line="242">
          <description>Encryption Algorithms: Client to Server</description>
          <long-description></long-description>
          <tag name="see" description="" line="242"/>
          <tag name="var" description="" line="242" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="242"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="251" namespace="" package="Net_SSH2">
        <name>$encryption_algorithms_server_to_client</name>
        <default></default>
        <docblock line="251">
          <description>Encryption Algorithms: Server to Client</description>
          <long-description></long-description>
          <tag name="see" description="" line="251"/>
          <tag name="var" description="" line="251" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="251"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="260" namespace="" package="Net_SSH2">
        <name>$mac_algorithms_client_to_server</name>
        <default></default>
        <docblock line="260">
          <description>MAC Algorithms: Client to Server</description>
          <long-description></long-description>
          <tag name="see" description="" line="260"/>
          <tag name="var" description="" line="260" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="260"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="269" namespace="" package="Net_SSH2">
        <name>$mac_algorithms_server_to_client</name>
        <default></default>
        <docblock line="269">
          <description>MAC Algorithms: Server to Client</description>
          <long-description></long-description>
          <tag name="see" description="" line="269"/>
          <tag name="var" description="" line="269" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="269"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="278" namespace="" package="Net_SSH2">
        <name>$compression_algorithms_client_to_server</name>
        <default></default>
        <docblock line="278">
          <description>Compression Algorithms: Client to Server</description>
          <long-description></long-description>
          <tag name="see" description="" line="278"/>
          <tag name="var" description="" line="278" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="278"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="287" namespace="" package="Net_SSH2">
        <name>$compression_algorithms_server_to_client</name>
        <default></default>
        <docblock line="287">
          <description>Compression Algorithms: Server to Client</description>
          <long-description></long-description>
          <tag name="see" description="" line="287"/>
          <tag name="var" description="" line="287" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="287"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="296" namespace="" package="Net_SSH2">
        <name>$languages_server_to_client</name>
        <default></default>
        <docblock line="296">
          <description>Languages: Server to Client</description>
          <long-description></long-description>
          <tag name="see" description="" line="296"/>
          <tag name="var" description="" line="296" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="296"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="305" namespace="" package="Net_SSH2">
        <name>$languages_client_to_server</name>
        <default></default>
        <docblock line="305">
          <description>Languages: Client to Server</description>
          <long-description></long-description>
          <tag name="see" description="" line="305"/>
          <tag name="var" description="" line="305" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="305"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="322" namespace="" package="Net_SSH2">
        <name>$encrypt_block_size</name>
        <default>8</default>
        <docblock line="322">
          <description>Block Size for Server to Client Encryption</description>
          <long-description>"Note that the length of the concatenation of 'packet_length',
 'padding_length', 'payload', and 'random padding' MUST be a multiple
 of the cipher block size or 8, whichever is larger.  This constraint
 MUST be enforced, even when using stream ciphers."

 -- http://tools.ietf.org/html/rfc4253#section-6</long-description>
          <tag name="see" description="" line="322"/>
          <tag name="see" description="" line="322"/>
          <tag name="var" description="" line="322" type="Integer" variable="">
            <type>Integer</type>
          </tag>
          <tag name="access" description="private" line="322"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="332" namespace="" package="Net_SSH2">
        <name>$decrypt_block_size</name>
        <default>8</default>
        <docblock line="332">
          <description>Block Size for Client to Server Encryption</description>
          <long-description></long-description>
          <tag name="see" description="" line="332"/>
          <tag name="see" description="" line="332"/>
          <tag name="var" description="" line="332" type="Integer" variable="">
            <type>Integer</type>
          </tag>
          <tag name="access" description="private" line="332"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="341" namespace="" package="Net_SSH2">
        <name>$decrypt</name>
        <default>false</default>
        <docblock line="341">
          <description>Server to Client Encryption Object</description>
          <long-description></long-description>
          <tag name="see" description="" line="341"/>
          <tag name="var" description="" line="341" type="Object" variable="">
            <type>Object</type>
          </tag>
          <tag name="access" description="private" line="341"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="350" namespace="" package="Net_SSH2">
        <name>$encrypt</name>
        <default>false</default>
        <docblock line="350">
          <description>Client to Server Encryption Object</description>
          <long-description></long-description>
          <tag name="see" description="" line="350"/>
          <tag name="var" description="" line="350" type="Object" variable="">
            <type>Object</type>
          </tag>
          <tag name="access" description="private" line="350"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="359" namespace="" package="Net_SSH2">
        <name>$hmac_create</name>
        <default>false</default>
        <docblock line="359">
          <description>Client to Server HMAC Object</description>
          <long-description></long-description>
          <tag name="see" description="" line="359"/>
          <tag name="var" description="" line="359" type="Object" variable="">
            <type>Object</type>
          </tag>
          <tag name="access" description="private" line="359"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="368" namespace="" package="Net_SSH2">
        <name>$hmac_check</name>
        <default>false</default>
        <docblock line="368">
          <description>Server to Client HMAC Object</description>
          <long-description></long-description>
          <tag name="see" description="" line="368"/>
          <tag name="var" description="" line="368" type="Object" variable="">
            <type>Object</type>
          </tag>
          <tag name="access" description="private" line="368"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="381" namespace="" package="Net_SSH2">
        <name>$hmac_size</name>
        <default>false</default>
        <docblock line="381">
          <description>Size of server to client HMAC</description>
          <long-description>We need to know how big the HMAC will be for the server to client direction so that we know how many bytes to read.
For the client to server side, the HMAC object will make the HMAC as long as it needs to be.  All we need to do is
append it.</long-description>
          <tag name="see" description="" line="381"/>
          <tag name="var" description="" line="381" type="Integer" variable="">
            <type>Integer</type>
          </tag>
          <tag name="access" description="private" line="381"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="390" namespace="" package="Net_SSH2">
        <name>$server_public_host_key</name>
        <default></default>
        <docblock line="390">
          <description>Server Public Host Key</description>
          <long-description></long-description>
          <tag name="see" description="" line="390"/>
          <tag name="var" description="" line="390" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="390"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="405" namespace="" package="Net_SSH2">
        <name>$session_id</name>
        <default>false</default>
        <docblock line="405">
          <description>Session identifer</description>
          <long-description>"The exchange hash H from the first key exchange is additionally
 used as the session identifier, which is a unique identifier for
 this connection."

 -- http://tools.ietf.org/html/rfc4253#section-7.2</long-description>
          <tag name="see" description="" line="405"/>
          <tag name="var" description="" line="405" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="405"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="416" namespace="" package="Net_SSH2">
        <name>$exchange_hash</name>
        <default>false</default>
        <docblock line="416">
          <description>Exchange hash</description>
          <long-description>The current exchange hash</long-description>
          <tag name="see" description="" line="416"/>
          <tag name="var" description="" line="416" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="416"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="425" namespace="" package="Net_SSH2">
        <name>$message_numbers</name>
        <default>array()</default>
        <docblock line="425">
          <description>Message Numbers</description>
          <long-description></long-description>
          <tag name="see" description="" line="425"/>
          <tag name="var" description="" line="425" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="425"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="434" namespace="" package="Net_SSH2">
        <name>$disconnect_reasons</name>
        <default>array()</default>
        <docblock line="434">
          <description>Disconnection Message 'reason codes' defined in RFC4253</description>
          <long-description></long-description>
          <tag name="see" description="" line="434"/>
          <tag name="var" description="" line="434" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="434"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="443" namespace="" package="Net_SSH2">
        <name>$channel_open_failure_reasons</name>
        <default>array()</default>
        <docblock line="443">
          <description>SSH_MSG_CHANNEL_OPEN_FAILURE 'reason codes', defined in RFC4254</description>
          <long-description></long-description>
          <tag name="see" description="" line="443"/>
          <tag name="var" description="" line="443" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="443"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="453" namespace="" package="Net_SSH2">
        <name>$terminal_modes</name>
        <default>array()</default>
        <docblock line="453">
          <description>Terminal Modes</description>
          <long-description></long-description>
          <tag name="link" description="http://tools.ietf.org/html/rfc4254#section-8" line="453"/>
          <tag name="see" description="" line="453"/>
          <tag name="var" description="" line="453" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="453"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="463" namespace="" package="Net_SSH2">
        <name>$channel_extended_data_type_codes</name>
        <default>array()</default>
        <docblock line="463">
          <description>SSH_MSG_CHANNEL_EXTENDED_DATA's data_type_codes</description>
          <long-description></long-description>
          <tag name="link" description="http://tools.ietf.org/html/rfc4254#section-5.2" line="463"/>
          <tag name="see" description="" line="463"/>
          <tag name="var" description="" line="463" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="463"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="474" namespace="" package="Net_SSH2">
        <name>$send_seq_no</name>
        <default>0</default>
        <docblock line="474">
          <description>Send Sequence Number</description>
          <long-description>See 'Section 6.4.  Data Integrity' of rfc4253 for more info.</long-description>
          <tag name="see" description="" line="474"/>
          <tag name="var" description="" line="474" type="Integer" variable="">
            <type>Integer</type>
          </tag>
          <tag name="access" description="private" line="474"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="485" namespace="" package="Net_SSH2">
        <name>$get_seq_no</name>
        <default>0</default>
        <docblock line="485">
          <description>Get Sequence Number</description>
          <long-description>See 'Section 6.4.  Data Integrity' of rfc4253 for more info.</long-description>
          <tag name="see" description="" line="485"/>
          <tag name="var" description="" line="485" type="Integer" variable="">
            <type>Integer</type>
          </tag>
          <tag name="access" description="private" line="485"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="497" namespace="" package="Net_SSH2">
        <name>$server_channels</name>
        <default>array()</default>
        <docblock line="497">
          <description>Server Channels</description>
          <long-description>Maps client channels to server channels</long-description>
          <tag name="see" description="" line="497"/>
          <tag name="see" description="" line="497"/>
          <tag name="var" description="" line="497" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="497"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="510" namespace="" package="Net_SSH2">
        <name>$channel_buffers</name>
        <default>array()</default>
        <docblock line="510">
          <description>Channel Buffers</description>
          <long-description>If a client requests a packet from one channel but receives two packets from another those packets should
be placed in a buffer</long-description>
          <tag name="see" description="" line="510"/>
          <tag name="see" description="" line="510"/>
          <tag name="var" description="" line="510" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="510"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="521" namespace="" package="Net_SSH2">
        <name>$channel_status</name>
        <default>array()</default>
        <docblock line="521">
          <description>Channel Status</description>
          <long-description>Contains the type of the last sent message</long-description>
          <tag name="see" description="" line="521"/>
          <tag name="var" description="" line="521" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="521"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="532" namespace="" package="Net_SSH2">
        <name>$packet_size_client_to_server</name>
        <default>array()</default>
        <docblock line="532">
          <description>Packet Size</description>
          <long-description>Maximum packet size indexed by channel</long-description>
          <tag name="see" description="" line="532"/>
          <tag name="var" description="" line="532" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="532"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="541" namespace="" package="Net_SSH2">
        <name>$message_number_log</name>
        <default>array()</default>
        <docblock line="541">
          <description>Message Number Log</description>
          <long-description></long-description>
          <tag name="see" description="" line="541"/>
          <tag name="var" description="" line="541" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="541"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="550" namespace="" package="Net_SSH2">
        <name>$message_log</name>
        <default>array()</default>
        <docblock line="550">
          <description>Message Log</description>
          <long-description></long-description>
          <tag name="see" description="" line="550"/>
          <tag name="var" description="" line="550" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="550"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="562" namespace="" package="Net_SSH2">
        <name>$window_size</name>
        <default>2147483647</default>
        <docblock line="562">
          <description>The Window Size</description>
          <long-description>Bytes the other party can send before it must wait for the window to be adjusted (0x7FFFFFFF = 4GB)</long-description>
          <tag name="var" description="" line="562" type="Integer" variable="">
            <type>Integer</type>
          </tag>
          <tag name="see" description="" line="562"/>
          <tag name="see" description="" line="562"/>
          <tag name="access" description="private" line="562"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="573" namespace="" package="Net_SSH2">
        <name>$window_size_client_to_server</name>
        <default>array()</default>
        <docblock line="573">
          <description>Window size</description>
          <long-description>Window size indexed by channel</long-description>
          <tag name="see" description="" line="573"/>
          <tag name="var" description="" line="573" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="573"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="584" namespace="" package="Net_SSH2">
        <name>$signature</name>
        <default>''</default>
        <docblock line="584">
          <description>Server signature</description>
          <long-description>Verified against $this-&gt;session_id</long-description>
          <tag name="see" description="" line="584"/>
          <tag name="var" description="" line="584" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="584"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="595" namespace="" package="Net_SSH2">
        <name>$signature_format</name>
        <default>''</default>
        <docblock line="595">
          <description>Server signature format</description>
          <long-description>ssh-rsa or ssh-dss.</long-description>
          <tag name="see" description="" line="595"/>
          <tag name="var" description="" line="595" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="595"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="604" namespace="" package="Net_SSH2">
        <name>$interactiveBuffer</name>
        <default>''</default>
        <docblock line="604">
          <description>Interactive Buffer</description>
          <long-description></long-description>
          <tag name="see" description="" line="604"/>
          <tag name="var" description="" line="604" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="604"/>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="617" package="Net_SSH2">
        <name>Net_SSH2</name>
        <full_name>\Net_SSH2::Net_SSH2()</full_name>
        <docblock line="617">
          <description>Default Constructor.</description>
          <long-description>Connects to an SSHv2 server</long-description>
          <tag name="param" description="" line="617" type="String" variable="$host">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Integer $port&lt;/p&gt;&#10;" line="617" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Integer $timeout&lt;/p&gt;&#10;" line="617" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="617" type="\Net_SSH2">
            <type>\Net_SSH2</type>
          </tag>
          <tag name="access" description="public" line="617"/>
        </docblock>
        <argument line="0">
          <name>$host</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$port</name>
          <default>22</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$timeout</name>
          <default>10</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="777" package="Net_SSH2">
        <name>_key_exchange</name>
        <full_name>\Net_SSH2::_key_exchange()</full_name>
        <docblock line="777">
          <description>Key Exchange</description>
          <long-description></long-description>
          <tag name="param" description="" line="777" type="String" variable="$kexinit_payload_server">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="777"/>
        </docblock>
        <argument line="0">
          <name>$kexinit_payload_server</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1407" package="Net_SSH2">
        <name>_keyboard_interactive_login</name>
        <full_name>\Net_SSH2::_keyboard_interactive_login()</full_name>
        <docblock line="1407">
          <description>Login via keyboard-interactive authentication</description>
          <long-description>See {@link http://tools.ietf.org/html/rfc4256 RFC4256} for details.  This is not a full-featured keyboard-interactive authenticator.</long-description>
          <tag name="param" description="" line="1407" type="String" variable="$username">
            <type>String</type>
          </tag>
          <tag name="param" description="" line="1407" type="String" variable="$password">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="1407" type="Boolean">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="private" line="1407"/>
        </docblock>
        <argument line="0">
          <name>$username</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$password</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1428" package="Net_SSH2">
        <name>_keyboard_interactive_process</name>
        <full_name>\Net_SSH2::_keyboard_interactive_process()</full_name>
        <docblock line="1428">
          <description>Handle the keyboard-interactive requests / responses.</description>
          <long-description></long-description>
          <tag name="param" description="" line="1428" type="String" variable="$responses...">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="1428" type="Boolean">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="private" line="1428"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1611" package="Net_SSH2">
        <name>exec</name>
        <full_name>\Net_SSH2::exec()</full_name>
        <docblock line="1611">
          <description>Execute Command</description>
          <long-description>If $block is set to false then Net_SSH2::_get_channel_packet(NET_SSH2_CHANNEL_EXEC) will need to be called manually.
In all likelihood, this is not a feature you want to be taking advantage of.</long-description>
          <tag name="param" description="" line="1611" type="String" variable="$command">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Boolean $block&lt;/p&gt;&#10;" line="1611" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="1611" type="String">
            <type>String</type>
          </tag>
          <tag name="access" description="public" line="1611"/>
        </docblock>
        <argument line="0">
          <name>$command</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$block</name>
          <default>true</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1690" package="Net_SSH2">
        <name>_initShell</name>
        <full_name>\Net_SSH2::_initShell()</full_name>
        <docblock line="1690">
          <description>Creates an interactive shell</description>
          <long-description></long-description>
          <tag name="see" description="" line="1690"/>
          <tag name="see" description="" line="1690"/>
          <tag name="return" description="" line="1690" type="Boolean">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="private" line="1690"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1768" package="Net_SSH2">
        <name>read</name>
        <full_name>\Net_SSH2::read()</full_name>
        <docblock line="1768">
          <description>Returns the output of an interactive shell</description>
          <long-description>Returns when there's a match for $expect, which can take the form of a string literal or,
if $mode == NET_SSH2_READ_REGEX, a regular expression.</long-description>
          <tag name="see" description="" line="1768"/>
          <tag name="param" description="" line="1768" type="String" variable="$expect">
            <type>String</type>
          </tag>
          <tag name="param" description="" line="1768" type="Integer" variable="$mode">
            <type>Integer</type>
          </tag>
          <tag name="return" description="" line="1768" type="String">
            <type>String</type>
          </tag>
          <tag name="access" description="public" line="1768"/>
        </docblock>
        <argument line="0">
          <name>$expect</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$mode</name>
          <default>NET_SSH2_READ_SIMPLE</default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1804" package="Net_SSH2">
        <name>write</name>
        <full_name>\Net_SSH2::write()</full_name>
        <docblock line="1804">
          <description>Inputs a command into an interactive shell.</description>
          <long-description></long-description>
          <tag name="see" description="" line="1804"/>
          <tag name="param" description="" line="1804" type="String" variable="$cmd">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="1804" type="Boolean">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="public" line="1804"/>
        </docblock>
        <argument line="0">
          <name>$cmd</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1824" package="Net_SSH2">
        <name>disconnect</name>
        <full_name>\Net_SSH2::disconnect()</full_name>
        <docblock line="1824">
          <description>Disconnect</description>
          <long-description></long-description>
          <tag name="access" description="public" line="1824"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1837" package="Net_SSH2">
        <name>__destruct</name>
        <full_name>\Net_SSH2::__destruct()</full_name>
        <docblock line="1837">
          <description>Destructor.</description>
          <long-description>Will be called, automatically, if you're supporting just PHP5.  If you're supporting PHP4, you'll need to call
disconnect().</long-description>
          <tag name="access" description="public" line="1837"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1851" package="Net_SSH2">
        <name>_get_binary_packet</name>
        <full_name>\Net_SSH2::_get_binary_packet()</full_name>
        <docblock line="1851">
          <description>Gets Binary Packets</description>
          <long-description>See '6. Binary Packet Protocol' of rfc4253 for more info.</long-description>
          <tag name="see" description="" line="1851"/>
          <tag name="return" description="" line="1851" type="String">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="1851"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1922" package="Net_SSH2">
        <name>_filter</name>
        <full_name>\Net_SSH2::_filter()</full_name>
        <docblock line="1922">
          <description>Filter Binary Packets</description>
          <long-description>Because some binary packets need to be ignored...</long-description>
          <tag name="see" description="" line="1922"/>
          <tag name="return" description="" line="1922" type="String">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="1922"/>
        </docblock>
        <argument line="0">
          <name>$payload</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2008" package="Net_SSH2">
        <name>_get_channel_packet</name>
        <full_name>\Net_SSH2::_get_channel_packet()</full_name>
        <docblock line="2008">
          <description>Gets channel data</description>
          <long-description>Returns the data as a string if it's available and false if not.</long-description>
          <tag name="param" description="" line="2008" type="" variable="$client_channel"/>
          <tag name="return" description="" line="2008" type="Mixed">
            <type>Mixed</type>
          </tag>
          <tag name="access" description="private" line="2008"/>
        </docblock>
        <argument line="0">
          <name>$client_channel</name>
          <default></default>
          <type>mixed</type>
        </argument>
        <argument line="0">
          <name>$skip_extended</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2138" package="Net_SSH2">
        <name>_send_binary_packet</name>
        <full_name>\Net_SSH2::_send_binary_packet()</full_name>
        <docblock line="2138">
          <description>Sends Binary Packets</description>
          <long-description>See '6. Binary Packet Protocol' of rfc4253 for more info.</long-description>
          <tag name="param" description="" line="2138" type="String" variable="$data">
            <type>String</type>
          </tag>
          <tag name="see" description="" line="2138"/>
          <tag name="return" description="" line="2138" type="Boolean">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="private" line="2138"/>
        </docblock>
        <argument line="0">
          <name>$data</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2201" package="Net_SSH2">
        <name>_send_channel_packet</name>
        <full_name>\Net_SSH2::_send_channel_packet()</full_name>
        <docblock line="2201">
          <description>Sends channel data</description>
          <long-description>Spans multiple SSH_MSG_CHANNEL_DATAs if appropriate</long-description>
          <tag name="param" description="" line="2201" type="Integer" variable="$client_channel">
            <type>Integer</type>
          </tag>
          <tag name="param" description="" line="2201" type="String" variable="$data">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="2201" type="Boolean">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="private" line="2201"/>
        </docblock>
        <argument line="0">
          <name>$client_channel</name>
          <default></default>
          <type>Integer</type>
        </argument>
        <argument line="0">
          <name>$data</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2254" package="Net_SSH2">
        <name>_close_channel</name>
        <full_name>\Net_SSH2::_close_channel()</full_name>
        <docblock line="2254">
          <description>Closes and flushes a channel</description>
          <long-description>Net_SSH2 doesn't properly close most channels.  For exec() channels are normally closed by the server
and for SFTP channels are presumably closed when the client disconnects.  This functions is intended
for SCP more than anything.</long-description>
          <tag name="param" description="" line="2254" type="Integer" variable="$client_channel">
            <type>Integer</type>
          </tag>
          <tag name="return" description="" line="2254" type="Boolean">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="private" line="2254"/>
        </docblock>
        <argument line="0">
          <name>$client_channel</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2275" package="Net_SSH2">
        <name>_disconnect</name>
        <full_name>\Net_SSH2::_disconnect()</full_name>
        <docblock line="2275">
          <description>Disconnect</description>
          <long-description></long-description>
          <tag name="param" description="" line="2275" type="Integer" variable="$reason">
            <type>Integer</type>
          </tag>
          <tag name="return" description="" line="2275" type="Boolean">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="private" line="2275"/>
        </docblock>
        <argument line="0">
          <name>$reason</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2296" package="Net_SSH2">
        <name>_string_shift</name>
        <full_name>\Net_SSH2::_string_shift()</full_name>
        <docblock line="2296">
          <description>String Shift</description>
          <long-description>Inspired by array_shift</long-description>
          <tag name="param" description="" line="2296" type="String" variable="$string">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Integer $index&lt;/p&gt;&#10;" line="2296" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="2296" type="String">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="2296"/>
        </docblock>
        <argument line="0">
          <name>$string</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$index</name>
          <default>1</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2313" package="Net_SSH2">
        <name>_define_array</name>
        <full_name>\Net_SSH2::_define_array()</full_name>
        <docblock line="2313">
          <description>Define Array</description>
          <long-description>Takes any number of arrays whose indices are integers and whose values are strings and defines a bunch of
named constants from it, using the value as the name of the constant and the index as the value of the constant.
If any of the constants that would be defined already exists, none of the constants will be defined.</long-description>
          <tag name="param" description="" line="2313" type="Array" variable="$array">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="2313"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2335" package="Net_SSH2">
        <name>getLog</name>
        <full_name>\Net_SSH2::getLog()</full_name>
        <docblock line="2335">
          <description>Returns a log of the packets that have been sent and received.</description>
          <long-description>Returns a string if NET_SSH2_LOGGING == NET_SSH2_LOG_COMPLEX, an array if NET_SSH2_LOGGING == NET_SSH2_LOG_SIMPLE and false if !defined('NET_SSH2_LOGGING')</long-description>
          <tag name="access" description="public" line="2335"/>
          <tag name="return" description="or Array" line="2335" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2361" package="Net_SSH2">
        <name>_format_log</name>
        <full_name>\Net_SSH2::_format_log()</full_name>
        <docblock line="2361">
          <description>Formats a log for printing</description>
          <long-description></long-description>
          <tag name="param" description="" line="2361" type="Array" variable="$message_log">
            <type>Array</type>
          </tag>
          <tag name="param" description="" line="2361" type="Array" variable="$message_number_log">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="2361"/>
          <tag name="return" description="" line="2361" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$message_log</name>
          <default></default>
          <type>Array</type>
        </argument>
        <argument line="0">
          <name>$message_number_log</name>
          <default></default>
          <type>Array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2401" package="Net_SSH2">
        <name>getErrors</name>
        <full_name>\Net_SSH2::getErrors()</full_name>
        <docblock line="2401">
          <description>Returns all errors</description>
          <long-description></long-description>
          <tag name="return" description="" line="2401" type="String">
            <type>String</type>
          </tag>
          <tag name="access" description="public" line="2401"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2412" package="Net_SSH2">
        <name>getLastError</name>
        <full_name>\Net_SSH2::getLastError()</full_name>
        <docblock line="2412">
          <description>Returns the last error</description>
          <long-description></long-description>
          <tag name="return" description="" line="2412" type="String">
            <type>String</type>
          </tag>
          <tag name="access" description="public" line="2412"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2423" package="Net_SSH2">
        <name>getServerIdentification</name>
        <full_name>\Net_SSH2::getServerIdentification()</full_name>
        <docblock line="2423">
          <description>Return the server identification.</description>
          <long-description></long-description>
          <tag name="return" description="" line="2423" type="String">
            <type>String</type>
          </tag>
          <tag name="access" description="public" line="2423"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2434" package="Net_SSH2">
        <name>getKexAlgorithms</name>
        <full_name>\Net_SSH2::getKexAlgorithms()</full_name>
        <docblock line="2434">
          <description>Return a list of the key exchange algorithms the server supports.</description>
          <long-description></long-description>
          <tag name="return" description="" line="2434" type="Array">
            <type>Array</type>
          </tag>
          <tag name="access" description="public" line="2434"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2445" package="Net_SSH2">
        <name>getServerHostKeyAlgorithms</name>
        <full_name>\Net_SSH2::getServerHostKeyAlgorithms()</full_name>
        <docblock line="2445">
          <description>Return a list of the host key (public key) algorithms the server supports.</description>
          <long-description></long-description>
          <tag name="return" description="" line="2445" type="Array">
            <type>Array</type>
          </tag>
          <tag name="access" description="public" line="2445"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2456" package="Net_SSH2">
        <name>getEncryptionAlgorithmsClient2Server</name>
        <full_name>\Net_SSH2::getEncryptionAlgorithmsClient2Server()</full_name>
        <docblock line="2456">
          <description>Return a list of the (symmetric key) encryption algorithms the server supports, when receiving stuff from the client.</description>
          <long-description></long-description>
          <tag name="return" description="" line="2456" type="Array">
            <type>Array</type>
          </tag>
          <tag name="access" description="public" line="2456"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2467" package="Net_SSH2">
        <name>getEncryptionAlgorithmsServer2Client</name>
        <full_name>\Net_SSH2::getEncryptionAlgorithmsServer2Client()</full_name>
        <docblock line="2467">
          <description>Return a list of the (symmetric key) encryption algorithms the server supports, when sending stuff to the client.</description>
          <long-description></long-description>
          <tag name="return" description="" line="2467" type="Array">
            <type>Array</type>
          </tag>
          <tag name="access" description="public" line="2467"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2478" package="Net_SSH2">
        <name>getMACAlgorithmsClient2Server</name>
        <full_name>\Net_SSH2::getMACAlgorithmsClient2Server()</full_name>
        <docblock line="2478">
          <description>Return a list of the MAC algorithms the server supports, when receiving stuff from the client.</description>
          <long-description></long-description>
          <tag name="return" description="" line="2478" type="Array">
            <type>Array</type>
          </tag>
          <tag name="access" description="public" line="2478"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2489" package="Net_SSH2">
        <name>getMACAlgorithmsServer2Client</name>
        <full_name>\Net_SSH2::getMACAlgorithmsServer2Client()</full_name>
        <docblock line="2489">
          <description>Return a list of the MAC algorithms the server supports, when sending stuff to the client.</description>
          <long-description></long-description>
          <tag name="return" description="" line="2489" type="Array">
            <type>Array</type>
          </tag>
          <tag name="access" description="public" line="2489"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2500" package="Net_SSH2">
        <name>getCompressionAlgorithmsClient2Server</name>
        <full_name>\Net_SSH2::getCompressionAlgorithmsClient2Server()</full_name>
        <docblock line="2500">
          <description>Return a list of the compression algorithms the server supports, when receiving stuff from the client.</description>
          <long-description></long-description>
          <tag name="return" description="" line="2500" type="Array">
            <type>Array</type>
          </tag>
          <tag name="access" description="public" line="2500"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2511" package="Net_SSH2">
        <name>getCompressionAlgorithmsServer2Client</name>
        <full_name>\Net_SSH2::getCompressionAlgorithmsServer2Client()</full_name>
        <docblock line="2511">
          <description>Return a list of the compression algorithms the server supports, when sending stuff to the client.</description>
          <long-description></long-description>
          <tag name="return" description="" line="2511" type="Array">
            <type>Array</type>
          </tag>
          <tag name="access" description="public" line="2511"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2522" package="Net_SSH2">
        <name>getLanguagesServer2Client</name>
        <full_name>\Net_SSH2::getLanguagesServer2Client()</full_name>
        <docblock line="2522">
          <description>Return a list of the languages the server supports, when sending stuff to the client.</description>
          <long-description></long-description>
          <tag name="return" description="" line="2522" type="Array">
            <type>Array</type>
          </tag>
          <tag name="access" description="public" line="2522"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2533" package="Net_SSH2">
        <name>getLanguagesClient2Server</name>
        <full_name>\Net_SSH2::getLanguagesClient2Server()</full_name>
        <docblock line="2533">
          <description>Return a list of the languages the server supports, when receiving stuff from the client.</description>
          <long-description></long-description>
          <tag name="return" description="" line="2533" type="Array">
            <type>Array</type>
          </tag>
          <tag name="access" description="public" line="2533"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2547" package="Net_SSH2">
        <name>getServerPublicHostKey</name>
        <full_name>\Net_SSH2::getServerPublicHostKey()</full_name>
        <docblock line="2547">
          <description>Returns the server public host key.</description>
          <long-description>Caching this the first time you connect to a server and checking the result on subsequent connections
is recommended.  Returns false if the server signature is not signed correctly with the public host key.</long-description>
          <tag name="return" description="" line="2547" type="Mixed">
            <type>Mixed</type>
          </tag>
          <tag name="access" description="public" line="2547"/>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/3rdParty/phpseclib/Net/SFTP.php" generated-path="lib.3rdParty.phpseclib.Net.SFTP.html" hash="45df2d5020b4aacac771cea7e6cf39af" package="Net_SFTP">
    <docblock line="0">
      <description>Pure-PHP implementation of SFTP.</description>
      <long-description>PHP versions 4 and 5

Currently only supports SFTPv3, which, according to wikipedia.org, "is the most widely used version,
implemented by the popular OpenSSH SFTP server".  If you want SFTPv4/5/6 support, provide me with access
to an SFTPv4/5/6 server.

The API for this library is modeled after the API from PHP's {@link http://php.net/book.ftp FTP extension}.

Here's a short example of how to use this library:
&lt;code&gt;
&lt;?php
   include('Net/SFTP.php');

   $sftp = new Net_SFTP('www.domain.tld');
   if (!$sftp-&gt;login('username', 'password')) {
       exit('Login Failed');
   }

   echo $sftp-&gt;pwd() . "\r\n";
   $sftp-&gt;put('filename.ext', 'hello, world!');
   print_r($sftp-&gt;nlist());
?&gt;
&lt;/code&gt;

LICENSE: Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.</long-description>
      <tag name="category" description="Net" line="0"/>
      <tag name="package" description="Net_SFTP" line="0"/>
      <tag name="author" description="Jim Wigginton &amp;lt;terrafrost@php.net&amp;gt;" line="0"/>
      <tag name="copyright" description="MMIX Jim Wigginton" line="0"/>
      <tag name="license" description="MIT License" line="0" link="http://www.opensource.org/licenses/mit-license.html"/>
      <tag name="link" description="http://phpseclib.sourceforge.net" line="0"/>
    </docblock>
    <constant namespace="" line="69" package="Net_SFTP">
      <name>NET_SFTP_LOG_SIMPLE</name>
      <full_name>\\NET_SFTP_LOG_SIMPLE</full_name>
      <value>NET_SSH2_LOG_SIMPLE</value>
      <docblock line="69">
        <description>Returns the message numbers</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="73" package="Net_SFTP">
      <name>NET_SFTP_LOG_COMPLEX</name>
      <full_name>\\NET_SFTP_LOG_COMPLEX</full_name>
      <value>NET_SSH2_LOG_COMPLEX</value>
      <docblock line="73">
        <description>Returns the message content</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="85" package="Net_SFTP">
      <name>NET_SFTP_CHANNEL</name>
      <full_name>\\NET_SFTP_CHANNEL</full_name>
      <value>2</value>
      <docblock line="85">
        <description>SFTP channel constant</description>
        <long-description>Net_SSH2::exec() uses 0 and Net_SSH2::read() / Net_SSH2::write() use 1.</long-description>
        <tag name="see" description="" line="85"/>
        <tag name="see" description="" line="85"/>
        <tag name="access" description="private" line="85"/>
      </docblock>
    </constant>
    <constant namespace="" line="94" package="Net_SFTP">
      <name>NET_SFTP_LOCAL_FILE</name>
      <full_name>\\NET_SFTP_LOCAL_FILE</full_name>
      <value>1</value>
      <docblock line="94">
        <description>Reads data from a local file.</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="98" package="Net_SFTP">
      <name>NET_SFTP_STRING</name>
      <full_name>\\NET_SFTP_STRING</full_name>
      <value>2</value>
      <docblock line="98">
        <description>Reads data from a string.</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <class final="false" abstract="false" namespace="" line="109" package="Net_SFTP">
      <extends>\Net_SSH2</extends>
      <name>Net_SFTP</name>
      <full_name>\Net_SFTP</full_name>
      <docblock line="109">
        <description>Pure-PHP implementations of SFTP.</description>
        <long-description></long-description>
        <tag name="author" description="Jim Wigginton &amp;lt;terrafrost@php.net&amp;gt;" line="109"/>
        <tag name="version" description="" line="109"/>
        <tag name="access" description="public" line="109"/>
        <tag name="package" description="Net_SFTP" line="109"/>
      </docblock>
      <property static="false" visibility="public" line="117" namespace="" package="Net_SFTP">
        <name>$packet_types</name>
        <default>array()</default>
        <docblock line="117">
          <description>Packet Types</description>
          <long-description></long-description>
          <tag name="see" description="" line="117"/>
          <tag name="var" description="" line="117" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="117"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="126" namespace="" package="Net_SFTP">
        <name>$status_codes</name>
        <default>array()</default>
        <docblock line="126">
          <description>Status Codes</description>
          <long-description></long-description>
          <tag name="see" description="" line="126"/>
          <tag name="var" description="" line="126" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="126"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="138" namespace="" package="Net_SFTP">
        <name>$request_id</name>
        <default>false</default>
        <docblock line="138">
          <description>The Request ID</description>
          <long-description>The request ID exists in the off chance that a packet is sent out-of-order.  Of course, this library doesn't support
concurrent actions, so it's somewhat academic, here.</long-description>
          <tag name="var" description="" line="138" type="Integer" variable="">
            <type>Integer</type>
          </tag>
          <tag name="see" description="" line="138"/>
          <tag name="access" description="private" line="138"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="150" namespace="" package="Net_SFTP">
        <name>$packet_type</name>
        <default>-1</default>
        <docblock line="150">
          <description>The Packet Type</description>
          <long-description>The request ID exists in the off chance that a packet is sent out-of-order.  Of course, this library doesn't support
concurrent actions, so it's somewhat academic, here.</long-description>
          <tag name="var" description="" line="150" type="Integer" variable="">
            <type>Integer</type>
          </tag>
          <tag name="see" description="" line="150"/>
          <tag name="access" description="private" line="150"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="159" namespace="" package="Net_SFTP">
        <name>$packet_buffer</name>
        <default>''</default>
        <docblock line="159">
          <description>Packet Buffer</description>
          <long-description></long-description>
          <tag name="var" description="" line="159" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="see" description="" line="159"/>
          <tag name="access" description="private" line="159"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="168" namespace="" package="Net_SFTP">
        <name>$extensions</name>
        <default>array()</default>
        <docblock line="168">
          <description>Extensions supported by the server</description>
          <long-description></long-description>
          <tag name="var" description="" line="168" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="see" description="" line="168"/>
          <tag name="access" description="private" line="168"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="177" namespace="" package="Net_SFTP">
        <name>$version</name>
        <default></default>
        <docblock line="177">
          <description>Server SFTP version</description>
          <long-description></long-description>
          <tag name="var" description="" line="177" type="Integer" variable="">
            <type>Integer</type>
          </tag>
          <tag name="see" description="" line="177"/>
          <tag name="access" description="private" line="177"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="187" namespace="" package="Net_SFTP">
        <name>$pwd</name>
        <default>false</default>
        <docblock line="187">
          <description>Current working directory</description>
          <long-description></long-description>
          <tag name="var" description="" line="187" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="see" description="" line="187"/>
          <tag name="see" description="" line="187"/>
          <tag name="access" description="private" line="187"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="196" namespace="" package="Net_SFTP">
        <name>$packet_type_log</name>
        <default>array()</default>
        <docblock line="196">
          <description>Packet Type Log</description>
          <long-description></long-description>
          <tag name="see" description="" line="196"/>
          <tag name="var" description="" line="196" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="196"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="205" namespace="" package="Net_SFTP">
        <name>$packet_log</name>
        <default>array()</default>
        <docblock line="205">
          <description>Packet Log</description>
          <long-description></long-description>
          <tag name="see" description="" line="205"/>
          <tag name="var" description="" line="205" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="205"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="215" namespace="" package="Net_SFTP">
        <name>$sftp_errors</name>
        <default>array()</default>
        <docblock line="215">
          <description>Error information</description>
          <long-description></long-description>
          <tag name="see" description="" line="215"/>
          <tag name="see" description="" line="215"/>
          <tag name="var" description="" line="215" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="215"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="224" namespace="" package="Net_SFTP">
        <name>$fileType</name>
        <default>0</default>
        <docblock line="224">
          <description>File Type</description>
          <long-description></long-description>
          <tag name="see" description="" line="224"/>
          <tag name="var" description="" line="224" type="Integer" variable="">
            <type>Integer</type>
          </tag>
          <tag name="access" description="private" line="224"/>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="237" package="Net_SFTP">
        <name>Net_SFTP</name>
        <full_name>\Net_SFTP::Net_SFTP()</full_name>
        <docblock line="237">
          <description>Default Constructor.</description>
          <long-description>Connects to an SFTP server</long-description>
          <tag name="param" description="" line="237" type="String" variable="$host">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Integer $port&lt;/p&gt;&#10;" line="237" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Integer $timeout&lt;/p&gt;&#10;" line="237" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="237" type="\Net_SFTP">
            <type>\Net_SFTP</type>
          </tag>
          <tag name="access" description="public" line="237"/>
        </docblock>
        <argument line="0">
          <name>$host</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$port</name>
          <default>22</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$timeout</name>
          <default>10</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="333" package="Net_SFTP">
        <name>login</name>
        <full_name>\Net_SFTP::login()</full_name>
        <docblock line="333">
          <description>Login</description>
          <long-description></long-description>
          <tag name="param" description="" line="333" type="String" variable="$username">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;String $password&lt;/p&gt;&#10;" line="333" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="333" type="Boolean">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="public" line="333"/>
        </docblock>
        <argument line="0">
          <name>$username</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$password</name>
          <default>''</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="444" package="Net_SFTP">
        <name>pwd</name>
        <full_name>\Net_SFTP::pwd()</full_name>
        <docblock line="444">
          <description>Returns the current directory name</description>
          <long-description></long-description>
          <tag name="return" description="" line="444" type="Mixed">
            <type>Mixed</type>
          </tag>
          <tag name="access" description="public" line="444"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="462" package="Net_SFTP">
        <name>_realpath</name>
        <full_name>\Net_SFTP::_realpath()</full_name>
        <docblock line="462">
          <description>Canonicalize the Server-Side Path Name</description>
          <long-description>SFTP doesn't provide a mechanism by which the current working directory can be changed, so we'll emulate it.  Returns
the absolute (canonicalized) path.  If $mode is set to NET_SFTP_CONFIRM_DIR (as opposed to NET_SFTP_CONFIRM_NONE,
which is what it is set to by default), false is returned if $dir is not a valid directory.</long-description>
          <tag name="see" description="" line="462"/>
          <tag name="param" description="" line="462" type="String" variable="$dir">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Integer $mode&lt;/p&gt;&#10;" line="462" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="462" type="Mixed">
            <type>Mixed</type>
          </tag>
          <tag name="access" description="private" line="462"/>
        </docblock>
        <argument line="0">
          <name>$dir</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="546" package="Net_SFTP">
        <name>chdir</name>
        <full_name>\Net_SFTP::chdir()</full_name>
        <docblock line="546">
          <description>Changes the current directory</description>
          <long-description></long-description>
          <tag name="param" description="" line="546" type="String" variable="$dir">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="546" type="Boolean">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="public" line="546"/>
        </docblock>
        <argument line="0">
          <name>$dir</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="605" package="Net_SFTP">
        <name>nlist</name>
        <full_name>\Net_SFTP::nlist()</full_name>
        <docblock line="605">
          <description>Returns a list of files in the given directory</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;String $dir&lt;/p&gt;&#10;" line="605" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="605" type="Mixed">
            <type>Mixed</type>
          </tag>
          <tag name="access" description="public" line="605"/>
        </docblock>
        <argument line="0">
          <name>$dir</name>
          <default>'.'</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="617" package="Net_SFTP">
        <name>rawlist</name>
        <full_name>\Net_SFTP::rawlist()</full_name>
        <docblock line="617">
          <description>Returns a detailed list of files in the given directory</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;String $dir&lt;/p&gt;&#10;" line="617" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="617" type="Mixed">
            <type>Mixed</type>
          </tag>
          <tag name="access" description="public" line="617"/>
        </docblock>
        <argument line="0">
          <name>$dir</name>
          <default>'.'</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="629" package="Net_SFTP">
        <name>_list</name>
        <full_name>\Net_SFTP::_list()</full_name>
        <docblock line="629">
          <description>Reads a list, be it detailed or not, of files in the given directory</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;String $dir&lt;/p&gt;&#10;" line="629" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="629" type="Mixed">
            <type>Mixed</type>
          </tag>
          <tag name="access" description="private" line="629"/>
        </docblock>
        <argument line="0">
          <name>$dir</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$raw</name>
          <default>true</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="740" package="Net_SFTP">
        <name>size</name>
        <full_name>\Net_SFTP::size()</full_name>
        <docblock line="740">
          <description>Returns the file size, in bytes, or false, on failure</description>
          <long-description>Files larger than 4GB will show up as being exactly 4GB.</long-description>
          <tag name="param" description="" line="740" type="String" variable="$filename">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="740" type="Mixed">
            <type>Mixed</type>
          </tag>
          <tag name="access" description="public" line="740"/>
        </docblock>
        <argument line="0">
          <name>$filename</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="763" package="Net_SFTP">
        <name>stat</name>
        <full_name>\Net_SFTP::stat()</full_name>
        <docblock line="763">
          <description>Returns general information about a file.</description>
          <long-description>Returns an array on success and false otherwise.</long-description>
          <tag name="param" description="" line="763" type="String" variable="$filename">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="763" type="Mixed">
            <type>Mixed</type>
          </tag>
          <tag name="access" description="public" line="763"/>
        </docblock>
        <argument line="0">
          <name>$filename</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="786" package="Net_SFTP">
        <name>lstat</name>
        <full_name>\Net_SFTP::lstat()</full_name>
        <docblock line="786">
          <description>Returns general information about a file or symbolic link.</description>
          <long-description>Returns an array on success and false otherwise.</long-description>
          <tag name="param" description="" line="786" type="String" variable="$filename">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="786" type="Mixed">
            <type>Mixed</type>
          </tag>
          <tag name="access" description="public" line="786"/>
        </docblock>
        <argument line="0">
          <name>$filename</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="811" package="Net_SFTP">
        <name>_stat</name>
        <full_name>\Net_SFTP::_stat()</full_name>
        <docblock line="811">
          <description>Returns general information about a file or symbolic link</description>
          <long-description>Determines information without calling Net_SFTP::_realpath().
The second parameter can be either NET_SFTP_STAT or NET_SFTP_LSTAT.</long-description>
          <tag name="param" description="" line="811" type="String" variable="$filename">
            <type>String</type>
          </tag>
          <tag name="param" description="" line="811" type="Integer" variable="$type">
            <type>Integer</type>
          </tag>
          <tag name="return" description="" line="811" type="Mixed">
            <type>Mixed</type>
          </tag>
          <tag name="access" description="private" line="811"/>
        </docblock>
        <argument line="0">
          <name>$filename</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$type</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="846" package="Net_SFTP">
        <name>_size</name>
        <full_name>\Net_SFTP::_size()</full_name>
        <docblock line="846">
          <description>Returns the file size, in bytes, or false, on failure</description>
          <long-description>Determines the size without calling Net_SFTP::_realpath()</long-description>
          <tag name="param" description="" line="846" type="String" variable="$filename">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="846" type="Mixed">
            <type>Mixed</type>
          </tag>
          <tag name="access" description="private" line="846"/>
        </docblock>
        <argument line="0">
          <name>$filename</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="862" package="Net_SFTP">
        <name>chmod</name>
        <full_name>\Net_SFTP::chmod()</full_name>
        <docblock line="862">
          <description>Set permissions on a file.</description>
          <long-description>Returns the new file permissions on success or FALSE on error.</long-description>
          <tag name="param" description="" line="862" type="Integer" variable="$mode">
            <type>Integer</type>
          </tag>
          <tag name="param" description="" line="862" type="String" variable="$filename">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="862" type="Mixed">
            <type>Mixed</type>
          </tag>
          <tag name="access" description="public" line="862"/>
        </docblock>
        <argument line="0">
          <name>$mode</name>
          <default></default>
          <type>Integer</type>
        </argument>
        <argument line="0">
          <name>$filename</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="929" package="Net_SFTP">
        <name>mkdir</name>
        <full_name>\Net_SFTP::mkdir()</full_name>
        <docblock line="929">
          <description>Creates a directory.</description>
          <long-description></long-description>
          <tag name="param" description="" line="929" type="String" variable="$dir">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="929" type="Boolean">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="public" line="929"/>
        </docblock>
        <argument line="0">
          <name>$dir</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="969" package="Net_SFTP">
        <name>rmdir</name>
        <full_name>\Net_SFTP::rmdir()</full_name>
        <docblock line="969">
          <description>Removes a directory.</description>
          <long-description></long-description>
          <tag name="param" description="" line="969" type="String" variable="$dir">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="969" type="Boolean">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="public" line="969"/>
        </docblock>
        <argument line="0">
          <name>$dir</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1131" package="Net_SFTP">
        <name>_read_put_responses</name>
        <full_name>\Net_SFTP::_read_put_responses()</full_name>
        <docblock line="1131">
          <description>Reads multiple successive SSH_FXP_WRITE responses</description>
          <long-description>Sending an SSH_FXP_WRITE packet and immediately reading its response isn't as efficient as blindly sending out $i
SSH_FXP_WRITEs, in succession, and then reading $i responses.</long-description>
          <tag name="param" description="" line="1131" type="Integer" variable="$i">
            <type>Integer</type>
          </tag>
          <tag name="return" description="" line="1131" type="Boolean">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="private" line="1131"/>
        </docblock>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1163" package="Net_SFTP">
        <name>get</name>
        <full_name>\Net_SFTP::get()</full_name>
        <docblock line="1163">
          <description>Downloads a file from the SFTP server.</description>
          <long-description>Returns a string containing the contents of $remote_file if $local_file is left undefined or a boolean false if
the operation was unsuccessful.  If $local_file is defined, returns true or false depending on the success of the
operation</long-description>
          <tag name="param" description="" line="1163" type="String" variable="$remote_file">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;String $local_file&lt;/p&gt;&#10;" line="1163" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="1163" type="Mixed">
            <type>Mixed</type>
          </tag>
          <tag name="access" description="public" line="1163"/>
        </docblock>
        <argument line="0">
          <name>$remote_file</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$local_file</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1275" package="Net_SFTP">
        <name>delete</name>
        <full_name>\Net_SFTP::delete()</full_name>
        <docblock line="1275">
          <description>Deletes a file on the SFTP server.</description>
          <long-description></long-description>
          <tag name="param" description="" line="1275" type="String" variable="$path">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="1275" type="Boolean">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="public" line="1275"/>
        </docblock>
        <argument line="0">
          <name>$path</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1316" package="Net_SFTP">
        <name>rename</name>
        <full_name>\Net_SFTP::rename()</full_name>
        <docblock line="1316">
          <description>Renames a file or a directory on the SFTP server</description>
          <long-description></long-description>
          <tag name="param" description="" line="1316" type="String" variable="$oldname">
            <type>String</type>
          </tag>
          <tag name="param" description="" line="1316" type="String" variable="$newname">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="1316" type="Boolean">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="public" line="1316"/>
        </docblock>
        <argument line="0">
          <name>$oldname</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$newname</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1360" package="Net_SFTP">
        <name>_parseAttributes</name>
        <full_name>\Net_SFTP::_parseAttributes()</full_name>
        <docblock line="1360">
          <description>Parse Attributes</description>
          <long-description>See '7.  File Attributes' of draft-ietf-secsh-filexfer-13 for more info.</long-description>
          <tag name="param" description="" line="1360" type="String" variable="$response">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="1360" type="Array">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="1360"/>
        </docblock>
        <argument line="0">
          <name>$response</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1417" package="Net_SFTP">
        <name>_parseLongname</name>
        <full_name>\Net_SFTP::_parseLongname()</full_name>
        <docblock line="1417">
          <description>Parse Longname</description>
          <long-description>SFTPv3 doesn't provide any easy way of identifying a file type.  You could try to open
a file as a directory and see if an error is returned or you could try to parse the
SFTPv3-specific longname field of the SSH_FXP_NAME packet.  That's what this function does.
The result is returned using the
{@link http://tools.ietf.org/html/draft-ietf-secsh-filexfer-04#section-5.2 SFTPv4 type constants}.

If the longname is in an unrecognized format bool(false) is returned.</long-description>
          <tag name="param" description="" line="1417" type="String" variable="$longname">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="1417" type="Mixed">
            <type>Mixed</type>
          </tag>
          <tag name="access" description="private" line="1417"/>
        </docblock>
        <argument line="0">
          <name>$longname</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1448" package="Net_SFTP">
        <name>_send_sftp_packet</name>
        <full_name>\Net_SFTP::_send_sftp_packet()</full_name>
        <docblock line="1448">
          <description>Sends SFTP Packets</description>
          <long-description>See '6. General Packet Format' of draft-ietf-secsh-filexfer-13 for more info.</long-description>
          <tag name="param" description="" line="1448" type="Integer" variable="$type">
            <type>Integer</type>
          </tag>
          <tag name="param" description="" line="1448" type="String" variable="$data">
            <type>String</type>
          </tag>
          <tag name="see" description="" line="1448"/>
          <tag name="see" description="" line="1448"/>
          <tag name="return" description="" line="1448" type="Boolean">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="private" line="1448"/>
        </docblock>
        <argument line="0">
          <name>$type</name>
          <default></default>
          <type>Integer</type>
        </argument>
        <argument line="0">
          <name>$data</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1482" package="Net_SFTP">
        <name>_get_sftp_packet</name>
        <full_name>\Net_SFTP::_get_sftp_packet()</full_name>
        <docblock line="1482">
          <description>Receives SFTP Packets</description>
          <long-description>See '6. General Packet Format' of draft-ietf-secsh-filexfer-13 for more info.

Incidentally, the number of SSH_MSG_CHANNEL_DATA messages has no bearing on the number of SFTP packets present.
There can be one SSH_MSG_CHANNEL_DATA messages containing two SFTP packets or there can be two SSH_MSG_CHANNEL_DATA
messages containing one SFTP packet.</long-description>
          <tag name="see" description="" line="1482"/>
          <tag name="return" description="" line="1482" type="String">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="1482"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1544" package="Net_SFTP">
        <name>getSFTPLog</name>
        <full_name>\Net_SFTP::getSFTPLog()</full_name>
        <docblock line="1544">
          <description>Returns a log of the packets that have been sent and received.</description>
          <long-description>Returns a string if NET_SFTP_LOGGING == NET_SFTP_LOG_COMPLEX, an array if NET_SFTP_LOGGING == NET_SFTP_LOG_SIMPLE and false if !defined('NET_SFTP_LOGGING')</long-description>
          <tag name="access" description="public" line="1544"/>
          <tag name="return" description="or Array" line="1544" type="String">
            <type>String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1566" package="Net_SFTP">
        <name>getSFTPErrors</name>
        <full_name>\Net_SFTP::getSFTPErrors()</full_name>
        <docblock line="1566">
          <description>Returns all errors</description>
          <long-description></long-description>
          <tag name="return" description="" line="1566" type="String">
            <type>String</type>
          </tag>
          <tag name="access" description="public" line="1566"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1577" package="Net_SFTP">
        <name>getLastSFTPError</name>
        <full_name>\Net_SFTP::getLastSFTPError()</full_name>
        <docblock line="1577">
          <description>Returns the last error</description>
          <long-description></long-description>
          <tag name="return" description="" line="1577" type="String">
            <type>String</type>
          </tag>
          <tag name="access" description="public" line="1577"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1588" package="Net_SFTP">
        <name>getSupportedVersions</name>
        <full_name>\Net_SFTP::getSupportedVersions()</full_name>
        <docblock line="1588">
          <description>Get supported SFTP versions</description>
          <long-description></long-description>
          <tag name="return" description="" line="1588" type="Array">
            <type>Array</type>
          </tag>
          <tag name="access" description="public" line="1588"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1604" package="Net_SFTP">
        <name>_disconnect</name>
        <full_name>\Net_SFTP::_disconnect()</full_name>
        <docblock line="1604">
          <description>Disconnect</description>
          <long-description></long-description>
          <tag name="param" description="" line="1604" type="Integer" variable="$reason">
            <type>Integer</type>
          </tag>
          <tag name="return" description="" line="1604" type="Boolean">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="private" line="1604"/>
        </docblock>
        <argument line="0">
          <name>$reason</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/3rdParty/phpseclib/Math/BigInteger.php" generated-path="lib.3rdParty.phpseclib.Math.BigInteger.html" hash="257550e82cb4ca5042a85a2a9235771b" package="Math_BigInteger">
    <docblock line="0">
      <description>Pure-PHP arbitrary precision integer arithmetic library.</description>
      <long-description>Supports base-2, base-10, base-16, and base-256 numbers.  Uses the GMP or BCMath extensions, if available,
and an internal implementation, otherwise.

PHP versions 4 and 5

{@internal (all DocBlock comments regarding implementation - such as the one that follows - refer to the
{@link MATH_BIGINTEGER_MODE_INTERNAL MATH_BIGINTEGER_MODE_INTERNAL} mode)

Math_BigInteger uses base-2**26 to perform operations such as multiplication and division and
base-2**52 (ie. two base 2**26 digits) to perform addition and subtraction.  Because the largest possible
value when multiplying two base-2**26 numbers together is a base-2**52 number, double precision floating
point numbers - numbers that should be supported on most hardware and whose significand is 53 bits - are
used.  As a consequence, bitwise operators such as &gt;&gt; and &lt;&lt; cannot be used, nor can the modulo operator %,
which only supports integers.  Although this fact will slow this library down, the fact that such a high
base is being used should more than compensate.

When PHP version 6 is officially released, we'll be able to use 64-bit integers.  This should, once again,
allow bitwise operators, and will increase the maximum possible base to 2**31 (or 2**62 for addition /
subtraction).

Numbers are stored in {@link http://en.wikipedia.org/wiki/Endianness little endian} format.  ie.
(new Math_BigInteger(pow(2, 26)))-&gt;value = array(0, 1)

Useful resources are as follows:

 - {@link http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf Handbook of Applied Cryptography (HAC)}
 - {@link http://math.libtomcrypt.com/files/tommath.pdf Multi-Precision Math (MPM)}
 - Java's BigInteger classes.  See /j2se/src/share/classes/java/math in jdk-1_5_0-src-jrl.zip

Here's an example of how to use this library:
&lt;code&gt;
&lt;?php
   include('Math/BigInteger.php');

   $a = new Math_BigInteger(2);
   $b = new Math_BigInteger(3);

   $c = $a-&gt;add($b);

   echo $c-&gt;toString(); // outputs 5
?&gt;
&lt;/code&gt;

LICENSE: Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.</long-description>
      <tag name="category" description="Math" line="0"/>
      <tag name="package" description="Math_BigInteger" line="0"/>
      <tag name="author" description="Jim Wigginton &amp;lt;terrafrost@php.net&amp;gt;" line="0"/>
      <tag name="copyright" description="MMVI Jim Wigginton" line="0"/>
      <tag name="license" description="MIT License" line="0" link="http://www.opensource.org/licenses/mit-license.html"/>
      <tag name="version" description="$Id: BigInteger.php 4105 2011-05-19 18:02:11Z gruberroland $" line="0"/>
      <tag name="link" description="http://pear.php.net/package/Math_BigInteger" line="0"/>
    </docblock>
    <constant namespace="" line="87" package="Math_BigInteger">
      <name>MATH_BIGINTEGER_MONTGOMERY</name>
      <full_name>\\MATH_BIGINTEGER_MONTGOMERY</full_name>
      <value>0</value>
      <docblock line="87">
        <description></description>
        <long-description></long-description>
        <tag name="see" description="" line="87"/>
        <tag name="see" description="" line="87"/>
      </docblock>
    </constant>
    <constant namespace="" line="91" package="Math_BigInteger">
      <name>MATH_BIGINTEGER_BARRETT</name>
      <full_name>\\MATH_BIGINTEGER_BARRETT</full_name>
      <value>1</value>
      <docblock line="91">
        <description></description>
        <long-description></long-description>
        <tag name="see" description="" line="91"/>
      </docblock>
    </constant>
    <constant namespace="" line="95" package="Math_BigInteger">
      <name>MATH_BIGINTEGER_POWEROF2</name>
      <full_name>\\MATH_BIGINTEGER_POWEROF2</full_name>
      <value>2</value>
      <docblock line="95">
        <description></description>
        <long-description></long-description>
        <tag name="see" description="" line="95"/>
      </docblock>
    </constant>
    <constant namespace="" line="99" package="Math_BigInteger">
      <name>MATH_BIGINTEGER_CLASSIC</name>
      <full_name>\\MATH_BIGINTEGER_CLASSIC</full_name>
      <value>3</value>
      <docblock line="99">
        <description></description>
        <long-description></long-description>
        <tag name="see" description="" line="99"/>
      </docblock>
    </constant>
    <constant namespace="" line="103" package="Math_BigInteger">
      <name>MATH_BIGINTEGER_NONE</name>
      <full_name>\\MATH_BIGINTEGER_NONE</full_name>
      <value>4</value>
      <docblock line="103">
        <description></description>
        <long-description></long-description>
        <tag name="see" description="" line="103"/>
      </docblock>
    </constant>
    <constant namespace="" line="117" package="Math_BigInteger">
      <name>MATH_BIGINTEGER_VALUE</name>
      <full_name>\\MATH_BIGINTEGER_VALUE</full_name>
      <value>0</value>
      <docblock line="117">
        <description>$result[MATH_BIGINTEGER_VALUE] contains the value.</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="121" package="Math_BigInteger">
      <name>MATH_BIGINTEGER_SIGN</name>
      <full_name>\\MATH_BIGINTEGER_SIGN</full_name>
      <value>1</value>
      <docblock line="121">
        <description>$result[MATH_BIGINTEGER_SIGN] contains the sign.</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="134" package="Math_BigInteger">
      <name>MATH_BIGINTEGER_VARIABLE</name>
      <full_name>\\MATH_BIGINTEGER_VARIABLE</full_name>
      <value>0</value>
      <docblock line="134">
        <description>Cache constants</description>
        <long-description>$cache[MATH_BIGINTEGER_VARIABLE] tells us whether or not the cached data is still valid.</long-description>
      </docblock>
    </constant>
    <constant namespace="" line="138" package="Math_BigInteger">
      <name>MATH_BIGINTEGER_DATA</name>
      <full_name>\\MATH_BIGINTEGER_DATA</full_name>
      <value>1</value>
      <docblock line="138">
        <description>$cache[MATH_BIGINTEGER_DATA] contains the cached data.</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="150" package="Math_BigInteger">
      <name>MATH_BIGINTEGER_MODE_INTERNAL</name>
      <full_name>\\MATH_BIGINTEGER_MODE_INTERNAL</full_name>
      <value>1</value>
      <docblock line="150">
        <description>To use the pure-PHP implementation</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="156" package="Math_BigInteger">
      <name>MATH_BIGINTEGER_MODE_BCMATH</name>
      <full_name>\\MATH_BIGINTEGER_MODE_BCMATH</full_name>
      <value>2</value>
      <docblock line="156">
        <description>To use the BCMath library</description>
        <long-description>(if enabled; otherwise, the internal implementation will be used)</long-description>
      </docblock>
    </constant>
    <constant namespace="" line="162" package="Math_BigInteger">
      <name>MATH_BIGINTEGER_MODE_GMP</name>
      <full_name>\\MATH_BIGINTEGER_MODE_GMP</full_name>
      <value>3</value>
      <docblock line="162">
        <description>To use the GMP library</description>
        <long-description>(if present; otherwise, either the BCMath or the internal implementation will be used)</long-description>
      </docblock>
    </constant>
    <constant namespace="" line="173" package="Math_BigInteger">
      <name>MATH_BIGINTEGER_MAX_DIGIT52</name>
      <full_name>\\MATH_BIGINTEGER_MAX_DIGIT52</full_name>
      <value>pow(2, 52)</value>
      <docblock line="173">
        <description>The largest digit that may be used in addition / subtraction</description>
        <long-description>(we do pow(2, 52) instead of using 4503599627370496, directly, because some PHP installations
 will truncate 4503599627370496)</long-description>
        <tag name="access" description="private" line="173"/>
      </docblock>
    </constant>
    <constant namespace="" line="182" package="Math_BigInteger">
      <name>MATH_BIGINTEGER_KARATSUBA_CUTOFF</name>
      <full_name>\\MATH_BIGINTEGER_KARATSUBA_CUTOFF</full_name>
      <value>25</value>
      <docblock line="182">
        <description>Karatsuba Cutoff</description>
        <long-description>At what point do we switch between Karatsuba multiplication and schoolbook long multiplication?</long-description>
        <tag name="access" description="private" line="182"/>
      </docblock>
    </constant>
    <constant namespace="" line="281" package="Math_BigInteger">
      <name>MATH_BIGINTEGER_MODE</name>
      <full_name>\\MATH_BIGINTEGER_MODE</full_name>
      <value>MATH_BIGINTEGER_MODE_INTERNAL</value>
      <docblock line="281">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <class final="false" abstract="false" namespace="" line="193" package="Math_BigInteger">
      <extends/>
      <name>Math_BigInteger</name>
      <full_name>\Math_BigInteger</full_name>
      <docblock line="193">
        <description>Pure-PHP arbitrary precision integer arithmetic library. Supports base-2, base-10, base-16, and base-256
numbers.</description>
        <long-description></long-description>
        <tag name="author" description="Jim Wigginton &amp;lt;terrafrost@php.net&amp;gt;" line="193"/>
        <tag name="version" description="" line="193"/>
        <tag name="access" description="public" line="193"/>
        <tag name="package" description="Math_BigInteger" line="193"/>
      </docblock>
      <property static="false" visibility="public" line="200" namespace="" package="Math_BigInteger">
        <name>$value</name>
        <default></default>
        <docblock line="200">
          <description>Holds the BigInteger's value.</description>
          <long-description></long-description>
          <tag name="var" description="" line="200" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="200"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="208" namespace="" package="Math_BigInteger">
        <name>$is_negative</name>
        <default>false</default>
        <docblock line="208">
          <description>Holds the BigInteger's magnitude.</description>
          <long-description></long-description>
          <tag name="var" description="" line="208" type="Boolean" variable="">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="private" line="208"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="216" namespace="" package="Math_BigInteger">
        <name>$generator</name>
        <default>'mt_rand'</default>
        <docblock line="216">
          <description>Random number generator function</description>
          <long-description></long-description>
          <tag name="see" description="" line="216"/>
          <tag name="access" description="private" line="216"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="224" namespace="" package="Math_BigInteger">
        <name>$precision</name>
        <default>-1</default>
        <docblock line="224">
          <description>Precision</description>
          <long-description></long-description>
          <tag name="see" description="" line="224"/>
          <tag name="access" description="private" line="224"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="232" namespace="" package="Math_BigInteger">
        <name>$bitmask</name>
        <default>false</default>
        <docblock line="232">
          <description>Precision Bitmask</description>
          <long-description></long-description>
          <tag name="see" description="" line="232"/>
          <tag name="access" description="private" line="232"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="246" namespace="" package="Math_BigInteger">
        <name>$hex</name>
        <default></default>
        <docblock line="246">
          <description>Mode independant value used for serialization.</description>
          <long-description>If the bcmath or gmp extensions are installed $this-&gt;value will be a non-serializable resource, hence the need for
a variable that'll be serializable regardless of whether or not extensions are being used.  Unlike $this-&gt;value,
however, $this-&gt;hex is only calculated when $this-&gt;__sleep() is called.</long-description>
          <tag name="see" description="" line="246"/>
          <tag name="see" description="" line="246"/>
          <tag name="var" description="" line="246" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="246"/>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="270" package="Math_BigInteger">
        <name>Math_BigInteger</name>
        <full_name>\Math_BigInteger::Math_BigInteger()</full_name>
        <docblock line="270">
          <description>Converts base-2, base-10, base-16, and binary strings (eg. base-256) to BigIntegers.</description>
          <long-description>If the second parameter - $base - is negative, then it will be assumed that the number's are encoded using
two's compliment.  The sole exception to this is -10, which is treated the same as 10 is.

Here's an example:
&lt;code&gt;
&lt;?php
   include('Math/BigInteger.php');

   $a = new Math_BigInteger('0x32', 16); // 50 in base-16

   echo $a-&gt;toString(); // outputs 50
?&gt;
&lt;/code&gt;</long-description>
          <tag name="param" description="&lt;p&gt;base-10 number or base-$base number if $base set.&lt;/p&gt;&#10;" line="270" type="\optional" variable="$x">
            <type>\optional</type>
          </tag>
          <tag name="param" description="&lt;p&gt;integer $base&lt;/p&gt;&#10;" line="270" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="270" type="\Math_BigInteger">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="access" description="public" line="270"/>
        </docblock>
        <argument line="0">
          <name>$x</name>
          <default>0</default>
          <type>\optional</type>
        </argument>
        <argument line="0">
          <name>$base</name>
          <default>10</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="680" package="Math_BigInteger">
        <name>copy</name>
        <full_name>\Math_BigInteger::copy()</full_name>
        <docblock line="680">
          <description>Copy an object</description>
          <long-description>PHP5 passes objects by reference while PHP4 passes by value.  As such, we need a function to guarantee
that all objects are passed by value, when appropriate.  More information can be found here:

{@link http://php.net/language.oop5.basic#51624}</long-description>
          <tag name="access" description="public" line="680"/>
          <tag name="see" description="" line="680"/>
          <tag name="return" description="" line="680" type="\Math_BigInteger">
            <type>\Math_BigInteger</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="717" package="Math_BigInteger">
        <name>__clone</name>
        <full_name>\Math_BigInteger::__clone()</full_name>
        <docblock line="717">
          <description>__clone() magic method</description>
          <long-description>Although you can call Math_BigInteger::__toString() directly in PHP5, you cannot call Math_BigInteger::__clone()
directly in PHP5.  You can in PHP4 since it's not a magic method, but in PHP5, you have to call it by using the PHP5
only syntax of $y = clone $x.  As such, if you're trying to write an application that works on both PHP4 and PHP5,
call Math_BigInteger::copy(), instead.</long-description>
          <tag name="access" description="public" line="717"/>
          <tag name="see" description="" line="717"/>
          <tag name="return" description="" line="717" type="\Math_BigInteger">
            <type>\Math_BigInteger</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="730" package="Math_BigInteger">
        <name>__sleep</name>
        <full_name>\Math_BigInteger::__sleep()</full_name>
        <docblock line="730">
          <description>__sleep() magic method</description>
          <long-description>Will be called, automatically, when serialize() is called on a Math_BigInteger object.</long-description>
          <tag name="see" description="" line="730"/>
          <tag name="access" description="public" line="730"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="752" package="Math_BigInteger">
        <name>__wakeup</name>
        <full_name>\Math_BigInteger::__wakeup()</full_name>
        <docblock line="752">
          <description>__wakeup() magic method</description>
          <long-description>Will be called, automatically, when unserialize() is called on a Math_BigInteger object.</long-description>
          <tag name="see" description="" line="752"/>
          <tag name="access" description="public" line="752"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="820" package="Math_BigInteger">
        <name>_add</name>
        <full_name>\Math_BigInteger::_add()</full_name>
        <docblock line="820">
          <description>Performs addition.</description>
          <long-description></long-description>
          <tag name="param" description="" line="820" type="Array" variable="$x_value">
            <type>Array</type>
          </tag>
          <tag name="param" description="" line="820" type="Boolean" variable="$x_negative">
            <type>Boolean</type>
          </tag>
          <tag name="param" description="" line="820" type="Array" variable="$y_value">
            <type>Array</type>
          </tag>
          <tag name="param" description="" line="820" type="Boolean" variable="$y_negative">
            <type>Boolean</type>
          </tag>
          <tag name="return" description="" line="820" type="Array">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="820"/>
        </docblock>
        <argument line="0">
          <name>$x_value</name>
          <default></default>
          <type>Array</type>
        </argument>
        <argument line="0">
          <name>$x_negative</name>
          <default></default>
          <type>Boolean</type>
        </argument>
        <argument line="0">
          <name>$y_value</name>
          <default></default>
          <type>Array</type>
        </argument>
        <argument line="0">
          <name>$y_negative</name>
          <default></default>
          <type>Boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="951" package="Math_BigInteger">
        <name>_subtract</name>
        <full_name>\Math_BigInteger::_subtract()</full_name>
        <docblock line="951">
          <description>Performs subtraction.</description>
          <long-description></long-description>
          <tag name="param" description="" line="951" type="Array" variable="$x_value">
            <type>Array</type>
          </tag>
          <tag name="param" description="" line="951" type="Boolean" variable="$x_negative">
            <type>Boolean</type>
          </tag>
          <tag name="param" description="" line="951" type="Array" variable="$y_value">
            <type>Array</type>
          </tag>
          <tag name="param" description="" line="951" type="Boolean" variable="$y_negative">
            <type>Boolean</type>
          </tag>
          <tag name="return" description="" line="951" type="Array">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="951"/>
        </docblock>
        <argument line="0">
          <name>$x_value</name>
          <default></default>
          <type>Array</type>
        </argument>
        <argument line="0">
          <name>$x_negative</name>
          <default></default>
          <type>Boolean</type>
        </argument>
        <argument line="0">
          <name>$y_value</name>
          <default></default>
          <type>Array</type>
        </argument>
        <argument line="0">
          <name>$y_negative</name>
          <default></default>
          <type>Boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1052" package="Math_BigInteger">
        <name>multiply</name>
        <full_name>\Math_BigInteger::multiply()</full_name>
        <docblock line="1052">
          <description>Multiplies two BigIntegers</description>
          <long-description>Here's an example:
&lt;code&gt;
&lt;?php
   include('Math/BigInteger.php');

   $a = new Math_BigInteger('10');
   $b = new Math_BigInteger('20');

   $c = $a-&gt;multiply($b);

   echo $c-&gt;toString(); // outputs 200
?&gt;
&lt;/code&gt;</long-description>
          <tag name="param" description="" line="1052" type="\Math_BigInteger" variable="$x">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="return" description="" line="1052" type="\Math_BigInteger">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="access" description="public" line="1052"/>
        </docblock>
        <argument line="0">
          <name>$x</name>
          <default></default>
          <type>\Math_BigInteger</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1086" package="Math_BigInteger">
        <name>_multiply</name>
        <full_name>\Math_BigInteger::_multiply()</full_name>
        <docblock line="1086">
          <description>Performs multiplication.</description>
          <long-description></long-description>
          <tag name="param" description="" line="1086" type="Array" variable="$x_value">
            <type>Array</type>
          </tag>
          <tag name="param" description="" line="1086" type="Boolean" variable="$x_negative">
            <type>Boolean</type>
          </tag>
          <tag name="param" description="" line="1086" type="Array" variable="$y_value">
            <type>Array</type>
          </tag>
          <tag name="param" description="" line="1086" type="Boolean" variable="$y_negative">
            <type>Boolean</type>
          </tag>
          <tag name="return" description="" line="1086" type="Array">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="1086"/>
        </docblock>
        <argument line="0">
          <name>$x_value</name>
          <default></default>
          <type>Array</type>
        </argument>
        <argument line="0">
          <name>$x_negative</name>
          <default></default>
          <type>Boolean</type>
        </argument>
        <argument line="0">
          <name>$y_value</name>
          <default></default>
          <type>Array</type>
        </argument>
        <argument line="0">
          <name>$y_negative</name>
          <default></default>
          <type>Boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1123" package="Math_BigInteger">
        <name>_regularMultiply</name>
        <full_name>\Math_BigInteger::_regularMultiply()</full_name>
        <docblock line="1123">
          <description>Performs long multiplication on two BigIntegers</description>
          <long-description>Modeled after 'multiply' in MutableBigInteger.java.</long-description>
          <tag name="param" description="" line="1123" type="Array" variable="$x_value">
            <type>Array</type>
          </tag>
          <tag name="param" description="" line="1123" type="Array" variable="$y_value">
            <type>Array</type>
          </tag>
          <tag name="return" description="" line="1123" type="Array">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="1123"/>
        </docblock>
        <argument line="0">
          <name>$x_value</name>
          <default></default>
          <type>Array</type>
        </argument>
        <argument line="0">
          <name>$y_value</name>
          <default></default>
          <type>Array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1187" package="Math_BigInteger">
        <name>_karatsuba</name>
        <full_name>\Math_BigInteger::_karatsuba()</full_name>
        <docblock line="1187">
          <description>Performs Karatsuba multiplication on two BigIntegers</description>
          <long-description>See {@link http://en.wikipedia.org/wiki/Karatsuba_algorithm Karatsuba algorithm} and
{@link http://math.libtomcrypt.com/files/tommath.pdf#page=120 MPM 5.2.3}.</long-description>
          <tag name="param" description="" line="1187" type="Array" variable="$x_value">
            <type>Array</type>
          </tag>
          <tag name="param" description="" line="1187" type="Array" variable="$y_value">
            <type>Array</type>
          </tag>
          <tag name="return" description="" line="1187" type="Array">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="1187"/>
        </docblock>
        <argument line="0">
          <name>$x_value</name>
          <default></default>
          <type>Array</type>
        </argument>
        <argument line="0">
          <name>$y_value</name>
          <default></default>
          <type>Array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1225" package="Math_BigInteger">
        <name>_square</name>
        <full_name>\Math_BigInteger::_square()</full_name>
        <docblock line="1225">
          <description>Performs squaring</description>
          <long-description></long-description>
          <tag name="param" description="" line="1225" type="Array" variable="$x">
            <type>Array</type>
          </tag>
          <tag name="return" description="" line="1225" type="Array">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="1225"/>
        </docblock>
        <argument line="0">
          <name>$x</name>
          <default>false</default>
          <type>Array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1243" package="Math_BigInteger">
        <name>_baseSquare</name>
        <full_name>\Math_BigInteger::_baseSquare()</full_name>
        <docblock line="1243">
          <description>Performs traditional squaring on two BigIntegers</description>
          <long-description>Squaring can be done faster than multiplying a number by itself can be.  See
{@link http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf#page=7 HAC 14.2.4} /
{@link http://math.libtomcrypt.com/files/tommath.pdf#page=141 MPM 5.3} for more information.</long-description>
          <tag name="param" description="" line="1243" type="Array" variable="$value">
            <type>Array</type>
          </tag>
          <tag name="return" description="" line="1243" type="Array">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="1243"/>
        </docblock>
        <argument line="0">
          <name>$value</name>
          <default></default>
          <type>Array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1282" package="Math_BigInteger">
        <name>_karatsubaSquare</name>
        <full_name>\Math_BigInteger::_karatsubaSquare()</full_name>
        <docblock line="1282">
          <description>Performs Karatsuba "squaring" on two BigIntegers</description>
          <long-description>See {@link http://en.wikipedia.org/wiki/Karatsuba_algorithm Karatsuba algorithm} and
{@link http://math.libtomcrypt.com/files/tommath.pdf#page=151 MPM 5.3.4}.</long-description>
          <tag name="param" description="" line="1282" type="Array" variable="$value">
            <type>Array</type>
          </tag>
          <tag name="return" description="" line="1282" type="Array">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="1282"/>
        </docblock>
        <argument line="0">
          <name>$value</name>
          <default></default>
          <type>Array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1521" package="Math_BigInteger">
        <name>_divide_digit</name>
        <full_name>\Math_BigInteger::_divide_digit()</full_name>
        <docblock line="1521">
          <description>Divides a BigInteger by a regular integer</description>
          <long-description>abc / x = a00 / x + b0 / x + c / x</long-description>
          <tag name="param" description="" line="1521" type="Array" variable="$dividend">
            <type>Array</type>
          </tag>
          <tag name="param" description="" line="1521" type="Array" variable="$divisor">
            <type>Array</type>
          </tag>
          <tag name="return" description="" line="1521" type="Array">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="1521"/>
        </docblock>
        <argument line="0">
          <name>$dividend</name>
          <default></default>
          <type>Array</type>
        </argument>
        <argument line="0">
          <name>$divisor</name>
          <default></default>
          <type>Array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1676" package="Math_BigInteger">
        <name>powMod</name>
        <full_name>\Math_BigInteger::powMod()</full_name>
        <docblock line="1676">
          <description>Performs modular exponentiation.</description>
          <long-description>Alias for Math_BigInteger::modPow()</long-description>
          <tag name="param" description="" line="1676" type="\Math_BigInteger" variable="$e">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="param" description="" line="1676" type="\Math_BigInteger" variable="$n">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="return" description="" line="1676" type="\Math_BigInteger">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="access" description="public" line="1676"/>
        </docblock>
        <argument line="0">
          <name>$e</name>
          <default></default>
          <type>\Math_BigInteger</type>
        </argument>
        <argument line="0">
          <name>$n</name>
          <default></default>
          <type>\Math_BigInteger</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1695" package="Math_BigInteger">
        <name>_slidingWindow</name>
        <full_name>\Math_BigInteger::_slidingWindow()</full_name>
        <docblock line="1695">
          <description>Sliding Window k-ary Modular Exponentiation</description>
          <long-description>Based on {@link http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf#page=27 HAC 14.85} /
{@link http://math.libtomcrypt.com/files/tommath.pdf#page=210 MPM 7.7}.  In a departure from those algorithims,
however, this function performs a modular reduction after every multiplication and squaring operation.
As such, this function has the same preconditions that the reductions being used do.</long-description>
          <tag name="param" description="" line="1695" type="\Math_BigInteger" variable="$e">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="param" description="" line="1695" type="\Math_BigInteger" variable="$n">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="param" description="" line="1695" type="Integer" variable="$mode">
            <type>Integer</type>
          </tag>
          <tag name="return" description="" line="1695" type="\Math_BigInteger">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="access" description="private" line="1695"/>
        </docblock>
        <argument line="0">
          <name>$e</name>
          <default></default>
          <type>\Math_BigInteger</type>
        </argument>
        <argument line="0">
          <name>$n</name>
          <default></default>
          <type>\Math_BigInteger</type>
        </argument>
        <argument line="0">
          <name>$mode</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1770" package="Math_BigInteger">
        <name>_reduce</name>
        <full_name>\Math_BigInteger::_reduce()</full_name>
        <docblock line="1770">
          <description>Modular reduction</description>
          <long-description>For most $modes this will return the remainder.</long-description>
          <tag name="see" description="" line="1770"/>
          <tag name="access" description="private" line="1770"/>
          <tag name="param" description="" line="1770" type="Array" variable="$x">
            <type>Array</type>
          </tag>
          <tag name="param" description="" line="1770" type="Array" variable="$n">
            <type>Array</type>
          </tag>
          <tag name="param" description="" line="1770" type="Integer" variable="$mode">
            <type>Integer</type>
          </tag>
          <tag name="return" description="" line="1770" type="Array">
            <type>Array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$x</name>
          <default></default>
          <type>Array</type>
        </argument>
        <argument line="0">
          <name>$n</name>
          <default></default>
          <type>Array</type>
        </argument>
        <argument line="0">
          <name>$mode</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1807" package="Math_BigInteger">
        <name>_prepareReduce</name>
        <full_name>\Math_BigInteger::_prepareReduce()</full_name>
        <docblock line="1807">
          <description>Modular reduction preperation</description>
          <long-description></long-description>
          <tag name="see" description="" line="1807"/>
          <tag name="access" description="private" line="1807"/>
          <tag name="param" description="" line="1807" type="Array" variable="$x">
            <type>Array</type>
          </tag>
          <tag name="param" description="" line="1807" type="Array" variable="$n">
            <type>Array</type>
          </tag>
          <tag name="param" description="" line="1807" type="Integer" variable="$mode">
            <type>Integer</type>
          </tag>
          <tag name="return" description="" line="1807" type="Array">
            <type>Array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$x</name>
          <default></default>
          <type>Array</type>
        </argument>
        <argument line="0">
          <name>$n</name>
          <default></default>
          <type>Array</type>
        </argument>
        <argument line="0">
          <name>$mode</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1826" package="Math_BigInteger">
        <name>_multiplyReduce</name>
        <full_name>\Math_BigInteger::_multiplyReduce()</full_name>
        <docblock line="1826">
          <description>Modular multiply</description>
          <long-description></long-description>
          <tag name="see" description="" line="1826"/>
          <tag name="access" description="private" line="1826"/>
          <tag name="param" description="" line="1826" type="Array" variable="$x">
            <type>Array</type>
          </tag>
          <tag name="param" description="" line="1826" type="Array" variable="$y">
            <type>Array</type>
          </tag>
          <tag name="param" description="" line="1826" type="Array" variable="$n">
            <type>Array</type>
          </tag>
          <tag name="param" description="" line="1826" type="Integer" variable="$mode">
            <type>Integer</type>
          </tag>
          <tag name="return" description="" line="1826" type="Array">
            <type>Array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$x</name>
          <default></default>
          <type>Array</type>
        </argument>
        <argument line="0">
          <name>$y</name>
          <default></default>
          <type>Array</type>
        </argument>
        <argument line="0">
          <name>$n</name>
          <default></default>
          <type>Array</type>
        </argument>
        <argument line="0">
          <name>$mode</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1845" package="Math_BigInteger">
        <name>_squareReduce</name>
        <full_name>\Math_BigInteger::_squareReduce()</full_name>
        <docblock line="1845">
          <description>Modular square</description>
          <long-description></long-description>
          <tag name="see" description="" line="1845"/>
          <tag name="access" description="private" line="1845"/>
          <tag name="param" description="" line="1845" type="Array" variable="$x">
            <type>Array</type>
          </tag>
          <tag name="param" description="" line="1845" type="Array" variable="$n">
            <type>Array</type>
          </tag>
          <tag name="param" description="" line="1845" type="Integer" variable="$mode">
            <type>Integer</type>
          </tag>
          <tag name="return" description="" line="1845" type="Array">
            <type>Array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$x</name>
          <default></default>
          <type>Array</type>
        </argument>
        <argument line="0">
          <name>$n</name>
          <default></default>
          <type>Array</type>
        </argument>
        <argument line="0">
          <name>$mode</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1864" package="Math_BigInteger">
        <name>_mod2</name>
        <full_name>\Math_BigInteger::_mod2()</full_name>
        <docblock line="1864">
          <description>Modulos for Powers of Two</description>
          <long-description>Calculates $x%$n, where $n = 2**$e, for some $e.  Since this is basically the same as doing $x &amp; ($n-1),
we'll just use this function as a wrapper for doing that.</long-description>
          <tag name="see" description="" line="1864"/>
          <tag name="access" description="private" line="1864"/>
          <tag name="param" description="" line="1864" type="\Math_BigInteger" variable="">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="return" description="" line="1864" type="\Math_BigInteger">
            <type>\Math_BigInteger</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$n</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1895" package="Math_BigInteger">
        <name>_barrett</name>
        <full_name>\Math_BigInteger::_barrett()</full_name>
        <docblock line="1895">
          <description>Barrett Modular Reduction</description>
          <long-description>See {@link http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf#page=14 HAC 14.3.3} /
{@link http://math.libtomcrypt.com/files/tommath.pdf#page=165 MPM 6.2.5} for more information.  Modified slightly,
so as not to require negative numbers (initially, this script didn't support negative numbers).

Employs "folding", as described at
{@link http://www.cosic.esat.kuleuven.be/publications/thesis-149.pdf#page=66 thesis-149.pdf#page=66}.  To quote from
it, "the idea [behind folding] is to find a value x' such that x (mod m) = x' (mod m), with x' being smaller than x."

Unfortunately, the "Barrett Reduction with Folding" algorithm described in thesis-149.pdf is not, as written, all that
usable on account of (1) its not using reasonable radix points as discussed in
{@link http://math.libtomcrypt.com/files/tommath.pdf#page=162 MPM 6.2.2} and (2) the fact that, even with reasonable
radix points, it only works when there are an even number of digits in the denominator.  The reason for (2) is that
(x &gt;&gt; 1) + (x &gt;&gt; 1) != x / 2 + x / 2.  If x is even, they're the same, but if x is odd, they're not.  See the in-line
comments for details.</long-description>
          <tag name="see" description="" line="1895"/>
          <tag name="access" description="private" line="1895"/>
          <tag name="param" description="" line="1895" type="Array" variable="$n">
            <type>Array</type>
          </tag>
          <tag name="param" description="" line="1895" type="Array" variable="$m">
            <type>Array</type>
          </tag>
          <tag name="return" description="" line="1895" type="Array">
            <type>Array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$n</name>
          <default></default>
          <type>Array</type>
        </argument>
        <argument line="0">
          <name>$m</name>
          <default></default>
          <type>Array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1992" package="Math_BigInteger">
        <name>_regularBarrett</name>
        <full_name>\Math_BigInteger::_regularBarrett()</full_name>
        <docblock line="1992">
          <description>(Regular) Barrett Modular Reduction</description>
          <long-description>For numbers with more than four digits Math_BigInteger::_barrett() is faster.  The difference between that and this
is that this function does not fold the denominator into a smaller form.</long-description>
          <tag name="see" description="" line="1992"/>
          <tag name="access" description="private" line="1992"/>
          <tag name="param" description="" line="1992" type="Array" variable="$x">
            <type>Array</type>
          </tag>
          <tag name="param" description="" line="1992" type="Array" variable="$n">
            <type>Array</type>
          </tag>
          <tag name="return" description="" line="1992" type="Array">
            <type>Array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$x</name>
          <default></default>
          <type>Array</type>
        </argument>
        <argument line="0">
          <name>$n</name>
          <default></default>
          <type>Array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2065" package="Math_BigInteger">
        <name>_multiplyLower</name>
        <full_name>\Math_BigInteger::_multiplyLower()</full_name>
        <docblock line="2065">
          <description>Performs long multiplication up to $stop digits</description>
          <long-description>If you're going to be doing array_slice($product-&gt;value, 0, $stop), some cycles can be saved.</long-description>
          <tag name="see" description="" line="2065"/>
          <tag name="param" description="" line="2065" type="Array" variable="$x_value">
            <type>Array</type>
          </tag>
          <tag name="param" description="" line="2065" type="Boolean" variable="$x_negative">
            <type>Boolean</type>
          </tag>
          <tag name="param" description="" line="2065" type="Array" variable="$y_value">
            <type>Array</type>
          </tag>
          <tag name="param" description="" line="2065" type="Boolean" variable="$y_negative">
            <type>Boolean</type>
          </tag>
          <tag name="return" description="" line="2065" type="Array">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="2065"/>
        </docblock>
        <argument line="0">
          <name>$x_value</name>
          <default></default>
          <type>Array</type>
        </argument>
        <argument line="0">
          <name>$x_negative</name>
          <default></default>
          <type>Boolean</type>
        </argument>
        <argument line="0">
          <name>$y_value</name>
          <default></default>
          <type>Array</type>
        </argument>
        <argument line="0">
          <name>$y_negative</name>
          <default></default>
          <type>Boolean</type>
        </argument>
        <argument line="0">
          <name>$stop</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2144" package="Math_BigInteger">
        <name>_montgomery</name>
        <full_name>\Math_BigInteger::_montgomery()</full_name>
        <docblock line="2144">
          <description>Montgomery Modular Reduction</description>
          <long-description>($x-&gt;_prepMontgomery($n))-&gt;_montgomery($n) yields $x % $n.
{@link http://math.libtomcrypt.com/files/tommath.pdf#page=170 MPM 6.3} provides insights on how this can be
improved upon (basically, by using the comba method).  gcd($n, 2) must be equal to one for this function
to work correctly.</long-description>
          <tag name="see" description="" line="2144"/>
          <tag name="see" description="" line="2144"/>
          <tag name="access" description="private" line="2144"/>
          <tag name="param" description="" line="2144" type="Array" variable="$x">
            <type>Array</type>
          </tag>
          <tag name="param" description="" line="2144" type="Array" variable="$n">
            <type>Array</type>
          </tag>
          <tag name="return" description="" line="2144" type="Array">
            <type>Array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$x</name>
          <default></default>
          <type>Array</type>
        </argument>
        <argument line="0">
          <name>$n</name>
          <default></default>
          <type>Array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2192" package="Math_BigInteger">
        <name>_montgomeryMultiply</name>
        <full_name>\Math_BigInteger::_montgomeryMultiply()</full_name>
        <docblock line="2192">
          <description>Montgomery Multiply</description>
          <long-description>Interleaves the montgomery reduction and long multiplication algorithms together as described in
{@link http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf#page=13 HAC 14.36}</long-description>
          <tag name="see" description="" line="2192"/>
          <tag name="see" description="" line="2192"/>
          <tag name="access" description="private" line="2192"/>
          <tag name="param" description="" line="2192" type="Array" variable="$x">
            <type>Array</type>
          </tag>
          <tag name="param" description="" line="2192" type="Array" variable="$y">
            <type>Array</type>
          </tag>
          <tag name="param" description="" line="2192" type="Array" variable="$m">
            <type>Array</type>
          </tag>
          <tag name="return" description="" line="2192" type="Array">
            <type>Array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$x</name>
          <default></default>
          <type>Array</type>
        </argument>
        <argument line="0">
          <name>$y</name>
          <default></default>
          <type>Array</type>
        </argument>
        <argument line="0">
          <name>$m</name>
          <default></default>
          <type>Array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2238" package="Math_BigInteger">
        <name>_prepMontgomery</name>
        <full_name>\Math_BigInteger::_prepMontgomery()</full_name>
        <docblock line="2238">
          <description>Prepare a number for use in Montgomery Modular Reductions</description>
          <long-description></long-description>
          <tag name="see" description="" line="2238"/>
          <tag name="see" description="" line="2238"/>
          <tag name="access" description="private" line="2238"/>
          <tag name="param" description="" line="2238" type="Array" variable="$x">
            <type>Array</type>
          </tag>
          <tag name="param" description="" line="2238" type="Array" variable="$n">
            <type>Array</type>
          </tag>
          <tag name="return" description="" line="2238" type="Array">
            <type>Array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$x</name>
          <default></default>
          <type>Array</type>
        </argument>
        <argument line="0">
          <name>$n</name>
          <default></default>
          <type>Array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2275" package="Math_BigInteger">
        <name>_modInverse67108864</name>
        <full_name>\Math_BigInteger::_modInverse67108864()</full_name>
        <docblock line="2275">
          <description>Modular Inverse of a number mod 2**26 (eg. 67108864)</description>
          <long-description>Based off of the bnpInvDigit function implemented and justified in the following URL:

{@link http://www-cs-students.stanford.edu/~tjw/jsbn/jsbn.js}

The following URL provides more info:

{@link http://groups.google.com/group/sci.crypt/msg/7a137205c1be7d85}

As for why we do all the bitmasking...  strange things can happen when converting from floats to ints. For
instance, on some computers, var_dump((int) -4294967297) yields int(-1) and on others, it yields
int(-2147483648).  To avoid problems stemming from this, we use bitmasks to guarantee that ints aren't
auto-converted to floats.  The outermost bitmask is present because without it, there's no guarantee that
the "residue" returned would be the so-called "common residue".  We use fmod, in the last step, because the
maximum possible $x is 26 bits and the maximum $result is 16 bits.  Thus, we have to be able to handle up to
40 bits, which only 64-bit floating points will support.

Thanks to Pedro Gimeno Fortea for input!</long-description>
          <tag name="see" description="" line="2275"/>
          <tag name="access" description="private" line="2275"/>
          <tag name="param" description="" line="2275" type="Array" variable="$x">
            <type>Array</type>
          </tag>
          <tag name="return" description="" line="2275" type="Integer">
            <type>Integer</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$x</name>
          <default></default>
          <type>Array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2381" package="Math_BigInteger">
        <name>extendedGCD</name>
        <full_name>\Math_BigInteger::extendedGCD()</full_name>
        <docblock line="2381">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$n</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2512" package="Math_BigInteger">
        <name>gcd</name>
        <full_name>\Math_BigInteger::gcd()</full_name>
        <docblock line="2512">
          <description>Calculates the greatest common divisor</description>
          <long-description>Say you have 693 and 609.  The GCD is 21.

Here's an example:
&lt;code&gt;
&lt;?php
   include('Math/BigInteger.php');

   $a = new Math_BigInteger(693);
   $b = new Math_BigInteger(609);

   $gcd = a-&gt;extendedGCD($b);

   echo $gcd-&gt;toString() . "\r\n"; // outputs 21
?&gt;
&lt;/code&gt;</long-description>
          <tag name="param" description="" line="2512" type="\Math_BigInteger" variable="$n">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="return" description="" line="2512" type="\Math_BigInteger">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="access" description="public" line="2512"/>
        </docblock>
        <argument line="0">
          <name>$n</name>
          <default></default>
          <type>\Math_BigInteger</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2524" package="Math_BigInteger">
        <name>abs</name>
        <full_name>\Math_BigInteger::abs()</full_name>
        <docblock line="2524">
          <description>Absolute value.</description>
          <long-description></long-description>
          <tag name="return" description="" line="2524" type="\Math_BigInteger">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="access" description="public" line="2524"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2583" package="Math_BigInteger">
        <name>_compare</name>
        <full_name>\Math_BigInteger::_compare()</full_name>
        <docblock line="2583">
          <description>Compares two numbers.</description>
          <long-description></long-description>
          <tag name="param" description="" line="2583" type="Array" variable="$x_value">
            <type>Array</type>
          </tag>
          <tag name="param" description="" line="2583" type="Boolean" variable="$x_negative">
            <type>Boolean</type>
          </tag>
          <tag name="param" description="" line="2583" type="Array" variable="$y_value">
            <type>Array</type>
          </tag>
          <tag name="param" description="" line="2583" type="Boolean" variable="$y_negative">
            <type>Boolean</type>
          </tag>
          <tag name="return" description="" line="2583" type="Integer">
            <type>Integer</type>
          </tag>
          <tag name="see" description="" line="2583"/>
          <tag name="access" description="private" line="2583"/>
        </docblock>
        <argument line="0">
          <name>$x_value</name>
          <default></default>
          <type>Array</type>
        </argument>
        <argument line="0">
          <name>$x_negative</name>
          <default></default>
          <type>Boolean</type>
        </argument>
        <argument line="0">
          <name>$y_value</name>
          <default></default>
          <type>Array</type>
        </argument>
        <argument line="0">
          <name>$y_negative</name>
          <default></default>
          <type>Boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2618" package="Math_BigInteger">
        <name>equals</name>
        <full_name>\Math_BigInteger::equals()</full_name>
        <docblock line="2618">
          <description>Tests the equality of two numbers.</description>
          <long-description>If you need to see if one number is greater than or less than another number, use Math_BigInteger::compare()</long-description>
          <tag name="param" description="" line="2618" type="\Math_BigInteger" variable="$x">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="return" description="" line="2618" type="Boolean">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="public" line="2618"/>
          <tag name="see" description="" line="2618"/>
        </docblock>
        <argument line="0">
          <name>$x</name>
          <default></default>
          <type>\Math_BigInteger</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2638" package="Math_BigInteger">
        <name>setPrecision</name>
        <full_name>\Math_BigInteger::setPrecision()</full_name>
        <docblock line="2638">
          <description>Set Precision</description>
          <long-description>Some bitwise operations give different results depending on the precision being used.  Examples include left
shift, not, and rotates.</long-description>
          <tag name="param" description="" line="2638" type="\Math_BigInteger" variable="$x">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="access" description="public" line="2638"/>
          <tag name="return" description="" line="2638" type="\Math_BigInteger">
            <type>\Math_BigInteger</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$bits</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2893" package="Math_BigInteger">
        <name>bitwise_leftRotate</name>
        <full_name>\Math_BigInteger::bitwise_leftRotate()</full_name>
        <docblock line="2893">
          <description>Logical Left Rotate</description>
          <long-description>Instead of the top x bits being dropped they're appended to the shifted bit string.</long-description>
          <tag name="param" description="" line="2893" type="Integer" variable="$shift">
            <type>Integer</type>
          </tag>
          <tag name="return" description="" line="2893" type="\Math_BigInteger">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="access" description="public" line="2893"/>
        </docblock>
        <argument line="0">
          <name>$shift</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2937" package="Math_BigInteger">
        <name>bitwise_rightRotate</name>
        <full_name>\Math_BigInteger::bitwise_rightRotate()</full_name>
        <docblock line="2937">
          <description>Logical Right Rotate</description>
          <long-description>Instead of the bottom x bits being dropped they're prepended to the shifted bit string.</long-description>
          <tag name="param" description="" line="2937" type="Integer" variable="$shift">
            <type>Integer</type>
          </tag>
          <tag name="return" description="" line="2937" type="\Math_BigInteger">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="access" description="public" line="2937"/>
        </docblock>
        <argument line="0">
          <name>$shift</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2956" package="Math_BigInteger">
        <name>setRandomGenerator</name>
        <full_name>\Math_BigInteger::setRandomGenerator()</full_name>
        <docblock line="2956">
          <description>Set random number generator function</description>
          <long-description>$generator should be the name of a random generating function whose first parameter is the minimum
value and whose second parameter is the maximum value.  If this function needs to be seeded, it should
be seeded prior to calling Math_BigInteger::random() or Math_BigInteger::randomPrime()

If the random generating function is not explicitly set, it'll be assumed to be mt_rand().</long-description>
          <tag name="see" description="" line="2956"/>
          <tag name="see" description="" line="2956"/>
          <tag name="param" description="&lt;p&gt;String $generator&lt;/p&gt;&#10;" line="2956" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="access" description="public" line="2956"/>
        </docblock>
        <argument line="0">
          <name>$generator</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2969" package="Math_BigInteger">
        <name>random</name>
        <full_name>\Math_BigInteger::random()</full_name>
        <docblock line="2969">
          <description>Generate a random number</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Integer $min&lt;/p&gt;&#10;" line="2969" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Integer $max&lt;/p&gt;&#10;" line="2969" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="2969" type="\Math_BigInteger">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="access" description="public" line="2969"/>
        </docblock>
        <argument line="0">
          <name>$min</name>
          <default>false</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$max</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="3134" package="Math_BigInteger">
        <name>_make_odd</name>
        <full_name>\Math_BigInteger::_make_odd()</full_name>
        <docblock line="3134">
          <description>Make the current number odd</description>
          <long-description>If the current number is odd it'll be unchanged.  If it's even, one will be added to it.</long-description>
          <tag name="see" description="" line="3134"/>
          <tag name="access" description="private" line="3134"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="3310" package="Math_BigInteger">
        <name>_lshift</name>
        <full_name>\Math_BigInteger::_lshift()</full_name>
        <docblock line="3310">
          <description>Logical Left Shift</description>
          <long-description>Shifts BigInteger's by $shift bits.</long-description>
          <tag name="param" description="" line="3310" type="Integer" variable="$shift">
            <type>Integer</type>
          </tag>
          <tag name="access" description="private" line="3310"/>
        </docblock>
        <argument line="0">
          <name>$shift</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="3345" package="Math_BigInteger">
        <name>_rshift</name>
        <full_name>\Math_BigInteger::_rshift()</full_name>
        <docblock line="3345">
          <description>Logical Right Shift</description>
          <long-description>Shifts BigInteger's by $shift bits.</long-description>
          <tag name="param" description="" line="3345" type="Integer" variable="$shift">
            <type>Integer</type>
          </tag>
          <tag name="access" description="private" line="3345"/>
        </docblock>
        <argument line="0">
          <name>$shift</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="3381" package="Math_BigInteger">
        <name>_normalize</name>
        <full_name>\Math_BigInteger::_normalize()</full_name>
        <docblock line="3381">
          <description>Normalize</description>
          <long-description>Removes leading zeros and truncates (if necessary) to maintain the appropriate precision</long-description>
          <tag name="param" description="" line="3381" type="\Math_BigInteger" variable="">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="return" description="" line="3381" type="\Math_BigInteger">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="see" description="" line="3381"/>
          <tag name="access" description="private" line="3381"/>
        </docblock>
        <argument line="0">
          <name>$result</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="3429" package="Math_BigInteger">
        <name>_trim</name>
        <full_name>\Math_BigInteger::_trim()</full_name>
        <docblock line="3429">
          <description>Trim</description>
          <long-description>Removes leading zeros</long-description>
          <tag name="return" description="" line="3429" type="\Math_BigInteger">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="access" description="private" line="3429"/>
        </docblock>
        <argument line="0">
          <name>$value</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="3449" package="Math_BigInteger">
        <name>_array_repeat</name>
        <full_name>\Math_BigInteger::_array_repeat()</full_name>
        <docblock line="3449">
          <description>Array Repeat</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Array&lt;/p&gt;" line="3449" type="" variable="$input"/>
          <tag name="param" description="&lt;p&gt;mixed&lt;/p&gt;" line="3449" type="" variable="$multiplier"/>
          <tag name="return" description="" line="3449" type="Array">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="3449"/>
        </docblock>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>mixed</type>
        </argument>
        <argument line="0">
          <name>$multiplier</name>
          <default></default>
          <type>mixed</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="3464" package="Math_BigInteger">
        <name>_base256_lshift</name>
        <full_name>\Math_BigInteger::_base256_lshift()</full_name>
        <docblock line="3464">
          <description>Logical Left Shift</description>
          <long-description>Shifts binary strings $shift bits, essentially multiplying by 2**$shift.</long-description>
          <tag name="param" description="&lt;p&gt;String&lt;/p&gt;" line="3464" type="" variable="$x"/>
          <tag name="param" description="&lt;p&gt;Integer&lt;/p&gt;" line="3464" type="" variable="$shift"/>
          <tag name="return" description="" line="3464" type="String">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="3464"/>
        </docblock>
        <argument line="0">
          <name>$x</name>
          <default></default>
          <type>mixed</type>
        </argument>
        <argument line="0">
          <name>$shift</name>
          <default></default>
          <type>mixed</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="3493" package="Math_BigInteger">
        <name>_base256_rshift</name>
        <full_name>\Math_BigInteger::_base256_rshift()</full_name>
        <docblock line="3493">
          <description>Logical Right Shift</description>
          <long-description>Shifts binary strings $shift bits, essentially dividing by 2**$shift and returning the remainder.</long-description>
          <tag name="param" description="&lt;p&gt;String&lt;/p&gt;" line="3493" type="" variable="$x"/>
          <tag name="param" description="&lt;p&gt;Integer&lt;/p&gt;" line="3493" type="" variable="$shift"/>
          <tag name="return" description="" line="3493" type="String">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="3493"/>
        </docblock>
        <argument line="0">
          <name>$x</name>
          <default></default>
          <type>mixed</type>
        </argument>
        <argument line="0">
          <name>$shift</name>
          <default></default>
          <type>mixed</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="3534" package="Math_BigInteger">
        <name>_int2bytes</name>
        <full_name>\Math_BigInteger::_int2bytes()</full_name>
        <docblock line="3534">
          <description>Converts 32-bit integers to bytes.</description>
          <long-description></long-description>
          <tag name="param" description="" line="3534" type="Integer" variable="$x">
            <type>Integer</type>
          </tag>
          <tag name="return" description="" line="3534" type="String">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="3534"/>
        </docblock>
        <argument line="0">
          <name>$x</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="3546" package="Math_BigInteger">
        <name>_bytes2int</name>
        <full_name>\Math_BigInteger::_bytes2int()</full_name>
        <docblock line="3546">
          <description>Converts bytes to 32-bit integers</description>
          <long-description></long-description>
          <tag name="param" description="" line="3546" type="String" variable="$x">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="3546" type="Integer">
            <type>Integer</type>
          </tag>
          <tag name="access" description="private" line="3546"/>
        </docblock>
        <argument line="0">
          <name>$x</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/3rdParty/phpseclib/Crypt/RSA.php" generated-path="lib.3rdParty.phpseclib.Crypt.RSA.html" hash="a09946ef8877e3df4470fbba3e49467f" package="Crypt_RSA">
    <docblock line="0">
      <description>Pure-PHP PKCS#1 (v2.1) compliant implementation of RSA.</description>
      <long-description>PHP versions 4 and 5

Here's an example of how to encrypt and decrypt text with this library:
&lt;code&gt;
&lt;?php
   include('Crypt/RSA.php');

   $rsa = new Crypt_RSA();
   extract($rsa-&gt;createKey());

   $plaintext = 'terrafrost';

   $rsa-&gt;loadKey($privatekey);
   $ciphertext = $rsa-&gt;encrypt($plaintext);

   $rsa-&gt;loadKey($publickey);
   echo $rsa-&gt;decrypt($ciphertext);
?&gt;
&lt;/code&gt;

Here's an example of how to create signatures and verify signatures with this library:
&lt;code&gt;
&lt;?php
   include('Crypt/RSA.php');

   $rsa = new Crypt_RSA();
   extract($rsa-&gt;createKey());

   $plaintext = 'terrafrost';

   $rsa-&gt;loadKey($privatekey);
   $signature = $rsa-&gt;sign($plaintext);

   $rsa-&gt;loadKey($publickey);
   echo $rsa-&gt;verify($plaintext, $signature) ? 'verified' : 'unverified';
?&gt;
&lt;/code&gt;

LICENSE: Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.</long-description>
      <tag name="category" description="Crypt" line="0"/>
      <tag name="package" description="Crypt_RSA" line="0"/>
      <tag name="author" description="Jim Wigginton &amp;lt;terrafrost@php.net&amp;gt;" line="0"/>
      <tag name="copyright" description="MMIX Jim Wigginton" line="0"/>
      <tag name="license" description="MIT License" line="0" link="http://www.opensource.org/licenses/mit-license.html"/>
      <tag name="version" description="$Id: RSA.php 4105 2011-05-19 18:02:11Z gruberroland $" line="0"/>
      <tag name="link" description="http://phpseclib.sourceforge.net" line="0"/>
    </docblock>
    <constant namespace="" line="101" package="Crypt_RSA">
      <name>CRYPT_RSA_ENCRYPTION_OAEP</name>
      <full_name>\\CRYPT_RSA_ENCRYPTION_OAEP</full_name>
      <value>1</value>
      <docblock line="101">
        <description>Use {@link http://en.wikipedia.org/wiki/Optimal_Asymmetric_Encryption_Padding Optimal Asymmetric Encryption Padding}
(OAEP) for encryption / decryption.</description>
        <long-description>Uses sha1 by default.</long-description>
        <tag name="see" description="" line="101"/>
        <tag name="see" description="" line="101"/>
      </docblock>
    </constant>
    <constant namespace="" line="108" package="Crypt_RSA">
      <name>CRYPT_RSA_ENCRYPTION_PKCS1</name>
      <full_name>\\CRYPT_RSA_ENCRYPTION_PKCS1</full_name>
      <value>2</value>
      <docblock line="108">
        <description>Use PKCS#1 padding.</description>
        <long-description>Although CRYPT_RSA_ENCRYPTION_OAEP offers more security, including PKCS#1 padding is necessary for purposes of backwards
compatability with protocols (like SSH-1) written before OAEP's introduction.</long-description>
      </docblock>
    </constant>
    <constant namespace="" line="125" package="Crypt_RSA">
      <name>CRYPT_RSA_SIGNATURE_PSS</name>
      <full_name>\\CRYPT_RSA_SIGNATURE_PSS</full_name>
      <value>1</value>
      <docblock line="125">
        <description>Use the Probabilistic Signature Scheme for signing</description>
        <long-description>Uses sha1 by default.</long-description>
        <tag name="see" description="" line="125"/>
        <tag name="see" description="" line="125"/>
      </docblock>
    </constant>
    <constant namespace="" line="132" package="Crypt_RSA">
      <name>CRYPT_RSA_SIGNATURE_PKCS1</name>
      <full_name>\\CRYPT_RSA_SIGNATURE_PKCS1</full_name>
      <value>2</value>
      <docblock line="132">
        <description>Use the PKCS#1 scheme by default.</description>
        <long-description>Although CRYPT_RSA_SIGNATURE_PSS offers more security, including PKCS#1 signing is necessary for purposes of backwards
compatability with protocols (like SSH-2) written before PSS's introduction.</long-description>
      </docblock>
    </constant>
    <constant namespace="" line="142" package="Crypt_RSA">
      <name>CRYPT_RSA_ASN1_INTEGER</name>
      <full_name>\\CRYPT_RSA_ASN1_INTEGER</full_name>
      <value>2</value>
      <docblock line="142">
        <description>ASN1 Integer</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="146" package="Crypt_RSA">
      <name>CRYPT_RSA_ASN1_SEQUENCE</name>
      <full_name>\\CRYPT_RSA_ASN1_SEQUENCE</full_name>
      <value>48</value>
      <docblock line="146">
        <description>ASN1 Sequence (with the constucted bit set)</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="156" package="Crypt_RSA">
      <name>CRYPT_RSA_MODE_INTERNAL</name>
      <full_name>\\CRYPT_RSA_MODE_INTERNAL</full_name>
      <value>1</value>
      <docblock line="156">
        <description>To use the pure-PHP implementation</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="162" package="Crypt_RSA">
      <name>CRYPT_RSA_MODE_OPENSSL</name>
      <full_name>\\CRYPT_RSA_MODE_OPENSSL</full_name>
      <value>2</value>
      <docblock line="162">
        <description>To use the OpenSSL library</description>
        <long-description>(if enabled; otherwise, the internal implementation will be used)</long-description>
      </docblock>
    </constant>
    <constant namespace="" line="175" package="Crypt_RSA">
      <name>CRYPT_RSA_PRIVATE_FORMAT_PKCS1</name>
      <full_name>\\CRYPT_RSA_PRIVATE_FORMAT_PKCS1</full_name>
      <value>0</value>
      <docblock line="175">
        <description>PKCS#1 formatted private key</description>
        <long-description>Used by OpenSSH</long-description>
      </docblock>
    </constant>
    <constant namespace="" line="179" package="Crypt_RSA">
      <name>CRYPT_RSA_PRIVATE_FORMAT_PUTTY</name>
      <full_name>\\CRYPT_RSA_PRIVATE_FORMAT_PUTTY</full_name>
      <value>1</value>
      <docblock line="179">
        <description>PuTTY formatted private key</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="183" package="Crypt_RSA">
      <name>CRYPT_RSA_PRIVATE_FORMAT_XML</name>
      <full_name>\\CRYPT_RSA_PRIVATE_FORMAT_XML</full_name>
      <value>2</value>
      <docblock line="183">
        <description>XML formatted private key</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="204" package="Crypt_RSA">
      <name>CRYPT_RSA_PUBLIC_FORMAT_RAW</name>
      <full_name>\\CRYPT_RSA_PUBLIC_FORMAT_RAW</full_name>
      <value>3</value>
      <docblock line="204">
        <description>Raw public key</description>
        <long-description>An array containing two Math_BigInteger objects.

The exponent can be indexed with any of the following:

0, e, exponent, publicExponent

The modulus can be indexed with any of the following:

1, n, modulo, modulus</long-description>
      </docblock>
    </constant>
    <constant namespace="" line="208" package="Crypt_RSA">
      <name>CRYPT_RSA_PUBLIC_FORMAT_PKCS1</name>
      <full_name>\\CRYPT_RSA_PUBLIC_FORMAT_PKCS1</full_name>
      <value>4</value>
      <docblock line="208">
        <description>PKCS#1 formatted public key</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="212" package="Crypt_RSA">
      <name>CRYPT_RSA_PUBLIC_FORMAT_XML</name>
      <full_name>\\CRYPT_RSA_PUBLIC_FORMAT_XML</full_name>
      <value>5</value>
      <docblock line="212">
        <description>XML formatted public key</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="218" package="Crypt_RSA">
      <name>CRYPT_RSA_PUBLIC_FORMAT_OPENSSH</name>
      <full_name>\\CRYPT_RSA_PUBLIC_FORMAT_OPENSSH</full_name>
      <value>6</value>
      <docblock line="218">
        <description>OpenSSH formatted public key</description>
        <long-description>Place in $HOME/.ssh/authorized_keys</long-description>
      </docblock>
    </constant>
    <constant namespace="" line="432" package="Crypt_RSA">
      <name>CRYPT_RSA_MODE</name>
      <full_name>\\CRYPT_RSA_MODE</full_name>
      <value>CRYPT_RSA_MODE_INTERNAL</value>
      <docblock line="432">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="484" package="Crypt_RSA">
      <name>CRYPT_RSA_EXPONENT</name>
      <full_name>\\CRYPT_RSA_EXPONENT</full_name>
      <value>'65537'</value>
      <docblock line="484">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="487" package="Crypt_RSA">
      <name>CRYPT_RSA_COMMENT</name>
      <full_name>\\CRYPT_RSA_COMMENT</full_name>
      <value>'phpseclib-generated-key'</value>
      <docblock line="487">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="492" package="Crypt_RSA">
      <name>CRYPT_RSA_SMALLEST_PRIME</name>
      <full_name>\\CRYPT_RSA_SMALLEST_PRIME</full_name>
      <value>4096</value>
      <docblock line="492">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <class final="false" abstract="false" namespace="" line="229" package="Crypt_RSA">
      <extends/>
      <name>Crypt_RSA</name>
      <full_name>\Crypt_RSA</full_name>
      <docblock line="229">
        <description>Pure-PHP PKCS#1 compliant implementation of RSA.</description>
        <long-description></long-description>
        <tag name="author" description="Jim Wigginton &amp;lt;terrafrost@php.net&amp;gt;" line="229"/>
        <tag name="version" description="" line="229"/>
        <tag name="access" description="public" line="229"/>
        <tag name="package" description="Crypt_RSA" line="229"/>
      </docblock>
      <property static="false" visibility="public" line="236" namespace="" package="Crypt_RSA">
        <name>$zero</name>
        <default></default>
        <docblock line="236">
          <description>Precomputed Zero</description>
          <long-description></long-description>
          <tag name="var" description="" line="236" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="236"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="244" namespace="" package="Crypt_RSA">
        <name>$one</name>
        <default></default>
        <docblock line="244">
          <description>Precomputed One</description>
          <long-description></long-description>
          <tag name="var" description="" line="244" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="244"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="252" namespace="" package="Crypt_RSA">
        <name>$privateKeyFormat</name>
        <default>CRYPT_RSA_PRIVATE_FORMAT_PKCS1</default>
        <docblock line="252">
          <description>Private Key Format</description>
          <long-description></long-description>
          <tag name="var" description="" line="252" type="Integer" variable="">
            <type>Integer</type>
          </tag>
          <tag name="access" description="private" line="252"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="260" namespace="" package="Crypt_RSA">
        <name>$publicKeyFormat</name>
        <default>CRYPT_RSA_PUBLIC_FORMAT_PKCS1</default>
        <docblock line="260">
          <description>Public Key Format</description>
          <long-description></long-description>
          <tag name="var" description="" line="260" type="Integer" variable="">
            <type>Integer</type>
          </tag>
          <tag name="access" description="public" line="260"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="268" namespace="" package="Crypt_RSA">
        <name>$modulus</name>
        <default></default>
        <docblock line="268">
          <description>Modulus (ie. n)</description>
          <long-description></long-description>
          <tag name="var" description="" line="268" type="\Math_BigInteger" variable="">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="access" description="private" line="268"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="276" namespace="" package="Crypt_RSA">
        <name>$k</name>
        <default></default>
        <docblock line="276">
          <description>Modulus length</description>
          <long-description></long-description>
          <tag name="var" description="" line="276" type="\Math_BigInteger" variable="">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="access" description="private" line="276"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="284" namespace="" package="Crypt_RSA">
        <name>$exponent</name>
        <default></default>
        <docblock line="284">
          <description>Exponent (ie. e or d)</description>
          <long-description></long-description>
          <tag name="var" description="" line="284" type="\Math_BigInteger" variable="">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="access" description="private" line="284"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="292" namespace="" package="Crypt_RSA">
        <name>$primes</name>
        <default></default>
        <docblock line="292">
          <description>Primes for Chinese Remainder Theorem (ie. p and q)</description>
          <long-description></long-description>
          <tag name="var" description="" line="292" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="292"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="300" namespace="" package="Crypt_RSA">
        <name>$exponents</name>
        <default></default>
        <docblock line="300">
          <description>Exponents for Chinese Remainder Theorem (ie. dP and dQ)</description>
          <long-description></long-description>
          <tag name="var" description="" line="300" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="300"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="308" namespace="" package="Crypt_RSA">
        <name>$coefficients</name>
        <default></default>
        <docblock line="308">
          <description>Coefficients for Chinese Remainder Theorem (ie. qInv)</description>
          <long-description></long-description>
          <tag name="var" description="" line="308" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="308"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="316" namespace="" package="Crypt_RSA">
        <name>$hashName</name>
        <default></default>
        <docblock line="316">
          <description>Hash name</description>
          <long-description></long-description>
          <tag name="var" description="" line="316" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="316"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="324" namespace="" package="Crypt_RSA">
        <name>$hash</name>
        <default></default>
        <docblock line="324">
          <description>Hash function</description>
          <long-description></long-description>
          <tag name="var" description="" line="324" type="\Crypt_Hash" variable="">
            <type>\Crypt_Hash</type>
          </tag>
          <tag name="access" description="private" line="324"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="332" namespace="" package="Crypt_RSA">
        <name>$hLen</name>
        <default></default>
        <docblock line="332">
          <description>Length of hash function output</description>
          <long-description></long-description>
          <tag name="var" description="" line="332" type="Integer" variable="">
            <type>Integer</type>
          </tag>
          <tag name="access" description="private" line="332"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="340" namespace="" package="Crypt_RSA">
        <name>$sLen</name>
        <default></default>
        <docblock line="340">
          <description>Length of salt</description>
          <long-description></long-description>
          <tag name="var" description="" line="340" type="Integer" variable="">
            <type>Integer</type>
          </tag>
          <tag name="access" description="private" line="340"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="348" namespace="" package="Crypt_RSA">
        <name>$mgfHash</name>
        <default></default>
        <docblock line="348">
          <description>Hash function for the Mask Generation Function</description>
          <long-description></long-description>
          <tag name="var" description="" line="348" type="\Crypt_Hash" variable="">
            <type>\Crypt_Hash</type>
          </tag>
          <tag name="access" description="private" line="348"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="356" namespace="" package="Crypt_RSA">
        <name>$mgfHLen</name>
        <default></default>
        <docblock line="356">
          <description>Length of MGF hash function output</description>
          <long-description></long-description>
          <tag name="var" description="" line="356" type="Integer" variable="">
            <type>Integer</type>
          </tag>
          <tag name="access" description="private" line="356"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="364" namespace="" package="Crypt_RSA">
        <name>$encryptionMode</name>
        <default>CRYPT_RSA_ENCRYPTION_OAEP</default>
        <docblock line="364">
          <description>Encryption mode</description>
          <long-description></long-description>
          <tag name="var" description="" line="364" type="Integer" variable="">
            <type>Integer</type>
          </tag>
          <tag name="access" description="private" line="364"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="372" namespace="" package="Crypt_RSA">
        <name>$signatureMode</name>
        <default>CRYPT_RSA_SIGNATURE_PSS</default>
        <docblock line="372">
          <description>Signature mode</description>
          <long-description></long-description>
          <tag name="var" description="" line="372" type="Integer" variable="">
            <type>Integer</type>
          </tag>
          <tag name="access" description="private" line="372"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="380" namespace="" package="Crypt_RSA">
        <name>$publicExponent</name>
        <default>false</default>
        <docblock line="380">
          <description>Public Exponent</description>
          <long-description></long-description>
          <tag name="var" description="" line="380" type="Mixed" variable="">
            <type>Mixed</type>
          </tag>
          <tag name="access" description="private" line="380"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="388" namespace="" package="Crypt_RSA">
        <name>$password</name>
        <default>''</default>
        <docblock line="388">
          <description>Password</description>
          <long-description></long-description>
          <tag name="var" description="" line="388" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="388"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="400" namespace="" package="Crypt_RSA">
        <name>$components</name>
        <default>array()</default>
        <docblock line="400">
          <description>Components</description>
          <long-description>For use with parsing XML formatted keys.  PHP's XML Parser functions use utilized - instead of PHP's DOM functions -
because PHP's XML Parser functions work on PHP4 whereas PHP's DOM functions - although surperior - don't.</long-description>
          <tag name="see" description="" line="400"/>
          <tag name="var" description="" line="400" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="400"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="412" namespace="" package="Crypt_RSA">
        <name>$current</name>
        <default></default>
        <docblock line="412">
          <description>Current String</description>
          <long-description>For use with parsing XML formatted keys.</long-description>
          <tag name="see" description="" line="412"/>
          <tag name="see" description="" line="412"/>
          <tag name="var" description="" line="412" type="Mixed" variable="">
            <type>Mixed</type>
          </tag>
          <tag name="access" description="private" line="412"/>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="424" package="Crypt_RSA">
        <name>Crypt_RSA</name>
        <full_name>\Crypt_RSA::Crypt_RSA()</full_name>
        <docblock line="424">
          <description>The constructor</description>
          <long-description>If you want to make use of the openssl extension, you'll need to set the mode manually, yourself.  The reason
Crypt_RSA doesn't do it is because OpenSSL doesn't fail gracefully.  openssl_pkey_new(), in particular, requires
openssl.cnf be present somewhere and, unfortunately, the only real way to find out is too late.</long-description>
          <tag name="return" description="" line="424" type="\Crypt_RSA">
            <type>\Crypt_RSA</type>
          </tag>
          <tag name="access" description="public" line="424"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="460" package="Crypt_RSA">
        <name>createKey</name>
        <full_name>\Crypt_RSA::createKey()</full_name>
        <docblock line="460">
          <description>Create public / private key pair</description>
          <long-description>Returns an array with the following three elements:
 - 'privatekey': The private key.
 - 'publickey':  The public key.
 - 'partialkey': A partially computed key (if the execution time exceeded $timeout).
                 Will need to be passed back to Crypt_RSA::createKey() as the third parameter for further processing.</long-description>
          <tag name="access" description="public" line="460"/>
          <tag name="param" description="&lt;p&gt;Integer $bits&lt;/p&gt;&#10;" line="460" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Integer $timeout&lt;/p&gt;&#10;" line="460" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Math_BigInteger $p&lt;/p&gt;&#10;" line="460" type="\optional" variable="">
            <type>\optional</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$bits</name>
          <default>1024</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$timeout</name>
          <default>false</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$partial</name>
          <default>array()</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="633" package="Crypt_RSA">
        <name>_convertPrivateKey</name>
        <full_name>\Crypt_RSA::_convertPrivateKey()</full_name>
        <docblock line="633">
          <description>Convert a private key to the appropriate format.</description>
          <long-description></long-description>
          <tag name="access" description="private" line="633"/>
          <tag name="see" description="" line="633"/>
          <tag name="param" description="" line="633" type="String" variable="$RSAPrivateKey">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="633" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$n</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$e</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$d</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$primes</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$exponents</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$coefficients</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="714" package="Crypt_RSA">
        <name>_convertPublicKey</name>
        <full_name>\Crypt_RSA::_convertPublicKey()</full_name>
        <docblock line="714">
          <description>Convert a public key to the appropriate format</description>
          <long-description></long-description>
          <tag name="access" description="private" line="714"/>
          <tag name="see" description="" line="714"/>
          <tag name="param" description="" line="714" type="String" variable="$RSAPrivateKey">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="714" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$n</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$e</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="765" package="Crypt_RSA">
        <name>_parseKey</name>
        <full_name>\Crypt_RSA::_parseKey()</full_name>
        <docblock line="765">
          <description>Break a public or private key down into its constituant components</description>
          <long-description></long-description>
          <tag name="access" description="private" line="765"/>
          <tag name="see" description="" line="765"/>
          <tag name="see" description="" line="765"/>
          <tag name="param" description="" line="765" type="String" variable="$key">
            <type>String</type>
          </tag>
          <tag name="param" description="" line="765" type="Integer" variable="$type">
            <type>Integer</type>
          </tag>
          <tag name="return" description="" line="765" type="Array">
            <type>Array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$key</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$type</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1078" package="Crypt_RSA">
        <name>_start_element_handler</name>
        <full_name>\Crypt_RSA::_start_element_handler()</full_name>
        <docblock line="1078">
          <description>Start Element Handler</description>
          <long-description>Called by xml_set_element_handler()</long-description>
          <tag name="access" description="private" line="1078"/>
          <tag name="param" description="" line="1078" type="Resource" variable="$parser">
            <type>Resource</type>
          </tag>
          <tag name="param" description="" line="1078" type="String" variable="$name">
            <type>String</type>
          </tag>
          <tag name="param" description="" line="1078" type="Array" variable="$attribs">
            <type>Array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$parser</name>
          <default></default>
          <type>Resource</type>
        </argument>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$attribs</name>
          <default></default>
          <type>Array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1121" package="Crypt_RSA">
        <name>_stop_element_handler</name>
        <full_name>\Crypt_RSA::_stop_element_handler()</full_name>
        <docblock line="1121">
          <description>Stop Element Handler</description>
          <long-description>Called by xml_set_element_handler()</long-description>
          <tag name="access" description="private" line="1121"/>
          <tag name="param" description="" line="1121" type="Resource" variable="$parser">
            <type>Resource</type>
          </tag>
          <tag name="param" description="" line="1121" type="String" variable="$name">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$parser</name>
          <default></default>
          <type>Resource</type>
        </argument>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1139" package="Crypt_RSA">
        <name>_data_handler</name>
        <full_name>\Crypt_RSA::_data_handler()</full_name>
        <docblock line="1139">
          <description>Data Handler</description>
          <long-description>Called by xml_set_character_data_handler()</long-description>
          <tag name="access" description="private" line="1139"/>
          <tag name="param" description="" line="1139" type="Resource" variable="$parser">
            <type>Resource</type>
          </tag>
          <tag name="param" description="" line="1139" type="String" variable="$data">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$parser</name>
          <default></default>
          <type>Resource</type>
        </argument>
        <argument line="0">
          <name>$data</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1156" package="Crypt_RSA">
        <name>loadKey</name>
        <full_name>\Crypt_RSA::loadKey()</full_name>
        <docblock line="1156">
          <description>Loads a public or private key</description>
          <long-description>Returns true on success and false on failure (ie. an incorrect password was provided or the key was malformed)</long-description>
          <tag name="access" description="public" line="1156"/>
          <tag name="param" description="" line="1156" type="String" variable="$key">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;optional&lt;/p&gt;" line="1156" type="Integer" variable="$type">
            <type>Integer</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$key</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$type</name>
          <default>false</default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1210" package="Crypt_RSA">
        <name>setPassword</name>
        <full_name>\Crypt_RSA::setPassword()</full_name>
        <docblock line="1210">
          <description>Sets the password</description>
          <long-description>Private keys can be encrypted with a password.  To unset the password, pass in the empty string or false.
Or rather, pass in $password such that empty($password) is true.</long-description>
          <tag name="see" description="" line="1210"/>
          <tag name="see" description="" line="1210"/>
          <tag name="access" description="public" line="1210"/>
          <tag name="param" description="" line="1210" type="String" variable="$password">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$password</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1234" package="Crypt_RSA">
        <name>setPublicKey</name>
        <full_name>\Crypt_RSA::setPublicKey()</full_name>
        <docblock line="1234">
          <description>Defines the public key</description>
          <long-description>Some private key formats define the public exponent and some don't.  Those that don't define it are problematic when
used in certain contexts.  For example, in SSH-2, RSA authentication works by sending the public key along with a
message signed by the private key to the server.  The SSH-2 server looks the public key up in an index of public keys
and if it's present then proceeds to verify the signature.  Problem is, if your private key doesn't include the public
exponent this won't work unless you manually add the public exponent.

Do note that when a new key is loaded the index will be cleared.

Returns true on success, false on failure</long-description>
          <tag name="see" description="" line="1234"/>
          <tag name="access" description="public" line="1234"/>
          <tag name="param" description="" line="1234" type="String" variable="$key">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;optional&lt;/p&gt;" line="1234" type="Integer" variable="$type">
            <type>Integer</type>
          </tag>
          <tag name="return" description="" line="1234" type="Boolean">
            <type>Boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$key</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$type</name>
          <default>CRYPT_RSA_PUBLIC_FORMAT_PKCS1</default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1260" package="Crypt_RSA">
        <name>getPublicKey</name>
        <full_name>\Crypt_RSA::getPublicKey()</full_name>
        <docblock line="1260">
          <description>Returns the public key</description>
          <long-description>The public key is only returned under two circumstances - if the private key had the public key embedded within it
or if the public key was set via setPublicKey().  If the currently loaded key is supposed to be the public key this
function won't return it since this library, for the most part, doesn't distinguish between public and private keys.</long-description>
          <tag name="see" description="" line="1260"/>
          <tag name="access" description="public" line="1260"/>
          <tag name="param" description="" line="1260" type="String" variable="$key">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;optional&lt;/p&gt;" line="1260" type="Integer" variable="$type">
            <type>Integer</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$type</name>
          <default>CRYPT_RSA_PUBLIC_FORMAT_PKCS1</default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1280" package="Crypt_RSA">
        <name>_generateMinMax</name>
        <full_name>\Crypt_RSA::_generateMinMax()</full_name>
        <docblock line="1280">
          <description>Generates the smallest and largest numbers requiring $bits bits</description>
          <long-description></long-description>
          <tag name="access" description="private" line="1280"/>
          <tag name="param" description="" line="1280" type="Integer" variable="$bits">
            <type>Integer</type>
          </tag>
          <tag name="return" description="" line="1280" type="Array">
            <type>Array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$bits</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1309" package="Crypt_RSA">
        <name>_decodeLength</name>
        <full_name>\Crypt_RSA::_decodeLength()</full_name>
        <docblock line="1309">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$string</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1330" package="Crypt_RSA">
        <name>_encodeLength</name>
        <full_name>\Crypt_RSA::_encodeLength()</full_name>
        <docblock line="1330">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$length</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1350" package="Crypt_RSA">
        <name>_string_shift</name>
        <full_name>\Crypt_RSA::_string_shift()</full_name>
        <docblock line="1350">
          <description>String Shift</description>
          <long-description>Inspired by array_shift</long-description>
          <tag name="param" description="" line="1350" type="String" variable="$string">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Integer $index&lt;/p&gt;&#10;" line="1350" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="1350" type="String">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="1350"/>
        </docblock>
        <argument line="0">
          <name>$string</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$index</name>
          <default>1</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1364" package="Crypt_RSA">
        <name>setPrivateKeyFormat</name>
        <full_name>\Crypt_RSA::setPrivateKeyFormat()</full_name>
        <docblock line="1364">
          <description>Determines the private key format</description>
          <long-description></long-description>
          <tag name="see" description="" line="1364"/>
          <tag name="access" description="public" line="1364"/>
          <tag name="param" description="" line="1364" type="Integer" variable="$format">
            <type>Integer</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$format</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1376" package="Crypt_RSA">
        <name>setPublicKeyFormat</name>
        <full_name>\Crypt_RSA::setPublicKeyFormat()</full_name>
        <docblock line="1376">
          <description>Determines the public key format</description>
          <long-description></long-description>
          <tag name="see" description="" line="1376"/>
          <tag name="access" description="public" line="1376"/>
          <tag name="param" description="" line="1376" type="Integer" variable="$format">
            <type>Integer</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$format</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1390" package="Crypt_RSA">
        <name>setHash</name>
        <full_name>\Crypt_RSA::setHash()</full_name>
        <docblock line="1390">
          <description>Determines which hashing function should be used</description>
          <long-description>Used with signature production / verification and (if the encryption mode is CRYPT_RSA_ENCRYPTION_OAEP) encryption and
decryption.  If $hash isn't supported, sha1 is used.</long-description>
          <tag name="access" description="public" line="1390"/>
          <tag name="param" description="" line="1390" type="String" variable="$hash">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$hash</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1419" package="Crypt_RSA">
        <name>setMGFHash</name>
        <full_name>\Crypt_RSA::setMGFHash()</full_name>
        <docblock line="1419">
          <description>Determines which hashing function should be used for the mask generation function</description>
          <long-description>The mask generation function is used by CRYPT_RSA_ENCRYPTION_OAEP and CRYPT_RSA_SIGNATURE_PSS and although it's
best if Hash and MGFHash are set to the same thing this is not a requirement.</long-description>
          <tag name="access" description="public" line="1419"/>
          <tag name="param" description="" line="1419" type="String" variable="$hash">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$hash</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1448" package="Crypt_RSA">
        <name>setSaltLength</name>
        <full_name>\Crypt_RSA::setSaltLength()</full_name>
        <docblock line="1448">
          <description>Determines the salt length</description>
          <long-description>To quote from {@link http://tools.ietf.org/html/rfc3447#page-38 RFC3447#page-38}:

   Typical salt lengths in octets are hLen (the length of the output
   of the hash function Hash) and 0.</long-description>
          <tag name="access" description="public" line="1448"/>
          <tag name="param" description="" line="1448" type="Integer" variable="$format">
            <type>Integer</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$sLen</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1461" package="Crypt_RSA">
        <name>_random</name>
        <full_name>\Crypt_RSA::_random()</full_name>
        <docblock line="1461">
          <description>Generates a random string x bytes long</description>
          <long-description></long-description>
          <tag name="access" description="public" line="1461"/>
          <tag name="param" description="" line="1461" type="Integer" variable="$bytes">
            <type>Integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Integer $nonzero&lt;/p&gt;&#10;" line="1461" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="1461" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$bytes</name>
          <default></default>
          <type>Integer</type>
        </argument>
        <argument line="0">
          <name>$nonzero</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1488" package="Crypt_RSA">
        <name>_i2osp</name>
        <full_name>\Crypt_RSA::_i2osp()</full_name>
        <docblock line="1488">
          <description>Integer-to-Octet-String primitive</description>
          <long-description>See {@link http://tools.ietf.org/html/rfc3447#section-4.1 RFC3447#section-4.1}.</long-description>
          <tag name="access" description="private" line="1488"/>
          <tag name="param" description="" line="1488" type="\Math_BigInteger" variable="$x">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="param" description="" line="1488" type="Integer" variable="$xLen">
            <type>Integer</type>
          </tag>
          <tag name="return" description="" line="1488" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$x</name>
          <default></default>
          <type>\Math_BigInteger</type>
        </argument>
        <argument line="0">
          <name>$xLen</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1507" package="Crypt_RSA">
        <name>_os2ip</name>
        <full_name>\Crypt_RSA::_os2ip()</full_name>
        <docblock line="1507">
          <description>Octet-String-to-Integer primitive</description>
          <long-description>See {@link http://tools.ietf.org/html/rfc3447#section-4.2 RFC3447#section-4.2}.</long-description>
          <tag name="access" description="private" line="1507"/>
          <tag name="param" description="" line="1507" type="String" variable="$x">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="1507" type="\Math_BigInteger">
            <type>\Math_BigInteger</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$x</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1521" package="Crypt_RSA">
        <name>_exponentiate</name>
        <full_name>\Crypt_RSA::_exponentiate()</full_name>
        <docblock line="1521">
          <description>Exponentiate with or without Chinese Remainder Theorem</description>
          <long-description>See {@link http://tools.ietf.org/html/rfc3447#section-5.1.1 RFC3447#section-5.1.2}.</long-description>
          <tag name="access" description="private" line="1521"/>
          <tag name="param" description="" line="1521" type="\Math_BigInteger" variable="$x">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="return" description="" line="1521" type="\Math_BigInteger">
            <type>\Math_BigInteger</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$x</name>
          <default></default>
          <type>\Math_BigInteger</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1602" package="Crypt_RSA">
        <name>_blind</name>
        <full_name>\Crypt_RSA::_blind()</full_name>
        <docblock line="1602">
          <description>Performs RSA Blinding</description>
          <long-description>Protects against timing attacks by employing RSA Blinding.
Returns $x-&gt;modPow($this-&gt;exponents[$i], $this-&gt;primes[$i])</long-description>
          <tag name="access" description="private" line="1602"/>
          <tag name="param" description="" line="1602" type="\Math_BigInteger" variable="$x">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="param" description="" line="1602" type="\Math_BigInteger" variable="$r">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="param" description="" line="1602" type="Integer" variable="$i">
            <type>Integer</type>
          </tag>
          <tag name="return" description="" line="1602" type="\Math_BigInteger">
            <type>\Math_BigInteger</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$x</name>
          <default></default>
          <type>\Math_BigInteger</type>
        </argument>
        <argument line="0">
          <name>$r</name>
          <default></default>
          <type>\Math_BigInteger</type>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1623" package="Crypt_RSA">
        <name>_rsaep</name>
        <full_name>\Crypt_RSA::_rsaep()</full_name>
        <docblock line="1623">
          <description>RSAEP</description>
          <long-description>See {@link http://tools.ietf.org/html/rfc3447#section-5.1.1 RFC3447#section-5.1.1}.</long-description>
          <tag name="access" description="private" line="1623"/>
          <tag name="param" description="" line="1623" type="\Math_BigInteger" variable="$m">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="return" description="" line="1623" type="\Math_BigInteger">
            <type>\Math_BigInteger</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$m</name>
          <default></default>
          <type>\Math_BigInteger</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1641" package="Crypt_RSA">
        <name>_rsadp</name>
        <full_name>\Crypt_RSA::_rsadp()</full_name>
        <docblock line="1641">
          <description>RSADP</description>
          <long-description>See {@link http://tools.ietf.org/html/rfc3447#section-5.1.2 RFC3447#section-5.1.2}.</long-description>
          <tag name="access" description="private" line="1641"/>
          <tag name="param" description="" line="1641" type="\Math_BigInteger" variable="$c">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="return" description="" line="1641" type="\Math_BigInteger">
            <type>\Math_BigInteger</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$c</name>
          <default></default>
          <type>\Math_BigInteger</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1659" package="Crypt_RSA">
        <name>_rsasp1</name>
        <full_name>\Crypt_RSA::_rsasp1()</full_name>
        <docblock line="1659">
          <description>RSASP1</description>
          <long-description>See {@link http://tools.ietf.org/html/rfc3447#section-5.2.1 RFC3447#section-5.2.1}.</long-description>
          <tag name="access" description="private" line="1659"/>
          <tag name="param" description="" line="1659" type="\Math_BigInteger" variable="$m">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="return" description="" line="1659" type="\Math_BigInteger">
            <type>\Math_BigInteger</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$m</name>
          <default></default>
          <type>\Math_BigInteger</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1677" package="Crypt_RSA">
        <name>_rsavp1</name>
        <full_name>\Crypt_RSA::_rsavp1()</full_name>
        <docblock line="1677">
          <description>RSAVP1</description>
          <long-description>See {@link http://tools.ietf.org/html/rfc3447#section-5.2.2 RFC3447#section-5.2.2}.</long-description>
          <tag name="access" description="private" line="1677"/>
          <tag name="param" description="" line="1677" type="\Math_BigInteger" variable="$s">
            <type>\Math_BigInteger</type>
          </tag>
          <tag name="return" description="" line="1677" type="\Math_BigInteger">
            <type>\Math_BigInteger</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$s</name>
          <default></default>
          <type>\Math_BigInteger</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1696" package="Crypt_RSA">
        <name>_mgf1</name>
        <full_name>\Crypt_RSA::_mgf1()</full_name>
        <docblock line="1696">
          <description>MGF1</description>
          <long-description>See {@link http://tools.ietf.org/html/rfc3447#appendix-B.2.1 RFC3447#appendix-B.2.1}.</long-description>
          <tag name="access" description="private" line="1696"/>
          <tag name="param" description="" line="1696" type="String" variable="$mgfSeed">
            <type>String</type>
          </tag>
          <tag name="param" description="" line="1696" type="Integer" variable="$mgfLen">
            <type>Integer</type>
          </tag>
          <tag name="return" description="" line="1696" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$mgfSeed</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$maskLen</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1721" package="Crypt_RSA">
        <name>_rsaes_oaep_encrypt</name>
        <full_name>\Crypt_RSA::_rsaes_oaep_encrypt()</full_name>
        <docblock line="1721">
          <description>RSAES-OAEP-ENCRYPT</description>
          <long-description>See {@link http://tools.ietf.org/html/rfc3447#section-7.1.1 RFC3447#section-7.1.1} and
{http://en.wikipedia.org/wiki/Optimal_Asymmetric_Encryption_Padding OAES}.</long-description>
          <tag name="access" description="private" line="1721"/>
          <tag name="param" description="" line="1721" type="String" variable="$m">
            <type>String</type>
          </tag>
          <tag name="param" description="" line="1721" type="String" variable="$l">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="1721" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$m</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$l</name>
          <default>''</default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1784" package="Crypt_RSA">
        <name>_rsaes_oaep_decrypt</name>
        <full_name>\Crypt_RSA::_rsaes_oaep_decrypt()</full_name>
        <docblock line="1784">
          <description>RSAES-OAEP-DECRYPT</description>
          <long-description>See {@link http://tools.ietf.org/html/rfc3447#section-7.1.2 RFC3447#section-7.1.2}.  The fact that the error
messages aren't distinguishable from one another hinders debugging, but, to quote from RFC3447#section-7.1.2:

   Note.  Care must be taken to ensure that an opponent cannot
   distinguish the different error conditions in Step 3.g, whether by
   error message or timing, or, more generally, learn partial
   information about the encoded message EM.  Otherwise an opponent may
   be able to obtain useful information about the decryption of the
   ciphertext C, leading to a chosen-ciphertext attack such as the one
   observed by Manger [36].

As for $l...  to quote from {@link http://tools.ietf.org/html/rfc3447#page-17 RFC3447#page-17}:

   Both the encryption and the decryption operations of RSAES-OAEP take
   the value of a label L as input.  In this version of PKCS #1, L is
   the empty string; other uses of the label are outside the scope of
   this document.</long-description>
          <tag name="access" description="private" line="1784"/>
          <tag name="param" description="" line="1784" type="String" variable="$c">
            <type>String</type>
          </tag>
          <tag name="param" description="" line="1784" type="String" variable="$l">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="1784" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$c</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$l</name>
          <default>''</default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1842" package="Crypt_RSA">
        <name>_rsaes_pkcs1_v1_5_encrypt</name>
        <full_name>\Crypt_RSA::_rsaes_pkcs1_v1_5_encrypt()</full_name>
        <docblock line="1842">
          <description>RSAES-PKCS1-V1_5-ENCRYPT</description>
          <long-description>See {@link http://tools.ietf.org/html/rfc3447#section-7.2.1 RFC3447#section-7.2.1}.</long-description>
          <tag name="access" description="private" line="1842"/>
          <tag name="param" description="" line="1842" type="String" variable="$m">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="1842" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$m</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1888" package="Crypt_RSA">
        <name>_rsaes_pkcs1_v1_5_decrypt</name>
        <full_name>\Crypt_RSA::_rsaes_pkcs1_v1_5_decrypt()</full_name>
        <docblock line="1888">
          <description>RSAES-PKCS1-V1_5-DECRYPT</description>
          <long-description>See {@link http://tools.ietf.org/html/rfc3447#section-7.2.2 RFC3447#section-7.2.2}.

For compatability purposes, this function departs slightly from the description given in RFC3447.
The reason being that RFC2313#section-8.1 (PKCS#1 v1.5) states that ciphertext's encrypted by the
private key should have the second byte set to either 0 or 1 and that ciphertext's encrypted by the
public key should have the second byte set to 2.  In RFC3447 (PKCS#1 v2.1), the second byte is supposed
to be 2 regardless of which key is used.  for compatability purposes, we'll just check to make sure the
second byte is 2 or less.  If it is, we'll accept the decrypted string as valid.

As a consequence of this, a private key encrypted ciphertext produced with Crypt_RSA may not decrypt
with a strictly PKCS#1 v1.5 compliant RSA implementation.  Public key encrypted ciphertext's should but
not private key encrypted ciphertext's.</long-description>
          <tag name="access" description="private" line="1888"/>
          <tag name="param" description="" line="1888" type="String" variable="$c">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="1888" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$c</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1937" package="Crypt_RSA">
        <name>_emsa_pss_encode</name>
        <full_name>\Crypt_RSA::_emsa_pss_encode()</full_name>
        <docblock line="1937">
          <description>EMSA-PSS-ENCODE</description>
          <long-description>See {@link http://tools.ietf.org/html/rfc3447#section-9.1.1 RFC3447#section-9.1.1}.</long-description>
          <tag name="access" description="private" line="1937"/>
          <tag name="param" description="" line="1937" type="String" variable="$m">
            <type>String</type>
          </tag>
          <tag name="param" description="" line="1937" type="Integer" variable="$emBits">
            <type>Integer</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$m</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$emBits</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1975" package="Crypt_RSA">
        <name>_emsa_pss_verify</name>
        <full_name>\Crypt_RSA::_emsa_pss_verify()</full_name>
        <docblock line="1975">
          <description>EMSA-PSS-VERIFY</description>
          <long-description>See {@link http://tools.ietf.org/html/rfc3447#section-9.1.2 RFC3447#section-9.1.2}.</long-description>
          <tag name="access" description="private" line="1975"/>
          <tag name="param" description="" line="1975" type="String" variable="$m">
            <type>String</type>
          </tag>
          <tag name="param" description="" line="1975" type="String" variable="$em">
            <type>String</type>
          </tag>
          <tag name="param" description="" line="1975" type="Integer" variable="$emBits">
            <type>Integer</type>
          </tag>
          <tag name="return" description="" line="1975" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$m</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$em</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$emBits</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2020" package="Crypt_RSA">
        <name>_rsassa_pss_sign</name>
        <full_name>\Crypt_RSA::_rsassa_pss_sign()</full_name>
        <docblock line="2020">
          <description>RSASSA-PSS-SIGN</description>
          <long-description>See {@link http://tools.ietf.org/html/rfc3447#section-8.1.1 RFC3447#section-8.1.1}.</long-description>
          <tag name="access" description="private" line="2020"/>
          <tag name="param" description="" line="2020" type="String" variable="$m">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="2020" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$m</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2047" package="Crypt_RSA">
        <name>_rsassa_pss_verify</name>
        <full_name>\Crypt_RSA::_rsassa_pss_verify()</full_name>
        <docblock line="2047">
          <description>RSASSA-PSS-VERIFY</description>
          <long-description>See {@link http://tools.ietf.org/html/rfc3447#section-8.1.2 RFC3447#section-8.1.2}.</long-description>
          <tag name="access" description="private" line="2047"/>
          <tag name="param" description="" line="2047" type="String" variable="$m">
            <type>String</type>
          </tag>
          <tag name="param" description="" line="2047" type="String" variable="$s">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="2047" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$m</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$s</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2087" package="Crypt_RSA">
        <name>_emsa_pkcs1_v1_5_encode</name>
        <full_name>\Crypt_RSA::_emsa_pkcs1_v1_5_encode()</full_name>
        <docblock line="2087">
          <description>EMSA-PKCS1-V1_5-ENCODE</description>
          <long-description>See {@link http://tools.ietf.org/html/rfc3447#section-9.2 RFC3447#section-9.2}.</long-description>
          <tag name="access" description="private" line="2087"/>
          <tag name="param" description="" line="2087" type="String" variable="$m">
            <type>String</type>
          </tag>
          <tag name="param" description="" line="2087" type="Integer" variable="$emLen">
            <type>Integer</type>
          </tag>
          <tag name="return" description="" line="2087" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$m</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$emLen</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2138" package="Crypt_RSA">
        <name>_rsassa_pkcs1_v1_5_sign</name>
        <full_name>\Crypt_RSA::_rsassa_pkcs1_v1_5_sign()</full_name>
        <docblock line="2138">
          <description>RSASSA-PKCS1-V1_5-SIGN</description>
          <long-description>See {@link http://tools.ietf.org/html/rfc3447#section-8.2.1 RFC3447#section-8.2.1}.</long-description>
          <tag name="access" description="private" line="2138"/>
          <tag name="param" description="" line="2138" type="String" variable="$m">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="2138" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$m</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2168" package="Crypt_RSA">
        <name>_rsassa_pkcs1_v1_5_verify</name>
        <full_name>\Crypt_RSA::_rsassa_pkcs1_v1_5_verify()</full_name>
        <docblock line="2168">
          <description>RSASSA-PKCS1-V1_5-VERIFY</description>
          <long-description>See {@link http://tools.ietf.org/html/rfc3447#section-8.2.2 RFC3447#section-8.2.2}.</long-description>
          <tag name="access" description="private" line="2168"/>
          <tag name="param" description="" line="2168" type="String" variable="$m">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="2168" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$m</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$s</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2212" package="Crypt_RSA">
        <name>setEncryptionMode</name>
        <full_name>\Crypt_RSA::setEncryptionMode()</full_name>
        <docblock line="2212">
          <description>Set Encryption Mode</description>
          <long-description>Valid values include CRYPT_RSA_ENCRYPTION_OAEP and CRYPT_RSA_ENCRYPTION_PKCS1.</long-description>
          <tag name="access" description="public" line="2212"/>
          <tag name="param" description="" line="2212" type="Integer" variable="$mode">
            <type>Integer</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$mode</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2225" package="Crypt_RSA">
        <name>setSignatureMode</name>
        <full_name>\Crypt_RSA::setSignatureMode()</full_name>
        <docblock line="2225">
          <description>Set Signature Mode</description>
          <long-description>Valid values include CRYPT_RSA_SIGNATURE_PSS and CRYPT_RSA_SIGNATURE_PKCS1</long-description>
          <tag name="access" description="public" line="2225"/>
          <tag name="param" description="" line="2225" type="Integer" variable="$mode">
            <type>Integer</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$mode</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2242" package="Crypt_RSA">
        <name>encrypt</name>
        <full_name>\Crypt_RSA::encrypt()</full_name>
        <docblock line="2242">
          <description>Encryption</description>
          <long-description>Both CRYPT_RSA_ENCRYPTION_OAEP and CRYPT_RSA_ENCRYPTION_PKCS1 both place limits on how long $plaintext can be.
If $plaintext exceeds those limits it will be broken up so that it does and the resultant ciphertext's will
be concatenated together.</long-description>
          <tag name="see" description="" line="2242"/>
          <tag name="access" description="public" line="2242"/>
          <tag name="param" description="" line="2242" type="String" variable="$plaintext">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="2242" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$plaintext</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2281" package="Crypt_RSA">
        <name>decrypt</name>
        <full_name>\Crypt_RSA::decrypt()</full_name>
        <docblock line="2281">
          <description>Decryption</description>
          <long-description></long-description>
          <tag name="see" description="" line="2281"/>
          <tag name="access" description="public" line="2281"/>
          <tag name="param" description="" line="2281" type="String" variable="$plaintext">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="2281" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$ciphertext</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2318" package="Crypt_RSA">
        <name>sign</name>
        <full_name>\Crypt_RSA::sign()</full_name>
        <docblock line="2318">
          <description>Create a signature</description>
          <long-description></long-description>
          <tag name="see" description="" line="2318"/>
          <tag name="access" description="public" line="2318"/>
          <tag name="param" description="" line="2318" type="String" variable="$message">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="2318" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$message</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2342" package="Crypt_RSA">
        <name>verify</name>
        <full_name>\Crypt_RSA::verify()</full_name>
        <docblock line="2342">
          <description>Verifies a signature</description>
          <long-description></long-description>
          <tag name="see" description="" line="2342"/>
          <tag name="access" description="public" line="2342"/>
          <tag name="param" description="" line="2342" type="String" variable="$message">
            <type>String</type>
          </tag>
          <tag name="param" description="" line="2342" type="String" variable="$signature">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="2342" type="Boolean">
            <type>Boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$message</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$signature</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/3rdParty/phpseclib/Crypt/Hash.php" generated-path="lib.3rdParty.phpseclib.Crypt.Hash.html" hash="493a9129f851e698e2e72448e4118fd8" package="Crypt_Hash">
    <docblock line="0">
      <description>Pure-PHP implementations of keyed-hash message authentication codes (HMACs) and various cryptographic hashing functions.</description>
      <long-description>Uses hash() or mhash() if available and an internal implementation, otherwise.  Currently supports the following:

md2, md5, md5-96, sha1, sha1-96, sha256, sha384, and sha512

If {@link Crypt_Hash::setKey() setKey()} is called, {@link Crypt_Hash::hash() hash()} will return the HMAC as opposed to
the hash.  If no valid algorithm is provided, sha1 will be used.

PHP versions 4 and 5

{@internal The variable names are the same as those in
{@link http://tools.ietf.org/html/rfc2104#section-2 RFC2104}.}}

Here's a short example of how to use this library:
&lt;code&gt;
&lt;?php
   include('Crypt/Hash.php');

   $hash = new Crypt_Hash('sha1');

   $hash-&gt;setKey('abcdefg');

   echo base64_encode($hash-&gt;hash('abcdefg'));
?&gt;
&lt;/code&gt;

LICENSE: Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.</long-description>
      <tag name="category" description="Crypt" line="0"/>
      <tag name="package" description="Crypt_Hash" line="0"/>
      <tag name="author" description="Jim Wigginton &amp;lt;terrafrost@php.net&amp;gt;" line="0"/>
      <tag name="copyright" description="MMVII Jim Wigginton" line="0"/>
      <tag name="license" description="MIT License" line="0" link="http://www.opensource.org/licenses/mit-license.html"/>
      <tag name="version" description="$Id: Hash.php 4105 2011-05-19 18:02:11Z gruberroland $" line="0"/>
      <tag name="link" description="http://phpseclib.sourceforge.net" line="0"/>
    </docblock>
    <constant namespace="" line="66" package="Crypt_Hash">
      <name>CRYPT_HASH_MODE_INTERNAL</name>
      <full_name>\\CRYPT_HASH_MODE_INTERNAL</full_name>
      <value>1</value>
      <docblock line="66">
        <description>Toggles the internal implementation</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="70" package="Crypt_Hash">
      <name>CRYPT_HASH_MODE_MHASH</name>
      <full_name>\\CRYPT_HASH_MODE_MHASH</full_name>
      <value>2</value>
      <docblock line="70">
        <description>Toggles the mhash() implementation, which has been deprecated on PHP 5.3.0+.</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="74" package="Crypt_Hash">
      <name>CRYPT_HASH_MODE_HASH</name>
      <full_name>\\CRYPT_HASH_MODE_HASH</full_name>
      <value>3</value>
      <docblock line="74">
        <description>Toggles the hash() implementation, which works on PHP 5.1.2+.</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="158" package="Crypt_Hash">
      <name>CRYPT_HASH_MODE</name>
      <full_name>\\CRYPT_HASH_MODE</full_name>
      <value>CRYPT_HASH_MODE_INTERNAL</value>
      <docblock line="158">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <class final="false" abstract="false" namespace="" line="85" package="Crypt_Hash">
      <extends/>
      <name>Crypt_Hash</name>
      <full_name>\Crypt_Hash</full_name>
      <docblock line="85">
        <description>Pure-PHP implementations of keyed-hash message authentication codes (HMACs) and various cryptographic hashing functions.</description>
        <long-description></long-description>
        <tag name="author" description="Jim Wigginton &amp;lt;terrafrost@php.net&amp;gt;" line="85"/>
        <tag name="version" description="" line="85"/>
        <tag name="access" description="public" line="85"/>
        <tag name="package" description="Crypt_Hash" line="85"/>
      </docblock>
      <property static="false" visibility="public" line="93" namespace="" package="Crypt_Hash">
        <name>$b</name>
        <default></default>
        <docblock line="93">
          <description>Byte-length of compression blocks / key (Internal HMAC)</description>
          <long-description></long-description>
          <tag name="see" description="" line="93"/>
          <tag name="var" description="" line="93" type="Integer" variable="">
            <type>Integer</type>
          </tag>
          <tag name="access" description="private" line="93"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="102" namespace="" package="Crypt_Hash">
        <name>$l</name>
        <default>false</default>
        <docblock line="102">
          <description>Byte-length of hash output (Internal HMAC)</description>
          <long-description></long-description>
          <tag name="see" description="" line="102"/>
          <tag name="var" description="" line="102" type="Integer" variable="">
            <type>Integer</type>
          </tag>
          <tag name="access" description="private" line="102"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="111" namespace="" package="Crypt_Hash">
        <name>$hash</name>
        <default></default>
        <docblock line="111">
          <description>Hash Algorithm</description>
          <long-description></long-description>
          <tag name="see" description="" line="111"/>
          <tag name="var" description="" line="111" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="111"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="120" namespace="" package="Crypt_Hash">
        <name>$key</name>
        <default>''</default>
        <docblock line="120">
          <description>Key</description>
          <long-description></long-description>
          <tag name="see" description="" line="120"/>
          <tag name="var" description="" line="120" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="120"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="129" namespace="" package="Crypt_Hash">
        <name>$opad</name>
        <default></default>
        <docblock line="129">
          <description>Outer XOR (Internal HMAC)</description>
          <long-description></long-description>
          <tag name="see" description="" line="129"/>
          <tag name="var" description="" line="129" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="129"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="138" namespace="" package="Crypt_Hash">
        <name>$ipad</name>
        <default></default>
        <docblock line="138">
          <description>Inner XOR (Internal HMAC)</description>
          <long-description></long-description>
          <tag name="see" description="" line="138"/>
          <tag name="var" description="" line="138" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="138"/>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="147" package="Crypt_Hash">
        <name>Crypt_Hash</name>
        <full_name>\Crypt_Hash::Crypt_Hash()</full_name>
        <docblock line="147">
          <description>Default Constructor.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;String $hash&lt;/p&gt;&#10;" line="147" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="147" type="\Crypt_Hash">
            <type>\Crypt_Hash</type>
          </tag>
          <tag name="access" description="public" line="147"/>
        </docblock>
        <argument line="0">
          <name>$hash</name>
          <default>'sha1'</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="173" package="Crypt_Hash">
        <name>setKey</name>
        <full_name>\Crypt_Hash::setKey()</full_name>
        <docblock line="173">
          <description>Sets the key for HMACs</description>
          <long-description>Keys can be of any length.</long-description>
          <tag name="access" description="public" line="173"/>
          <tag name="param" description="" line="173" type="String" variable="$key">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$key</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="184" package="Crypt_Hash">
        <name>setHash</name>
        <full_name>\Crypt_Hash::setHash()</full_name>
        <docblock line="184">
          <description>Sets the hash function.</description>
          <long-description></long-description>
          <tag name="access" description="public" line="184"/>
          <tag name="param" description="" line="184" type="String" variable="$hash">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$hash</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="294" package="Crypt_Hash">
        <name>hash</name>
        <full_name>\Crypt_Hash::hash()</full_name>
        <docblock line="294">
          <description>Compute the HMAC.</description>
          <long-description></long-description>
          <tag name="access" description="public" line="294"/>
          <tag name="param" description="" line="294" type="String" variable="$text">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="294" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$text</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="343" package="Crypt_Hash">
        <name>getLength</name>
        <full_name>\Crypt_Hash::getLength()</full_name>
        <docblock line="343">
          <description>Returns the hash length (in bytes)</description>
          <long-description></long-description>
          <tag name="access" description="public" line="343"/>
          <tag name="return" description="" line="343" type="Integer">
            <type>Integer</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="354" package="Crypt_Hash">
        <name>_md5</name>
        <full_name>\Crypt_Hash::_md5()</full_name>
        <docblock line="354">
          <description>Wrapper for MD5</description>
          <long-description></long-description>
          <tag name="access" description="private" line="354"/>
          <tag name="param" description="" line="354" type="String" variable="$text">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$m</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="365" package="Crypt_Hash">
        <name>_sha1</name>
        <full_name>\Crypt_Hash::_sha1()</full_name>
        <docblock line="365">
          <description>Wrapper for SHA1</description>
          <long-description></long-description>
          <tag name="access" description="private" line="365"/>
          <tag name="param" description="" line="365" type="String" variable="$text">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$m</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="378" package="Crypt_Hash">
        <name>_md2</name>
        <full_name>\Crypt_Hash::_md2()</full_name>
        <docblock line="378">
          <description>Pure-PHP implementation of MD2</description>
          <long-description>See {@link http://tools.ietf.org/html/rfc1319 RFC1319}.</long-description>
          <tag name="access" description="private" line="378"/>
          <tag name="param" description="" line="378" type="String" variable="$text">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$m</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="454" package="Crypt_Hash">
        <name>_sha256</name>
        <full_name>\Crypt_Hash::_sha256()</full_name>
        <docblock line="454">
          <description>Pure-PHP implementation of SHA256</description>
          <long-description>See {@link http://en.wikipedia.org/wiki/SHA_hash_functions#SHA-256_.28a_SHA-2_variant.29_pseudocode SHA-256 (a SHA-2 variant) pseudocode - Wikipedia}.</long-description>
          <tag name="access" description="private" line="454"/>
          <tag name="param" description="" line="454" type="String" variable="$text">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$m</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="559" package="Crypt_Hash">
        <name>_sha512</name>
        <full_name>\Crypt_Hash::_sha512()</full_name>
        <docblock line="559">
          <description>Pure-PHP implementation of SHA384 and SHA512</description>
          <long-description></long-description>
          <tag name="access" description="private" line="559"/>
          <tag name="param" description="" line="559" type="String" variable="$text">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$m</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="745" package="Crypt_Hash">
        <name>_rightRotate</name>
        <full_name>\Crypt_Hash::_rightRotate()</full_name>
        <docblock line="745">
          <description>Right Rotate</description>
          <long-description></long-description>
          <tag name="access" description="private" line="745"/>
          <tag name="param" description="" line="745" type="Integer" variable="$int">
            <type>Integer</type>
          </tag>
          <tag name="param" description="" line="745" type="Integer" variable="$amt">
            <type>Integer</type>
          </tag>
          <tag name="see" description="" line="745"/>
          <tag name="return" description="" line="745" type="Integer">
            <type>Integer</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$int</name>
          <default></default>
          <type>Integer</type>
        </argument>
        <argument line="0">
          <name>$amt</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="761" package="Crypt_Hash">
        <name>_rightShift</name>
        <full_name>\Crypt_Hash::_rightShift()</full_name>
        <docblock line="761">
          <description>Right Shift</description>
          <long-description></long-description>
          <tag name="access" description="private" line="761"/>
          <tag name="param" description="" line="761" type="Integer" variable="$int">
            <type>Integer</type>
          </tag>
          <tag name="param" description="" line="761" type="Integer" variable="$amt">
            <type>Integer</type>
          </tag>
          <tag name="see" description="" line="761"/>
          <tag name="return" description="" line="761" type="Integer">
            <type>Integer</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$int</name>
          <default></default>
          <type>Integer</type>
        </argument>
        <argument line="0">
          <name>$amt</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="775" package="Crypt_Hash">
        <name>_not</name>
        <full_name>\Crypt_Hash::_not()</full_name>
        <docblock line="775">
          <description>Not</description>
          <long-description></long-description>
          <tag name="access" description="private" line="775"/>
          <tag name="param" description="" line="775" type="Integer" variable="$int">
            <type>Integer</type>
          </tag>
          <tag name="see" description="" line="775"/>
          <tag name="return" description="" line="775" type="Integer">
            <type>Integer</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$int</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="792" package="Crypt_Hash">
        <name>_add</name>
        <full_name>\Crypt_Hash::_add()</full_name>
        <docblock line="792">
          <description>Add</description>
          <long-description>_sha256() adds multiple unsigned 32-bit integers.  Since PHP doesn't support unsigned integers and since the
possibility of overflow exists, care has to be taken.  Math_BigInteger() could be used but this should be faster.</long-description>
          <tag name="param" description="" line="792" type="String" variable="$string">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Integer $index&lt;/p&gt;&#10;" line="792" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="792" type="String">
            <type>String</type>
          </tag>
          <tag name="see" description="" line="792"/>
          <tag name="access" description="private" line="792"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="818" package="Crypt_Hash">
        <name>_string_shift</name>
        <full_name>\Crypt_Hash::_string_shift()</full_name>
        <docblock line="818">
          <description>String Shift</description>
          <long-description>Inspired by array_shift</long-description>
          <tag name="param" description="" line="818" type="String" variable="$string">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Integer $index&lt;/p&gt;&#10;" line="818" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="818" type="String">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="818"/>
        </docblock>
        <argument line="0">
          <name>$string</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$index</name>
          <default>1</default>
          <type/>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/3rdParty/phpseclib/Crypt/TripleDES.php" generated-path="lib.3rdParty.phpseclib.Crypt.TripleDES.html" hash="bb9ada71321d6710e544ded8535bc6d5" package="Crypt_TripleDES">
    <docblock line="0">
      <description>Pure-PHP implementation of Triple DES.</description>
      <long-description>Uses mcrypt, if available, and an internal implementation, otherwise.  Operates in the EDE3 mode (encrypt-decrypt-encrypt).

PHP versions 4 and 5

Here's a short example of how to use this library:
&lt;code&gt;
&lt;?php
   include('Crypt/TripleDES.php');

   $des = new Crypt_TripleDES();

   $des-&gt;setKey('abcdefghijklmnopqrstuvwx');

   $size = 10 * 1024;
   $plaintext = '';
   for ($i = 0; $i &lt; $size; $i++) {
       $plaintext.= 'a';
   }

   echo $des-&gt;decrypt($des-&gt;encrypt($plaintext));
?&gt;
&lt;/code&gt;

LICENSE: Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.</long-description>
      <tag name="category" description="Crypt" line="0"/>
      <tag name="package" description="Crypt_TripleDES" line="0"/>
      <tag name="author" description="Jim Wigginton &amp;lt;terrafrost@php.net&amp;gt;" line="0"/>
      <tag name="copyright" description="MMVII Jim Wigginton" line="0"/>
      <tag name="license" description="MIT License" line="0" link="http://www.opensource.org/licenses/mit-license.html"/>
      <tag name="version" description="$Id: TripleDES.php 4105 2011-05-19 18:02:11Z gruberroland $" line="0"/>
      <tag name="link" description="http://phpseclib.sourceforge.net" line="0"/>
    </docblock>
    <constant namespace="" line="67" package="Crypt_TripleDES">
      <name>CRYPT_DES_MODE_3CBC</name>
      <full_name>\\CRYPT_DES_MODE_3CBC</full_name>
      <value>-2</value>
      <docblock line="67">
        <description>Encrypt / decrypt using inner chaining</description>
        <long-description>Inner chaining is used by SSH-1 and is generally considered to be less secure then outer chaining (CRYPT_DES_MODE_CBC3).</long-description>
      </docblock>
    </constant>
    <constant namespace="" line="74" package="Crypt_TripleDES">
      <name>CRYPT_DES_MODE_CBC3</name>
      <full_name>\\CRYPT_DES_MODE_CBC3</full_name>
      <value>CRYPT_DES_MODE_CBC</value>
      <docblock line="74">
        <description>Encrypt / decrypt using outer chaining</description>
        <long-description>Outer chaining is used by SSH-2 and when the mode is set to CRYPT_DES_MODE_CBC.</long-description>
      </docblock>
    </constant>
    <constant namespace="" line="258" package="Crypt_TripleDES">
      <name>CRYPT_DES_MODE</name>
      <full_name>\\CRYPT_DES_MODE</full_name>
      <value>CRYPT_DES_MODE_INTERNAL</value>
      <docblock line="258">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <class final="false" abstract="false" namespace="" line="84" package="Crypt_TerraDES">
      <extends/>
      <name>Crypt_TripleDES</name>
      <full_name>\Crypt_TripleDES</full_name>
      <docblock line="84">
        <description>Pure-PHP implementation of Triple DES.</description>
        <long-description></long-description>
        <tag name="author" description="Jim Wigginton &amp;lt;terrafrost@php.net&amp;gt;" line="84"/>
        <tag name="version" description="" line="84"/>
        <tag name="access" description="public" line="84"/>
        <tag name="package" description="Crypt_TerraDES" line="84"/>
      </docblock>
      <property static="false" visibility="public" line="92" namespace="" package="Crypt_TerraDES">
        <name>$key</name>
        <default>"\0\0\0\0\0\0\0\0"</default>
        <docblock line="92">
          <description>The Three Keys</description>
          <long-description></long-description>
          <tag name="see" description="" line="92"/>
          <tag name="var" description="" line="92" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="92"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="101" namespace="" package="Crypt_TerraDES">
        <name>$mode</name>
        <default>CRYPT_DES_MODE_CBC</default>
        <docblock line="101">
          <description>The Encryption Mode</description>
          <long-description></long-description>
          <tag name="see" description="" line="101"/>
          <tag name="var" description="" line="101" type="Integer" variable="">
            <type>Integer</type>
          </tag>
          <tag name="access" description="private" line="101"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="110" namespace="" package="Crypt_TerraDES">
        <name>$continuousBuffer</name>
        <default>false</default>
        <docblock line="110">
          <description>Continuous Buffer status</description>
          <long-description></long-description>
          <tag name="see" description="" line="110"/>
          <tag name="var" description="" line="110" type="Boolean" variable="">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="private" line="110"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="119" namespace="" package="Crypt_TerraDES">
        <name>$padding</name>
        <default>true</default>
        <docblock line="119">
          <description>Padding status</description>
          <long-description></long-description>
          <tag name="see" description="" line="119"/>
          <tag name="var" description="" line="119" type="Boolean" variable="">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="private" line="119"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="128" namespace="" package="Crypt_TerraDES">
        <name>$iv</name>
        <default>"\0\0\0\0\0\0\0\0"</default>
        <docblock line="128">
          <description>The Initialization Vector</description>
          <long-description></long-description>
          <tag name="see" description="" line="128"/>
          <tag name="var" description="" line="128" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="128"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="137" namespace="" package="Crypt_TerraDES">
        <name>$encryptIV</name>
        <default>"\0\0\0\0\0\0\0\0"</default>
        <docblock line="137">
          <description>A "sliding" Initialization Vector</description>
          <long-description></long-description>
          <tag name="see" description="" line="137"/>
          <tag name="var" description="" line="137" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="137"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="146" namespace="" package="Crypt_TerraDES">
        <name>$decryptIV</name>
        <default>"\0\0\0\0\0\0\0\0"</default>
        <docblock line="146">
          <description>A "sliding" Initialization Vector</description>
          <long-description></long-description>
          <tag name="see" description="" line="146"/>
          <tag name="var" description="" line="146" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="146"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="154" namespace="" package="Crypt_TerraDES">
        <name>$des</name>
        <default></default>
        <docblock line="154">
          <description>The Crypt_DES objects</description>
          <long-description></long-description>
          <tag name="var" description="" line="154" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="154"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="166" namespace="" package="Crypt_TerraDES">
        <name>$enmcrypt</name>
        <default></default>
        <docblock line="166">
          <description>mcrypt resource for encryption</description>
          <long-description>The mcrypt resource can be recreated every time something needs to be created or it can be created just once.
Since mcrypt operates in continuous mode, by default, it'll need to be recreated when in non-continuous mode.</long-description>
          <tag name="see" description="" line="166"/>
          <tag name="var" description="" line="166" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="166"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="178" namespace="" package="Crypt_TerraDES">
        <name>$demcrypt</name>
        <default></default>
        <docblock line="178">
          <description>mcrypt resource for decryption</description>
          <long-description>The mcrypt resource can be recreated every time something needs to be created or it can be created just once.
Since mcrypt operates in continuous mode, by default, it'll need to be recreated when in non-continuous mode.</long-description>
          <tag name="see" description="" line="178"/>
          <tag name="var" description="" line="178" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="178"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="188" namespace="" package="Crypt_TerraDES">
        <name>$enchanged</name>
        <default>true</default>
        <docblock line="188">
          <description>Does the enmcrypt resource need to be (re)initialized?</description>
          <long-description></long-description>
          <tag name="see" description="" line="188"/>
          <tag name="see" description="" line="188"/>
          <tag name="var" description="" line="188" type="Boolean" variable="">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="private" line="188"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="198" namespace="" package="Crypt_TerraDES">
        <name>$dechanged</name>
        <default>true</default>
        <docblock line="198">
          <description>Does the demcrypt resource need to be (re)initialized?</description>
          <long-description></long-description>
          <tag name="see" description="" line="198"/>
          <tag name="see" description="" line="198"/>
          <tag name="var" description="" line="198" type="Boolean" variable="">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="private" line="198"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="207" namespace="" package="Crypt_TerraDES">
        <name>$paddable</name>
        <default>false</default>
        <docblock line="207">
          <description>Is the mode one that is paddable?</description>
          <long-description></long-description>
          <tag name="see" description="" line="207"/>
          <tag name="var" description="" line="207" type="Boolean" variable="">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="private" line="207"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="216" namespace="" package="Crypt_TerraDES">
        <name>$enbuffer</name>
        <default>''</default>
        <docblock line="216">
          <description>Encryption buffer for CTR, OFB and CFB modes</description>
          <long-description></long-description>
          <tag name="see" description="" line="216"/>
          <tag name="var" description="" line="216" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="216"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="225" namespace="" package="Crypt_TerraDES">
        <name>$debuffer</name>
        <default>''</default>
        <docblock line="225">
          <description>Decryption buffer for CTR, OFB and CFB modes</description>
          <long-description></long-description>
          <tag name="see" description="" line="225"/>
          <tag name="var" description="" line="225" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="225"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="235" namespace="" package="Crypt_TerraDES">
        <name>$ecb</name>
        <default></default>
        <docblock line="235">
          <description>mcrypt resource for CFB mode</description>
          <long-description></long-description>
          <tag name="see" description="" line="235"/>
          <tag name="see" description="" line="235"/>
          <tag name="var" description="" line="235" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="235"/>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="247" package="Crypt_TerraDES">
        <name>Crypt_TripleDES</name>
        <full_name>\Crypt_TripleDES::Crypt_TripleDES()</full_name>
        <docblock line="247">
          <description>Default Constructor.</description>
          <long-description>Determines whether or not the mcrypt extension should be used.  $mode should only, at present, be
CRYPT_DES_MODE_ECB or CRYPT_DES_MODE_CBC.  If not explictly set, CRYPT_DES_MODE_CBC will be used.</long-description>
          <tag name="param" description="&lt;p&gt;Integer $mode&lt;/p&gt;&#10;" line="247" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="247" type="\Crypt_TripleDES">
            <type>\Crypt_TripleDES</type>
          </tag>
          <tag name="access" description="public" line="247"/>
        </docblock>
        <argument line="0">
          <name>$mode</name>
          <default>CRYPT_DES_MODE_CBC</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="344" package="Crypt_TerraDES">
        <name>setKey</name>
        <full_name>\Crypt_TripleDES::setKey()</full_name>
        <docblock line="344">
          <description>Sets the key.</description>
          <long-description>Keys can be of any length.  Triple DES, itself, can use 128-bit (eg. strlen($key) == 16) or
192-bit (eg. strlen($key) == 24) keys.  This function pads and truncates $key as appropriate.

DES also requires that every eighth bit be a parity bit, however, we'll ignore that.

If the key is not explicitly set, it'll be assumed to be all zero's.</long-description>
          <tag name="access" description="public" line="344"/>
          <tag name="param" description="" line="344" type="String" variable="$key">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$key</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="375" package="Crypt_TerraDES">
        <name>setIV</name>
        <full_name>\Crypt_TripleDES::setIV()</full_name>
        <docblock line="375">
          <description>Sets the initialization vector. (optional)</description>
          <long-description>SetIV is not required when CRYPT_DES_MODE_ECB is being used.  If not explictly set, it'll be assumed
to be all zero's.</long-description>
          <tag name="access" description="public" line="375"/>
          <tag name="param" description="" line="375" type="String" variable="$iv">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$iv</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="398" package="Crypt_TerraDES">
        <name>_generate_xor</name>
        <full_name>\Crypt_TripleDES::_generate_xor()</full_name>
        <docblock line="398">
          <description>Generate CTR XOR encryption key</description>
          <long-description>Encrypt the output of this and XOR it against the ciphertext / plaintext to get the
plaintext / ciphertext in CTR mode.</long-description>
          <tag name="see" description="" line="398"/>
          <tag name="see" description="" line="398"/>
          <tag name="access" description="private" line="398"/>
          <tag name="param" description="" line="398" type="Integer" variable="$length">
            <type>Integer</type>
          </tag>
          <tag name="param" description="" line="398" type="String" variable="$iv">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$length</name>
          <default></default>
          <type>Integer</type>
        </argument>
        <argument line="0">
          <name>$iv</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="430" package="Crypt_TerraDES">
        <name>encrypt</name>
        <full_name>\Crypt_TripleDES::encrypt()</full_name>
        <docblock line="430">
          <description>Encrypts a message.</description>
          <long-description></long-description>
          <tag name="access" description="public" line="430"/>
          <tag name="param" description="" line="430" type="String" variable="$plaintext">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$plaintext</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="637" package="Crypt_TerraDES">
        <name>decrypt</name>
        <full_name>\Crypt_TripleDES::decrypt()</full_name>
        <docblock line="637">
          <description>Decrypts a message.</description>
          <long-description></long-description>
          <tag name="access" description="public" line="637"/>
          <tag name="param" description="" line="637" type="String" variable="$ciphertext">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$ciphertext</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="876" package="Crypt_TerraDES">
        <name>enableContinuousBuffer</name>
        <full_name>\Crypt_TripleDES::enableContinuousBuffer()</full_name>
        <docblock line="876">
          <description>Treat consecutive "packets" as if they are a continuous buffer.</description>
          <long-description>Say you have a 16-byte plaintext $plaintext.  Using the default behavior, the two following code snippets
will yield different outputs:

&lt;code&gt;
   echo $des-&gt;encrypt(substr($plaintext, 0, 8));
   echo $des-&gt;encrypt(substr($plaintext, 8, 8));
&lt;/code&gt;
&lt;code&gt;
   echo $des-&gt;encrypt($plaintext);
&lt;/code&gt;

The solution is to enable the continuous buffer.  Although this will resolve the above discrepancy, it creates
another, as demonstrated with the following:

&lt;code&gt;
   $des-&gt;encrypt(substr($plaintext, 0, 8));
   echo $des-&gt;decrypt($des-&gt;encrypt(substr($plaintext, 8, 8)));
&lt;/code&gt;
&lt;code&gt;
   echo $des-&gt;decrypt($des-&gt;encrypt(substr($plaintext, 8, 8)));
&lt;/code&gt;

With the continuous buffer disabled, these would yield the same output.  With it enabled, they yield different
outputs.  The reason is due to the fact that the initialization vector's change after every encryption /
decryption round when the continuous buffer is enabled.  When it's disabled, they remain constant.

Put another way, when the continuous buffer is enabled, the state of the Crypt_DES() object changes after each
encryption / decryption round, whereas otherwise, it'd remain constant.  For this reason, it's recommended that
continuous buffers not be used.  They do offer better security and are, in fact, sometimes required (SSH uses them),
however, they are also less intuitive and more likely to cause you problems.</long-description>
          <tag name="see" description="" line="876"/>
          <tag name="access" description="public" line="876"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="894" package="Crypt_TerraDES">
        <name>disableContinuousBuffer</name>
        <full_name>\Crypt_TripleDES::disableContinuousBuffer()</full_name>
        <docblock line="894">
          <description>Treat consecutive packets as if they are a discontinuous buffer.</description>
          <long-description>The default behavior.</long-description>
          <tag name="see" description="" line="894"/>
          <tag name="access" description="public" line="894"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="921" package="Crypt_TerraDES">
        <name>enablePadding</name>
        <full_name>\Crypt_TripleDES::enablePadding()</full_name>
        <docblock line="921">
          <description>Pad "packets".</description>
          <long-description>DES works by encrypting eight bytes at a time.  If you ever need to encrypt or decrypt something that's not
a multiple of eight, it becomes necessary to pad the input so that it's length is a multiple of eight.

Padding is enabled by default.  Sometimes, however, it is undesirable to pad strings.  Such is the case in SSH1,
where "packets" are padded with random bytes before being encrypted.  Unpad these packets and you risk stripping
away characters that shouldn't be stripped away. (SSH knows how many bytes are added because the length is
transmitted separately)</long-description>
          <tag name="see" description="" line="921"/>
          <tag name="access" description="public" line="921"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="932" package="Crypt_TerraDES">
        <name>disablePadding</name>
        <full_name>\Crypt_TripleDES::disablePadding()</full_name>
        <docblock line="932">
          <description>Do not pad packets.</description>
          <long-description></long-description>
          <tag name="see" description="" line="932"/>
          <tag name="access" description="public" line="932"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="949" package="Crypt_TerraDES">
        <name>_pad</name>
        <full_name>\Crypt_TripleDES::_pad()</full_name>
        <docblock line="949">
          <description>Pads a string</description>
          <long-description>Pads a string using the RSA PKCS padding standards so that its length is a multiple of the blocksize (8).
8 - (strlen($text) &amp; 7) bytes are added, each of which is equal to chr(8 - (strlen($text) &amp; 7)

If padding is disabled and $text is not a multiple of the blocksize, the string will be padded regardless
and padding will, hence forth, be enabled.</long-description>
          <tag name="see" description="" line="949"/>
          <tag name="access" description="private" line="949"/>
        </docblock>
        <argument line="0">
          <name>$text</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="975" package="Crypt_TerraDES">
        <name>_unpad</name>
        <full_name>\Crypt_TripleDES::_unpad()</full_name>
        <docblock line="975">
          <description>Unpads a string</description>
          <long-description>If padding is enabled and the reported padding length is invalid the encryption key will be assumed to be wrong
and false will be returned.</long-description>
          <tag name="see" description="" line="975"/>
          <tag name="access" description="private" line="975"/>
        </docblock>
        <argument line="0">
          <name>$text</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1000" package="Crypt_TerraDES">
        <name>_string_shift</name>
        <full_name>\Crypt_TripleDES::_string_shift()</full_name>
        <docblock line="1000">
          <description>String Shift</description>
          <long-description>Inspired by array_shift</long-description>
          <tag name="param" description="" line="1000" type="String" variable="$string">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Integer $index&lt;/p&gt;&#10;" line="1000" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="1000" type="String">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="1000"/>
        </docblock>
        <argument line="0">
          <name>$string</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$index</name>
          <default>1</default>
          <type/>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/3rdParty/phpseclib/Crypt/AES.php" generated-path="lib.3rdParty.phpseclib.Crypt.AES.html" hash="f774eeb89a3bf03c3a594eea40d2538c" package="Crypt_AES">
    <docblock line="0">
      <description>Pure-PHP implementation of AES.</description>
      <long-description>Uses mcrypt, if available, and an internal implementation, otherwise.

PHP versions 4 and 5

If {@link Crypt_AES::setKeyLength() setKeyLength()} isn't called, it'll be calculated from
{@link Crypt_AES::setKey() setKey()}.  ie. if the key is 128-bits, the key length will be 128-bits.  If it's 136-bits
it'll be null-padded to 160-bits and 160 bits will be the key length until {@link Crypt_Rijndael::setKey() setKey()}
is called, again, at which point, it'll be recalculated.

Since Crypt_AES extends Crypt_Rijndael, some functions are available to be called that, in the context of AES, don't
make a whole lot of sense.  {@link Crypt_AES::setBlockLength() setBlockLength()}, for instance.  Calling that function,
however possible, won't do anything (AES has a fixed block length whereas Rijndael has a variable one).

Here's a short example of how to use this library:
&lt;code&gt;
&lt;?php
   include('Crypt/AES.php');

   $aes = new Crypt_AES();

   $aes-&gt;setKey('abcdefghijklmnop');

   $size = 10 * 1024;
   $plaintext = '';
   for ($i = 0; $i &lt; $size; $i++) {
       $plaintext.= 'a';
   }

   echo $aes-&gt;decrypt($aes-&gt;encrypt($plaintext));
?&gt;
&lt;/code&gt;

LICENSE: Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.</long-description>
      <tag name="category" description="Crypt" line="0"/>
      <tag name="package" description="Crypt_AES" line="0"/>
      <tag name="author" description="Jim Wigginton &amp;lt;terrafrost@php.net&amp;gt;" line="0"/>
      <tag name="copyright" description="MMVIII Jim Wigginton" line="0"/>
      <tag name="license" description="MIT License" line="0" link="http://www.opensource.org/licenses/mit-license.html"/>
      <tag name="version" description="$Id: AES.php 4105 2011-05-19 18:02:11Z gruberroland $" line="0"/>
      <tag name="link" description="http://phpseclib.sourceforge.net" line="0"/>
    </docblock>
    <constant namespace="" line="83" package="Crypt_AES">
      <name>CRYPT_AES_MODE_CTR</name>
      <full_name>\\CRYPT_AES_MODE_CTR</full_name>
      <value>-1</value>
      <docblock line="83">
        <description>Encrypt / decrypt using the Counter mode.</description>
        <long-description>Set to -1 since that's what Crypt/Random.php uses to index the CTR mode.</long-description>
        <tag name="link" description="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Counter_.28CTR.29" line="83"/>
      </docblock>
    </constant>
    <constant namespace="" line="89" package="Crypt_AES">
      <name>CRYPT_AES_MODE_ECB</name>
      <full_name>\\CRYPT_AES_MODE_ECB</full_name>
      <value>1</value>
      <docblock line="89">
        <description>Encrypt / decrypt using the Electronic Code Book mode.</description>
        <long-description></long-description>
        <tag name="link" description="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Electronic_codebook_.28ECB.29" line="89"/>
      </docblock>
    </constant>
    <constant namespace="" line="95" package="Crypt_AES">
      <name>CRYPT_AES_MODE_CBC</name>
      <full_name>\\CRYPT_AES_MODE_CBC</full_name>
      <value>2</value>
      <docblock line="95">
        <description>Encrypt / decrypt using the Code Book Chaining mode.</description>
        <long-description></long-description>
        <tag name="link" description="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Cipher-block_chaining_.28CBC.29" line="95"/>
      </docblock>
    </constant>
    <constant namespace="" line="101" package="Crypt_AES">
      <name>CRYPT_AES_MODE_CFB</name>
      <full_name>\\CRYPT_AES_MODE_CFB</full_name>
      <value>3</value>
      <docblock line="101">
        <description>Encrypt / decrypt using the Cipher Feedback mode.</description>
        <long-description></long-description>
        <tag name="link" description="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Cipher_feedback_.28CFB.29" line="101"/>
      </docblock>
    </constant>
    <constant namespace="" line="107" package="Crypt_AES">
      <name>CRYPT_AES_MODE_OFB</name>
      <full_name>\\CRYPT_AES_MODE_OFB</full_name>
      <value>4</value>
      <docblock line="107">
        <description>Encrypt / decrypt using the Cipher Feedback mode.</description>
        <long-description></long-description>
        <tag name="link" description="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Output_feedback_.28OFB.29" line="107"/>
      </docblock>
    </constant>
    <constant namespace="" line="117" package="Crypt_AES">
      <name>CRYPT_AES_MODE_INTERNAL</name>
      <full_name>\\CRYPT_AES_MODE_INTERNAL</full_name>
      <value>1</value>
      <docblock line="117">
        <description>Toggles the internal implementation</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="121" package="Crypt_AES">
      <name>CRYPT_AES_MODE_MCRYPT</name>
      <full_name>\\CRYPT_AES_MODE_MCRYPT</full_name>
      <value>2</value>
      <docblock line="121">
        <description>Toggles the mcrypt implementation</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="188" package="Crypt_AES">
      <name>CRYPT_AES_MODE</name>
      <full_name>\\CRYPT_AES_MODE</full_name>
      <value>CRYPT_AES_MODE_INTERNAL</value>
      <docblock line="188">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <class final="false" abstract="false" namespace="" line="132" package="Crypt_AES">
      <extends>\Crypt_Rijndael</extends>
      <name>Crypt_AES</name>
      <full_name>\Crypt_AES</full_name>
      <docblock line="132">
        <description>Pure-PHP implementation of AES.</description>
        <long-description></long-description>
        <tag name="author" description="Jim Wigginton &amp;lt;terrafrost@php.net&amp;gt;" line="132"/>
        <tag name="version" description="" line="132"/>
        <tag name="access" description="public" line="132"/>
        <tag name="package" description="Crypt_AES" line="132"/>
      </docblock>
      <property static="false" visibility="public" line="143" namespace="" package="Crypt_AES">
        <name>$enmcrypt</name>
        <default></default>
        <docblock line="143">
          <description>mcrypt resource for encryption</description>
          <long-description>The mcrypt resource can be recreated every time something needs to be created or it can be created just once.
Since mcrypt operates in continuous mode, by default, it'll need to be recreated when in non-continuous mode.</long-description>
          <tag name="see" description="" line="143"/>
          <tag name="var" description="" line="143" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="143"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="155" namespace="" package="Crypt_AES">
        <name>$demcrypt</name>
        <default></default>
        <docblock line="155">
          <description>mcrypt resource for decryption</description>
          <long-description>The mcrypt resource can be recreated every time something needs to be created or it can be created just once.
Since mcrypt operates in continuous mode, by default, it'll need to be recreated when in non-continuous mode.</long-description>
          <tag name="see" description="" line="155"/>
          <tag name="var" description="" line="155" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="155"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="165" namespace="" package="Crypt_AES">
        <name>$ecb</name>
        <default></default>
        <docblock line="165">
          <description>mcrypt resource for CFB mode</description>
          <long-description></long-description>
          <tag name="see" description="" line="165"/>
          <tag name="see" description="" line="165"/>
          <tag name="var" description="" line="165" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="165"/>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="177" package="Crypt_AES">
        <name>Crypt_AES</name>
        <full_name>\Crypt_AES::Crypt_AES()</full_name>
        <docblock line="177">
          <description>Default Constructor.</description>
          <long-description>Determines whether or not the mcrypt extension should be used.  $mode should only, at present, be
CRYPT_AES_MODE_ECB or CRYPT_AES_MODE_CBC.  If not explictly set, CRYPT_AES_MODE_CBC will be used.</long-description>
          <tag name="param" description="&lt;p&gt;Integer $mode&lt;/p&gt;&#10;" line="177" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="177" type="\Crypt_AES">
            <type>\Crypt_AES</type>
          </tag>
          <tag name="access" description="public" line="177"/>
        </docblock>
        <argument line="0">
          <name>$mode</name>
          <default>CRYPT_AES_MODE_CBC</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="256" package="Crypt_AES">
        <name>setBlockLength</name>
        <full_name>\Crypt_AES::setBlockLength()</full_name>
        <docblock line="256">
          <description>Dummy function</description>
          <long-description>Since Crypt_AES extends Crypt_Rijndael, this function is, technically, available, but it doesn't do anything.</long-description>
          <tag name="access" description="public" line="256"/>
          <tag name="param" description="" line="256" type="Integer" variable="$length">
            <type>Integer</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$length</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="278" package="Crypt_AES">
        <name>encrypt</name>
        <full_name>\Crypt_AES::encrypt()</full_name>
        <docblock line="278">
          <description>Encrypts a message.</description>
          <long-description>$plaintext will be padded with up to 16 additional bytes.  Other AES implementations may or may not pad in the
same manner.  Other common approaches to padding and the reasons why it's necessary are discussed in the following
URL:

{@link http://www.di-mgt.com.au/cryptopad.html http://www.di-mgt.com.au/cryptopad.html}

An alternative to padding is to, separately, send the length of the file.  This is what SSH, in fact, does.
strlen($plaintext) will still need to be a multiple of 16, however, arbitrary values can be added to make it that
length.</long-description>
          <tag name="see" description="" line="278"/>
          <tag name="access" description="public" line="278"/>
          <tag name="param" description="" line="278" type="String" variable="$plaintext">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$plaintext</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="356" package="Crypt_AES">
        <name>decrypt</name>
        <full_name>\Crypt_AES::decrypt()</full_name>
        <docblock line="356">
          <description>Decrypts a message.</description>
          <long-description>If strlen($ciphertext) is not a multiple of 16, null bytes will be added to the end of the string until it is.</long-description>
          <tag name="see" description="" line="356"/>
          <tag name="access" description="public" line="356"/>
          <tag name="param" description="" line="356" type="String" variable="$ciphertext">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$ciphertext</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="432" package="Crypt_AES">
        <name>_mcryptSetup</name>
        <full_name>\Crypt_AES::_mcryptSetup()</full_name>
        <docblock line="432">
          <description>Setup mcrypt</description>
          <long-description>Validates all the variables.</long-description>
          <tag name="access" description="private" line="432"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="490" package="Crypt_AES">
        <name>_encryptBlock</name>
        <full_name>\Crypt_AES::_encryptBlock()</full_name>
        <docblock line="490">
          <description>Encrypts a block</description>
          <long-description>Optimized over Crypt_Rijndael's implementation by means of loop unrolling.</long-description>
          <tag name="see" description="" line="490"/>
          <tag name="access" description="private" line="490"/>
          <tag name="param" description="" line="490" type="String" variable="$in">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="490" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$in</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="551" package="Crypt_AES">
        <name>_decryptBlock</name>
        <full_name>\Crypt_AES::_decryptBlock()</full_name>
        <docblock line="551">
          <description>Decrypts a block</description>
          <long-description>Optimized over Crypt_Rijndael's implementation by means of loop unrolling.</long-description>
          <tag name="see" description="" line="551"/>
          <tag name="access" description="private" line="551"/>
          <tag name="param" description="" line="551" type="String" variable="$in">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="551" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$in</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/3rdParty/phpseclib/Crypt/RC4.php" generated-path="lib.3rdParty.phpseclib.Crypt.RC4.html" hash="437d9bed3526e367fef644daefa5d3e4" package="Crypt_RC4">
    <docblock line="0">
      <description>Pure-PHP implementation of RC4.</description>
      <long-description>Uses mcrypt, if available, and an internal implementation, otherwise.

PHP versions 4 and 5

Useful resources are as follows:

 - {@link http://www.mozilla.org/projects/security/pki/nss/draft-kaukonen-cipher-arcfour-03.txt ARCFOUR Algorithm}
 - {@link http://en.wikipedia.org/wiki/RC4 - Wikipedia: RC4}

RC4 is also known as ARCFOUR or ARC4.  The reason is elaborated upon at Wikipedia.  This class is named RC4 and not
ARCFOUR or ARC4 because RC4 is how it is refered to in the SSH1 specification.

Here's a short example of how to use this library:
&lt;code&gt;
&lt;?php
   include('Crypt/RC4.php');

   $rc4 = new Crypt_RC4();

   $rc4-&gt;setKey('abcdefgh');

   $size = 10 * 1024;
   $plaintext = '';
   for ($i = 0; $i &lt; $size; $i++) {
       $plaintext.= 'a';
   }

   echo $rc4-&gt;decrypt($rc4-&gt;encrypt($plaintext));
?&gt;
&lt;/code&gt;

LICENSE: Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.</long-description>
      <tag name="category" description="Crypt" line="0"/>
      <tag name="package" description="Crypt_RC4" line="0"/>
      <tag name="author" description="Jim Wigginton &amp;lt;terrafrost@php.net&amp;gt;" line="0"/>
      <tag name="copyright" description="MMVII Jim Wigginton" line="0"/>
      <tag name="license" description="MIT License" line="0" link="http://www.opensource.org/licenses/mit-license.html"/>
      <tag name="version" description="$Id: RC4.php 4105 2011-05-19 18:02:11Z gruberroland $" line="0"/>
      <tag name="link" description="http://phpseclib.sourceforge.net" line="0"/>
    </docblock>
    <constant namespace="" line="72" package="Crypt_RC4">
      <name>CRYPT_RC4_MODE_INTERNAL</name>
      <full_name>\\CRYPT_RC4_MODE_INTERNAL</full_name>
      <value>1</value>
      <docblock line="72">
        <description>Toggles the internal implementation</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="76" package="Crypt_RC4">
      <name>CRYPT_RC4_MODE_MCRYPT</name>
      <full_name>\\CRYPT_RC4_MODE_MCRYPT</full_name>
      <value>2</value>
      <docblock line="76">
        <description>Toggles the mcrypt implementation</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="83" package="Crypt_RC4">
      <name>CRYPT_RC4_ENCRYPT</name>
      <full_name>\\CRYPT_RC4_ENCRYPT</full_name>
      <value>0</value>
      <docblock line="83">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="84" package="Crypt_RC4">
      <name>CRYPT_RC4_DECRYPT</name>
      <full_name>\\CRYPT_RC4_DECRYPT</full_name>
      <value>1</value>
      <docblock line="84">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="194" package="Crypt_RC4">
      <name>CRYPT_RC4_MODE</name>
      <full_name>\\CRYPT_RC4_MODE</full_name>
      <value>CRYPT_RC4_MODE_INTERNAL</value>
      <docblock line="194">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <class final="false" abstract="false" namespace="" line="95" package="Crypt_RC4">
      <extends/>
      <name>Crypt_RC4</name>
      <full_name>\Crypt_RC4</full_name>
      <docblock line="95">
        <description>Pure-PHP implementation of RC4.</description>
        <long-description></long-description>
        <tag name="author" description="Jim Wigginton &amp;lt;terrafrost@php.net&amp;gt;" line="95"/>
        <tag name="version" description="" line="95"/>
        <tag name="access" description="public" line="95"/>
        <tag name="package" description="Crypt_RC4" line="95"/>
      </docblock>
      <property static="false" visibility="public" line="103" namespace="" package="Crypt_RC4">
        <name>$key</name>
        <default>"\0"</default>
        <docblock line="103">
          <description>The Key</description>
          <long-description></long-description>
          <tag name="see" description="" line="103"/>
          <tag name="var" description="" line="103" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="103"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="114" namespace="" package="Crypt_RC4">
        <name>$encryptStream</name>
        <default>false</default>
        <docblock line="114">
          <description>The Key Stream for encryption</description>
          <long-description>If CRYPT_RC4_MODE == CRYPT_RC4_MODE_MCRYPT, this will be equal to the mcrypt object</long-description>
          <tag name="see" description="" line="114"/>
          <tag name="var" description="" line="114" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="114"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="125" namespace="" package="Crypt_RC4">
        <name>$decryptStream</name>
        <default>false</default>
        <docblock line="125">
          <description>The Key Stream for decryption</description>
          <long-description>If CRYPT_RC4_MODE == CRYPT_RC4_MODE_MCRYPT, this will be equal to the mcrypt object</long-description>
          <tag name="see" description="" line="125"/>
          <tag name="var" description="" line="125" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="125"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="134" namespace="" package="Crypt_RC4">
        <name>$encryptIndex</name>
        <default>0</default>
        <docblock line="134">
          <description>The $i and $j indexes for encryption</description>
          <long-description></long-description>
          <tag name="see" description="" line="134"/>
          <tag name="var" description="" line="134" type="Integer" variable="">
            <type>Integer</type>
          </tag>
          <tag name="access" description="private" line="134"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="143" namespace="" package="Crypt_RC4">
        <name>$decryptIndex</name>
        <default>0</default>
        <docblock line="143">
          <description>The $i and $j indexes for decryption</description>
          <long-description></long-description>
          <tag name="see" description="" line="143"/>
          <tag name="var" description="" line="143" type="Integer" variable="">
            <type>Integer</type>
          </tag>
          <tag name="access" description="private" line="143"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="152" namespace="" package="Crypt_RC4">
        <name>$mcrypt</name>
        <default>array('', '')</default>
        <docblock line="152">
          <description>MCrypt parameters</description>
          <long-description></long-description>
          <tag name="see" description="" line="152"/>
          <tag name="var" description="" line="152" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="152"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="163" namespace="" package="Crypt_RC4">
        <name>$mode</name>
        <default></default>
        <docblock line="163">
          <description>The Encryption Algorithm</description>
          <long-description>Only used if CRYPT_RC4_MODE == CRYPT_RC4_MODE_MCRYPT.  Only possible values are MCRYPT_RC4 or MCRYPT_ARCFOUR.</long-description>
          <tag name="see" description="" line="163"/>
          <tag name="var" description="" line="163" type="Integer" variable="">
            <type>Integer</type>
          </tag>
          <tag name="access" description="private" line="163"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="172" namespace="" package="Crypt_RC4">
        <name>$continuousBuffer</name>
        <default>false</default>
        <docblock line="172">
          <description>Continuous Buffer status</description>
          <long-description></long-description>
          <tag name="see" description="" line="172"/>
          <tag name="var" description="" line="172" type="Boolean" variable="">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="private" line="172"/>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="183" package="Crypt_RC4">
        <name>Crypt_RC4</name>
        <full_name>\Crypt_RC4::Crypt_RC4()</full_name>
        <docblock line="183">
          <description>Default Constructor.</description>
          <long-description>Determines whether or not the mcrypt extension should be used.</long-description>
          <tag name="param" description="&lt;p&gt;Integer $mode&lt;/p&gt;&#10;" line="183" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="183" type="\Crypt_RC4">
            <type>\Crypt_RC4</type>
          </tag>
          <tag name="access" description="public" line="183"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="219" package="Crypt_RC4">
        <name>setKey</name>
        <full_name>\Crypt_RC4::setKey()</full_name>
        <docblock line="219">
          <description>Sets the key.</description>
          <long-description>Keys can be between 1 and 256 bytes long.  If they are longer then 256 bytes, the first 256 bytes will
be used.  If no key is explicitly set, it'll be assumed to be a single null byte.</long-description>
          <tag name="access" description="public" line="219"/>
          <tag name="param" description="" line="219" type="String" variable="$key">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$key</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="263" package="Crypt_RC4">
        <name>setIV</name>
        <full_name>\Crypt_RC4::setIV()</full_name>
        <docblock line="263">
          <description>Dummy function.</description>
          <long-description>Some protocols, such as WEP, prepend an "initialization vector" to the key, effectively creating a new key [1].
If you need to use an initialization vector in this manner, feel free to prepend it to the key, yourself, before
calling setKey().

[1] WEP's initialization vectors (IV's) are used in a somewhat insecure way.  Since, in that protocol,
the IV's are relatively easy to predict, an attack described by
{@link http://www.drizzle.com/~aboba/IEEE/rc4_ksaproc.pdf Scott Fluhrer, Itsik Mantin, and Adi Shamir}
can be used to quickly guess at the rest of the key.  The following links elaborate:

{@link http://www.rsa.com/rsalabs/node.asp?id=2009 http://www.rsa.com/rsalabs/node.asp?id=2009}
{@link http://en.wikipedia.org/wiki/Related_key_attack http://en.wikipedia.org/wiki/Related_key_attack}</long-description>
          <tag name="param" description="" line="263" type="String" variable="$iv">
            <type>String</type>
          </tag>
          <tag name="see" description="" line="263"/>
          <tag name="access" description="public" line="263"/>
        </docblock>
        <argument line="0">
          <name>$iv</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="277" package="Crypt_RC4">
        <name>setMCrypt</name>
        <full_name>\Crypt_RC4::setMCrypt()</full_name>
        <docblock line="277">
          <description>Sets MCrypt parameters. (optional)</description>
          <long-description>If MCrypt is being used, empty strings will be used, unless otherwise specified.</long-description>
          <tag name="link" description="http://php.net/function.mcrypt-module-open#function.mcrypt-module-open" line="277"/>
          <tag name="access" description="public" line="277"/>
          <tag name="param" description="&lt;p&gt;Integer $algorithm_directory&lt;/p&gt;&#10;" line="277" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Integer $mode_directory&lt;/p&gt;&#10;" line="277" type="\optional" variable="">
            <type>\optional</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$algorithm_directory</name>
          <default>''</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$mode_directory</name>
          <default>''</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="292" package="Crypt_RC4">
        <name>encrypt</name>
        <full_name>\Crypt_RC4::encrypt()</full_name>
        <docblock line="292">
          <description>Encrypts a message.</description>
          <long-description></long-description>
          <tag name="see" description="" line="292"/>
          <tag name="access" description="public" line="292"/>
          <tag name="param" description="" line="292" type="String" variable="$plaintext">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$plaintext</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="307" package="Crypt_RC4">
        <name>decrypt</name>
        <full_name>\Crypt_RC4::decrypt()</full_name>
        <docblock line="307">
          <description>Decrypts a message.</description>
          <long-description>$this-&gt;decrypt($this-&gt;encrypt($plaintext)) == $this-&gt;encrypt($this-&gt;encrypt($plaintext)).
Atleast if the continuous buffer is disabled.</long-description>
          <tag name="see" description="" line="307"/>
          <tag name="access" description="public" line="307"/>
          <tag name="param" description="" line="307" type="String" variable="$ciphertext">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$ciphertext</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="321" package="Crypt_RC4">
        <name>_crypt</name>
        <full_name>\Crypt_RC4::_crypt()</full_name>
        <docblock line="321">
          <description>Encrypts or decrypts a message.</description>
          <long-description></long-description>
          <tag name="see" description="" line="321"/>
          <tag name="see" description="" line="321"/>
          <tag name="access" description="private" line="321"/>
          <tag name="param" description="" line="321" type="String" variable="$text">
            <type>String</type>
          </tag>
          <tag name="param" description="" line="321" type="Integer" variable="$mode">
            <type>Integer</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$text</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$mode</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="417" package="Crypt_RC4">
        <name>enableContinuousBuffer</name>
        <full_name>\Crypt_RC4::enableContinuousBuffer()</full_name>
        <docblock line="417">
          <description>Treat consecutive "packets" as if they are a continuous buffer.</description>
          <long-description>Say you have a 16-byte plaintext $plaintext.  Using the default behavior, the two following code snippets
will yield different outputs:

&lt;code&gt;
   echo $rc4-&gt;encrypt(substr($plaintext, 0, 8));
   echo $rc4-&gt;encrypt(substr($plaintext, 8, 8));
&lt;/code&gt;
&lt;code&gt;
   echo $rc4-&gt;encrypt($plaintext);
&lt;/code&gt;

The solution is to enable the continuous buffer.  Although this will resolve the above discrepancy, it creates
another, as demonstrated with the following:

&lt;code&gt;
   $rc4-&gt;encrypt(substr($plaintext, 0, 8));
   echo $rc4-&gt;decrypt($des-&gt;encrypt(substr($plaintext, 8, 8)));
&lt;/code&gt;
&lt;code&gt;
   echo $rc4-&gt;decrypt($des-&gt;encrypt(substr($plaintext, 8, 8)));
&lt;/code&gt;

With the continuous buffer disabled, these would yield the same output.  With it enabled, they yield different
outputs.  The reason is due to the fact that the initialization vector's change after every encryption /
decryption round when the continuous buffer is enabled.  When it's disabled, they remain constant.

Put another way, when the continuous buffer is enabled, the state of the Crypt_DES() object changes after each
encryption / decryption round, whereas otherwise, it'd remain constant.  For this reason, it's recommended that
continuous buffers not be used.  They do offer better security and are, in fact, sometimes required (SSH uses them),
however, they are also less intuitive and more likely to cause you problems.</long-description>
          <tag name="see" description="" line="417"/>
          <tag name="access" description="public" line="417"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="430" package="Crypt_RC4">
        <name>disableContinuousBuffer</name>
        <full_name>\Crypt_RC4::disableContinuousBuffer()</full_name>
        <docblock line="430">
          <description>Treat consecutive packets as if they are a discontinuous buffer.</description>
          <long-description>The default behavior.</long-description>
          <tag name="see" description="" line="430"/>
          <tag name="access" description="public" line="430"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="449" package="Crypt_RC4">
        <name>enablePadding</name>
        <full_name>\Crypt_RC4::enablePadding()</full_name>
        <docblock line="449">
          <description>Dummy function.</description>
          <long-description>Since RC4 is a stream cipher and not a block cipher, no padding is necessary.  The only reason this function is
included is so that you can switch between a block cipher and a stream cipher transparently.</long-description>
          <tag name="see" description="" line="449"/>
          <tag name="access" description="public" line="449"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="459" package="Crypt_RC4">
        <name>disablePadding</name>
        <full_name>\Crypt_RC4::disablePadding()</full_name>
        <docblock line="459">
          <description>Dummy function.</description>
          <long-description></long-description>
          <tag name="see" description="" line="459"/>
          <tag name="access" description="public" line="459"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="471" package="Crypt_RC4">
        <name>__destruct</name>
        <full_name>\Crypt_RC4::__destruct()</full_name>
        <docblock line="471">
          <description>Class destructor.</description>
          <long-description>Will be called, automatically, if you're using PHP5.  If you're using PHP4, call it yourself.  Only really
needs to be called if mcrypt is being used.</long-description>
          <tag name="access" description="public" line="471"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="483" package="Crypt_RC4">
        <name>_closeMCrypt</name>
        <full_name>\Crypt_RC4::_closeMCrypt()</full_name>
        <docblock line="483">
          <description>Properly close the MCrypt objects.</description>
          <long-description></long-description>
          <tag name="access" description="prviate" line="483"/>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/3rdParty/phpseclib/Crypt/DES.php" generated-path="lib.3rdParty.phpseclib.Crypt.DES.html" hash="a5b126545ee10145d0cd2e1a0bfde541" package="Crypt_DES">
    <docblock line="0">
      <description>Pure-PHP implementation of DES.</description>
      <long-description>Uses mcrypt, if available, and an internal implementation, otherwise.

PHP versions 4 and 5

Useful resources are as follows:

 - {@link http://en.wikipedia.org/wiki/DES_supplementary_material Wikipedia: DES supplementary material}
 - {@link http://www.itl.nist.gov/fipspubs/fip46-2.htm FIPS 46-2 - (DES), Data Encryption Standard}
 - {@link http://www.cs.eku.edu/faculty/styer/460/Encrypt/JS-DES.html JavaScript DES Example}

Here's a short example of how to use this library:
&lt;code&gt;
&lt;?php
   include('Crypt/DES.php');

   $des = new Crypt_DES();

   $des-&gt;setKey('abcdefgh');

   $size = 10 * 1024;
   $plaintext = '';
   for ($i = 0; $i &lt; $size; $i++) {
       $plaintext.= 'a';
   }

   echo $des-&gt;decrypt($des-&gt;encrypt($plaintext));
?&gt;
&lt;/code&gt;

LICENSE: Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.</long-description>
      <tag name="category" description="Crypt" line="0"/>
      <tag name="package" description="Crypt_DES" line="0"/>
      <tag name="author" description="Jim Wigginton &amp;lt;terrafrost@php.net&amp;gt;" line="0"/>
      <tag name="copyright" description="MMVII Jim Wigginton" line="0"/>
      <tag name="license" description="MIT License" line="0" link="http://www.opensource.org/licenses/mit-license.html"/>
      <tag name="version" description="$Id: DES.php 4105 2011-05-19 18:02:11Z gruberroland $" line="0"/>
      <tag name="link" description="http://phpseclib.sourceforge.net" line="0"/>
    </docblock>
    <constant namespace="" line="71" package="Crypt_DES">
      <name>CRYPT_DES_ENCRYPT</name>
      <full_name>\\CRYPT_DES_ENCRYPT</full_name>
      <value>0</value>
      <docblock line="71">
        <description>Contains array_reverse($keys[CRYPT_DES_DECRYPT])</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="75" package="Crypt_DES">
      <name>CRYPT_DES_DECRYPT</name>
      <full_name>\\CRYPT_DES_DECRYPT</full_name>
      <value>1</value>
      <docblock line="75">
        <description>Contains array_reverse($keys[CRYPT_DES_ENCRYPT])</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="90" package="Crypt_DES">
      <name>CRYPT_DES_MODE_CTR</name>
      <full_name>\\CRYPT_DES_MODE_CTR</full_name>
      <value>-1</value>
      <docblock line="90">
        <description>Encrypt / decrypt using the Counter mode.</description>
        <long-description>Set to -1 since that's what Crypt/Random.php uses to index the CTR mode.</long-description>
        <tag name="link" description="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Counter_.28CTR.29" line="90"/>
      </docblock>
    </constant>
    <constant namespace="" line="96" package="Crypt_DES">
      <name>CRYPT_DES_MODE_ECB</name>
      <full_name>\\CRYPT_DES_MODE_ECB</full_name>
      <value>1</value>
      <docblock line="96">
        <description>Encrypt / decrypt using the Electronic Code Book mode.</description>
        <long-description></long-description>
        <tag name="link" description="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Electronic_codebook_.28ECB.29" line="96"/>
      </docblock>
    </constant>
    <constant namespace="" line="102" package="Crypt_DES">
      <name>CRYPT_DES_MODE_CBC</name>
      <full_name>\\CRYPT_DES_MODE_CBC</full_name>
      <value>2</value>
      <docblock line="102">
        <description>Encrypt / decrypt using the Code Book Chaining mode.</description>
        <long-description></long-description>
        <tag name="link" description="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Cipher-block_chaining_.28CBC.29" line="102"/>
      </docblock>
    </constant>
    <constant namespace="" line="108" package="Crypt_DES">
      <name>CRYPT_DES_MODE_CFB</name>
      <full_name>\\CRYPT_DES_MODE_CFB</full_name>
      <value>3</value>
      <docblock line="108">
        <description>Encrypt / decrypt using the Cipher Feedback mode.</description>
        <long-description></long-description>
        <tag name="link" description="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Cipher_feedback_.28CFB.29" line="108"/>
      </docblock>
    </constant>
    <constant namespace="" line="114" package="Crypt_DES">
      <name>CRYPT_DES_MODE_OFB</name>
      <full_name>\\CRYPT_DES_MODE_OFB</full_name>
      <value>4</value>
      <docblock line="114">
        <description>Encrypt / decrypt using the Cipher Feedback mode.</description>
        <long-description></long-description>
        <tag name="link" description="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Output_feedback_.28OFB.29" line="114"/>
      </docblock>
    </constant>
    <constant namespace="" line="124" package="Crypt_DES">
      <name>CRYPT_DES_MODE_INTERNAL</name>
      <full_name>\\CRYPT_DES_MODE_INTERNAL</full_name>
      <value>1</value>
      <docblock line="124">
        <description>Toggles the internal implementation</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="128" package="Crypt_DES">
      <name>CRYPT_DES_MODE_MCRYPT</name>
      <full_name>\\CRYPT_DES_MODE_MCRYPT</full_name>
      <value>2</value>
      <docblock line="128">
        <description>Toggles the mcrypt implementation</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="305" package="Crypt_DES">
      <name>CRYPT_DES_MODE</name>
      <full_name>\\CRYPT_DES_MODE</full_name>
      <value>CRYPT_DES_MODE_INTERNAL</value>
      <docblock line="305">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <class final="false" abstract="false" namespace="" line="139" package="Crypt_DES">
      <extends/>
      <name>Crypt_DES</name>
      <full_name>\Crypt_DES</full_name>
      <docblock line="139">
        <description>Pure-PHP implementation of DES.</description>
        <long-description></long-description>
        <tag name="author" description="Jim Wigginton &amp;lt;terrafrost@php.net&amp;gt;" line="139"/>
        <tag name="version" description="" line="139"/>
        <tag name="access" description="public" line="139"/>
        <tag name="package" description="Crypt_DES" line="139"/>
      </docblock>
      <property static="false" visibility="public" line="147" namespace="" package="Crypt_DES">
        <name>$keys</name>
        <default>"\0\0\0\0\0\0\0\0"</default>
        <docblock line="147">
          <description>The Key Schedule</description>
          <long-description></long-description>
          <tag name="see" description="" line="147"/>
          <tag name="var" description="" line="147" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="147"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="156" namespace="" package="Crypt_DES">
        <name>$mode</name>
        <default></default>
        <docblock line="156">
          <description>The Encryption Mode</description>
          <long-description></long-description>
          <tag name="see" description="" line="156"/>
          <tag name="var" description="" line="156" type="Integer" variable="">
            <type>Integer</type>
          </tag>
          <tag name="access" description="private" line="156"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="165" namespace="" package="Crypt_DES">
        <name>$continuousBuffer</name>
        <default>false</default>
        <docblock line="165">
          <description>Continuous Buffer status</description>
          <long-description></long-description>
          <tag name="see" description="" line="165"/>
          <tag name="var" description="" line="165" type="Boolean" variable="">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="private" line="165"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="174" namespace="" package="Crypt_DES">
        <name>$padding</name>
        <default>true</default>
        <docblock line="174">
          <description>Padding status</description>
          <long-description></long-description>
          <tag name="see" description="" line="174"/>
          <tag name="var" description="" line="174" type="Boolean" variable="">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="private" line="174"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="183" namespace="" package="Crypt_DES">
        <name>$iv</name>
        <default>"\0\0\0\0\0\0\0\0"</default>
        <docblock line="183">
          <description>The Initialization Vector</description>
          <long-description></long-description>
          <tag name="see" description="" line="183"/>
          <tag name="var" description="" line="183" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="183"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="192" namespace="" package="Crypt_DES">
        <name>$encryptIV</name>
        <default>"\0\0\0\0\0\0\0\0"</default>
        <docblock line="192">
          <description>A "sliding" Initialization Vector</description>
          <long-description></long-description>
          <tag name="see" description="" line="192"/>
          <tag name="var" description="" line="192" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="192"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="201" namespace="" package="Crypt_DES">
        <name>$decryptIV</name>
        <default>"\0\0\0\0\0\0\0\0"</default>
        <docblock line="201">
          <description>A "sliding" Initialization Vector</description>
          <long-description></long-description>
          <tag name="see" description="" line="201"/>
          <tag name="var" description="" line="201" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="201"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="213" namespace="" package="Crypt_DES">
        <name>$enmcrypt</name>
        <default></default>
        <docblock line="213">
          <description>mcrypt resource for encryption</description>
          <long-description>The mcrypt resource can be recreated every time something needs to be created or it can be created just once.
Since mcrypt operates in continuous mode, by default, it'll need to be recreated when in non-continuous mode.</long-description>
          <tag name="see" description="" line="213"/>
          <tag name="var" description="" line="213" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="213"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="225" namespace="" package="Crypt_DES">
        <name>$demcrypt</name>
        <default></default>
        <docblock line="225">
          <description>mcrypt resource for decryption</description>
          <long-description>The mcrypt resource can be recreated every time something needs to be created or it can be created just once.
Since mcrypt operates in continuous mode, by default, it'll need to be recreated when in non-continuous mode.</long-description>
          <tag name="see" description="" line="225"/>
          <tag name="var" description="" line="225" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="225"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="235" namespace="" package="Crypt_DES">
        <name>$enchanged</name>
        <default>true</default>
        <docblock line="235">
          <description>Does the enmcrypt resource need to be (re)initialized?</description>
          <long-description></long-description>
          <tag name="see" description="" line="235"/>
          <tag name="see" description="" line="235"/>
          <tag name="var" description="" line="235" type="Boolean" variable="">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="private" line="235"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="245" namespace="" package="Crypt_DES">
        <name>$dechanged</name>
        <default>true</default>
        <docblock line="245">
          <description>Does the demcrypt resource need to be (re)initialized?</description>
          <long-description></long-description>
          <tag name="see" description="" line="245"/>
          <tag name="see" description="" line="245"/>
          <tag name="var" description="" line="245" type="Boolean" variable="">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="private" line="245"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="254" namespace="" package="Crypt_DES">
        <name>$paddable</name>
        <default>false</default>
        <docblock line="254">
          <description>Is the mode one that is paddable?</description>
          <long-description></long-description>
          <tag name="see" description="" line="254"/>
          <tag name="var" description="" line="254" type="Boolean" variable="">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="private" line="254"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="263" namespace="" package="Crypt_DES">
        <name>$enbuffer</name>
        <default>''</default>
        <docblock line="263">
          <description>Encryption buffer for CTR, OFB and CFB modes</description>
          <long-description></long-description>
          <tag name="see" description="" line="263"/>
          <tag name="var" description="" line="263" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="263"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="272" namespace="" package="Crypt_DES">
        <name>$debuffer</name>
        <default>''</default>
        <docblock line="272">
          <description>Decryption buffer for CTR, OFB and CFB modes</description>
          <long-description></long-description>
          <tag name="see" description="" line="272"/>
          <tag name="var" description="" line="272" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="272"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="282" namespace="" package="Crypt_DES">
        <name>$ecb</name>
        <default></default>
        <docblock line="282">
          <description>mcrypt resource for CFB mode</description>
          <long-description></long-description>
          <tag name="see" description="" line="282"/>
          <tag name="see" description="" line="282"/>
          <tag name="var" description="" line="282" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="282"/>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="294" package="Crypt_DES">
        <name>Crypt_DES</name>
        <full_name>\Crypt_DES::Crypt_DES()</full_name>
        <docblock line="294">
          <description>Default Constructor.</description>
          <long-description>Determines whether or not the mcrypt extension should be used.  $mode should only, at present, be
CRYPT_DES_MODE_ECB or CRYPT_DES_MODE_CBC.  If not explictly set, CRYPT_DES_MODE_CBC will be used.</long-description>
          <tag name="param" description="&lt;p&gt;Integer $mode&lt;/p&gt;&#10;" line="294" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="294" type="\Crypt_DES">
            <type>\Crypt_DES</type>
          </tag>
          <tag name="access" description="public" line="294"/>
        </docblock>
        <argument line="0">
          <name>$mode</name>
          <default>CRYPT_MODE_DES_CBC</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="366" package="Crypt_DES">
        <name>setKey</name>
        <full_name>\Crypt_DES::setKey()</full_name>
        <docblock line="366">
          <description>Sets the key.</description>
          <long-description>Keys can be of any length.  DES, itself, uses 64-bit keys (eg. strlen($key) == 8), however, we
only use the first eight, if $key has more then eight characters in it, and pad $key with the
null byte if it is less then eight characters long.

DES also requires that every eighth bit be a parity bit, however, we'll ignore that.

If the key is not explicitly set, it'll be assumed to be all zero's.</long-description>
          <tag name="access" description="public" line="366"/>
          <tag name="param" description="" line="366" type="String" variable="$key">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$key</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="381" package="Crypt_DES">
        <name>setIV</name>
        <full_name>\Crypt_DES::setIV()</full_name>
        <docblock line="381">
          <description>Sets the initialization vector. (optional)</description>
          <long-description>SetIV is not required when CRYPT_DES_MODE_ECB is being used.  If not explictly set, it'll be assumed
to be all zero's.</long-description>
          <tag name="access" description="public" line="381"/>
          <tag name="param" description="" line="381" type="String" variable="$iv">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$iv</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="399" package="Crypt_DES">
        <name>_generate_xor</name>
        <full_name>\Crypt_DES::_generate_xor()</full_name>
        <docblock line="399">
          <description>Generate CTR XOR encryption key</description>
          <long-description>Encrypt the output of this and XOR it against the ciphertext / plaintext to get the
plaintext / ciphertext in CTR mode.</long-description>
          <tag name="see" description="" line="399"/>
          <tag name="see" description="" line="399"/>
          <tag name="access" description="public" line="399"/>
          <tag name="param" description="" line="399" type="Integer" variable="$length">
            <type>Integer</type>
          </tag>
          <tag name="param" description="" line="399" type="String" variable="$iv">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$length</name>
          <default></default>
          <type>Integer</type>
        </argument>
        <argument line="0">
          <name>$iv</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="442" package="Crypt_DES">
        <name>encrypt</name>
        <full_name>\Crypt_DES::encrypt()</full_name>
        <docblock line="442">
          <description>Encrypts a message.</description>
          <long-description>$plaintext will be padded with up to 8 additional bytes.  Other DES implementations may or may not pad in the
same manner.  Other common approaches to padding and the reasons why it's necessary are discussed in the following
URL:

{@link http://www.di-mgt.com.au/cryptopad.html http://www.di-mgt.com.au/cryptopad.html}

An alternative to padding is to, separately, send the length of the file.  This is what SSH, in fact, does.
strlen($plaintext) will still need to be a multiple of 8, however, arbitrary values can be added to make it that
length.</long-description>
          <tag name="see" description="" line="442"/>
          <tag name="access" description="public" line="442"/>
          <tag name="param" description="" line="442" type="String" variable="$plaintext">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$plaintext</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="615" package="Crypt_DES">
        <name>decrypt</name>
        <full_name>\Crypt_DES::decrypt()</full_name>
        <docblock line="615">
          <description>Decrypts a message.</description>
          <long-description>If strlen($ciphertext) is not a multiple of 8, null bytes will be added to the end of the string until it is.</long-description>
          <tag name="see" description="" line="615"/>
          <tag name="access" description="public" line="615"/>
          <tag name="param" description="" line="615" type="String" variable="$ciphertext">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$ciphertext</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="820" package="Crypt_DES">
        <name>enableContinuousBuffer</name>
        <full_name>\Crypt_DES::enableContinuousBuffer()</full_name>
        <docblock line="820">
          <description>Treat consecutive "packets" as if they are a continuous buffer.</description>
          <long-description>Say you have a 16-byte plaintext $plaintext.  Using the default behavior, the two following code snippets
will yield different outputs:

&lt;code&gt;
   echo $des-&gt;encrypt(substr($plaintext, 0, 8));
   echo $des-&gt;encrypt(substr($plaintext, 8, 8));
&lt;/code&gt;
&lt;code&gt;
   echo $des-&gt;encrypt($plaintext);
&lt;/code&gt;

The solution is to enable the continuous buffer.  Although this will resolve the above discrepancy, it creates
another, as demonstrated with the following:

&lt;code&gt;
   $des-&gt;encrypt(substr($plaintext, 0, 8));
   echo $des-&gt;decrypt($des-&gt;encrypt(substr($plaintext, 8, 8)));
&lt;/code&gt;
&lt;code&gt;
   echo $des-&gt;decrypt($des-&gt;encrypt(substr($plaintext, 8, 8)));
&lt;/code&gt;

With the continuous buffer disabled, these would yield the same output.  With it enabled, they yield different
outputs.  The reason is due to the fact that the initialization vector's change after every encryption /
decryption round when the continuous buffer is enabled.  When it's disabled, they remain constant.

Put another way, when the continuous buffer is enabled, the state of the Crypt_DES() object changes after each
encryption / decryption round, whereas otherwise, it'd remain constant.  For this reason, it's recommended that
continuous buffers not be used.  They do offer better security and are, in fact, sometimes required (SSH uses them),
however, they are also less intuitive and more likely to cause you problems.</long-description>
          <tag name="see" description="" line="820"/>
          <tag name="access" description="public" line="820"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="833" package="Crypt_DES">
        <name>disableContinuousBuffer</name>
        <full_name>\Crypt_DES::disableContinuousBuffer()</full_name>
        <docblock line="833">
          <description>Treat consecutive packets as if they are a discontinuous buffer.</description>
          <long-description>The default behavior.</long-description>
          <tag name="see" description="" line="833"/>
          <tag name="access" description="public" line="833"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="854" package="Crypt_DES">
        <name>enablePadding</name>
        <full_name>\Crypt_DES::enablePadding()</full_name>
        <docblock line="854">
          <description>Pad "packets".</description>
          <long-description>DES works by encrypting eight bytes at a time.  If you ever need to encrypt or decrypt something that's not
a multiple of eight, it becomes necessary to pad the input so that it's length is a multiple of eight.

Padding is enabled by default.  Sometimes, however, it is undesirable to pad strings.  Such is the case in SSH1,
where "packets" are padded with random bytes before being encrypted.  Unpad these packets and you risk stripping
away characters that shouldn't be stripped away. (SSH knows how many bytes are added because the length is
transmitted separately)</long-description>
          <tag name="see" description="" line="854"/>
          <tag name="access" description="public" line="854"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="865" package="Crypt_DES">
        <name>disablePadding</name>
        <full_name>\Crypt_DES::disablePadding()</full_name>
        <docblock line="865">
          <description>Do not pad packets.</description>
          <long-description></long-description>
          <tag name="see" description="" line="865"/>
          <tag name="access" description="public" line="865"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="882" package="Crypt_DES">
        <name>_pad</name>
        <full_name>\Crypt_DES::_pad()</full_name>
        <docblock line="882">
          <description>Pads a string</description>
          <long-description>Pads a string using the RSA PKCS padding standards so that its length is a multiple of the blocksize (8).
8 - (strlen($text) &amp; 7) bytes are added, each of which is equal to chr(8 - (strlen($text) &amp; 7)

If padding is disabled and $text is not a multiple of the blocksize, the string will be padded regardless
and padding will, hence forth, be enabled.</long-description>
          <tag name="see" description="" line="882"/>
          <tag name="access" description="private" line="882"/>
        </docblock>
        <argument line="0">
          <name>$text</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="908" package="Crypt_DES">
        <name>_unpad</name>
        <full_name>\Crypt_DES::_unpad()</full_name>
        <docblock line="908">
          <description>Unpads a string</description>
          <long-description>If padding is enabled and the reported padding length is invalid the encryption key will be assumed to be wrong
and false will be returned.</long-description>
          <tag name="see" description="" line="908"/>
          <tag name="access" description="private" line="908"/>
        </docblock>
        <argument line="0">
          <name>$text</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="935" package="Crypt_DES">
        <name>_processBlock</name>
        <full_name>\Crypt_DES::_processBlock()</full_name>
        <docblock line="935">
          <description>Encrypts or decrypts a 64-bit block</description>
          <long-description>$mode should be either CRYPT_DES_ENCRYPT or CRYPT_DES_DECRYPT.  See
{@link http://en.wikipedia.org/wiki/Image:Feistel.png Feistel.png} to get a general
idea of what this function does.</long-description>
          <tag name="access" description="private" line="935"/>
          <tag name="param" description="" line="935" type="String" variable="$block">
            <type>String</type>
          </tag>
          <tag name="param" description="" line="935" type="Integer" variable="$mode">
            <type>Integer</type>
          </tag>
          <tag name="return" description="" line="935" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$block</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$mode</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1127" package="Crypt_DES">
        <name>_prepareKey</name>
        <full_name>\Crypt_DES::_prepareKey()</full_name>
        <docblock line="1127">
          <description>Creates the key schedule.</description>
          <long-description></long-description>
          <tag name="access" description="private" line="1127"/>
          <tag name="param" description="" line="1127" type="String" variable="$key">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="1127" type="Array">
            <type>Array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$key</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1236" package="Crypt_DES">
        <name>_string_shift</name>
        <full_name>\Crypt_DES::_string_shift()</full_name>
        <docblock line="1236">
          <description>String Shift</description>
          <long-description>Inspired by array_shift</long-description>
          <tag name="param" description="" line="1236" type="String" variable="$string">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Integer $index&lt;/p&gt;&#10;" line="1236" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="1236" type="String">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="1236"/>
        </docblock>
        <argument line="0">
          <name>$string</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$index</name>
          <default>1</default>
          <type/>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/3rdParty/phpseclib/Crypt/Random.php" generated-path="lib.3rdParty.phpseclib.Crypt.Random.html" hash="45a77b83219b6eaef5c0696498052cdf" package="Crypt_Random">
    <docblock line="0">
      <description>Random Number Generator</description>
      <long-description>PHP versions 4 and 5

Here's a short example of how to use this library:
&lt;code&gt;
&lt;?php
   include('Crypt/Random.php');

   echo crypt_random();
?&gt;
&lt;/code&gt;

LICENSE: Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.</long-description>
      <tag name="category" description="Crypt" line="0"/>
      <tag name="package" description="Crypt_Random" line="0"/>
      <tag name="author" description="Jim Wigginton &amp;lt;terrafrost@php.net&amp;gt;" line="0"/>
      <tag name="copyright" description="MMVII Jim Wigginton" line="0"/>
      <tag name="license" description="MIT License" line="0" link="http://www.opensource.org/licenses/mit-license.html"/>
      <tag name="version" description="$Id: Random.php 4105 2011-05-19 18:02:11Z gruberroland $" line="0"/>
      <tag name="link" description="http://phpseclib.sourceforge.net" line="0"/>
    </docblock>
    <function namespace="" line="60" package="Crypt_Random">
      <name>crypt_random</name>
      <full_name>\crypt_random()</full_name>
      <docblock line="60">
        <description>Generate a random value.</description>
        <long-description>On 32-bit machines, the largest distance that can exist between $min and $max is 2**31.
If $min and $max are farther apart than that then the last ($max - range) numbers.

Depending on how this is being used, it may be worth while to write a replacement.  For example,
a PHP-based web app that stores its data in an SQL database can collect more entropy than this function
can.</long-description>
        <tag name="param" description="&lt;p&gt;Integer $min&lt;/p&gt;&#10;" line="60" type="\optional" variable="">
          <type>\optional</type>
        </tag>
        <tag name="param" description="&lt;p&gt;Integer $max&lt;/p&gt;&#10;" line="60" type="\optional" variable="">
          <type>\optional</type>
        </tag>
        <tag name="return" description="" line="60" type="Integer">
          <type>Integer</type>
        </tag>
        <tag name="access" description="public" line="60"/>
      </docblock>
      <argument line="0">
        <name>$min</name>
        <default>0</default>
        <type/>
      </argument>
      <argument line="0">
        <name>$max</name>
        <default>2147483647</default>
        <type/>
      </argument>
    </function>
    <source> </source>
  </file>
  <file path="lib/3rdParty/phpseclib/Crypt/Rijndael.php" generated-path="lib.3rdParty.phpseclib.Crypt.Rijndael.html" hash="3ab293f861f943071631b725ce1a5484" package="Crypt_Rijndael">
    <docblock line="0">
      <description>Pure-PHP implementation of Rijndael.</description>
      <long-description>Does not use mcrypt, even when available, for reasons that are explained below.

PHP versions 4 and 5

If {@link Crypt_Rijndael::setBlockLength() setBlockLength()} isn't called, it'll be assumed to be 128 bits.  If
{@link Crypt_Rijndael::setKeyLength() setKeyLength()} isn't called, it'll be calculated from
{@link Crypt_Rijndael::setKey() setKey()}.  ie. if the key is 128-bits, the key length will be 128-bits.  If it's
136-bits it'll be null-padded to 160-bits and 160 bits will be the key length until
{@link Crypt_Rijndael::setKey() setKey()} is called, again, at which point, it'll be recalculated.

Not all Rijndael implementations may support 160-bits or 224-bits as the block length / key length.  mcrypt, for example,
does not.  AES, itself, only supports block lengths of 128 and key lengths of 128, 192, and 256.
{@link http://csrc.nist.gov/archive/aes/rijndael/Rijndael-ammended.pdf#page=10 Rijndael-ammended.pdf#page=10} defines the
algorithm for block lengths of 192 and 256 but not for block lengths / key lengths of 160 and 224.  Indeed, 160 and 224
are first defined as valid key / block lengths in
{@link http://csrc.nist.gov/archive/aes/rijndael/Rijndael-ammended.pdf#page=44 Rijndael-ammended.pdf#page=44}:
Extensions: Other block and Cipher Key lengths.

{@internal The variable names are the same as those in
{@link http://www.csrc.nist.gov/publications/fips/fips197/fips-197.pdf#page=10 fips-197.pdf#page=10}.}}

Here's a short example of how to use this library:
&lt;code&gt;
&lt;?php
   include('Crypt/Rijndael.php');

   $rijndael = new Crypt_Rijndael();

   $rijndael-&gt;setKey('abcdefghijklmnop');

   $size = 10 * 1024;
   $plaintext = '';
   for ($i = 0; $i &lt; $size; $i++) {
       $plaintext.= 'a';
   }

   echo $rijndael-&gt;decrypt($rijndael-&gt;encrypt($plaintext));
?&gt;
&lt;/code&gt;

LICENSE: Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.</long-description>
      <tag name="category" description="Crypt" line="0"/>
      <tag name="package" description="Crypt_Rijndael" line="0"/>
      <tag name="author" description="Jim Wigginton &amp;lt;terrafrost@php.net&amp;gt;" line="0"/>
      <tag name="copyright" description="MMVIII Jim Wigginton" line="0"/>
      <tag name="license" description="MIT License" line="0" link="http://www.opensource.org/licenses/mit-license.html"/>
      <tag name="version" description="$Id: Rijndael.php 4105 2011-05-19 18:02:11Z gruberroland $" line="0"/>
      <tag name="link" description="http://phpseclib.sourceforge.net" line="0"/>
    </docblock>
    <constant namespace="" line="86" package="Crypt_Rijndael">
      <name>CRYPT_RIJNDAEL_MODE_CTR</name>
      <full_name>\\CRYPT_RIJNDAEL_MODE_CTR</full_name>
      <value>-1</value>
      <docblock line="86">
        <description>Encrypt / decrypt using the Counter mode.</description>
        <long-description>Set to -1 since that's what Crypt/Random.php uses to index the CTR mode.</long-description>
        <tag name="link" description="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Counter_.28CTR.29" line="86"/>
      </docblock>
    </constant>
    <constant namespace="" line="92" package="Crypt_Rijndael">
      <name>CRYPT_RIJNDAEL_MODE_ECB</name>
      <full_name>\\CRYPT_RIJNDAEL_MODE_ECB</full_name>
      <value>1</value>
      <docblock line="92">
        <description>Encrypt / decrypt using the Electronic Code Book mode.</description>
        <long-description></long-description>
        <tag name="link" description="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Electronic_codebook_.28ECB.29" line="92"/>
      </docblock>
    </constant>
    <constant namespace="" line="98" package="Crypt_Rijndael">
      <name>CRYPT_RIJNDAEL_MODE_CBC</name>
      <full_name>\\CRYPT_RIJNDAEL_MODE_CBC</full_name>
      <value>2</value>
      <docblock line="98">
        <description>Encrypt / decrypt using the Code Book Chaining mode.</description>
        <long-description></long-description>
        <tag name="link" description="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Cipher-block_chaining_.28CBC.29" line="98"/>
      </docblock>
    </constant>
    <constant namespace="" line="104" package="Crypt_Rijndael">
      <name>CRYPT_RIJNDAEL_MODE_CFB</name>
      <full_name>\\CRYPT_RIJNDAEL_MODE_CFB</full_name>
      <value>3</value>
      <docblock line="104">
        <description>Encrypt / decrypt using the Cipher Feedback mode.</description>
        <long-description></long-description>
        <tag name="link" description="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Cipher_feedback_.28CFB.29" line="104"/>
      </docblock>
    </constant>
    <constant namespace="" line="110" package="Crypt_Rijndael">
      <name>CRYPT_RIJNDAEL_MODE_OFB</name>
      <full_name>\\CRYPT_RIJNDAEL_MODE_OFB</full_name>
      <value>4</value>
      <docblock line="110">
        <description>Encrypt / decrypt using the Cipher Feedback mode.</description>
        <long-description></long-description>
        <tag name="link" description="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Output_feedback_.28OFB.29" line="110"/>
      </docblock>
    </constant>
    <constant namespace="" line="120" package="Crypt_Rijndael">
      <name>CRYPT_RIJNDAEL_MODE_INTERNAL</name>
      <full_name>\\CRYPT_RIJNDAEL_MODE_INTERNAL</full_name>
      <value>1</value>
      <docblock line="120">
        <description>Toggles the internal implementation</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="124" package="Crypt_Rijndael">
      <name>CRYPT_RIJNDAEL_MODE_MCRYPT</name>
      <full_name>\\CRYPT_RIJNDAEL_MODE_MCRYPT</full_name>
      <value>2</value>
      <docblock line="124">
        <description>Toggles the mcrypt implementation</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <class final="false" abstract="false" namespace="" line="135" package="Crypt_Rijndael">
      <extends/>
      <name>Crypt_Rijndael</name>
      <full_name>\Crypt_Rijndael</full_name>
      <docblock line="135">
        <description>Pure-PHP implementation of Rijndael.</description>
        <long-description></long-description>
        <tag name="author" description="Jim Wigginton &amp;lt;terrafrost@php.net&amp;gt;" line="135"/>
        <tag name="version" description="" line="135"/>
        <tag name="access" description="public" line="135"/>
        <tag name="package" description="Crypt_Rijndael" line="135"/>
      </docblock>
      <property static="false" visibility="public" line="143" namespace="" package="Crypt_Rijndael">
        <name>$mode</name>
        <default></default>
        <docblock line="143">
          <description>The Encryption Mode</description>
          <long-description></long-description>
          <tag name="see" description="" line="143"/>
          <tag name="var" description="" line="143" type="Integer" variable="">
            <type>Integer</type>
          </tag>
          <tag name="access" description="private" line="143"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="152" namespace="" package="Crypt_Rijndael">
        <name>$key</name>
        <default>"\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0"</default>
        <docblock line="152">
          <description>The Key</description>
          <long-description></long-description>
          <tag name="see" description="" line="152"/>
          <tag name="var" description="" line="152" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="152"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="161" namespace="" package="Crypt_Rijndael">
        <name>$iv</name>
        <default>''</default>
        <docblock line="161">
          <description>The Initialization Vector</description>
          <long-description></long-description>
          <tag name="see" description="" line="161"/>
          <tag name="var" description="" line="161" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="161"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="170" namespace="" package="Crypt_Rijndael">
        <name>$encryptIV</name>
        <default>''</default>
        <docblock line="170">
          <description>A "sliding" Initialization Vector</description>
          <long-description></long-description>
          <tag name="see" description="" line="170"/>
          <tag name="var" description="" line="170" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="170"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="179" namespace="" package="Crypt_Rijndael">
        <name>$decryptIV</name>
        <default>''</default>
        <docblock line="179">
          <description>A "sliding" Initialization Vector</description>
          <long-description></long-description>
          <tag name="see" description="" line="179"/>
          <tag name="var" description="" line="179" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="179"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="188" namespace="" package="Crypt_Rijndael">
        <name>$continuousBuffer</name>
        <default>false</default>
        <docblock line="188">
          <description>Continuous Buffer status</description>
          <long-description></long-description>
          <tag name="see" description="" line="188"/>
          <tag name="var" description="" line="188" type="Boolean" variable="">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="private" line="188"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="197" namespace="" package="Crypt_Rijndael">
        <name>$padding</name>
        <default>true</default>
        <docblock line="197">
          <description>Padding status</description>
          <long-description></long-description>
          <tag name="see" description="" line="197"/>
          <tag name="var" description="" line="197" type="Boolean" variable="">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="private" line="197"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="208" namespace="" package="Crypt_Rijndael">
        <name>$changed</name>
        <default>true</default>
        <docblock line="208">
          <description>Does the key schedule need to be (re)calculated?</description>
          <long-description></long-description>
          <tag name="see" description="" line="208"/>
          <tag name="see" description="" line="208"/>
          <tag name="see" description="" line="208"/>
          <tag name="var" description="" line="208" type="Boolean" variable="">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="private" line="208"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="217" namespace="" package="Crypt_Rijndael">
        <name>$explicit_key_length</name>
        <default>false</default>
        <docblock line="217">
          <description>Has the key length explicitly been set or should it be derived from the key, itself?</description>
          <long-description></long-description>
          <tag name="see" description="" line="217"/>
          <tag name="var" description="" line="217" type="Boolean" variable="">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="private" line="217"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="226" namespace="" package="Crypt_Rijndael">
        <name>$w</name>
        <default></default>
        <docblock line="226">
          <description>The Key Schedule</description>
          <long-description></long-description>
          <tag name="see" description="" line="226"/>
          <tag name="var" description="" line="226" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="226"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="235" namespace="" package="Crypt_Rijndael">
        <name>$dw</name>
        <default></default>
        <docblock line="235">
          <description>The Inverse Key Schedule</description>
          <long-description></long-description>
          <tag name="see" description="" line="235"/>
          <tag name="var" description="" line="235" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="235"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="300" namespace="" package="Crypt_Rijndael">
        <name>$c</name>
        <default></default>
        <docblock line="300">
          <description>Shift offsets</description>
          <long-description></long-description>
          <tag name="var" description="" line="300" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="300"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="309" namespace="" package="Crypt_Rijndael">
        <name>$t0</name>
        <default></default>
        <docblock line="309">
          <description>Precomputed mixColumns table</description>
          <long-description></long-description>
          <tag name="see" description="" line="309"/>
          <tag name="var" description="" line="309" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="309"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="318" namespace="" package="Crypt_Rijndael">
        <name>$t1</name>
        <default></default>
        <docblock line="318">
          <description>Precomputed mixColumns table</description>
          <long-description></long-description>
          <tag name="see" description="" line="318"/>
          <tag name="var" description="" line="318" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="318"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="327" namespace="" package="Crypt_Rijndael">
        <name>$t2</name>
        <default></default>
        <docblock line="327">
          <description>Precomputed mixColumns table</description>
          <long-description></long-description>
          <tag name="see" description="" line="327"/>
          <tag name="var" description="" line="327" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="327"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="336" namespace="" package="Crypt_Rijndael">
        <name>$t3</name>
        <default></default>
        <docblock line="336">
          <description>Precomputed mixColumns table</description>
          <long-description></long-description>
          <tag name="see" description="" line="336"/>
          <tag name="var" description="" line="336" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="336"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="345" namespace="" package="Crypt_Rijndael">
        <name>$dt0</name>
        <default></default>
        <docblock line="345">
          <description>Precomputed invMixColumns table</description>
          <long-description></long-description>
          <tag name="see" description="" line="345"/>
          <tag name="var" description="" line="345" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="345"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="354" namespace="" package="Crypt_Rijndael">
        <name>$dt1</name>
        <default></default>
        <docblock line="354">
          <description>Precomputed invMixColumns table</description>
          <long-description></long-description>
          <tag name="see" description="" line="354"/>
          <tag name="var" description="" line="354" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="354"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="363" namespace="" package="Crypt_Rijndael">
        <name>$dt2</name>
        <default></default>
        <docblock line="363">
          <description>Precomputed invMixColumns table</description>
          <long-description></long-description>
          <tag name="see" description="" line="363"/>
          <tag name="var" description="" line="363" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="363"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="372" namespace="" package="Crypt_Rijndael">
        <name>$dt3</name>
        <default></default>
        <docblock line="372">
          <description>Precomputed invMixColumns table</description>
          <long-description></long-description>
          <tag name="see" description="" line="372"/>
          <tag name="var" description="" line="372" type="Array" variable="">
            <type>Array</type>
          </tag>
          <tag name="access" description="private" line="372"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="381" namespace="" package="Crypt_Rijndael">
        <name>$paddable</name>
        <default>false</default>
        <docblock line="381">
          <description>Is the mode one that is paddable?</description>
          <long-description></long-description>
          <tag name="see" description="" line="381"/>
          <tag name="var" description="" line="381" type="Boolean" variable="">
            <type>Boolean</type>
          </tag>
          <tag name="access" description="private" line="381"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="390" namespace="" package="Crypt_Rijndael">
        <name>$enbuffer</name>
        <default>array('encrypted' =&gt; '', 'xor' =&gt; '')</default>
        <docblock line="390">
          <description>Encryption buffer for CTR, OFB and CFB modes</description>
          <long-description></long-description>
          <tag name="see" description="" line="390"/>
          <tag name="var" description="" line="390" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="390"/>
        </docblock>
      </property>
      <property static="false" visibility="public" line="399" namespace="" package="Crypt_Rijndael">
        <name>$debuffer</name>
        <default>array('ciphertext' =&gt; '')</default>
        <docblock line="399">
          <description>Decryption buffer for CTR, OFB and CFB modes</description>
          <long-description></long-description>
          <tag name="see" description="" line="399"/>
          <tag name="var" description="" line="399" type="String" variable="">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="399"/>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="411" package="Crypt_Rijndael">
        <name>Crypt_Rijndael</name>
        <full_name>\Crypt_Rijndael::Crypt_Rijndael()</full_name>
        <docblock line="411">
          <description>Default Constructor.</description>
          <long-description>Determines whether or not the mcrypt extension should be used.  $mode should only, at present, be
CRYPT_RIJNDAEL_MODE_ECB or CRYPT_RIJNDAEL_MODE_CBC.  If not explictly set, CRYPT_RIJNDAEL_MODE_CBC will be used.</long-description>
          <tag name="param" description="&lt;p&gt;Integer $mode&lt;/p&gt;&#10;" line="411" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="411" type="\Crypt_Rijndael">
            <type>\Crypt_Rijndael</type>
          </tag>
          <tag name="access" description="public" line="411"/>
        </docblock>
        <argument line="0">
          <name>$mode</name>
          <default>CRYPT_RIJNDAEL_MODE_CBC</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="536" package="Crypt_Rijndael">
        <name>setKey</name>
        <full_name>\Crypt_Rijndael::setKey()</full_name>
        <docblock line="536">
          <description>Sets the key.</description>
          <long-description>Keys can be of any length.  Rijndael, itself, requires the use of a key that's between 128-bits and 256-bits long and
whose length is a multiple of 32.  If the key is less than 256-bits and the key length isn't set, we round the length
up to the closest valid key length, padding $key with null bytes.  If the key is more than 256-bits, we trim the
excess bits.

If the key is not explicitly set, it'll be assumed to be all null bytes.</long-description>
          <tag name="access" description="public" line="536"/>
          <tag name="param" description="" line="536" type="String" variable="$key">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$key</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="551" package="Crypt_Rijndael">
        <name>setIV</name>
        <full_name>\Crypt_Rijndael::setIV()</full_name>
        <docblock line="551">
          <description>Sets the initialization vector. (optional)</description>
          <long-description>SetIV is not required when CRYPT_RIJNDAEL_MODE_ECB is being used.  If not explictly set, it'll be assumed
to be all zero's.</long-description>
          <tag name="access" description="public" line="551"/>
          <tag name="param" description="" line="551" type="String" variable="$iv">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$iv</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="565" package="Crypt_Rijndael">
        <name>setKeyLength</name>
        <full_name>\Crypt_Rijndael::setKeyLength()</full_name>
        <docblock line="565">
          <description>Sets the key length</description>
          <long-description>Valid key lengths are 128, 160, 192, 224, and 256.  If the length is less than 128, it will be rounded up to
128.  If the length is greater then 128 and invalid, it will be rounded down to the closest valid amount.</long-description>
          <tag name="access" description="public" line="565"/>
          <tag name="param" description="" line="565" type="Integer" variable="$length">
            <type>Integer</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$length</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="589" package="Crypt_Rijndael">
        <name>setBlockLength</name>
        <full_name>\Crypt_Rijndael::setBlockLength()</full_name>
        <docblock line="589">
          <description>Sets the block length</description>
          <long-description>Valid block lengths are 128, 160, 192, 224, and 256.  If the length is less than 128, it will be rounded up to
128.  If the length is greater then 128 and invalid, it will be rounded down to the closest valid amount.</long-description>
          <tag name="access" description="public" line="589"/>
          <tag name="param" description="" line="589" type="Integer" variable="$length">
            <type>Integer</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$length</name>
          <default></default>
          <type>Integer</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="614" package="Crypt_Rijndael">
        <name>_generate_xor</name>
        <full_name>\Crypt_Rijndael::_generate_xor()</full_name>
        <docblock line="614">
          <description>Generate CTR XOR encryption key</description>
          <long-description>Encrypt the output of this and XOR it against the ciphertext / plaintext to get the
plaintext / ciphertext in CTR mode.</long-description>
          <tag name="see" description="" line="614"/>
          <tag name="see" description="" line="614"/>
          <tag name="access" description="public" line="614"/>
          <tag name="param" description="" line="614" type="Integer" variable="$length">
            <type>Integer</type>
          </tag>
          <tag name="param" description="" line="614" type="String" variable="$iv">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$length</name>
          <default></default>
          <type>Integer</type>
        </argument>
        <argument line="0">
          <name>$iv</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="659" package="Crypt_Rijndael">
        <name>encrypt</name>
        <full_name>\Crypt_Rijndael::encrypt()</full_name>
        <docblock line="659">
          <description>Encrypts a message.</description>
          <long-description>$plaintext will be padded with additional bytes such that it's length is a multiple of the block size.  Other Rjindael
implementations may or may not pad in the same manner.  Other common approaches to padding and the reasons why it's
necessary are discussed in the following
URL:

{@link http://www.di-mgt.com.au/cryptopad.html http://www.di-mgt.com.au/cryptopad.html}

An alternative to padding is to, separately, send the length of the file.  This is what SSH, in fact, does.
strlen($plaintext) will still need to be a multiple of 8, however, arbitrary values can be added to make it that
length.</long-description>
          <tag name="see" description="" line="659"/>
          <tag name="access" description="public" line="659"/>
          <tag name="param" description="" line="659" type="String" variable="$plaintext">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$plaintext</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="778" package="Crypt_Rijndael">
        <name>decrypt</name>
        <full_name>\Crypt_Rijndael::decrypt()</full_name>
        <docblock line="778">
          <description>Decrypts a message.</description>
          <long-description>If strlen($ciphertext) is not a multiple of the block size, null bytes will be added to the end of the string until
it is.</long-description>
          <tag name="see" description="" line="778"/>
          <tag name="access" description="public" line="778"/>
          <tag name="param" description="" line="778" type="String" variable="$ciphertext">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$ciphertext</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="896" package="Crypt_Rijndael">
        <name>_encryptBlock</name>
        <full_name>\Crypt_Rijndael::_encryptBlock()</full_name>
        <docblock line="896">
          <description>Encrypts a block</description>
          <long-description></long-description>
          <tag name="access" description="private" line="896"/>
          <tag name="param" description="" line="896" type="String" variable="$in">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="896" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$in</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="983" package="Crypt_Rijndael">
        <name>_decryptBlock</name>
        <full_name>\Crypt_Rijndael::_decryptBlock()</full_name>
        <docblock line="983">
          <description>Decrypts a block</description>
          <long-description></long-description>
          <tag name="access" description="private" line="983"/>
          <tag name="param" description="" line="983" type="String" variable="$in">
            <type>String</type>
          </tag>
          <tag name="return" description="" line="983" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$in</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1061" package="Crypt_Rijndael">
        <name>_setup</name>
        <full_name>\Crypt_Rijndael::_setup()</full_name>
        <docblock line="1061">
          <description>Setup Rijndael</description>
          <long-description>Validates all the variables and calculates $Nr - the number of rounds that need to be performed - and $w - the key
key schedule.</long-description>
          <tag name="access" description="private" line="1061"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1175" package="Crypt_Rijndael">
        <name>_subWord</name>
        <full_name>\Crypt_Rijndael::_subWord()</full_name>
        <docblock line="1175">
          <description>Performs S-Box substitutions</description>
          <long-description></long-description>
          <tag name="access" description="private" line="1175"/>
        </docblock>
        <argument line="0">
          <name>$word</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1221" package="Crypt_Rijndael">
        <name>_invSubWord</name>
        <full_name>\Crypt_Rijndael::_invSubWord()</full_name>
        <docblock line="1221">
          <description>Performs inverse S-Box substitutions</description>
          <long-description></long-description>
          <tag name="access" description="private" line="1221"/>
        </docblock>
        <argument line="0">
          <name>$word</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1277" package="Crypt_Rijndael">
        <name>enablePadding</name>
        <full_name>\Crypt_Rijndael::enablePadding()</full_name>
        <docblock line="1277">
          <description>Pad "packets".</description>
          <long-description>Rijndael works by encrypting between sixteen and thirty-two bytes at a time, provided that number is also a multiple
of four.  If you ever need to encrypt or decrypt something that isn't of the proper length, it becomes necessary to
pad the input so that it is of the proper length.

Padding is enabled by default.  Sometimes, however, it is undesirable to pad strings.  Such is the case in SSH,
where "packets" are padded with random bytes before being encrypted.  Unpad these packets and you risk stripping
away characters that shouldn't be stripped away. (SSH knows how many bytes are added because the length is
transmitted separately)</long-description>
          <tag name="see" description="" line="1277"/>
          <tag name="access" description="public" line="1277"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1288" package="Crypt_Rijndael">
        <name>disablePadding</name>
        <full_name>\Crypt_Rijndael::disablePadding()</full_name>
        <docblock line="1288">
          <description>Do not pad packets.</description>
          <long-description></long-description>
          <tag name="see" description="" line="1288"/>
          <tag name="access" description="public" line="1288"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1306" package="Crypt_Rijndael">
        <name>_pad</name>
        <full_name>\Crypt_Rijndael::_pad()</full_name>
        <docblock line="1306">
          <description>Pads a string</description>
          <long-description>Pads a string using the RSA PKCS padding standards so that its length is a multiple of the blocksize.
$block_size - (strlen($text) % $block_size) bytes are added, each of which is equal to
chr($block_size - (strlen($text) % $block_size)

If padding is disabled and $text is not a multiple of the blocksize, the string will be padded regardless
and padding will, hence forth, be enabled.</long-description>
          <tag name="see" description="" line="1306"/>
          <tag name="access" description="private" line="1306"/>
        </docblock>
        <argument line="0">
          <name>$text</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1333" package="Crypt_Rijndael">
        <name>_unpad</name>
        <full_name>\Crypt_Rijndael::_unpad()</full_name>
        <docblock line="1333">
          <description>Unpads a string.</description>
          <long-description>If padding is enabled and the reported padding length is invalid the encryption key will be assumed to be wrong
and false will be returned.</long-description>
          <tag name="see" description="" line="1333"/>
          <tag name="access" description="private" line="1333"/>
        </docblock>
        <argument line="0">
          <name>$text</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1385" package="Crypt_Rijndael">
        <name>enableContinuousBuffer</name>
        <full_name>\Crypt_Rijndael::enableContinuousBuffer()</full_name>
        <docblock line="1385">
          <description>Treat consecutive "packets" as if they are a continuous buffer.</description>
          <long-description>Say you have a 32-byte plaintext $plaintext.  Using the default behavior, the two following code snippets
will yield different outputs:

&lt;code&gt;
   echo $rijndael-&gt;encrypt(substr($plaintext,  0, 16));
   echo $rijndael-&gt;encrypt(substr($plaintext, 16, 16));
&lt;/code&gt;
&lt;code&gt;
   echo $rijndael-&gt;encrypt($plaintext);
&lt;/code&gt;

The solution is to enable the continuous buffer.  Although this will resolve the above discrepancy, it creates
another, as demonstrated with the following:

&lt;code&gt;
   $rijndael-&gt;encrypt(substr($plaintext, 0, 16));
   echo $rijndael-&gt;decrypt($des-&gt;encrypt(substr($plaintext, 16, 16)));
&lt;/code&gt;
&lt;code&gt;
   echo $rijndael-&gt;decrypt($des-&gt;encrypt(substr($plaintext, 16, 16)));
&lt;/code&gt;

With the continuous buffer disabled, these would yield the same output.  With it enabled, they yield different
outputs.  The reason is due to the fact that the initialization vector's change after every encryption /
decryption round when the continuous buffer is enabled.  When it's disabled, they remain constant.

Put another way, when the continuous buffer is enabled, the state of the Crypt_Rijndael() object changes after each
encryption / decryption round, whereas otherwise, it'd remain constant.  For this reason, it's recommended that
continuous buffers not be used.  They do offer better security and are, in fact, sometimes required (SSH uses them),
however, they are also less intuitive and more likely to cause you problems.</long-description>
          <tag name="see" description="" line="1385"/>
          <tag name="access" description="public" line="1385"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1398" package="Crypt_Rijndael">
        <name>disableContinuousBuffer</name>
        <full_name>\Crypt_Rijndael::disableContinuousBuffer()</full_name>
        <docblock line="1398">
          <description>Treat consecutive packets as if they are a discontinuous buffer.</description>
          <long-description>The default behavior.</long-description>
          <tag name="see" description="" line="1398"/>
          <tag name="access" description="public" line="1398"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1415" package="Crypt_Rijndael">
        <name>_string_shift</name>
        <full_name>\Crypt_Rijndael::_string_shift()</full_name>
        <docblock line="1415">
          <description>String Shift</description>
          <long-description>Inspired by array_shift</long-description>
          <tag name="param" description="" line="1415" type="String" variable="$string">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Integer $index&lt;/p&gt;&#10;" line="1415" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="" line="1415" type="String">
            <type>String</type>
          </tag>
          <tag name="access" description="private" line="1415"/>
        </docblock>
        <argument line="0">
          <name>$string</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$index</name>
          <default>1</default>
          <type/>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/modules.inc" generated-path="lib.modules.inc.html" hash="985df084a1d469c7e693b4f1f8b041ac" package="modules">
    <docblock line="0">
      <description>Interface between modules and other parts of LAM.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Tilo Lutz" line="0"/>
      <tag name="author" description="Michael Duergner" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <function namespace="" line="65" package="modules">
      <name>getModuleAlias</name>
      <full_name>\getModuleAlias()</full_name>
      <docblock line="65">
        <description>Returns the alias name of a module</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;the module name&lt;/p&gt;" line="65" type="string" variable="$name">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;the account type (&quot;user&quot;, &quot;group&quot;, &quot;host&quot;)&lt;/p&gt;&#10;" line="65" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="return" description="alias name" line="65" type="string">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$name</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="77" package="modules">
      <name>is_base_module</name>
      <full_name>\is_base_module()</full_name>
      <docblock line="77">
        <description>Returns true if the module is a base module</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;the module name&lt;/p&gt;" line="77" type="string" variable="$name">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;the account type (&quot;user&quot;, &quot;group&quot;, &quot;host&quot;)&lt;/p&gt;&#10;" line="77" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="return" description="true if base module" line="77" type="boolean">
          <type>boolean</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$name</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="88" package="modules">
      <name>get_ldap_filter</name>
      <full_name>\get_ldap_filter()</full_name>
      <docblock line="88">
        <description>Returns the LDAP filter used by the account lists</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;the account type (&quot;user&quot;, &quot;group&quot;, &quot;host&quot;)&lt;/p&gt;&#10;" line="88" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="return" description="LDAP filter" line="88" type="string">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="134" package="modules">
      <name>getRDNAttributes</name>
      <full_name>\getRDNAttributes()</full_name>
      <docblock line="134">
        <description>Returns a list of LDAP attributes which can be used to form the RDN.</description>
        <long-description>The list is already sorted by the priority given by the nodules.</long-description>
        <tag name="param" description="&lt;p&gt;account type (user, group, host)&lt;/p&gt;&#10;" line="134" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;return only RDN attributes of these modules&lt;/p&gt;" line="134" type="array" variable="$selectedModules">
          <type>array</type>
        </tag>
        <tag name="return" description="list of LDAP attributes" line="134" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$selectedModules</name>
        <default>null</default>
        <type>array</type>
      </argument>
    </function>
    <function namespace="" line="187" package="modules">
      <name>getModulesDependencies</name>
      <full_name>\getModulesDependencies()</full_name>
      <docblock line="187">
        <description>Returns a hash array (module name =&gt; dependencies) of all module dependencies</description>
        <long-description>"dependencies" contains an array with two sub arrays: depends, conflicts
&lt;br&gt;The elements of "depends" are either module names or an array of module names (OR-case).
&lt;br&gt;The elements of conflicts are module names.</long-description>
        <tag name="param" description="&lt;p&gt;the account type (user, group, host)&lt;/p&gt;&#10;" line="187" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="return" description="dependencies" line="187" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="205" package="modules">
      <name>check_module_depends</name>
      <full_name>\check_module_depends()</full_name>
      <docblock line="205">
        <description>Checks if there are missing dependencies between modules.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;selected module names&lt;/p&gt;" line="205" type="array" variable="$selected">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;module dependencies&lt;/p&gt;" line="205" type="array" variable="$deps">
          <type>array</type>
        </tag>
        <tag name="return" description="false if no misssing dependency was found,&#10;otherwise an array of array(selected module, depending module) if missing dependencies were found" line="205" type="mixed">
          <type>mixed</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$selected</name>
        <default></default>
        <type>array</type>
      </argument>
      <argument line="0">
        <name>$deps</name>
        <default></default>
        <type>array</type>
      </argument>
    </function>
    <function namespace="" line="246" package="modules">
      <name>check_module_conflicts</name>
      <full_name>\check_module_conflicts()</full_name>
      <docblock line="246">
        <description>Checks if there are conflicts between modules</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;selected module names&lt;/p&gt;" line="246" type="array" variable="$selected">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;module dependencies&lt;/p&gt;" line="246" type="array" variable="$deps">
          <type>array</type>
        </tag>
        <tag name="return" description="false if no conflict was found,&#10;otherwise an array of array(selected module, conflicting module) if conflicts were found" line="246" type="boolean">
          <type>boolean</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$selected</name>
        <default></default>
        <type>array</type>
      </argument>
      <argument line="0">
        <name>$deps</name>
        <default></default>
        <type>array</type>
      </argument>
    </function>
    <function namespace="" line="266" package="modules">
      <name>getAvailableModules</name>
      <full_name>\getAvailableModules()</full_name>
      <docblock line="266">
        <description>Returns an array with all available user module names</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;account type (user, group, host)&lt;/p&gt;&#10;" line="266" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;module must support LAM admin interface (default: false)&lt;/p&gt;&#10;" line="266" type="boolean" variable="$mustSupportAdminInterface">
          <type>boolean</type>
        </tag>
        <tag name="return" description="list of possible modules" line="266" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$mustSupportAdminInterface</name>
        <default>false</default>
        <type>boolean</type>
      </argument>
    </function>
    <function namespace="" line="291" package="modules">
      <name>getProfileOptions</name>
      <full_name>\getProfileOptions()</full_name>
      <docblock line="291">
        <description>Returns the elements for the profile page.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;account type (user, group, host)&lt;/p&gt;&#10;" line="291" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="return" description="profile elements" line="291" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="308" package="modules">
      <name>checkProfileOptions</name>
      <full_name>\checkProfileOptions()</full_name>
      <docblock line="308">
        <description>Checks if the profile options are valid</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;account type (user, group, host)&lt;/p&gt;&#10;" line="308" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;hash array containing all options (name =&gt; array(...))&lt;/p&gt;&#10;" line="308" type="array" variable="$options">
          <type>array</type>
        </tag>
        <tag name="return" description="list of error messages" line="308" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$options</name>
        <default></default>
        <type>array</type>
      </argument>
    </function>
    <function namespace="" line="325" package="modules">
      <name>getConfigOptions</name>
      <full_name>\getConfigOptions()</full_name>
      <docblock line="325">
        <description>Returns a hash array (module name =&gt; elements) of all module options for the configuration page.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;hash array (module name =&gt; array(account types))&lt;/p&gt;&#10;" line="325" type="array" variable="$scopes">
          <type>array</type>
        </tag>
        <tag name="return" description="configuration options" line="325" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$scopes</name>
        <default></default>
        <type>array</type>
      </argument>
    </function>
    <function namespace="" line="342" package="modules">
      <name>checkConfigOptions</name>
      <full_name>\checkConfigOptions()</full_name>
      <docblock line="342">
        <description>Checks if the configuration options are valid</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;hash array (module name =&gt; array(account types))&lt;/p&gt;&#10;" line="342" type="array" variable="$scopes">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;hash array containing all options (name =&gt; array(...))&lt;/p&gt;&#10;" line="342" type="array" variable="$options">
          <type>array</type>
        </tag>
        <tag name="return" description="list of error messages" line="342" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$scopes</name>
        <default></default>
        <type>array</type>
      </argument>
      <argument line="0">
        <name>$options</name>
        <default></default>
        <type>array</type>
      </argument>
    </function>
    <function namespace="" line="363" package="modules">
      <name>getHelp</name>
      <full_name>\getHelp()</full_name>
      <docblock line="363">
        <description>Returns a help entry from an account module.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;module name&lt;/p&gt;" line="363" type="string" variable="$module">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;help identifier&lt;/p&gt;" line="363" type="string" variable="$helpID">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="363" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="return" description="help entry" line="363" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$module</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$helpID</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$scope</name>
        <default>''</default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="385" package="modules">
      <name>getAvailablePDFFields</name>
      <full_name>\getAvailablePDFFields()</full_name>
      <docblock line="385">
        <description>Returns a list of available PDF entries.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;account type (user, group, host)&lt;/p&gt;&#10;" line="385" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="return" description="PDF entries (field ID =&amp;gt; field label)" line="385" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="424" package="modules">
      <name>getUploadColumns</name>
      <full_name>\getUploadColumns()</full_name>
      <docblock line="424">
        <description>Returns an array containing all input columns for the file upload.</description>
        <long-description>Syntax:
&lt;br&gt; array(
&lt;br&gt;  string: name,  // fixed non-translated name which is used as column name (should be of format: &lt;module name&gt;_&lt;column name&gt;)
&lt;br&gt;  string: description,  // short descriptive name
&lt;br&gt;  string: help,  // help ID
&lt;br&gt;  string: example,  // example value
&lt;br&gt;  boolean: required  // true, if user must set a value for this column
&lt;br&gt; )</long-description>
        <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="424" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;selected account modules&lt;/p&gt;" line="424" type="array" variable="$selectedModules">
          <type>array</type>
        </tag>
        <tag name="return" description="column list" line="424" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$selectedModules</name>
        <default></default>
        <type>array</type>
      </argument>
    </function>
    <function namespace="" line="444" package="modules">
      <name>buildUploadAccounts</name>
      <full_name>\buildUploadAccounts()</full_name>
      <docblock line="444">
        <description>This function builds the LDAP accounts for the file upload.</description>
        <long-description>If there are problems status messages will be printed automatically.</long-description>
        <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="444" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;array containing one account in each element&lt;/p&gt;" line="444" type="array" variable="$data">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;array(&lt;column_name&gt; =&gt; &lt;column number&gt;)&lt;/p&gt;&#10;" line="444" type="array" variable="$ids">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;selected account modules&lt;/p&gt;" line="444" type="array" variable="$selectedModules">
          <type>array</type>
        </tag>
        <tag name="return" description="array including accounts or false if there were errors" line="444" type="mixed">
          <type>mixed</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$data</name>
        <default></default>
        <type>array</type>
      </argument>
      <argument line="0">
        <name>$ids</name>
        <default></default>
        <type>array</type>
      </argument>
      <argument line="0">
        <name>$selectedModules</name>
        <default></default>
        <type>array</type>
      </argument>
    </function>
    <function namespace="" line="517" package="modules">
      <name>doUploadPreActions</name>
      <full_name>\doUploadPreActions()</full_name>
      <docblock line="517">
        <description>Runs any actions that need to be done before an LDAP entry is created.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="517" type="String" variable="$scope">
          <type>String</type>
        </tag>
        <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="517" type="array" variable="$selectedModules">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;LDAP attributes of this entry (attributes are provided as reference, handle modifications of $attributes with care)&lt;/p&gt;&#10;" line="517" type="array" variable="$attributes">
          <type>array</type>
        </tag>
        <tag name="return" description="array which contains status messages. Each entry is an array containing the status message parameters." line="517" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>String</type>
      </argument>
      <argument line="0">
        <name>$selectedModules</name>
        <default></default>
        <type>array</type>
      </argument>
      <argument line="0">
        <name>$attributes</name>
        <default></default>
        <type>array</type>
      </argument>
    </function>
    <function namespace="" line="544" package="modules">
      <name>doUploadPostActions</name>
      <full_name>\doUploadPostActions()</full_name>
      <docblock line="544">
        <description>This function executes one post upload action.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="544" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;array containing one account in each element&lt;/p&gt;" line="544" type="array" variable="$data">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;array(&lt;column_name&gt; =&gt; &lt;column number&gt;)&lt;/p&gt;&#10;" line="544" type="array" variable="$ids">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;list of accounts which were not created successfully&lt;/p&gt;" line="544" type="array" variable="$failed">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="544" type="array" variable="$selectedModules">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;list of LDAP entries&lt;/p&gt;" line="544" type="array" variable="$accounts">
          <type>array</type>
        </tag>
        <tag name="return" description="current status&#10;&amp;lt;br&amp;gt; array (&#10;&amp;lt;br&amp;gt;  &amp;#039;status&amp;#039; =&amp;gt; &amp;#039;finished&amp;#039; | &amp;#039;inProgress&amp;#039;&#10;&amp;lt;br&amp;gt;  &amp;#039;module&amp;#039; =&amp;gt; &amp;lt;name of active module&amp;gt;&#10;&amp;lt;br&amp;gt;  &amp;#039;progress&amp;#039; =&amp;gt; 0..100&#10;&amp;lt;br&amp;gt;  &amp;#039;errors&amp;#039; =&amp;gt; array (&amp;lt;array of parameters for StatusMessage&amp;gt;)&#10;&amp;lt;br&amp;gt; )" line="544" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$data</name>
        <default></default>
        <type>array</type>
      </argument>
      <argument line="0">
        <name>$ids</name>
        <default></default>
        <type>array</type>
      </argument>
      <argument line="0">
        <name>$failed</name>
        <default></default>
        <type>array</type>
      </argument>
      <argument line="0">
        <name>$selectedModules</name>
        <default></default>
        <type>array</type>
      </argument>
      <argument line="0">
        <name>$accounts</name>
        <default></default>
        <type>array</type>
      </argument>
    </function>
    <function namespace="" line="580" package="modules">
      <name>getRequiredExtensions</name>
      <full_name>\getRequiredExtensions()</full_name>
      <docblock line="580">
        <description>Returns true if the module is a base module</description>
        <long-description></long-description>
        <tag name="return" description="required extensions" line="580" type="array">
          <type>array</type>
        </tag>
      </docblock>
    </function>
    <function namespace="" line="610" package="modules">
      <name>parseHtml</name>
      <full_name>\parseHtml()</full_name>
      <docblock line="610">
        <description>Takes a list of meta-HTML elements and prints the equivalent HTML output.</description>
        <long-description>The modules are not allowed to display HTML code directly but return
meta HTML code. This allows to have a common design for all module pages.</long-description>
        <tag name="param" description="&lt;p&gt;Name of account module&lt;/p&gt;" line="610" type="string" variable="$module">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;htmlElement or array of htmlElement elements&lt;/p&gt;" line="610" type="mixed" variable="$input">
          <type>mixed</type>
        </tag>
        <tag name="param" description="&lt;p&gt;List of values which override the defaults in $input (name =&gt; value)&lt;/p&gt;&#10;" line="610" type="array" variable="$values">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;If true then no buttons will be displayed&lt;/p&gt;" line="610" type="boolean" variable="$restricted">
          <type>boolean</type>
        </tag>
        <tag name="param" description="&lt;p&gt;Start value of tabulator index for input fields&lt;/p&gt;" line="610" type="integer" variable="$tabindex">
          <type>integer</type>
        </tag>
        <tag name="param" description="&lt;p&gt;Account type&lt;/p&gt;" line="610" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="return" description="List of input field names and their type (name =&amp;gt; type)" line="610" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$module</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$input</name>
        <default></default>
        <type>mixed</type>
      </argument>
      <argument line="0">
        <name>$values</name>
        <default></default>
        <type>array</type>
      </argument>
      <argument line="0">
        <name>$restricted</name>
        <default></default>
        <type>boolean</type>
      </argument>
      <argument line="0">
        <name>$tabindex</name>
        <default></default>
        <type>integer</type>
      </argument>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="632" package="modules">
      <name>lamCompareDescriptiveOptions</name>
      <full_name>\lamCompareDescriptiveOptions()</full_name>
      <docblock line="632">
        <description>Helper function to sort descriptive options in parseHTML().</description>
        <long-description>It compares the second entries of two arrays.</long-description>
        <tag name="param" description="&lt;p&gt;first array&lt;/p&gt;" line="632" type="array" variable="$a">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;second array&lt;/p&gt;" line="632" type="array" variable="$b">
          <type>array</type>
        </tag>
        <tag name="return" description="compare result" line="632" type="integer">
          <type>integer</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$a</name>
        <default></default>
        <type>array</type>
      </argument>
      <argument line="0">
        <name>$b</name>
        <default></default>
        <type>array</type>
      </argument>
    </function>
    <function namespace="" line="648" package="modules">
      <name>printHelpLink</name>
      <full_name>\printHelpLink()</full_name>
      <docblock line="648">
        <description>Prints a LAM help link.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;help entry&lt;/p&gt;" line="648" type="array" variable="$entry">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;help number&lt;/p&gt;" line="648" type="String" variable="$number">
          <type>String</type>
        </tag>
        <tag name="param" description="&lt;p&gt;module name&lt;/p&gt;" line="648" type="String" variable="$module">
          <type>String</type>
        </tag>
        <tag name="param" description="&lt;p&gt;account scope&lt;/p&gt;" line="648" type="String" variable="$scope">
          <type>String</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$entry</name>
        <default></default>
        <type>array</type>
      </argument>
      <argument line="0">
        <name>$number</name>
        <default></default>
        <type>String</type>
      </argument>
      <argument line="0">
        <name>$module</name>
        <default>''</default>
        <type>String</type>
      </argument>
      <argument line="0">
        <name>$scope</name>
        <default>''</default>
        <type>String</type>
      </argument>
    </function>
    <interface namespace="" line="2043" package="modules">
      <name>passwordService</name>
      <full_name>\passwordService</full_name>
      <docblock line="2043">
        <description>This interface needs to be implemented by all account modules which manage passwords.</description>
        <long-description>It allows LAM to provide central password changes.</long-description>
        <tag name="package" description="modules" line="2043"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2052" package="modules">
        <name>managesPasswordAttributes</name>
        <full_name>\passwordService::managesPasswordAttributes()</full_name>
        <docblock line="2052">
          <description>This method specifies if a module manages password attributes. The module alias will
then appear as option in the GUI.</description>
          <long-description>&lt;br&gt;If the module only wants to get notified about password changes then return false.</long-description>
          <tag name="return" description="true if this module manages password attributes" line="2052" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2059" package="modules">
        <name>supportsForcePasswordChange</name>
        <full_name>\passwordService::supportsForcePasswordChange()</full_name>
        <docblock line="2059">
          <description>Specifies if this module supports to force that a user must change his password on next login.</description>
          <long-description></long-description>
          <tag name="return" description="force password change supported" line="2059" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2071" package="modules">
        <name>passwordChangeRequested</name>
        <full_name>\passwordService::passwordChangeRequested()</full_name>
        <docblock line="2071">
          <description>This function is called whenever the password should be changed. Account modules
must change their password attributes only if the modules list contains their module name.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;new password&lt;/p&gt;" line="2071" type="String" variable="$password">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of modules for which the password should be changed&lt;/p&gt;" line="2071" type="array" variable="$modules">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;force the user to change his password at next login&lt;/p&gt;" line="2071" type="boolean" variable="$forcePasswordChange">
            <type>boolean</type>
          </tag>
          <tag name="return" description="list of error messages if any as parameter array for StatusMessage&#10;              e.g. return arrray(array(&amp;#039;ERROR&amp;#039;, &amp;#039;Password change failed.&amp;#039;))" line="2071" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$password</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$modules</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$forcePasswordChange</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
    </interface>
    <class final="false" abstract="false" namespace="" line="674" package="modules">
      <extends/>
      <name>accountContainer</name>
      <full_name>\accountContainer</full_name>
      <docblock line="674">
        <description>This class includes all modules and attributes of an account.</description>
        <long-description></long-description>
        <tag name="package" description="modules" line="674"/>
      </docblock>
      <property static="false" visibility="public" line="703" namespace="" package="modules">
        <name>$attributes</name>
        <default></default>
        <docblock line="703">
          <description>Array of all used attributes
Syntax is attribute =&gt; array ( objectClass =&gt; MUST or MAY, .</description>
          <long-description>..)</long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="709" namespace="" package="modules">
        <name>$type</name>
        <default></default>
        <docblock line="709">
          <description>This variale stores the account type.</description>
          <long-description>Currently "user", "group" and "host" are supported.</long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="712" namespace="" package="modules">
        <name>$module</name>
        <default></default>
        <docblock line="712">
          <description>This is an array with all module objects</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="715" namespace="" package="modules">
        <name>$dnSuffix</name>
        <default></default>
        <docblock line="715">
          <description>DN suffix of the account</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="718" namespace="" package="modules">
        <name>$dn_orig</name>
        <default></default>
        <docblock line="718">
          <description>DN of account when it was loaded</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="721" namespace="" package="modules">
        <name>$rdn</name>
        <default></default>
        <docblock line="721">
          <description>RDN attribute of this account</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="724" namespace="" package="modules">
        <name>$finalDN</name>
        <default></default>
        <docblock line="724">
          <description>DN of saved account</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="727" namespace="" package="modules">
        <name>$attributes_orig</name>
        <default></default>
        <docblock line="727">
          <description>original LDAP attributes when account was loaded from LDAP</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="730" namespace="" package="modules">
        <name>$order</name>
        <default></default>
        <docblock line="730">
          <description>Module order</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="733" namespace="" package="modules">
        <name>$base</name>
        <default></default>
        <docblock line="733">
          <description>Name of accountContainer variable in session</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="736" namespace="" package="modules">
        <name>$current_page</name>
        <default>0</default>
        <docblock line="736">
          <description>This variable stores the page number of the currently displayed page</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="739" namespace="" package="modules">
        <name>$subpage</name>
        <default></default>
        <docblock line="739">
          <description>This variable is set to the pagename of a subpage if it should be displayed</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="742" namespace="" package="modules">
        <name>$isNewAccount</name>
        <default></default>
        <docblock line="742">
          <description>True if this is a newly created account</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="745" namespace="" package="modules">
        <name>$lastLoadedProfile</name>
        <default>''</default>
        <docblock line="745">
          <description>name of last loaded account profile</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="748" namespace="" package="modules">
        <name>$cachedOUs</name>
        <default>null</default>
        <docblock line="748">
          <description>cache for existing OUs</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="751" namespace="" package="modules">
        <name>$titleBarTitle</name>
        <default>null</default>
        <docblock line="751">
          <description>main title in title bar</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="753" namespace="" package="modules">
        <name>$titleBarSubtitle</name>
        <default>null</default>
        <docblock line="753">
          <description>subtitle in title bar</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="755" namespace="" package="modules">
        <name>$sendPasswordViaMail</name>
        <default>null</default>
        <docblock line="755">
          <description>send password via mail</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="757" namespace="" package="modules">
        <name>$sendPasswordViaMailAlternateAddress</name>
        <default>null</default>
        <docblock line="757">
          <description>send password via mail to this alternate address</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="682" package="modules">
        <name>__construct</name>
        <full_name>\accountContainer::__construct()</full_name>
        <docblock line="682">
          <description>Constructor</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="682" type="string" variable="$type">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;key in $_SESSION where this object is saved&lt;/p&gt;&#10;" line="682" type="string" variable="$base">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$type</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$base</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="765" package="modules">
        <name>getAccountModule</name>
        <full_name>\accountContainer::getAccountModule()</full_name>
        <docblock line="765">
          <description>Returns the account module with the given class name</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;class name (e.g. posixAccount)&lt;/p&gt;&#10;" line="765" type="string" variable="$name">
            <type>string</type>
          </tag>
          <tag name="return" description="account module" line="765" type="\baseModule">
            <type>\baseModule</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="779" package="modules">
        <name>getAccountModules</name>
        <full_name>\accountContainer::getAccountModules()</full_name>
        <docblock line="779">
          <description>Returns the included account modules.</description>
          <long-description></long-description>
          <tag name="return" description="modules" line="779" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="788" package="modules">
        <name>get_type</name>
        <full_name>\accountContainer::get_type()</full_name>
        <docblock line="788">
          <description>Returns the accout type of this object (e.g. user, group, host).</description>
          <long-description></long-description>
          <tag name="return" description="account type" line="788" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="796" package="modules">
        <name>continue_main</name>
        <full_name>\accountContainer::continue_main()</full_name>
        <docblock line="796">
          <description>This function is called when the user clicks on any button on the account pages.</description>
          <long-description>It prints the HTML code of each account page.</long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="955" package="modules">
        <name>printModuleContent</name>
        <full_name>\accountContainer::printModuleContent()</full_name>
        <docblock line="955">
          <description>Prints the content part provided by the current module.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of messages&lt;/p&gt;" line="955" type="array" variable="$result">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;true if page should end after displaying the messages&lt;/p&gt;" line="955" type="boolean" variable="$stopProcessing">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$result</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$stopProcessing</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1034" package="modules">
        <name>printPasswordPromt</name>
        <full_name>\accountContainer::printPasswordPromt()</full_name>
        <docblock line="1034">
          <description>Prints the input fields of the central password service.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1097" package="modules">
        <name>setNewPassword</name>
        <full_name>\accountContainer::setNewPassword()</full_name>
        <docblock line="1097">
          <description>Sets the new password in all selected account modules.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;input parameters&lt;/p&gt;" line="1097" type="array" variable="$input">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1179" package="modules">
        <name>printCommonControls</name>
        <full_name>\accountContainer::printCommonControls()</full_name>
        <docblock line="1179">
          <description>Prints common controls like the save button and the ou selection.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;tabindex for GUI elements&lt;/p&gt;" line="1179" type="int" variable="$tabindex">
            <type>int</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$tabindex</name>
          <default></default>
          <type>int</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1242" package="modules">
        <name>showSetPasswordButton</name>
        <full_name>\accountContainer::showSetPasswordButton()</full_name>
        <docblock line="1242">
          <description>Returns if the page should show a button to set the password.</description>
          <long-description></long-description>
          <tag name="return" description="show or hide button" line="1242" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1254" package="modules">
        <name>printPageHeader</name>
        <full_name>\accountContainer::printPageHeader()</full_name>
        <docblock line="1254">
          <description>Prints the header of the account pages.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1267" package="modules">
        <name>printPageFooter</name>
        <full_name>\accountContainer::printPageFooter()</full_name>
        <docblock line="1267">
          <description>Prints the footer of the account pages.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1277" package="modules">
        <name>printSuccessPage</name>
        <full_name>\accountContainer::printSuccessPage()</full_name>
        <docblock line="1277">
          <description>Prints the HTML code to notify the user about the successful saving.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;array which contains status messages. Each entry is an array containing the status message parameters.&lt;/p&gt;" line="1277" type="array" variable="$messages">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$messages</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1340" package="modules">
        <name>loadProfileIfRequested</name>
        <full_name>\accountContainer::loadProfileIfRequested()</full_name>
        <docblock line="1340">
          <description>Checks if the user requested to load a profile.</description>
          <long-description></long-description>
          <tag name="return" description="true, if profile was loaded" line="1340" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1363" package="modules">
        <name>printModuleTabs</name>
        <full_name>\accountContainer::printModuleTabs()</full_name>
        <docblock line="1363">
          <description>Prints the HTML code of the module tabs.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1402" package="modules">
        <name>save_module_attributes</name>
        <full_name>\accountContainer::save_module_attributes()</full_name>
        <docblock line="1402">
          <description>This function checks which LDAP attributes have changed while the account was edited.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;list of current LDAP attributes&lt;/p&gt;" line="1402" type="array" variable="$attributes">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of old attributes when account was loaded&lt;/p&gt;" line="1402" type="array" variable="$orig">
            <type>array</type>
          </tag>
          <tag name="return" description="an array which can be passed to $this-&amp;gt;saveAccount()" line="1402" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$orig</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1483" package="modules">
        <name>load_account</name>
        <full_name>\accountContainer::load_account()</full_name>
        <docblock line="1483">
          <description>Loads an LDAP account with the given DN.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;the DN of the account&lt;/p&gt;" line="1483" type="string" variable="$dn">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of additional informational attributes that are added to the LDAP attributes&#10;E.g. this is used to inject the clear text password in the file upload. Informational attribute names must start with &quot;INFO.&quot;.&lt;/p&gt;" line="1483" type="array" variable="$infoAttributes">
            <type>array</type>
          </tag>
          <tag name="return" description="error messages" line="1483" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$infoAttributes</name>
          <default>array()</default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1546" package="modules">
        <name>fixLDAPAttributes</name>
        <full_name>\accountContainer::fixLDAPAttributes()</full_name>
        <docblock line="1546">
          <description>Fixes spelling errors in the attribute names.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="1546" type="array" variable="$attributes">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of active modules&lt;/p&gt;" line="1546" type="array" variable="$modules">
            <type>array</type>
          </tag>
          <tag name="return" description="fixed attributes" line="1546" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$modules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1619" package="modules">
        <name>new_account</name>
        <full_name>\accountContainer::new_account()</full_name>
        <docblock line="1619">
          <description>This function will prepare the object for a new account.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1654" package="modules">
        <name>save_account</name>
        <full_name>\accountContainer::save_account()</full_name>
        <docblock line="1654">
          <description>This function will save an account to the LDAP database.</description>
          <long-description></long-description>
          <tag name="return" description="list of status messages" line="1654" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1881" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\accountContainer::get_pdfEntries()</full_name>
        <docblock line="1881">
          <description>Returns a list of possible PDF entries for this account.</description>
          <long-description></long-description>
          <tag name="return" description="of PDF entries (array(&amp;lt;name&amp;gt; =&amp;gt; &amp;lt;PDF lines&amp;gt;))" line="1881" type="\list">
            <type>\list</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1898" package="modules">
        <name>sortModules</name>
        <full_name>\accountContainer::sortModules()</full_name>
        <docblock line="1898">
          <description>Sorts the module buttons for the account page.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1979" package="modules">
        <name>getRDN</name>
        <full_name>\accountContainer::getRDN()</full_name>
        <docblock line="1979">
          <description>Returns the RDN part of a given DN.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;DN&lt;/p&gt;" line="1979" type="String" variable="$dn">
            <type>String</type>
          </tag>
          <tag name="return" description="RDN" line="1979" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1991" package="modules">
        <name>getParentDN</name>
        <full_name>\accountContainer::getParentDN()</full_name>
        <docblock line="1991">
          <description>Returns the parent DN of a given DN.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;DN&lt;/p&gt;" line="1991" type="String" variable="$dn">
            <type>String</type>
          </tag>
          <tag name="return" description="DN" line="1991" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="2002" package="modules">
        <name>getOUs</name>
        <full_name>\accountContainer::getOUs()</full_name>
        <docblock line="2002">
          <description>Returns a list of OUs that exist for this account type.</description>
          <long-description></long-description>
          <tag name="return" description="OU list" line="2002" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2016" package="modules">
        <name>__sleep</name>
        <full_name>\accountContainer::__sleep()</full_name>
        <docblock line="2016">
          <description>Encrypts sensitive data before storing in session.</description>
          <long-description></long-description>
          <tag name="return" description="list of attributes which are serialized" line="2016" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2028" package="modules">
        <name>__wakeup</name>
        <full_name>\accountContainer::__wakeup()</full_name>
        <docblock line="2028">
          <description>Decrypts sensitive data after accountContainer was loaded from session.</description>
          <long-description></long-description>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/createntlm.inc" generated-path="lib.createntlm.inc.html" hash="0bece1d66fcb7566c5aecf95c8634da8" package="modules">
    <docblock line="0">
      <description>This class provides functions to calculate Samba NT and LM hashes.</description>
      <long-description>The code is a conversion from createntlm.pl (Benjamin Kuit) and smbdes.c/md4.c (Andrew Tridgell).</long-description>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="package" description="modules" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="41" package="modules">
      <extends/>
      <name>smbHash</name>
      <full_name>\smbHash</full_name>
      <docblock line="41">
        <description>Calculates NT and LM hashes.</description>
        <long-description>The important functions are lmhash($password) and nthash($password).</long-description>
        <tag name="package" description="modules" line="41"/>
      </docblock>
      <property static="false" visibility="private" line="45" namespace="" package="modules">
        <name>$perm1</name>
        <default>array(57, 49, 41, 33, 25, 17, 9, 1, 58, 50, 42, 34, 26, 18, 10, 2, 59, 51, 43, 35, 27, 19, 11, 3, 60, 52, 44, 36, 63, 55, 47, 39, 31, 23, 15, 7, 62, 54, 46, 38, 30, 22, 14, 6, 61, 53, 45, 37, 29, 21, 13, 5, 28, 20, 12, 4)</default>
        <docblock line="45">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="54" namespace="" package="modules">
        <name>$perm2</name>
        <default>array(14, 17, 11, 24, 1, 5, 3, 28, 15, 6, 21, 10, 23, 19, 12, 4, 26, 8, 16, 7, 27, 20, 13, 2, 41, 52, 31, 37, 47, 55, 30, 40, 51, 45, 33, 48, 44, 49, 39, 56, 34, 53, 46, 42, 50, 36, 29, 32)</default>
        <docblock line="54">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="63" namespace="" package="modules">
        <name>$perm3</name>
        <default>array(58, 50, 42, 34, 26, 18, 10, 2, 60, 52, 44, 36, 28, 20, 12, 4, 62, 54, 46, 38, 30, 22, 14, 6, 64, 56, 48, 40, 32, 24, 16, 8, 57, 49, 41, 33, 25, 17, 9, 1, 59, 51, 43, 35, 27, 19, 11, 3, 61, 53, 45, 37, 29, 21, 13, 5, 63, 55, 47, 39, 31, 23, 15, 7)</default>
        <docblock line="63">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="72" namespace="" package="modules">
        <name>$perm4</name>
        <default>array(32, 1, 2, 3, 4, 5, 4, 5, 6, 7, 8, 9, 8, 9, 10, 11, 12, 13, 12, 13, 14, 15, 16, 17, 16, 17, 18, 19, 20, 21, 20, 21, 22, 23, 24, 25, 24, 25, 26, 27, 28, 29, 28, 29, 30, 31, 32, 1)</default>
        <docblock line="72">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="81" namespace="" package="modules">
        <name>$perm5</name>
        <default>array(16, 7, 20, 21, 29, 12, 28, 17, 1, 15, 23, 26, 5, 18, 31, 10, 2, 8, 24, 14, 32, 27, 3, 9, 19, 13, 30, 6, 22, 11, 4, 25)</default>
        <docblock line="81">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="90" namespace="" package="modules">
        <name>$perm6</name>
        <default>array(40, 8, 48, 16, 56, 24, 64, 32, 39, 7, 47, 15, 55, 23, 63, 31, 38, 6, 46, 14, 54, 22, 62, 30, 37, 5, 45, 13, 53, 21, 61, 29, 36, 4, 44, 12, 52, 20, 60, 28, 35, 3, 43, 11, 51, 19, 59, 27, 34, 2, 42, 10, 50, 18, 58, 26, 33, 1, 41, 9, 49, 17, 57, 25)</default>
        <docblock line="90">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="99" namespace="" package="modules">
        <name>$sc</name>
        <default>array(1, 1, 2, 2, 2, 2, 2, 2, 1, 2, 2, 2, 2, 2, 2, 1)</default>
        <docblock line="99">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="103" namespace="" package="modules">
        <name>$sbox</name>
        <default>array(array(array(14, 4, 13, 1, 2, 15, 11, 8, 3, 10, 6, 12, 5, 9, 0, 7), array(0, 15, 7, 4, 14, 2, 13, 1, 10, 6, 12, 11, 9, 5, 3, 8), array(4, 1, 14, 8, 13, 6, 2, 11, 15, 12, 9, 7, 3, 10, 5, 0), array(15, 12, 8, 2, 4, 9, 1, 7, 5, 11, 3, 14, 10, 0, 6, 13)), array(array(15, 1, 8, 14, 6, 11, 3, 4, 9, 7, 2, 13, 12, 0, 5, 10), array(3, 13, 4, 7, 15, 2, 8, 14, 12, 0, 1, 10, 6, 9, 11, 5), array(0, 14, 7, 11, 10, 4, 13, 1, 5, 8, 12, 6, 9, 3, 2, 15), array(13, 8, 10, 1, 3, 15, 4, 2, 11, 6, 7, 12, 0, 5, 14, 9)), array(array(10, 0, 9, 14, 6, 3, 15, 5, 1, 13, 12, 7, 11, 4, 2, 8), array(13, 7, 0, 9, 3, 4, 6, 10, 2, 8, 5, 14, 12, 11, 15, 1), array(13, 6, 4, 9, 8, 15, 3, 0, 11, 1, 2, 12, 5, 10, 14, 7), array(1, 10, 13, 0, 6, 9, 8, 7, 4, 15, 14, 3, 11, 5, 2, 12)), array(array(7, 13, 14, 3, 0, 6, 9, 10, 1, 2, 8, 5, 11, 12, 4, 15), array(13, 8, 11, 5, 6, 15, 0, 3, 4, 7, 2, 12, 1, 10, 14, 9), array(10, 6, 9, 0, 12, 11, 7, 13, 15, 1, 3, 14, 5, 2, 8, 4), array(3, 15, 0, 6, 10, 1, 13, 8, 9, 4, 5, 11, 12, 7, 2, 14)), array(array(2, 12, 4, 1, 7, 10, 11, 6, 8, 5, 3, 15, 13, 0, 14, 9), array(14, 11, 2, 12, 4, 7, 13, 1, 5, 0, 15, 10, 3, 9, 8, 6), array(4, 2, 1, 11, 10, 13, 7, 8, 15, 9, 12, 5, 6, 3, 0, 14), array(11, 8, 12, 7, 1, 14, 2, 13, 6, 15, 0, 9, 10, 4, 5, 3)), array(array(12, 1, 10, 15, 9, 2, 6, 8, 0, 13, 3, 4, 14, 7, 5, 11), array(10, 15, 4, 2, 7, 12, 9, 5, 6, 1, 13, 14, 0, 11, 3, 8), array(9, 14, 15, 5, 2, 8, 12, 3, 7, 0, 4, 10, 1, 13, 11, 6), array(4, 3, 2, 12, 9, 5, 15, 10, 11, 14, 1, 7, 6, 0, 8, 13)), array(array(4, 11, 2, 14, 15, 0, 8, 13, 3, 12, 9, 7, 5, 10, 6, 1), array(13, 0, 11, 7, 4, 9, 1, 10, 14, 3, 5, 12, 2, 15, 8, 6), array(1, 4, 11, 13, 12, 3, 7, 14, 10, 15, 6, 8, 0, 5, 9, 2), array(6, 11, 13, 8, 1, 4, 10, 7, 9, 5, 0, 15, 14, 2, 3, 12)), array(array(13, 2, 8, 4, 6, 15, 11, 1, 10, 9, 3, 14, 5, 0, 12, 7), array(1, 15, 13, 8, 10, 3, 7, 4, 12, 5, 6, 11, 0, 14, 9, 2), array(7, 11, 4, 1, 9, 12, 14, 2, 0, 6, 10, 13, 15, 3, 5, 8), array(2, 1, 14, 7, 4, 10, 8, 13, 15, 12, 9, 0, 3, 5, 6, 11)))</default>
        <docblock line="103">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="139" package="modules">
        <name>x</name>
        <full_name>\smbHash::x()</full_name>
        <docblock line="139">
          <description>Fixes too large numbers</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="149" package="modules">
        <name>lshift</name>
        <full_name>\smbHash::lshift()</full_name>
        <docblock line="149">
          <description></description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;count&lt;/p&gt;" line="149" type="integer" variable="">
            <type>integer</type>
          </tag>
          <tag name="param" description="" line="149" type="array" variable="$data">
            <type>array</type>
          </tag>
          <tag name="return" description="" line="149" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$count</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$data</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="162" package="modules">
        <name>permute</name>
        <full_name>\smbHash::permute()</full_name>
        <docblock line="162">
          <description></description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;in input data&lt;/p&gt;" line="162" type="array" variable="">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;p permutation&lt;/p&gt;" line="162" type="array" variable="">
            <type>array</type>
          </tag>
          <tag name="return" description="" line="162" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$in</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$p</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$n</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="175" package="modules">
        <name>mxor</name>
        <full_name>\smbHash::mxor()</full_name>
        <docblock line="175">
          <description></description>
          <long-description></long-description>
          <tag name="param" description="" line="175" type="array" variable="$in1">
            <type>array</type>
          </tag>
          <tag name="param" description="" line="175" type="array" variable="$in2">
            <type>array</type>
          </tag>
          <tag name="return" description="" line="175" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$in1</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$in2</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="189" package="modules">
        <name>doHash</name>
        <full_name>\smbHash::doHash()</full_name>
        <docblock line="189">
          <description></description>
          <long-description></long-description>
          <tag name="param" description="" line="189" type="array" variable="$in">
            <type>array</type>
          </tag>
          <tag name="param" description="" line="189" type="array" variable="$key">
            <type>array</type>
          </tag>
          <tag name="param" description="" line="189" type="boolean" variable="$forw">
            <type>boolean</type>
          </tag>
          <tag name="return" description="" line="189" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$in</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$key</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$forw</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="261" package="modules">
        <name>str_to_key</name>
        <full_name>\smbHash::str_to_key()</full_name>
        <docblock line="261">
          <description>str_to_key</description>
          <long-description></long-description>
          <tag name="param" description="" line="261" type="string" variable="$str">
            <type>string</type>
          </tag>
          <tag name="return" description="key" line="261" type="string">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$str</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="284" package="modules">
        <name>smb_hash</name>
        <full_name>\smbHash::smb_hash()</full_name>
        <docblock line="284">
          <description>smb_hash</description>
          <long-description></long-description>
          <tag name="param" description="" line="284" type="\unknown_type" variable="$in">
            <type>\unknown_type</type>
          </tag>
          <tag name="param" description="" line="284" type="\unknown_type" variable="$key">
            <type>\unknown_type</type>
          </tag>
          <tag name="param" description="" line="284" type="\unknown_type" variable="$forw">
            <type>\unknown_type</type>
          </tag>
          <tag name="return" description="" line="284" type="\unknown">
            <type>\unknown</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$in</name>
          <default></default>
          <type>\unknown_type</type>
        </argument>
        <argument line="0">
          <name>$key</name>
          <default></default>
          <type>\unknown_type</type>
        </argument>
        <argument line="0">
          <name>$forw</name>
          <default></default>
          <type>\unknown_type</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="310" package="modules">
        <name>E_P16</name>
        <full_name>\smbHash::E_P16()</full_name>
        <docblock line="310">
          <description>E_P16</description>
          <long-description></long-description>
          <tag name="param" description="" line="310" type="\unknown_type" variable="$in">
            <type>\unknown_type</type>
          </tag>
          <tag name="return" description="" line="310" type="\unknown">
            <type>\unknown</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$in</name>
          <default></default>
          <type>\unknown_type</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="334" package="modules">
        <name>lmhash</name>
        <full_name>\smbHash::lmhash()</full_name>
        <docblock line="334">
          <description>Calculates the LM hash of a given password.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;password&lt;/p&gt;" line="334" type="string" variable="$password">
            <type>string</type>
          </tag>
          <tag name="return" description="hash value" line="334" type="string">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$password</name>
          <default>""</default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="351" package="modules">
        <name>nthash</name>
        <full_name>\smbHash::nthash()</full_name>
        <docblock line="351">
          <description>Calculates the NT hash of a given password.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;password&lt;/p&gt;" line="351" type="string" variable="$password">
            <type>string</type>
          </tag>
          <tag name="return" description="hash value" line="351" type="string">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$password</name>
          <default>""</default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="360" package="modules">
        <name>unsigned_shift_r</name>
        <full_name>\smbHash::unsigned_shift_r()</full_name>
        <docblock line="360">
          <description>Unsigned shift operation for 32bit values.</description>
          <long-description>PHP 4 only supports signed shifts by default.</long-description>
        </docblock>
        <argument line="0">
          <name>$a</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$b</name>
          <default></default>
          <type/>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="lib/security.inc" generated-path="lib.security.inc.html" hash="4ab8d569ccd4ce81d012cd8f66b921c1" package="lib">
    <docblock line="0">
      <description>This file includes functions to perform several security checks on each page load.</description>
      <long-description></long-description>
      <tag name="package" description="lib" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <function namespace="" line="47" package="lib">
      <name>startSecureSession</name>
      <full_name>\startSecureSession()</full_name>
      <docblock line="47">
        <description>Starts a session and checks the environment.</description>
        <long-description>The script is stopped if one of the checks fail (timeout redirection may be overriden).</long-description>
        <tag name="param" description="&lt;p&gt;redirect user to login page (default: true)&lt;/p&gt;&#10;" line="47" type="boolean" variable="$redirectToLogin">
          <type>boolean</type>
        </tag>
        <tag name="param" description="&lt;p&gt;init verification data like session ID and client IP (default: false)&lt;/p&gt;&#10;" line="47" type="boolean" variable="$initSecureData">
          <type>boolean</type>
        </tag>
        <tag name="return" description="true if all ok, false if session expired" line="47" type="boolean">
          <type>boolean</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$redirectToLogin</name>
        <default>true</default>
        <type>boolean</type>
      </argument>
      <argument line="0">
        <name>$initSecureData</name>
        <default>false</default>
        <type>boolean</type>
      </argument>
    </function>
    <function namespace="" line="99" package="lib">
      <name>checkClientIP</name>
      <full_name>\checkClientIP()</full_name>
      <docblock line="99">
        <description>Checks if the client's IP address is on the list of allowed IPs.</description>
        <long-description>The script is stopped if the host is not valid.</long-description>
      </docblock>
    </function>
    <function namespace="" line="130" package="lib">
      <name>logoffAndBackToLoginPage</name>
      <full_name>\logoffAndBackToLoginPage()</full_name>
      <docblock line="130">
        <description>Logs off the user and displays the login page.</description>
        <long-description></long-description>
      </docblock>
    </function>
    <function namespace="" line="193" package="lib">
      <name>logNewMessage</name>
      <full_name>\logNewMessage()</full_name>
      <docblock line="193">
        <description>Puts a new message in the log file.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;log level (LOG_DEBUG, LOG_NOTICE, LOG_WARNING, LOG_ERR)&lt;/p&gt;&#10;" line="193" type="string" variable="$level">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;log message&lt;/p&gt;" line="193" type="string" variable="$message">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$level</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$message</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="230" package="lib">
      <name>checkIfWriteAccessIsAllowed</name>
      <full_name>\checkIfWriteAccessIsAllowed()</full_name>
      <docblock line="230">
        <description>Checks if write access to LDAP is allowed.</description>
        <long-description></long-description>
        <tag name="return" description="true, if allowed" line="230" type="boolean">
          <type>boolean</type>
        </tag>
      </docblock>
    </function>
    <function namespace="" line="245" package="lib">
      <name>checkIfPasswordChangeIsAllowed</name>
      <full_name>\checkIfPasswordChangeIsAllowed()</full_name>
      <docblock line="245">
        <description>Checks if passwords may be changed.</description>
        <long-description></long-description>
        <tag name="return" description="true, if allowed" line="245" type="boolean">
          <type>boolean</type>
        </tag>
      </docblock>
    </function>
    <function namespace="" line="262" package="lib">
      <name>checkIfNewEntriesAreAllowed</name>
      <full_name>\checkIfNewEntriesAreAllowed()</full_name>
      <docblock line="262">
        <description>Checks if it is allowed to create new LDAP entries of the given type.</description>
        <long-description>This also checks if general write access is enabled.</long-description>
        <tag name="param" description="&lt;p&gt;account type (e.g. 'user')&lt;/p&gt;&#10;" line="262" type="String" variable="$scope">
          <type>String</type>
        </tag>
        <tag name="return" description="true, if new entries are allowed" line="262" type="boolean">
          <type>boolean</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>String</type>
      </argument>
    </function>
    <function namespace="" line="282" package="lib">
      <name>checkIfDeleteEntriesIsAllowed</name>
      <full_name>\checkIfDeleteEntriesIsAllowed()</full_name>
      <docblock line="282">
        <description>Checks if it is allowed to delete LDAP entries of the given type.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;account type (e.g. 'user')&lt;/p&gt;&#10;" line="282" type="String" variable="$scope">
          <type>String</type>
        </tag>
        <tag name="return" description="true, if entries may be deleted" line="282" type="boolean">
          <type>boolean</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>String</type>
      </argument>
    </function>
    <function namespace="" line="302" package="lib">
      <name>checkPasswordStrength</name>
      <full_name>\checkPasswordStrength()</full_name>
      <docblock line="302">
        <description>Checks if the password fulfills the password policies.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;password&lt;/p&gt;" line="302" type="string" variable="$password">
          <type>string</type>
        </tag>
        <tag name="return" description="true if ok, string with error message if not valid" line="302" type="mixed">
          <type>mixed</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$password</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="373" package="lib">
      <name>checkIfToolIsActive</name>
      <full_name>\checkIfToolIsActive()</full_name>
      <docblock line="373">
        <description>Checks if the given tool is active.</description>
        <long-description>Otherwise, an error message is logged and the execution is stopped (die()).</long-description>
        <tag name="param" description="&lt;p&gt;tool class name (e.g. toolFileUpload)&lt;/p&gt;&#10;" line="373" type="String" variable="$tool">
          <type>String</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$tool</name>
        <default></default>
        <type>String</type>
      </argument>
    </function>
    <source> </source>
  </file>
  <file path="lib/baseModule.inc" generated-path="lib.baseModule.inc.html" hash="f114dbbf5e6cdc1cf19449d08dad2a18" package="modules">
    <docblock line="0">
      <description>This is the parent class for all account modules.</description>
      <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.</long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="see" description="" line="0"/>
    </docblock>
    <class final="false" abstract="true" namespace="" line="53" package="modules">
      <extends/>
      <name>baseModule</name>
      <full_name>\baseModule</full_name>
      <docblock line="53">
        <description>Parent class of all account modules.</description>
        <long-description>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Location and naming of modules&lt;/b&gt;&lt;br&gt;
All LAM modules are placed in lib/modules/ and are named "&lt;class name&gt;.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.&lt;br&gt;
&lt;br&gt;
You can avoid to override many functions by using {@link get_metaData()}.&lt;br&gt;
&lt;br&gt;
All module classes should extend the baseModule class.</long-description>
        <tag name="package" description="modules" line="53"/>
        <tag name="author" description="Roland Gruber" line="53"/>
      </docblock>
      <property static="false" visibility="protected" line="56" namespace="" package="modules">
        <name>$meta</name>
        <default></default>
        <docblock line="56">
          <description>includes all meta data provided by the sub class</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="59" namespace="" package="modules">
        <name>$scope</name>
        <default></default>
        <docblock line="59">
          <description>the account type of this module (user, group, host)</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="62" namespace="" package="modules">
        <name>$moduleSettings</name>
        <default></default>
        <docblock line="62">
          <description>configuration settings of all modules</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="65" namespace="" package="modules">
        <name>$selfServiceSettings</name>
        <default></default>
        <docblock line="65">
          <description>self service settings of all modules</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="68" namespace="" package="modules">
        <name>$base</name>
        <default></default>
        <docblock line="68">
          <description>name of parent accountContainer ($_SESSION[$base])</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="71" namespace="" package="modules">
        <name>$attributes</name>
        <default></default>
        <docblock line="71">
          <description>contains all ldap attributes which should be written</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="74" namespace="" package="modules">
        <name>$orig</name>
        <default></default>
        <docblock line="74">
          <description>contains all ldap attributes which are loaded from ldap</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="77" namespace="" package="modules">
        <name>$messages</name>
        <default></default>
        <docblock line="77">
          <description>contains all error messages of a module</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="80" namespace="" package="modules">
        <name>$autoAddObjectClasses</name>
        <default></default>
        <docblock line="80">
          <description>if true, managed object classes are added when an account is created or loaded (default: true)</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="87" package="modules">
        <name>__construct</name>
        <full_name>\baseModule::__construct()</full_name>
        <docblock line="87">
          <description>Creates a new base module class</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;the account type (user, group, host)&lt;/p&gt;&#10;" line="87" type="string" variable="$scope">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$scope</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="103" package="modules">
        <name>load_Messages</name>
        <full_name>\baseModule::load_Messages()</full_name>
        <docblock line="103">
          <description>This function fills the $messages variable with output messages from this module.</description>
          <long-description>Calling this method requires the existence of an enclosing {@link accountContainer}.</long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="113" package="modules">
        <name>init</name>
        <full_name>\baseModule::init()</full_name>
        <docblock line="113">
          <description>Initializes the module after it became part of an {@link accountContainer}</description>
          <long-description>Calling this method requires the existence of an enclosing {@link accountContainer}.</long-description>
          <tag name="param" description="&lt;p&gt;the name of the {@link accountContainer} object ($_SESSION[$base])&lt;/p&gt;&#10;" line="113" type="string" variable="$base">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$base</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="141" package="modules">
        <name>load_attributes</name>
        <full_name>\baseModule::load_attributes()</full_name>
        <docblock line="141">
          <description>This function loads the LDAP attributes when an account should be loaded.</description>
          <long-description>Calling this method requires the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
By default this method loads the object classes and accounts which are specified in {@link getManagedObjectClasses()}
and {@link getManagedAttributes()}.</long-description>
          <tag name="param" description="&lt;p&gt;array like the array returned by get_ldap_attributes(dn of account) but without count indices&lt;/p&gt;&#10;" line="141" type="array" variable="$attributes">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="376" package="modules">
        <name>get_metaData</name>
        <full_name>\baseModule::get_metaData()</full_name>
        <docblock line="376">
          <description>This function provides meta data which is interpreted by baseModule.</description>
          <long-description>Only subclasses will return real data.&lt;br&gt;
&lt;br&gt;
The aim of the meta data is to reduce the number
of functions in the subclasses. All major data is centralized in one place.&lt;br&gt;
&lt;br&gt;
The returned array contains a list of key-value pairs for the different functions.&lt;br&gt;
&lt;ul&gt;

&lt;li&gt;&lt;b&gt;{@link can_manage()}&lt;/b&gt;&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Key:&lt;/b&gt; account_types&lt;br&gt;
&lt;b&gt;Value:&lt;/b&gt; array of account types&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Example:&lt;/b&gt; "account_types" =&gt; array("user", "host")
&lt;br&gt;&lt;br&gt;
&lt;/li&gt;

&lt;li&gt;&lt;b&gt;{@link is_base_module()}&lt;/b&gt;&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Key:&lt;/b&gt; is_base&lt;br&gt;
&lt;b&gt;Value:&lt;/b&gt; boolean&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Example:&lt;/b&gt; "is_base" =&gt; true
&lt;br&gt;&lt;br&gt;
&lt;/li&gt;

&lt;li&gt;&lt;b&gt;{@link get_ldap_filter()}&lt;/b&gt;&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Key:&lt;/b&gt; ldap_filter&lt;br&gt;
&lt;b&gt;Value:&lt;/b&gt; array of filters&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Example:&lt;/b&gt; "ldap_filter" =&gt; array('or' =&gt; 'objectClass=posixAccount', 'and' =&gt; '(!(uid=*$))')
&lt;br&gt;&lt;br&gt;
&lt;/li&gt;

&lt;li&gt;&lt;b&gt;{@link getManagedObjectClasses()}&lt;/b&gt;&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Key:&lt;/b&gt; objectClasses&lt;br&gt;
&lt;b&gt;Value:&lt;/b&gt; array of object classes&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Example:&lt;/b&gt; "objectClasses" =&gt; array('posixAccount')
&lt;br&gt;&lt;br&gt;
&lt;/li&gt;

&lt;li&gt;&lt;b&gt;{@link getLDAPAliases()}&lt;/b&gt;&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Key:&lt;/b&gt; LDAPaliases&lt;br&gt;
&lt;b&gt;Value:&lt;/b&gt; array of aliases&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Example:&lt;/b&gt; "LDAPaliases" =&gt; array('commonName' =&gt; 'cn')
&lt;br&gt;&lt;br&gt;
&lt;/li&gt;

&lt;li&gt;&lt;b&gt;{@link get_RDNAttributes()}&lt;/b&gt;&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Key:&lt;/b&gt; RDN&lt;br&gt;
&lt;b&gt;Value:&lt;/b&gt; array of RDNs&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Example:&lt;/b&gt; "RDN" =&gt; array('uid' =&gt; 'normal', 'cn' =&gt; 'low')
&lt;br&gt;&lt;br&gt;
&lt;/li&gt;

&lt;li&gt;&lt;b&gt;{@link get_dependencies()}&lt;/b&gt;&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Key:&lt;/b&gt; dependencies&lt;br&gt;
&lt;b&gt;Value:&lt;/b&gt; array of dependencies&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Example:&lt;/b&gt; "dependencies" =&gt; array("depends" =&gt; array("posixAccount", array("qmail", "sendmail")), "conflicts" =&gt; array("exim"))
&lt;br&gt;&lt;br&gt;
&lt;/li&gt;

&lt;li&gt;&lt;b&gt;{@link get_profileOptions()}&lt;/b&gt;&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Key:&lt;/b&gt; profile_options&lt;br&gt;
&lt;b&gt;Value:&lt;/b&gt; array of profile options&lt;br&gt;
&lt;br&gt;
The syntax for the value array is the same as for the return value of get_profileOptions().
&lt;br&gt;&lt;br&gt;
&lt;/li&gt;

&lt;li&gt;&lt;b&gt;{@link check_profileOptions()}&lt;/b&gt;&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Key:&lt;/b&gt; profile_checks&lt;br&gt;
&lt;b&gt;Value:&lt;/b&gt; array of checks (array("optionName" =&gt; array()))&lt;br&gt;
&lt;br&gt;
The "optionName" keys of the value array are the names of the option identifiers.&lt;br&gt;
Each array element is an array itself containing these values:
&lt;ul&gt;
&lt;li&gt;&lt;b&gt;type:&lt;/b&gt; determines how to check input&lt;br&gt;
Possible values:
	&lt;ul&gt;
	&lt;li&gt;&lt;b&gt;regex:&lt;/b&gt; check with regular expression from regex variable, case sensitive&lt;/li&gt;
&lt;li&gt;&lt;b&gt;regex_i:&lt;/b&gt; check with regular expression from regex variable, case insensitive&lt;/li&gt;
	&lt;li&gt;&lt;b&gt;int_greater:&lt;/b&gt; integer value of cmp_name1 must be greater than the integer value from the option cmp_name2&lt;/li&gt;
	&lt;li&gt;&lt;b&gt;int_greaterOrEqual:&lt;/b&gt; integer value of cmp_name1 must be greater or equal than the integer value from the option cmp_name2&lt;/li&gt;
	&lt;/ul&gt;
&lt;/li&gt;
&lt;li&gt;&lt;b&gt;error_message:&lt;/b&gt; message that is displayed if input value was syntactically incorrect&lt;br&gt;
	error_message is an array to build StatusMessages (message type, message head, message text, additional variables)
&lt;li&gt;&lt;b&gt;regex:&lt;/b&gt; regular expression string (only if type is regex/regex_i)&lt;/li&gt;
&lt;li&gt;&lt;b&gt;cmp_name1:&lt;/b&gt; name of first input variable that is used for comparison (only if type is int_greater/int_greaterOrEqual)&lt;/li&gt;
&lt;li&gt;&lt;b&gt;cmp_name2:&lt;/b&gt; name of second input variable that is used for comparison (only if type is int_greater/int_greaterOrEqual)&lt;/li&gt;
&lt;li&gt;&lt;b&gt;required:&lt;/b&gt; true or false, if this input field must be filled set to true (optional)
&lt;li&gt;&lt;b&gt;required_message:&lt;/b&gt; message that is displayed if no input value was given (only if required == true)&lt;br&gt;
	required_message is an array to build StatusMessages (message type, message head, message text, additional variables)
&lt;/li&gt;
&lt;/ul&gt;
&lt;br&gt;&lt;br&gt;
&lt;/li&gt;

&lt;li&gt;&lt;b&gt;{@link load_profile()}&lt;/b&gt;&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Key:&lt;/b&gt; profile_mappings&lt;br&gt;
&lt;b&gt;Value:&lt;/b&gt; array('profile_identifier1' =&gt; 'LDAP_attribute1', 'profile_identifier2' =&gt; 'LDAP_attribute2')&lt;br&gt;
&lt;br&gt;
The mapped values are stored directly in $this-&gt;attributes.
&lt;br&gt;
&lt;b&gt;Example:&lt;/b&gt; "profile_mappings" =&gt; array('inetOrgPerson_title' =&gt; 'title')
&lt;br&gt;&lt;br&gt;
&lt;/li&gt;

&lt;li&gt;&lt;b&gt;{@link get_configOptions()}&lt;/b&gt;&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Key:&lt;/b&gt; config_options&lt;br&gt;
&lt;b&gt;Value:&lt;/b&gt; array('user' =&gt; array, 'host' =&gt; array, 'all' =&gt; array)&lt;br&gt;
&lt;br&gt;
The values from 'all' are always returned, the other values only if they are inside the $scopes array.&lt;br&gt;
The syntax for sub arrays is the same as for the return value of {@link get_configOptions()}.
&lt;br&gt;&lt;br&gt;
&lt;/li&gt;

&lt;li&gt;&lt;b&gt;{@link check_configOptions()}&lt;/b&gt;&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Key:&lt;/b&gt; config_checks&lt;br&gt;
&lt;b&gt;Value:&lt;/b&gt; array('user' =&gt; array, 'host' =&gt; 'array', 'all' =&gt; array)&lt;br&gt;
&lt;br&gt;
The values from 'all' are always used for checking, the other values only if they are inside the $scopes array.
The syntax for sub arrays is the same as for {@link check_configOptions()}.
&lt;br&gt;&lt;br&gt;
&lt;/li&gt;

&lt;li&gt;&lt;b&gt;{@link get_uploadColumns()}&lt;/b&gt;&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Key:&lt;/b&gt; upload_columns&lt;br&gt;
&lt;b&gt;Value:&lt;/b&gt; array&lt;br&gt;
&lt;br&gt;
The syntax for array is the same as for the return value of {@link get_uploadColumns()}.
&lt;br&gt;&lt;br&gt;
&lt;/li&gt;

&lt;li&gt;&lt;b&gt;{@link get_uploadPreDepends()}&lt;/b&gt;&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Key:&lt;/b&gt; upload_preDepends&lt;br&gt;
&lt;b&gt;Value:&lt;/b&gt; array&lt;br&gt;
&lt;br&gt;
The syntax for array is the same as for the return value of {@link get_uploadPreDepends()}.
&lt;br&gt;&lt;br&gt;
&lt;/li&gt;

&lt;li&gt;&lt;b&gt;{@link getRequiredExtensions()}&lt;/b&gt;&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Key:&lt;/b&gt; extensions&lt;br&gt;
&lt;b&gt;Value:&lt;/b&gt; array of extension names&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Example:&lt;/b&gt; "extensions" =&gt; array('hash')
&lt;br&gt;&lt;br&gt;
&lt;/li&gt;

&lt;li&gt;&lt;b&gt;{@link get_help()}&lt;/b&gt;&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Key:&lt;/b&gt; help&lt;br&gt;
&lt;b&gt;Value:&lt;/b&gt; hashtable of help entries&lt;br&gt;
&lt;br&gt;
The hashtable is an array which maps help IDs to help entries.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Example:&lt;/b&gt; 'help' =&gt; array('myEntry' =&gt; array('Headline' =&gt; 'This is the head line', 'Text' =&gt; 'Help content'))
&lt;br&gt;&lt;br&gt;
&lt;/li&gt;

&lt;li&gt;&lt;b&gt;{@link getSelfServiceSearchAttributes()}&lt;/b&gt;&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Key:&lt;/b&gt; selfServiceSearchAttributes&lt;br&gt;
&lt;b&gt;Value:&lt;/b&gt; array of attribute names&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Example:&lt;/b&gt; "selfServiceSearchAttributes" =&gt; array('uid')
&lt;br&gt;&lt;br&gt;
&lt;/li&gt;

&lt;li&gt;&lt;b&gt;{@link getSelfServiceFields()}&lt;/b&gt;&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Key:&lt;/b&gt; selfServiceFieldSettings&lt;br&gt;
&lt;b&gt;Value:&lt;/b&gt; array of self service fields&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Example:&lt;/b&gt; "selfServiceFieldSettings" =&gt; array('pwd' =&gt; 'Password')
&lt;br&gt;&lt;br&gt;
&lt;/li&gt;

&lt;/ul&gt;
&lt;b&gt;Example:&lt;/b&gt; return array("is_base" =&gt; true);</long-description>
          <tag name="return" description="meta data" line="376" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="385" package="modules">
        <name>get_scope</name>
        <full_name>\baseModule::get_scope()</full_name>
        <docblock line="385">
          <description>Returns the account type of this module (user, group, host)</description>
          <long-description></long-description>
          <tag name="return" description="account type" line="385" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="398" package="modules">
        <name>can_manage</name>
        <full_name>\baseModule::can_manage()</full_name>
        <docblock line="398">
          <description>Returns true if this module can manage accounts of the current type, otherwise false.</description>
          <long-description>Calling this method does not require the existence of an enclosing {@link accountContainer}.</long-description>
          <tag name="return" description="true if module fits" line="398" type="boolean">
            <type>boolean</type>
          </tag>
          <tag name="see" description="" line="398"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="415" package="modules">
        <name>is_base_module</name>
        <full_name>\baseModule::is_base_module()</full_name>
        <docblock line="415">
          <description>Returns true if your module is a base module and otherwise false.</description>
          <long-description>Calling this method does not require the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
Every account type needs exactly one base module. A base module manages a structural object class.
E.g. the inetOrgPerson module is a base module since its object class is structural.</long-description>
          <tag name="return" description="true if base module (defaults to false if no meta data is provided)" line="415" type="boolean">
            <type>boolean</type>
          </tag>
          <tag name="see" description="" line="415"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="435" package="modules">
        <name>get_ldap_filter</name>
        <full_name>\baseModule::get_ldap_filter()</full_name>
        <docblock line="435">
          <description>Returns an LDAP filter for the account lists</description>
          <long-description>Calling this method does not require the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
Returns an array('or' =&gt; '...', 'and' =&gt; '...') that is used to build the LDAP filter. Usually, this is used to filter object classes.
All "or" filter parts of the base modules are combined with OR and then combined with the "and" parts.&lt;br&gt;
The resulting LDAP filter will look like this: (&amp;(|(OR1)(OR2)(OR3))(AND1)(AND2)(AND3))&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Example:&lt;/b&gt; return array('or' =&gt; '(objectClass=posixAccount)', 'and' =&gt; '(!(uid=*$))')</long-description>
          <tag name="return" description="LDAP filter" line="435" type="string">
            <type>string</type>
          </tag>
          <tag name="see" description="" line="435"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="453" package="modules">
        <name>get_alias</name>
        <full_name>\baseModule::get_alias()</full_name>
        <docblock line="453">
          <description>Returns an alias name for the module.</description>
          <long-description>Calling this method does not require the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
This function returns a more descriptive string than the class name. Alias names are used for the buttons on the account pages and the module selection in the configuration wizard.&lt;br&gt;
Please take care that your alias name is not too long. It may contain any character but should not include parts that may be interpreted by the browser (e.g. '&lt;' or '&gt;').
If you use different aliases dependent on the account type please make sure that there is a general alias for unknown types.</long-description>
          <tag name="return" description="alias name" line="453" type="string">
            <type>string</type>
          </tag>
          <tag name="see" description="" line="453"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="473" package="modules">
        <name>get_RDNAttributes</name>
        <full_name>\baseModule::get_RDNAttributes()</full_name>
        <docblock line="473">
          <description>Returns a hash array containing a list of possible LDAP attributes that can be used to form the RDN (Relative Distinguished Name).</description>
          <long-description>Calling this method does not require the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
The returned elements have this form: &lt;attribute&gt; =&gt; &lt;priority&gt;
&lt;br&gt; &lt;attribute&gt; is the name of the LDAP attribute
&lt;br&gt; &lt;priority&gt; defines the priority of the attribute (can be "low", "normal", "high")&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Example:&lt;/b&gt; return array('uid' =&gt; 'normal', 'cn' =&gt; 'low')</long-description>
          <tag name="return" description="list of attributes" line="473" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="473"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="496" package="modules">
        <name>get_dependencies</name>
        <full_name>\baseModule::get_dependencies()</full_name>
        <docblock line="496">
          <description>This function returns a list with all depending and conflicting modules.</description>
          <long-description>Calling this method does not require the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
The return value is an array with two sub arrays, "depends" and "conflicts".
All values of the conflict array are string values with module names. All values of the depends
array are either string values with module names or arrays which include only string values with
module names.&lt;br&gt;
If an element of the depends array is itself an array, this means that your module
depends on one of these modules.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Example:&lt;/b&gt; return array("depends" =&gt; array("posixAccount", array("qmail", "sendmail")), "conflicts" =&gt; array("exim"))</long-description>
          <tag name="return" description="list of dependencies and conflicts" line="496" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="496"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="516" package="modules">
        <name>get_profileOptions</name>
        <full_name>\baseModule::get_profileOptions()</full_name>
        <docblock line="516">
          <description>This function defines what attributes will be used in the account profiles and their appearance in the profile editor.</description>
          <long-description>Calling this method does not require the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
The return value is an object implementing htmlElement.&lt;br&gt;
The field name are used as keywords to load
and save profiles. We recommend to use the module name as prefix for them
(e.g. posixAccount_homeDirectory) to avoid naming conflicts.</long-description>
          <tag name="return" description="meta HTML object" line="516" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
          <tag name="see" description="" line="516"/>
          <tag name="see" description="" line="516"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="537" package="modules">
        <name>check_profileOptions</name>
        <full_name>\baseModule::check_profileOptions()</full_name>
        <docblock line="537">
          <description>Checks input values of account profiles.</description>
          <long-description>Calling this method does not require the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
$options is an hash array (option name =&gt; value) that contains the user input.
The option values are all arrays containing one or more elements.&lt;br&gt;
If the input data is invalid the return value is an array that contains arrays
to build StatusMessages (message type, message head, message text). If no errors occured
the function returns an empty array.</long-description>
          <tag name="param" description="&lt;p&gt;a hash array (name =&gt; value) containing the user input&lt;/p&gt;&#10;" line="537" type="array" variable="$options">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages (array(type, title, text)) to generate StatusMessages, if any" line="537" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="537"/>
        </docblock>
        <argument line="0">
          <name>$options</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="622" package="modules">
        <name>load_profile</name>
        <full_name>\baseModule::load_profile()</full_name>
        <docblock line="622">
          <description>This function loads the values from an account profile to the module's internal data structures.</description>
          <long-description>Calling this method does not require the existence of an enclosing {@link accountContainer}.</long-description>
          <tag name="param" description="&lt;p&gt;hash array with profile values (identifier =&gt; value)&lt;/p&gt;&#10;" line="622" type="array" variable="$profile">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="622"/>
        </docblock>
        <argument line="0">
          <name>$profile</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="648" package="modules">
        <name>get_configOptions</name>
        <full_name>\baseModule::get_configOptions()</full_name>
        <docblock line="648">
          <description>Returns a list of configuration options.</description>
          <long-description>Calling this method does not require the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
The field names are used as keywords to load and save settings.
We recommend to use the module name as prefix for them (e.g. posixAccount_homeDirectory) to avoid naming conflicts.</long-description>
          <tag name="param" description="&lt;p&gt;account types (user, group, host)&lt;/p&gt;&#10;" line="648" type="array" variable="$scopes">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of all active account modules and their scopes (module =&gt; array(scopes))&lt;/p&gt;&#10;" line="648" type="array" variable="$allScopes">
            <type>array</type>
          </tag>
          <tag name="return" description="htmlElement or array of htmlElement" line="648" type="mixed">
            <type>mixed</type>
          </tag>
          <tag name="see" description="" line="648"/>
          <tag name="see" description="" line="648"/>
        </docblock>
        <argument line="0">
          <name>$scopes</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$allScopes</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="691" package="modules">
        <name>check_configOptions</name>
        <full_name>\baseModule::check_configOptions()</full_name>
        <docblock line="691">
          <description>Checks input values of module settings.</description>
          <long-description>Calling this method does not require the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
If the input data is invalid the return value is an array that contains subarrays to build StatusMessages ('message type', 'message head', 'message text').
&lt;br&gt;If no errors occured the function returns an empty array.</long-description>
          <tag name="param" description="&lt;p&gt;list of account types which are used&lt;/p&gt;" line="691" type="array" variable="$scopes">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;hash array (option name =&gt; value) that contains the input. The option values are all arrays containing one or more elements.&lt;/p&gt;&#10;" line="691" type="array" variable="$options">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages" line="691" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="691"/>
        </docblock>
        <argument line="0">
          <name>$scopes</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$options</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="814" package="modules">
        <name>get_pdfFields</name>
        <full_name>\baseModule::get_pdfFields()</full_name>
        <docblock line="814">
          <description>Returns a hashtable with all entries that may be printed out in the PDF.</description>
          <long-description>Calling this method does not require the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
This method must be overwritten in case that there are non static values
to be returned. The $this-&gt;meta['PDF_fields'] array may be used for static content.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Format of returned hashtable:&lt;/b&gt;&lt;br&gt;
&lt;br&gt;
This function uses XML formatted commands to define the PDF output. Each part in the PDF
document is surrounded by "&lt;block&gt;" and "&lt;/block&gt;".&lt;br&gt;
Inside the &lt;block&gt; tags there are different ways to format the output:
&lt;ul&gt;
&lt;li&gt;&lt;b&gt;simple line with attribute name and value:&lt;/b&gt; &lt;block&gt;&lt;key&gt;&lt;b&gt;attribute name&lt;/b&gt;&lt;/key&gt;&lt;value&gt;&lt;b&gt;attribute value&lt;/b&gt;&lt;/value&gt;&lt;/block&gt;&lt;/li&gt;
&lt;li&gt;&lt;b&gt;table:&lt;/b&gt; &lt;block&gt;&lt;key&gt;&lt;b&gt;attribute name&lt;/b&gt;&lt;/key&gt;&lt;tr&gt;&lt;td&gt;&lt;b&gt;value&lt;/b&gt;&lt;td&gt;&lt;td&gt;&lt;b&gt;value&lt;/b&gt;&lt;td&gt;&lt;/tr&gt;&lt;/block&gt;&lt;block&gt;&lt;tr&gt;&lt;td&gt;&lt;b&gt;value&lt;/b&gt;&lt;/td&gt;&lt;td&gt;&lt;b&gt;value&lt;/b&gt;&lt;td&gt;&lt;/tr&gt;&lt;/block&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;b&gt;Special commands:&lt;/b&gt;
&lt;ul&gt;
&lt;li&gt;&lt;b&gt;Alignment in &lt;td&gt;:&lt;/b&gt; You can specify the alignment in &lt;td&gt; tags with align=(L|R|C) (e.g. &lt;td align=\"L\"&gt;)&lt;/li&gt;
&lt;li&gt;&lt;b&gt;Cell width:&lt;/b&gt; &lt;td&gt; allows an attribute "width" to set the cell width (e.g. &lt;td width=20%&gt; or &lt;td width=30&gt;).&lt;/li&gt;
&lt;li&gt;&lt;b&gt;Line breaks:&lt;/b&gt; Line breaks can be specified by adding a &lt;&lt;br&gt;&gt; tag. The new line will start at the left border of the PDF document.&lt;/li&gt;
&lt;/ul&gt;
&lt;br&gt;
&lt;b&gt;Examples:&lt;/b&gt;&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Simple name+value lines:&lt;/b&gt;&lt;br&gt;&lt;br&gt;
In most cases you will just want to display a single line per attribute with its name and value.&lt;br&gt;
&lt;br&gt;
'myAttribute' =&gt; '&lt;block&gt;&lt;key&gt;AttrName&lt;/key&gt;&lt;value&gt;12345&lt;/value&gt;&lt;/block&gt;'&lt;br&gt;
&lt;br&gt;
This will give the following PDF output:&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Attribute name:&lt;/b&gt; 12345&lt;br&gt;
&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Multiline values:&lt;/b&gt;&lt;br&gt;&lt;br&gt;
Sometimes you have multivalued attributes where it is not applicable to write all values in one line but
where you want to list your values one below the other or show a table. This can be done by using the &lt;td&gt; tag.&lt;br&gt;
&lt;br&gt;
This example only uses one column but you can just use more &lt;td&gt; tags per &lt;block&gt; tag to display more columns.&lt;br&gt;
&lt;br&gt;
'myAttribute' =&gt; '&lt;block&gt;&lt;key&gt;AttrName&lt;/key&gt;&lt;tr&gt;&lt;td align=\"L\"&gt;123&lt;/td&gt;&lt;/tr&gt;&lt;/block&gt;&lt;block&gt;&lt;tr&gt;&lt;td align=\"L\"&gt;456&lt;/td&gt;&lt;/tr&gt;&lt;/block&gt;&lt;block&gt;&lt;tr&gt;&lt;td align=\"L\"&gt;789&lt;/td&gt;&lt;/tr&gt;&lt;/block&gt;'</long-description>
          <tag name="return" description="PDF entries" line="814" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="814"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="823" package="modules">
        <name>get_pdfEntries</name>
        <full_name>\baseModule::get_pdfEntries()</full_name>
        <docblock line="823">
          <description>Returns the PDF entries for this module.</description>
          <long-description></long-description>
          <tag name="return" description="list of possible PDF entries" line="823" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="836" package="modules">
        <name>addSimplePDFField</name>
        <full_name>\baseModule::addSimplePDFField()</full_name>
        <docblock line="836">
          <description>Adds a simple PDF entry to the given array.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;result array (entry will be added here)&lt;/p&gt;&#10;" line="836" type="array" variable="$result">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;ID&lt;/p&gt;" line="836" type="String" variable="$name">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;label name&lt;/p&gt;" line="836" type="String" variable="$label">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;attribute name (default: =$name)&lt;/p&gt;&#10;" line="836" type="String" variable="$attrName">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;delimiter if multiple attribute values exist (default: &quot;, &quot;)&lt;/p&gt;&#10;" line="836" type="String" variable="$delimiter">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$result</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$label</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$attrName</name>
          <default>null</default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$delimiter</name>
          <default>', '</default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="878" package="modules">
        <name>get_uploadColumns</name>
        <full_name>\baseModule::get_uploadColumns()</full_name>
        <docblock line="878">
          <description>Returns an array containing all input columns for the file upload.</description>
          <long-description>Calling this method does not require the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
This funtion returns an array which contains subarrays which represent an upload column.
&lt;b&gt;Syntax of column arrays:&lt;/b&gt;
&lt;br&gt;
&lt;br&gt; array(
&lt;br&gt;  string: name,  // fixed non-translated name which is used as column name (should be of format: &lt;module name&gt;_&lt;column name&gt;)
&lt;br&gt;  string: description,  // short descriptive name
&lt;br&gt;  string: help,  // help ID
&lt;br&gt;  string: example,  // example value
&lt;br&gt;  string: values, // possible input values (optional)
&lt;br&gt;  string: default, // default value (optional)
&lt;br&gt;  boolean: required  // true, if user must set a value for this column
&lt;br&gt;  boolean: unique // true if all values of this column must be different values (optional, default: "false")
&lt;br&gt; )</long-description>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="878" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="column list" line="878" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="878"/>
        </docblock>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="894" package="modules">
        <name>get_uploadPreDepends</name>
        <full_name>\baseModule::get_uploadPreDepends()</full_name>
        <docblock line="894">
          <description>Returns a list of module names which must be processed in building the account befor this module.</description>
          <long-description>Calling this method does not require the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
The named modules may not be active, LAM will check this automatically.</long-description>
          <tag name="return" description="list of module names" line="894" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="894"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="912" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>\baseModule::build_uploadAccounts()</full_name>
        <docblock line="912">
          <description>In this function the LDAP accounts are built.</description>
          <long-description>Calling this method does not require the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
Returns an array which contains subarrays to generate StatusMessages if any errors occured.</long-description>
          <tag name="param" description="&lt;p&gt;the user input data, contains one subarray for each account.&lt;/p&gt;" line="912" type="array" variable="$rawAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)&lt;/p&gt;&#10;" line="912" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of hash arrays (name =&gt; value) which are later added to LDAP&lt;/p&gt;&#10;" line="912" type="array" variable="$partialAccounts">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="912" type="array" variable="$selectedModules">
            <type>array</type>
          </tag>
          <tag name="return" description="list of error messages if any" line="912" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rawAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$partialAccounts</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$selectedModules</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="942" package="modules">
        <name>get_help</name>
        <full_name>\baseModule::get_help()</full_name>
        <docblock line="942">
          <description>This function returns the help entry array for a specific help id.</description>
          <long-description>Calling this method does not require the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
The result is an hashtable with the following keys:&lt;br&gt;
&lt;ul&gt;
&lt;li&gt;&lt;b&gt;Headline (required)&lt;/b&gt;&lt;br&gt;
The headline of this help entry. Can consist of any alpha-numeric characters. No HTML/CSS elements are allowed.&lt;/li&gt;
&lt;li&gt;&lt;b&gt;Text (required)&lt;/b&gt;&lt;br&gt;
The text of the help entry which may contain any alpha-numeric characters.&lt;/li&gt;
&lt;li&gt;&lt;b&gt;SeeAlso (optional)&lt;/b&gt;&lt;br&gt;
A reference to anonther related web site. It must be an array containing a field called "text" with the link text
that should be displayed and a field called "link" which is the link target.&lt;/li&gt;
&lt;/ul&gt;
&lt;br&gt;
&lt;b&gt;Example:&lt;/b&gt;&lt;br&gt;
&lt;br&gt;
array('Headline' =&gt; 'This is the head line', 'Text' =&gt; 'Help content', 'SeeAlso' =&gt; array('text' =&gt; 'LAM homepage', 'link' =&gt; 'http://www.ldap-account-manager.org/'))</long-description>
          <tag name="param" description="&lt;p&gt;The id string for the help entry needed.&lt;/p&gt;" line="942" type="string" variable="$id">
            <type>string</type>
          </tag>
          <tag name="return" description="The desired help entry." line="942" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="942"/>
        </docblock>
        <argument line="0">
          <name>$id</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="966" package="modules">
        <name>module_ready</name>
        <full_name>\baseModule::module_ready()</full_name>
        <docblock line="966">
          <description>This function is used to check if this module page can be displayed.</description>
          <long-description>Calling this method requires the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
Your module might depend on input of other modules. This function determines if the user
can change to your module page or not. The return value is true if your module accepts
input, otherwise false.&lt;br&gt;
This method's return value defaults to true.</long-description>
          <tag name="return" description="true, if page can be displayed" line="966" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="982" package="modules">
        <name>module_complete</name>
        <full_name>\baseModule::module_complete()</full_name>
        <docblock line="982">
          <description>This function is used to check if all settings for this module have been made.</description>
          <long-description>Calling this method requires the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
This function tells LAM if it can create/modify the LDAP account. If your module needs any
additional input then set this to false. The user will be notified that your module needs
more input.&lt;br&gt;
This method's return value defaults to true.</long-description>
          <tag name="return" description="true, if settings are complete" line="982" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1000" package="modules">
        <name>getButtonStatus</name>
        <full_name>\baseModule::getButtonStatus()</full_name>
        <docblock line="1000">
          <description>Controls if the module button the account page is visible and activated.</description>
          <long-description>Calling this method requires the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Possible return values:&lt;/b&gt;
&lt;ul&gt;
&lt;li&gt;&lt;b&gt;enabled:&lt;/b&gt; button is visible and active&lt;/li&gt;
&lt;li&gt;&lt;b&gt;disabled:&lt;/b&gt; button is visible and deactivated (greyed)&lt;/li&gt;
&lt;li&gt;&lt;b&gt;hidden:&lt;/b&gt; no button will be shown&lt;/li&gt;
&lt;/ul&gt;</long-description>
          <tag name="return" description="status (&amp;quot;enabled&amp;quot;, &amp;quot;disabled&amp;quot;, &amp;quot;hidden&amp;quot;)" line="1000" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1010" package="modules">
        <name>doUploadPreActions</name>
        <full_name>\baseModule::doUploadPreActions()</full_name>
        <docblock line="1010">
          <description>Runs any actions that need to be done before an LDAP entry is created.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;LDAP attributes of this entry (attributes are provided as reference, handle modifications of $attributes with care)&lt;/p&gt;&#10;" line="1010" type="array" variable="$attributes">
            <type>array</type>
          </tag>
          <tag name="return" description="array which contains status messages. Each entry is an array containing the status message parameters." line="1010" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1036" package="modules">
        <name>doUploadPostActions</name>
        <full_name>\baseModule::doUploadPostActions()</full_name>
        <docblock line="1036">
          <description>This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc.</description>
          <long-description>.).

Calling this method does not require the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
This function is called as long as the returned status is 'finished'. Please make sure
that one function call lasts no longer than 3-4 seconds. Otherwise the upload may fail
because the time limit is exceeded. You should not make more than one LDAP operation in
each call.</long-description>
          <tag name="param" description="&lt;p&gt;array containing one account in each element&lt;/p&gt;" line="1036" type="array" variable="$data">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;maps the column names to keys for the sub arrays (array(&lt;column_name&gt; =&gt; &lt;column number&gt;))&lt;/p&gt;&#10;" line="1036" type="array" variable="$ids">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of account numbers which could not be successfully uploaded to LDAP&lt;/p&gt;" line="1036" type="array" variable="$failed">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;variable to store temporary data between two post actions&lt;/p&gt;" line="1036" type="array" variable="$temp">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of LDAP entries&lt;/p&gt;" line="1036" type="array" variable="$accounts">
            <type>array</type>
          </tag>
          <tag name="return" description="current status&#10;&amp;lt;br&amp;gt; array (&#10;&amp;lt;br&amp;gt;  &amp;#039;status&amp;#039; =&amp;gt; &amp;#039;finished&amp;#039; | &amp;#039;inProgress&amp;#039; // defines if all operations are complete&#10;&amp;lt;br&amp;gt;  &amp;#039;progress&amp;#039; =&amp;gt; 0..100 // the progress of the operations in percent&#10;&amp;lt;br&amp;gt;  &amp;#039;errors&amp;#039; =&amp;gt; array // list of arrays which are used to generate StatusMessages&#10;&amp;lt;br&amp;gt; )" line="1036" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$data</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$ids</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$failed</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$temp</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$accounts</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1064" package="modules">
        <name>save_attributes</name>
        <full_name>\baseModule::save_attributes()</full_name>
        <docblock line="1064">
          <description>Returns a list of modifications which have to be made to the LDAP account.</description>
          <long-description>Calling this method requires the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;

&lt;br&gt;This function returns an array with 3 entries:
&lt;br&gt;array( DN1 ('add' =&gt; array($attr), 'remove' =&gt; array($attr), 'modify' =&gt; array($attr)), DN2 .... )
&lt;br&gt;DN is the DN to change. It is possible to change several DNs (e.g. create a new user and add him
to some groups via attribute memberUid)&lt;br&gt;
&lt;br&gt;&lt;b&gt;"add"&lt;/b&gt; are attributes which have to be added to the LDAP entry
&lt;br&gt;&lt;b&gt;"remove"&lt;/b&gt; are attributes which have to be removed from the LDAP entry
&lt;br&gt;&lt;b&gt;"modify"&lt;/b&gt; are attributes which have to be modified in the LDAP entry
&lt;br&gt;&lt;b&gt;"notchanged"&lt;/b&gt; are attributes which stay unchanged
&lt;br&gt;&lt;b&gt;"info"&lt;/b&gt; values with informational value (e.g. to be used later by pre/postModify actions)
&lt;br&gt;
&lt;br&gt;This builds the required comands from $this-attributes and $this-&gt;orig.</long-description>
          <tag name="return" description="list of modifications" line="1064" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1079" package="modules">
        <name>preModifyActions</name>
        <full_name>\baseModule::preModifyActions()</full_name>
        <docblock line="1079">
          <description>Allows the module to run commands before the LDAP entry is changed or created.</description>
          <long-description>Calling this method requires the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
The modification is aborted if an error message is returned.</long-description>
          <tag name="param" description="&lt;p&gt;new account&lt;/p&gt;" line="1079" type="boolean" variable="$newAccount">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;LDAP attributes of this entry (added/modified attributes are provided as reference, handle modifications of $attributes with care)&lt;/p&gt;&#10;" line="1079" type="array" variable="$attributes">
            <type>array</type>
          </tag>
          <tag name="return" description="array which contains status messages. Each entry is an array containing the status message parameters." line="1079" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$newAccount</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1092" package="modules">
        <name>postModifyActions</name>
        <full_name>\baseModule::postModifyActions()</full_name>
        <docblock line="1092">
          <description>Allows the module to run commands after the LDAP entry is changed or created.</description>
          <long-description>Calling this method requires the existence of an enclosing {@link accountContainer}.</long-description>
          <tag name="param" description="&lt;p&gt;new account&lt;/p&gt;" line="1092" type="boolean" variable="$newAccount">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;LDAP attributes of this entry&lt;/p&gt;" line="1092" type="array" variable="$attributes">
            <type>array</type>
          </tag>
          <tag name="return" description="array which contains status messages. Each entry is an array containing the status message parameters." line="1092" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$newAccount</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1103" package="modules">
        <name>preDeleteActions</name>
        <full_name>\baseModule::preDeleteActions()</full_name>
        <docblock line="1103">
          <description>Allows the module to run commands before the LDAP entry is deleted.</description>
          <long-description>Calling this method requires the existence of an enclosing {@link accountContainer}.&lt;br&gt;</long-description>
          <tag name="return" description="Array which contains status messages. Each entry is an array containing the status message parameters." line="1103" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1114" package="modules">
        <name>postDeleteActions</name>
        <full_name>\baseModule::postDeleteActions()</full_name>
        <docblock line="1114">
          <description>Allows the module to run commands after the LDAP entry is deleted.</description>
          <long-description>Calling this method requires the existence of an enclosing {@link accountContainer}.</long-description>
          <tag name="return" description="Array which contains status messages. Each entry is an array containing the status message parameters." line="1114" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1127" package="modules">
        <name>delete_attributes</name>
        <full_name>\baseModule::delete_attributes()</full_name>
        <docblock line="1127">
          <description>This function returns an array with the same syntax as save_attributes().</description>
          <long-description>Calling this method requires the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
It allows additional LDAP changes when an account is deleted.</long-description>
          <tag name="return" description="of LDAP operations, same as for save_attributes()" line="1127" type="\List">
            <type>\List</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1142" package="modules">
        <name>display_html_delete</name>
        <full_name>\baseModule::display_html_delete()</full_name>
        <docblock line="1142">
          <description>This function creates meta HTML code which will be displayed when an account should be deleted.</description>
          <long-description>Calling this method requires the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
This can be used to interact with the user, e.g. should the home directory be deleted? The output
of all modules is displayed on a single page.</long-description>
          <tag name="return" description="meta HTML object" line="1142" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
          <tag name="see" description="" line="1142"/>
        </docblock>
      </method>
      <method final="false" abstract="true" static="false" visibility="public" namespace="" line="1157" package="modules">
        <name>process_attributes</name>
        <full_name>\baseModule::process_attributes()</full_name>
        <docblock line="1157">
          <description>This function processes user input.</description>
          <long-description>Calling this method requires the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
It checks the user input and saves changes in the module's data structures.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Example:&lt;/b&gt; return array(array('ERROR', 'Invalid input!', 'This is not allowed here.'));</long-description>
          <tag name="return" description="Array which contains status messages. Each entry is an array containing the status message parameters." line="1157" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="true" static="false" visibility="public" namespace="" line="1168" package="modules">
        <name>display_html_attributes</name>
        <full_name>\baseModule::display_html_attributes()</full_name>
        <docblock line="1168">
          <description>This function creates meta HTML code to display the module page.</description>
          <long-description>Calling this method requires the existence of an enclosing {@link accountContainer}.</long-description>
          <tag name="return" description="meta HTML object" line="1168" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
          <tag name="see" description="" line="1168"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1182" package="modules">
        <name>addSimpleInputTextField</name>
        <full_name>\baseModule::addSimpleInputTextField()</full_name>
        <docblock line="1182">
          <description>Adds a simple text input field to the given htmlTable.</description>
          <long-description>The field name will be the same as the attribute name. There must also be a help entry with the attribute name as ID.
A new line will also be added after this entry so multiple calls will show the fields one below the other.</long-description>
          <tag name="param" description="&lt;p&gt;parent container&lt;/p&gt;" line="1182" type="\htmlTable" variable="$container">
            <type>\htmlTable</type>
          </tag>
          <tag name="param" description="&lt;p&gt;attribute name&lt;/p&gt;" line="1182" type="String" variable="$attrName">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;label name&lt;/p&gt;" line="1182" type="String" variable="$label">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;this is a required field (default false)&lt;/p&gt;&#10;" line="1182" type="boolean" variable="$required">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;field length&lt;/p&gt;" line="1182" type="integer" variable="$length">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;show as text area (default false)&lt;/p&gt;&#10;" line="1182" type="boolean" variable="$isTextArea">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$container</name>
          <default></default>
          <type>\htmlTable</type>
        </argument>
        <argument line="0">
          <name>$attrName</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$label</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$required</name>
          <default>false</default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$length</name>
          <default>null</default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$isTextArea</name>
          <default>false</default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1218" package="modules">
        <name>addMultiValueInputTextField</name>
        <full_name>\baseModule::addMultiValueInputTextField()</full_name>
        <docblock line="1218">
          <description>Adds a text input field that may contain multiple values to the given htmlTable.</description>
          <long-description>The field name will be the same as the attribute name plus a counting number (e.g. street_0).
The last field will be followed by a button to add a new value. This is named add_{attribute name} (e.g. add_street).
There must be a help entry with the attribute name as ID.
A new line will also be added after this entry so multiple calls will show the fields one below the other.</long-description>
          <tag name="param" description="&lt;p&gt;parent container&lt;/p&gt;" line="1218" type="\htmlTable" variable="$container">
            <type>\htmlTable</type>
          </tag>
          <tag name="param" description="&lt;p&gt;attribute name&lt;/p&gt;" line="1218" type="String" variable="$attrName">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;label name&lt;/p&gt;" line="1218" type="String" variable="$label">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;this is a required field (default false)&lt;/p&gt;&#10;" line="1218" type="boolean" variable="$required">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;field length&lt;/p&gt;" line="1218" type="integer" variable="$length">
            <type>integer</type>
          </tag>
          <tag name="param" description="&lt;p&gt;show as text area (default false)&lt;/p&gt;&#10;" line="1218" type="boolean" variable="$isTextArea">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$container</name>
          <default></default>
          <type>\htmlTable</type>
        </argument>
        <argument line="0">
          <name>$attrName</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$label</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$required</name>
          <default>false</default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$length</name>
          <default>null</default>
          <type>integer</type>
        </argument>
        <argument line="0">
          <name>$isTextArea</name>
          <default>false</default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1263" package="modules">
        <name>processMultiValueInputTextField</name>
        <full_name>\baseModule::processMultiValueInputTextField()</full_name>
        <docblock line="1263">
          <description>Validates a multi-value text field.</description>
          <long-description>The input fields must be created with function addMultiValueInputTextField().
If validation is used then there must exist a message named [{attribute name}][0] (e.g. $this-&gt;messages['street'][0]).</long-description>
          <tag name="param" description="&lt;p&gt;attribute name&lt;/p&gt;" line="1263" type="String" variable="$attrName">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;errors array where to put validation errors&lt;/p&gt;" line="1263" type="array" variable="$errors">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;validation ID for function get_preg() (default: null, null means no validation)&lt;/p&gt;&#10;" line="1263" type="String" variable="$validationID">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attrName</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$errors</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$validationID</name>
          <default>null</default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1294" package="modules">
        <name>addSimpleSelfServiceTextField</name>
        <full_name>\baseModule::addSimpleSelfServiceTextField()</full_name>
        <docblock line="1294">
          <description>Adds a simple text input field for the self service.</description>
          <long-description>The field name will be the same as the class name plus "_" plus attribute name (e.g. posixAccount_cn).</long-description>
          <tag name="param" description="&lt;p&gt;array that is used as return value for getSelfServiceOptions()&lt;/p&gt;&#10;" line="1294" type="array" variable="$container">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;attribute name (== field name)&lt;/p&gt;&#10;" line="1294" type="String" variable="$name">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;label to display in front of input field&lt;/p&gt;" line="1294" type="String" variable="$label">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of active fields&lt;/p&gt;" line="1294" type="array" variable="$fields">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;attributes of LDAP account&lt;/p&gt;" line="1294" type="array" variable="$attributes">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of read-only fields&lt;/p&gt;&#10;" line="1294" type="array" variable="$readOnlyFields">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;field is required&lt;/p&gt;" line="1294" type="boolean" variable="$required">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;display as text area&lt;/p&gt;" line="1294" type="boolean" variable="$isTextArea">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$container</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$label</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$fields</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$readOnlyFields</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$required</name>
          <default>false</default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$isTextArea</name>
          <default>false</default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1333" package="modules">
        <name>checkSimpleSelfServiceTextField</name>
        <full_name>\baseModule::checkSimpleSelfServiceTextField()</full_name>
        <docblock line="1333">
          <description>Checks the input value of a self service text field.</description>
          <long-description>The field name must be the same as the class name plus "_" plus attribute name (e.g. posixAccount_cn).
If validation is used then there must exist a message named [{attribute name}][0] (e.g. $this-&gt;messages['street'][0]).</long-description>
          <tag name="param" description="&lt;p&gt;return value of checkSelfServiceOptions()&lt;/p&gt;&#10;" line="1333" type="array" variable="$container">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;attribute name&lt;/p&gt;" line="1333" type="String" variable="$name">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="1333" type="array" variable="$attributes">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;input fields&lt;/p&gt;" line="1333" type="string" variable="$fields">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of read-only fields&lt;/p&gt;&#10;" line="1333" type="array" variable="$readOnlyFields">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;validation ID for get_preg()&lt;/p&gt;&#10;" line="1333" type="String" variable="$validationID">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$container</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$fields</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$readOnlyFields</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$validationID</name>
          <default>null</default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1368" package="modules">
        <name>getManagedObjectClasses</name>
        <full_name>\baseModule::getManagedObjectClasses()</full_name>
        <docblock line="1368">
          <description>Returns a list of managed object classes for this module.</description>
          <long-description>Calling this method does not require the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
This is used to fix spelling errors in LDAP-Entries (e.g. if "posixACCOUNT" is read instead of "posixAccount" from LDAP).&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Example:&lt;/b&gt; return array('posixAccount')</long-description>
          <tag name="return" description="list of object classes" line="1368" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="1368"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1384" package="modules">
        <name>getLDAPAliases</name>
        <full_name>\baseModule::getLDAPAliases()</full_name>
        <docblock line="1384">
          <description>Returns a list of aliases for LDAP attributes.</description>
          <long-description>Calling this method does not require the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
All alias attributes will be renamed to the given attribute names.</long-description>
          <tag name="return" description="list of aliases like array(&amp;quot;alias name&amp;quot; =&amp;gt; &amp;quot;attribute name&amp;quot;)" line="1384" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="1384"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1397" package="modules">
        <name>getManagedAttributes</name>
        <full_name>\baseModule::getManagedAttributes()</full_name>
        <docblock line="1397">
          <description>Returns a list of LDAP attributes which are managed by this module.</description>
          <long-description>All attribute names will be renamed to match the given spelling.</long-description>
          <tag name="return" description="list of attributes" line="1397" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="1397"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1411" package="modules">
        <name>getRequiredExtensions</name>
        <full_name>\baseModule::getRequiredExtensions()</full_name>
        <docblock line="1411">
          <description>This function returns a list of PHP extensions (e.g. hash) which are needed by this module.</description>
          <long-description>Calling this method does not require the existence of an enclosing {@link accountContainer}.</long-description>
          <tag name="return" description="extensions" line="1411" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="1411"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1425" package="modules">
        <name>getSelfServiceSearchAttributes</name>
        <full_name>\baseModule::getSelfServiceSearchAttributes()</full_name>
        <docblock line="1425">
          <description>This function returns a list of possible LDAP attributes (e.g. uid, cn, .</description>
          <long-description>..) which can be used to search for LDAP objects.

Calling this method does not require the existence of an enclosing {@link accountContainer}.</long-description>
          <tag name="return" description="attributes" line="1425" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="1425"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1441" package="modules">
        <name>getSelfServiceFields</name>
        <full_name>\baseModule::getSelfServiceFields()</full_name>
        <docblock line="1441">
          <description>Returns a list of possible input fields and their descriptions.</description>
          <long-description>Calling this method does not require the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
&lt;b&gt;Format:&lt;/b&gt; array(&lt;field identifier&gt; =&gt; &lt;field description&gt;)</long-description>
          <tag name="return" description="fields" line="1441" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="1441"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1452" package="modules">
        <name>canSelfServiceFieldBeReadOnly</name>
        <full_name>\baseModule::canSelfServiceFieldBeReadOnly()</full_name>
        <docblock line="1452">
          <description>Returns if a given self service field can be set in read-only mode.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;field identifier&lt;/p&gt;" line="1452" type="String" variable="$fieldID">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;currently edited profile&lt;/p&gt;" line="1452" type="\selfServiceProfile" variable="$profile">
            <type>\selfServiceProfile</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$fieldID</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$profile</name>
          <default></default>
          <type>\selfServiceProfile</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1474" package="modules">
        <name>getSelfServiceOptions</name>
        <full_name>\baseModule::getSelfServiceOptions()</full_name>
        <docblock line="1474">
          <description>Returns the meta HTML code for each input field.</description>
          <long-description>Calling this method does not require the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
It is not possible to display help links.</long-description>
          <tag name="param" description="&lt;p&gt;list of active fields&lt;/p&gt;" line="1474" type="array" variable="$fields">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;attributes of LDAP account&lt;/p&gt;" line="1474" type="array" variable="$attributes">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;indicates that the user is only allowed to change his password and no LDAP content is readable&lt;/p&gt;" line="1474" type="boolean" variable="$passwordChangeOnly">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of read-only fields&lt;/p&gt;&#10;" line="1474" type="array" variable="$readOnlyFields">
            <type>array</type>
          </tag>
          <tag name="return" description="list of meta HTML elements (field name =&amp;gt; htmlTableRow)" line="1474" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="1474"/>
        </docblock>
        <argument line="0">
          <name>$fields</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$passwordChangeOnly</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$readOnlyFields</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1496" package="modules">
        <name>checkSelfServiceOptions</name>
        <full_name>\baseModule::checkSelfServiceOptions()</full_name>
        <docblock line="1496">
          <description>Checks if all input values are correct and returns the LDAP attributes which should be changed.</description>
          <long-description>&lt;br&gt;Return values:
&lt;br&gt;messages: array of parameters to create status messages
&lt;br&gt;add: array of attributes to add
&lt;br&gt;del: array of attributes to remove
&lt;br&gt;mod: array of attributes to modify
&lt;br&gt;info: array of values with informational value (e.g. to be used later by pre/postModify actions)

Calling this method does not require the existence of an enclosing {@link accountContainer}.</long-description>
          <tag name="param" description="&lt;p&gt;input fields&lt;/p&gt;" line="1496" type="string" variable="$fields">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;LDAP attributes&lt;/p&gt;" line="1496" type="array" variable="$attributes">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;indicates that the user is only allowed to change his password and no LDAP content is readable&lt;/p&gt;" line="1496" type="boolean" variable="$passwordChangeOnly">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;list of read-only fields&lt;/p&gt;&#10;" line="1496" type="array" variable="$readOnlyFields">
            <type>array</type>
          </tag>
          <tag name="return" description="messages and attributes (array(&amp;#039;messages&amp;#039; =&amp;gt; array(), &amp;#039;add&amp;#039; =&amp;gt; array(&amp;#039;mail&amp;#039; =&amp;gt; array(&amp;#039;test@test.com&amp;#039;)), &amp;#039;del&amp;#039; =&amp;gt; array(), &amp;#039;mod&amp;#039; =&amp;gt; array(), &amp;#039;info&amp;#039; =&amp;gt; array()))" line="1496" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$fields</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$passwordChangeOnly</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$readOnlyFields</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1516" package="modules">
        <name>getSelfServiceSettings</name>
        <full_name>\baseModule::getSelfServiceSettings()</full_name>
        <docblock line="1516">
          <description>Returns a list of self service configuration settings.</description>
          <long-description>Calling this method does not require the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
The name attributes are used as keywords to load
and save settings. We recommend to use the module name as prefix for them
(e.g. posixAccount_homeDirectory) to avoid naming conflicts.</long-description>
          <tag name="param" description="&lt;p&gt;currently edited profile&lt;/p&gt;" line="1516" type="\selfServiceProfile" variable="$profile">
            <type>\selfServiceProfile</type>
          </tag>
          <tag name="return" description="meta HTML object" line="1516" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
          <tag name="see" description="" line="1516"/>
          <tag name="see" description="" line="1516"/>
        </docblock>
        <argument line="0">
          <name>$profile</name>
          <default></default>
          <type>\selfServiceProfile</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1538" package="modules">
        <name>checkSelfServiceSettings</name>
        <full_name>\baseModule::checkSelfServiceSettings()</full_name>
        <docblock line="1538">
          <description>Checks if the self service settings are valid.</description>
          <long-description>Calling this method does not require the existence of an enclosing {@link accountContainer}.&lt;br&gt;
&lt;br&gt;
If the input data is invalid the return value is an array that contains arrays
to build StatusMessages (message type, message head, message text). If no errors
occured the function returns an empty array.</long-description>
          <tag name="param" description="&lt;p&gt;hash array (option name =&gt; value) that contains the input. The option values are all arrays containing one or more elements.&lt;/p&gt;&#10;" line="1538" type="array" variable="$options">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;self service profile&lt;/p&gt;" line="1538" type="\selfServiceProfile" variable="$profile">
            <type>\selfServiceProfile</type>
          </tag>
          <tag name="return" description="error messages" line="1538" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$options</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$profile</name>
          <default></default>
          <type>\selfServiceProfile</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1552" package="modules">
        <name>preModifySelfService</name>
        <full_name>\baseModule::preModifySelfService()</full_name>
        <docblock line="1552">
          <description>Allows the module to run commands before the LDAP entry is changed or created.</description>
          <long-description>An error message should be printed if the function returns false.</long-description>
          <tag name="param" description="&lt;p&gt;is new account or existing one&lt;/p&gt;" line="1552" type="boolean" variable="$newAccount">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;LDAP attributes of this entry&lt;/p&gt;" line="1552" type="array" variable="$attributes">
            <type>array</type>
          </tag>
          <tag name="return" description="true, if no problems occured" line="1552" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$newAccount</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1563" package="modules">
        <name>postModifySelfService</name>
        <full_name>\baseModule::postModifySelfService()</full_name>
        <docblock line="1563">
          <description>Allows the module to run commands after the LDAP entry is changed or created.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;is new account or existing one&lt;/p&gt;" line="1563" type="boolean" variable="$newAccount">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;LDAP attributes of this entry&lt;/p&gt;" line="1563" type="array" variable="$attributes">
            <type>array</type>
          </tag>
          <tag name="return" description="true, if no problems occured" line="1563" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$newAccount</name>
          <default></default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$attributes</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1576" package="modules">
        <name>getLinkToSpecialSelfServicePage</name>
        <full_name>\baseModule::getLinkToSpecialSelfServicePage()</full_name>
        <docblock line="1576">
          <description>This allows modules to create a link to a module specific page
for the self service.</description>
          <long-description>The link is shown on the login page of the self service. You
can use this to provide e.g. a page to reset passwords.</long-description>
          <tag name="param" description="&lt;p&gt;self service settings&lt;/p&gt;" line="1576" type="array" variable="$settings">
            <type>array</type>
          </tag>
          <tag name="return" description="link text (null if no special page used)" line="1576" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$settings</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1589" package="modules">
        <name>displaySpecialSelfServicePage</name>
        <full_name>\baseModule::displaySpecialSelfServicePage()</full_name>
        <docblock line="1589">
          <description>This function creates meta HTML code to display the module specific page
for the self service.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;self service settings&lt;/p&gt;" line="1589" type="\selfServiceProfile" variable="$profile">
            <type>\selfServiceProfile</type>
          </tag>
          <tag name="return" description="meta HTML object" line="1589" type="\htmlElement">
            <type>\htmlElement</type>
          </tag>
          <tag name="see" description="" line="1589"/>
        </docblock>
        <argument line="0">
          <name>$profile</name>
          <default></default>
          <type>\selfServiceProfile</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1600" package="modules">
        <name>getAccountContainer</name>
        <full_name>\baseModule::getAccountContainer()</full_name>
        <docblock line="1600">
          <description>Returns the {@link accountContainer} object.</description>
          <long-description></long-description>
          <tag name="return" description="accountContainer object" line="1600" type="\accountContainer">
            <type>\accountContainer</type>
          </tag>
          <tag name="see" description="" line="1600"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1614" package="modules">
        <name>getAttributes</name>
        <full_name>\baseModule::getAttributes()</full_name>
        <docblock line="1614">
          <description>Returns the LDAP attributes which are managed in this module.</description>
          <long-description></long-description>
          <tag name="return" description="attributes" line="1614" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1623" package="modules">
        <name>getOriginalAttributes</name>
        <full_name>\baseModule::getOriginalAttributes()</full_name>
        <docblock line="1623">
          <description>Returns the LDAP attributes which are managed in this module (with unchanged values).</description>
          <long-description></long-description>
          <tag name="return" description="attributes" line="1623" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1636" package="modules">
        <name>getIcon</name>
        <full_name>\baseModule::getIcon()</full_name>
        <docblock line="1636">
          <description>Returns the path to the module icon.</description>
          <long-description>The path must be releative to graphics (e.g. key.png). You can also set $this-&gt;meta['icon'].
The preferred size is 32x32px.</long-description>
          <tag name="return" description="" line="1636" type="\unknown">
            <type>\unknown</type>
          </tag>
          <tag name="see" description="" line="1636"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1647" package="modules">
        <name>handleAjaxRequest</name>
        <full_name>\baseModule::handleAjaxRequest()</full_name>
        <docblock line="1647">
          <description>Manages AJAX requests.</description>
          <long-description>This function may be called with or without an account container.</long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1659" package="modules">
        <name>supportsAdminInterface</name>
        <full_name>\baseModule::supportsAdminInterface()</full_name>
        <docblock line="1659">
          <description>Specifies if this module supports the LAM admin interface.</description>
          <long-description>The LAM admin interface are the pages that allow to manage e.g. users and groups.
In contrast there is also the LAM self service interface. Most modules support
the admin interface.</long-description>
          <tag name="return" description="support admin interface" line="1659" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1674" package="modules">
        <name>isBooleanConfigOptionSet</name>
        <full_name>\baseModule::isBooleanConfigOptionSet()</full_name>
        <docblock line="1674">
          <description>Returns if the given configuration option is set.</description>
          <long-description>This function returns false if the configuration options cannot be read.</long-description>
          <tag name="param" description="&lt;p&gt;name of the option&lt;/p&gt;" line="1674" type="String" variable="$optionName">
            <type>String</type>
          </tag>
          <tag name="return" description="true if option is set" line="1674" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$optionName</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
    </class>
    <markers>
      <todo line="844">workarounds for PDF parser, remove when migrated to other PDF library</todo>
      <todo line="848">workaround for UFPDF, remove when migrated to other PDF library</todo>
    </markers>
    <source> </source>
  </file>
  <file path="lib/status.inc" generated-path="lib.status.inc.html" hash="1f334ac451e6f05079f32908146704cf" package="lib">
    <docblock line="0">
      <description>LDAP Account Manager status messages.</description>
      <long-description></long-description>
      <tag name="author" description="Michael Duergner" line="0"/>
      <tag name="package" description="lib" line="0"/>
    </docblock>
    <function namespace="" line="53" package="lib">
      <name>StatusMessage</name>
      <full_name>\StatusMessage()</full_name>
      <docblock line="53">
        <description>This function prints a short status message. It can be used to print INFO,
WARN and ERROR messages at the moment.</description>
        <long-description>The headline and text may be formated with special tags:
&lt;br&gt;
&lt;br&gt;&lt;b&gt;{bold}, {endbold}:&lt;/b&gt; All text between these tags is printed bold.
&lt;br&gt;&lt;b&gt;{color=#123456}, {endcolor}:&lt;/b&gt; All text between these tags is printed in the given color.
&lt;br&gt;&lt;b&gt;{link=http://nodomain.org}, {endlink}:&lt;/b&gt; A link with the given target is created. The link text is the text between the tags.</long-description>
        <tag name="param" description="&lt;p&gt;The type of the message to be printed. It must be one of&#10;the following types: 'INFO', 'WARN' or 'ERROR'.&#10;&lt;br&gt; Every other type will lead to an error message indicating an invalid message type.&lt;/p&gt;" line="53" type="string" variable="$MessageTyp">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;The headline of the status message.&#10;&lt;br&gt; It may be formatted with special color/link/bold tags.&lt;/p&gt;&#10;" line="53" type="string" variable="$MessageHeadline">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;The text of the status message.&#10;&lt;br&gt; It may be formatted with special color/link/bold tags. This parameter is optional.&lt;/p&gt;&#10;" line="53" type="string" variable="$MessageText">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;The variables that are used to replace the spacers (%s) in the&#10;submitted text. This parameter is optional.&lt;/p&gt;&#10;" line="53" type="array" variable="$MessageVariables">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;if set to true this function will return the generated HTML code instead of printing it directly (default: false)&lt;/p&gt;&#10;" line="53" type="boolean" variable="$returnOutput">
          <type>boolean</type>
        </tag>
        <tag name="return" description="HTML code if $returnOutput is set to true, otherwise null" line="53" type="String">
          <type>String</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$MessageTyp</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$MessageHeadline</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$MessageText</name>
        <default>''</default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$MessageVariables</name>
        <default>array()</default>
        <type>array</type>
      </argument>
      <argument line="0">
        <name>$returnOutput</name>
        <default>false</default>
        <type>boolean</type>
      </argument>
    </function>
    <function namespace="" line="118" package="lib">
      <name>parseMessageString</name>
      <full_name>\parseMessageString()</full_name>
      <docblock line="118">
        <description>Use the three replace functions on the submitted Text.</description>
        <long-description></long-description>
        <tag name="access" description="private" line="118"/>
        <tag name="param" description="&lt;p&gt;The text that is used to search for replaceable strings.&lt;/p&gt;" line="118" type="string" variable="$MessageString">
          <type>string</type>
        </tag>
        <tag name="return" description="The processed text." line="118" type="string">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$MessageString</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="132" package="lib">
      <name>boldText</name>
      <full_name>\boldText()</full_name>
      <docblock line="132">
        <description>Replace {bold} and {endbold} with &lt;b&gt; and &lt;/b&gt; HTML-Tags.</description>
        <long-description></long-description>
        <tag name="access" description="private" line="132"/>
        <tag name="param" description="&lt;p&gt;The text that is used to search for {bold} and {endbold} tags.&lt;/p&gt;&#10;" line="132" type="string" variable="$text">
          <type>string</type>
        </tag>
        <tag name="return" description="The submitted text with {bold} and {endbold} replaced with&#10;the appropriate HTML tages &amp;lt;b&amp;gt; and &amp;lt;/b&amp;gt;" line="132" type="string">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$text</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="147" package="lib">
      <name>colorText</name>
      <full_name>\colorText()</full_name>
      <docblock line="147">
        <description>Replace {color=#[HEX-Value]} or {color=[HEX-Value]} and {endcolor} with &lt;font color="#[HEX-Value]"&gt; and &lt;/font&gt; HTML-Tags.</description>
        <long-description></long-description>
        <tag name="access" description="private" line="147"/>
        <tag name="param" description="&lt;p&gt;The text that is used to search for {color} and {endcolor} tags.&lt;/p&gt;&#10;" line="147" type="string" variable="$text">
          <type>string</type>
        </tag>
        <tag name="return" description="Input string with HTML-formatted color tags" line="147" type="string">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$text</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="162" package="lib">
      <name>linkText</name>
      <full_name>\linkText()</full_name>
      <docblock line="162">
        <description>Replace {link=[Link-Target]} and {endlink} with &lt;a href="[Link-Target]" target="_blank"&gt; and &lt;/a&gt; HTML-Tags.</description>
        <long-description></long-description>
        <tag name="access" description="private" line="162"/>
        <tag name="param" description="&lt;p&gt;The text that is used to search for {link} and {endlink} tags.&lt;/p&gt;&#10;" line="162" type="string" variable="$text">
          <type>string</type>
        </tag>
        <tag name="return" description="Input string with HTML-formatted link tags" line="162" type="string">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$text</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <source> </source>
  </file>
  <file path="lib/lamdaemon.inc" generated-path="lib.lamdaemon.inc.html" hash="acbbdd2ecfe4312a3a0db7eace27543f" package="modules">
    <docblock line="0">
      <description>This file includes functions to control lamdaemon.</description>
      <long-description></long-description>
      <tag name="author" description="Tilo Lutz" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="author" description="Thomas Manninger" line="0"/>
      <tag name="package" description="modules" line="0"/>
    </docblock>
    <function namespace="" line="42" package="modules">
      <name>lamdaemon</name>
      <full_name>\lamdaemon()</full_name>
      <docblock line="42">
        <description>Sends commands to lamdaemon script.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;command to execute&lt;/p&gt;" line="42" type="array" variable="$command">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;remote server&lt;/p&gt;" line="42" type="string" variable="$server">
          <type>string</type>
        </tag>
        <tag name="return" description="Output of lamdaemon" line="42" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$command</name>
        <default></default>
        <type>array</type>
      </argument>
      <argument line="0">
        <name>$server</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <source> </source>
  </file>
  <file path="lib/schema.inc" generated-path="lib.schema.inc.html" hash="295d59fcfa633bec6a970f3682162638" package="lib">
    <docblock line="0">
      <description>Classes and functions for fetching and parsing schema from an LDAP server.</description>
      <long-description></long-description>
      <tag name="package" description="lib" line="0"/>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <constant namespace="" line="34" package="lib">
      <name>SCHEMA_SESSION_CACHE_ENABLED</name>
      <full_name>\\SCHEMA_SESSION_CACHE_ENABLED</full_name>
      <value>1</value>
      <docblock line="34">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <function namespace="" line="1284" package="lib">
      <name>_get_schema_dn</name>
      <full_name>\_get_schema_dn()</full_name>
      <docblock line="1284">
        <description>Helper for _get_raw_schema() which fetches the DN of the schema object
in an LDAP server based on a DN. Entries should set the subSchemaSubEntry
attribute pointing to the DN of the server schema. You can specify  the
DN whose subSchemaSubEntry you wish to retrieve of specify an empty string
to fetch the subScehamSubEntry from the Root DSE.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;The DN (may be null) which houses the subschemaSubEntry attribute which&#10;                 this function can use to determine the schema entry's DN.&lt;/p&gt;&#10;" line="1284" type="string" variable="$dn">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;Switch to true to see some nice and copious output. :)&lt;/p&gt;&#10;" line="1284" type="bool" variable="$debug">
          <type>bool</type>
        </tag>
        <tag name="return" description="The DN of the entry which houses this LDAP server&amp;#039;s schema." line="1284" type="string">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$dn</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$debug</name>
        <default>false</default>
        <type>bool</type>
      </argument>
    </function>
    <function namespace="" line="1351" package="lib">
      <name>_get_raw_schema</name>
      <full_name>\_get_raw_schema()</full_name>
      <docblock line="1351">
        <description>Fetches the raw schema array for the subschemaSubentry of the server. Note,
this function has grown many hairs to accomodate more LDAP servers. It is
needfully complicated as it now supports many popular LDAP servers that
don't necessarily expose their schema "the right way".</description>
        <long-description></long-description>
        <tag name="param" description="&lt;ul&gt;&#10;&lt;li&gt;A string indicating which type of schema to&#10;fetch. Five valid values: 'objectclasses', 'attributetypes',&#10;'ldapsyntaxes', 'matchingruleuse', or 'matchingrules'.&#10;Case insensitive.&lt;/li&gt;&#10;&lt;/ul&gt;&#10;" line="1351" type="" variable="$schema_to_fetch"/>
        <tag name="param" description="&lt;p&gt;(optional) This paremeter is the DN of the entry whose schema you&#10;        would like to fetch. Entries have the option of specifying&#10;        their own subschemaSubentry that points to the DN of the system&#10;        schema entry which applies to this attribute. If unspecified,&#10;    this will try to retrieve the schema from the RootDSE subschemaSubentry.&#10;    Failing that, we use some commonly known schema DNs. Default&#10;    value is the Root DSE DN (zero-length string)&lt;/p&gt;&#10;" line="1351" type="" variable="$dn"/>
        <tag name="return" description="array of strings of this form:&#10;   Array (&#10;     [0] =&amp;gt; &amp;quot;( 1.3.6.1.4.1.7165.1.2.2.4 NAME &amp;#039;gidPool&amp;#039; DESC &amp;#039;Pool ...&#10;     [1] =&amp;gt; &amp;quot;( 1.3.6.1.4.1.7165.2.2.3 NAME &amp;#039;sambaAccount&amp;#039; DESC &amp;#039;Sa ...&#10;     etc." line="1351" type="\an">
          <type>\an</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$schema_to_fetch</name>
        <default></default>
        <type>mixed</type>
      </argument>
      <argument line="0">
        <name>$dn</name>
        <default>''</default>
        <type>mixed</type>
      </argument>
    </function>
    <function namespace="" line="1542" package="lib">
      <name>get_schema_objectclasses</name>
      <full_name>\get_schema_objectclasses()</full_name>
      <docblock line="1542">
        <description>Gets an associative array of ObjectClass objects for the specified
server. Each array entry's key is the name of the objectClass
in lower-case and the value is an ObjectClass object.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;(optional) It is easier to fetch schema if a DN is provided&#10;            which defines the subschemaSubEntry attribute (all entries should).&lt;/p&gt;&#10;" line="1542" type="string" variable="$dn">
          <type>string</type>
        </tag>
        <tag name="return" description="An array of ObjectClass objects." line="1542" type="array">
          <type>array</type>
        </tag>
        <tag name="see" description="" line="1542"/>
        <tag name="see" description="" line="1542"/>
      </docblock>
      <argument line="0">
        <name>$dn</name>
        <default>null</default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$use_cache</name>
        <default>true</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="1582" package="lib">
      <name>get_schema_objectclass</name>
      <full_name>\get_schema_objectclass()</full_name>
      <docblock line="1582">
        <description>Gets a single ObjectClass object specified by name.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;The name of the objectClass to fetch.&lt;/p&gt;" line="1582" type="string" variable="$oclass_name">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;(optional) It is easier to fetch schema if a DN is provided&#10;            which defines the subschemaSubEntry attribute (all entries should).&lt;/p&gt;&#10;" line="1582" type="string" variable="$dn">
          <type>string</type>
        </tag>
        <tag name="return" description="The specified ObjectClass object or false on error." line="1582" type="\ObjectClass">
          <type>\ObjectClass</type>
        </tag>
        <tag name="see" description="" line="1582"/>
        <tag name="see" description="" line="1582"/>
      </docblock>
      <argument line="0">
        <name>$oclass_name</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$dn</name>
        <default>null</default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$use_cache</name>
        <default>true</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="1606" package="lib">
      <name>get_schema_attribute</name>
      <full_name>\get_schema_attribute()</full_name>
      <docblock line="1606">
        <description>Gets a single AttributeType object specified by name.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;The name of the AttributeType to fetch.&lt;/p&gt;" line="1606" type="string" variable="$oclass_name">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;(optional) It is easier to fetch schema if a DN is provided&#10;            which defines the subschemaSubEntry attribute (all entries should).&lt;/p&gt;&#10;" line="1606" type="string" variable="$dn">
          <type>string</type>
        </tag>
        <tag name="return" description="The specified AttributeType object or false on error." line="1606" type="\AttributeType">
          <type>\AttributeType</type>
        </tag>
        <tag name="see" description="" line="1606"/>
        <tag name="see" description="" line="1606"/>
      </docblock>
      <argument line="0">
        <name>$attr_name</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$dn</name>
        <default>null</default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$use_cache</name>
        <default>true</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="1627" package="lib">
      <name>get_schema_attributes</name>
      <full_name>\get_schema_attributes()</full_name>
      <docblock line="1627">
        <description>Gets an associative array of AttributeType objects for the specified
server. Each array entry's key is the name of the attributeType
in lower-case and the value is an AttributeType object.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;(optional) It is easier to fetch schema if a DN is provided&#10;            which defines the subschemaSubEntry attribute (all entries should).&lt;/p&gt;&#10;" line="1627" type="string" variable="$dn">
          <type>string</type>
        </tag>
        <tag name="return" description="An array of AttributeType objects." line="1627" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$dn</name>
        <default>null</default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$use_cache</name>
        <default>true</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="1719" package="lib">
      <name>add_aliases_to_attrs</name>
      <full_name>\add_aliases_to_attrs()</full_name>
      <docblock line="1719">
        <description>For each attribute that has multiple names, this function adds unique entries to
the attrs array for those names. Ie, attributeType has name 'gn' and 'givenName'.</description>
        <long-description>This function will create a unique entry for 'gn' and 'givenName'.</long-description>
      </docblock>
      <argument line="0">
        <name>$attrs</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="1746" package="lib">
      <name>add_sup_to_attrs</name>
      <full_name>\add_sup_to_attrs()</full_name>
      <docblock line="1746">
        <description>Adds inherited values to each attributeType specified by the SUP directive.</description>
        <long-description>Supports infinite levels of inheritance.
Bug 856832: require a second paramter that has all attributes indexed by OID</long-description>
      </docblock>
      <argument line="0">
        <name>$attrs</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$attrs_oid</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="1860" package="lib">
      <name>get_schema_matching_rules</name>
      <full_name>\get_schema_matching_rules()</full_name>
      <docblock line="1860">
        <description>Returns an array of MatchingRule objects for the specified server.</description>
        <long-description>The key of each entry is the OID of the matching rule.</long-description>
      </docblock>
      <argument line="0">
        <name>$dn</name>
        <default>null</default>
        <type/>
      </argument>
      <argument line="0">
        <name>$use_cache</name>
        <default>true</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="1914" package="lib">
      <name>get_schema_syntaxes</name>
      <full_name>\get_schema_syntaxes()</full_name>
      <docblock line="1914">
        <description>Returns an array of Syntax objects that this LDAP server uses mapped to
their descriptions. The key of each entry is the OID of the Syntax.</description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$dn</name>
        <default>null</default>
        <type/>
      </argument>
      <argument line="0">
        <name>$use_cache</name>
        <default>true</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="1955" package="lib">
      <name>cached_schema_available</name>
      <full_name>\cached_schema_available()</full_name>
      <docblock line="1955">
        <description>Returns true if the schema for $schema_type has been cached and
is availble. $schema_type may be one of (lowercase) the following:
     objectclasses
     attributetypes
     ldapsyntaxes
     matchingrules
     matchingruleuse
Note that _get_raw_schema() takes a similar parameter.</description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$schema_type</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="1992" package="lib">
      <name>get_cached_schema</name>
      <full_name>\get_cached_schema()</full_name>
      <docblock line="1992">
        <description>Returns the cached array of schemaitem objects for the specified
$schema_type. For list of valid $schema_type values, see above
schema_cache_available(). Note that internally, this function
utilizes a two-layer cache, one in memory using a static variable
for multiple calls within the same page load, and one in a session
for multiple calls within the same user session (spanning multiple
page loads).</description>
        <long-description>Returns an array of SchemaItem objects on success or false on failure.</long-description>
      </docblock>
      <argument line="0">
        <name>$schema_type</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="2023" package="lib">
      <name>set_cached_schema</name>
      <full_name>\set_cached_schema()</full_name>
      <docblock line="2023">
        <description>Caches the specified $schema_type.</description>
        <long-description>$schema_items should be an array of SchemaItem instances (ie,
an array of ObjectClass, AttributeType, LDAPSyntax, MatchingRuleUse,
or MatchingRule objects.

Returns true on success of false on failure.</long-description>
      </docblock>
      <argument line="0">
        <name>$schema_type</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$schema_items</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="2052" package="lib">
      <name>set_schema_cache_unavailable</name>
      <full_name>\set_schema_cache_unavailable()</full_name>
      <docblock line="2052">
        <description>Sets the schema entry for the server_id to be "unavailable" so that we realize
that we tried to get the schema but could not, so quit trying next time to
fetch it from the server.</description>
        <long-description></long-description>
      </docblock>
    </function>
    <class final="false" abstract="false" namespace="" line="45" package="lib">
      <extends/>
      <name>SchemaItem</name>
      <full_name>\SchemaItem</full_name>
      <docblock line="45">
        <description>Generic parent class for all schema items. A schema item is
an ObjectClass, an AttributeBype, a MatchingRule, or a Syntax.</description>
        <long-description>All schema items have at least two things in common: An OID
and a description. This class provides an implementation for
these two data.</long-description>
        <tag name="package" description="lib" line="45"/>
      </docblock>
      <property static="false" visibility="public" line="48" namespace="" package="lib">
        <name>$oid</name>
        <default></default>
        <docblock line="48">
          <description>The OID of this schema item.</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="50" namespace="" package="lib">
        <name>$description</name>
        <default></default>
        <docblock line="50">
          <description>The description of this schema item.</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="53" package="lib">
        <name>initVars</name>
        <full_name>\SchemaItem::initVars()</full_name>
        <docblock line="53">
          <description>Initialize class members to default values.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="60" package="lib">
        <name>SchemaItem</name>
        <full_name>\SchemaItem::SchemaItem()</full_name>
        <docblock line="60">
          <description>Default constructor.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="65" package="lib">
        <name>setOID</name>
        <full_name>\SchemaItem::setOID()</full_name>
        <docblock line="65">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$new_oid</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="70" package="lib">
        <name>setDescription</name>
        <full_name>\SchemaItem::setDescription()</full_name>
        <docblock line="70">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$new_desc</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="75" package="lib">
        <name>getOID</name>
        <full_name>\SchemaItem::getOID()</full_name>
        <docblock line="75">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="80" package="lib">
        <name>getDescription</name>
        <full_name>\SchemaItem::getDescription()</full_name>
        <docblock line="80">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="91" package="lib">
      <extends>\SchemaItem</extends>
      <name>ObjectClass</name>
      <full_name>\ObjectClass</full_name>
      <docblock line="91">
        <description>Represents an LDAP objectClass</description>
        <long-description>All schema items have at least two things in common: An OID
and a description. This class provides an implementation for
these two data.</long-description>
        <tag name="package" description="lib" line="91"/>
      </docblock>
      <property static="false" visibility="public" line="94" namespace="" package="lib">
        <name>$name</name>
        <default></default>
        <docblock line="94">
          <description>This objectClass' name, ie "inetOrgPerson"</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="96" namespace="" package="lib">
        <name>$sup_classes</name>
        <default></default>
        <docblock line="96">
          <description>array of objectClass names from which this objectClass inherits</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="98" namespace="" package="lib">
        <name>$type</name>
        <default></default>
        <docblock line="98">
          <description>one of STRUCTURAL, ABSTRACT, or AUXILIARY</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="100" namespace="" package="lib">
        <name>$must_attrs</name>
        <default></default>
        <docblock line="100">
          <description>arrays of attribute names that this objectClass requires</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="102" namespace="" package="lib">
        <name>$may_attrs</name>
        <default></default>
        <docblock line="102">
          <description>arrays of attribute names that this objectClass allows, but does not require</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="104" namespace="" package="lib">
        <name>$is_obsolete</name>
        <default></default>
        <docblock line="104">
          <description>boolean value indicating whether this objectClass is obsolete</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="106" namespace="" package="lib">
        <name>$children_objectclasses</name>
        <default></default>
        <docblock line="106">
          <description>array of objectClasses which inherit from this one (must be set at runtime explicitly by the caller)</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="109" package="lib">
        <name>initVars</name>
        <full_name>\ObjectClass::initVars()</full_name>
        <docblock line="109">
          <description>Initialize the class' member variables</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="126" package="lib">
        <name>ObjectClass</name>
        <full_name>\ObjectClass::ObjectClass()</full_name>
        <docblock line="126">
          <description>Creates a new ObjectClass object given a raw LDAP objectClass string.</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$raw_ldap_schema_string</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="286" package="lib">
        <name>getMustAttrs</name>
        <full_name>\ObjectClass::getMustAttrs()</full_name>
        <docblock line="286">
          <description>Gets an array of AttributeType objects that entries of this ObjectClass must define.</description>
          <long-description>This differs from getMustAttrNames in that it returns an array of AttributeType objects</long-description>
          <tag name="param" description="&lt;p&gt;An array of ObjectClass objects to use when traversing&#10;            the inheritance tree. This presents some what of a bootstrapping problem&#10;            as we must fetch all objectClasses to determine through inheritance which&#10;            attributes this objectClass requires.&lt;/p&gt;" line="286" type="array" variable="$oclasses">
            <type>array</type>
          </tag>
          <tag name="return" description="The array of required AttributeType objects." line="286" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="286"/>
          <tag name="see" description="" line="286"/>
          <tag name="see" description="" line="286"/>
        </docblock>
        <argument line="0">
          <name>$oclasses</name>
          <default>NULL</default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="320" package="lib">
        <name>getMayAttrs</name>
        <full_name>\ObjectClass::getMayAttrs()</full_name>
        <docblock line="320">
          <description>Gets an array of AttributeType objects that entries of this ObjectClass may define.</description>
          <long-description>This differs from getMayAttrNames in that it returns an array of AttributeType objects</long-description>
          <tag name="param" description="&lt;p&gt;An array of ObjectClass objects to use when traversing&#10;            the inheritance tree. This presents some what of a bootstrapping problem&#10;            as we must fetch all objectClasses to determine through inheritance which&#10;            attributes this objectClass provides.&lt;/p&gt;" line="320" type="array" variable="$oclasses">
            <type>array</type>
          </tag>
          <tag name="return" description="The array of allowed AttributeType objects." line="320" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="320"/>
          <tag name="see" description="" line="320"/>
          <tag name="see" description="" line="320"/>
          <tag name="see" description="" line="320"/>
        </docblock>
        <argument line="0">
          <name>$oclasses</name>
          <default>NULL</default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="354" package="lib">
        <name>getMustAttrNames</name>
        <full_name>\ObjectClass::getMustAttrNames()</full_name>
        <docblock line="354">
          <description>Gets an array of attribute names (strings) that entries of this ObjectClass must define.</description>
          <long-description>This differs from getMustAttrs in that it returns an array of strings rather than
array of AttributeType objects</long-description>
          <tag name="param" description="&lt;p&gt;An array of ObjectClass objects to use when traversing&#10;            the inheritance tree. This presents some what of a bootstrapping problem&#10;            as we must fetch all objectClasses to determine through inheritance which&#10;            attributes this objectClass provides.&lt;/p&gt;" line="354" type="array" variable="$oclasses">
            <type>array</type>
          </tag>
          <tag name="return" description="The array of allowed attribute names (strings)." line="354" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="354"/>
          <tag name="see" description="" line="354"/>
          <tag name="see" description="" line="354"/>
        </docblock>
        <argument line="0">
          <name>$oclasses</name>
          <default>null</default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="378" package="lib">
        <name>getMayAttrNames</name>
        <full_name>\ObjectClass::getMayAttrNames()</full_name>
        <docblock line="378">
          <description>Gets an array of attribute names (strings) that entries of this ObjectClass must define.</description>
          <long-description>This differs from getMayAttrs in that it returns an array of strings rather than
array of AttributeType objects</long-description>
          <tag name="param" description="&lt;p&gt;An array of ObjectClass objects to use when traversing&#10;            the inheritance tree. This presents some what of a bootstrapping problem&#10;            as we must fetch all objectClasses to determine through inheritance which&#10;            attributes this objectClass provides.&lt;/p&gt;" line="378" type="array" variable="$oclasses">
            <type>array</type>
          </tag>
          <tag name="return" description="The array of allowed attribute names (strings)." line="378" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="378"/>
          <tag name="see" description="" line="378"/>
          <tag name="see" description="" line="378"/>
        </docblock>
        <argument line="0">
          <name>$oclasses</name>
          <default>null</default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="393" package="lib">
        <name>addChildObjectClass</name>
        <full_name>\ObjectClass::addChildObjectClass()</full_name>
        <docblock line="393">
          <description>Adds an objectClass to the list of objectClasses that inherit
from this objectClass.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The name of the objectClass to add&lt;/p&gt;" line="393" type="String" variable="$object_class_name">
            <type>String</type>
          </tag>
          <tag name="return" description="Returns true on success or false on failure (objectclass already existed for example)" line="393" type="bool">
            <type>bool</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$object_class_name</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="409" package="lib">
        <name>getChildObjectClasses</name>
        <full_name>\ObjectClass::getChildObjectClasses()</full_name>
        <docblock line="409">
          <description>Returns the array of objectClass names which inherit from this objectClass.</description>
          <long-description></long-description>
          <tag name="return" description="Names of objectClasses which inherit from this objectClass." line="409" type="Array">
            <type>Array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="418" package="lib">
        <name>getName</name>
        <full_name>\ObjectClass::getName()</full_name>
        <docblock line="418">
          <description>Gets the name of this objectClass (ie, "inetOrgPerson")</description>
          <long-description></long-description>
          <tag name="return" description="The name of the objectClass" line="418" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="428" package="lib">
        <name>getSupClasses</name>
        <full_name>\ObjectClass::getSupClasses()</full_name>
        <docblock line="428">
          <description>Gets the objectClass names from which this objectClass inherits.</description>
          <long-description></long-description>
          <tag name="return" description="An array of objectClass names (strings)" line="428" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="436" package="lib">
        <name>getType</name>
        <full_name>\ObjectClass::getType()</full_name>
        <docblock line="436">
          <description>Gets the type of this objectClass: STRUCTURAL, ABSTRACT, or AUXILIARY.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="444" package="lib">
        <name>getIsObsolete</name>
        <full_name>\ObjectClass::getIsObsolete()</full_name>
        <docblock line="444">
          <description>Gets whether this objectClass is flagged as obsolete by the LDAP server.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="456" package="lib">
        <name>addMustAttrs</name>
        <full_name>\ObjectClass::addMustAttrs()</full_name>
        <docblock line="456">
          <description>Adds the specified array of attributes to this objectClass' list of
MUST attributes. The resulting array of must attributes will contain
unique members.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;An array of attribute names (strings) to add.&lt;/p&gt;&#10;" line="456" type="array" variable="$new_must_attrs">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$new_must_attrs</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="471" package="lib">
        <name>addMayAttrs</name>
        <full_name>\ObjectClass::addMayAttrs()</full_name>
        <docblock line="471">
          <description>Behaves identically to addMustAttrs, but it operates on the MAY
attributes of this objectClass.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;An array of attribute names (strings) to add.&lt;/p&gt;&#10;" line="471" type="array" variable="$new_may_attrs">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$new_may_attrs</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="493" package="lib">
      <extends/>
      <name>ObjectClassAttribute</name>
      <full_name>\ObjectClassAttribute</full_name>
      <docblock line="493">
        <description>A simple class for representing AttributeTypes used only by the ObjectClass class.</description>
        <long-description>Users should never instantiate this class. It represents an attribute internal to
an ObjectClass. If PHP supported inner-classes and variable permissions, this would
be interior to class ObjectClass and flagged private. The reason this class is used
and not the "real" class AttributeType is because this class supports the notion of
a "source" objectClass, meaning that it keeps track of which objectClass originally
specified it. This class is therefore used by the class ObjectClass to determine
inheritance.</long-description>
        <tag name="package" description="lib" line="493"/>
      </docblock>
      <property static="false" visibility="public" line="496" namespace="" package="lib">
        <name>$name</name>
        <default></default>
        <docblock line="496">
          <description>This Attribute's name</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="498" namespace="" package="lib">
        <name>$source</name>
        <default></default>
        <docblock line="498">
          <description>This Attribute's root</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="506" package="lib">
        <name>ObjectClassAttribute</name>
        <full_name>\ObjectClassAttribute::ObjectClassAttribute()</full_name>
        <docblock line="506">
          <description>Creates a new ObjectClassAttribute with specified name and source objectClass.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;the name of the new attribute.&lt;/p&gt;" line="506" type="string" variable="$name">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;the name of the ObjectClass which&#10;          specifies this attribute.&lt;/p&gt;" line="506" type="string" variable="$source">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$source</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="513" package="lib">
        <name>getName</name>
        <full_name>\ObjectClassAttribute::getName()</full_name>
        <docblock line="513">
          <description>Gets this attribute's name</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="519" package="lib">
        <name>getSource</name>
        <full_name>\ObjectClassAttribute::getSource()</full_name>
        <docblock line="519">
          <description>Gets the name of the ObjectClass which originally specified this attribute.</description>
          <long-description></long-description>
        </docblock>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="531" package="lib">
      <extends>\SchemaItem</extends>
      <name>AttributeType</name>
      <full_name>\AttributeType</full_name>
      <docblock line="531">
        <description>Represents an LDAP AttributeType</description>
        <long-description>All schema items have at least two things in common: An OID
and a description. This class provides an implementation for
these two data.</long-description>
        <tag name="package" description="lib" line="531"/>
      </docblock>
      <property static="false" visibility="public" line="534" namespace="" package="lib">
        <name>$name</name>
        <default></default>
        <docblock line="534">
          <description>The name of this attributeType</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="536" namespace="" package="lib">
        <name>$is_obsolete</name>
        <default></default>
        <docblock line="536">
          <description>string: the description</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="538" namespace="" package="lib">
        <name>$sup_attribute</name>
        <default></default>
        <docblock line="538">
          <description>The attribute from which this attribute inherits (if any)</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="540" namespace="" package="lib">
        <name>$equality</name>
        <default></default>
        <docblock line="540">
          <description>The equality rule used</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="542" namespace="" package="lib">
        <name>$ordering</name>
        <default></default>
        <docblock line="542">
          <description>The ordering of the attributeType</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="544" namespace="" package="lib">
        <name>$sub_str</name>
        <default></default>
        <docblock line="544">
          <description>Boolean: supports substring matching?</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="546" namespace="" package="lib">
        <name>$syntax</name>
        <default></default>
        <docblock line="546">
          <description>The full syntax string, ie 1.2.3.4{16}</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="548" namespace="" package="lib">
        <name>$is_single_value</name>
        <default></default>
        <docblock line="548">
          <description>boolean: is single valued only?</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="550" namespace="" package="lib">
        <name>$is_collective</name>
        <default></default>
        <docblock line="550">
          <description>boolean: is collective?</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="552" namespace="" package="lib">
        <name>$is_no_user_modification</name>
        <default></default>
        <docblock line="552">
          <description>boolean: can use modify?</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="554" namespace="" package="lib">
        <name>$usage</name>
        <default></default>
        <docblock line="554">
          <description>The usage string set by the LDAP schema</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="556" namespace="" package="lib">
        <name>$aliases</name>
        <default></default>
        <docblock line="556">
          <description>An array of alias attribute names, strings</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="558" namespace="" package="lib">
        <name>$max_length</name>
        <default></default>
        <docblock line="558">
          <description>The max number of characters this attribute can be</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="560" namespace="" package="lib">
        <name>$type</name>
        <default></default>
        <docblock line="560">
          <description>A string description of the syntax type (taken from the LDAPSyntaxes)</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="562" namespace="" package="lib">
        <name>$used_in_object_classes</name>
        <default></default>
        <docblock line="562">
          <description>An array of objectClasses which use this attributeType (must be set by caller)</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="564" namespace="" package="lib">
        <name>$required_by_object_classes</name>
        <default>array()</default>
        <docblock line="564">
          <description>A list of object class names that require this attribute type.</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="569" package="lib">
        <name>initVars</name>
        <full_name>\AttributeType::initVars()</full_name>
        <docblock line="569">
          <description>Initialize the class' member variables</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="596" package="lib">
        <name>AttributeType</name>
        <full_name>\AttributeType::AttributeType()</full_name>
        <docblock line="596">
          <description>Creates a new AttributeType objcet from a raw LDAP AttributeType string.</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$raw_ldap_attr_string</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="713" package="lib">
        <name>getName</name>
        <full_name>\AttributeType::getName()</full_name>
        <docblock line="713">
          <description>Gets this attribute's name</description>
          <long-description></long-description>
          <tag name="return" description="" line="713" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="722" package="lib">
        <name>getIsObsolete</name>
        <full_name>\AttributeType::getIsObsolete()</full_name>
        <docblock line="722">
          <description>Gets whether this attribute has been flagged as obsolete by the LDAP server</description>
          <long-description></long-description>
          <tag name="return" description="" line="722" type="bool">
            <type>bool</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="731" package="lib">
        <name>getUsage</name>
        <full_name>\AttributeType::getUsage()</full_name>
        <docblock line="731">
          <description>Gets this attribute's usage string as defined by the LDAP server</description>
          <long-description></long-description>
          <tag name="return" description="" line="731" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="741" package="lib">
        <name>getSupAttribute</name>
        <full_name>\AttributeType::getSupAttribute()</full_name>
        <docblock line="741">
          <description>Gets this attribute's parent attribute (if any). If this attribute does not
inherit from another attribute, null is returned.</description>
          <long-description></long-description>
          <tag name="return" description="" line="741" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="750" package="lib">
        <name>getEquality</name>
        <full_name>\AttributeType::getEquality()</full_name>
        <docblock line="750">
          <description>Gets this attribute's equality string</description>
          <long-description></long-description>
          <tag name="return" description="" line="750" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="759" package="lib">
        <name>getOrdering</name>
        <full_name>\AttributeType::getOrdering()</full_name>
        <docblock line="759">
          <description>Gets this attribute's ordering specification.</description>
          <long-description></long-description>
          <tag name="return" description="" line="759" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="768" package="lib">
        <name>getSubstr</name>
        <full_name>\AttributeType::getSubstr()</full_name>
        <docblock line="768">
          <description>Gets this attribute's substring matching specification</description>
          <long-description></long-description>
          <tag name="return" description="" line="768" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="778" package="lib">
        <name>getAliases</name>
        <full_name>\AttributeType::getAliases()</full_name>
        <docblock line="778">
          <description>Gets the names of attributes that are an alias for this attribute (if any).</description>
          <long-description></long-description>
          <tag name="return" description="An array of names of attributes which alias this attribute or&#10;         an empty array if no attribute aliases this object." line="778" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="788" package="lib">
        <name>isAliasFor</name>
        <full_name>\AttributeType::isAliasFor()</full_name>
        <docblock line="788">
          <description>Returns whether the specified attribute is an alias for this one (based on this attribute's alias list).</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The name of the attribute to check.&lt;/p&gt;" line="788" type="string" variable="$attr_name">
            <type>string</type>
          </tag>
          <tag name="return" description="True if the specified attribute is an alias for this one, or false otherwise." line="788" type="bool">
            <type>bool</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attr_name</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="801" package="lib">
        <name>getSyntaxString</name>
        <full_name>\AttributeType::getSyntaxString()</full_name>
        <docblock line="801">
          <description>Gets this attribute's raw syntax string (ie: "1.2.3.4{16}").</description>
          <long-description></long-description>
          <tag name="return" description="The raw syntax string" line="801" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="813" package="lib">
        <name>getSyntaxOID</name>
        <full_name>\AttributeType::getSyntaxOID()</full_name>
        <docblock line="813">
          <description>Gets this attribute's syntax OID. Differs from getSyntaxString() in that this
function only returns the actual OID with any length specification removed.</description>
          <long-description>Ie, if the syntax string is "1.2.3.4{16}", this function only retruns
"1.2.3.4".</long-description>
          <tag name="return" description="The syntax OID string." line="813" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="822" package="lib">
        <name>getMaxLength</name>
        <full_name>\AttributeType::getMaxLength()</full_name>
        <docblock line="822">
          <description>Gets this attribute's the maximum length. If no maximum is defined by the LDAP server, null is returned.</description>
          <long-description></long-description>
          <tag name="return" description="The maximum length (in characters) of this attribute or null if no maximum is specified." line="822" type="int">
            <type>int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="832" package="lib">
        <name>getIsSingleValue</name>
        <full_name>\AttributeType::getIsSingleValue()</full_name>
        <docblock line="832">
          <description>Gets whether this attribute is single-valued. If this attribute only supports single values, true
is returned. If this attribute supports multiple values, false is returned.</description>
          <long-description></long-description>
          <tag name="return" description="Returns true if this attribute is single-valued or false otherwise." line="832" type="bool">
            <type>bool</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="841" package="lib">
        <name>setIsSingleValue</name>
        <full_name>\AttributeType::setIsSingleValue()</full_name>
        <docblock line="841">
          <description>Sets whether this attribute is single-valued.</description>
          <long-description></long-description>
          <tag name="param" description="" line="841" type="bool" variable="$is_single_value">
            <type>bool</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$is_single_value</name>
          <default></default>
          <type>bool</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="850" package="lib">
        <name>getIsCollective</name>
        <full_name>\AttributeType::getIsCollective()</full_name>
        <docblock line="850">
          <description>Gets whether this attribute is collective.</description>
          <long-description></long-description>
          <tag name="return" description="Returns true if this attribute is collective and false otherwise." line="850" type="bool">
            <type>bool</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="859" package="lib">
        <name>getIsNoUserModification</name>
        <full_name>\AttributeType::getIsNoUserModification()</full_name>
        <docblock line="859">
          <description>Gets whether this attribute is not modifiable by users.</description>
          <long-description></long-description>
          <tag name="return" description="Returns true if this attribute is not modifiable by users." line="859" type="bool">
            <type>bool</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="868" package="lib">
        <name>getType</name>
        <full_name>\AttributeType::getType()</full_name>
        <docblock line="868">
          <description>Gets this attribute's type</description>
          <long-description></long-description>
          <tag name="return" description="The attribute&amp;#039;s type." line="868" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="879" package="lib">
        <name>removeAlias</name>
        <full_name>\AttributeType::removeAlias()</full_name>
        <docblock line="879">
          <description>Removes an attribute name from this attribute's alias array.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The name of the attribute to remove.&lt;/p&gt;" line="879" type="string" variable="$remove_alias_name">
            <type>string</type>
          </tag>
          <tag name="return" description="true on success or false on failure (ie, if the specified&#10;          attribute name is not found in this attribute&amp;#039;s list of aliases)" line="879" type="bool">
            <type>bool</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$remove_alias_name</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="895" package="lib">
        <name>addAlias</name>
        <full_name>\AttributeType::addAlias()</full_name>
        <docblock line="895">
          <description>Adds an attribute name to the alias array.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The name of a new attribute to add to this attribute's list of aliases.&lt;/p&gt;" line="895" type="string" variable="$new_alias_name">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$new_alias_name</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="904" package="lib">
        <name>setName</name>
        <full_name>\AttributeType::setName()</full_name>
        <docblock line="904">
          <description>Sets this attriute's name.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The new name to give this attribute.&lt;/p&gt;" line="904" type="string" variable="$new_name">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$new_name</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="913" package="lib">
        <name>setSupAttribute</name>
        <full_name>\AttributeType::setSupAttribute()</full_name>
        <docblock line="913">
          <description>Sets this attriute's SUP attribute (ie, the attribute from which this attribute inherits).</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The name of the new parent (SUP) attribute&lt;/p&gt;&#10;" line="913" type="string" variable="$new_sup_attr">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$new_sup_attr</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="922" package="lib">
        <name>setAliases</name>
        <full_name>\AttributeType::setAliases()</full_name>
        <docblock line="922">
          <description>Sets this attribute's list of aliases.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The array of alias names (strings)&lt;/p&gt;&#10;" line="922" type="array" variable="$new_aliases">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$new_aliases</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="931" package="lib">
        <name>setType</name>
        <full_name>\AttributeType::setType()</full_name>
        <docblock line="931">
          <description>Sets this attribute's type.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The new type.&lt;/p&gt;" line="931" type="string" variable="$new_type">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$new_type</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="941" package="lib">
        <name>addUsedInObjectClass</name>
        <full_name>\AttributeType::addUsedInObjectClass()</full_name>
        <docblock line="941">
          <description>Adds an objectClass name to this attribute's list of "used in" objectClasses,
that is the list of objectClasses which provide this attribute.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The name of the objectClass to add.&lt;/p&gt;" line="941" type="string" variable="$object_class_name">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$object_class_name</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="955" package="lib">
        <name>getUsedInObjectClasses</name>
        <full_name>\AttributeType::getUsedInObjectClasses()</full_name>
        <docblock line="955">
          <description>Gets the list of "used in" objectClasses, that is the list of objectClasses
which provide this attribute.</description>
          <long-description></long-description>
          <tag name="return" description="An array of names of objectclasses (strings) which provide this attribute" line="955" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="965" package="lib">
        <name>addRequiredByObjectClass</name>
        <full_name>\AttributeType::addRequiredByObjectClass()</full_name>
        <docblock line="965">
          <description>Adds an objectClass name to this attribute's list of "required by" objectClasses,
that is the list of objectClasses which must have this attribute.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The name of the objectClass to add.&lt;/p&gt;" line="965" type="string" variable="$object_class_name">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$object_class_name</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="979" package="lib">
        <name>getRequiredByObjectClasses</name>
        <full_name>\AttributeType::getRequiredByObjectClasses()</full_name>
        <docblock line="979">
          <description>Gets the list of "required by" objectClasses, that is the list of objectClasses
which provide must have attribute.</description>
          <long-description></long-description>
          <tag name="return" description="An array of names of objectclasses (strings) which provide this attribute" line="979" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="990" package="lib">
      <extends>\SchemaItem</extends>
      <name>Syntax</name>
      <full_name>\Syntax</full_name>
      <docblock line="990">
        <description>Represents an LDAP Syntax</description>
        <long-description>All schema items have at least two things in common: An OID
and a description. This class provides an implementation for
these two data.</long-description>
        <tag name="package" description="lib" line="990"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="993" package="lib">
        <name>initVars</name>
        <full_name>\Syntax::initVars()</full_name>
        <docblock line="993">
          <description>Initializes the class' member variables</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1003" package="lib">
        <name>Syntax</name>
        <full_name>\Syntax::Syntax()</full_name>
        <docblock line="1003">
          <description>Creates a new Syntax object from a raw LDAP syntax string.</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$raw_ldap_syntax_string</name>
          <default></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="1036" package="lib">
      <extends>\SchemaItem</extends>
      <name>MatchingRule</name>
      <full_name>\MatchingRule</full_name>
      <docblock line="1036">
        <description>Represents an LDAP MatchingRule</description>
        <long-description>All schema items have at least two things in common: An OID
and a description. This class provides an implementation for
these two data.</long-description>
        <tag name="package" description="lib" line="1036"/>
      </docblock>
      <property static="false" visibility="public" line="1039" namespace="" package="lib">
        <name>$name</name>
        <default></default>
        <docblock line="1039">
          <description>This rule's name</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="1041" namespace="" package="lib">
        <name>$syntax</name>
        <default></default>
        <docblock line="1041">
          <description>This rule's syntax OID</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="1043" namespace="" package="lib">
        <name>$is_obsolete</name>
        <default></default>
        <docblock line="1043">
          <description>Boolean value indicating whether this MatchingRule is obsolete</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="1045" namespace="" package="lib">
        <name>$used_by_attrs</name>
        <default></default>
        <docblock line="1045">
          <description>An array of attribute names who use this MatchingRule</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1048" package="lib">
        <name>initVars</name>
        <full_name>\MatchingRule::initVars()</full_name>
        <docblock line="1048">
          <description>Initialize the class' member variables</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1062" package="lib">
        <name>MatchingRule</name>
        <full_name>\MatchingRule::MatchingRule()</full_name>
        <docblock line="1062">
          <description>Creates a new MatchingRule object from a raw LDAP MatchingRule string.</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$raw_ldap_matching_rule_string</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1123" package="lib">
        <name>setUsedByAttrs</name>
        <full_name>\MatchingRule::setUsedByAttrs()</full_name>
        <docblock line="1123">
          <description>Sets the list of used_by_attrs to the array specified by $attrs;</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The array of attribute names (strings) which use this MatchingRule&lt;/p&gt;&#10;" line="1123" type="array" variable="$attrs">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attrs</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1132" package="lib">
        <name>addUsedByAttr</name>
        <full_name>\MatchingRule::addUsedByAttr()</full_name>
        <docblock line="1132">
          <description>Adds an attribute name to the list of attributes who use this MatchingRule</description>
          <long-description></long-description>
          <tag name="return" description="if the attribute was added and false otherwise (already in the list)" line="1132" type="true">
            <type>true</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$new_attr_name</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1145" package="lib">
        <name>getName</name>
        <full_name>\MatchingRule::getName()</full_name>
        <docblock line="1145">
          <description>Gets this MatchingRule's name.</description>
          <long-description></long-description>
          <tag name="return" description="The name." line="1145" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1154" package="lib">
        <name>getIsObsolete</name>
        <full_name>\MatchingRule::getIsObsolete()</full_name>
        <docblock line="1154">
          <description>Gets whether this MatchingRule is flagged as obsolete by the LDAP server.</description>
          <long-description></long-description>
          <tag name="return" description="True if this MatchingRule is obsolete and false otherwise." line="1154" type="bool">
            <type>bool</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1163" package="lib">
        <name>getUsedByAttrs</name>
        <full_name>\MatchingRule::getUsedByAttrs()</full_name>
        <docblock line="1163">
          <description>Gets an array of attribute names (strings) which use this MatchingRule</description>
          <long-description></long-description>
          <tag name="return" description="The array of attribute names (strings)." line="1163" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="1174" package="lib">
      <extends>\SchemaItem</extends>
      <name>MatchingRuleUse</name>
      <full_name>\MatchingRuleUse</full_name>
      <docblock line="1174">
        <description>Represents an LDAP schema matchingRuleUse entry</description>
        <long-description>All schema items have at least two things in common: An OID
and a description. This class provides an implementation for
these two data.</long-description>
        <tag name="package" description="lib" line="1174"/>
      </docblock>
      <property static="false" visibility="public" line="1177" namespace="" package="lib">
        <name>$name</name>
        <default></default>
        <docblock line="1177">
          <description>The name of the MathingRule this applies to</description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="1180" namespace="" package="lib">
        <name>$used_by_attrs</name>
        <default></default>
        <docblock line="1180">
          <description>An array of attributeType names who make use of the mathingRule
identified by $this-&gt;oid and $this-&gt;name</description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1183" package="lib">
        <name>initVars</name>
        <full_name>\MatchingRuleUse::initVars()</full_name>
        <docblock line="1183">
          <description>Initialize the class' member variables</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1191" package="lib">
        <name>MatchingRuleUse</name>
        <full_name>\MatchingRuleUse::MatchingRuleUse()</full_name>
        <docblock line="1191">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$raw_matching_rule_use_string</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1256" package="lib">
        <name>getName</name>
        <full_name>\MatchingRuleUse::getName()</full_name>
        <docblock line="1256">
          <description>Gets this MatchingRuleUse's name</description>
          <long-description></long-description>
          <tag name="return" description="The name" line="1256" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1265" package="lib">
        <name>getUsedByAttrs</name>
        <full_name>\MatchingRuleUse::getUsedByAttrs()</full_name>
        <docblock line="1265">
          <description>Gets an array of attribute names (strings) which use this MatchingRuleUse object.</description>
          <long-description></long-description>
          <tag name="return" description="The array of attribute names (strings)." line="1265" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="help/help.inc" generated-path="help.help.inc.html" hash="c80cd724c3d3dd55fc76579feb33705e" package="Help">
    <docblock line="0">
      <description>LDAP Account Manager help entries.</description>
      <long-description></long-description>
      <tag name="author" description="Michael Duergner" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="package" description="Help" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/lib/141_jquery-validationEngine-lang.php" generated-path="templates.lib.141_jquery-validationEngine-lang.html" hash="8381d680210908ca0d75ffd3b7c8b0ea" package="main">
    <docblock line="0">
      <description></description>
      <long-description></long-description>
    </docblock>
    <parse_markers>
      <error line="0" code="PPC:ERR-50000">No summary was found for this file</error>
    </parse_markers>
    <source> </source>
  </file>
  <file path="templates/misc/ajax.php" generated-path="templates.misc.ajax.html" hash="17ff1a03fa4bc1d8aafa9da3ff87d046" package="tools">
    <docblock line="0">
      <description>Manages all AJAX requests.</description>
      <long-description></long-description>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="package" description="tools" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="55" package="tools">
      <extends/>
      <name>lamAjax</name>
      <full_name>\lamAjax</full_name>
      <docblock line="55">
        <description>Manages all AJAX requests.</description>
        <long-description></long-description>
      </docblock>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="60" package="tools">
        <name>handleRequest</name>
        <full_name>\lamAjax::handleRequest()</full_name>
        <docblock line="60">
          <description>Manages an AJAX request.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="91" package="tools">
        <name>managePasswordChange</name>
        <full_name>\lamAjax::managePasswordChange()</full_name>
        <docblock line="91">
          <description>Manages a password change request on the edit account page.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;input parameters&lt;/p&gt;" line="91" type="array" variable="$input">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$input</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="templates/tree/treeViewContainer.php" generated-path="templates.tree.treeViewContainer.html" hash="9af53eb878d4a5359c387a4b5d00fd5e" package="lists">
    <docblock line="0">
      <description>Provides a container around the tree view frameset.</description>
      <long-description></long-description>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="package" description="lists" line="0"/>
      <tag name="subpackage" description="tree" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/serverInfo.php" generated-path="templates.serverInfo.html" hash="61ce935fa95bcaa8d326cd1653e37be6" package="tools">
    <docblock line="0">
      <description>Provides a list of LAM tests.</description>
      <long-description></long-description>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="package" description="tools" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/lists/list.php" generated-path="templates.lists.list.html" hash="0206d500ca1a9c3e8bffea88e75e98cc" package="lists">
    <docblock line="0">
      <description>This file shows the list views.</description>
      <long-description></long-description>
      <tag name="package" description="lists" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/lists/userlink.php" generated-path="templates.lists.userlink.html" hash="8be5e0eb89bf91ee243ba3e546785eb0" package="lists">
    <docblock line="0">
      <description>This page will redirect to account/edit.php if the given user is valid.</description>
      <long-description>It is called from listgroups.php via the memberUID links.</long-description>
      <tag name="package" description="lists" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <function namespace="" line="74" package="lists">
      <name>search_username</name>
      <full_name>\search_username()</full_name>
      <docblock line="74">
        <description>Searches LDAP for a specific user name (uid attribute) and returns its DN entry</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;user name&lt;/p&gt;" line="74" type="string" variable="$name">
          <type>string</type>
        </tag>
        <tag name="return" description="DN" line="74" type="string">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$name</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <source> </source>
  </file>
  <file path="templates/lists/deletelink.php" generated-path="templates.lists.deletelink.html" hash="11eabef0ce4f36792617d0c6764f58d6" package="lists">
    <docblock line="0">
      <description>This page will redirect to delete.php if the given user is valid.</description>
      <long-description>It is called from the list views via the delete links.</long-description>
      <tag name="package" description="lists" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/tests/schemaTest.php" generated-path="templates.tests.schemaTest.html" hash="b50b31ab0289bebc9738edb5632f9b30" package="tools">
    <docblock line="0">
      <description>Tests the lamdaemon script.</description>
      <long-description></long-description>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="package" description="tools" line="0"/>
    </docblock>
    <function namespace="" line="101" package="tools">
      <name>checkSchemaForModule</name>
      <full_name>\checkSchemaForModule()</full_name>
      <docblock line="101">
        <description>Checks if the object classes and attributes for this module are available.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;module name&lt;/p&gt;" line="101" type="String" variable="$name">
          <type>String</type>
        </tag>
        <tag name="param" description="&lt;p&gt;type (user, group, ...)&lt;/p&gt;&#10;" line="101" type="String" variable="$type">
          <type>String</type>
        </tag>
        <tag name="return" description="error message or null" line="101" type="String">
          <type>String</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$name</name>
        <default></default>
        <type>String</type>
      </argument>
      <argument line="0">
        <name>$type</name>
        <default></default>
        <type>String</type>
      </argument>
    </function>
    <function namespace="" line="140" package="tools">
      <name>getRecursiveAttributesFromObjectClass</name>
      <full_name>\getRecursiveAttributesFromObjectClass()</full_name>
      <docblock line="140">
        <description>Returns the names of all attributes which are managed by the given object class and its parents.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;object class&lt;/p&gt;" line="140" type="\ObjectClass" variable="$oClass">
          <type>\ObjectClass</type>
        </tag>
        <tag name="return" description="list of attribute names" line="140" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$oClass</name>
        <default></default>
        <type>\ObjectClass</type>
      </argument>
    </function>
    <source> </source>
  </file>
  <file path="templates/tests/index.php" generated-path="templates.tests.index.html" hash="8e73213c6c079573ef5371dee38d1aef" package="tools">
    <docblock line="0">
      <description>Provides a list of LAM tests.</description>
      <long-description></long-description>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="package" description="tools" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/tests/lamdaemonTest.php" generated-path="templates.tests.lamdaemonTest.html" hash="2ce4ab3745fe051a6e79abc101a375e3" package="tools">
    <docblock line="0">
      <description>Tests the lamdaemon script.</description>
      <long-description></long-description>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="author" description="Thomas Manninger" line="0"/>
      <tag name="package" description="tools" line="0"/>
    </docblock>
    <function namespace="" line="118" package="tools">
      <name>lamTestLamdaemon</name>
      <full_name>\lamTestLamdaemon()</full_name>
      <docblock line="118">
        <description>Runs a test case of lamdaemon.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;test command&lt;/p&gt;" line="118" type="string" variable="$command">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;specifies if test should be run&lt;/p&gt;" line="118" type="boolean" variable="$stopTest">
          <type>boolean</type>
        </tag>
        <tag name="param" description="&lt;p&gt;SSH connection&lt;/p&gt;" line="118" type="\connection" variable="$handle">
          <type>\connection</type>
        </tag>
        <tag name="param" description="&lt;p&gt;describing text&lt;/p&gt;" line="118" type="string" variable="$testText">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;container for HTML output&lt;/p&gt;" line="118" type="\htmlTable" variable="$container">
          <type>\htmlTable</type>
        </tag>
        <tag name="return" description="true, if errors occured" line="118" type="boolean">
          <type>boolean</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$command</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$stopTest</name>
        <default></default>
        <type>boolean</type>
      </argument>
      <argument line="0">
        <name>$handle</name>
        <default></default>
        <type>\connection</type>
      </argument>
      <argument line="0">
        <name>$testText</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$container</name>
        <default></default>
        <type>\htmlTable</type>
      </argument>
    </function>
    <function namespace="" line="172" package="tools">
      <name>lamRunLamdaemonTestSuite</name>
      <full_name>\lamRunLamdaemonTestSuite()</full_name>
      <docblock line="172">
        <description>Runs all tests for a given server.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;server ID&lt;/p&gt;" line="172" type="String" variable="$serverName">
          <type>String</type>
        </tag>
        <tag name="param" description="&lt;p&gt;server name&lt;/p&gt;" line="172" type="String" variable="$serverTitle">
          <type>String</type>
        </tag>
        <tag name="param" description="&lt;p&gt;true, if Quotas should be checked&lt;/p&gt;" line="172" type="boolean" variable="$testQuota">
          <type>boolean</type>
        </tag>
        <tag name="param" description="&lt;p&gt;container for HTML output&lt;/p&gt;" line="172" type="\htmlTable" variable="$container">
          <type>\htmlTable</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$serverName</name>
        <default></default>
        <type>String</type>
      </argument>
      <argument line="0">
        <name>$serverTitle</name>
        <default></default>
        <type>String</type>
      </argument>
      <argument line="0">
        <name>$testQuota</name>
        <default></default>
        <type>boolean</type>
      </argument>
      <argument line="0">
        <name>$container</name>
        <default></default>
        <type>\htmlTable</type>
      </argument>
    </function>
    <function namespace="" line="302" package="tools">
      <name>lamTestConnectSSH</name>
      <full_name>\lamTestConnectSSH()</full_name>
      <docblock line="302">
        <description>Connects to the given SSH server.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;server name (e.g. localhost or localhost,1234)&lt;/p&gt;&#10;" line="302" type="String" variable="$server">
          <type>String</type>
        </tag>
        <tag name="return" description="handle" line="302" type="object">
          <type>object</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$server</name>
        <default></default>
        <type>String</type>
      </argument>
    </function>
    <source> </source>
  </file>
  <file path="templates/ou_edit.php" generated-path="templates.ou_edit.html" hash="3eadf3f8cb28f310e7ad3b26dffda3dc" package="tools">
    <docblock line="0">
      <description>This is an editor for organizational units.</description>
      <long-description></long-description>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="package" description="tools" line="0"/>
    </docblock>
    <function namespace="" line="144" package="tools">
      <name>display_main</name>
      <full_name>\display_main()</full_name>
      <docblock line="144">
        <description>Displays the main page of the OU editor</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;info message&lt;/p&gt;" line="144" type="String" variable="$message">
          <type>String</type>
        </tag>
        <tag name="param" description="&lt;p&gt;error message&lt;/p&gt;" line="144" type="String" variable="$error">
          <type>String</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$message</name>
        <default></default>
        <type>String</type>
      </argument>
      <argument line="0">
        <name>$error</name>
        <default></default>
        <type>String</type>
      </argument>
    </function>
    <source> </source>
  </file>
  <file path="templates/tools.php" generated-path="templates.tools.html" hash="68eb8d4879d465fde0f0cdb52bbea9de" package="tools">
    <docblock line="0">
      <description>Provides a list of tools like file upload or profile editor.</description>
      <long-description></long-description>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="package" description="tools" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/main.php" generated-path="templates.main.html" hash="1b02c2ebe867d2a44c4e8a23ff5ebe1c" package="main">
    <docblock line="0">
      <description>This is the main window. The user and group lists will be shown in this frameset.</description>
      <long-description></long-description>
      <tag name="package" description="main" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/login.php" generated-path="templates.login.html" hash="9e3f938675bfcbbf721bd78d12bb8503" package="main">
    <docblock line="0">
      <description>Login form of LDAP Account Manager.</description>
      <long-description></long-description>
      <tag name="author" description="Michael Duergner" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="package" description="main" line="0"/>
    </docblock>
    <function namespace="" line="130" package="main">
      <name>display_LoginPage</name>
      <full_name>\display_LoginPage()</full_name>
      <docblock line="130">
        <description>Displays the login window.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;current active configuration&lt;/p&gt;" line="130" type="object" variable="$config_object">
          <type>object</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$config_object</name>
        <default></default>
        <type>object</type>
      </argument>
    </function>
    <source> </source>
  </file>
  <file path="templates/massDoUpload.php" generated-path="templates.massDoUpload.html" hash="fe1788c160e2af0ba1be4c17ac48a2e8" package="tools">
    <docblock line="0">
      <description>Creates LDAP accounts for file upload.</description>
      <long-description></long-description>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="package" description="tools" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/masscreate.php" generated-path="templates.masscreate.html" hash="ff29855dc0f64f764af857aaeb8b8556" package="tools">
    <docblock line="0">
      <description>Start page of file upload</description>
      <long-description></long-description>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="package" description="tools" line="0"/>
    </docblock>
    <function namespace="" line="228" package="tools">
      <name>showMainPage</name>
      <full_name>\showMainPage()</full_name>
      <docblock line="228">
        <description>Displays the acount type specific main page of the upload.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="228" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;list of selected account modules&lt;/p&gt;" line="228" type="array" variable="$selectedModules">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$selectedModules</name>
        <default></default>
        <type>array</type>
      </argument>
    </function>
    <source> </source>
  </file>
  <file path="templates/config/profmanage.php" generated-path="templates.config.profmanage.html" hash="428d8310b01276be7bdbf78f11a0ece4" package="configuration">
    <docblock line="0">
      <description>Configuration profile management.</description>
      <long-description></long-description>
      <tag name="package" description="configuration" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/config/mainmanage.php" generated-path="templates.config.mainmanage.html" hash="786fa6ff947b24f5128ef1edaf7504b2" package="configuration">
    <docblock line="0">
      <description>Manages the main configuration options.</description>
      <long-description></long-description>
      <tag name="package" description="configuration" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <function namespace="" line="405" package="configuration">
      <name>formatSSLTimestamp</name>
      <full_name>\formatSSLTimestamp()</full_name>
      <docblock line="405">
        <description>Formats an LDAP time string (e.g. from createTimestamp).</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;LDAP time value&lt;/p&gt;" line="405" type="String" variable="$time">
          <type>String</type>
        </tag>
        <tag name="return" description="formated time" line="405" type="String">
          <type>String</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$time</name>
        <default></default>
        <type>String</type>
      </argument>
    </function>
    <source> </source>
  </file>
  <file path="templates/config/confmodules.php" generated-path="templates.config.confmodules.html" hash="1e38410314e158e2baca4a9a6bfbdfe9" package="configuration">
    <docblock line="0">
      <description>confmodules lets the user select the account modules</description>
      <long-description></long-description>
      <tag name="package" description="configuration" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <function namespace="" line="255" package="configuration">
      <name>config_showAccountModules</name>
      <full_name>\config_showAccountModules()</full_name>
      <docblock line="255">
        <description>Displays the module selection boxes and checks if dependencies are fulfilled.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="255" type="string" variable="$scope">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;title for module selection (e.g. &quot;User modules&quot;)&lt;/p&gt;&#10;" line="255" type="string" variable="$title">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;meta HTML container&lt;/p&gt;" line="255" type="\htmlTable" variable="$container">
          <type>\htmlTable</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$title</name>
        <default></default>
        <type>string</type>
      </argument>
      <argument line="0">
        <name>$container</name>
        <default></default>
        <type>\htmlTable</type>
      </argument>
    </function>
    <function namespace="" line="344" package="configuration">
      <name>checkInput</name>
      <full_name>\checkInput()</full_name>
      <docblock line="344">
        <description>Checks user input and saves the entered settings.</description>
        <long-description></long-description>
        <tag name="return" description="list of errors" line="344" type="array">
          <type>array</type>
        </tag>
      </docblock>
    </function>
    <source> </source>
  </file>
  <file path="templates/config/confsave.php" generated-path="templates.config.confsave.html" hash="abd7071cf4f53ff46b64332e97767b8d" package="configuration">
    <docblock line="0">
      <description>End page of configuration.</description>
      <long-description></long-description>
      <tag name="package" description="configuration" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/config/index.php" generated-path="templates.config.index.html" hash="d567a2112a37ac40db0c496dfe27aa34" package="configuration">
    <docblock line="0">
      <description>Displays links to all configuration pages.</description>
      <long-description></long-description>
      <tag name="package" description="configuration" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/config/confmain.php" generated-path="templates.config.confmain.html" hash="84f9cf45da86423ce5a310b71e961e44" package="configuration">
    <docblock line="0">
      <description>Main page of configuration</description>
      <long-description></long-description>
      <tag name="package" description="configuration" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="author" description="Thomas Manninger" line="0"/>
    </docblock>
    <function namespace="" line="469" package="configuration">
      <name>checkInput</name>
      <full_name>\checkInput()</full_name>
      <docblock line="469">
        <description>Checks user input and saves the entered settings.</description>
        <long-description></long-description>
        <tag name="return" description="list of errors" line="469" type="array">
          <type>array</type>
        </tag>
      </docblock>
    </function>
    <source> </source>
  </file>
  <file path="templates/config/moduleSettings.php" generated-path="templates.config.moduleSettings.html" hash="081e1ccd3681e93b98024658c073d7fc" package="configuration">
    <docblock line="0">
      <description>Here the user can edit the module settings.</description>
      <long-description></long-description>
      <tag name="package" description="configuration" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <function namespace="" line="264" package="configuration">
      <name>checkInput</name>
      <full_name>\checkInput()</full_name>
      <docblock line="264">
        <description>Checks user input and saves the entered settings.</description>
        <long-description></long-description>
        <tag name="return" description="list of errors" line="264" type="array">
          <type>array</type>
        </tag>
      </docblock>
    </function>
    <source> </source>
  </file>
  <file path="templates/config/conftypes.php" generated-path="templates.config.conftypes.html" hash="b94602b97ff49e82b99eda6d1adb338a" package="configuration">
    <docblock line="0">
      <description>Here the user can select the account types.</description>
      <long-description></long-description>
      <tag name="package" description="configuration" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <function namespace="" line="337" package="configuration">
      <name>checkInput</name>
      <full_name>\checkInput()</full_name>
      <docblock line="337">
        <description>Checks user input and saves the entered settings.</description>
        <long-description></long-description>
        <tag name="return" description="list of errors" line="337" type="array">
          <type>array</type>
        </tag>
      </docblock>
    </function>
    <source> </source>
  </file>
  <file path="templates/config/conflogin.php" generated-path="templates.config.conflogin.html" hash="c27e164426a760b8cba6380fcaec434a" package="configuration">
    <docblock line="0">
      <description>Login page to change the preferences.</description>
      <long-description></long-description>
      <tag name="package" description="configuration" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/config/mainlogin.php" generated-path="templates.config.mainlogin.html" hash="cc0d2d9bb11430e1d20e4c814c0aa27c" package="configuration">
    <docblock line="0">
      <description>Login page to change the main preferences.</description>
      <long-description></long-description>
      <tag name="package" description="configuration" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/main_footer.php" generated-path="templates.main_footer.html" hash="87f6238b4dabe640b125f217dcb7925c" package="main">
    <docblock line="0">
      <description></description>
      <long-description></long-description>
    </docblock>
    <parse_markers>
      <error line="0" code="PPC:ERR-50000">No summary was found for this file</error>
    </parse_markers>
    <source> </source>
  </file>
  <file path="templates/account/edit.php" generated-path="templates.account.edit.html" hash="e301e625697fec2a04ab68e13e7af795" package="modules">
    <docblock line="0">
      <description>Displays the account detail page.</description>
      <long-description></long-description>
      <tag name="package" description="modules" line="0"/>
      <tag name="author" description="Tilo Lutz" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/main_header.php" generated-path="templates.main_header.html" hash="d10ae23598e3e5fec667e60af05c93b5" package="main">
    <docblock line="0">
      <description>Head part of page which includes links to lists etc.</description>
      <long-description></long-description>
      <tag name="package" description="main" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/schema/schema.php" generated-path="templates.schema.schema.html" hash="c632e61739393ffda882d1bf2c0a2de7" package="tools">
    <docblock line="0">
      <description>Displays the LDAP schema of the server</description>
      <long-description></long-description>
      <tag name="package" description="tools" line="0"/>
      <tag name="author" description="David Smith" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/pdfedit/pdfpage.php" generated-path="templates.pdfedit.pdfpage.html" hash="7f1bbbeabc433fa28908ca7c3348e51d" package="PDF">
    <docblock line="0">
      <description>Displays the main page of the PDF editor where the user can select the displayed entries.</description>
      <long-description></long-description>
      <tag name="author" description="Michael Duergner" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="package" description="PDF" line="0"/>
    </docblock>
    <function namespace="" line="670" package="PDF">
      <name>translateFieldIDToName</name>
      <full_name>\translateFieldIDToName()</full_name>
      <docblock line="670">
        <description>Translates a given field ID (e.g. inetOrgPerson_givenName) to its descriptive name.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;field ID&lt;/p&gt;" line="670" type="String" variable="$id">
          <type>String</type>
        </tag>
        <tag name="param" description="&lt;p&gt;account type&lt;/p&gt;" line="670" type="String" variable="$scope">
          <type>String</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$id</name>
        <default></default>
        <type>String</type>
      </argument>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>String</type>
      </argument>
    </function>
    <source> </source>
  </file>
  <file path="templates/pdfedit/pdfmain.php" generated-path="templates.pdfedit.pdfmain.html" hash="1166ac7a10fbb27cbc6df1ce7abed118" package="PDF">
    <docblock line="0">
      <description>This is the main window of the pdf structure editor.</description>
      <long-description></long-description>
      <tag name="author" description="Michael Duergner" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="package" description="PDF" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/delete.php" generated-path="templates.delete.html" hash="11678cacdadf2e5a1031a7cf3e502c9e" package="main">
    <docblock line="0">
      <description>Used to delete accounts from LDAP tree.</description>
      <long-description></long-description>
      <tag name="author" description="Tilo Lutz" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="package" description="main" line="0"/>
    </docblock>
    <function namespace="" line="316" package="main">
      <name>getChildCount</name>
      <full_name>\getChildCount()</full_name>
      <docblock line="316">
        <description>Returns the number of child entries of a DN.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;DN of parent&lt;/p&gt;" line="316" type="string" variable="$dn">
          <type>string</type>
        </tag>
        <tag name="return" description="number of childs" line="316" type="\interger">
          <type>\interger</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$dn</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <function namespace="" line="327" package="main">
      <name>deleteDN</name>
      <full_name>\deleteDN()</full_name>
      <docblock line="327">
        <description>Deletes a DN and all child entries.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;DN to delete&lt;/p&gt;" line="327" type="string" variable="$dn">
          <type>string</type>
        </tag>
        <tag name="return" description="error messages" line="327" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$dn</name>
        <default></default>
        <type>string</type>
      </argument>
    </function>
    <source> </source>
  </file>
  <file path="templates/profedit/profilepage.php" generated-path="templates.profedit.profilepage.html" hash="8def063a0dddc5cda45e984c8c46b468" package="profiles">
    <docblock line="0">
      <description>Manages creating/changing of profiles.</description>
      <long-description></long-description>
      <tag name="package" description="profiles" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/profedit/profilemain.php" generated-path="templates.profedit.profilemain.html" hash="bfde2f889abd853c5fa177c1b592c1e2" package="profiles">
    <docblock line="0">
      <description>This is the main window of the profile editor.</description>
      <long-description></long-description>
      <tag name="package" description="profiles" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/QueryRender.php" generated-path="templates.3rdParty.pla.lib.QueryRender.html" hash="a915a4f3a7882919375804b25cf45c0b" package="phpLDAPadmin">
    <docblock line="0">
      <description></description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="14" package="phpLDAPadmin\Templates">
      <extends>\PageRender</extends>
      <name>QueryRender</name>
      <full_name>\QueryRender</full_name>
      <docblock line="14">
        <description>QueryRender class</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="14"/>
        <tag name="subpackage" description="Templates" line="14"/>
        <tag name="todo" description="need to add paging" line="14"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="20" package="phpLDAPadmin\Templates">
        <name>accept</name>
        <full_name>\QueryRender::accept()</full_name>
        <docblock line="20">
          <description>Intialise and Render the QueryRender</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="48" package="phpLDAPadmin\Templates">
        <name>getTemplates</name>
        <full_name>\QueryRender::getTemplates()</full_name>
        <docblock line="48">
          <description>Get our templates applicable for this object</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="58" package="phpLDAPadmin\Templates">
        <name>haveDefaultTemplate</name>
        <full_name>\QueryRender::haveDefaultTemplate()</full_name>
        <docblock line="58">
          <description>Are default queries enabled?</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="70" package="phpLDAPadmin\Templates">
        <name>drawTemplateChoice</name>
        <full_name>\QueryRender::drawTemplateChoice()</full_name>
        <docblock line="70">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="186" package="phpLDAPadmin\Templates">
        <name>visitStart</name>
        <full_name>\QueryRender::visitStart()</full_name>
        <docblock line="186">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="195" package="phpLDAPadmin\Templates">
        <name>visitEnd</name>
        <full_name>\QueryRender::visitEnd()</full_name>
        <docblock line="195">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="411" package="phpLDAPadmin\Templates">
        <name>drawSubTitle</name>
        <full_name>\QueryRender::drawSubTitle()</full_name>
        <docblock line="411">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$subtitle</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="415" package="phpLDAPadmin\Templates">
        <name>getAFattrs</name>
        <full_name>\QueryRender::getAFattrs()</full_name>
        <docblock line="415">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="428" package="phpLDAPadmin\Templates">
        <name>getAjaxRef</name>
        <full_name>\QueryRender::getAjaxRef()</full_name>
        <docblock line="428">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="435" package="phpLDAPadmin\Templates">
        <name>drawBaseTabs</name>
        <full_name>\QueryRender::drawBaseTabs()</full_name>
        <docblock line="435">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="465" package="phpLDAPadmin\Templates">
        <name>drawResultsTable</name>
        <full_name>\QueryRender::drawResultsTable()</full_name>
        <docblock line="465">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$base</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$results</name>
          <default></default>
          <type/>
        </argument>
      </method>
    </class>
    <parse_markers>
      <error line="0" code="PPC:ERR-50000">No summary was found for this file</error>
      <error line="70" code="PPC:ERR-50008">No summary for method drawTemplateChoice()</error>
      <error line="186" code="PPC:ERR-50008">No summary for method visitStart()</error>
      <error line="195" code="PPC:ERR-50008">No summary for method visitEnd()</error>
      <error line="411" code="PPC:ERR-50008">No summary for method drawSubTitle()</error>
      <error line="415" code="PPC:ERR-50008">No summary for method getAFattrs()</error>
      <error line="428" code="PPC:ERR-50008">No summary for method getAjaxRef()</error>
      <error line="435" code="PPC:ERR-50008">No summary for method drawBaseTabs()</error>
      <error line="465" code="PPC:ERR-50008">No summary for method drawResultsTable()</error>
    </parse_markers>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/schema_functions.php" generated-path="templates.3rdParty.pla.lib.schema_functions.html" hash="c7f0689fae16ea720416d037956671cb" package="phpLDAPadmin">
    <docblock line="0">
      <description>Classes and functions for fetching and parsing schema from an LDAP server.</description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <class final="false" abstract="true" namespace="" line="19" package="phpLDAPadmin\Schema">
      <extends/>
      <name>SchemaItem</name>
      <full_name>\SchemaItem</full_name>
      <docblock line="19">
        <description>Generic parent class for all schema items. A schema item is
an ObjectClass, an AttributeBype, a MatchingRule, or a Syntax.</description>
        <long-description>All schema items have at least two things in common: An OID
and a description. This class provides an implementation for
these two data.</long-description>
        <tag name="package" description="phpLDAPadmin" line="19"/>
        <tag name="subpackage" description="Schema" line="19"/>
      </docblock>
      <property static="false" visibility="protected" line="21" namespace="" package="phpLDAPadmin\Schema">
        <name>$name</name>
        <default>null</default>
        <docblock line="21">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="23" namespace="" package="phpLDAPadmin\Schema">
        <name>$oid</name>
        <default>null</default>
        <docblock line="23">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="25" namespace="" package="phpLDAPadmin\Schema">
        <name>$description</name>
        <default>null</default>
        <docblock line="25">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="27" namespace="" package="phpLDAPadmin\Schema">
        <name>$is_obsolete</name>
        <default>false</default>
        <docblock line="27">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="29" package="phpLDAPadmin\Schema">
        <name>setOID</name>
        <full_name>\SchemaItem::setOID()</full_name>
        <docblock line="29">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$oid</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="36" package="phpLDAPadmin\Schema">
        <name>setDescription</name>
        <full_name>\SchemaItem::setDescription()</full_name>
        <docblock line="36">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$desc</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="43" package="phpLDAPadmin\Schema">
        <name>getOID</name>
        <full_name>\SchemaItem::getOID()</full_name>
        <docblock line="43">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="50" package="phpLDAPadmin\Schema">
        <name>getDescription</name>
        <full_name>\SchemaItem::getDescription()</full_name>
        <docblock line="50">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="60" package="phpLDAPadmin\Schema">
        <name>getIsObsolete</name>
        <full_name>\SchemaItem::getIsObsolete()</full_name>
        <docblock line="60">
          <description>Gets whether this objectClass is flagged as obsolete by the LDAP server.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="73" package="phpLDAPadmin\Schema">
        <name>getName</name>
        <full_name>\SchemaItem::getName()</full_name>
        <docblock line="73">
          <description>Return the objects name.</description>
          <long-description>param boolean $lower Return the name in lower case (default)</long-description>
          <tag name="return" description="The name" line="73" type="string">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$lower</name>
          <default>true</default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="87" package="phpLDAPadmin\Schema">
      <extends>\SchemaItem</extends>
      <name>ObjectClass</name>
      <full_name>\ObjectClass</full_name>
      <docblock line="87">
        <description>Represents an LDAP objectClass</description>
        <long-description>All schema items have at least two things in common: An OID
and a description. This class provides an implementation for
these two data.</long-description>
        <tag name="package" description="phpLDAPadmin" line="87"/>
        <tag name="subpackage" description="Schema" line="87"/>
      </docblock>
      <property static="false" visibility="private" line="89" namespace="" package="phpLDAPadmin\Schema">
        <name>$server_id</name>
        <default>null</default>
        <docblock line="89">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="91" namespace="" package="phpLDAPadmin\Schema">
        <name>$sup_classes</name>
        <default>array()</default>
        <docblock line="91">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="93" namespace="" package="phpLDAPadmin\Schema">
        <name>$type</name>
        <default></default>
        <docblock line="93">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="95" namespace="" package="phpLDAPadmin\Schema">
        <name>$must_attrs</name>
        <default>array()</default>
        <docblock line="95">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="97" namespace="" package="phpLDAPadmin\Schema">
        <name>$may_attrs</name>
        <default>array()</default>
        <docblock line="97">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="99" namespace="" package="phpLDAPadmin\Schema">
        <name>$force_may</name>
        <default>array()</default>
        <docblock line="99">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="101" namespace="" package="phpLDAPadmin\Schema">
        <name>$children_objectclasses</name>
        <default>array()</default>
        <docblock line="101">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="103" namespace="" package="phpLDAPadmin\Schema">
        <name>$hierarchy</name>
        <default>array()</default>
        <docblock line="103">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="108" package="phpLDAPadmin\Schema">
        <name>__construct</name>
        <full_name>\ObjectClass::__construct()</full_name>
        <docblock line="108">
          <description>Creates a new ObjectClass object given a raw LDAP objectClass string.</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$class</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$server</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="281" package="phpLDAPadmin\Schema">
        <name>parseList</name>
        <full_name>\ObjectClass::parseList()</full_name>
        <docblock line="281">
          <description>Parse an LDAP schema list</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$strings</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$attrs</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="345" package="phpLDAPadmin\Schema">
        <name>getParents</name>
        <full_name>\ObjectClass::getParents()</full_name>
        <docblock line="345">
          <description>This will return all our parent ObjectClass Objects</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="381" package="phpLDAPadmin\Schema">
        <name>getMustAttrs</name>
        <full_name>\ObjectClass::getMustAttrs()</full_name>
        <docblock line="381">
          <description>Gets an array of AttributeType objects that entries of this ObjectClass must define.</description>
          <long-description>This differs from getMustAttrNames in that it returns an array of AttributeType objects</long-description>
          <tag name="param" description="&lt;p&gt;An array of ObjectClass objects to use when traversing&#10;            the inheritance tree. This presents some what of a bootstrapping problem&#10;            as we must fetch all objectClasses to determine through inheritance which&#10;            attributes this objectClass requires.&lt;/p&gt;" line="381" type="array" variable="$parents">
            <type>array</type>
          </tag>
          <tag name="return" description="The array of required AttributeType objects." line="381" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="381"/>
          <tag name="see" description="" line="381"/>
          <tag name="see" description="" line="381"/>
        </docblock>
        <argument line="0">
          <name>$parents</name>
          <default>false</default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="423" package="phpLDAPadmin\Schema">
        <name>getMayAttrs</name>
        <full_name>\ObjectClass::getMayAttrs()</full_name>
        <docblock line="423">
          <description>Gets an array of AttributeType objects that entries of this ObjectClass may define.</description>
          <long-description>This differs from getMayAttrNames in that it returns an array of AttributeType objects</long-description>
          <tag name="param" description="&lt;p&gt;An array of ObjectClass objects to use when traversing&#10;            the inheritance tree. This presents some what of a bootstrapping problem&#10;            as we must fetch all objectClasses to determine through inheritance which&#10;            attributes this objectClass provides.&lt;/p&gt;" line="423" type="array" variable="$parents">
            <type>array</type>
          </tag>
          <tag name="return" description="The array of allowed AttributeType objects." line="423" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="423"/>
          <tag name="see" description="" line="423"/>
          <tag name="see" description="" line="423"/>
          <tag name="see" description="" line="423"/>
        </docblock>
        <argument line="0">
          <name>$parents</name>
          <default>false</default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="450" package="phpLDAPadmin\Schema">
        <name>getForceMayAttrs</name>
        <full_name>\ObjectClass::getForceMayAttrs()</full_name>
        <docblock line="450">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="472" package="phpLDAPadmin\Schema">
        <name>getMustAttrNames</name>
        <full_name>\ObjectClass::getMustAttrNames()</full_name>
        <docblock line="472">
          <description>Gets an array of attribute names (strings) that entries of this ObjectClass must define.</description>
          <long-description>This differs from getMustAttrs in that it returns an array of strings rather than
array of AttributeType objects</long-description>
          <tag name="param" description="&lt;p&gt;An array of ObjectClass objects to use when traversing&#10;            the inheritance tree. This presents some what of a bootstrapping problem&#10;            as we must fetch all objectClasses to determine through inheritance which&#10;            attributes this objectClass provides.&lt;/p&gt;" line="472" type="array" variable="$parents">
            <type>array</type>
          </tag>
          <tag name="return" description="The array of allowed attribute names (strings)." line="472" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="472"/>
          <tag name="see" description="" line="472"/>
          <tag name="see" description="" line="472"/>
        </docblock>
        <argument line="0">
          <name>$parents</name>
          <default>false</default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="499" package="phpLDAPadmin\Schema">
        <name>getMayAttrNames</name>
        <full_name>\ObjectClass::getMayAttrNames()</full_name>
        <docblock line="499">
          <description>Gets an array of attribute names (strings) that entries of this ObjectClass must define.</description>
          <long-description>This differs from getMayAttrs in that it returns an array of strings rather than
array of AttributeType objects</long-description>
          <tag name="param" description="&lt;p&gt;An array of ObjectClass objects to use when traversing&#10;            the inheritance tree. This presents some what of a bootstrapping problem&#10;            as we must fetch all objectClasses to determine through inheritance which&#10;            attributes this objectClass provides.&lt;/p&gt;" line="499" type="array" variable="$parents">
            <type>array</type>
          </tag>
          <tag name="return" description="The array of allowed attribute names (strings)." line="499" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="499"/>
          <tag name="see" description="" line="499"/>
          <tag name="see" description="" line="499"/>
        </docblock>
        <argument line="0">
          <name>$parents</name>
          <default>false</default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="518" package="phpLDAPadmin\Schema">
        <name>addChildObjectClass</name>
        <full_name>\ObjectClass::addChildObjectClass()</full_name>
        <docblock line="518">
          <description>Adds an objectClass to the list of objectClasses that inherit
from this objectClass.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The name of the objectClass to add&lt;/p&gt;" line="518" type="String" variable="$name">
            <type>String</type>
          </tag>
          <tag name="return" description="Returns true on success or false on failure (objectclass already existed for example)" line="518" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="536" package="phpLDAPadmin\Schema">
        <name>getChildObjectClasses</name>
        <full_name>\ObjectClass::getChildObjectClasses()</full_name>
        <docblock line="536">
          <description>Returns the array of objectClass names which inherit from this objectClass.</description>
          <long-description></long-description>
          <tag name="return" description="Names of objectClasses which inherit from this objectClass." line="536" type="Array">
            <type>Array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="548" package="phpLDAPadmin\Schema">
        <name>getSupClasses</name>
        <full_name>\ObjectClass::getSupClasses()</full_name>
        <docblock line="548">
          <description>Gets the objectClass names from which this objectClass inherits.</description>
          <long-description></long-description>
          <tag name="return" description="An array of objectClass names (strings)" line="548" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="560" package="phpLDAPadmin\Schema">
        <name>isRelated</name>
        <full_name>\ObjectClass::isRelated()</full_name>
        <docblock line="560">
          <description>Return if this objectClass is related to $oclass</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;ObjectClasses that this attribute may be related to&lt;/p&gt;" line="560" type="array" variable="">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$oclass</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="583" package="phpLDAPadmin\Schema">
        <name>getType</name>
        <full_name>\ObjectClass::getType()</full_name>
        <docblock line="583">
          <description>Gets the type of this objectClass: STRUCTURAL, ABSTRACT, or AUXILIARY.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="597" package="phpLDAPadmin\Schema">
        <name>addMustAttrs</name>
        <full_name>\ObjectClass::addMustAttrs()</full_name>
        <docblock line="597">
          <description>Adds the specified array of attributes to this objectClass' list of
MUST attributes. The resulting array of must attributes will contain
unique members.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;An array of attribute names (strings) to add.&lt;/p&gt;&#10;" line="597" type="array" variable="$attr">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attr</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="613" package="phpLDAPadmin\Schema">
        <name>addMayAttrs</name>
        <full_name>\ObjectClass::addMayAttrs()</full_name>
        <docblock line="613">
          <description>Behaves identically to addMustAttrs, but it operates on the MAY
attributes of this objectClass.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;An array of attribute names (strings) to add.&lt;/p&gt;&#10;" line="613" type="array" variable="$attr">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attr</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="626" package="phpLDAPadmin\Schema">
        <name>isForceMay</name>
        <full_name>\ObjectClass::isForceMay()</full_name>
        <docblock line="626">
          <description>Determine if an array is listed in the force_may attrs</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attr</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="637" package="phpLDAPadmin\Schema">
        <name>isStructural</name>
        <full_name>\ObjectClass::isStructural()</full_name>
        <docblock line="637">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="661" package="phpLDAPadmin\Schema">
      <extends/>
      <name>ObjectClass_ObjectClassAttribute</name>
      <full_name>\ObjectClass_ObjectClassAttribute</full_name>
      <docblock line="661">
        <description>A simple class for representing AttributeTypes used only by the ObjectClass class.</description>
        <long-description>Users should never instantiate this class. It represents an attribute internal to
an ObjectClass. If PHP supported inner-classes and variable permissions, this would
be interior to class ObjectClass and flagged private. The reason this class is used
and not the "real" class AttributeType is because this class supports the notion of
a "source" objectClass, meaning that it keeps track of which objectClass originally
specified it. This class is therefore used by the class ObjectClass to determine
inheritance.</long-description>
        <tag name="package" description="phpLDAPadmin" line="661"/>
        <tag name="subpackage" description="Schema" line="661"/>
      </docblock>
      <property static="false" visibility="public" line="663" namespace="" package="phpLDAPadmin\Schema">
        <name>$name</name>
        <default></default>
        <docblock line="663">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="665" namespace="" package="phpLDAPadmin\Schema">
        <name>$source</name>
        <default></default>
        <docblock line="665">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="673" package="phpLDAPadmin\Schema">
        <name>__construct</name>
        <full_name>\ObjectClass_ObjectClassAttribute::__construct()</full_name>
        <docblock line="673">
          <description>Creates a new ObjectClass_ObjectClassAttribute with specified name and source objectClass.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;the name of the new attribute.&lt;/p&gt;" line="673" type="string" variable="$name">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;the name of the ObjectClass which specifies this attribute.&lt;/p&gt;" line="673" type="string" variable="$source">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$source</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="682" package="phpLDAPadmin\Schema">
        <name>getName</name>
        <full_name>\ObjectClass_ObjectClassAttribute::getName()</full_name>
        <docblock line="682">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$lower</name>
          <default>true</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="690" package="phpLDAPadmin\Schema">
        <name>getSource</name>
        <full_name>\ObjectClass_ObjectClassAttribute::getSource()</full_name>
        <docblock line="690">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="704" package="phpLDAPadmin\Schema">
      <extends>\SchemaItem</extends>
      <name>AttributeType</name>
      <full_name>\AttributeType</full_name>
      <docblock line="704">
        <description>Represents an LDAP AttributeType</description>
        <long-description>All schema items have at least two things in common: An OID
and a description. This class provides an implementation for
these two data.</long-description>
        <tag name="package" description="phpLDAPadmin" line="704"/>
        <tag name="subpackage" description="Schema" line="704"/>
      </docblock>
      <property static="false" visibility="private" line="706" namespace="" package="phpLDAPadmin\Schema">
        <name>$sup_attribute</name>
        <default>null</default>
        <docblock line="706">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="708" namespace="" package="phpLDAPadmin\Schema">
        <name>$equality</name>
        <default>null</default>
        <docblock line="708">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="710" namespace="" package="phpLDAPadmin\Schema">
        <name>$ordering</name>
        <default>null</default>
        <docblock line="710">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="712" namespace="" package="phpLDAPadmin\Schema">
        <name>$sub_str</name>
        <default>null</default>
        <docblock line="712">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="714" namespace="" package="phpLDAPadmin\Schema">
        <name>$syntax</name>
        <default>null</default>
        <docblock line="714">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="715" namespace="" package="phpLDAPadmin\Schema">
        <name>$syntax_oid</name>
        <default>null</default>
        <docblock line="715">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="717" namespace="" package="phpLDAPadmin\Schema">
        <name>$is_single_value</name>
        <default>false</default>
        <docblock line="717">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="719" namespace="" package="phpLDAPadmin\Schema">
        <name>$is_collective</name>
        <default>false</default>
        <docblock line="719">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="721" namespace="" package="phpLDAPadmin\Schema">
        <name>$is_no_user_modification</name>
        <default>false</default>
        <docblock line="721">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="723" namespace="" package="phpLDAPadmin\Schema">
        <name>$usage</name>
        <default>null</default>
        <docblock line="723">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="725" namespace="" package="phpLDAPadmin\Schema">
        <name>$aliases</name>
        <default>array()</default>
        <docblock line="725">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="727" namespace="" package="phpLDAPadmin\Schema">
        <name>$max_length</name>
        <default>null</default>
        <docblock line="727">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="729" namespace="" package="phpLDAPadmin\Schema">
        <name>$type</name>
        <default>null</default>
        <docblock line="729">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="731" namespace="" package="phpLDAPadmin\Schema">
        <name>$used_in_object_classes</name>
        <default>array()</default>
        <docblock line="731">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="733" namespace="" package="phpLDAPadmin\Schema">
        <name>$required_by_object_classes</name>
        <default>array()</default>
        <docblock line="733">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="735" namespace="" package="phpLDAPadmin\Schema">
        <name>$forced_as_may</name>
        <default>false</default>
        <docblock line="735">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="740" package="phpLDAPadmin\Schema">
        <name>__construct</name>
        <full_name>\AttributeType::__construct()</full_name>
        <docblock line="740">
          <description>Creates a new AttributeType object from a raw LDAP AttributeType string.</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attr</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="929" package="phpLDAPadmin\Schema">
        <name>getUsage</name>
        <full_name>\AttributeType::getUsage()</full_name>
        <docblock line="929">
          <description>Gets this attribute's usage string as defined by the LDAP server</description>
          <long-description></long-description>
          <tag name="return" description="" line="929" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="942" package="phpLDAPadmin\Schema">
        <name>getSupAttribute</name>
        <full_name>\AttributeType::getSupAttribute()</full_name>
        <docblock line="942">
          <description>Gets this attribute's parent attribute (if any). If this attribute does not
inherit from another attribute, null is returned.</description>
          <long-description></long-description>
          <tag name="return" description="" line="942" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="954" package="phpLDAPadmin\Schema">
        <name>getEquality</name>
        <full_name>\AttributeType::getEquality()</full_name>
        <docblock line="954">
          <description>Gets this attribute's equality string</description>
          <long-description></long-description>
          <tag name="return" description="" line="954" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="966" package="phpLDAPadmin\Schema">
        <name>getOrdering</name>
        <full_name>\AttributeType::getOrdering()</full_name>
        <docblock line="966">
          <description>Gets this attribute's ordering specification.</description>
          <long-description></long-description>
          <tag name="return" description="" line="966" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="978" package="phpLDAPadmin\Schema">
        <name>getSubstr</name>
        <full_name>\AttributeType::getSubstr()</full_name>
        <docblock line="978">
          <description>Gets this attribute's substring matching specification</description>
          <long-description></long-description>
          <tag name="return" description="" line="978" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="991" package="phpLDAPadmin\Schema">
        <name>getAliases</name>
        <full_name>\AttributeType::getAliases()</full_name>
        <docblock line="991">
          <description>Gets the names of attributes that are an alias for this attribute (if any).</description>
          <long-description></long-description>
          <tag name="return" description="An array of names of attributes which alias this attribute or&#10;         an empty array if no attribute aliases this object." line="991" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1004" package="phpLDAPadmin\Schema">
        <name>isAliasFor</name>
        <full_name>\AttributeType::isAliasFor()</full_name>
        <docblock line="1004">
          <description>Returns whether the specified attribute is an alias for this one (based on this attribute's alias list).</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The name of the attribute to check.&lt;/p&gt;" line="1004" type="string" variable="$attr_name">
            <type>string</type>
          </tag>
          <tag name="return" description="True if the specified attribute is an alias for this one, or false otherwise." line="1004" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attr_name</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1020" package="phpLDAPadmin\Schema">
        <name>getSyntaxString</name>
        <full_name>\AttributeType::getSyntaxString()</full_name>
        <docblock line="1020">
          <description>Gets this attribute's raw syntax string (ie: "1.2.3.4{16}").</description>
          <long-description></long-description>
          <tag name="return" description="The raw syntax string" line="1020" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1035" package="phpLDAPadmin\Schema">
        <name>getSyntaxOID</name>
        <full_name>\AttributeType::getSyntaxOID()</full_name>
        <docblock line="1035">
          <description>Gets this attribute's syntax OID. Differs from getSyntaxString() in that this
function only returns the actual OID with any length specification removed.</description>
          <long-description>Ie, if the syntax string is "1.2.3.4{16}", this function only retruns
"1.2.3.4".</long-description>
          <tag name="return" description="The syntax OID string." line="1035" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1047" package="phpLDAPadmin\Schema">
        <name>getMaxLength</name>
        <full_name>\AttributeType::getMaxLength()</full_name>
        <docblock line="1047">
          <description>Gets this attribute's the maximum length. If no maximum is defined by the LDAP server, null is returned.</description>
          <long-description></long-description>
          <tag name="return" description="The maximum length (in characters) of this attribute or null if no maximum is specified." line="1047" type="int">
            <type>int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1060" package="phpLDAPadmin\Schema">
        <name>getIsSingleValue</name>
        <full_name>\AttributeType::getIsSingleValue()</full_name>
        <docblock line="1060">
          <description>Gets whether this attribute is single-valued. If this attribute only supports single values, true
is returned. If this attribute supports multiple values, false is returned.</description>
          <long-description></long-description>
          <tag name="return" description="Returns true if this attribute is single-valued or false otherwise." line="1060" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1072" package="phpLDAPadmin\Schema">
        <name>setIsSingleValue</name>
        <full_name>\AttributeType::setIsSingleValue()</full_name>
        <docblock line="1072">
          <description>Sets whether this attribute is single-valued.</description>
          <long-description></long-description>
          <tag name="param" description="" line="1072" type="boolean" variable="$is">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$is</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1084" package="phpLDAPadmin\Schema">
        <name>getIsCollective</name>
        <full_name>\AttributeType::getIsCollective()</full_name>
        <docblock line="1084">
          <description>Gets whether this attribute is collective.</description>
          <long-description></long-description>
          <tag name="return" description="Returns true if this attribute is collective and false otherwise." line="1084" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1096" package="phpLDAPadmin\Schema">
        <name>getIsNoUserModification</name>
        <full_name>\AttributeType::getIsNoUserModification()</full_name>
        <docblock line="1096">
          <description>Gets whether this attribute is not modifiable by users.</description>
          <long-description></long-description>
          <tag name="return" description="Returns true if this attribute is not modifiable by users." line="1096" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1108" package="phpLDAPadmin\Schema">
        <name>getType</name>
        <full_name>\AttributeType::getType()</full_name>
        <docblock line="1108">
          <description>Gets this attribute's type</description>
          <long-description></long-description>
          <tag name="return" description="The attribute&amp;#039;s type." line="1108" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1122" package="phpLDAPadmin\Schema">
        <name>removeAlias</name>
        <full_name>\AttributeType::removeAlias()</full_name>
        <docblock line="1122">
          <description>Removes an attribute name from this attribute's alias array.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The name of the attribute to remove.&lt;/p&gt;" line="1122" type="string" variable="$remove_alias_name">
            <type>string</type>
          </tag>
          <tag name="return" description="true on success or false on failure (ie, if the specified&#10;          attribute name is not found in this attribute&amp;#039;s list of aliases)" line="1122" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$remove_alias_name</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1143" package="phpLDAPadmin\Schema">
        <name>addAlias</name>
        <full_name>\AttributeType::addAlias()</full_name>
        <docblock line="1143">
          <description>Adds an attribute name to the alias array.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The name of a new attribute to add to this attribute's list of aliases.&lt;/p&gt;" line="1143" type="string" variable="$alias">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$alias</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1155" package="phpLDAPadmin\Schema">
        <name>setName</name>
        <full_name>\AttributeType::setName()</full_name>
        <docblock line="1155">
          <description>Sets this attriute's name.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The new name to give this attribute.&lt;/p&gt;" line="1155" type="string" variable="$name">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1167" package="phpLDAPadmin\Schema">
        <name>setSupAttribute</name>
        <full_name>\AttributeType::setSupAttribute()</full_name>
        <docblock line="1167">
          <description>Sets this attriute's SUP attribute (ie, the attribute from which this attribute inherits).</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The name of the new parent (SUP) attribute&lt;/p&gt;&#10;" line="1167" type="string" variable="$attr">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attr</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1179" package="phpLDAPadmin\Schema">
        <name>setAliases</name>
        <full_name>\AttributeType::setAliases()</full_name>
        <docblock line="1179">
          <description>Sets this attribute's list of aliases.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The array of alias names (strings)&lt;/p&gt;&#10;" line="1179" type="array" variable="$aliases">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$aliases</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1191" package="phpLDAPadmin\Schema">
        <name>setType</name>
        <full_name>\AttributeType::setType()</full_name>
        <docblock line="1191">
          <description>Sets this attribute's type.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The new type.&lt;/p&gt;" line="1191" type="string" variable="$type">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$type</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1204" package="phpLDAPadmin\Schema">
        <name>addUsedInObjectClass</name>
        <full_name>\AttributeType::addUsedInObjectClass()</full_name>
        <docblock line="1204">
          <description>Adds an objectClass name to this attribute's list of "used in" objectClasses,
that is the list of objectClasses which provide this attribute.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The name of the objectClass to add.&lt;/p&gt;" line="1204" type="string" variable="$name">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1225" package="phpLDAPadmin\Schema">
        <name>getUsedInObjectClasses</name>
        <full_name>\AttributeType::getUsedInObjectClasses()</full_name>
        <docblock line="1225">
          <description>Gets the list of "used in" objectClasses, that is the list of objectClasses
which provide this attribute.</description>
          <long-description></long-description>
          <tag name="return" description="An array of names of objectclasses (strings) which provide this attribute" line="1225" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1238" package="phpLDAPadmin\Schema">
        <name>addRequiredByObjectClass</name>
        <full_name>\AttributeType::addRequiredByObjectClass()</full_name>
        <docblock line="1238">
          <description>Adds an objectClass name to this attribute's list of "required by" objectClasses,
that is the list of objectClasses which must have this attribute.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The name of the objectClass to add.&lt;/p&gt;" line="1238" type="string" variable="$name">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1255" package="phpLDAPadmin\Schema">
        <name>getRequiredByObjectClasses</name>
        <full_name>\AttributeType::getRequiredByObjectClasses()</full_name>
        <docblock line="1255">
          <description>Gets the list of "required by" objectClasses, that is the list of objectClasses
which provide must have attribute.</description>
          <long-description></long-description>
          <tag name="return" description="An array of names of objectclasses (strings) which provide this attribute" line="1255" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1265" package="phpLDAPadmin\Schema">
        <name>setForceMay</name>
        <full_name>\AttributeType::setForceMay()</full_name>
        <docblock line="1265">
          <description>This function will mark this attribute as a forced MAY attribute</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1272" package="phpLDAPadmin\Schema">
        <name>isForceMay</name>
        <full_name>\AttributeType::isForceMay()</full_name>
        <docblock line="1272">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="1286" package="phpLDAPadmin\Schema">
      <extends>\SchemaItem</extends>
      <name>Syntax</name>
      <full_name>\Syntax</full_name>
      <docblock line="1286">
        <description>Represents an LDAP Syntax</description>
        <long-description>All schema items have at least two things in common: An OID
and a description. This class provides an implementation for
these two data.</long-description>
        <tag name="package" description="phpLDAPadmin" line="1286"/>
        <tag name="subpackage" description="Schema" line="1286"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1290" package="phpLDAPadmin\Schema">
        <name>__construct</name>
        <full_name>\Syntax::__construct()</full_name>
        <docblock line="1290">
          <description>Creates a new Syntax object from a raw LDAP syntax string.</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$class</name>
          <default></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="1328" package="phpLDAPadmin\Schema">
      <extends>\SchemaItem</extends>
      <name>MatchingRule</name>
      <full_name>\MatchingRule</full_name>
      <docblock line="1328">
        <description>Represents an LDAP MatchingRule</description>
        <long-description>All schema items have at least two things in common: An OID
and a description. This class provides an implementation for
these two data.</long-description>
        <tag name="package" description="phpLDAPadmin" line="1328"/>
        <tag name="subpackage" description="Schema" line="1328"/>
      </docblock>
      <property static="false" visibility="private" line="1330" namespace="" package="phpLDAPadmin\Schema">
        <name>$syntax</name>
        <default>null</default>
        <docblock line="1330">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="1332" namespace="" package="phpLDAPadmin\Schema">
        <name>$used_by_attrs</name>
        <default>array()</default>
        <docblock line="1332">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1337" package="phpLDAPadmin\Schema">
        <name>__construct</name>
        <full_name>\MatchingRule::__construct()</full_name>
        <docblock line="1337">
          <description>Creates a new MatchingRule object from a raw LDAP MatchingRule string.</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$strings</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1409" package="phpLDAPadmin\Schema">
        <name>setUsedByAttrs</name>
        <full_name>\MatchingRule::setUsedByAttrs()</full_name>
        <docblock line="1409">
          <description>Sets the list of used_by_attrs to the array specified by $attrs;</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The array of attribute names (strings) which use this MatchingRule&lt;/p&gt;&#10;" line="1409" type="array" variable="$attrs">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attrs</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1421" package="phpLDAPadmin\Schema">
        <name>addUsedByAttr</name>
        <full_name>\MatchingRule::addUsedByAttr()</full_name>
        <docblock line="1421">
          <description>Adds an attribute name to the list of attributes who use this MatchingRule</description>
          <long-description></long-description>
          <tag name="return" description="if the attribute was added and false otherwise (already in the list)" line="1421" type="true">
            <type>true</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attr</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1439" package="phpLDAPadmin\Schema">
        <name>getUsedByAttrs</name>
        <full_name>\MatchingRule::getUsedByAttrs()</full_name>
        <docblock line="1439">
          <description>Gets an array of attribute names (strings) which use this MatchingRule</description>
          <long-description></long-description>
          <tag name="return" description="The array of attribute names (strings)." line="1439" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="1453" package="phpLDAPadmin\Schema">
      <extends>\SchemaItem</extends>
      <name>MatchingRuleUse</name>
      <full_name>\MatchingRuleUse</full_name>
      <docblock line="1453">
        <description>Represents an LDAP schema matchingRuleUse entry</description>
        <long-description>All schema items have at least two things in common: An OID
and a description. This class provides an implementation for
these two data.</long-description>
        <tag name="package" description="phpLDAPadmin" line="1453"/>
        <tag name="subpackage" description="Schema" line="1453"/>
      </docblock>
      <property static="false" visibility="private" line="1455" namespace="" package="phpLDAPadmin\Schema">
        <name>$used_by_attrs</name>
        <default>array()</default>
        <docblock line="1455">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1457" package="phpLDAPadmin\Schema">
        <name>__construct</name>
        <full_name>\MatchingRuleUse::__construct()</full_name>
        <docblock line="1457">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$strings</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1532" package="phpLDAPadmin\Schema">
        <name>getUsedByAttrs</name>
        <full_name>\MatchingRuleUse::getUsedByAttrs()</full_name>
        <docblock line="1532">
          <description>Gets an array of attribute names (strings) which use this MatchingRuleUse object.</description>
          <long-description></long-description>
          <tag name="return" description="The array of attribute names (strings)." line="1532" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/AttributeFactory.php" generated-path="templates.3rdParty.pla.lib.AttributeFactory.html" hash="162422f3ced3b75e79222fd08283fd5b" package="phpLDAPadmin">
    <docblock line="0">
      <description>Allows to create new attributes</description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="15" package="phpLDAPadmin\Templates">
      <extends/>
      <name>AttributeFactory</name>
      <full_name>\AttributeFactory</full_name>
      <docblock line="15">
        <description>AttributeFactory Class</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="15"/>
        <tag name="subpackage" description="Templates" line="15"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="16" package="phpLDAPadmin\Templates">
        <name>newAttribute</name>
        <full_name>\AttributeFactory::newAttribute()</full_name>
        <docblock line="16">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$server_id</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$source</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="140" package="phpLDAPadmin\Templates">
        <name>newJpegAttribute</name>
        <full_name>\AttributeFactory::newJpegAttribute()</full_name>
        <docblock line="140">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$server_id</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$source</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="144" package="phpLDAPadmin\Templates">
        <name>newBinaryAttribute</name>
        <full_name>\AttributeFactory::newBinaryAttribute()</full_name>
        <docblock line="144">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$server_id</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$source</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="148" package="phpLDAPadmin\Templates">
        <name>newPasswordAttribute</name>
        <full_name>\AttributeFactory::newPasswordAttribute()</full_name>
        <docblock line="148">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$server_id</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$source</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="152" package="phpLDAPadmin\Templates">
        <name>newSambaPasswordAttribute</name>
        <full_name>\AttributeFactory::newSambaPasswordAttribute()</full_name>
        <docblock line="152">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$server_id</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$source</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="156" package="phpLDAPadmin\Templates">
        <name>newRandomPasswordAttribute</name>
        <full_name>\AttributeFactory::newRandomPasswordAttribute()</full_name>
        <docblock line="156">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$server_id</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$source</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="160" package="phpLDAPadmin\Templates">
        <name>newShadowAttribute</name>
        <full_name>\AttributeFactory::newShadowAttribute()</full_name>
        <docblock line="160">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$server_id</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$source</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="164" package="phpLDAPadmin\Templates">
        <name>newSelectionAttribute</name>
        <full_name>\AttributeFactory::newSelectionAttribute()</full_name>
        <docblock line="164">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$server_id</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$source</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="168" package="phpLDAPadmin\Templates">
        <name>newMultiLineAttribute</name>
        <full_name>\AttributeFactory::newMultiLineAttribute()</full_name>
        <docblock line="168">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$server_id</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$source</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="172" package="phpLDAPadmin\Templates">
        <name>newDateAttribute</name>
        <full_name>\AttributeFactory::newDateAttribute()</full_name>
        <docblock line="172">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$server_id</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$source</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="176" package="phpLDAPadmin\Templates">
        <name>newObjectClassAttribute</name>
        <full_name>\AttributeFactory::newObjectClassAttribute()</full_name>
        <docblock line="176">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$server_id</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$source</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="180" package="phpLDAPadmin\Templates">
        <name>newDnAttribute</name>
        <full_name>\AttributeFactory::newDnAttribute()</full_name>
        <docblock line="180">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$server_id</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$source</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="184" package="phpLDAPadmin\Templates">
        <name>newGidAttribute</name>
        <full_name>\AttributeFactory::newGidAttribute()</full_name>
        <docblock line="184">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$server_id</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$source</name>
          <default></default>
          <type/>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/Visitor.php" generated-path="templates.3rdParty.pla.lib.Visitor.html" hash="7bd83a1767035e2100fba12533584932" package="phpLDAPadmin">
    <docblock line="0">
      <description>Classes and functions for the template engines.</description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <constant namespace="" line="11" package="phpLDAPadmin">
      <name>DEBUGTMP</name>
      <full_name>\\DEBUGTMP</full_name>
      <value>0</value>
      <docblock line="11">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="12" package="phpLDAPadmin">
      <name>DEBUGTMPSUB</name>
      <full_name>\\DEBUGTMPSUB</full_name>
      <value>0</value>
      <docblock line="12">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <class final="false" abstract="true" namespace="" line="20" package="phpLDAPadmin\Templates">
      <extends/>
      <name>Visitor</name>
      <full_name>\Visitor</full_name>
      <docblock line="20">
        <description>Abstract Visitor class</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="20"/>
        <tag name="subpackage" description="Templates" line="20"/>
      </docblock>
      <property static="false" visibility="protected" line="22" namespace="" package="phpLDAPadmin\Templates">
        <name>$server_id</name>
        <default></default>
        <docblock line="22">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="24" package="phpLDAPadmin\Templates">
        <name>__call</name>
        <full_name>\Visitor::__call()</full_name>
        <docblock line="24">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$method</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$args</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="77" package="phpLDAPadmin\Templates">
        <name>getServerID</name>
        <full_name>\Visitor::getServerID()</full_name>
        <docblock line="77">
          <description>Return the LDAP server ID</description>
          <long-description></long-description>
          <tag name="return" description="Server ID" line="77" type="int">
            <type>int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="92" package="phpLDAPadmin\Templates">
        <name>getServer</name>
        <full_name>\Visitor::getServer()</full_name>
        <docblock line="92">
          <description>Return this LDAP Server object</description>
          <long-description></long-description>
          <tag name="return" description="DataStore Server" line="92" type="object">
            <type>object</type>
          </tag>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/PasswordAttribute.php" generated-path="templates.3rdParty.pla.lib.PasswordAttribute.html" hash="be1c3029de777796b93beec93417d30d" package="phpLDAPadmin">
    <docblock line="0">
      <description>Classes and functions for the template engine.</description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="15" package="phpLDAPadmin\Templates">
      <extends>\Attribute</extends>
      <name>PasswordAttribute</name>
      <full_name>\PasswordAttribute</full_name>
      <docblock line="15">
        <description>Represents an attribute whose values are passwords</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="15"/>
        <tag name="subpackage" description="Templates" line="15"/>
      </docblock>
    </class>
    <source>eJx1j00OgkAMhfdziq5Z6AWMYHTpghguUJkqRJiZTDtoYry7hYDGhdv2/Xxvk4cmmHWWGchg3yEzMaCzcEmultY7houPIA2BUB86FAJy19bRSh2jqcAkjUoqlWjW8bAr0fatA0sDdT705ES92E/igPUNr79KfazNwnCiEInVM2IAisT2nLT03ngmGLBLI2DUBGW9+2h54fgTDQWn8/Kr5g08ddbjXijnoN2nix5CzjJ8L0/zMvnWvAF+lmRM</source>
  </file>
  <file path="templates/3rdParty/pla/lib/xml2array.php" generated-path="templates.3rdParty.pla.lib.xml2array.html" hash="531f5794f35c89be942c71479e925bd6" package="phpLDAPadmin">
    <docblock line="0">
      <description>Classes and functions for manipulating XML templates.</description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="17" package="phpLDAPadmin\XML">
      <extends/>
      <name>xml2array</name>
      <full_name>\xml2array</full_name>
      <docblock line="17">
        <description>XML Parser</description>
        <long-description>This will read our XML file and convert it into variables for us to parse.</long-description>
        <tag name="package" description="phpLDAPadmin" line="17"/>
        <tag name="subpackage" description="XML" line="17"/>
      </docblock>
      <property static="false" visibility="public" line="18" namespace="" package="phpLDAPadmin\XML">
        <name>$stack</name>
        <default>array()</default>
        <docblock line="18">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="19" namespace="" package="phpLDAPadmin\XML">
        <name>$stack_ref</name>
        <default></default>
        <docblock line="19">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="20" namespace="" package="phpLDAPadmin\XML">
        <name>$arrOutput</name>
        <default>array()</default>
        <docblock line="20">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="21" namespace="" package="phpLDAPadmin\XML">
        <name>$resParser</name>
        <default></default>
        <docblock line="21">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="22" namespace="" package="phpLDAPadmin\XML">
        <name>$strXmlData</name>
        <default></default>
        <docblock line="22">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="24" package="phpLDAPadmin\XML">
        <name>push_pos</name>
        <full_name>\xml2array::push_pos()</full_name>
        <docblock line="24">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$pos</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="29" package="phpLDAPadmin\XML">
        <name>pop_pos</name>
        <full_name>\xml2array::pop_pos()</full_name>
        <docblock line="29">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="34" package="phpLDAPadmin\XML">
        <name>parseXML</name>
        <full_name>\xml2array::parseXML()</full_name>
        <docblock line="34">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$strInputXML</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$filename</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="61" package="phpLDAPadmin\XML">
        <name>tagOpen</name>
        <full_name>\xml2array::tagOpen()</full_name>
        <docblock line="61">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$parser</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$attrs</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="88" package="phpLDAPadmin\XML">
        <name>tagData</name>
        <full_name>\xml2array::tagData()</full_name>
        <docblock line="88">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$parser</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$tagData</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="98" package="phpLDAPadmin\XML">
        <name>tagClosed</name>
        <full_name>\xml2array::tagClosed()</full_name>
        <docblock line="98">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$parser</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="107" package="phpLDAPadmin\XML">
        <name>cleanXML</name>
        <full_name>\xml2array::cleanXML()</full_name>
        <docblock line="107">
          <description>This function will parse an XML array and make a normal array.</description>
          <long-description></long-description>
          <tag name="return" description="- Clean XML data" line="107" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$details</name>
          <default></default>
          <type/>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/page.php" generated-path="templates.3rdParty.pla.lib.page.html" hash="697221bdddeb3a4c6e8cda1c8064467b" package="phpLDAPadmin">
    <docblock line="0">
      <description>Page Rendering Functions</description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <constant namespace="" line="34" package="phpLDAPadmin">
      <name>IMGDIR</name>
      <full_name>\\IMGDIR</full_name>
      <value>'images/default'</value>
      <docblock line="34">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="36" package="phpLDAPadmin">
      <name>CSSDIR</name>
      <full_name>\\CSSDIR</full_name>
      <value>'css/default'</value>
      <docblock line="36">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <class final="false" abstract="false" namespace="" line="15" package="phpLDAPadmin\Page">
      <extends/>
      <name>page</name>
      <full_name>\page</full_name>
      <docblock line="15">
        <description>This class controls the final output to the browser.</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="15"/>
        <tag name="subpackage" description="Page" line="15"/>
      </docblock>
      <property static="false" visibility="protected" line="17" namespace="" package="phpLDAPadmin\Page">
        <name>$_pageheader</name>
        <default></default>
        <docblock line="17">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="20" namespace="" package="phpLDAPadmin\Page">
        <name>$_head</name>
        <default></default>
        <docblock line="20">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="23" namespace="" package="phpLDAPadmin\Page">
        <name>$_app</name>
        <default></default>
        <docblock line="23">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="26" namespace="" package="phpLDAPadmin\Page">
        <name>$_default</name>
        <default></default>
        <docblock line="26">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="28" package="phpLDAPadmin\Page">
        <name>__construct</name>
        <full_name>\page::__construct()</full_name>
        <docblock line="28">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$index</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="87" package="phpLDAPadmin\Page">
        <name>head_add</name>
        <full_name>\page::head_add()</full_name>
        <docblock line="87">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$html</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="95" package="phpLDAPadmin\Page">
        <name>pageheader_print</name>
        <full_name>\page::pageheader_print()</full_name>
        <docblock line="95">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="141" package="phpLDAPadmin\Page">
        <name>head_print</name>
        <full_name>\page::head_print()</full_name>
        <docblock line="141">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="177" package="phpLDAPadmin\Page">
        <name>control_print</name>
        <full_name>\page::control_print()</full_name>
        <docblock line="177">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="205" package="phpLDAPadmin\Page">
        <name>tree</name>
        <full_name>\page::tree()</full_name>
        <docblock line="205">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="234" package="phpLDAPadmin\Page">
        <name>block_add</name>
        <full_name>\page::block_add()</full_name>
        <docblock line="234">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$side</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$object</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="244" package="phpLDAPadmin\Page">
        <name>block_print</name>
        <full_name>\page::block_print()</full_name>
        <docblock line="244">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$side</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="257" package="phpLDAPadmin\Page">
        <name>sysmsg</name>
        <full_name>\page::sysmsg()</full_name>
        <docblock line="257">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="295" package="phpLDAPadmin\Page">
        <name>body</name>
        <full_name>\page::body()</full_name>
        <docblock line="295">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$raw</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="319" package="phpLDAPadmin\Page">
        <name>footer_print</name>
        <full_name>\page::footer_print()</full_name>
        <docblock line="319">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="332" package="phpLDAPadmin\Page">
        <name>show</name>
        <full_name>\page::show()</full_name>
        <docblock line="332">
          <description>Only show a particular page frame - used by an AJAX call</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$frame</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$compress</name>
          <default>false</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$raw</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="367" package="phpLDAPadmin\Page">
        <name>display</name>
        <full_name>\page::display()</full_name>
        <docblock line="367">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$filter</name>
          <default>array()</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="445" package="phpLDAPadmin\Page">
        <name>setsysmsg</name>
        <full_name>\page::setsysmsg()</full_name>
        <docblock line="445">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$data</name>
          <default></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="469" package="phpLDAPadmin\Page">
      <extends/>
      <name>block</name>
      <full_name>\block</full_name>
      <docblock line="469">
        <description>This class draws a block.</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="469"/>
        <tag name="subpackage" description="Page" line="469"/>
      </docblock>
      <property static="false" visibility="private" line="470" namespace="" package="phpLDAPadmin\Page">
        <name>$title</name>
        <default></default>
        <docblock line="470">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="471" namespace="" package="phpLDAPadmin\Page">
        <name>$body</name>
        <default></default>
        <docblock line="471">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="472" namespace="" package="phpLDAPadmin\Page">
        <name>$foot</name>
        <default></default>
        <docblock line="472">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="474" package="phpLDAPadmin\Page">
        <name>setTitle</name>
        <full_name>\block::setTitle()</full_name>
        <docblock line="474">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$html</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="478" package="phpLDAPadmin\Page">
        <name>setBody</name>
        <full_name>\block::setBody()</full_name>
        <docblock line="478">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$html</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="482" package="phpLDAPadmin\Page">
        <name>setFooter</name>
        <full_name>\block::setFooter()</full_name>
        <docblock line="482">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$html</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="486" package="phpLDAPadmin\Page">
        <name>draw</name>
        <full_name>\block::draw()</full_name>
        <docblock line="486">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$side</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$raw</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/Template.php" generated-path="templates.3rdParty.pla.lib.Template.html" hash="d86cc8d531fe02304118796bf9d2ac52" package="phpLDAPadmin">
    <docblock line="0">
      <description>Classes and functions for the template engine.</description>
      <long-description>Templates are either:
+ Creating or Editing, (a Container or DN passed to the object)
+ A predefined template, or a default template (template ID passed to the object)

The template object will know which attributes are mandatory (MUST
attributes) and which attributes are optional (MAY attributes). It will also
contain a list of optional attributes. These are attributes that the schema
will allow data for (they are MAY attributes), but the template has not
included a definition for them.

The template object will be invalidated if it does contain the necessary
items (objectClass, MUST attributes, etc) to make a successful LDAP update.</long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="31" package="phpLDAPadmin\Templates">
      <extends>\xmlTemplate</extends>
      <name>Template</name>
      <full_name>\Template</full_name>
      <docblock line="31">
        <description>Template Class</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="31"/>
        <tag name="subpackage" description="Templates" line="31"/>
        <tag name="todo" description="RDN attributes should be treated as MUST attributes even though the schema marks them as MAY" line="31"/>
        <tag name="todo" description="RDN attributes need to be checked that are included in the schema, otherwise mark it is invalid" line="31"/>
        <tag name="todo" description="askcontainer is no longer used?" line="31"/>
      </docblock>
      <property static="false" visibility="private" line="33" namespace="" package="phpLDAPadmin\Templates">
        <name>$visible</name>
        <default>true</default>
        <docblock line="33">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="35" namespace="" package="phpLDAPadmin\Templates">
        <name>$invalid</name>
        <default>false</default>
        <docblock line="35">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="36" namespace="" package="phpLDAPadmin\Templates">
        <name>$invalid_admin</name>
        <default>false</default>
        <docblock line="36">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="37" namespace="" package="phpLDAPadmin\Templates">
        <name>$invalid_reason</name>
        <default></default>
        <docblock line="37">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="39" namespace="" package="phpLDAPadmin\Templates">
        <name>$structural_oclass</name>
        <default>array()</default>
        <docblock line="39">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="40" namespace="" package="phpLDAPadmin\Templates">
        <name>$description</name>
        <default>''</default>
        <docblock line="40">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="42" namespace="" package="phpLDAPadmin\Templates">
        <name>$readonly</name>
        <default>false</default>
        <docblock line="42">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="45" namespace="" package="phpLDAPadmin\Templates">
        <name>$dn</name>
        <default></default>
        <docblock line="45">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="47" namespace="" package="phpLDAPadmin\Templates">
        <name>$container</name>
        <default></default>
        <docblock line="47">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="49" namespace="" package="phpLDAPadmin\Templates">
        <name>$noleaf</name>
        <default>false</default>
        <docblock line="49">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="51" namespace="" package="phpLDAPadmin\Templates">
        <name>$regexp</name>
        <default></default>
        <docblock line="51">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="53" namespace="" package="phpLDAPadmin\Templates">
        <name>$title</name>
        <default></default>
        <docblock line="53">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="55" namespace="" package="phpLDAPadmin\Templates">
        <name>$icon</name>
        <default></default>
        <docblock line="55">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="57" namespace="" package="phpLDAPadmin\Templates">
        <name>$rdn</name>
        <default></default>
        <docblock line="57">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="59" package="phpLDAPadmin\Templates">
        <name>__construct</name>
        <full_name>\Template::__construct()</full_name>
        <docblock line="59">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$server_id</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$name</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$filename</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$type</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$id</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="67" package="phpLDAPadmin\Templates">
        <name>__clone</name>
        <full_name>\Template::__clone()</full_name>
        <docblock line="67">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="81" package="phpLDAPadmin\Templates">
        <name>storeTemplate</name>
        <full_name>\Template::storeTemplate()</full_name>
        <docblock line="81">
          <description>Main processing to store the template.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Parsed xmldata from xml2array object&lt;/p&gt;" line="81" type="\xmldata" variable="">
            <type>\xmldata</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$xmldata</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="229" package="phpLDAPadmin\Templates">
        <name>hasDefaultTemplate</name>
        <full_name>\Template::hasDefaultTemplate()</full_name>
        <docblock line="229">
          <description>Is default templates enabled?
This will disable the default template from the engine.</description>
          <long-description></long-description>
          <tag name="return" description="" line="229" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="245" package="phpLDAPadmin\Templates">
        <name>readTemplates</name>
        <full_name>\Template::readTemplates()</full_name>
        <docblock line="245">
          <description>Return the templates of type (creation/modification)</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;type - creation/modification&lt;/p&gt;&#10;" line="245" type="" variable="$string"/>
          <tag name="return" description="- Array of templates of that type" line="245" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$type</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="261" package="phpLDAPadmin\Templates">
        <name>accept</name>
        <full_name>\Template::accept()</full_name>
        <docblock line="261">
          <description>This function will perform the following intialisation steps:
+ If a DN is set, query the ldap and load the object
+ Read our $_REQUEST variable and set the values
After this action, the template should self describe as to whether it is an update, create
or delete.</description>
          <long-description>(OLD values are IGNORED, we will have got them when we build this object from the LDAP server DN.)</long-description>
        </docblock>
        <argument line="0">
          <name>$makeVisible</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="573" package="phpLDAPadmin\Templates">
        <name>setDN</name>
        <full_name>\Template::setDN()</full_name>
        <docblock line="573">
          <description>Set the DN for this template, if we are editing entries</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The DN of the entry&lt;/p&gt;" line="573" type="\dn" variable="">
            <type>\dn</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="594" package="phpLDAPadmin\Templates">
        <name>setRDNAttributes</name>
        <full_name>\Template::setRDNAttributes()</full_name>
        <docblock line="594">
          <description>Set the RDN attributes
Given an RDN, mark the attributes as RDN attributes. If there is no defined attribute,
then the remaining RDNs will be returned.</description>
          <long-description></long-description>
          <tag name="param" description="" line="594" type="\RDN" variable="">
            <type>\RDN</type>
          </tag>
          <tag name="return" description="attributes not processed" line="594" type="\RDN">
            <type>\RDN</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rdn</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="621" package="phpLDAPadmin\Templates">
        <name>getDN</name>
        <full_name>\Template::getDN()</full_name>
        <docblock line="621">
          <description>Display the DN for this template entry. If the DN is not set (creating a new entry), then
a generated DN will be produced, taken from the RDN and the CONTAINER details.</description>
          <long-description></long-description>
          <tag name="return" description="" line="621" type="\dn">
            <type>\dn</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="637" package="phpLDAPadmin\Templates">
        <name>getDNEncode</name>
        <full_name>\Template::getDNEncode()</full_name>
        <docblock line="637">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$url</name>
          <default>true</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="651" package="phpLDAPadmin\Templates">
        <name>setContainer</name>
        <full_name>\Template::setContainer()</full_name>
        <docblock line="651">
          <description>Set the container for this template, if we are creating entries</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The DN of the container&lt;/p&gt;" line="651" type="\dn" variable="">
            <type>\dn</type>
          </tag>
          <tag name="todo" description="Trigger a query to the LDAP server and generate an error if the container doesnt exist" line="651"/>
        </docblock>
        <argument line="0">
          <name>$container</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="669" package="phpLDAPadmin\Templates">
        <name>getContainer</name>
        <full_name>\Template::getContainer()</full_name>
        <docblock line="669">
          <description>Get the DN of the container for this entry</description>
          <long-description></long-description>
          <tag name="return" description="DN of the container" line="669" type="\dn">
            <type>\dn</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="676" package="phpLDAPadmin\Templates">
        <name>getContainerEncode</name>
        <full_name>\Template::getContainerEncode()</full_name>
        <docblock line="676">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$url</name>
          <default>true</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="687" package="phpLDAPadmin\Templates">
        <name>copy</name>
        <full_name>\Template::copy()</full_name>
        <docblock line="687">
          <description>Copy a DN</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$template</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$rdn</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$asnew</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="757" package="phpLDAPadmin\Templates">
        <name>getAttrbyLdapType</name>
        <full_name>\Template::getAttrbyLdapType()</full_name>
        <docblock line="757">
          <description>Get Attributes by LDAP type
This function will return a list of attributes by LDAP type (MUST,MAY).</description>
          <long-description></long-description>
          <tag name="return" description="Array of attributes." line="757" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$type</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="774" package="phpLDAPadmin\Templates">
        <name>isAttrType</name>
        <full_name>\Template::isAttrType()</full_name>
        <docblock line="774">
          <description>Return true if this is a MUST,MAY attribute</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attr</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$type</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="789" package="phpLDAPadmin\Templates">
        <name>getRDNObjects</name>
        <full_name>\Template::getRDNObjects()</full_name>
        <docblock line="789">
          <description>Return the attributes that comprise the RDN.</description>
          <long-description></long-description>
          <tag name="return" description="Array of RDN objects" line="789" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="808" package="phpLDAPadmin\Templates">
        <name>getRDNAttrs</name>
        <full_name>\Template::getRDNAttrs()</full_name>
        <docblock line="808">
          <description>Get all the RDNs for this template, in RDN order.</description>
          <long-description></long-description>
          <tag name="return" description="RDNs in order." line="808" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="837" package="phpLDAPadmin\Templates">
        <name>getRDN</name>
        <full_name>\Template::getRDN()</full_name>
        <docblock line="837">
          <description>Return the RDN for this template. If the DN is already defined, then the RDN will be calculated from it.</description>
          <long-description>If the DN is not set, then the RDN will be calcuated from the template attribute definitions</long-description>
          <tag name="return" description="RDN for this template" line="837" type="\rdn">
            <type>\rdn</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="865" package="phpLDAPadmin\Templates">
        <name>getRDNAttributeName</name>
        <full_name>\Template::getRDNAttributeName()</full_name>
        <docblock line="865">
          <description>Return the attribute name part of the RDN</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="890" package="phpLDAPadmin\Templates">
        <name>getContext</name>
        <full_name>\Template::getContext()</full_name>
        <docblock line="890">
          <description>Determine the type of template this is</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="909" package="phpLDAPadmin\Templates">
        <name>isVisible</name>
        <full_name>\Template::isVisible()</full_name>
        <docblock line="909">
          <description>Test if the template is visible</description>
          <long-description></long-description>
          <tag name="return" description="" line="909" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="916" package="phpLDAPadmin\Templates">
        <name>setVisible</name>
        <full_name>\Template::setVisible()</full_name>
        <docblock line="916">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="920" package="phpLDAPadmin\Templates">
        <name>setInvisible</name>
        <full_name>\Template::setInvisible()</full_name>
        <docblock line="920">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="924" package="phpLDAPadmin\Templates">
        <name>getRegExp</name>
        <full_name>\Template::getRegExp()</full_name>
        <docblock line="924">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="934" package="phpLDAPadmin\Templates">
        <name>isReadOnly</name>
        <full_name>\Template::isReadOnly()</full_name>
        <docblock line="934">
          <description>Test if this template has been marked as a read-only template</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="950" package="phpLDAPadmin\Templates">
        <name>getAttributes</name>
        <full_name>\Template::getAttributes()</full_name>
        <docblock line="950">
          <description>Get the attribute entries</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Include the optional attributes&lt;/p&gt;" line="950" type="boolean" variable="">
            <type>boolean</type>
          </tag>
          <tag name="return" description="Array of attributes" line="950" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$optional</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="971" package="phpLDAPadmin\Templates">
        <name>getAttributesShown</name>
        <full_name>\Template::getAttributesShown()</full_name>
        <docblock line="971">
          <description>Return a list of attributes that should be shown</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="987" package="phpLDAPadmin\Templates">
        <name>getAttributesInternal</name>
        <full_name>\Template::getAttributesInternal()</full_name>
        <docblock line="987">
          <description>Return a list of the internal attributes</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1005" package="phpLDAPadmin\Templates">
        <name>getObjectClasses</name>
        <full_name>\Template::getObjectClasses()</full_name>
        <docblock line="1005">
          <description>Return the objectclasses defined in this template</description>
          <long-description></long-description>
          <tag name="return" description="Array of Objects" line="1005" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1019" package="phpLDAPadmin\Templates">
        <name>getIcon</name>
        <full_name>\Template::getIcon()</full_name>
        <docblock line="1019">
          <description>Get template icon</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1031" package="phpLDAPadmin\Templates">
        <name>getDescription</name>
        <full_name>\Template::getDescription()</full_name>
        <docblock line="1031">
          <description>Return the template description</description>
          <long-description></long-description>
          <tag name="return" description="Description" line="1031" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1043" package="phpLDAPadmin\Templates">
        <name>setInvalid</name>
        <full_name>\Template::setInvalid()</full_name>
        <docblock line="1043">
          <description>Set a template as invalid</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Message indicating the reason the template has been invalidated&lt;/p&gt;" line="1043" type="string" variable="">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$msg</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$admin</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1057" package="phpLDAPadmin\Templates">
        <name>isInValid</name>
        <full_name>\Template::isInValid()</full_name>
        <docblock line="1057">
          <description>Get the template validity or the reason it is invalid</description>
          <long-description></long-description>
          <tag name="return" description="Invalid reason, or false if not invalid" line="1057" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1067" package="phpLDAPadmin\Templates">
        <name>isAdminDisabled</name>
        <full_name>\Template::isAdminDisabled()</full_name>
        <docblock line="1067">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1080" package="phpLDAPadmin\Templates">
        <name>setMinValueCount</name>
        <full_name>\Template::setMinValueCount()</full_name>
        <docblock line="1080">
          <description>Set the minimum number of values for an attribute</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Attribute&lt;/p&gt;" line="1080" type="object" variable="">
            <type>object</type>
          </tag>
          <tag name="param" description="" line="1080" type="int" variable="">
            <type>int</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attr</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$value</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1096" package="phpLDAPadmin\Templates">
        <name>setAttrLDAPtype</name>
        <full_name>\Template::setAttrLDAPtype()</full_name>
        <docblock line="1096">
          <description>Set the LDAP type property for an attribute</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Attribute&lt;/p&gt;" line="1096" type="object" variable="">
            <type>object</type>
          </tag>
          <tag name="param" description="&lt;p&gt;(MUST,MAY,OPTIONAL)&lt;/p&gt;&#10;" line="1096" type="string" variable="">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attr</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$value</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1111" package="phpLDAPadmin\Templates">
        <name>OnChangeAdd</name>
        <full_name>\Template::OnChangeAdd()</full_name>
        <docblock line="1111">
          <description>OnChangeAdd javascript processing</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$origin</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$value</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1277" package="phpLDAPadmin\Templates">
        <name>rebuildTemplateAttrs</name>
        <full_name>\Template::rebuildTemplateAttrs()</full_name>
        <docblock line="1277">
          <description>This functions main purpose is to discover our MUST attributes based on objectclass
definitions in the template file and to discover which of the objectclasses are
STRUCTURAL - without one, creating an entry will just product an LDAP error.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1392" package="phpLDAPadmin\Templates">
        <name>getLDAPadd</name>
        <full_name>\Template::getLDAPadd()</full_name>
        <docblock line="1392">
          <description>Return an array, that can be passed to ldap_add().</description>
          <long-description>Attributes with empty values will be excluded.</long-description>
        </docblock>
        <argument line="0">
          <name>$attrsOnly</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1427" package="phpLDAPadmin\Templates">
        <name>getLDAPmodify</name>
        <full_name>\Template::getLDAPmodify()</full_name>
        <docblock line="1427">
          <description>Return an array, that can be passed to ldap_mod_replace().</description>
          <long-description>Only attributes that have changed their value will be returned.

This function will cache its results, so that it can be called with count() to see
if there are changes, and if they are, the 2nd call will just return the results</long-description>
          <tag name="param" description="&lt;p&gt;Return the attribute objects (useful for a confirmation process), or the modification array for ldap_modify()&lt;/p&gt;&#10;" line="1427" type="boolean" variable="">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attrsOnly</name>
          <default>false</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$index</name>
          <default>0</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1508" package="phpLDAPadmin\Templates">
        <name>getForceDeleteAttrs</name>
        <full_name>\Template::getForceDeleteAttrs()</full_name>
        <docblock line="1508">
          <description>Get the attributes that are marked as force delete
We'll cache this result in the event of multiple calls.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1527" package="phpLDAPadmin\Templates">
        <name>getAvailAttrs</name>
        <full_name>\Template::getAvailAttrs()</full_name>
        <docblock line="1527">
          <description>Get available attributes</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1563" package="phpLDAPadmin\Templates">
        <name>isNoLeaf</name>
        <full_name>\Template::isNoLeaf()</full_name>
        <docblock line="1563">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/functions.php" generated-path="templates.3rdParty.pla.lib.functions.html" hash="11a86717a67fa03412378bd36d948040" package="phpLDAPadmin">
    <docblock line="0">
      <description>A collection of common generic functions used throughout the application.</description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <constant namespace="" line="16" package="phpLDAPadmin">
      <name>HTDOCDIR</name>
      <full_name>\\HTDOCDIR</full_name>
      <value>sprintf('%s/', realpath(LIBDIR . '../htdocs/'))</value>
      <docblock line="16">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="17" package="phpLDAPadmin">
      <name>LANGDIR</name>
      <full_name>\\LANGDIR</full_name>
      <value>sprintf('%s/', realpath(LIBDIR . '../locale/'))</value>
      <docblock line="17">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="18" package="phpLDAPadmin">
      <name>CONFDIR</name>
      <full_name>\\CONFDIR</full_name>
      <value>sprintf('%s/', realpath(LIBDIR . '../config'))</value>
      <docblock line="18">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="19" package="phpLDAPadmin">
      <name>QUERYDIR</name>
      <full_name>\\QUERYDIR</full_name>
      <value>sprintf('%s/', realpath(LIBDIR . '../queries/'))</value>
      <docblock line="19">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="20" package="phpLDAPadmin">
      <name>TMPLDIR</name>
      <full_name>\\TMPLDIR</full_name>
      <value>sprintf('%s/', realpath(LIBDIR . '../templates/'))</value>
      <docblock line="20">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="21" package="phpLDAPadmin">
      <name>DOCDIR</name>
      <full_name>\\DOCDIR</full_name>
      <value>sprintf('%s/', realpath(LIBDIR . '../doc/'))</value>
      <docblock line="21">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="22" package="phpLDAPadmin">
      <name>HOOKSDIR</name>
      <full_name>\\HOOKSDIR</full_name>
      <value>sprintf('%s/', realpath(LIBDIR . '../hooks/'))</value>
      <docblock line="22">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="23" package="phpLDAPadmin">
      <name>JSDIR</name>
      <full_name>\\JSDIR</full_name>
      <value>'js/'</value>
      <docblock line="23">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <function namespace="" line="54" package="phpLDAPadmin">
      <name>__autoload</name>
      <full_name>\__autoload()</full_name>
      <docblock line="54">
        <description>Loads class definition</description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$className</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="74" package="phpLDAPadmin">
      <name>array_stripslashes</name>
      <full_name>\array_stripslashes()</full_name>
      <docblock line="74">
        <description>Strips all slashes from the specified array in place (pass by ref).</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;The array to strip slashes from, typically one of&#10;                    $_GET, $_POST, or $_COOKIE.&lt;/p&gt;&#10;" line="74" type="Array" variable="">
          <type>Array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$array</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="96" package="phpLDAPadmin">
      <name>_</name>
      <full_name>\_()</full_name>
      <docblock line="96">
        <description></description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$msg</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="122" package="phpLDAPadmin">
      <name>app_error_handler</name>
      <full_name>\app_error_handler()</full_name>
      <docblock line="122">
        <description>Custom error handling function.</description>
        <long-description>When a PHP error occurs, PHP will call this function rather than printing
the typical PHP error string. This provides the application the ability to
format an error message so that it looks better.
Optionally, it can present a link so that a user can search/submit bugs.
This function is not to be called directly. It is exclusively for the use of
PHP internally. If this function is called by PHP from within a context
where error handling has been disabled (ie, from within a function called
with "@" prepended), then this function does nothing.</long-description>
        <tag name="param" description="&lt;p&gt;The PHP error number that occurred (ie, E_ERROR, E_WARNING, E_PARSE, etc).&lt;/p&gt;&#10;" line="122" type="int" variable="">
          <type>int</type>
        </tag>
        <tag name="param" description="&lt;p&gt;The PHP error string provided (ie, &quot;Warning index &quot;foo&quot; is undefined)&lt;/p&gt;&#10;" line="122" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;The file in which the PHP error ocurred.&lt;/p&gt;" line="122" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;The line number on which the PHP error ocurred&lt;/p&gt;" line="122" type="int" variable="">
          <type>int</type>
        </tag>
        <tag name="see" description="" line="122"/>
      </docblock>
      <argument line="0">
        <name>$errno</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$errstr</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$file</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$lineno</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="167" package="phpLDAPadmin">
      <name>app_name</name>
      <full_name>\app_name()</full_name>
      <docblock line="167">
        <description>Returns the application name.</description>
        <long-description></long-description>
      </docblock>
    </function>
    <function namespace="" line="177" package="phpLDAPadmin">
      <name>app_version</name>
      <full_name>\app_version()</full_name>
      <docblock line="177">
        <description>Returns the application version currently running. The version
is read from the file named VERSION.</description>
        <long-description></long-description>
        <tag name="return" description="The current version as read from the VERSION file." line="177" type="string">
          <type>string</type>
        </tag>
      </docblock>
    </function>
    <function namespace="" line="186" package="phpLDAPadmin">
      <name>auto_lang</name>
      <full_name>\auto_lang()</full_name>
      <docblock line="186">
        <description>This function will convert the browser two character language into the
default 5 character language, where the country portion should NOT be
assumed to be upper case characters of the first two characters.</description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$lang</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="197" package="phpLDAPadmin">
      <name>check_config</name>
      <full_name>\check_config()</full_name>
      <docblock line="197">
        <description>Makes sure that the config file is properly setup.</description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$config_file</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="286" package="phpLDAPadmin">
      <name>cmd_control_pane</name>
      <full_name>\cmd_control_pane()</full_name>
      <docblock line="286">
        <description>Commands available in the control_panel of the page</description>
        <long-description></long-description>
        <tag name="return" description="" line="286" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$type</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="359" package="phpLDAPadmin">
      <name>debug_dump</name>
      <full_name>\debug_dump()</full_name>
      <docblock line="359">
        <description>This function dumps the $variable for debugging purposes</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;Variable to dump&lt;/p&gt;" line="359" type="string|array" variable="">
          <type>string</type>
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;Whether to stop execution or not.&lt;/p&gt;" line="359" type="boolean" variable="">
          <type>boolean</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$variable</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$die</name>
        <default>false</default>
        <type/>
      </argument>
      <argument line="0">
        <name>$onlydebugaddr</name>
        <default>false</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="368" package="phpLDAPadmin">
      <name>debug_dump_backtrace</name>
      <full_name>\debug_dump_backtrace()</full_name>
      <docblock line="368">
        <description>This function generates a backtrace</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;Whether to stop execution or not.&lt;/p&gt;" line="368" type="boolean" variable="">
          <type>boolean</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$msg</name>
        <default>'Calling BackTrace'</default>
        <type/>
      </argument>
      <argument line="0">
        <name>$die</name>
        <default>false</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="375" package="phpLDAPadmin">
      <name>debug_sysmsg</name>
      <full_name>\debug_sysmsg()</full_name>
      <docblock line="375">
        <description>Send a debug as a sys message</description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$msg</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="410" package="phpLDAPadmin">
      <name>debug_log</name>
      <full_name>\debug_log()</full_name>
      <docblock line="410">
        <description>Debug Logging</description>
        <long-description>The global debug level is turned on in your configuration file by setting:
&lt;code&gt;
$config-&gt;custom-&gt;debug['level'] = 255;
&lt;/code&gt;
together with atleast one output direction (currently file and syslog are supported).
&lt;code&gt;
$config-&gt;custom-&gt;debug['file'] = '/tmp/app_debug.log';
$config-&gt;custom-&gt;debug['syslog'] = true;
&lt;/code&gt;

The debug level is turned into binary, then if the message levels bit is on
the message will be sent to the debug log. (Thus setting your debug level to 255,
all bits on, will results in all messages being printed.)

The message level bits are defined here.
 0(  1) = Entry/Return results from function calls.
 1(  2) = Configuration Processing
 2(  4) = Template Processing
 3(  8) = Schema Processing
 4( 16) = LDAP Server Communication
 5( 32) = Tree Processing
 7( 64) = Other non generic messages
 8(128) = Page Processing
 9(256) = Hooks Processing</long-description>
        <tag name="param" description="&lt;p&gt;Message to send to syslog&lt;/p&gt;" line="410" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;Log bit number for this message.&lt;/p&gt;" line="410" type="int" variable="">
          <type>int</type>
        </tag>
        <tag name="see" description="" line="410"/>
      </docblock>
      <argument line="0">
        <name>$msg</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$level</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$indent</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="498" package="phpLDAPadmin">
      <name>error</name>
      <full_name>\error()</full_name>
      <docblock line="498">
        <description>Display an error message in the system message panel of the page.</description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$msg</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$type</name>
        <default>'note'</default>
        <type/>
      </argument>
      <argument line="0">
        <name>$redirect</name>
        <default>null</default>
        <type/>
      </argument>
      <argument line="0">
        <name>$fatal</name>
        <default>false</default>
        <type/>
      </argument>
      <argument line="0">
        <name>$backtrace</name>
        <default>false</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="573" package="phpLDAPadmin">
      <name>get_request</name>
      <full_name>\get_request()</full_name>
      <docblock line="573">
        <description>Return the result of a form variable, with optional default</description>
        <long-description></long-description>
        <tag name="return" description="form GET/REQUEST/SESSION/POST variable value or its default" line="573" type="\The">
          <type>\The</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$attr</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$type</name>
        <default>'POST'</default>
        <type/>
      </argument>
      <argument line="0">
        <name>$die</name>
        <default>false</default>
        <type/>
      </argument>
      <argument line="0">
        <name>$default</name>
        <default>null</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="608" package="phpLDAPadmin">
      <name>system_message</name>
      <full_name>\system_message()</full_name>
      <docblock line="608">
        <description>Record a system message.</description>
        <long-description>This function can be used as an alternative to generate a system message, if page hasnt yet been defined.</long-description>
      </docblock>
      <argument line="0">
        <name>$msg</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$redirect</name>
        <default>null</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="661" package="phpLDAPadmin">
      <name>blowfish_encrypt</name>
      <full_name>\blowfish_encrypt()</full_name>
      <docblock line="661">
        <description>Encryption using blowfish algorithm</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;Original data&lt;/p&gt;" line="661" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;The secret&lt;/p&gt;" line="661" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="return" description="The encrypted result" line="661" type="string">
          <type>string</type>
        </tag>
        <tag name="author" description="lem9 (taken from the phpMyAdmin source)" line="661"/>
      </docblock>
      <argument line="0">
        <name>$data</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$secret</name>
        <default>null</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="710" package="phpLDAPadmin">
      <name>blowfish_decrypt</name>
      <full_name>\blowfish_decrypt()</full_name>
      <docblock line="710">
        <description>Decryption using blowfish algorithm</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;Encrypted data&lt;/p&gt;" line="710" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;The secret&lt;/p&gt;" line="710" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="return" description="Original data" line="710" type="string">
          <type>string</type>
        </tag>
        <tag name="author" description="lem9 (taken from the phpMyAdmin source)" line="710"/>
      </docblock>
      <argument line="0">
        <name>$encdata</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$secret</name>
        <default>null</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="764" package="phpLDAPadmin">
      <name>full_str_pad</name>
      <full_name>\full_str_pad()</full_name>
      <docblock line="764">
        <description>String padding</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;Input string&lt;/p&gt;" line="764" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;Length of the result&lt;/p&gt;" line="764" type="integer" variable="">
          <type>integer</type>
        </tag>
        <tag name="param" description="&lt;p&gt;The filling string&lt;/p&gt;" line="764" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;Padding mode&lt;/p&gt;" line="764" type="integer" variable="">
          <type>integer</type>
        </tag>
        <tag name="return" description="The padded string" line="764" type="string">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$input</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$pad_length</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$pad_string</name>
        <default>''</default>
        <type/>
      </argument>
      <argument line="0">
        <name>$pad_type</name>
        <default>0</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="799" package="phpLDAPadmin">
      <name>get_cached_item</name>
      <full_name>\get_cached_item()</full_name>
      <docblock line="799">
        <description>Returns the cached array of LDAP resources.</description>
        <long-description>Note that internally, this function utilizes a two-layer cache,
one in memory using a static variable for multiple calls within
the same page load, and one in a session for multiple calls within
the same user session (spanning multiple page loads).</long-description>
        <tag name="return" description="the cached attributed requested,&#10;        or null if there is nothing cached.." line="799" type="\Returns">
          <type>\Returns</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$index</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$item</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$subitem</name>
        <default>'null'</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="821" package="phpLDAPadmin">
      <name>set_cached_item</name>
      <full_name>\set_cached_item()</full_name>
      <docblock line="821">
        <description>Caches the specified $item for the specified $index.</description>
        <long-description>Returns true on success of false on failure.</long-description>
      </docblock>
      <argument line="0">
        <name>$index</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$item</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$subitem</name>
        <default>'null'</default>
        <type/>
      </argument>
      <argument line="0">
        <name>$data</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="841" package="phpLDAPadmin">
      <name>del_cached_item</name>
      <full_name>\del_cached_item()</full_name>
      <docblock line="841">
        <description>Deletes the cache for a specified $item for the specified $index</description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$index</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$item</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$subitem</name>
        <default>'null'</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="866" package="phpLDAPadmin">
      <name>set_cookie</name>
      <full_name>\set_cookie()</full_name>
      <docblock line="866">
        <description>Utility wrapper for setting cookies, which takes into consideration
application configuration values. On success, true is returned. On
failure, false is returned.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;The name of the cookie to set.&lt;/p&gt;" line="866" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;The value of the cookie to set.&lt;/p&gt;" line="866" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;(optional) The duration in seconds of this cookie. If unspecified, $cookie_time is used from config.php&lt;/p&gt;&#10;" line="866" type="int" variable="">
          <type>int</type>
        </tag>
        <tag name="param" description="&lt;p&gt;(optional) The directory value of this cookie (see php.net/setcookie)&lt;/p&gt;&#10;" line="866" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="return" description="" line="866" type="boolean">
          <type>boolean</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$name</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$val</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$expire</name>
        <default>null</default>
        <type/>
      </argument>
      <argument line="0">
        <name>$dir</name>
        <default>null</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="901" package="phpLDAPadmin">
      <name>get_custom_file</name>
      <full_name>\get_custom_file()</full_name>
      <docblock line="901">
        <description>Get a customized file for a server
We don't need any caching, because it's done by PHP</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;The ID of the server&lt;/p&gt;" line="901" type="int" variable="">
          <type>int</type>
        </tag>
        <tag name="param" description="&lt;p&gt;The requested filename&lt;/p&gt;" line="901" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="return" description="The customized filename, if exists, or the standard one" line="901" type="string">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$index</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$filename</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$path</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="927" package="phpLDAPadmin">
      <name>masort</name>
      <full_name>\masort()</full_name>
      <docblock line="927">
        <description>Sort a multi dimensional array.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;Multi demension array passed by reference&lt;/p&gt;" line="927" type="array" variable="">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;Comma delimited string of sort keys.&lt;/p&gt;" line="927" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;Whether to reverse sort.&lt;/p&gt;" line="927" type="boolean" variable="">
          <type>boolean</type>
        </tag>
        <tag name="return" description="Sorted multi demension array." line="927" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$data</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$sortby</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$rev</name>
        <default>0</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="1017" package="phpLDAPadmin">
      <name>isCompress</name>
      <full_name>\isCompress()</full_name>
      <docblock line="1017">
        <description>Is compression enabled for output</description>
        <long-description></long-description>
      </docblock>
    </function>
    <function namespace="" line="1044" package="phpLDAPadmin">
      <name>obfuscate_password_display</name>
      <full_name>\obfuscate_password_display()</full_name>
      <docblock line="1044">
        <description>Fetches whether the user has configured phpLDAPadmin to obfuscate passwords
with "*********" when displaying them.</description>
        <long-description>This is configured in config.php thus:
&lt;code&gt;
 $config-&gt;custom-&gt;appearance['obfuscate_password_display'] = true;
&lt;/code&gt;

Or if it is OK to show encrypted passwords but not clear text passwords
&lt;code&gt;
 $config-&gt;custom-&gt;appearance['show_clear_password'] = false;
&lt;/code&gt;</long-description>
        <tag name="param" description="&lt;p&gt;Password encoding type&lt;/p&gt;" line="1044" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="return" description="" line="1044" type="boolean">
          <type>boolean</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$enc</name>
        <default>null</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="1073" package="phpLDAPadmin">
      <name>pretty_print_dn</name>
      <full_name>\pretty_print_dn()</full_name>
      <docblock line="1073">
        <description>Returns an HTML-beautified version of a DN.</description>
        <long-description>Internally, this function makes use of pla_explode_dn() to break the
the DN into its components. It then glues them back together with
"pretty" HTML. The returned HTML is NOT to be used as a real DN, but
simply displayed.</long-description>
        <tag name="param" description="&lt;p&gt;The DN to pretty-print.&lt;/p&gt;&#10;" line="1073" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="return" description="" line="1073" type="string">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$dn</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="1106" package="phpLDAPadmin">
      <name>is_dn_string</name>
      <full_name>\is_dn_string()</full_name>
      <docblock line="1106">
        <description>Given a string, this function returns true if the string has the format
of a DN (ie, looks like "cn=Foo,dc=example,dc=com"). Returns false otherwise.</description>
        <long-description>The purpose of this function is so that developers can examine a string and
know if it looks like a DN, and draw a hyperlink as needed.

(See unit_test.php for test cases)</long-description>
        <tag name="param" description="&lt;p&gt;The attribute to examine for &quot;DNness&quot;&lt;/p&gt;" line="1106" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="return" description="" line="1106" type="boolean">
          <type>boolean</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$str</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="1143" package="phpLDAPadmin">
      <name>is_mail_string</name>
      <full_name>\is_mail_string()</full_name>
      <docblock line="1143">
        <description>Get whether a string looks like an email address (user@example.com).</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;The string to analyze.&lt;/p&gt;" line="1143" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="return" description="Returns true if the specified string looks like an email address or false otherwise." line="1143" type="boolean">
          <type>boolean</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$str</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="1161" package="phpLDAPadmin">
      <name>is_url_string</name>
      <full_name>\is_url_string()</full_name>
      <docblock line="1161">
        <description>Get whether a string looks like a web URL (http://www.example.com/)</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;The string to analyze.&lt;/p&gt;" line="1161" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="return" description="Returns true if the specified string looks like a web URL or false otherwise." line="1161" type="boolean">
          <type>boolean</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$str</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="1204" package="phpLDAPadmin">
      <name>pla_compare_dns</name>
      <full_name>\pla_compare_dns()</full_name>
      <docblock line="1204">
        <description>Compares 2 DNs. If they are equivelant, returns 0, otherwise,
returns their sorting order (similar to strcmp()):
     Returns &lt; 0 if dn1 is less than dn2.</description>
        <long-description>Returns &gt; 0 if dn1 is greater than dn2.

The comparison is performed starting with the top-most element
of the DN. Thus, the following list:
   &lt;code&gt;
      ou=people,dc=example,dc=com
      cn=Admin,ou=People,dc=example,dc=com
      cn=Joe,ou=people,dc=example,dc=com
      dc=example,dc=com
      cn=Fred,ou=people,dc=example,dc=org
      cn=Dave,ou=people,dc=example,dc=org
   &lt;/code&gt;
Will be sorted thus using usort( $list, "pla_compare_dns" ):
   &lt;code&gt;
      dc=com
      dc=example,dc=com
      ou=people,dc=example,dc=com
      cn=Admin,ou=People,dc=example,dc=com
      cn=Joe,ou=people,dc=example,dc=com
      cn=Dave,ou=people,dc=example,dc=org
      cn=Fred,ou=people,dc=example,dc=org
   &lt;/code&gt;</long-description>
        <tag name="param" description="&lt;p&gt;The first of two DNs to compare&lt;/p&gt;" line="1204" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;The second of two DNs to compare&lt;/p&gt;" line="1204" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="return" description="" line="1204" type="int">
          <type>int</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$dn1</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$dn2</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="1303" package="phpLDAPadmin">
      <name>get_next_number</name>
      <full_name>\get_next_number()</full_name>
      <docblock line="1303">
        <description>For LDAP servers with auto_number enabled, this function will get the next
available number using the host's preferred mechanism (pool or search).</description>
        <long-description>This is configured in config.php by server:

&lt;code&gt;
  $servers-&gt;setValue('auto_number','enable',true|false);
&lt;/code&gt;

The available mechanisms are:
pool:
  The pool mechanism uses a user-configured entry in the LDAP server to
  store the last used "number". This mechanism simply fetches and increments
  and returns that value.

search:
  The search mechanism will search the LDAP server that has the attribute
  set. It will then find the smallest value and "fills in the gaps" by
  incrementing the smallest attribute until an unused value is found.

NOTE: Both mechanisms do NOT prevent race conditions or toe-stomping, so
care must be taken when actually creating the entry to check that the number
returned here has not been used in the mean time. Note that the two different
mechanisms may (will!) return different values as they use different algorithms
to arrive at their result. Do not be alarmed if (when!) this is the case.

See config.php.example for more notes on the two mechanisms.</long-description>
        <tag name="param" description="&lt;p&gt;Base to start the search from&lt;/p&gt;" line="1303" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;Attribute to query&lt;/p&gt;" line="1303" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;Increment the result (for pool searches)&lt;/p&gt;&#10;" line="1303" type="boolean" variable="">
          <type>boolean</type>
        </tag>
        <tag name="param" description="&lt;p&gt;LDAP filter to use (for pool searches)&lt;/p&gt;&#10;" line="1303" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="return" description="" line="1303" type="int">
          <type>int</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$base</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$attr</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$increment</name>
        <default>false</default>
        <type/>
      </argument>
      <argument line="0">
        <name>$filter</name>
        <default>false</default>
        <type/>
      </argument>
      <argument line="0">
        <name>$startmin</name>
        <default>null</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="1495" package="phpLDAPadmin">
      <name>get_icon</name>
      <full_name>\get_icon()</full_name>
      <docblock line="1495">
        <description>Given a DN and server ID, this function reads the DN's objectClasses and
determines which icon best represents the entry. The results of this query
are cached in a session variable so it is not run every time the tree
browser changes, just when exposing new DNs that were not displayed
previously. That means we can afford a little bit of inefficiency here
in favor of coolness. :)</description>
        <long-description>This function returns a string like "country.png". All icon files are assumed
to be contained in the /images/ directory of phpLDAPadmin.

Developers are encouraged to add new icons to the images directory and modify
this function as needed to suit their types of LDAP entries. If the modifications
are general to an LDAP audience, the phpLDAPadmin team will gladly accept them
as a patch.</long-description>
        <tag name="param" description="&lt;p&gt;The DN of the entry whose icon you wish to fetch.&lt;/p&gt;" line="1495" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="return" description="" line="1495" type="string">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$server_id</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$dn</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$object_classes</name>
        <default>array()</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="1676" package="phpLDAPadmin">
      <name>expand_dn_with_base</name>
      <full_name>\expand_dn_with_base()</full_name>
      <docblock line="1676">
        <description>Appends a servers base to a "sub" dn or returns the base.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;The baseDN to be added if the DN is relative&lt;/p&gt;" line="1676" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;The DN to be made absolute&lt;/p&gt;" line="1676" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="return" description="Returns null if both base is null and sub_dn is null or empty" line="1676" type="string|null">
          <type>string</type>
          <type>null</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$base</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$sub_dn</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="1702" package="phpLDAPadmin">
      <name>random_salt</name>
      <full_name>\random_salt()</full_name>
      <docblock line="1702">
        <description>Used to generate a random salt for crypt-style passwords. Salt strings are used
to make pre-built hash cracking dictionaries difficult to use as the hash algorithm uses
not only the user's password but also a randomly generated string. The string is
stored as the first N characters of the hash for reference of hashing algorithms later.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;The length of the salt string to generate.&lt;/p&gt;" line="1702" type="int" variable="">
          <type>int</type>
        </tag>
        <tag name="return" description="The generated salt string." line="1702" type="string">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$length</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="1728" package="phpLDAPadmin">
      <name>get_rdn</name>
      <full_name>\get_rdn()</full_name>
      <docblock line="1728">
        <description>Given a DN string, this returns the 'RDN' portion of the string.</description>
        <long-description>For example. given 'cn=Manager,dc=example,dc=com', this function returns
'cn=Manager' (it is really the exact opposite of ds_ldap::getContainer()).</long-description>
        <tag name="param" description="&lt;p&gt;The DN whose RDN to return.&lt;/p&gt;" line="1728" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;If true, include attributes in the RDN string. See http://php.net/ldap_explode_dn for details&lt;/p&gt;&#10;" line="1728" type="boolean" variable="">
          <type>boolean</type>
        </tag>
        <tag name="return" description="The RDN" line="1728" type="string">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$dn</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$include_attrs</name>
        <default>0</default>
        <type/>
      </argument>
      <argument line="0">
        <name>$decode</name>
        <default>false</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="1750" package="phpLDAPadmin">
      <name>rdn_explode</name>
      <full_name>\rdn_explode()</full_name>
      <docblock line="1750">
        <description>Split an RDN into its attributes</description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$rdn</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="1786" package="phpLDAPadmin">
      <name>pla_verbose_error</name>
      <full_name>\pla_verbose_error()</full_name>
      <docblock line="1786">
        <description>Given an LDAP error number, returns a verbose description of the error.</description>
        <long-description>This function parses ldap_error_codes.txt and looks up the specified
ldap error number, and returns the verbose message defined in that file.

&lt;code&gt;
 Array (
   [title] =&gt; "Invalid Credentials"
   [description] =&gt; "An invalid username and/or password was supplied to the LDAP server."
 )
&lt;/code&gt;</long-description>
        <tag name="param" description="&lt;p&gt;The hex error number (ie, &quot;0x42&quot;) of the LDAP error of interest.&lt;/p&gt;&#10;" line="1786" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="return" description="An associative array contianing the error title and description like so:" line="1786" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$key</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="1838" package="phpLDAPadmin">
      <name>support_oid_to_text</name>
      <full_name>\support_oid_to_text()</full_name>
      <docblock line="1838">
        <description>Given an LDAP OID number, returns a verbose description of the OID.</description>
        <long-description>This function parses ldap_supported_oids.txt and looks up the specified
OID, and returns the verbose message defined in that file.

&lt;code&gt;
 Array (
   [title] =&gt; All Operational Attribute
   [ref] =&gt; RFC 3673
   [desc] =&gt; An LDAP extension which clients may use to request the return of all operational attributes.
 )
&lt;/code&gt;</long-description>
        <tag name="param" description="&lt;p&gt;The OID number (ie, &quot;1.3.6.1.4.1.4203.1.5.1&quot;) of the OID of interest.&lt;/p&gt;&#10;" line="1838" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="return" description="An associative array contianing the OID title and description like so:" line="1838" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$key</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="1885" package="phpLDAPadmin">
      <name>ldap_error_msg</name>
      <full_name>\ldap_error_msg()</full_name>
      <docblock line="1885">
        <description>Print an LDAP error message</description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$msg</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$errnum</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="1930" package="phpLDAPadmin">
      <name>draw_jpeg_photo</name>
      <full_name>\draw_jpeg_photo()</full_name>
      <docblock line="1930">
        <description>Draw the jpegPhoto image(s) for an entry wrapped in HTML. Many options are available to
specify how the images are to be displayed.</description>
        <long-description>Usage Examples:
 &lt;code&gt;
  draw_jpeg_photo(0,'cn=Bob,ou=People,dc=example,dc=com',"jpegPhoto",0,true,array('img_opts'=&gt;"border: 1px; width: 150px"));
  draw_jpeg_photo(1,'cn=Fred,ou=People,dc=example,dc=com',null,1);
 &lt;/code&gt;</long-description>
        <tag name="param" description="&lt;p&gt;The Server to get the image from.&lt;/p&gt;" line="1930" type="object" variable="">
          <type>object</type>
        </tag>
        <tag name="param" description="&lt;p&gt;The DN of the entry that contains the jpeg attribute you want to draw.&lt;/p&gt;" line="1930" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;The name of the attribute containing the jpeg data (usually 'jpegPhoto').&lt;/p&gt;&#10;" line="1930" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;Index of the attribute to draw&lt;/p&gt;" line="1930" type="int" variable="">
          <type>int</type>
        </tag>
        <tag name="param" description="&lt;p&gt;If true, draws a button beneath the image titled 'Delete' allowing the user&#10;               to delete the jpeg attribute by calling JavaScript function deleteAttribute() provided&#10;               in the default modification template.&lt;/p&gt;&#10;" line="1930" type="boolean" variable="">
          <type>boolean</type>
        </tag>
        <tag name="param" description="&lt;p&gt;Specifies optional image and CSS style attributes for the table tag. Supported keys are&#10;               fixed_width, fixed_height, img_opts.&lt;/p&gt;" line="1930" type="array" variable="">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$server</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$dn</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$attr_name</name>
        <default>'jpegphoto'</default>
        <type/>
      </argument>
      <argument line="0">
        <name>$index</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$draw_delete_buttons</name>
        <default>false</default>
        <type/>
      </argument>
      <argument line="0">
        <name>$options</name>
        <default>array()</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="2022" package="phpLDAPadmin">
      <name>password_types</name>
      <full_name>\password_types()</full_name>
      <docblock line="2022">
        <description>Return the list of available password types</description>
        <long-description></long-description>
        <tag name="todo" description="Dynamically work this list out so we only present hashes that we can encrypt" line="2022"/>
      </docblock>
    </function>
    <function namespace="" line="2044" package="phpLDAPadmin">
      <name>pla_password_hash</name>
      <full_name>\pla_password_hash()</full_name>
      <docblock line="2044">
        <description>Hashes a password and returns the hash based on the specified enc_type.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;The password to hash in clear text.&lt;/p&gt;" line="2044" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;Standard LDAP encryption type which must be one of&#10;       crypt, ext_des, md5crypt, blowfish, md5, sha, smd5, ssha, or clear.&lt;/p&gt;" line="2044" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="return" description="The hashed password." line="2044" type="string">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$password_clear</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$enc_type</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="2095" package="phpLDAPadmin">
      <name>password_check</name>
      <full_name>\password_check()</full_name>
      <docblock line="2095">
        <description>Given a clear-text password and a hash, this function determines if the clear-text password
is the password that was used to generate the hash. This is handy to verify a user's password
when all that is given is the hash and a "guess".</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;The hash.&lt;/p&gt;" line="2095" type="String" variable="">
          <type>String</type>
        </tag>
        <tag name="param" description="&lt;p&gt;The password in clear text to test.&lt;/p&gt;" line="2095" type="String" variable="">
          <type>String</type>
        </tag>
        <tag name="return" description="True if the clear password matches the hash, and false otherwise." line="2095" type="Boolean">
          <type>Boolean</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$cryptedpassword</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$plainpassword</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$attribute</name>
        <default>'userpassword'</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="2249" package="phpLDAPadmin">
      <name>get_enc_type</name>
      <full_name>\get_enc_type()</full_name>
      <docblock line="2249">
        <description>Detects password encryption type</description>
        <long-description>Returns crypto string listed in braces. If it is 'crypt' password,
returns crypto detected in password hash. Function should detect
md5crypt, blowfish and extended DES crypt. If function fails to detect
encryption type, it returns NULL.</long-description>
        <tag name="param" description="&lt;p&gt;Hashed password&lt;/p&gt;" line="2249" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="return" description="" line="2249" type="string">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$user_password</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="2288" package="phpLDAPadmin">
      <name>draw_chooser_link</name>
      <full_name>\draw_chooser_link()</full_name>
      <docblock line="2288">
        <description>Draws an HTML browse button which, when clicked, pops up a DN chooser dialog.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;The name of the form element to which this chooser&#10;        dialog will publish the user's choice. The form element must be a member&#10;        of a form with the &quot;name&quot; or &quot;id&quot; attribute set in the form tag, and the element&#10;        must also define &quot;name&quot; or &quot;id&quot; for JavaScript to uniquely identify it.&#10;        Example $form_element values may include &quot;creation_form.container&quot; or&#10;        &quot;edit_form.member_uid&quot;. See /templates/modification/default.php for example usage.&lt;/p&gt;&#10;" line="2288" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;(optional) If true, the function draws the localized text &quot;choose&quot; to the right of the button.&lt;/p&gt;&#10;" line="2288" type="boolean" variable="">
          <type>boolean</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$form</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$element</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$include_choose_text</name>
        <default>true</default>
        <type/>
      </argument>
      <argument line="0">
        <name>$rdn</name>
        <default>'none'</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="2319" package="phpLDAPadmin">
      <name>pla_explode_dn</name>
      <full_name>\pla_explode_dn()</full_name>
      <docblock line="2319">
        <description>Explode a DN into an array of its RDN parts.</description>
        <long-description>NOTE: When a multivalue RDN is passed to ldap_explode_dn, the results returns with 'value + value';

&lt;code&gt;
 Array (
   [0] =&gt; uid=ppratt
   [1] =&gt; ou=People
   [2] =&gt; dc=example
   [3] =&gt; dc=com
 )
&lt;/code&gt;</long-description>
        <tag name="param" description="&lt;p&gt;The DN to explode.&lt;/p&gt;" line="2319" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;(optional) Whether to include attribute names (see http://php.net/ldap_explode_dn for details)&lt;/p&gt;&#10;" line="2319" type="int" variable="">
          <type>int</type>
        </tag>
        <tag name="return" description="An array of RDN parts of this format:" line="2319" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$dn</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$with_attributes</name>
        <default>0</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="2367" package="phpLDAPadmin">
      <name>dn_escape</name>
      <full_name>\dn_escape()</full_name>
      <docblock line="2367">
        <description>Parse a DN and escape any special characters</description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$dn</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="2388" package="phpLDAPadmin">
      <name>dn_unescape</name>
      <full_name>\dn_unescape()</full_name>
      <docblock line="2388">
        <description>Parse a DN and unescape any special characters</description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$dn</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="2411" package="phpLDAPadmin">
      <name>convertHexStringToCharCallback</name>
      <full_name>\convertHexStringToCharCallback()</full_name>
      <docblock line="2411">
        <description>Converts a hex encoded string like \12 to the corresponding character.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;preg_replace_callback: matching hex string array&lt;/p&gt;" line="2411" type="array" variable="$hex">
          <type>array</type>
        </tag>
        <tag name="return" description="character" line="2411" type="String">
          <type>String</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$hex</name>
        <default></default>
        <type>array</type>
      </argument>
    </function>
    <function namespace="" line="2423" package="phpLDAPadmin">
      <name>get_href</name>
      <full_name>\get_href()</full_name>
      <docblock line="2423">
        <description>Fetches the URL for the specified item. This is a convenience function for
fetching project HREFs (like bugs)</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;One of &quot;open_bugs&quot;, &quot;add_bug&quot;, &quot;donate&quot;, or &quot;add_rfe&quot;&#10;              (rfe = request for enhancement)&lt;/p&gt;&#10;" line="2423" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="return" description="The URL to the requested item." line="2423" type="string">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$type</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$extra_info</name>
        <default>''</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="2465" package="phpLDAPadmin">
      <name>utime</name>
      <full_name>\utime()</full_name>
      <docblock line="2465">
        <description>Returns the current time as a double (including micro-seconds).</description>
        <long-description></long-description>
        <tag name="return" description="The current time in seconds since the beginning of the UNIX epoch (Midnight Jan. 1, 1970)" line="2465" type="double">
          <type>double</type>
        </tag>
      </docblock>
    </function>
    <function namespace="" line="2491" package="phpLDAPadmin">
      <name>array_to_query_string</name>
      <full_name>\array_to_query_string()</full_name>
      <docblock line="2491">
        <description>Converts an array to a query-string with the option to exclude certain variables
from the returned query string. This is convenient if callers want to convert the
current GET query string or POST array into a string and replace certain
variables with their own.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;The associate array to convert whose form is such that the keys are the&#10;             names of the variables and the values are said variables' values like this:&#10;             &lt;code&gt;&#10;              Array (&#10;                [server_id] = 0,&#10;                [dn] = &quot;dc=example,dc=com&quot;,&#10;                [attr] = &quot;sn&quot;&#10;              )&#10;             &lt;/code&gt;&#10;             This will produce a string like this: &quot;server_id=0&amp;dn=dc=example,dc=com&amp;attr=sn&quot;&lt;/p&gt;&#10;" line="2491" type="array" variable="">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;(optional) An array of variables to exclude in the resulting string&lt;/p&gt;&#10;" line="2491" type="array" variable="">
          <type>array</type>
        </tag>
        <tag name="return" description="The string created from the array." line="2491" type="string">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$array</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$exclude_vars</name>
        <default>array()</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="2538" package="phpLDAPadmin">
      <name>pla_reverse_dn</name>
      <full_name>\pla_reverse_dn()</full_name>
      <docblock line="2538">
        <description>Reverses a DN such that the top-level RDN is first and the bottom-level RDN is last
For example:
&lt;code&gt;
  cn=Brigham,ou=People,dc=example,dc=com
&lt;/code&gt;
Becomes:
&lt;code&gt;
  dc=com,dc=example,ou=People,cn=Brigham
&lt;/code&gt;
This makes it possible to sort lists of DNs such that they are grouped by container.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;The DN to reverse&lt;/p&gt;" line="2538" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="return" description="The reversed DN" line="2538" type="string">
          <type>string</type>
        </tag>
        <tag name="see" description="" line="2538"/>
        <tag name="see" description="" line="2538"/>
      </docblock>
      <argument line="0">
        <name>$dn</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="2548" package="phpLDAPadmin">
      <name>sortAttrs</name>
      <full_name>\sortAttrs()</full_name>
      <docblock line="2548">
        <description>Attribute sorting</description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$a</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$b</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="2561" package="phpLDAPadmin">
      <name>arrayLower</name>
      <full_name>\arrayLower()</full_name>
      <docblock line="2561">
        <description>Reads an array and returns the array values back in lower case</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;The array to convert the values to lowercase.&lt;/p&gt;" line="2561" type="array" variable="$array">
          <type>array</type>
        </tag>
        <tag name="returns" description="array Array with values converted to lowercase." line="2561"/>
      </docblock>
      <argument line="0">
        <name>$array</name>
        <default></default>
        <type>array</type>
      </argument>
    </function>
    <function namespace="" line="2578" package="phpLDAPadmin">
      <name>draw_formatted_dn</name>
      <full_name>\draw_formatted_dn()</full_name>
      <docblock line="2578">
        <description>Gets a DN string using the user-configured tree_display_format string to format it.</description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$server</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$entry</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="2636" package="phpLDAPadmin">
      <name>server_select_list</name>
      <full_name>\server_select_list()</full_name>
      <docblock line="2636">
        <description>Server html select list</description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$selected</name>
        <default>null</default>
        <type/>
      </argument>
      <argument line="0">
        <name>$logged_on</name>
        <default>false</default>
        <type/>
      </argument>
      <argument line="0">
        <name>$name</name>
        <default>'index'</default>
        <type/>
      </argument>
      <argument line="0">
        <name>$isVisible</name>
        <default>true</default>
        <type/>
      </argument>
      <argument line="0">
        <name>$js</name>
        <default>null</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="2674" package="phpLDAPadmin">
      <name>littleEndian</name>
      <full_name>\littleEndian()</full_name>
      <docblock line="2674">
        <description>Converts a little-endian hex-number to one, that 'hexdec' can convert</description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$hex</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="2686" package="phpLDAPadmin">
      <name>binSIDtoText</name>
      <full_name>\binSIDtoText()</full_name>
      <docblock line="2686">
        <description></description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$binsid</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="2717" package="phpLDAPadmin">
      <name>return_ldap_hash</name>
      <full_name>\return_ldap_hash()</full_name>
      <docblock line="2717">
        <description>Query LDAP and return a hash.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;The base DN to use.&lt;/p&gt;" line="2717" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;LDAP Query filter.&lt;/p&gt;" line="2717" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;LDAP attribute to use as key.&lt;/p&gt;" line="2717" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="param" description="&lt;p&gt;Attributes to use as values.&lt;/p&gt;" line="2717" type="array" variable="">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;Specify false to not sort results by DN&#10;               or true to have the returned array sorted by DN (uses ksort)&#10;               or an array of attribute names to sort by attribute values&lt;/p&gt;&#10;" line="2717" type="boolean" variable="">
          <type>boolean</type>
        </tag>
        <tag name="return" description="Array of values keyed by $key." line="2717" type="array">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$base</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$filter</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$key</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$attrs</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$sort</name>
        <default>true</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="2766" package="phpLDAPadmin">
      <name>password_generate</name>
      <full_name>\password_generate()</full_name>
      <docblock line="2766">
        <description>This function returns a string automatically generated
based on the criteria defined in the array $criteria in config.php</description>
        <long-description></long-description>
      </docblock>
    </function>
    <function namespace="" line="2848" package="phpLDAPadmin">
      <name>a_array_rand</name>
      <full_name>\a_array_rand()</full_name>
      <docblock line="2848">
        <description>This function returns an array of $num_req values
randomly picked from the $input array</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;Array of values&lt;/p&gt;" line="2848" type="array" variable="">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;Number of values in returned array&lt;/p&gt;" line="2848" type="integer" variable="">
          <type>integer</type>
        </tag>
        <tag name="return" description="The padded string" line="2848" type="string">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$input</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$num_req</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="2885" package="phpLDAPadmin">
      <name>random_junk</name>
      <full_name>\random_junk()</full_name>
      <docblock line="2885">
        <description>This is for Opera. By putting "random junk" in the query string, it thinks
that it does not have a cached version of the page, and will thus
fetch the page rather than display the cached version</description>
        <long-description></long-description>
      </docblock>
    </function>
    <function namespace="" line="2896" package="phpLDAPadmin">
      <name>htmlid</name>
      <full_name>\htmlid()</full_name>
      <docblock line="2896">
        <description>Returns a HTML id that can be used in the URL after the #.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;The DN to pretty-print.&lt;/p&gt;&#10;" line="2896" type="string" variable="">
          <type>string</type>
        </tag>
        <tag name="return" description="" line="2896" type="string">
          <type>string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$sid</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$dn</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="2903" package="phpLDAPadmin">
      <name>isAjaxEnabled</name>
      <full_name>\isAjaxEnabled()</full_name>
      <docblock line="2903">
        <description>Is PLA configured for AJAX display</description>
        <long-description></long-description>
      </docblock>
    </function>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/ShadowAttribute.php" generated-path="templates.3rdParty.pla.lib.ShadowAttribute.html" hash="6e85ad6847eb72f72a70e1dcfad8d375" package="phpLDAPadmin">
    <docblock line="0">
      <description>Classes and functions for the template engine.</description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="15" package="phpLDAPadmin\Templates">
      <extends>\Attribute</extends>
      <name>ShadowAttribute</name>
      <full_name>\ShadowAttribute</full_name>
      <docblock line="15">
        <description>Represents a shadow date attribute</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="15"/>
        <tag name="subpackage" description="Templates" line="15"/>
      </docblock>
      <property static="false" visibility="public" line="16" namespace="" package="phpLDAPadmin\Templates">
        <name>$shadow_before_today_attrs</name>
        <default>array('shadowLastChange', 'shadowMin')</default>
        <docblock line="16">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="17" namespace="" package="phpLDAPadmin\Templates">
        <name>$shadow_after_today_attrs</name>
        <default>array('shadowMax', 'shadowExpire', 'shadowWarning', 'shadowInactive')</default>
        <docblock line="17">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
    </class>
    <source>eJx9kc1OwzAQhM/4KfaAFIgQfQB+2qrlgNRKCCpxjDbxJrGabCx7U1Ih3h0nbVohBEfvznwztu+ntrRqEscKYlhU6D15QNaQt5yJadhD3jiQkkCothUKAXFhmG6DozfNsJUySDZBElir5fwFdW0YNO2oamxNLMGL9SC2mG2x+KkMi4kaO7ySdeSDJ9QAX6JuPkD3qSjiTNoKjbl/oGDm23TcbY6d/ZCR9feDtwE6H3FAnRBrD+fJp7qwbVqZDC4PDZKUwitQIo3GfdI38fAA6Bzur6KDZIVeFiVyQdHNcbQ2HF3f/WJhLuT+Q62xOzGeOmvcGfmOjg0Xp/MzY/ilHfU5X2r6qL4BNdedqA==</source>
  </file>
  <file path="templates/3rdParty/pla/lib/hooks.php" generated-path="templates.3rdParty.pla.lib.hooks.html" hash="12fa438edce899c361d34e31ba49db1f" package="phpLDAPadmin">
    <docblock line="0">
      <description>Functions related to hooks management.</description>
      <long-description>This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of the
License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
USA</long-description>
      <tag name="author" description="Benjamin Drieu &amp;lt;benjamin.drieu@fr.alcove.com&amp;gt; and Alc�?ve" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <function namespace="" line="34" package="phpLDAPadmin">
      <name>sort_array_by_priority</name>
      <full_name>\sort_array_by_priority()</full_name>
      <docblock line="34">
        <description>Compares two arrays by numerically comparing their 'prority'
value. Standard `cmp-like' function.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;First element to compare.&lt;/p&gt;" line="34" type="\a" variable="">
          <type>\a</type>
        </tag>
        <tag name="param" description="&lt;p&gt;Second element to compare.&lt;/p&gt;" line="34" type="\b" variable="">
          <type>\b</type>
        </tag>
        <tag name="return" description="if priority of first element is smaller than second&#10;element priority. 1 otherwise." line="34" type="\-1">
          <type>\-1</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$a</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$b</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="52" package="phpLDAPadmin">
      <name>run_hook</name>
      <full_name>\run_hook()</full_name>
      <docblock line="52">
        <description>Runs procedures attached to a hook.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;Name of hook to run.&lt;/p&gt;" line="52" type="\hook_name" variable="">
          <type>\hook_name</type>
        </tag>
        <tag name="param" description="&lt;p&gt;Array of optional arguments set by phpldapadmin. It is normally in a form known by call_user_func_array() :&#10;&lt;pre&gt;[ 'server_id' =&gt; 0,&#10;'dn' =&gt; 'uid=epoussa,ou=tech,o=corp,o=fr' ]&lt;/pre&gt;&lt;/p&gt;&#10;" line="52" type="\args" variable="">
          <type>\args</type>
        </tag>
        <tag name="return" description="if all procedures returned true, false otherwise." line="52" type="true">
          <type>true</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$hook_name</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$args</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="119" package="phpLDAPadmin">
      <name>add_hook</name>
      <full_name>\add_hook()</full_name>
      <docblock line="119">
        <description>Adds a procedure to a hook for later execution.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;Name of the hook.&lt;/p&gt;" line="119" type="\hook_name" variable="">
          <type>\hook_name</type>
        </tag>
        <tag name="param" description="&lt;p&gt;Name of the php function called upon hook trigger.&lt;/p&gt;" line="119" type="\hook_function" variable="">
          <type>\hook_function</type>
        </tag>
        <tag name="param" description="&lt;p&gt;Numeric priority. Lowest means procedure will be executed before.&lt;/p&gt;" line="119" type="\priority" variable="">
          <type>\priority</type>
        </tag>
        <tag name="param" description="&lt;p&gt;Name of the php rollback function called upon failure.&lt;/p&gt;" line="119" type="\rollback_function" variable="">
          <type>\rollback_function</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$hook_name</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$hook_function</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$priority</name>
        <default>0</default>
        <type/>
      </argument>
      <argument line="0">
        <name>$rollback_function</name>
        <default>null</default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="155" package="phpLDAPadmin">
      <name>remove_hook</name>
      <full_name>\remove_hook()</full_name>
      <docblock line="155">
        <description>Removes a procedure from a hook, based on a filter.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;Name of the hook.&lt;/p&gt;" line="155" type="\hook_name" variable="">
          <type>\hook_name</type>
        </tag>
        <tag name="param" description="&lt;p&gt;Numeric priority. If set, all procedures of that priority will be removed.&lt;/p&gt;" line="155" type="\priority" variable="">
          <type>\priority</type>
        </tag>
        <tag name="param" description="&lt;p&gt;Name of the procedure function. If set, all procedures that call this function will be removed.&lt;/p&gt;" line="155" type="\hook_function" variable="">
          <type>\hook_function</type>
        </tag>
        <tag name="param" description="&lt;p&gt;Name of the php rollback function called upon failure. If set, all&#10;&#9;&#9;procedures that call this function as a rollback will be removed.&lt;/p&gt;" line="155" type="\rollback_function" variable="">
          <type>\rollback_function</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$hook_name</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$hook_function</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$priority</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$rollback_function</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="178" package="phpLDAPadmin">
      <name>clear_hooks</name>
      <full_name>\clear_hooks()</full_name>
      <docblock line="178">
        <description>Removes all procedures from a hook.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;Name of hook to clear.&lt;/p&gt;" line="178" type="\hook_name" variable="">
          <type>\hook_name</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$hook_name</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/syslog.php" generated-path="templates.3rdParty.pla.lib.syslog.html" hash="252370b42bdb909e86ff1e70f36345f5" package="phpLDAPadmin">
    <docblock line="0">
      <description>Functions related to syslog logging.</description>
      <long-description>This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of the
License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
USA</long-description>
      <tag name="author" description="Benjamin Drieu &amp;lt;benjamin.drieu@fr.alcove.com&amp;gt; and Alcôve" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <function namespace="" line="41" package="phpLDAPadmin">
      <name>syslog_msg</name>
      <full_name>\syslog_msg()</full_name>
      <docblock line="41">
        <description>Verify that syslog logging is activated in the config via the
debug-&gt;syslog variable and does a call to the syslog() function is it
is true.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;Syslog emergency.&lt;/p&gt;" line="41" type="\emergency" variable="">
          <type>\emergency</type>
        </tag>
        <tag name="param" description="&lt;p&gt;String to log.&lt;/p&gt;" line="41" type="\log_string" variable="">
          <type>\log_string</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$emergency</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$log_string</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="54" package="phpLDAPadmin">
      <name>syslog_err</name>
      <full_name>\syslog_err()</full_name>
      <docblock line="54">
        <description>Issue an error message via syslog.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;Log message to send to syslog.&lt;/p&gt;" line="54" type="\log_string" variable="">
          <type>\log_string</type>
        </tag>
        <tag name="return" description="on success." line="54" type="true">
          <type>true</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$log_string</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="64" package="phpLDAPadmin">
      <name>syslog_warning</name>
      <full_name>\syslog_warning()</full_name>
      <docblock line="64">
        <description>Issue a warning message via syslog.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;Log message to send to syslog.&lt;/p&gt;" line="64" type="\log_string" variable="">
          <type>\log_string</type>
        </tag>
        <tag name="return" description="on success." line="64" type="true">
          <type>true</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$log_string</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="74" package="phpLDAPadmin">
      <name>syslog_notice</name>
      <full_name>\syslog_notice()</full_name>
      <docblock line="74">
        <description>Issue a notice message via syslog.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;Log message to send to syslog.&lt;/p&gt;" line="74" type="\log_string" variable="">
          <type>\log_string</type>
        </tag>
        <tag name="return" description="on success." line="74" type="true">
          <type>true</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$log_string</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="85" package="phpLDAPadmin">
      <name>syslog_debug</name>
      <full_name>\syslog_debug()</full_name>
      <docblock line="85">
        <description>Issue a debug message via syslog, only if $log_level is set to
'debug' from the config file.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;Log message to send to syslog.&lt;/p&gt;" line="85" type="\log_string" variable="">
          <type>\log_string</type>
        </tag>
        <tag name="return" description="on success or if debug log is not activated." line="85" type="true">
          <type>true</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$log_string</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/RandomPasswordAttribute.php" generated-path="templates.3rdParty.pla.lib.RandomPasswordAttribute.html" hash="37fea1fca0f8dc518049e80f525f75e2" package="phpLDAPadmin">
    <docblock line="0">
      <description>Classes and functions for the template engine.</description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="15" package="phpLDAPadmin\Templates">
      <extends>\PasswordAttribute</extends>
      <name>RandomPasswordAttribute</name>
      <full_name>\RandomPasswordAttribute</full_name>
      <docblock line="15">
        <description>Represents an attribute whose values are random passwords</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="15"/>
        <tag name="subpackage" description="Templates" line="15"/>
      </docblock>
    </class>
    <source>eJx1j0kKwkAQRfd9ilpnoRcQB3TpQsQLlOnKgOmBrupEEO9uJRhBxPWf3l9tYhPNsigMFLDvkJkY0Fuosi+lDZ6hCgmkIRBysUMhIF+3nhaaGENbzNKo5aIW7Toedie0rvVgqacuREdeNItuMkcsb1h/O1VYmpnhTDERa2bEABRJ7TXr6NAEJuixyyNgIkhKGRxERR5Csjzj/FmALefrrF3eV3iaLsfbcJ76Tu+63WeY7kLeMvwqD/M0m7V5AUZ2bKE=</source>
  </file>
  <file path="templates/3rdParty/pla/lib/JpegAttribute.php" generated-path="templates.3rdParty.pla.lib.JpegAttribute.html" hash="d58f92e08c97dfb8f6bc0838b0ccb593" package="phpLDAPadmin">
    <docblock line="0">
      <description>Classes and functions for the template engine.</description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="15" package="phpLDAPadmin\Templates">
      <extends>\BinaryAttribute</extends>
      <name>JpegAttribute</name>
      <full_name>\JpegAttribute</full_name>
      <docblock line="15">
        <description>Represents an attribute whose values are jpeg pictures</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="15"/>
        <tag name="subpackage" description="Templates" line="15"/>
      </docblock>
    </class>
    <source>eJx1jzkOwkAMRfs5hesUcAHEXiEKhLiASUwykDijsYdFiLvjIAKioLXf30aTUAU3zDIHGSxqFCEB5AIOiXP1LQsc2ghaESg1oUYlIC4908AUnWiKSStDdoaY13o522DReIaCzlS3oSFW02LzggPmJyx/SXsMXd9hSyGSmKarAaga/T5Z6KVqheCMdeoKRoJjoBKCzzUZ33f5Yw9TSfv+t3vvkFdu3m2GlZnNPll0VeJCYO4Z4+17v7uHm4zdE9PyZjM=</source>
  </file>
  <file path="templates/3rdParty/pla/lib/query_functions.php" generated-path="templates.3rdParty.pla.lib.query_functions.html" hash="994b6ab1504333803d05a7818e950b64" package="phpLDAPadmin">
    <docblock line="0">
      <description>Classes and functions for searching the LDAP server</description>
      <long-description>These classes and functions will read our XML search files, for defined
search reports.</long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="20" package="phpLDAPadmin\Queries">
      <extends>\xmlTemplates</extends>
      <name>Queries</name>
      <full_name>\Queries</full_name>
      <docblock line="20">
        <description>Query Class</description>
        <long-description>This class will store all our pre-defined search definitions.</long-description>
        <tag name="package" description="phpLDAPadmin" line="20"/>
        <tag name="subpackage" description="Queries" line="20"/>
      </docblock>
    </class>
    <source>eJx1j81OAzEMhO95Cp9XQF8A0SI4FgmkHriazWw3In+ys6UI8e5k/yohwS3xeDzf3G5zn82maQw19OBZFUocLXVDbItLUalLQgqWtnfxSKUH7R/vn+tITpBqG52HHgpq//R/OO9JwJbSIPT6tF+uUec89Gq6b9G5CDueWkRBTlL0ZgnY8VD6uliDqBKPBGyDi9V5gk85IBYq4DAtZ27f+fh7swobszZ9GSCfc99LA6dzgRlYSxIQ19dInQXXC+MKOH3dVPEC+U8u7XR4W7Ux2kEnnDlvmRDOBdEqnYM/IGTPpQ6/zLfZ3pkfTjKLKQ==</source>
  </file>
  <file path="templates/3rdParty/pla/lib/xmlTemplates.php" generated-path="templates.3rdParty.pla.lib.xmlTemplates.html" hash="3bea3a131b8bee474f64afcd1132e9f4" package="phpLDAPadmin">
    <docblock line="0">
      <description>Classes and functions for XML based templates.</description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <class final="false" abstract="true" namespace="" line="15" package="phpLDAPadmin\Templates">
      <extends/>
      <name>xmlTemplates</name>
      <full_name>\xmlTemplates</full_name>
      <docblock line="15">
        <description>XML Templates Class</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="15"/>
        <tag name="subpackage" description="Templates" line="15"/>
      </docblock>
      <property static="false" visibility="protected" line="17" namespace="" package="phpLDAPadmin\Templates">
        <name>$server_id</name>
        <default></default>
        <docblock line="17">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="19" namespace="" package="phpLDAPadmin\Templates">
        <name>$templates</name>
        <default>array()</default>
        <docblock line="19">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="21" package="phpLDAPadmin\Templates">
        <name>__construct</name>
        <full_name>\xmlTemplates::__construct()</full_name>
        <docblock line="21">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$server_id</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="153" package="phpLDAPadmin\Templates">
        <name>getClassVars</name>
        <full_name>\xmlTemplates::getClassVars()</full_name>
        <docblock line="153">
          <description>This will return our custom class variables, used by the parent to create objects.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="193" package="phpLDAPadmin\Templates">
        <name>getTemplates</name>
        <full_name>\xmlTemplates::getTemplates()</full_name>
        <docblock line="193">
          <description>Return a list of templates by their type
This function should return a sorted list, as the array is built sorted.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Type of template, eg: creation, modification&lt;/p&gt;" line="193" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Exclude templates purposely disabled.&lt;/p&gt;" line="193" type="boolean" variable="">
            <type>boolean</type>
          </tag>
          <tag name="return" description="List of templates of the type" line="193" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$type</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$container</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$disabled</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="225" package="phpLDAPadmin\Templates">
        <name>getTemplate</name>
        <full_name>\xmlTemplates::getTemplate()</full_name>
        <docblock line="225">
          <description>Return a template by its ID</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The template ID as it was when it was generated (normally used in $_REQUEST vars).&lt;/p&gt;&#10;" line="225" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="return" description="Template (or default template if the ID doesnt exist)" line="225" type="object">
            <type>object</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$templateid</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="244" package="phpLDAPadmin\Templates">
        <name>getTemplateFiles</name>
        <full_name>\xmlTemplates::getTemplateFiles()</full_name>
        <docblock line="244">
          <description>Get a list of template filenames.</description>
          <long-description></long-description>
        </docblock>
      </method>
    </class>
    <class final="false" abstract="true" namespace="" line="263" package="phpLDAPadmin\Templates">
      <extends/>
      <name>xmlTemplate</name>
      <full_name>\xmlTemplate</full_name>
      <docblock line="263">
        <description>XML Template Class</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="263"/>
        <tag name="subpackage" description="Templates" line="263"/>
      </docblock>
      <property static="false" visibility="protected" line="265" namespace="" package="phpLDAPadmin\Templates">
        <name>$server_id</name>
        <default></default>
        <docblock line="265">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="267" namespace="" package="phpLDAPadmin\Templates">
        <name>$id</name>
        <default></default>
        <docblock line="267">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="269" namespace="" package="phpLDAPadmin\Templates">
        <name>$name</name>
        <default></default>
        <docblock line="269">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="271" namespace="" package="phpLDAPadmin\Templates">
        <name>$type</name>
        <default></default>
        <docblock line="271">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="273" namespace="" package="phpLDAPadmin\Templates">
        <name>$readtime</name>
        <default></default>
        <docblock line="273">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="275" namespace="" package="phpLDAPadmin\Templates">
        <name>$filename</name>
        <default></default>
        <docblock line="275">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="277" namespace="" package="phpLDAPadmin\Templates">
        <name>$attributes</name>
        <default>array()</default>
        <docblock line="277">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="279" package="phpLDAPadmin\Templates">
        <name>__construct</name>
        <full_name>\xmlTemplate::__construct()</full_name>
        <docblock line="279">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$server_id</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$name</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$filename</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$type</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$id</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="306" package="phpLDAPadmin\Templates">
        <name>getAttrID</name>
        <full_name>\xmlTemplate::getAttrID()</full_name>
        <docblock line="306">
          <description>Get an attribute ID</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The Attribute being searched.&lt;/p&gt;" line="306" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="return" description="Attribute ID in the array" line="306" type="int">
            <type>int</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attr</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="320" package="phpLDAPadmin\Templates">
        <name>getFileName</name>
        <full_name>\xmlTemplate::getFileName()</full_name>
        <docblock line="320">
          <description>Get the Template filename.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="330" package="phpLDAPadmin\Templates">
        <name>getID</name>
        <full_name>\xmlTemplate::getID()</full_name>
        <docblock line="330">
          <description>Return the template by ID</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="345" package="phpLDAPadmin\Templates">
        <name>getName</name>
        <full_name>\xmlTemplate::getName()</full_name>
        <docblock line="345">
          <description>Return the template name</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Force the name to be lowercase (default)&lt;/p&gt;&#10;" line="345" type="boolean" variable="">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$lower</name>
          <default>true</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="358" package="phpLDAPadmin\Templates">
        <name>getReadTime</name>
        <full_name>\xmlTemplate::getReadTime()</full_name>
        <docblock line="358">
          <description>Get the Template read time.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="370" package="phpLDAPadmin\Templates">
        <name>getServer</name>
        <full_name>\xmlTemplate::getServer()</full_name>
        <docblock line="370">
          <description>Return this LDAP Server object</description>
          <long-description></long-description>
          <tag name="return" description="DataStore Server" line="370" type="object">
            <type>object</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="382" package="phpLDAPadmin\Templates">
        <name>getServerID</name>
        <full_name>\xmlTemplate::getServerID()</full_name>
        <docblock line="382">
          <description>Return the LDAP server ID</description>
          <long-description></long-description>
          <tag name="return" description="Server ID" line="382" type="int">
            <type>int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="394" package="phpLDAPadmin\Templates">
        <name>isType</name>
        <full_name>\xmlTemplate::isType()</full_name>
        <docblock line="394">
          <description>Test if a template is of a type</description>
          <long-description></long-description>
          <tag name="return" description="" line="394" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$type</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="407" package="phpLDAPadmin\Templates">
        <name>getType</name>
        <full_name>\xmlTemplate::getType()</full_name>
        <docblock line="407">
          <description>Return the template type</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="417" package="phpLDAPadmin\Templates">
        <name>getTitle</name>
        <full_name>\xmlTemplate::getTitle()</full_name>
        <docblock line="417">
          <description>Get template title</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="432" package="phpLDAPadmin\Templates">
        <name>addAttribute</name>
        <full_name>\xmlTemplate::addAttribute()</full_name>
        <docblock line="432">
          <description>Add another attribute to this template</description>
          <long-description></long-description>
          <tag name="return" description="Attribute ID" line="432" type="int">
            <type>int</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$value</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$source</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="465" package="phpLDAPadmin\Templates">
        <name>getAttributeNames</name>
        <full_name>\xmlTemplate::getAttributeNames()</full_name>
        <docblock line="465">
          <description>Get the attribute names</description>
          <long-description></long-description>
          <tag name="return" description="Array of attributes Names" line="465" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="483" package="phpLDAPadmin\Templates">
        <name>getAttribute</name>
        <full_name>\xmlTemplate::getAttribute()</full_name>
        <docblock line="483">
          <description>Get a specific Attribute</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of attribute to retrieve&lt;/p&gt;" line="483" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="return" description="Attribute" line="483" type="object">
            <type>object</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="497" package="phpLDAPadmin\Templates">
        <name>isAdminDisabled</name>
        <full_name>\xmlTemplate::isAdminDisabled()</full_name>
        <docblock line="497">
          <description>May be overloaded in other classes</description>
          <long-description></long-description>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/ds_ldap_pla.php" generated-path="templates.3rdParty.pla.lib.ds_ldap_pla.html" hash="b5a19294940a76ccadca399941d94d95" package="phpLDAPadmin">
    <docblock line="0">
      <description>Classes and functions for communication of Data Stores</description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="15" package="phpLDAPadmin\DataStore">
      <extends>\myldap</extends>
      <name>ldap_pla</name>
      <full_name>\ldap_pla</full_name>
      <docblock line="15">
        <description>This abstract class provides variables and methods for LDAP datastores for use by PLA.</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="15"/>
        <tag name="subpackage" description="DataStore" line="15"/>
      </docblock>
      <property static="false" visibility="private" line="17" namespace="" package="phpLDAPadmin\DataStore">
        <name>$force_may</name>
        <default>array()</default>
        <docblock line="17">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="19" package="phpLDAPadmin\DataStore">
        <name>__construct</name>
        <full_name>\ldap_pla::__construct()</full_name>
        <docblock line="19">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$index</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="130" package="phpLDAPadmin\DataStore">
        <name>__get</name>
        <full_name>\ldap_pla::__get()</full_name>
        <docblock line="130">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$key</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="158" package="phpLDAPadmin\DataStore">
        <name>isShowCreateEnabled</name>
        <full_name>\ldap_pla::isShowCreateEnabled()</full_name>
        <docblock line="158">
          <description>Gets whether the admin has configured phpLDAPadmin to show the "Create New" link in the tree viewer.</description>
          <long-description>&lt;code&gt;
$servers-&gt;setValue('appearance','show_create',true|false);
&lt;/code&gt;
If NOT set, then default to show the Create New item.
If IS set, then return the value (it should be true or false).

The entry creation command must be available.
&lt;code&gt;
$config-&gt;custom-&gt;commands['script'] = array('create' =&gt; true);
&lt;/code&gt;</long-description>
          <tag name="return" description="true if the feature is enabled and false otherwise." line="158" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="177" package="phpLDAPadmin\DataStore">
        <name>isAnonBindAllowed</name>
        <full_name>\ldap_pla::isAnonBindAllowed()</full_name>
        <docblock line="177">
          <description>Fetch whether the user has configured a certain server login to be non anonymous</description>
          <long-description>&lt;code&gt;
$servers-&gt;setValue('login','anon_bind',true|false);
&lt;/code&gt;</long-description>
          <tag name="return" description="" line="177" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="203" package="phpLDAPadmin\DataStore">
        <name>isBranchRenameEnabled</name>
        <full_name>\ldap_pla::isBranchRenameEnabled()</full_name>
        <docblock line="203">
          <description>Returns true if the user has configured the specified server to enable branch (non-leaf) renames.</description>
          <long-description>This is configured in config.php thus:
&lt;code&gt;
$servers-&gt;setValue('server','branch_rename',true|false);
&lt;/code&gt;</long-description>
          <tag name="return" description="" line="203" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="227" package="phpLDAPadmin\DataStore">
        <name>isMultiLineAttr</name>
        <full_name>\ldap_pla::isMultiLineAttr()</full_name>
        <docblock line="227">
          <description>Determines if an attribute's value can contain multiple lines. Attributes that fall
in this multi-line category may be configured in config.php. Hence, this function
accesses the global variable $_SESSION[APPCONFIG]-&gt;custom-&gt;appearance['multi_line_attributes'];</description>
          <long-description>Usage example:
&lt;code&gt;
if ($ldapserver-&gt;isMultiLineAttr('postalAddress'))
	echo '&lt;textarea name="postalAddress"&gt;&lt;/textarea&gt;';
else
	echo '&lt;input name="postalAddress" type="text"&gt;';
&lt;/code&gt;</long-description>
          <tag name="param" description="&lt;p&gt;The name of the attribute of interested (case insensivite)&lt;/p&gt;&#10;" line="227" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;(optional) The current value of the attribute (speeds up the process by searching for carriage returns already in the attribute value)&lt;/p&gt;&#10;" line="227" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="return" description="" line="227" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attr_name</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$val</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="277" package="phpLDAPadmin\DataStore">
        <name>isAttrTest</name>
        <full_name>\ldap_pla::isAttrTest()</full_name>
        <docblock line="277">
          <description>Returns true if the specified attribute is configured according to
the test enabled in config.php</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The name of the attribute to test.&lt;/p&gt;" line="277" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;The attributes to test against.&lt;/p&gt;" line="277" type="array" variable="">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;A DN that is exempt from these tests.&lt;/p&gt;" line="277" type="\dn" variable="">
            <type>\dn</type>
          </tag>
          <tag name="return" description="" line="277" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attr</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$attrs</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$except_dn</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="304" package="phpLDAPadmin\DataStore">
        <name>isAttrReadOnly</name>
        <full_name>\ldap_pla::isAttrReadOnly()</full_name>
        <docblock line="304">
          <description>Returns true if the specified attribute is configured as read only
in config.php.</description>
          <long-description>Attributes are configured as read-only in config.php thus:
&lt;code&gt;
$config-&gt;custom-&gt;appearance['readonly_attrs'] = array('objectClass');
&lt;/code&gt;</long-description>
          <tag name="param" description="&lt;p&gt;The name of the attribute to test.&lt;/p&gt;" line="304" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="return" description="" line="304" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attr</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="325" package="phpLDAPadmin\DataStore">
        <name>isAttrHidden</name>
        <full_name>\ldap_pla::isAttrHidden()</full_name>
        <docblock line="325">
          <description>Returns true if the specified attribute is configured as hidden
in config.php.</description>
          <long-description>Attributes are configured as hidden in config.php thus:
&lt;code&gt;
$config-&gt;custom-&gt;appearance['hide_attrs'] = array('objectClass');
&lt;/code&gt;</long-description>
          <tag name="param" description="&lt;p&gt;The name of the attribute to test.&lt;/p&gt;" line="325" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="return" description="" line="325" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attr</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="338" package="phpLDAPadmin\DataStore">
        <name>add</name>
        <full_name>\ldap_pla::add()</full_name>
        <docblock line="338">
          <description>Add objects</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$entry_array</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$method</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="382" package="phpLDAPadmin\DataStore">
        <name>delete</name>
        <full_name>\ldap_pla::delete()</full_name>
        <docblock line="382">
          <description>Delete objects</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$method</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="408" package="phpLDAPadmin\DataStore">
        <name>rename</name>
        <full_name>\ldap_pla::rename()</full_name>
        <docblock line="408">
          <description>Rename objects</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$new_rdn</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$container</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$deleteoldrdn</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$method</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="435" package="phpLDAPadmin\DataStore">
        <name>modify</name>
        <full_name>\ldap_pla::modify()</full_name>
        <docblock line="435">
          <description>Modify objects</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$attrs</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$method</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="548" package="phpLDAPadmin\DataStore">
        <name>isAttrUnique</name>
        <full_name>\ldap_pla::isAttrUnique()</full_name>
        <docblock line="548">
          <description>Returns true if the specified attribute is configured as unique
in config.php.</description>
          <long-description>Attributes are configured as hidden in config.php thus:
&lt;code&gt;
$servers-&gt;setValue('unique','attrs',array('mail','uid','uidNumber'));
&lt;/code&gt;</long-description>
          <tag name="param" description="&lt;p&gt;The name of the attribute to test.&lt;/p&gt;" line="548" type="string" variable="$attr">
            <type>string</type>
          </tag>
          <tag name="return" description="" line="548" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attr</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="569" package="phpLDAPadmin\DataStore">
        <name>checkUniqueAttrs</name>
        <full_name>\ldap_pla::checkUniqueAttrs()</full_name>
        <docblock line="569">
          <description>This function will check whether the value for an attribute being changed
is already assigned to another DN.</description>
          <long-description>Returns the bad value, or null if all values are OK</long-description>
          <tag name="param" description="&lt;p&gt;DN that is being changed&lt;/p&gt;" line="569" type="\dn" variable="">
            <type>\dn</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Attribute being changed&lt;/p&gt;" line="569" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;New values for the attribute&lt;/p&gt;" line="569" type="string|array" variable="">
            <type>string</type>
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$attrs</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="633" package="phpLDAPadmin\DataStore">
        <name>isSessionValid</name>
        <full_name>\ldap_pla::isSessionValid()</full_name>
        <docblock line="633">
          <description>Check if the session timeout has occured for this LDAP server.</description>
          <long-description></long-description>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/BinaryAttribute.php" generated-path="templates.3rdParty.pla.lib.BinaryAttribute.html" hash="cc9ce3c3d2f4495b6c7b831583a888db" package="phpLDAPadmin">
    <docblock line="0">
      <description>Classes and functions for the template engine.</description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="15" package="phpLDAPadmin\Templates">
      <extends>\Attribute</extends>
      <name>BinaryAttribute</name>
      <full_name>\BinaryAttribute</full_name>
      <docblock line="15">
        <description>Represents an attribute whose values are binary</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="15"/>
        <tag name="subpackage" description="Templates" line="15"/>
      </docblock>
      <property static="false" visibility="protected" line="16" namespace="" package="phpLDAPadmin\Templates">
        <name>$filepaths</name>
        <default></default>
        <docblock line="16">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="17" namespace="" package="phpLDAPadmin\Templates">
        <name>$filenames</name>
        <default></default>
        <docblock line="17">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="19" package="phpLDAPadmin\Templates">
        <name>__construct</name>
        <full_name>\BinaryAttribute::__construct()</full_name>
        <docblock line="19">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$server_id</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$source</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="26" package="phpLDAPadmin\Templates">
        <name>getFileNames</name>
        <full_name>\BinaryAttribute::getFileNames()</full_name>
        <docblock line="26">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="30" package="phpLDAPadmin\Templates">
        <name>getFileName</name>
        <full_name>\BinaryAttribute::getFileName()</full_name>
        <docblock line="30">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="35" package="phpLDAPadmin\Templates">
        <name>addFileName</name>
        <full_name>\BinaryAttribute::addFileName()</full_name>
        <docblock line="35">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default>-1</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="43" package="phpLDAPadmin\Templates">
        <name>getFilePaths</name>
        <full_name>\BinaryAttribute::getFilePaths()</full_name>
        <docblock line="43">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="47" package="phpLDAPadmin\Templates">
        <name>getFilePath</name>
        <full_name>\BinaryAttribute::getFilePath()</full_name>
        <docblock line="47">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="52" package="phpLDAPadmin\Templates">
        <name>addFilePath</name>
        <full_name>\BinaryAttribute::addFilePath()</full_name>
        <docblock line="52">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$path</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default>-1</default>
          <type/>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/config_default.php" generated-path="templates.3rdParty.pla.lib.config_default.html" hash="f00f525bec62ba9127de631ebcaffd43" package="phpLDAPadmin">
    <docblock line="0">
      <description>Configuration processing and defaults.</description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="todo" description="Add validation of set variables to enforce limits or particular values." line="0"/>
    </docblock>
    <constant namespace="" line="11" package="phpLDAPadmin">
      <name>REQUIRED_PHP_VERSION</name>
      <full_name>\\REQUIRED_PHP_VERSION</full_name>
      <value>'5.0.0'</value>
      <docblock line="11">
        <description>The minimum version of PHP required to run phpLDAPadmin.</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <class final="false" abstract="false" namespace="" line="22" package="phpLDAPadmin\Tree">
      <extends/>
      <name>Config</name>
      <full_name>\Config</full_name>
      <docblock line="22">
        <description>The config class contains all our configuration settings for a session.</description>
        <long-description>An instance of this class should be stored in $_SESSION to maintain state, and to avoid
rebuilding/rereading it at the state of each page output.</long-description>
        <tag name="package" description="phpLDAPadmin" line="22"/>
        <tag name="subpackage" description="Tree" line="22"/>
      </docblock>
      <property static="false" visibility="public" line="23" namespace="" package="phpLDAPadmin\Tree">
        <name>$custom</name>
        <default></default>
        <docblock line="23">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="24" namespace="" package="phpLDAPadmin\Tree">
        <name>$default</name>
        <default></default>
        <docblock line="24">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="25" namespace="" package="phpLDAPadmin\Tree">
        <name>$servers</name>
        <default>array()</default>
        <docblock line="25">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="27" namespace="" package="phpLDAPadmin\Tree">
        <name>$hooks</name>
        <default>array()</default>
        <docblock line="27">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="29" package="phpLDAPadmin\Tree">
        <name>__construct</name>
        <full_name>\Config::__construct()</full_name>
        <docblock line="29">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="577" package="phpLDAPadmin\Tree">
        <name>getConfigArray</name>
        <full_name>\Config::getConfigArray()</full_name>
        <docblock line="577">
          <description>Access the configuration, taking into account the defaults and the customisations</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$usecache</name>
          <default>true</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="596" package="phpLDAPadmin\Tree">
        <name>getValue</name>
        <full_name>\Config::getValue()</full_name>
        <docblock line="596">
          <description>Get a configuration value.</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$key</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$index</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$fatal</name>
          <default>true</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="618" package="phpLDAPadmin\Tree">
        <name>untested</name>
        <full_name>\Config::untested()</full_name>
        <docblock line="618">
          <description>Return the untested config items</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="632" package="phpLDAPadmin\Tree">
        <name>CheckCustom</name>
        <full_name>\Config::CheckCustom()</full_name>
        <docblock line="632">
          <description>Function to check and warn about any unusual defined variables.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="667" package="phpLDAPadmin\Tree">
        <name>getCommandList</name>
        <full_name>\Config::getCommandList()</full_name>
        <docblock line="667">
          <description>Get a list of available commands.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="684" package="phpLDAPadmin\Tree">
        <name>isCommandAvailable</name>
        <full_name>\Config::isCommandAvailable()</full_name>
        <docblock line="684">
          <description>Simple ACL to see if commands can be run</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$index</name>
          <default>'cmd'</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="701" package="phpLDAPadmin\Tree">
        <name>configDefinition</name>
        <full_name>\Config::configDefinition()</full_name>
        <docblock line="701">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$key</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$index</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$config</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="718" package="phpLDAPadmin\Tree">
        <name>getFriendlyAttrs</name>
        <full_name>\Config::getFriendlyAttrs()</full_name>
        <docblock line="718">
          <description>Return the friendly attributes names</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="732" package="phpLDAPadmin\Tree">
        <name>getFriendlyName</name>
        <full_name>\Config::getFriendlyName()</full_name>
        <docblock line="732">
          <description>This function will return the friendly name of an attribute, if it exists.</description>
          <long-description>If the friendly name doesnt exist, the attribute name will be returned.</long-description>
          <tag name="param" description="" line="732" type="\attribute" variable="">
            <type>\attribute</type>
          </tag>
          <tag name="return" description="friendly name|attribute" line="732" type="string">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attr</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="760" package="phpLDAPadmin\Tree">
        <name>haveFriendlyName</name>
        <full_name>\Config::haveFriendlyName()</full_name>
        <docblock line="760">
          <description>This function will return true if a friendly name exists for an attribute.</description>
          <long-description>If the friendly name doesnt exist, it will return false.</long-description>
          <tag name="param" description="" line="760" type="\attribute" variable="">
            <type>\attribute</type>
          </tag>
          <tag name="return" description="true|false" line="760" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attr</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="773" package="phpLDAPadmin\Tree">
        <name>getFriendlyHTML</name>
        <full_name>\Config::getFriendlyHTML()</full_name>
        <docblock line="773">
          <description>This function will return the &lt;ancronym&gt; html for a friendly name attribute.</description>
          <long-description></long-description>
          <tag name="param" description="" line="773" type="\attribute" variable="">
            <type>\attribute</type>
          </tag>
          <tag name="return" description="html for the friendly name." line="773" type="string">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attr</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="779" package="phpLDAPadmin\Tree">
        <name>setServers</name>
        <full_name>\Config::setServers()</full_name>
        <docblock line="779">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$servers</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="783" package="phpLDAPadmin\Tree">
        <name>getServer</name>
        <full_name>\Config::getServer()</full_name>
        <docblock line="783">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$index</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="791" package="phpLDAPadmin\Tree">
        <name>getServerList</name>
        <full_name>\Config::getServerList()</full_name>
        <docblock line="791">
          <description>Return a list of our servers</description>
          <long-description></long-description>
          <tag name="param" description="&lt;ul&gt;&#10;&lt;li&gt;Only return visible servers&lt;/li&gt;&#10;&lt;/ul&gt;&#10;" line="791" type="boolean" variable="$visible">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$visible</name>
          <default>true</default>
          <type>boolean</type>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/Query.php" generated-path="templates.3rdParty.pla.lib.Query.html" hash="d6c2cf546bf1ab22f3c85de522ba7b0d" package="phpLDAPadmin">
    <docblock line="0">
      <description>Classes and functions for the query engine.</description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="15" package="phpLDAPadmin\Queries">
      <extends>\xmlTemplate</extends>
      <name>Query</name>
      <full_name>\Query</full_name>
      <docblock line="15">
        <description>Query Class</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="15"/>
        <tag name="subpackage" description="Queries" line="15"/>
      </docblock>
      <property static="false" visibility="protected" line="16" namespace="" package="phpLDAPadmin\Queries">
        <name>$description</name>
        <default>''</default>
        <docblock line="16">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="17" namespace="" package="phpLDAPadmin\Queries">
        <name>$results</name>
        <default>array()</default>
        <docblock line="17">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="24" package="phpLDAPadmin\Queries">
        <name>storeTemplate</name>
        <full_name>\Query::storeTemplate()</full_name>
        <docblock line="24">
          <description>Main processing to store the template.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Parsed xmldata from xml2array object&lt;/p&gt;" line="24" type="\xmldata" variable="">
            <type>\xmldata</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$xmldata</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="123" package="phpLDAPadmin\Queries">
        <name>accept</name>
        <full_name>\Query::accept()</full_name>
        <docblock line="123">
          <description>Accept will run the query and store the results in results()</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="181" package="phpLDAPadmin\Queries">
        <name>setDN</name>
        <full_name>\Query::setDN()</full_name>
        <docblock line="181">
          <description>This is temporary to get around objects that use a DN for rendering, for example jpegPhoto</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="191" package="phpLDAPadmin\Queries">
        <name>getDN</name>
        <full_name>\Query::getDN()</full_name>
        <docblock line="191">
          <description>This is temporary to get around objects that use a DN for rendering, for example jpegPhoto</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="198" package="phpLDAPadmin\Queries">
        <name>getDNEncode</name>
        <full_name>\Query::getDNEncode()</full_name>
        <docblock line="198">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$url</name>
          <default>true</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="206" package="phpLDAPadmin\Queries">
        <name>getAttrSortOrder</name>
        <full_name>\Query::getAttrSortOrder()</full_name>
        <docblock line="206">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="228" package="phpLDAPadmin\Queries">
        <name>getAttrDisplayOrder</name>
        <full_name>\Query::getAttrDisplayOrder()</full_name>
        <docblock line="228">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="269" package="phpLDAPadmin\Queries">
        <name>isVisible</name>
        <full_name>\Query::isVisible()</full_name>
        <docblock line="269">
          <description>Test if the template is visible</description>
          <long-description></long-description>
          <tag name="return" description="" line="269" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="276" package="phpLDAPadmin\Queries">
        <name>getDescription</name>
        <full_name>\Query::getDescription()</full_name>
        <docblock line="276">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/blowfish.php" generated-path="templates.3rdParty.pla.lib.blowfish.html" hash="554ccb46a8a275145bb76599e8559489" package="horde.cipher">
    <docblock line="0">
      <description>The Cipher_blowfish:: class implements the Cipher interface enryption data
using the Blowfish algorithm.</description>
      <long-description>$Horde: horde/lib/Cipher/blowfish.php,v 1.2.2.3 2003/01/03 13:23:22 jan Exp $

Copyright 2002-2003 Mike Cochrane &lt;mike@graftonhall.co.nz&gt;

See the enclosed file COPYING for license information (LGPL). If you
did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.</long-description>
      <tag name="author" description="Mike Cochrane &amp;lt;mike@graftonhall.co.nz&amp;gt;" line="0"/>
      <tag name="version" description="$Revision: 4149 $" line="0"/>
      <tag name="since" description="Horde 2.2" line="0"/>
      <tag name="package" description="horde.cipher" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="24" package="horde.cipher">
      <extends/>
      <name>Horde_Cipher_blowfish</name>
      <full_name>\Horde_Cipher_blowfish</full_name>
      <docblock line="24">
        <description></description>
        <long-description></long-description>
        <tag name="package" description="horde.cipher" line="24"/>
      </docblock>
      <property static="false" visibility="public" line="27" namespace="" package="horde.cipher">
        <name>$p</name>
        <default>array(608135816, 2242054355, 320440878, 57701188, 2752067618, 698298832, 137296536, 3964562569, 1160258022, 953160567, 3193202383, 887688300, 3232508343, 3380367581, 1065670069, 3041331479, 2450970073, 2306472731)</default>
        <docblock line="27">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="35" namespace="" package="horde.cipher">
        <name>$s1</name>
        <default>array(3509652390, 2564797868, 805139163, 3491422135, 3101798381, 1780907670, 3128725573, 4046225305, 614570311, 3012652279, 134345442, 2240740374, 1667834072, 1901547113, 2757295779, 4103290238, 227898511, 1921955416, 1904987480, 2182433518, 2069144605, 3260701109, 2620446009, 720527379, 3318853667, 677414384, 3393288472, 3101374703, 2390351024, 1614419982, 1822297739, 2954791486, 3608508353, 3174124327, 2024746970, 1432378464, 3864339955, 2857741204, 1464375394, 1676153920, 1439316330, 715854006, 3033291828, 289532110, 2706671279, 2087905683, 3018724369, 1668267050, 732546397, 1947742710, 3462151702, 2609353502, 2950085171, 1814351708, 2050118529, 680887927, 999245976, 1800124847, 3300911131, 1713906067, 1641548236, 4213287313, 1216130144, 1575780402, 4018429277, 3917837745, 3693486850, 3949271944, 596196993, 3549867205, 258830323, 2213823033, 772490370, 2760122372, 1774776394, 2652871518, 566650946, 4142492826, 1728879713, 2882767088, 1783734482, 3629395816, 2517608232, 2874225571, 1861159788, 326777828, 3124490320, 2130389656, 2716951837, 967770486, 1724537150, 2185432712, 2364442137, 1164943284, 2105845187, 998989502, 3765401048, 2244026483, 1075463327, 1455516326, 1322494562, 910128902, 469688178, 1117454909, 936433444, 3490320968, 3675253459, 1240580251, 122909385, 2157517691, 634681816, 4142456567, 3825094682, 3061402683, 2540495037, 79693498, 3249098678, 1084186820, 1583128258, 426386531, 1761308591, 1047286709, 322548459, 995290223, 1845252383, 2603652396, 3431023940, 2942221577, 3202600964, 3727903485, 1712269319, 422464435, 3234572375, 1170764815, 3523960633, 3117677531, 1434042557, 442511882, 3600875718, 1076654713, 1738483198, 4213154764, 2393238008, 3677496056, 1014306527, 4251020053, 793779912, 2902807211, 842905082, 4246964064, 1395751752, 1040244610, 2656851899, 3396308128, 445077038, 3742853595, 3577915638, 679411651, 2892444358, 2354009459, 1767581616, 3150600392, 3791627101, 3102740896, 284835224, 4246832056, 1258075500, 768725851, 2589189241, 3069724005, 3532540348, 1274779536, 3789419226, 2764799539, 1660621633, 3471099624, 4011903706, 913787905, 3497959166, 737222580, 2514213453, 2928710040, 3937242737, 1804850592, 3499020752, 2949064160, 2386320175, 2390070455, 2415321851, 4061277028, 2290661394, 2416832540, 1336762016, 1754252060, 3520065937, 3014181293, 791618072, 3188594551, 3933548030, 2332172193, 3852520463, 3043980520, 413987798, 3465142937, 3030929376, 4245938359, 2093235073, 3534596313, 375366246, 2157278981, 2479649556, 555357303, 3870105701, 2008414854, 3344188149, 4221384143, 3956125452, 2067696032, 3594591187, 2921233993, 2428461, 544322398, 577241275, 1471733935, 610547355, 4027169054, 1432588573, 1507829418, 2025931657, 3646575487, 545086370, 48609733, 2200306550, 1653985193, 298326376, 1316178497, 3007786442, 2064951626, 458293330, 2589141269, 3591329599, 3164325604, 727753846, 2179363840, 146436021, 1461446943, 4069977195, 705550613, 3059967265, 3887724982, 4281599278, 3313849956, 1404054877, 2845806497, 146425753, 1854211946)</default>
        <docblock line="35">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="100" namespace="" package="horde.cipher">
        <name>$s2</name>
        <default>array(1266315497, 3048417604, 3681880366, 3289982499, 2909710000, 1235738493, 2632868024, 2414719590, 3970600049, 1771706367, 1449415276, 3266420449, 422970021, 1963543593, 2690192192, 3826793022, 1062508698, 1531092325, 1804592342, 2583117782, 2714934279, 4024971509, 1294809318, 4028980673, 1289560198, 2221992742, 1669523910, 35572830, 157838143, 1052438473, 1016535060, 1802137761, 1753167236, 1386275462, 3080475397, 2857371447, 1040679964, 2145300060, 2390574316, 1461121720, 2956646967, 4031777805, 4028374788, 33600511, 2920084762, 1018524850, 629373528, 3691585981, 3515945977, 2091462646, 2486323059, 586499841, 988145025, 935516892, 3367335476, 2599673255, 2839830854, 265290510, 3972581182, 2759138881, 3795373465, 1005194799, 847297441, 406762289, 1314163512, 1332590856, 1866599683, 4127851711, 750260880, 613907577, 1450815602, 3165620655, 3734664991, 3650291728, 3012275730, 3704569646, 1427272223, 778793252, 1343938022, 2676280711, 2052605720, 1946737175, 3164576444, 3914038668, 3967478842, 3682934266, 1661551462, 3294938066, 4011595847, 840292616, 3712170807, 616741398, 312560963, 711312465, 1351876610, 322626781, 1910503582, 271666773, 2175563734, 1594956187, 70604529, 3617834859, 1007753275, 1495573769, 4069517037, 2549218298, 2663038764, 504708206, 2263041392, 3941167025, 2249088522, 1514023603, 1998579484, 1312622330, 694541497, 2582060303, 2151582166, 1382467621, 776784248, 2618340202, 3323268794, 2497899128, 2784771155, 503983604, 4076293799, 907881277, 423175695, 432175456, 1378068232, 4145222326, 3954048622, 3938656102, 3820766613, 2793130115, 2977904593, 26017576, 3274890735, 3194772133, 1700274565, 1756076034, 4006520079, 3677328699, 720338349, 1533947780, 354530856, 688349552, 3973924725, 1637815568, 332179504, 3949051286, 53804574, 2852348879, 3044236432, 1282449977, 3583942155, 3416972820, 4006381244, 1617046695, 2628476075, 3002303598, 1686838959, 431878346, 2686675385, 1700445008, 1080580658, 1009431731, 832498133, 3223435511, 2605976345, 2271191193, 2516031870, 1648197032, 4164389018, 2548247927, 300782431, 375919233, 238389289, 3353747414, 2531188641, 2019080857, 1475708069, 455242339, 2609103871, 448939670, 3451063019, 1395535956, 2413381860, 1841049896, 1491858159, 885456874, 4264095073, 4001119347, 1565136089, 3898914787, 1108368660, 540939232, 1173283510, 2745871338, 3681308437, 4207628240, 3343053890, 4016749493, 1699691293, 1103962373, 3625875870, 2256883143, 3830138730, 1031889488, 3479347698, 1535977030, 4236805024, 3251091107, 2132092099, 1774941330, 1199868427, 1452454533, 157007616, 2904115357, 342012276, 595725824, 1480756522, 206960106, 497939518, 591360097, 863170706, 2375253569, 3596610801, 1814182875, 2094937945, 3421402208, 1082520231, 3463918190, 2785509508, 435703966, 3908032597, 1641649973, 2842273706, 3305899714, 1510255612, 2148256476, 2655287854, 3276092548, 4258621189, 236887753, 3681803219, 274041037, 1734335097, 3815195456, 3317970021, 1899903192, 1026095262, 4050517792, 356393447, 2410691914, 3873677099, 3682840055)</default>
        <docblock line="100">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="165" namespace="" package="horde.cipher">
        <name>$s3</name>
        <default>array(3913112168, 2491498743, 4132185628, 2489919796, 1091903735, 1979897079, 3170134830, 3567386728, 3557303409, 857797738, 1136121015, 1342202287, 507115054, 2535736646, 337727348, 3213592640, 1301675037, 2528481711, 1895095763, 1721773893, 3216771564, 62756741, 2142006736, 835421444, 2531993523, 1442658625, 3659876326, 2882144922, 676362277, 1392781812, 170690266, 3921047035, 1759253602, 3611846912, 1745797284, 664899054, 1329594018, 3901205900, 3045908486, 2062866102, 2865634940, 3543621612, 3464012697, 1080764994, 553557557, 3656615353, 3996768171, 991055499, 499776247, 1265440854, 648242737, 3940784050, 980351604, 3713745714, 1749149687, 3396870395, 4211799374, 3640570775, 1161844396, 3125318951, 1431517754, 545492359, 4268468663, 3499529547, 1437099964, 2702547544, 3433638243, 2581715763, 2787789398, 1060185593, 1593081372, 2418618748, 4260947970, 69676912, 2159744348, 86519011, 2512459080, 3838209314, 1220612927, 3339683548, 133810670, 1090789135, 1078426020, 1569222167, 845107691, 3583754449, 4072456591, 1091646820, 628848692, 1613405280, 3757631651, 526609435, 236106946, 48312990, 2942717905, 3402727701, 1797494240, 859738849, 992217954, 4005476642, 2243076622, 3870952857, 3732016268, 765654824, 3490871365, 2511836413, 1685915746, 3888969200, 1414112111, 2273134842, 3281911079, 4080962846, 172450625, 2569994100, 980381355, 4109958455, 2819808352, 2716589560, 2568741196, 3681446669, 3329971472, 1835478071, 660984891, 3704678404, 4045999559, 3422617507, 3040415634, 1762651403, 1719377915, 3470491036, 2693910283, 3642056355, 3138596744, 1364962596, 2073328063, 1983633131, 926494387, 3423689081, 2150032023, 4096667949, 1749200295, 3328846651, 309677260, 2016342300, 1779581495, 3079819751, 111262694, 1274766160, 443224088, 298511866, 1025883608, 3806446537, 1145181785, 168956806, 3641502830, 3584813610, 1689216846, 3666258015, 3200248200, 1692713982, 2646376535, 4042768518, 1618508792, 1610833997, 3523052358, 4130873264, 2001055236, 3610705100, 2202168115, 4028541809, 2961195399, 1006657119, 2006996926, 3186142756, 1430667929, 3210227297, 1314452623, 4074634658, 4101304120, 2273951170, 1399257539, 3367210612, 3027628629, 1190975929, 2062231137, 2333990788, 2221543033, 2438960610, 1181637006, 548689776, 2362791313, 3372408396, 3104550113, 3145860560, 296247880, 1970579870, 3078560182, 3769228297, 1714227617, 3291629107, 3898220290, 166772364, 1251581989, 493813264, 448347421, 195405023, 2709975567, 677966185, 3703036547, 1463355134, 2715995803, 1338867538, 1343315457, 2802222074, 2684532164, 233230375, 2599980071, 2000651841, 3277868038, 1638401717, 4028070440, 3237316320, 6314154, 819756386, 300326615, 590932579, 1405279636, 3267499572, 3150704214, 2428286686, 3959192993, 3461946742, 1862657033, 1266418056, 963775037, 2089974820, 2263052895, 1917689273, 448879540, 3550394620, 3981727096, 150775221, 3627908307, 1303187396, 508620638, 2975983352, 2726630617, 1817252668, 1876281319, 1457606340, 908771278, 3720792119, 3617206836, 2455994898, 1729034894, 1080033504)</default>
        <docblock line="165">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="230" namespace="" package="horde.cipher">
        <name>$s4</name>
        <default>array(976866871, 3556439503, 2881648439, 1522871579, 1555064734, 1336096578, 3548522304, 2579274686, 3574697629, 3205460757, 3593280638, 3338716283, 3079412587, 564236357, 2993598910, 1781952180, 1464380207, 3163844217, 3332601554, 1699332808, 1393555694, 1183702653, 3581086237, 1288719814, 691649499, 2847557200, 2895455976, 3193889540, 2717570544, 1781354906, 1676643554, 2592534050, 3230253752, 1126444790, 2770207658, 2633158820, 2210423226, 2615765581, 2414155088, 3127139286, 673620729, 2805611233, 1269405062, 4015350505, 3341807571, 4149409754, 1057255273, 2012875353, 2162469141, 2276492801, 2601117357, 993977747, 3918593370, 2654263191, 753973209, 36408145, 2530585658, 25011837, 3520020182, 2088578344, 530523599, 2918365339, 1524020338, 1518925132, 3760827505, 3759777254, 1202760957, 3985898139, 3906192525, 674977740, 4174734889, 2031300136, 2019492241, 3983892565, 4153806404, 3822280332, 352677332, 2297720250, 60907813, 90501309, 3286998549, 1016092578, 2535922412, 2839152426, 457141659, 509813237, 4120667899, 652014361, 1966332200, 2975202805, 55981186, 2327461051, 676427537, 3255491064, 2882294119, 3433927263, 1307055953, 942726286, 933058658, 2468411793, 3933900994, 4215176142, 1361170020, 2001714738, 2830558078, 3274259782, 1222529897, 1679025792, 2729314320, 3714953764, 1770335741, 151462246, 3013232138, 1682292957, 1483529935, 471910574, 1539241949, 458788160, 3436315007, 1807016891, 3718408830, 978976581, 1043663428, 3165965781, 1927990952, 4200891579, 2372276910, 3208408903, 3533431907, 1412390302, 2931980059, 4132332400, 1947078029, 3881505623, 4168226417, 2941484381, 1077988104, 1320477388, 886195818, 18198404, 3786409000, 2509781533, 112762804, 3463356488, 1866414978, 891333506, 18488651, 661792760, 1628790961, 3885187036, 3141171499, 876946877, 2693282273, 1372485963, 791857591, 2686433993, 3759982718, 3167212022, 3472953795, 2716379847, 445679433, 3561995674, 3504004811, 3574258232, 54117162, 3331405415, 2381918588, 3769707343, 4154350007, 1140177722, 4074052095, 668550556, 3214352940, 367459370, 261225585, 2610173221, 4209349473, 3468074219, 3265815641, 314222801, 3066103646, 3808782860, 282218597, 3406013506, 3773591054, 379116347, 1285071038, 846784868, 2669647154, 3771962079, 3550491691, 2305946142, 453669953, 1268987020, 3317592352, 3279303384, 3744833421, 2610507566, 3859509063, 266596637, 3847019092, 517658769, 3462560207, 3443424879, 370717030, 4247526661, 2224018117, 4143653529, 4112773975, 2788324899, 2477274417, 1456262402, 2901442914, 1517677493, 1846949527, 2295493580, 3734397586, 2176403920, 1280348187, 1908823572, 3871786941, 846861322, 1172426758, 3287448474, 3383383037, 1655181056, 3139813346, 901632758, 1897031941, 2986607138, 3066810236, 3447102507, 1393639104, 373351379, 950779232, 625454576, 3124240540, 4148612726, 2007998917, 544563296, 2244738638, 2330496472, 2058025392, 1291430526, 424198748, 50039436, 29584100, 3605783033, 2429876329, 2791104160, 1057563949, 3255363231, 3075367218, 3463963227, 1469046755, 985887462)</default>
        <docblock line="230">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="297" namespace="" package="horde.cipher">
        <name>$_rounds</name>
        <default>16</default>
        <docblock line="297">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="300" package="horde.cipher">
        <name>Cipher_blowfish</name>
        <full_name>\Horde_Cipher_blowfish::Cipher_blowfish()</full_name>
        <docblock line="300">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$params</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="309" package="horde.cipher">
        <name>setKey</name>
        <full_name>\Horde_Cipher_blowfish::setKey()</full_name>
        <docblock line="309">
          <description>Set the key to be used for en/decryption</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The key to use&lt;/p&gt;" line="309" type="String" variable="$key">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$key</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="368" package="horde.cipher">
        <name>getBlockSize</name>
        <full_name>\Horde_Cipher_blowfish::getBlockSize()</full_name>
        <docblock line="368">
          <description>Return the size of the blocks that this cipher needs</description>
          <long-description></long-description>
          <tag name="return" description="The number of characters per block" line="368" type="Integer">
            <type>Integer</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="381" package="horde.cipher">
        <name>encryptBlock</name>
        <full_name>\Horde_Cipher_blowfish::encryptBlock()</full_name>
        <docblock line="381">
          <description>Encrypt a block on data.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The data to encrypt&lt;/p&gt;" line="381" type="String" variable="$block">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;String $key  The key to use&lt;/p&gt;&#10;" line="381" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="the encrypted output" line="381" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$block</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$key</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="400" package="horde.cipher">
        <name>_encryptBlock</name>
        <full_name>\Horde_Cipher_blowfish::_encryptBlock()</full_name>
        <docblock line="400">
          <description>Encrypt a block on data.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The data to encrypt.&lt;/p&gt;" line="400" type="String" variable="$L">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;The data to encrypt.&lt;/p&gt;" line="400" type="String" variable="$R">
            <type>String</type>
          </tag>
          <tag name="return" description="The encrypted output." line="400" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$L</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$R</name>
          <default></default>
          <type>String</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="432" package="horde.cipher">
        <name>decryptBlock</name>
        <full_name>\Horde_Cipher_blowfish::decryptBlock()</full_name>
        <docblock line="432">
          <description>Decrypt a block on data.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The data to decrypt&lt;/p&gt;" line="432" type="String" variable="$block">
            <type>String</type>
          </tag>
          <tag name="param" description="&lt;p&gt;String $key  The key to use&lt;/p&gt;&#10;" line="432" type="\optional" variable="">
            <type>\optional</type>
          </tag>
          <tag name="return" description="the decrypted output" line="432" type="String">
            <type>String</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$block</name>
          <default></default>
          <type>String</type>
        </argument>
        <argument line="0">
          <name>$key</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="474" package="horde.cipher">
        <name>_formatKey</name>
        <full_name>\Horde_Cipher_blowfish::_formatKey()</full_name>
        <docblock line="474">
          <description>Converts a text key into an array.</description>
          <long-description></long-description>
          <tag name="return" description="The key." line="474" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$key</name>
          <default></default>
          <type/>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/DateAttribute.php" generated-path="templates.3rdParty.pla.lib.DateAttribute.html" hash="c75ac439a08b258c860ff7d518de13b3" package="phpLDAPadmin">
    <docblock line="0">
      <description>Classes and functions for the template engine.</description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="15" package="phpLDAPadmin\Templates">
      <extends>\Attribute</extends>
      <name>DateAttribute</name>
      <full_name>\DateAttribute</full_name>
      <docblock line="15">
        <description>Represents an attribute whose values are dates</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="15"/>
        <tag name="subpackage" description="Templates" line="15"/>
      </docblock>
    </class>
    <source>eJx1j0sOgkAMhvdziq5ZyAWMQGTpwhguUJjyiDBMaAdNjHe3ENG4cNn2f3zdJ771Jo4iAxEce2QmBnQW6uAq6UbHUI8TSEsgNPgehYBc0znaqWMxpRikVUmhEs065dkZ7dA5sDRTP/qBnKgXh1Xssbpi86vUQ2w2hgv5iVg9CwagyNSVQUtv7cgEM/ZhAZwIrKLwxvAnFlIO5XYr3vy89lXLr5DrnH066C7kLMN38zBPkxzMCyK4YKI=</source>
  </file>
  <file path="templates/3rdParty/pla/lib/ds.php" generated-path="templates.3rdParty.pla.lib.ds.html" hash="2cbd15f72702d4075bbd24488d32b602" package="phpLDAPadmin">
    <docblock line="0">
      <description>Classes and functions for communication of Data Stores</description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <class final="false" abstract="true" namespace="" line="15" package="phpLDAPadmin\DataStore">
      <extends/>
      <name>DS</name>
      <full_name>\DS</full_name>
      <docblock line="15">
        <description>This abstract class provides the basic variables and methods.</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="15"/>
        <tag name="subpackage" description="DataStore" line="15"/>
      </docblock>
      <property static="false" visibility="protected" line="17" namespace="" package="phpLDAPadmin\DataStore">
        <name>$index</name>
        <default></default>
        <docblock line="17">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="20" namespace="" package="phpLDAPadmin\DataStore">
        <name>$default</name>
        <default></default>
        <docblock line="20">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="21" namespace="" package="phpLDAPadmin\DataStore">
        <name>$custom</name>
        <default></default>
        <docblock line="21">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="22" namespace="" package="phpLDAPadmin\DataStore">
        <name>$type</name>
        <default></default>
        <docblock line="22">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="true" static="false" visibility="public" namespace="" line="24" package="phpLDAPadmin\DataStore">
        <name>__construct</name>
        <full_name>\DS::__construct()</full_name>
        <docblock line="24">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$index</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="true" static="false" visibility="protected" namespace="" line="29" package="phpLDAPadmin\DataStore">
        <name>connect</name>
        <full_name>\DS::connect()</full_name>
        <docblock line="29">
          <description>This will make the connection to the datasource</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$method</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$debug</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="true" static="false" visibility="public" namespace="" line="37" package="phpLDAPadmin\DataStore">
        <name>login</name>
        <full_name>\DS::login()</full_name>
        <docblock line="37">
          <description>Login to the datastore
 method: default = anon, connect to ds using bind_id not auth_id.</description>
          <long-description>method: 'user', connect with auth_id
 method: '&lt;freetext&gt;', any custom extra connection to ds.</long-description>
        </docblock>
        <argument line="0">
          <name>$user</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$pass</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$method</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="true" static="false" visibility="public" namespace="" line="42" package="phpLDAPadmin\DataStore">
        <name>query</name>
        <full_name>\DS::query()</full_name>
        <docblock line="42">
          <description>Query the datasource</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$query</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$method</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$index</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$debug</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="true" static="false" visibility="protected" namespace="" line="47" package="phpLDAPadmin\DataStore">
        <name>getErrorMessage</name>
        <full_name>\DS::getErrorMessage()</full_name>
        <docblock line="47">
          <description>Return error details from previous operation</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="true" static="false" visibility="protected" namespace="" line="48" package="phpLDAPadmin\DataStore">
        <name>getErrorNum</name>
        <full_name>\DS::getErrorNum()</full_name>
        <docblock line="48">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="53" package="phpLDAPadmin\DataStore">
        <name>setDefaults</name>
        <full_name>\DS::setDefaults()</full_name>
        <docblock line="53">
          <description>Functions that set and verify object configuration details</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$defaults</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="59" package="phpLDAPadmin\DataStore">
        <name>isDefaultKey</name>
        <full_name>\DS::isDefaultKey()</full_name>
        <docblock line="59">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$key</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="63" package="phpLDAPadmin\DataStore">
        <name>isDefaultSetting</name>
        <full_name>\DS::isDefaultSetting()</full_name>
        <docblock line="63">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$key</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$setting</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="70" package="phpLDAPadmin\DataStore">
        <name>getValue</name>
        <full_name>\DS::getValue()</full_name>
        <docblock line="70">
          <description>Return a configuration value</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$key</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$setting</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$fatal</name>
          <default>true</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="90" package="phpLDAPadmin\DataStore">
        <name>setValue</name>
        <full_name>\DS::setValue()</full_name>
        <docblock line="90">
          <description>Set a configuration value</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$key</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$setting</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$value</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="104" package="phpLDAPadmin\DataStore">
        <name>untested</name>
        <full_name>\DS::untested()</full_name>
        <docblock line="104">
          <description>Return the untested config items</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="118" package="phpLDAPadmin\DataStore">
        <name>getName</name>
        <full_name>\DS::getName()</full_name>
        <docblock line="118">
          <description>Get the name of this datastore</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="131" package="phpLDAPadmin\DataStore">
        <name>getAuthType</name>
        <full_name>\DS::getAuthType()</full_name>
        <docblock line="131">
          <description>Return the authentication type for this object</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="155" package="phpLDAPadmin\DataStore">
        <name>getLogin</name>
        <full_name>\DS::getLogin()</full_name>
        <docblock line="155">
          <description>Get the login name of the user logged into this datastore's connection method
If this returns null, we are not logged in.</description>
          <long-description>If this returns '', we are logged in with anonymous</long-description>
        </docblock>
        <argument line="0">
          <name>$method</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="205" package="phpLDAPadmin\DataStore">
        <name>setLogin</name>
        <full_name>\DS::setLogin()</full_name>
        <docblock line="205">
          <description>Set the login details of the user logged into this datastore's connection method</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$user</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$pass</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$method</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="240" package="phpLDAPadmin\DataStore">
        <name>getPassword</name>
        <full_name>\DS::getPassword()</full_name>
        <docblock line="240">
          <description>Get the login password of the user logged into this datastore's connection method</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$method</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="285" package="phpLDAPadmin\DataStore">
        <name>isLoggedIn</name>
        <full_name>\DS::isLoggedIn()</full_name>
        <docblock line="285">
          <description>Return if this datastore's connection method has been logged into</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$method</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="389" package="phpLDAPadmin\DataStore">
        <name>logout</name>
        <full_name>\DS::logout()</full_name>
        <docblock line="389">
          <description>Logout of this datastore's connection method</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$method</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="422" package="phpLDAPadmin\DataStore">
        <name>isVisible</name>
        <full_name>\DS::isVisible()</full_name>
        <docblock line="422">
          <description>Functions that return the condition of the datasource</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="429" package="phpLDAPadmin\DataStore">
        <name>isReadOnly</name>
        <full_name>\DS::isReadOnly()</full_name>
        <docblock line="429">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="439" package="phpLDAPadmin\DataStore">
        <name>getIndex</name>
        <full_name>\DS::getIndex()</full_name>
        <docblock line="439">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="455" package="phpLDAPadmin\DataStore">
        <name>getMethod</name>
        <full_name>\DS::getMethod()</full_name>
        <docblock line="455">
          <description>Work out which connection method to use.</description>
          <long-description>If a method is passed, then it will be passed back. If no method is passed, then we'll
check to see if the user is logged in. If they are, then 'user' is used, otherwise
'anon' is used.</long-description>
          <tag name="param" description="&lt;p&gt;Server ID&lt;/p&gt;" line="455" type="int" variable="">
            <type>int</type>
          </tag>
          <tag name="return" description="Connection Method" line="455" type="string">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$method</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="480" package="phpLDAPadmin\DataStore">
        <name>isSessionValid</name>
        <full_name>\DS::isSessionValid()</full_name>
        <docblock line="480">
          <description>This method should be overridden in application specific ds files</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="491" package="phpLDAPadmin\DataStore">
        <name>inactivityTime</name>
        <full_name>\DS::inactivityTime()</full_name>
        <docblock line="491">
          <description>Return the time left in seconds until this connection times out. If there is not timeout,
this function will return null.</description>
          <long-description></long-description>
        </docblock>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="508" package="phpLDAPadmin\DataStore">
      <extends/>
      <name>Datastore</name>
      <full_name>\Datastore</full_name>
      <docblock line="508">
        <description>The list of database sources</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="508"/>
        <tag name="subpackage" description="DataStore" line="508"/>
      </docblock>
      <property static="false" visibility="private" line="510" namespace="" package="phpLDAPadmin\DataStore">
        <name>$index</name>
        <default></default>
        <docblock line="510">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="512" namespace="" package="phpLDAPadmin\DataStore">
        <name>$objects</name>
        <default>array()</default>
        <docblock line="512">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="514" namespace="" package="phpLDAPadmin\DataStore">
        <name>$default</name>
        <default></default>
        <docblock line="514">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="516" package="phpLDAPadmin\DataStore">
        <name>__construct</name>
        <full_name>\Datastore::__construct()</full_name>
        <docblock line="516">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="600" package="phpLDAPadmin\DataStore">
        <name>newServer</name>
        <full_name>\Datastore::newServer()</full_name>
        <docblock line="600">
          <description>Create a new database object</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$type</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="616" package="phpLDAPadmin\DataStore">
        <name>setValue</name>
        <full_name>\Datastore::setValue()</full_name>
        <docblock line="616">
          <description>Set values for a database object.</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$key</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$setting</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$value</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="640" package="phpLDAPadmin\DataStore">
        <name>getServerList</name>
        <full_name>\Datastore::getServerList()</full_name>
        <docblock line="640">
          <description>Get a list of all the configured servers.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Only show visible servers.&lt;/p&gt;" line="640" type="boolean" variable="">
            <type>boolean</type>
          </tag>
          <tag name="return" description="list of all configured servers." line="640" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$isVisible</name>
          <default>true</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="673" package="phpLDAPadmin\DataStore">
        <name>Instance</name>
        <full_name>\Datastore::Instance()</full_name>
        <docblock line="673">
          <description>Return an object Instance of a configured database.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Index&lt;/p&gt;" line="673" type="int" variable="">
            <type>int</type>
          </tag>
          <tag name="return" description="Datastore instance object." line="673" type="object">
            <type>object</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$index</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="696" package="phpLDAPadmin\DataStore">
        <name>InstanceName</name>
        <full_name>\Datastore::InstanceName()</full_name>
        <docblock line="696">
          <description>Return an object Instance of a configured database.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Name of the instance to retrieve&lt;/p&gt;" line="696" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="return" description="Datastore instance object." line="696" type="object">
            <type>object</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="714" package="phpLDAPadmin\DataStore">
        <name>InstanceId</name>
        <full_name>\Datastore::InstanceId()</full_name>
        <docblock line="714">
          <description>Return an object Instance of a configured database.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;ID of the instance to retrieve&lt;/p&gt;" line="714" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="return" description="Datastore instance object." line="714" type="object">
            <type>object</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$id</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/ObjectClassAttribute.php" generated-path="templates.3rdParty.pla.lib.ObjectClassAttribute.html" hash="59e6fc02acb4d97f9f7cae83a727c473" package="phpLDAPadmin">
    <docblock line="0">
      <description>Classes and functions for the template engine.</description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="15" package="phpLDAPadmin\Templates">
      <extends>\Attribute</extends>
      <name>ObjectClassAttribute</name>
      <full_name>\ObjectClassAttribute</full_name>
      <docblock line="15">
        <description>Represents an 'objectClass' attribute</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="15"/>
        <tag name="subpackage" description="Templates" line="15"/>
      </docblock>
    </class>
    <source>eJx1jkEOgjAQRfc9xexMWMgFjEB0aaIxXGBoB6hC29CpMTHe3UJsiAu38/9783eF653Is0xABocBvScPaBS0wUjW1nho7QTcEzCNbkAmINNpQ9tIzFCJgftYqWMluk7H6oJq1AYUPWiwbiTDkcVxKTuUd+x+mzHIRdpwJTeRj8w8Aza2uZHkZdgGkHnSTWBKr//YoPShSVn9ne2XN3I2wXm1VskJ9GQyysN6eYm3KPbiAxojX80=</source>
  </file>
  <file path="templates/3rdParty/pla/lib/createlm.php" generated-path="templates.3rdParty.pla.lib.createlm.html" hash="680a5100589c23a8319905e5e1990528" package="lam">
    <docblock line="0">
      <description>This class provides functions to calculate Samba NT and LM hashes.</description>
      <long-description>The code is a conversion from createntlm.pl (Benjamin Kuit) and smbdes.c/md4.c (Andrew Tridgell).</long-description>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="package" description="lam" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="40" package="lam">
      <extends/>
      <name>smbHash</name>
      <full_name>\smbHash</full_name>
      <docblock line="40">
        <description>Calculates NT and LM hashes.</description>
        <long-description>The important functions are lmhash($password) and nthash($password).</long-description>
        <tag name="package" description="lam" line="40"/>
      </docblock>
      <property static="false" visibility="private" line="44" namespace="" package="lam">
        <name>$perm1</name>
        <default>array(57, 49, 41, 33, 25, 17, 9, 1, 58, 50, 42, 34, 26, 18, 10, 2, 59, 51, 43, 35, 27, 19, 11, 3, 60, 52, 44, 36, 63, 55, 47, 39, 31, 23, 15, 7, 62, 54, 46, 38, 30, 22, 14, 6, 61, 53, 45, 37, 29, 21, 13, 5, 28, 20, 12, 4)</default>
        <docblock line="44">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="53" namespace="" package="lam">
        <name>$perm2</name>
        <default>array(14, 17, 11, 24, 1, 5, 3, 28, 15, 6, 21, 10, 23, 19, 12, 4, 26, 8, 16, 7, 27, 20, 13, 2, 41, 52, 31, 37, 47, 55, 30, 40, 51, 45, 33, 48, 44, 49, 39, 56, 34, 53, 46, 42, 50, 36, 29, 32)</default>
        <docblock line="53">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="62" namespace="" package="lam">
        <name>$perm3</name>
        <default>array(58, 50, 42, 34, 26, 18, 10, 2, 60, 52, 44, 36, 28, 20, 12, 4, 62, 54, 46, 38, 30, 22, 14, 6, 64, 56, 48, 40, 32, 24, 16, 8, 57, 49, 41, 33, 25, 17, 9, 1, 59, 51, 43, 35, 27, 19, 11, 3, 61, 53, 45, 37, 29, 21, 13, 5, 63, 55, 47, 39, 31, 23, 15, 7)</default>
        <docblock line="62">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="71" namespace="" package="lam">
        <name>$perm4</name>
        <default>array(32, 1, 2, 3, 4, 5, 4, 5, 6, 7, 8, 9, 8, 9, 10, 11, 12, 13, 12, 13, 14, 15, 16, 17, 16, 17, 18, 19, 20, 21, 20, 21, 22, 23, 24, 25, 24, 25, 26, 27, 28, 29, 28, 29, 30, 31, 32, 1)</default>
        <docblock line="71">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="80" namespace="" package="lam">
        <name>$perm5</name>
        <default>array(16, 7, 20, 21, 29, 12, 28, 17, 1, 15, 23, 26, 5, 18, 31, 10, 2, 8, 24, 14, 32, 27, 3, 9, 19, 13, 30, 6, 22, 11, 4, 25)</default>
        <docblock line="80">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="89" namespace="" package="lam">
        <name>$perm6</name>
        <default>array(40, 8, 48, 16, 56, 24, 64, 32, 39, 7, 47, 15, 55, 23, 63, 31, 38, 6, 46, 14, 54, 22, 62, 30, 37, 5, 45, 13, 53, 21, 61, 29, 36, 4, 44, 12, 52, 20, 60, 28, 35, 3, 43, 11, 51, 19, 59, 27, 34, 2, 42, 10, 50, 18, 58, 26, 33, 1, 41, 9, 49, 17, 57, 25)</default>
        <docblock line="89">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="98" namespace="" package="lam">
        <name>$sc</name>
        <default>array(1, 1, 2, 2, 2, 2, 2, 2, 1, 2, 2, 2, 2, 2, 2, 1)</default>
        <docblock line="98">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="102" namespace="" package="lam">
        <name>$sbox</name>
        <default>array(array(array(14, 4, 13, 1, 2, 15, 11, 8, 3, 10, 6, 12, 5, 9, 0, 7), array(0, 15, 7, 4, 14, 2, 13, 1, 10, 6, 12, 11, 9, 5, 3, 8), array(4, 1, 14, 8, 13, 6, 2, 11, 15, 12, 9, 7, 3, 10, 5, 0), array(15, 12, 8, 2, 4, 9, 1, 7, 5, 11, 3, 14, 10, 0, 6, 13)), array(array(15, 1, 8, 14, 6, 11, 3, 4, 9, 7, 2, 13, 12, 0, 5, 10), array(3, 13, 4, 7, 15, 2, 8, 14, 12, 0, 1, 10, 6, 9, 11, 5), array(0, 14, 7, 11, 10, 4, 13, 1, 5, 8, 12, 6, 9, 3, 2, 15), array(13, 8, 10, 1, 3, 15, 4, 2, 11, 6, 7, 12, 0, 5, 14, 9)), array(array(10, 0, 9, 14, 6, 3, 15, 5, 1, 13, 12, 7, 11, 4, 2, 8), array(13, 7, 0, 9, 3, 4, 6, 10, 2, 8, 5, 14, 12, 11, 15, 1), array(13, 6, 4, 9, 8, 15, 3, 0, 11, 1, 2, 12, 5, 10, 14, 7), array(1, 10, 13, 0, 6, 9, 8, 7, 4, 15, 14, 3, 11, 5, 2, 12)), array(array(7, 13, 14, 3, 0, 6, 9, 10, 1, 2, 8, 5, 11, 12, 4, 15), array(13, 8, 11, 5, 6, 15, 0, 3, 4, 7, 2, 12, 1, 10, 14, 9), array(10, 6, 9, 0, 12, 11, 7, 13, 15, 1, 3, 14, 5, 2, 8, 4), array(3, 15, 0, 6, 10, 1, 13, 8, 9, 4, 5, 11, 12, 7, 2, 14)), array(array(2, 12, 4, 1, 7, 10, 11, 6, 8, 5, 3, 15, 13, 0, 14, 9), array(14, 11, 2, 12, 4, 7, 13, 1, 5, 0, 15, 10, 3, 9, 8, 6), array(4, 2, 1, 11, 10, 13, 7, 8, 15, 9, 12, 5, 6, 3, 0, 14), array(11, 8, 12, 7, 1, 14, 2, 13, 6, 15, 0, 9, 10, 4, 5, 3)), array(array(12, 1, 10, 15, 9, 2, 6, 8, 0, 13, 3, 4, 14, 7, 5, 11), array(10, 15, 4, 2, 7, 12, 9, 5, 6, 1, 13, 14, 0, 11, 3, 8), array(9, 14, 15, 5, 2, 8, 12, 3, 7, 0, 4, 10, 1, 13, 11, 6), array(4, 3, 2, 12, 9, 5, 15, 10, 11, 14, 1, 7, 6, 0, 8, 13)), array(array(4, 11, 2, 14, 15, 0, 8, 13, 3, 12, 9, 7, 5, 10, 6, 1), array(13, 0, 11, 7, 4, 9, 1, 10, 14, 3, 5, 12, 2, 15, 8, 6), array(1, 4, 11, 13, 12, 3, 7, 14, 10, 15, 6, 8, 0, 5, 9, 2), array(6, 11, 13, 8, 1, 4, 10, 7, 9, 5, 0, 15, 14, 2, 3, 12)), array(array(13, 2, 8, 4, 6, 15, 11, 1, 10, 9, 3, 14, 5, 0, 12, 7), array(1, 15, 13, 8, 10, 3, 7, 4, 12, 5, 6, 11, 0, 14, 9, 2), array(7, 11, 4, 1, 9, 12, 14, 2, 0, 6, 10, 13, 15, 3, 5, 8), array(2, 1, 14, 7, 4, 10, 8, 13, 15, 12, 9, 0, 3, 5, 6, 11)))</default>
        <docblock line="102">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="138" package="lam">
        <name>x</name>
        <full_name>\smbHash::x()</full_name>
        <docblock line="138">
          <description>Fixes too large numbers</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="148" package="lam">
        <name>lshift</name>
        <full_name>\smbHash::lshift()</full_name>
        <docblock line="148">
          <description></description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;count&lt;/p&gt;" line="148" type="integer" variable="">
            <type>integer</type>
          </tag>
          <tag name="param" description="" line="148" type="array" variable="$data">
            <type>array</type>
          </tag>
          <tag name="return" description="" line="148" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$count</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$data</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="161" package="lam">
        <name>permute</name>
        <full_name>\smbHash::permute()</full_name>
        <docblock line="161">
          <description></description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;in input data&lt;/p&gt;" line="161" type="array" variable="">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;p permutation&lt;/p&gt;" line="161" type="array" variable="">
            <type>array</type>
          </tag>
          <tag name="return" description="" line="161" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$in</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$p</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$n</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="174" package="lam">
        <name>mxor</name>
        <full_name>\smbHash::mxor()</full_name>
        <docblock line="174">
          <description></description>
          <long-description></long-description>
          <tag name="param" description="" line="174" type="array" variable="$in1">
            <type>array</type>
          </tag>
          <tag name="param" description="" line="174" type="array" variable="$in2">
            <type>array</type>
          </tag>
          <tag name="return" description="" line="174" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$in1</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$in2</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="188" package="lam">
        <name>doHash</name>
        <full_name>\smbHash::doHash()</full_name>
        <docblock line="188">
          <description></description>
          <long-description></long-description>
          <tag name="param" description="" line="188" type="array" variable="$in">
            <type>array</type>
          </tag>
          <tag name="param" description="" line="188" type="array" variable="$key">
            <type>array</type>
          </tag>
          <tag name="param" description="" line="188" type="boolean" variable="$forw">
            <type>boolean</type>
          </tag>
          <tag name="return" description="" line="188" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$in</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$key</name>
          <default></default>
          <type>array</type>
        </argument>
        <argument line="0">
          <name>$forw</name>
          <default></default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="260" package="lam">
        <name>str_to_key</name>
        <full_name>\smbHash::str_to_key()</full_name>
        <docblock line="260">
          <description>str_to_key</description>
          <long-description></long-description>
          <tag name="param" description="" line="260" type="string" variable="$str">
            <type>string</type>
          </tag>
          <tag name="return" description="key" line="260" type="string">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$str</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="283" package="lam">
        <name>smb_hash</name>
        <full_name>\smbHash::smb_hash()</full_name>
        <docblock line="283">
          <description>smb_hash</description>
          <long-description></long-description>
          <tag name="param" description="" line="283" type="\unknown_type" variable="$in">
            <type>\unknown_type</type>
          </tag>
          <tag name="param" description="" line="283" type="\unknown_type" variable="$key">
            <type>\unknown_type</type>
          </tag>
          <tag name="param" description="" line="283" type="\unknown_type" variable="$forw">
            <type>\unknown_type</type>
          </tag>
          <tag name="return" description="" line="283" type="\unknown">
            <type>\unknown</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$in</name>
          <default></default>
          <type>\unknown_type</type>
        </argument>
        <argument line="0">
          <name>$key</name>
          <default></default>
          <type>\unknown_type</type>
        </argument>
        <argument line="0">
          <name>$forw</name>
          <default></default>
          <type>\unknown_type</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="309" package="lam">
        <name>E_P16</name>
        <full_name>\smbHash::E_P16()</full_name>
        <docblock line="309">
          <description>E_P16</description>
          <long-description></long-description>
          <tag name="param" description="" line="309" type="\unknown_type" variable="$in">
            <type>\unknown_type</type>
          </tag>
          <tag name="return" description="" line="309" type="\unknown">
            <type>\unknown</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$in</name>
          <default></default>
          <type>\unknown_type</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="333" package="lam">
        <name>lmhash</name>
        <full_name>\smbHash::lmhash()</full_name>
        <docblock line="333">
          <description>Calculates the LM hash of a given password.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;password&lt;/p&gt;" line="333" type="string" variable="$password">
            <type>string</type>
          </tag>
          <tag name="return" description="hash value" line="333" type="string">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$password</name>
          <default>""</default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="350" package="lam">
        <name>nthash</name>
        <full_name>\smbHash::nthash()</full_name>
        <docblock line="350">
          <description>Calculates the NT hash of a given password.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;password&lt;/p&gt;" line="350" type="string" variable="$password">
            <type>string</type>
          </tag>
          <tag name="return" description="hash value" line="350" type="string">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$password</name>
          <default>""</default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="359" package="lam">
        <name>unsigned_shift_r</name>
        <full_name>\smbHash::unsigned_shift_r()</full_name>
        <docblock line="359">
          <description>Unsigned shift operation for 32bit values.</description>
          <long-description>PHP 4 only supports signed shifts by default.</long-description>
        </docblock>
        <argument line="0">
          <name>$a</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$b</name>
          <default></default>
          <type/>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/import_functions.php" generated-path="templates.3rdParty.pla.lib.import_functions.html" hash="0514b6b52ce659d441215eb550135c23" package="phpLDAPadmin">
    <docblock line="0">
      <description>Classes and functions for importing data to LDAP</description>
      <long-description>These classes provide differnet import formats.</long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="see" description="and import_form.php" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="21" package="phpLDAPadmin\Import">
      <extends/>
      <name>Importer</name>
      <full_name>\Importer</full_name>
      <docblock line="21">
        <description>Importer Class</description>
        <long-description>This class serves as a top level importer class, which will return
the correct Import class.</long-description>
        <tag name="package" description="phpLDAPadmin" line="21"/>
        <tag name="subpackage" description="Import" line="21"/>
      </docblock>
      <property static="false" visibility="private" line="23" namespace="" package="phpLDAPadmin\Import">
        <name>$server_id</name>
        <default></default>
        <docblock line="23">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="25" namespace="" package="phpLDAPadmin\Import">
        <name>$template_id</name>
        <default></default>
        <docblock line="25">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="26" namespace="" package="phpLDAPadmin\Import">
        <name>$template</name>
        <default></default>
        <docblock line="26">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="28" package="phpLDAPadmin\Import">
        <name>__construct</name>
        <full_name>\Importer::__construct()</full_name>
        <docblock line="28">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$server_id</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$template_id</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="35" package="phpLDAPadmin\Import">
        <name>types</name>
        <full_name>\Importer::types()</full_name>
        <docblock line="35">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="44" package="phpLDAPadmin\Import">
        <name>accept</name>
        <full_name>\Importer::accept()</full_name>
        <docblock line="44">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="57" package="phpLDAPadmin\Import">
        <name>getTemplate</name>
        <full_name>\Importer::getTemplate()</full_name>
        <docblock line="57">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
    </class>
    <class final="false" abstract="true" namespace="" line="71" package="phpLDAPadmin\Import">
      <extends/>
      <name>Import</name>
      <full_name>\Import</full_name>
      <docblock line="71">
        <description>Import Class</description>
        <long-description>This abstract classes provides all the common methods and variables for the
custom import classes.</long-description>
        <tag name="package" description="phpLDAPadmin" line="71"/>
        <tag name="subpackage" description="Import" line="71"/>
      </docblock>
      <property static="false" visibility="protected" line="72" namespace="" package="phpLDAPadmin\Import">
        <name>$server_id</name>
        <default>null</default>
        <docblock line="72">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="73" namespace="" package="phpLDAPadmin\Import">
        <name>$input</name>
        <default>null</default>
        <docblock line="73">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="74" namespace="" package="phpLDAPadmin\Import">
        <name>$source</name>
        <default>array()</default>
        <docblock line="74">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="76" package="phpLDAPadmin\Import">
        <name>__construct</name>
        <full_name>\Import::__construct()</full_name>
        <docblock line="76">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$server_id</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="80" package="phpLDAPadmin\Import">
        <name>accept</name>
        <full_name>\Import::accept()</full_name>
        <docblock line="80">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="102" package="phpLDAPadmin\Import">
        <name>getSource</name>
        <full_name>\Import::getSource()</full_name>
        <docblock line="102">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attr</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="110" package="phpLDAPadmin\Import">
        <name>LDAPimport</name>
        <full_name>\Import::LDAPimport()</full_name>
        <docblock line="110">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="142" package="phpLDAPadmin\Import">
      <extends>\Import</extends>
      <name>ImportLDIF</name>
      <full_name>\ImportLDIF</full_name>
      <docblock line="142">
        <description>Import entries from LDIF</description>
        <long-description>The LDIF spec is described by RFC2849
http://www.ietf.org/rfc/rfc2849.txt</long-description>
        <tag name="package" description="phpLDAPadmin" line="142"/>
        <tag name="subpackage" description="Import" line="142"/>
      </docblock>
      <property static="false" visibility="private" line="143" namespace="" package="phpLDAPadmin\Import">
        <name>$_currentLineNumber</name>
        <default>0</default>
        <docblock line="143">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="144" namespace="" package="phpLDAPadmin\Import">
        <name>$_currentLine</name>
        <default>''</default>
        <docblock line="144">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="145" namespace="" package="phpLDAPadmin\Import">
        <name>$template</name>
        <default></default>
        <docblock line="145">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="146" namespace="" package="phpLDAPadmin\Import">
        <name>$error</name>
        <default>array()</default>
        <docblock line="146">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="148" package="phpLDAPadmin\Import">
        <name>getType</name>
        <full_name>\ImportLDIF::getType()</full_name>
        <docblock line="148">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="152" package="phpLDAPadmin\Import">
        <name>getTemplate</name>
        <full_name>\ImportLDIF::getTemplate()</full_name>
        <docblock line="152">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="156" package="phpLDAPadmin\Import">
        <name>getServer</name>
        <full_name>\ImportLDIF::getServer()</full_name>
        <docblock line="156">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="160" package="phpLDAPadmin\Import">
        <name>readEntry</name>
        <full_name>\ImportLDIF::readEntry()</full_name>
        <docblock line="160">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="246" package="phpLDAPadmin\Import">
        <name>getAttrValue</name>
        <full_name>\ImportLDIF::getAttrValue()</full_name>
        <docblock line="246">
          <description>Get the Attribute and Decoded Value</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$line</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="263" package="phpLDAPadmin\Import">
        <name>nextLines</name>
        <full_name>\ImportLDIF::nextLines()</full_name>
        <docblock line="263">
          <description>Get the lines of the next entry</description>
          <long-description></long-description>
          <tag name="return" description="lines (unfolded) of the next entry" line="263" type="\The">
            <type>\The</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="301" package="phpLDAPadmin\Import">
        <name>hasMoreEntries</name>
        <full_name>\ImportLDIF::hasMoreEntries()</full_name>
        <docblock line="301">
          <description>Private method to check if there is more entries in the input.</description>
          <long-description></long-description>
          <tag name="return" description="true if an entry was found, false otherwise." line="301" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="323" package="phpLDAPadmin\Import">
        <name>nextLine</name>
        <full_name>\ImportLDIF::nextLine()</full_name>
        <docblock line="323">
          <description>Helper method to switch to the next line</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="333" package="phpLDAPadmin\Import">
        <name>isCommentLine</name>
        <full_name>\ImportLDIF::isCommentLine()</full_name>
        <docblock line="333">
          <description>Check if it's a comment line.</description>
          <long-description></long-description>
          <tag name="return" description="true if it&amp;#039;s a comment line,false otherwise" line="333" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="342" package="phpLDAPadmin\Import">
        <name>isWrappedLine</name>
        <full_name>\ImportLDIF::isWrappedLine()</full_name>
        <docblock line="342">
          <description>Check if it's a wrapped line.</description>
          <long-description></long-description>
          <tag name="return" description="true if it&amp;#039;s a wrapped line,false otherwise" line="342" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="351" package="phpLDAPadmin\Import">
        <name>isBlankLine</name>
        <full_name>\ImportLDIF::isBlankLine()</full_name>
        <docblock line="351">
          <description>Check if is the current line is a blank line.</description>
          <long-description></long-description>
          <tag name="return" description="if it is a blank line,false otherwise." line="351" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="360" package="phpLDAPadmin\Import">
        <name>eof</name>
        <full_name>\ImportLDIF::eof()</full_name>
        <docblock line="360">
          <description>Returns true if we reached the end of the input.</description>
          <long-description></long-description>
          <tag name="return" description="true if it&amp;#039;s the end of file, false otherwise." line="360" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="364" package="phpLDAPadmin\Import">
        <name>error</name>
        <full_name>\ImportLDIF::error()</full_name>
        <docblock line="364">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$msg</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$data</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="377" package="phpLDAPadmin\Import">
        <name>getAttributeValue</name>
        <full_name>\ImportLDIF::getAttributeValue()</full_name>
        <docblock line="377">
          <description>Method to retrieve the attribute value of a ldif line,
and get the base 64 decoded value if it is encoded</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$value</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="408" package="phpLDAPadmin\Import">
        <name>getAddDetails</name>
        <full_name>\ImportLDIF::getAddDetails()</full_name>
        <docblock line="408">
          <description>Build the attributes array when the change type is add.</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$lines</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="427" package="phpLDAPadmin\Import">
        <name>getModifyDetails</name>
        <full_name>\ImportLDIF::getModifyDetails()</full_name>
        <docblock line="427">
          <description>Build the attributes array for the entry when the change type is modify</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$lines</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="554" package="phpLDAPadmin\Import">
        <name>getModRDNAttributes</name>
        <full_name>\ImportLDIF::getModRDNAttributes()</full_name>
        <docblock line="554">
          <description>Build the attributes for the entry when the change type is modrdn</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$lines</name>
          <default></default>
          <type/>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/Attribute.php" generated-path="templates.3rdParty.pla.lib.Attribute.html" hash="8c5cc7f3fa1722c815e6d2a5c2c263b8" package="phpLDAPadmin">
    <docblock line="0">
      <description>Classes and functions for the template engine.</description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="15" package="phpLDAPadmin\Templates">
      <extends/>
      <name>Attribute</name>
      <full_name>\Attribute</full_name>
      <docblock line="15">
        <description>Represents an attribute of a template.</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="15"/>
        <tag name="subpackage" description="Templates" line="15"/>
      </docblock>
      <property static="false" visibility="public" line="17" namespace="" package="phpLDAPadmin\Templates">
        <name>$name</name>
        <default></default>
        <docblock line="17">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="19" namespace="" package="phpLDAPadmin\Templates">
        <name>$source</name>
        <default></default>
        <docblock line="19">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="22" namespace="" package="phpLDAPadmin\Templates">
        <name>$oldvalues</name>
        <default>array()</default>
        <docblock line="22">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="23" namespace="" package="phpLDAPadmin\Templates">
        <name>$values</name>
        <default>array()</default>
        <docblock line="23">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="26" namespace="" package="phpLDAPadmin\Templates">
        <name>$min_value_count</name>
        <default>-1</default>
        <docblock line="26">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="27" namespace="" package="phpLDAPadmin\Templates">
        <name>$max_value_count</name>
        <default>-1</default>
        <docblock line="27">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="30" namespace="" package="phpLDAPadmin\Templates">
        <name>$internal</name>
        <default>false</default>
        <docblock line="30">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="32" namespace="" package="phpLDAPadmin\Templates">
        <name>$modified</name>
        <default>false</default>
        <docblock line="32">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="34" namespace="" package="phpLDAPadmin\Templates">
        <name>$forcedelete</name>
        <default>false</default>
        <docblock line="34">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="36" namespace="" package="phpLDAPadmin\Templates">
        <name>$visible</name>
        <default>false</default>
        <docblock line="36">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="37" namespace="" package="phpLDAPadmin\Templates">
        <name>$forcehide</name>
        <default>false</default>
        <docblock line="37">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="39" namespace="" package="phpLDAPadmin\Templates">
        <name>$readonly</name>
        <default>false</default>
        <docblock line="39">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="41" namespace="" package="phpLDAPadmin\Templates">
        <name>$ldaptype</name>
        <default>null</default>
        <docblock line="41">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="43" namespace="" package="phpLDAPadmin\Templates">
        <name>$type</name>
        <default>''</default>
        <docblock line="43">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="45" namespace="" package="phpLDAPadmin\Templates">
        <name>$unique</name>
        <default>false</default>
        <docblock line="45">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="48" namespace="" package="phpLDAPadmin\Templates">
        <name>$display</name>
        <default>''</default>
        <docblock line="48">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="49" namespace="" package="phpLDAPadmin\Templates">
        <name>$icon</name>
        <default>''</default>
        <docblock line="49">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="50" namespace="" package="phpLDAPadmin\Templates">
        <name>$hint</name>
        <default>''</default>
        <docblock line="50">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="52" namespace="" package="phpLDAPadmin\Templates">
        <name>$helper</name>
        <default>array()</default>
        <docblock line="52">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="53" namespace="" package="phpLDAPadmin\Templates">
        <name>$helpervalue</name>
        <default>array()</default>
        <docblock line="53">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="55" namespace="" package="phpLDAPadmin\Templates">
        <name>$onchange</name>
        <default>array()</default>
        <docblock line="55">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="57" namespace="" package="phpLDAPadmin\Templates">
        <name>$spacer</name>
        <default>false</default>
        <docblock line="57">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="58" namespace="" package="phpLDAPadmin\Templates">
        <name>$verify</name>
        <default>false</default>
        <docblock line="58">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="61" namespace="" package="phpLDAPadmin\Templates">
        <name>$size</name>
        <default>0</default>
        <docblock line="61">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="63" namespace="" package="phpLDAPadmin\Templates">
        <name>$maxlength</name>
        <default>0</default>
        <docblock line="63">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="65" namespace="" package="phpLDAPadmin\Templates">
        <name>$cols</name>
        <default>0</default>
        <docblock line="65">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="66" namespace="" package="phpLDAPadmin\Templates">
        <name>$rows</name>
        <default>0</default>
        <docblock line="66">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="69" namespace="" package="phpLDAPadmin\Templates">
        <name>$page</name>
        <default>1</default>
        <docblock line="69">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="70" namespace="" package="phpLDAPadmin\Templates">
        <name>$order</name>
        <default>255</default>
        <docblock line="70">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="71" namespace="" package="phpLDAPadmin\Templates">
        <name>$ordersort</name>
        <default>255</default>
        <docblock line="71">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="public" line="72" namespace="" package="phpLDAPadmin\Templates">
        <name>$rdn</name>
        <default>false</default>
        <docblock line="72">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="75" namespace="" package="phpLDAPadmin\Templates">
        <name>$aliases</name>
        <default>array()</default>
        <docblock line="75">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="78" namespace="" package="phpLDAPadmin\Templates">
        <name>$autovalue</name>
        <default>array()</default>
        <docblock line="78">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="79" namespace="" package="phpLDAPadmin\Templates">
        <name>$postvalue</name>
        <default>array()</default>
        <docblock line="79">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="81" package="phpLDAPadmin\Templates">
        <name>__construct</name>
        <full_name>\Attribute::__construct()</full_name>
        <docblock line="81">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$server_id</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$source</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="131" package="phpLDAPadmin\Templates">
        <name>getName</name>
        <full_name>\Attribute::getName()</full_name>
        <docblock line="131">
          <description>Return the name of the attribute.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;ul&gt;&#10;&lt;li&gt;Return the attribute in normal or lower case (default lower)&lt;/li&gt;&#10;&lt;/ul&gt;&#10;" line="131" type="boolean" variable="$lower">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;ul&gt;&#10;&lt;li&gt;Return the real attribute name (with ;binary, or just the name)&lt;/li&gt;&#10;&lt;/ul&gt;&#10;" line="131" type="boolean" variable="$real">
            <type>boolean</type>
          </tag>
          <tag name="return" description="Attribute name" line="131" type="string">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$lower</name>
          <default>true</default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$real</name>
          <default>false</default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="141" package="phpLDAPadmin\Templates">
        <name>getValues</name>
        <full_name>\Attribute::getValues()</full_name>
        <docblock line="141">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="148" package="phpLDAPadmin\Templates">
        <name>getOldValues</name>
        <full_name>\Attribute::getOldValues()</full_name>
        <docblock line="148">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="155" package="phpLDAPadmin\Templates">
        <name>getValueCount</name>
        <full_name>\Attribute::getValueCount()</full_name>
        <docblock line="155">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="162" package="phpLDAPadmin\Templates">
        <name>getSource</name>
        <full_name>\Attribute::getSource()</full_name>
        <docblock line="162">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="172" package="phpLDAPadmin\Templates">
        <name>autoValue</name>
        <full_name>\Attribute::autoValue()</full_name>
        <docblock line="172">
          <description>Autovalue is called after the attribute is initialised, and thus the values from the ldap server will be set.</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$new_val</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="182" package="phpLDAPadmin\Templates">
        <name>initValue</name>
        <full_name>\Attribute::initValue()</full_name>
        <docblock line="182">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$new_val</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="194" package="phpLDAPadmin\Templates">
        <name>clearValue</name>
        <full_name>\Attribute::clearValue()</full_name>
        <docblock line="194">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="201" package="phpLDAPadmin\Templates">
        <name>setOldValue</name>
        <full_name>\Attribute::setOldValue()</full_name>
        <docblock line="201">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$val</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="208" package="phpLDAPadmin\Templates">
        <name>setValue</name>
        <full_name>\Attribute::setValue()</full_name>
        <docblock line="208">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$new_val</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="230" package="phpLDAPadmin\Templates">
        <name>addValue</name>
        <full_name>\Attribute::addValue()</full_name>
        <docblock line="230">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$new_val</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default>-1</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="244" package="phpLDAPadmin\Templates">
        <name>delValue</name>
        <full_name>\Attribute::delValue()</full_name>
        <docblock line="244">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$i</name>
          <default>-1</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="261" package="phpLDAPadmin\Templates">
        <name>getValue</name>
        <full_name>\Attribute::getValue()</full_name>
        <docblock line="261">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="271" package="phpLDAPadmin\Templates">
        <name>getOldValue</name>
        <full_name>\Attribute::getOldValue()</full_name>
        <docblock line="271">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="281" package="phpLDAPadmin\Templates">
        <name>getMinValueCount</name>
        <full_name>\Attribute::getMinValueCount()</full_name>
        <docblock line="281">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="288" package="phpLDAPadmin\Templates">
        <name>setMinValueCount</name>
        <full_name>\Attribute::setMinValueCount()</full_name>
        <docblock line="288">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$min</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="295" package="phpLDAPadmin\Templates">
        <name>getMaxValueCount</name>
        <full_name>\Attribute::getMaxValueCount()</full_name>
        <docblock line="295">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="302" package="phpLDAPadmin\Templates">
        <name>setMaxValueCount</name>
        <full_name>\Attribute::setMaxValueCount()</full_name>
        <docblock line="302">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$max</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="309" package="phpLDAPadmin\Templates">
        <name>haveMoreValues</name>
        <full_name>\Attribute::haveMoreValues()</full_name>
        <docblock line="309">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="319" package="phpLDAPadmin\Templates">
        <name>justModified</name>
        <full_name>\Attribute::justModified()</full_name>
        <docblock line="319">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="326" package="phpLDAPadmin\Templates">
        <name>hasBeenModified</name>
        <full_name>\Attribute::hasBeenModified()</full_name>
        <docblock line="326">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="333" package="phpLDAPadmin\Templates">
        <name>isForceDelete</name>
        <full_name>\Attribute::isForceDelete()</full_name>
        <docblock line="333">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="340" package="phpLDAPadmin\Templates">
        <name>setForceDelete</name>
        <full_name>\Attribute::setForceDelete()</full_name>
        <docblock line="340">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="350" package="phpLDAPadmin\Templates">
        <name>isInternal</name>
        <full_name>\Attribute::isInternal()</full_name>
        <docblock line="350">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="357" package="phpLDAPadmin\Templates">
        <name>setInternal</name>
        <full_name>\Attribute::setInternal()</full_name>
        <docblock line="357">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="364" package="phpLDAPadmin\Templates">
        <name>isRequired</name>
        <full_name>\Attribute::isRequired()</full_name>
        <docblock line="364">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="378" package="phpLDAPadmin\Templates">
        <name>isMay</name>
        <full_name>\Attribute::isMay()</full_name>
        <docblock line="378">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="388" package="phpLDAPadmin\Templates">
        <name>setType</name>
        <full_name>\Attribute::setType()</full_name>
        <docblock line="388">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$type</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="395" package="phpLDAPadmin\Templates">
        <name>getType</name>
        <full_name>\Attribute::getType()</full_name>
        <docblock line="395">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="402" package="phpLDAPadmin\Templates">
        <name>setLDAPtype</name>
        <full_name>\Attribute::setLDAPtype()</full_name>
        <docblock line="402">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$type</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="409" package="phpLDAPadmin\Templates">
        <name>getLDAPtype</name>
        <full_name>\Attribute::getLDAPtype()</full_name>
        <docblock line="409">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="416" package="phpLDAPadmin\Templates">
        <name>setProperties</name>
        <full_name>\Attribute::setProperties()</full_name>
        <docblock line="416">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$properties</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="451" package="phpLDAPadmin\Templates">
        <name>setRequired</name>
        <full_name>\Attribute::setRequired()</full_name>
        <docblock line="451">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="459" package="phpLDAPadmin\Templates">
        <name>setOptional</name>
        <full_name>\Attribute::setOptional()</full_name>
        <docblock line="459">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="466" package="phpLDAPadmin\Templates">
        <name>isReadOnly</name>
        <full_name>\Attribute::isReadOnly()</full_name>
        <docblock line="466">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="473" package="phpLDAPadmin\Templates">
        <name>setReadOnly</name>
        <full_name>\Attribute::setReadOnly()</full_name>
        <docblock line="473">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="480" package="phpLDAPadmin\Templates">
        <name>isMultiple</name>
        <full_name>\Attribute::isMultiple()</full_name>
        <docblock line="480">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="484" package="phpLDAPadmin\Templates">
        <name>isVisible</name>
        <full_name>\Attribute::isVisible()</full_name>
        <docblock line="484">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="491" package="phpLDAPadmin\Templates">
        <name>hide</name>
        <full_name>\Attribute::hide()</full_name>
        <docblock line="491">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="498" package="phpLDAPadmin\Templates">
        <name>show</name>
        <full_name>\Attribute::show()</full_name>
        <docblock line="498">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="505" package="phpLDAPadmin\Templates">
        <name>haveFriendlyName</name>
        <full_name>\Attribute::haveFriendlyName()</full_name>
        <docblock line="505">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="512" package="phpLDAPadmin\Templates">
        <name>getFriendlyName</name>
        <full_name>\Attribute::getFriendlyName()</full_name>
        <docblock line="512">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="522" package="phpLDAPadmin\Templates">
        <name>setDescription</name>
        <full_name>\Attribute::setDescription()</full_name>
        <docblock line="522">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$description</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="529" package="phpLDAPadmin\Templates">
        <name>getDescription</name>
        <full_name>\Attribute::getDescription()</full_name>
        <docblock line="529">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="536" package="phpLDAPadmin\Templates">
        <name>setIcon</name>
        <full_name>\Attribute::setIcon()</full_name>
        <docblock line="536">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$icon</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="543" package="phpLDAPadmin\Templates">
        <name>getIcon</name>
        <full_name>\Attribute::getIcon()</full_name>
        <docblock line="543">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="550" package="phpLDAPadmin\Templates">
        <name>getHint</name>
        <full_name>\Attribute::getHint()</full_name>
        <docblock line="550">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="557" package="phpLDAPadmin\Templates">
        <name>setHint</name>
        <full_name>\Attribute::setHint()</full_name>
        <docblock line="557">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$hint</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="564" package="phpLDAPadmin\Templates">
        <name>getMaxLength</name>
        <full_name>\Attribute::getMaxLength()</full_name>
        <docblock line="564">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="571" package="phpLDAPadmin\Templates">
        <name>setMaxLength</name>
        <full_name>\Attribute::setMaxLength()</full_name>
        <docblock line="571">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$maxlength</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="578" package="phpLDAPadmin\Templates">
        <name>getSize</name>
        <full_name>\Attribute::getSize()</full_name>
        <docblock line="578">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="585" package="phpLDAPadmin\Templates">
        <name>setSize</name>
        <full_name>\Attribute::setSize()</full_name>
        <docblock line="585">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$size</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="592" package="phpLDAPadmin\Templates">
        <name>getSpacer</name>
        <full_name>\Attribute::getSpacer()</full_name>
        <docblock line="592">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="599" package="phpLDAPadmin\Templates">
        <name>getPage</name>
        <full_name>\Attribute::getPage()</full_name>
        <docblock line="599">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="605" package="phpLDAPadmin\Templates">
        <name>setPage</name>
        <full_name>\Attribute::setPage()</full_name>
        <docblock line="605">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$page</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="612" package="phpLDAPadmin\Templates">
        <name>getOnChange</name>
        <full_name>\Attribute::getOnChange()</full_name>
        <docblock line="612">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="619" package="phpLDAPadmin\Templates">
        <name>getHelper</name>
        <full_name>\Attribute::getHelper()</full_name>
        <docblock line="619">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="626" package="phpLDAPadmin\Templates">
        <name>getHelperValue</name>
        <full_name>\Attribute::getHelperValue()</full_name>
        <docblock line="626">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="633" package="phpLDAPadmin\Templates">
        <name>getVerify</name>
        <full_name>\Attribute::getVerify()</full_name>
        <docblock line="633">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="640" package="phpLDAPadmin\Templates">
        <name>setRDN</name>
        <full_name>\Attribute::setRDN()</full_name>
        <docblock line="640">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$rdn</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="652" package="phpLDAPadmin\Templates">
        <name>isRDN</name>
        <full_name>\Attribute::isRDN()</full_name>
        <docblock line="652">
          <description>Return if this attribute is an RDN attribute</description>
          <long-description></long-description>
          <tag name="return" description="" line="652" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="664" package="phpLDAPadmin\Templates">
        <name>setLDAPdetails</name>
        <full_name>\Attribute::setLDAPdetails()</full_name>
        <docblock line="664">
          <description>Capture all the LDAP details we are interested in</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Schema Attribute&lt;/p&gt;" line="664" type="\sattr" variable="">
            <type>\sattr</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$sattr</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="684" package="phpLDAPadmin\Templates">
        <name>getAliases</name>
        <full_name>\Attribute::getAliases()</full_name>
        <docblock line="684">
          <description>Return a list of aliases for this Attribute (as defined by the schema)
This list will be lowercase.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="691" package="phpLDAPadmin\Templates">
        <name>getAutoValue</name>
        <full_name>\Attribute::getAutoValue()</full_name>
        <docblock line="691">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="698" package="phpLDAPadmin\Templates">
        <name>getPostValue</name>
        <full_name>\Attribute::getPostValue()</full_name>
        <docblock line="698">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="705" package="phpLDAPadmin\Templates">
        <name>setPostValue</name>
        <full_name>\Attribute::setPostValue()</full_name>
        <docblock line="705">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$postvalue</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="712" package="phpLDAPadmin\Templates">
        <name>setXML</name>
        <full_name>\Attribute::setXML()</full_name>
        <docblock line="712">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="850" package="phpLDAPadmin\Templates">
        <name>getRemovedValues</name>
        <full_name>\Attribute::getRemovedValues()</full_name>
        <docblock line="850">
          <description>Display the values removed in an attribute.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="860" package="phpLDAPadmin\Templates">
        <name>getAddedValues</name>
        <full_name>\Attribute::getAddedValues()</full_name>
        <docblock line="860">
          <description>Display the values removed in an attribute.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="876" package="phpLDAPadmin\Templates">
        <name>real_attr_name</name>
        <full_name>\Attribute::real_attr_name()</full_name>
        <docblock line="876">
          <description>Prunes off anything after the ";" in an attr name. This is useful for
attributes that may have ";binary" appended to their names. With
real_attr_name(), you can more easily fetch these attributes' schema
with their "real" attribute name.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The name of the attribute to examine.&lt;/p&gt;" line="876" type="string" variable="$attr_name">
            <type>string</type>
          </tag>
          <tag name="return" description="" line="876" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="886" package="phpLDAPadmin\Templates">
        <name>needJS</name>
        <full_name>\Attribute::needJS()</full_name>
        <docblock line="886">
          <description>Does this attribute need supporting JS</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$type</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/emuhash_functions.php" generated-path="templates.3rdParty.pla.lib.emuhash_functions.html" hash="81afdc7c474056fd6f6ec5b92fa7aa37" package="main">
    <docblock line="0">
      <description></description>
      <long-description></long-description>
    </docblock>
    <constant namespace="" line="50" package="main">
      <name>MHASH_MD5</name>
      <full_name>\\MHASH_MD5</full_name>
      <value>'md5'</value>
      <docblock line="50">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="51" package="main">
      <name>MHASH_SHA1</name>
      <full_name>\\MHASH_SHA1</full_name>
      <value>'sha1'</value>
      <docblock line="51">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="52" package="main">
      <name>MHASH_RIPEMD160</name>
      <full_name>\\MHASH_RIPEMD160</full_name>
      <value>'rmd160'</value>
      <docblock line="52">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <function namespace="" line="58" package="main">
      <name>openssl_hash</name>
      <full_name>\openssl_hash()</full_name>
      <docblock line="58">
        <description></description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$openssl_hash_id</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$password_clear</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="86" package="main">
      <name>mhash</name>
      <full_name>\mhash()</full_name>
      <docblock line="86">
        <description></description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$hash_id</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$password_clear</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="107" package="main">
      <name>mhash_keygen_s2k</name>
      <full_name>\mhash_keygen_s2k()</full_name>
      <docblock line="107">
        <description></description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$hash_id</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$password_clear</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$salt</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$bytes</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <parse_markers>
      <error line="0" code="PPC:ERR-50000">No summary was found for this file</error>
      <error line="58" code="PPC:ERR-50011">No summary for function \openssl_hash()</error>
      <error line="86" code="PPC:ERR-50011">No summary for function \mhash()</error>
      <error line="107" code="PPC:ERR-50011">No summary for function \mhash_keygen_s2k()</error>
    </parse_markers>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/MultiLineAttribute.php" generated-path="templates.3rdParty.pla.lib.MultiLineAttribute.html" hash="34840800799bfc876a25ecca65e726a4" package="phpLDAPadmin">
    <docblock line="0">
      <description>Classes and functions for the template engine.</description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="15" package="phpLDAPadmin\Templates">
      <extends>\Attribute</extends>
      <name>MultiLineAttribute</name>
      <full_name>\MultiLineAttribute</full_name>
      <docblock line="15">
        <description>Represents a attribute whose values are multiline text</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="15"/>
        <tag name="subpackage" description="Templates" line="15"/>
      </docblock>
      <property static="false" visibility="protected" line="16" namespace="" package="phpLDAPadmin\Templates">
        <name>$rows</name>
        <default>0</default>
        <docblock line="16">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="17" namespace="" package="phpLDAPadmin\Templates">
        <name>$cols</name>
        <default>0</default>
        <docblock line="17">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="19" package="phpLDAPadmin\Templates">
        <name>getRows</name>
        <full_name>\MultiLineAttribute::getRows()</full_name>
        <docblock line="19">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="23" package="phpLDAPadmin\Templates">
        <name>setRows</name>
        <full_name>\MultiLineAttribute::setRows()</full_name>
        <docblock line="23">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$rows</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="27" package="phpLDAPadmin\Templates">
        <name>getCols</name>
        <full_name>\MultiLineAttribute::getCols()</full_name>
        <docblock line="27">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="31" package="phpLDAPadmin\Templates">
        <name>setCols</name>
        <full_name>\MultiLineAttribute::setCols()</full_name>
        <docblock line="31">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$cols</name>
          <default></default>
          <type/>
        </argument>
      </method>
    </class>
    <source>eJx9kMtOwzAQRdf1V8wiC4gEZQ/0obIsEqr6A04yTaw6tmWPWyTUf2cckkCklu14zj13/LJ0jRPzPBeQw0bLEDCANBUcoilJWRPgYD1Qg0DYOi0JAU2tDD4ykaCVjNTwyp5XOGv7tv6QVasMVHhCbV2LhpiVbbfsZHmU9XSTH+Zi6LBD5zEwwzVAEnlVRHaeGxsQTlLH1M8jtFGT0tyDsz9p6HIjHlYhFsPbvr8jdN4y3QzvKW3LaevRyKloqgC/ky8xc94SloQVZN6eA7zC0/NkWlrdT3kcC63K8SehRtoxdHefkmYeKXoDGTUqPCxSGiddrmChxzrjD/sHYln2D8zODVe66kxdbzs7rLtn4uwPzEb4IpYL8Q3Kab14</source>
  </file>
  <file path="templates/3rdParty/pla/lib/Tree.php" generated-path="templates.3rdParty.pla.lib.Tree.html" hash="9427ea7aebad73e8e4c1e5ad24c47c1d" package="phpLDAPadmin">
    <docblock line="0">
      <description>Classes and functions for the LDAP tree.</description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <class final="false" abstract="true" namespace="" line="17" package="phpLDAPadmin\Tree">
      <extends/>
      <name>Tree</name>
      <full_name>\Tree</full_name>
      <docblock line="17">
        <description>Abstract class which represents the LDAP tree view ; the draw() method
must be implemented by subclasses</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="17"/>
        <tag name="subpackage" description="Tree" line="17"/>
        <tag name="see" description="AJAXTree" line="17"/>
      </docblock>
      <property static="false" visibility="private" line="19" namespace="" package="phpLDAPadmin\Tree">
        <name>$server_id</name>
        <default>null</default>
        <docblock line="19">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="21" namespace="" package="phpLDAPadmin\Tree">
        <name>$entries</name>
        <default>array()</default>
        <docblock line="21">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="true" static="false" visibility="public" namespace="" line="26" package="phpLDAPadmin\Tree">
        <name>draw</name>
        <full_name>\Tree::draw()</full_name>
        <docblock line="26">
          <description>Displays the LDAP tree</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="28" package="phpLDAPadmin\Tree">
        <name>__construct</name>
        <full_name>\Tree::__construct()</full_name>
        <docblock line="28">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$server_id</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="41" package="phpLDAPadmin\Tree">
        <name>getInstance</name>
        <full_name>\Tree::getInstance()</full_name>
        <docblock line="41">
          <description>Create an instance of the tree - this is used when we call this class directly
Tree::getInstance($index)</description>
          <long-description></long-description>
          <tag name="return" description="Tree" line="41" type="object">
            <type>object</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$server_id</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="78" package="phpLDAPadmin\Tree">
        <name>getServerID</name>
        <full_name>\Tree::getServerID()</full_name>
        <docblock line="78">
          <description>Get the Server ID for this tree</description>
          <long-description></long-description>
          <tag name="return" description="Server ID that this tree is for" line="78" type="int">
            <type>int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="90" package="phpLDAPadmin\Tree">
        <name>getServer</name>
        <full_name>\Tree::getServer()</full_name>
        <docblock line="90">
          <description>Get the server Object for this tree</description>
          <long-description></long-description>
          <tag name="return" description="Server Object for this tree" line="90" type="object">
            <type>object</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="102" package="phpLDAPadmin\Tree">
        <name>getBaseEntries</name>
        <full_name>\Tree::getBaseEntries()</full_name>
        <docblock line="102">
          <description>Get the entries that are BaseDN entries.</description>
          <long-description></long-description>
          <tag name="return" description="Base DN entries" line="102" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="127" package="phpLDAPadmin\Tree">
        <name>indexDN</name>
        <full_name>\Tree::indexDN()</full_name>
        <docblock line="127">
          <description>This function will take the DN, convert it to lowercase and strip unnessary
commas. This result will be used as the index for the tree object.</description>
          <long-description>Any display of a DN should use the object-&gt;dn entry, not the index.
The reason we need to do this is because:
uid=User A,ou=People,c=AU and
uid=User B, ou=PeOpLe, c=au
are infact in the same branch, but PLA will show them inconsistently.</long-description>
          <tag name="param" description="&lt;p&gt;DN to clean&lt;/p&gt;" line="127" type="\dn" variable="">
            <type>\dn</type>
          </tag>
          <tag name="return" description="Lowercase clean DN" line="127" type="\dn">
            <type>\dn</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="145" package="phpLDAPadmin\Tree">
        <name>getEntry</name>
        <full_name>\Tree::getEntry()</full_name>
        <docblock line="145">
          <description>Get a tree entry</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;DN to retrieve&lt;/p&gt;" line="145" type="\dn" variable="">
            <type>\dn</type>
          </tag>
          <tag name="return" description="Tree DN object" line="145" type="object">
            <type>object</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="164" package="phpLDAPadmin\Tree">
        <name>addEntry</name>
        <full_name>\Tree::addEntry()</full_name>
        <docblock line="164">
          <description>Add an entry in the tree view ; the entry is added in the
children array of its parent</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;DN to add&lt;/p&gt;" line="164" type="\dn" variable="">
            <type>\dn</type>
          </tag>
          <tag name="param" description="&lt;p&gt;the dn of the entry to create&lt;/p&gt;" line="164" type="string" variable="$dn">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="221" package="phpLDAPadmin\Tree">
        <name>delEntry</name>
        <full_name>\Tree::delEntry()</full_name>
        <docblock line="221">
          <description>Delete an entry from the tree view ; the entry is deleted from the
children array of its parent</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;DN to remote&lt;/p&gt;" line="221" type="\dn" variable="">
            <type>\dn</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="245" package="phpLDAPadmin\Tree">
        <name>renameEntry</name>
        <full_name>\Tree::renameEntry()</full_name>
        <docblock line="245">
          <description>Rename an entry in the tree</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Old DN&lt;/p&gt;" line="245" type="\dn" variable="">
            <type>\dn</type>
          </tag>
          <tag name="param" description="&lt;p&gt;New DN&lt;/p&gt;" line="245" type="\dn" variable="">
            <type>\dn</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$dnOLD</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$dnNEW</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="277" package="phpLDAPadmin\Tree">
        <name>readChildren</name>
        <full_name>\Tree::readChildren()</full_name>
        <docblock line="277">
          <description>Read the children of a tree entry</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;DN of the entry&lt;/p&gt;" line="277" type="\dn" variable="">
            <type>\dn</type>
          </tag>
          <tag name="param" description="&lt;p&gt;LDAP Size Limit&lt;/p&gt;" line="277" type="boolean" variable="">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$nolimit</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="331" package="phpLDAPadmin\Tree">
        <name>readChildrenNumber</name>
        <full_name>\Tree::readChildrenNumber()</full_name>
        <docblock line="331">
          <description>Return the number of children an entry has. Optionally autoread the child entry.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;DN of the entry&lt;/p&gt;" line="331" type="\dn" variable="">
            <type>\dn</type>
          </tag>
          <tag name="param" description="&lt;p&gt;LDAP Size Limit&lt;/p&gt;" line="331" type="boolean" variable="">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$nolimit</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/session_functions.php" generated-path="templates.3rdParty.pla.lib.session_functions.html" hash="1b138eeffda8f89af5f160f23c1b0ea6" package="phpLDAPadmin">
    <docblock line="0">
      <description>A collection of functions to handle sessions.</description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Session" line="0"/>
    </docblock>
    <function namespace="" line="19" package="phpLDAPadmin">
      <name>app_session_start</name>
      <full_name>\app_session_start()</full_name>
      <docblock line="19">
        <description>The only function which should be called by a user</description>
        <long-description></long-description>
        <tag name="see" description="" line="19"/>
        <tag name="see" description="" line="19"/>
        <tag name="return" description="Returns true if the session was started the first time" line="19" type="boolean">
          <type>boolean</type>
        </tag>
      </docblock>
    </function>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/TreeItem.php" generated-path="templates.3rdParty.pla.lib.TreeItem.html" hash="79493d251e823a53b29e86a1076495b3" package="phpLDAPadmin">
    <docblock line="0">
      <description>Classes and functions for the LDAP tree.</description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="15" package="phpLDAPadmin\Tree">
      <extends/>
      <name>TreeItem</name>
      <full_name>\TreeItem</full_name>
      <docblock line="15">
        <description>Represents an item in the tree.</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="15"/>
        <tag name="subpackage" description="Tree" line="15"/>
      </docblock>
      <property static="false" visibility="protected" line="17" namespace="" package="phpLDAPadmin\Tree">
        <name>$dn</name>
        <default></default>
        <docblock line="17">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="19" namespace="" package="phpLDAPadmin\Tree">
        <name>$server_id</name>
        <default></default>
        <docblock line="19">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="21" namespace="" package="phpLDAPadmin\Tree">
        <name>$objectclasses</name>
        <default>array()</default>
        <docblock line="21">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="23" namespace="" package="phpLDAPadmin\Tree">
        <name>$base_entry</name>
        <default>false</default>
        <docblock line="23">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="25" namespace="" package="phpLDAPadmin\Tree">
        <name>$children</name>
        <default>array()</default>
        <docblock line="25">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="27" namespace="" package="phpLDAPadmin\Tree">
        <name>$icon</name>
        <default></default>
        <docblock line="27">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="29" namespace="" package="phpLDAPadmin\Tree">
        <name>$leaf</name>
        <default>false</default>
        <docblock line="29">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="31" namespace="" package="phpLDAPadmin\Tree">
        <name>$open</name>
        <default>false</default>
        <docblock line="31">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="33" namespace="" package="phpLDAPadmin\Tree">
        <name>$size_limited</name>
        <default>true</default>
        <docblock line="33">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="35" namespace="" package="phpLDAPadmin\Tree">
        <name>$template</name>
        <default>null</default>
        <docblock line="35">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="37" namespace="" package="phpLDAPadmin\Tree">
        <name>$childsort</name>
        <default>true</default>
        <docblock line="37">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="39" namespace="" package="phpLDAPadmin\Tree">
        <name>$reading_children</name>
        <default>false</default>
        <docblock line="39">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="41" package="phpLDAPadmin\Tree">
        <name>__construct</name>
        <full_name>\TreeItem::__construct()</full_name>
        <docblock line="41">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$server_id</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="54" package="phpLDAPadmin\Tree">
        <name>getDN</name>
        <full_name>\TreeItem::getDN()</full_name>
        <docblock line="54">
          <description>Get the DN of this tree item.</description>
          <long-description></long-description>
          <tag name="return" description="The DN of this item." line="54" type="\DN">
            <type>\DN</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="61" package="phpLDAPadmin\Tree">
        <name>getDNEncode</name>
        <full_name>\TreeItem::getDNEncode()</full_name>
        <docblock line="61">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="70" package="phpLDAPadmin\Tree">
        <name>getRDN</name>
        <full_name>\TreeItem::getRDN()</full_name>
        <docblock line="70">
          <description>Get the RDN of this tree items DN.</description>
          <long-description></long-description>
          <tag name="return" description="The RDN of this items DN." line="70" type="\RDN">
            <type>\RDN</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="80" package="phpLDAPadmin\Tree">
        <name>setBase</name>
        <full_name>\TreeItem::setBase()</full_name>
        <docblock line="80">
          <description>Set this item as a LDAP base DN item.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="90" package="phpLDAPadmin\Tree">
        <name>isBaseDN</name>
        <full_name>\TreeItem::isBaseDN()</full_name>
        <docblock line="90">
          <description>Return if this item is a base DN item.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="97" package="phpLDAPadmin\Tree">
        <name>setObjectClasses</name>
        <full_name>\TreeItem::setObjectClasses()</full_name>
        <docblock line="97">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$oc</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="104" package="phpLDAPadmin\Tree">
        <name>getObjectClasses</name>
        <full_name>\TreeItem::getObjectClasses()</full_name>
        <docblock line="104">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="111" package="phpLDAPadmin\Tree">
        <name>isInLDAP</name>
        <full_name>\TreeItem::isInLDAP()</full_name>
        <docblock line="111">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="122" package="phpLDAPadmin\Tree">
        <name>getChildren</name>
        <full_name>\TreeItem::getChildren()</full_name>
        <docblock line="122">
          <description>Returns null if the children have never be defined
or an array of the dn of the children</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="134" package="phpLDAPadmin\Tree">
        <name>readingChildren</name>
        <full_name>\TreeItem::readingChildren()</full_name>
        <docblock line="134">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$bool</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="141" package="phpLDAPadmin\Tree">
        <name>isChildSorted</name>
        <full_name>\TreeItem::isChildSorted()</full_name>
        <docblock line="141">
          <description>Do the children require resorting</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="151" package="phpLDAPadmin\Tree">
        <name>childSorted</name>
        <full_name>\TreeItem::childSorted()</full_name>
        <docblock line="151">
          <description>Mark the children as sorted</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="163" package="phpLDAPadmin\Tree">
        <name>addChild</name>
        <full_name>\TreeItem::addChild()</full_name>
        <docblock line="163">
          <description>Add a child to this DN entry.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The DN to add.&lt;/p&gt;" line="163" type="\DN" variable="">
            <type>\DN</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="179" package="phpLDAPadmin\Tree">
        <name>delChild</name>
        <full_name>\TreeItem::delChild()</full_name>
        <docblock line="179">
          <description>Delete a child from this DN entry.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The DN to add.&lt;/p&gt;" line="179" type="\DN" variable="">
            <type>\DN</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="197" package="phpLDAPadmin\Tree">
        <name>rename</name>
        <full_name>\TreeItem::rename()</full_name>
        <docblock line="197">
          <description>Rename this DN.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The DN to rename to.&lt;/p&gt;" line="197" type="\DN" variable="">
            <type>\DN</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="207" package="phpLDAPadmin\Tree">
        <name>isOpened</name>
        <full_name>\TreeItem::isOpened()</full_name>
        <docblock line="207">
          <description>Return if this item has been opened.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="217" package="phpLDAPadmin\Tree">
        <name>close</name>
        <full_name>\TreeItem::close()</full_name>
        <docblock line="217">
          <description>Mark this node as closed.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="227" package="phpLDAPadmin\Tree">
        <name>open</name>
        <full_name>\TreeItem::open()</full_name>
        <docblock line="227">
          <description>Opens the node ; the children of the node must have been defined</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="237" package="phpLDAPadmin\Tree">
        <name>setLeaf</name>
        <full_name>\TreeItem::setLeaf()</full_name>
        <docblock line="237">
          <description>Mark this node as a leaf.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="247" package="phpLDAPadmin\Tree">
        <name>isLeaf</name>
        <full_name>\TreeItem::isLeaf()</full_name>
        <docblock line="247">
          <description>Return if this node is a leaf.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="258" package="phpLDAPadmin\Tree">
        <name>getIcon</name>
        <full_name>\TreeItem::getIcon()</full_name>
        <docblock line="258">
          <description>Returns the path of the icon file used to represent this node ;
If the icon hasnt been set, it will call get_icon()</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="271" package="phpLDAPadmin\Tree">
        <name>setSizeLimited</name>
        <full_name>\TreeItem::setSizeLimited()</full_name>
        <docblock line="271">
          <description>Mark this node as a size limited (it wont have all its children).</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="281" package="phpLDAPadmin\Tree">
        <name>unsetSizeLimited</name>
        <full_name>\TreeItem::unsetSizeLimited()</full_name>
        <docblock line="281">
          <description>Clear the size limited flag.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="291" package="phpLDAPadmin\Tree">
        <name>isSizeLimited</name>
        <full_name>\TreeItem::isSizeLimited()</full_name>
        <docblock line="291">
          <description>Return if this node has hit an LDAP size limit (and thus doesnt have all its children).</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="298" package="phpLDAPadmin\Tree">
        <name>setTemplate</name>
        <full_name>\TreeItem::setTemplate()</full_name>
        <docblock line="298">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$template</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="305" package="phpLDAPadmin\Tree">
        <name>getTemplate</name>
        <full_name>\TreeItem::getTemplate()</full_name>
        <docblock line="305">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/SelectionAttribute.php" generated-path="templates.3rdParty.pla.lib.SelectionAttribute.html" hash="ebd54d780d03ab22dc6a940670f75533" package="phpLDAPadmin">
    <docblock line="0">
      <description>Classes and functions for the template engine.</description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="15" package="phpLDAPadmin\Templates">
      <extends>\Attribute</extends>
      <name>SelectionAttribute</name>
      <full_name>\SelectionAttribute</full_name>
      <docblock line="15">
        <description>Represents an attribute whose values are in a predefined list</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="15"/>
        <tag name="subpackage" description="Templates" line="15"/>
      </docblock>
      <property static="false" visibility="protected" line="16" namespace="" package="phpLDAPadmin\Templates">
        <name>$selection</name>
        <default>array()</default>
        <docblock line="16">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="17" namespace="" package="phpLDAPadmin\Templates">
        <name>$multiple</name>
        <default></default>
        <docblock line="17">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="18" namespace="" package="phpLDAPadmin\Templates">
        <name>$default</name>
        <default></default>
        <docblock line="18">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="20" package="phpLDAPadmin\Templates">
        <name>__construct</name>
        <full_name>\SelectionAttribute::__construct()</full_name>
        <docblock line="20">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$name</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$values</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$server_id</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$source</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="36" package="phpLDAPadmin\Templates">
        <name>addOption</name>
        <full_name>\SelectionAttribute::addOption()</full_name>
        <docblock line="36">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$value</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$description</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="40" package="phpLDAPadmin\Templates">
        <name>addValue</name>
        <full_name>\SelectionAttribute::addValue()</full_name>
        <docblock line="40">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$new_val</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default>-1</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="47" package="phpLDAPadmin\Templates">
        <name>getOptionCount</name>
        <full_name>\SelectionAttribute::getOptionCount()</full_name>
        <docblock line="47">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="51" package="phpLDAPadmin\Templates">
        <name>getSelection</name>
        <full_name>\SelectionAttribute::getSelection()</full_name>
        <docblock line="51">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="55" package="phpLDAPadmin\Templates">
        <name>autoValue</name>
        <full_name>\SelectionAttribute::autoValue()</full_name>
        <docblock line="55">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$value</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="59" package="phpLDAPadmin\Templates">
        <name>getDefault</name>
        <full_name>\SelectionAttribute::getDefault()</full_name>
        <docblock line="59">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="63" package="phpLDAPadmin\Templates">
        <name>isMultiple</name>
        <full_name>\SelectionAttribute::isMultiple()</full_name>
        <docblock line="63">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="67" package="phpLDAPadmin\Templates">
        <name>setMultiple</name>
        <full_name>\SelectionAttribute::setMultiple()</full_name>
        <docblock line="67">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/template_functions.php" generated-path="templates.3rdParty.pla.lib.template_functions.html" hash="a928a97fbd0a270486fdda76bbaecd08" package="phpLDAPadmin">
    <docblock line="0">
      <description>Classes and functions for the template engine.</description>
      <long-description>These classes and functions will read our XML template files, as well as
query the LDAP server and build a template object that can be used for user
input.</long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="21" package="phpLDAPadmin\Templates">
      <extends>\xmlTemplates</extends>
      <name>Templates</name>
      <full_name>\Templates</full_name>
      <docblock line="21">
        <description>Templates Class</description>
        <long-description>This class will store all our templates.</long-description>
        <tag name="package" description="phpLDAPadmin" line="21"/>
        <tag name="subpackage" description="Templates" line="21"/>
      </docblock>
    </class>
    <source>eJx1UMtOwzAQvPsr9hxV9AcQLYJjkTj0wHUTTxqDYxuv3RYh/h0nIYmQ4LbandfO7S50QW2rSlFFD5ZFIMROU5tdk4x3Qq2PlDpQQh8sJxDcyTjcFMZAOnYQUPMn9WKspQjW5HOkl6fDKtIaC9kQFxAKiGXQes+IH6PZ4fH+mQTxjDhq1tlYTbzyff2KJhUsJ2rYUQ3KAj2mLUMc5IwLOc0595xTV44lL5WfBwPWvXGkcYb1oYcrcuB+BAdu3vj0G1kOWzV3dfwJIlNrSxlGpi6m3yX5COIyDQXM4WXJ9I8N7SXX821xGv0n8dUd1wSnha69XZef6kvt7tQ3NmadJA==</source>
  </file>
  <file path="templates/3rdParty/pla/lib/DnAttribute.php" generated-path="templates.3rdParty.pla.lib.DnAttribute.html" hash="57742c3588f6b77643966bb7e84ba19c" package="phpLDAPadmin">
    <docblock line="0">
      <description>Classes and functions for the template engine.</description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="15" package="phpLDAPadmin\Templates">
      <extends>\Attribute</extends>
      <name>DnAttribute</name>
      <full_name>\DnAttribute</full_name>
      <docblock line="15">
        <description>Represents an attribute whose values are DNs</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="15"/>
        <tag name="subpackage" description="Templates" line="15"/>
      </docblock>
    </class>
    <source>eJx1j0sOgkAMhvdziq5ZyAWMQGRpjDFcoEARIpTJtIMmxrs7ENG4cNv/9XWb2NaaOIoMRLDvUYQEkGtoPFfajSzQjA60JVAabI9KQHzpmDYhMYdS9NoGSxEsoeuQZyesh46hpon60Q7EGrI4LGaL1RUvv84gxGZlOJN1JCEzYwCquq70YfTWjkIwYe9nQEeQH2Ul+FMKqfhy1Yo3vSxr1fwp5Jx9+umuxLXA9/IwT5PszAt2qF7K</source>
  </file>
  <file path="templates/3rdParty/pla/lib/AJAXTree.php" generated-path="templates.3rdParty.pla.lib.AJAXTree.html" hash="566b3c1aa9f49f7ea515bcec6f15ff80" package="phpLDAPadmin">
    <docblock line="0">
      <description>Classes and functions for the LDAP tree.</description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="16" package="phpLDAPadmin\Tree">
      <extends>\HTMLTree</extends>
      <name>AJAXTree</name>
      <full_name>\AJAXTree</full_name>
      <docblock line="16">
        <description>This class implements an AJAX based tree.</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="16"/>
        <tag name="subpackage" description="Tree" line="16"/>
        <tag name="see" description="Tree" line="16"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="25" package="phpLDAPadmin\Tree">
        <name>draw_item</name>
        <full_name>\AJAXTree::draw_item()</full_name>
        <docblock line="25">
          <description>Draw a node of the tree</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The Base DN to draw&lt;/p&gt;" line="25" type="\dn" variable="">
            <type>\dn</type>
          </tag>
          <tag name="param" description="&lt;p&gt;a string of 0 and 1 ; $level == &quot;000101&quot; will draw &quot;   | |&lt;node&gt;&quot;&lt;/p&gt;&#10;" line="25" type="string" variable="$level">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;is the first child entry, which is normally the &quot;Create New Entry&quot; option&lt;/p&gt;" line="25" type="boolean" variable="$first_child">
            <type>boolean</type>
          </tag>
          <tag name="param" description="&lt;p&gt;is the last child entry, which is normally the &quot;Create New Entry&quot; option&lt;/p&gt;" line="25" type="boolean" variable="$last_child">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$item</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$level</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$first_child</name>
          <default>true</default>
          <type>boolean</type>
        </argument>
        <argument line="0">
          <name>$last_child</name>
          <default>true</default>
          <type>boolean</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="138" package="phpLDAPadmin\Tree">
        <name>draw_children</name>
        <full_name>\AJAXTree::draw_children()</full_name>
        <docblock line="138">
          <description>Expand and draw a child entry, when it is clicked on. This is using AJAX just to render this section of the tree.</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$parent_entry</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$code</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="186" package="phpLDAPadmin\Tree">
        <name>get_indentation</name>
        <full_name>\AJAXTree::get_indentation()</full_name>
        <docblock line="186">
          <description>Return the indentation before a node</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;a string of 0 and 1 ; $code == &quot;000101&quot; will return &quot;   | |&quot;&lt;/p&gt;&#10;" line="186" type="" variable="$code"/>
        </docblock>
        <argument line="0">
          <name>$code</name>
          <default></default>
          <type>mixed</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="210" package="phpLDAPadmin\Tree">
        <name>draw_javascript</name>
        <full_name>\AJAXTree::draw_javascript()</full_name>
        <docblock line="210">
          <description>Draw the javascript to support the tree.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="222" package="phpLDAPadmin\Tree">
        <name>create_before_child</name>
        <full_name>\AJAXTree::create_before_child()</full_name>
        <docblock line="222">
          <description>Draw the "Create New Entry" item before the children.</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$entry</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$level</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="242" package="phpLDAPadmin\Tree">
        <name>create_after_child</name>
        <full_name>\AJAXTree::create_after_child()</full_name>
        <docblock line="242">
          <description>Draw the "Create New Entry" item after the children.</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$entry</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$level</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="261" package="phpLDAPadmin\Tree">
        <name>draw_create_new_entry</name>
        <full_name>\AJAXTree::draw_create_new_entry()</full_name>
        <docblock line="261">
          <description>Draw the "Create New Entry" item.</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$entry</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$level</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$img</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="294" package="phpLDAPadmin\Tree">
        <name>listOpenItems</name>
        <full_name>\AJAXTree::listOpenItems()</full_name>
        <docblock line="294">
          <description>List the items in the tree that are open</description>
          <long-description></long-description>
          <tag name="return" description="List of open nodes" line="294" type="array">
            <type>array</type>
          </tag>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/TemplateRender.php" generated-path="templates.3rdParty.pla.lib.TemplateRender.html" hash="55e17c4145cd7207fcd3ed6aec577e2a" package="phpLDAPadmin">
    <docblock line="0">
      <description>This class will render the creation or editing of an LDAP entry.</description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="15" package="phpLDAPadmin\Templates">
      <extends>\PageRender</extends>
      <name>TemplateRender</name>
      <full_name>\TemplateRender</full_name>
      <docblock line="15">
        <description>TemplateRender class</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="15"/>
        <tag name="subpackage" description="Templates" line="15"/>
      </docblock>
      <property static="false" visibility="private" line="17" namespace="" package="phpLDAPadmin\Templates">
        <name>$pagelast</name>
        <default></default>
        <docblock line="17">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="24" package="phpLDAPadmin\Templates">
        <name>accept</name>
        <full_name>\TemplateRender::accept()</full_name>
        <docblock line="24">
          <description>Initialise and Render the TemplateRender</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$norender</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="88" package="phpLDAPadmin\Templates">
        <name>getDefaultAttribute</name>
        <full_name>\TemplateRender::getDefaultAttribute()</full_name>
        <docblock line="88">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$container</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$type</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="434" package="phpLDAPadmin\Templates">
        <name>getMode</name>
        <full_name>\TemplateRender::getMode()</full_name>
        <docblock line="434">
          <description>Set the mode of the TemplateRender
Applicable modes are "create" or "edit"</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="451" package="phpLDAPadmin\Templates">
        <name>getModeContainer</name>
        <full_name>\TemplateRender::getModeContainer()</full_name>
        <docblock line="451">
          <description>Return the container for this mode</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="472" package="phpLDAPadmin\Templates">
        <name>haveDefaultTemplate</name>
        <full_name>\TemplateRender::haveDefaultTemplate()</full_name>
        <docblock line="472">
          <description>Is the default template enabled?</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="485" package="phpLDAPadmin\Templates">
        <name>drawTemplateChoice</name>
        <full_name>\TemplateRender::drawTemplateChoice()</full_name>
        <docblock line="485">
          <description>Present a list of available templates for creating and editing LDAP entries</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="609" package="phpLDAPadmin\Templates">
        <name>visitStart</name>
        <full_name>\TemplateRender::visitStart()</full_name>
        <docblock line="609">
          <description>This function will setup our template object (read LDAP for current values, read $_REQUEST for new values, etc)
so that it can be rendered.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="630" package="phpLDAPadmin\Templates">
        <name>visitEnd</name>
        <full_name>\TemplateRender::visitEnd()</full_name>
        <docblock line="630">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="677" package="phpLDAPadmin\Templates">
        <name>drawHeader</name>
        <full_name>\TemplateRender::drawHeader()</full_name>
        <docblock line="677">
          <description>PAGE DRAWING METHODS *</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="692" package="phpLDAPadmin\Templates">
        <name>drawTitle</name>
        <full_name>\TemplateRender::drawTitle()</full_name>
        <docblock line="692">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$title</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="712" package="phpLDAPadmin\Templates">
        <name>drawSubTitle</name>
        <full_name>\TemplateRender::drawSubTitle()</full_name>
        <docblock line="712">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$subtitle</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="744" package="phpLDAPadmin\Templates">
        <name>drawMenu</name>
        <full_name>\TemplateRender::drawMenu()</full_name>
        <docblock line="744">
          <description>PAGE ENTRY MENU *</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="836" package="phpLDAPadmin\Templates">
        <name>getMenuItem</name>
        <full_name>\TemplateRender::getMenuItem()</full_name>
        <docblock line="836">
          <description>PAGE ENTRY MENU ITEMS *</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="998" package="phpLDAPadmin\Templates">
        <name>getDeleteAttributeMessage</name>
        <full_name>\TemplateRender::getDeleteAttributeMessage()</full_name>
        <docblock line="998">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1010" package="phpLDAPadmin\Templates">
        <name>getModifiedAttributesMessage</name>
        <full_name>\TemplateRender::getModifiedAttributesMessage()</full_name>
        <docblock line="1010">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$modified_attributes</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1022" package="phpLDAPadmin\Templates">
        <name>getReadOnlyMessage</name>
        <full_name>\TemplateRender::getReadOnlyMessage()</full_name>
        <docblock line="1022">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1031" package="phpLDAPadmin\Templates">
        <name>getViewSchemaMessage</name>
        <full_name>\TemplateRender::getViewSchemaMessage()</full_name>
        <docblock line="1031">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1042" package="phpLDAPadmin\Templates">
        <name>getMenuItemRefresh</name>
        <full_name>\TemplateRender::getMenuItemRefresh()</full_name>
        <docblock line="1042">
          <description>PAGE ENTRY MENU ITEMS DETAILS *</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1058" package="phpLDAPadmin\Templates">
        <name>getMenuItemSwitchTemplate</name>
        <full_name>\TemplateRender::getMenuItemSwitchTemplate()</full_name>
        <docblock line="1058">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1072" package="phpLDAPadmin\Templates">
        <name>getMenuItemExportBase</name>
        <full_name>\TemplateRender::getMenuItemExportBase()</full_name>
        <docblock line="1072">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1088" package="phpLDAPadmin\Templates">
        <name>getMenuItemMove</name>
        <full_name>\TemplateRender::getMenuItemMove()</full_name>
        <docblock line="1088">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1106" package="phpLDAPadmin\Templates">
        <name>getMenuItemInternalAttributes</name>
        <full_name>\TemplateRender::getMenuItemInternalAttributes()</full_name>
        <docblock line="1106">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1126" package="phpLDAPadmin\Templates">
        <name>getMenuItemDelete</name>
        <full_name>\TemplateRender::getMenuItemDelete()</full_name>
        <docblock line="1126">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1143" package="phpLDAPadmin\Templates">
        <name>getMenuItemRename</name>
        <full_name>\TemplateRender::getMenuItemRename()</full_name>
        <docblock line="1143">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1159" package="phpLDAPadmin\Templates">
        <name>getMenuItemCompare</name>
        <full_name>\TemplateRender::getMenuItemCompare()</full_name>
        <docblock line="1159">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1176" package="phpLDAPadmin\Templates">
        <name>getMenuItemCreate</name>
        <full_name>\TemplateRender::getMenuItemCreate()</full_name>
        <docblock line="1176">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1193" package="phpLDAPadmin\Templates">
        <name>getMenuItemAddAttribute</name>
        <full_name>\TemplateRender::getMenuItemAddAttribute()</full_name>
        <docblock line="1193">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1214" package="phpLDAPadmin\Templates">
        <name>getMenuItemShowChildren</name>
        <full_name>\TemplateRender::getMenuItemShowChildren()</full_name>
        <docblock line="1214">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$children_count</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1234" package="phpLDAPadmin\Templates">
        <name>getMenuItemExportSub</name>
        <full_name>\TemplateRender::getMenuItemExportSub()</full_name>
        <docblock line="1234">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1256" package="phpLDAPadmin\Templates">
        <name>drawRDNChooser</name>
        <full_name>\TemplateRender::drawRDNChooser()</full_name>
        <docblock line="1256">
          <description>RDN Chooser</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1297" package="phpLDAPadmin\Templates">
        <name>drawContainerChooser</name>
        <full_name>\TemplateRender::drawContainerChooser()</full_name>
        <docblock line="1297">
          <description>Container Chooser</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$default_container</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1316" package="phpLDAPadmin\Templates">
        <name>drawObjectClassChooser</name>
        <full_name>\TemplateRender::drawObjectClassChooser()</full_name>
        <docblock line="1316">
          <description>Object Class Chooser</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1349" package="phpLDAPadmin\Templates">
        <name>drawInternalAttributes</name>
        <full_name>\TemplateRender::drawInternalAttributes()</full_name>
        <docblock line="1349">
          <description>INTERNAL ATTRIBUTES *</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1359" package="phpLDAPadmin\Templates">
        <name>drawInternalAttribute</name>
        <full_name>\TemplateRender::drawInternalAttribute()</full_name>
        <docblock line="1359">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1367" package="phpLDAPadmin\Templates">
        <name>drawFormStart</name>
        <full_name>\TemplateRender::drawFormStart()</full_name>
        <docblock line="1367">
          <description>FORM METHODS *</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1378" package="phpLDAPadmin\Templates">
        <name>drawForm</name>
        <full_name>\TemplateRender::drawForm()</full_name>
        <docblock line="1378">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$nosubmit</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1400" package="phpLDAPadmin\Templates">
        <name>drawFormEnd</name>
        <full_name>\TemplateRender::drawFormEnd()</full_name>
        <docblock line="1400">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1434" package="phpLDAPadmin\Templates">
        <name>drawFormSubmitButton</name>
        <full_name>\TemplateRender::drawFormSubmitButton()</full_name>
        <docblock line="1434">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1445" package="phpLDAPadmin\Templates">
        <name>drawStepTitle</name>
        <full_name>\TemplateRender::drawStepTitle()</full_name>
        <docblock line="1445">
          <description>STEP FORM METHODS *</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$page</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1470" package="phpLDAPadmin\Templates">
        <name>drawStepFormStart</name>
        <full_name>\TemplateRender::drawStepFormStart()</full_name>
        <docblock line="1470">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$page</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1488" package="phpLDAPadmin\Templates">
        <name>drawStepForm</name>
        <full_name>\TemplateRender::drawStepForm()</full_name>
        <docblock line="1488">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$page</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1526" package="phpLDAPadmin\Templates">
        <name>drawStepFormEnd</name>
        <full_name>\TemplateRender::drawStepFormEnd()</full_name>
        <docblock line="1526">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1532" package="phpLDAPadmin\Templates">
        <name>drawStepFormSubmitButton</name>
        <full_name>\TemplateRender::drawStepFormSubmitButton()</full_name>
        <docblock line="1532">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$page</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1548" package="phpLDAPadmin\Templates">
        <name>drawStepFormDefaultAttributes</name>
        <full_name>\TemplateRender::drawStepFormDefaultAttributes()</full_name>
        <docblock line="1548">
          <description>Given our known objectClass in the template, this will render the required MAY and optional MUST attributes</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1588" package="phpLDAPadmin\Templates">
        <name>drawShownAttributes</name>
        <full_name>\TemplateRender::drawShownAttributes()</full_name>
        <docblock line="1588">
          <description>DRAW ATTRIBUTES *</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1600" package="phpLDAPadmin\Templates">
        <name>drawJavascript</name>
        <full_name>\TemplateRender::drawJavascript()</full_name>
        <docblock line="1600">
          <description>DRAW PAGE JAVACRIPT</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1686" package="phpLDAPadmin\Templates">
        <name>drawTemplateJavascript</name>
        <full_name>\TemplateRender::drawTemplateJavascript()</full_name>
        <docblock line="1686">
          <description>Javascript Functions</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1753" package="phpLDAPadmin\Templates">
        <name>drawTitleAttribute</name>
        <full_name>\TemplateRender::drawTitleAttribute()</full_name>
        <docblock line="1753">
          <description>ATTRIBUTE TITLE *</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1778" package="phpLDAPadmin\Templates">
        <name>drawStartValueLineAttribute</name>
        <full_name>\TemplateRender::drawStartValueLineAttribute()</full_name>
        <docblock line="1778">
          <description>ATTRIBUTE LINE *</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1790" package="phpLDAPadmin\Templates">
        <name>drawEndValueLineAttribute</name>
        <full_name>\TemplateRender::drawEndValueLineAttribute()</full_name>
        <docblock line="1790">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1804" package="phpLDAPadmin\Templates">
        <name>drawTemplateAttribute</name>
        <full_name>\TemplateRender::drawTemplateAttribute()</full_name>
        <docblock line="1804">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1811" package="phpLDAPadmin\Templates">
        <name>drawTemplateValuesAttribute</name>
        <full_name>\TemplateRender::drawTemplateValuesAttribute()</full_name>
        <docblock line="1811">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1841" package="phpLDAPadmin\Templates">
        <name>drawIconAttribute</name>
        <full_name>\TemplateRender::drawIconAttribute()</full_name>
        <docblock line="1841">
          <description>DRAW ICONS FOR ATTRIBUTES VALUES *</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$val</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1857" package="phpLDAPadmin\Templates">
        <name>drawDnValueIconAttribute</name>
        <full_name>\TemplateRender::drawDnValueIconAttribute()</full_name>
        <docblock line="1857">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$val</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1869" package="phpLDAPadmin\Templates">
        <name>drawMailValueIconAttribute</name>
        <full_name>\TemplateRender::drawMailValueIconAttribute()</full_name>
        <docblock line="1869">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$val</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1880" package="phpLDAPadmin\Templates">
        <name>drawUrlValueIconAttribute</name>
        <full_name>\TemplateRender::drawUrlValueIconAttribute()</full_name>
        <docblock line="1880">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$val</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1897" package="phpLDAPadmin\Templates">
        <name>drawJavascriptAttribute</name>
        <full_name>\TemplateRender::drawJavascriptAttribute()</full_name>
        <docblock line="1897">
          <description>javacript</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1950" package="phpLDAPadmin\Templates">
        <name>getFocusJavascriptAttribute</name>
        <full_name>\TemplateRender::getFocusJavascriptAttribute()</full_name>
        <docblock line="1950">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$component</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1959" package="phpLDAPadmin\Templates">
        <name>getBlurJavascriptAttribute</name>
        <full_name>\TemplateRender::getBlurJavascriptAttribute()</full_name>
        <docblock line="1959">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$component</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1971" package="phpLDAPadmin\Templates">
        <name>drawFocusJavascriptAttribute</name>
        <full_name>\TemplateRender::drawFocusJavascriptAttribute()</full_name>
        <docblock line="1971">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$component</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1975" package="phpLDAPadmin\Templates">
        <name>drawBlurJavascriptAttribute</name>
        <full_name>\TemplateRender::drawBlurJavascriptAttribute()</full_name>
        <docblock line="1975">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$component</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1979" package="phpLDAPadmin\Templates">
        <name>drawFillJavascriptAttribute</name>
        <full_name>\TemplateRender::drawFillJavascriptAttribute()</full_name>
        <docblock line="1979">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$component_id</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$component_value</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1984" package="phpLDAPadmin\Templates">
        <name>drawValidateJavascriptAttribute</name>
        <full_name>\TemplateRender::drawValidateJavascriptAttribute()</full_name>
        <docblock line="1984">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$component</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$silence</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$var_valid</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="2000" package="phpLDAPadmin\Templates">
        <name>drawMenuAttribute</name>
        <full_name>\TemplateRender::drawMenuAttribute()</full_name>
        <docblock line="2000">
          <description>ATTRIBUTE MENU *</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="2019" package="phpLDAPadmin\Templates">
        <name>getMenuItemAttribute</name>
        <full_name>\TemplateRender::getMenuItemAttribute()</full_name>
        <docblock line="2019">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$action</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="2062" package="phpLDAPadmin\Templates">
        <name>getAddValueMenuItemAttribute</name>
        <full_name>\TemplateRender::getAddValueMenuItemAttribute()</full_name>
        <docblock line="2062">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="2080" package="phpLDAPadmin\Templates">
        <name>getAddValueMenuItemObjectClassAttribute</name>
        <full_name>\TemplateRender::getAddValueMenuItemObjectClassAttribute()</full_name>
        <docblock line="2080">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="2098" package="phpLDAPadmin\Templates">
        <name>getModifyMemberMenuItemAttribute</name>
        <full_name>\TemplateRender::getModifyMemberMenuItemAttribute()</full_name>
        <docblock line="2098">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="2117" package="phpLDAPadmin\Templates">
        <name>getRenameMenuItemAttribute</name>
        <full_name>\TemplateRender::getRenameMenuItemAttribute()</full_name>
        <docblock line="2117">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="2131" package="phpLDAPadmin\Templates">
        <name>drawValueAttribute</name>
        <full_name>\TemplateRender::drawValueAttribute()</full_name>
        <docblock line="2131">
          <description>values *</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="2163" package="phpLDAPadmin\Templates">
        <name>drawHelperAttribute</name>
        <full_name>\TemplateRender::drawHelperAttribute()</full_name>
        <docblock line="2163">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="2250" package="phpLDAPadmin\Templates">
        <name>drawRequiredSymbolAttribute</name>
        <full_name>\TemplateRender::drawRequiredSymbolAttribute()</full_name>
        <docblock line="2250">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="2260" package="phpLDAPadmin\Templates">
        <name>drawJavascriptBinaryAttribute</name>
        <full_name>\TemplateRender::drawJavascriptBinaryAttribute()</full_name>
        <docblock line="2260">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="2304" package="phpLDAPadmin\Templates">
        <name>drawJavaScriptDateAttribute</name>
        <full_name>\TemplateRender::drawJavaScriptDateAttribute()</full_name>
        <docblock line="2304">
          <description>DATE ATTRIBUTE RENDERING *</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="2347" package="phpLDAPadmin\Templates">
        <name>drawSelectorPopupDateAttribute</name>
        <full_name>\TemplateRender::drawSelectorPopupDateAttribute()</full_name>
        <docblock line="2347">
          <description>Draws an HTML date selector button which, when clicked, pops up a date selector dialog.</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="2354" package="phpLDAPadmin\Templates">
        <name>drawIconDnAttribute</name>
        <full_name>\TemplateRender::drawIconDnAttribute()</full_name>
        <docblock line="2354">
          <description>DN ATTRIBUTES *</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$val</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="2362" package="phpLDAPadmin\Templates">
        <name>drawIconObjectClassAttribute</name>
        <full_name>\TemplateRender::drawIconObjectClassAttribute()</full_name>
        <docblock line="2362">
          <description>OBJECT CLASS ATTRIBUTE *</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$val</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="2368" package="phpLDAPadmin\Templates">
        <name>drawJavascriptPasswordAttribute</name>
        <full_name>\TemplateRender::drawJavascriptPasswordAttribute()</full_name>
        <docblock line="2368">
          <description>PASSWORD ATTRIBUTES *</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="2397" package="phpLDAPadmin\Templates">
        <name>drawCheckLinkPasswordAttribute</name>
        <full_name>\TemplateRender::drawCheckLinkPasswordAttribute()</full_name>
        <docblock line="2397">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$component_id</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="2411" package="phpLDAPadmin\Templates">
        <name>drawJavascriptRandomPasswordAttribute</name>
        <full_name>\TemplateRender::drawJavascriptRandomPasswordAttribute()</full_name>
        <docblock line="2411">
          <description>This will draw the javascript that displays to the user the random password generated</description>
          <long-description></long-description>
          <tag name="todo" description="This function doesnt work well if there are more than 1 RandomPasswordAttributes on the form for the same attribute (unlikely situation)" line="2411"/>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="2444" package="phpLDAPadmin\Templates">
        <name>drawDefaultHelperPasswordAttribute</name>
        <full_name>\TemplateRender::drawDefaultHelperPasswordAttribute()</full_name>
        <docblock line="2444">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="2465" package="phpLDAPadmin\Templates">
        <name>drawDefaultHelperSambaPasswordAttribute</name>
        <full_name>\TemplateRender::drawDefaultHelperSambaPasswordAttribute()</full_name>
        <docblock line="2465">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="2486" package="phpLDAPadmin\Templates">
        <name>drawIconSelectionAttribute</name>
        <full_name>\TemplateRender::drawIconSelectionAttribute()</full_name>
        <docblock line="2486">
          <description>SELECTION ATTRIBUTE RENDERING *</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$val</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="2493" package="phpLDAPadmin\Templates">
        <name>getMenuItemSelectionAttribute</name>
        <full_name>\TemplateRender::getMenuItemSelectionAttribute()</full_name>
        <docblock line="2493">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/ds_myldap.php" generated-path="templates.3rdParty.pla.lib.ds_myldap.html" hash="489bc8ec708988a4678112e977601d61" package="phpLDAPadmin">
    <docblock line="0">
      <description>Classes and functions for communication of Data Stores</description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="15" package="phpLDAPadmin\DataStore">
      <extends>\DS</extends>
      <name>myldap</name>
      <full_name>\myldap</full_name>
      <docblock line="15">
        <description>This abstract class provides the basic variables and methods for LDAP datastores</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="15"/>
        <tag name="subpackage" description="DataStore" line="15"/>
      </docblock>
      <property static="false" visibility="private" line="17" namespace="" package="phpLDAPadmin\DataStore">
        <name>$noconnect</name>
        <default>false</default>
        <docblock line="17">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="19" namespace="" package="phpLDAPadmin\DataStore">
        <name>$_schema_entries</name>
        <default>null</default>
        <docblock line="19">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="21" namespace="" package="phpLDAPadmin\DataStore">
        <name>$_schemaDN</name>
        <default>null</default>
        <docblock line="21">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="23" namespace="" package="phpLDAPadmin\DataStore">
        <name>$force_may</name>
        <default>array()</default>
        <docblock line="23">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="25" package="phpLDAPadmin\DataStore">
        <name>__construct</name>
        <full_name>\myldap::__construct()</full_name>
        <docblock line="25">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$index</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="129" package="phpLDAPadmin\DataStore">
        <name>connect</name>
        <full_name>\myldap::connect()</full_name>
        <docblock line="129">
          <description>Connect and Bind to the Database</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Which connection method resource to use&lt;/p&gt;" line="129" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="return" description="Connection resource if successful, null if not." line="129" type="resource|null">
            <type>resource</type>
            <type>null</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$method</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$debug</name>
          <default>false</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$new</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="247" package="phpLDAPadmin\DataStore">
        <name>login</name>
        <full_name>\myldap::login()</full_name>
        <docblock line="247">
          <description>Login to the database with the application user/password</description>
          <long-description></long-description>
          <tag name="return" description="true|false for successful login." line="247" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$user</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$pass</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$method</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$new</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="311" package="phpLDAPadmin\DataStore">
        <name>query</name>
        <full_name>\myldap::query()</full_name>
        <docblock line="311">
          <description>Perform a query to the Database</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;query to perform&#10;$query['base']&#10;$query['filter']&#10;$query['scope']&#10;$query['attrs'] = array();&#10;$query['deref']&lt;/p&gt;&#10;" line="311" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Which connection method resource to use&lt;/p&gt;" line="311" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Index items according to this key&lt;/p&gt;" line="311" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Enable debugging output&lt;/p&gt;" line="311" type="boolean" variable="">
            <type>boolean</type>
          </tag>
          <tag name="return" description="Results of query." line="311" type="array|null">
            <type>array</type>
            <type>null</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$query</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$method</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$index</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$debug</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="444" package="phpLDAPadmin\DataStore">
        <name>getErrorMessage</name>
        <full_name>\myldap::getErrorMessage()</full_name>
        <docblock line="444">
          <description>Get the last error string</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Which connection method resource to use&lt;/p&gt;" line="444" type="string" variable="">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$method</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="456" package="phpLDAPadmin\DataStore">
        <name>getErrorNum</name>
        <full_name>\myldap::getErrorNum()</full_name>
        <docblock line="456">
          <description>Get the last error number</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Which connection method resource to use&lt;/p&gt;" line="456" type="string" variable="">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$method</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="471" package="phpLDAPadmin\DataStore">
        <name>getLoginID</name>
        <full_name>\myldap::getLoginID()</full_name>
        <docblock line="471">
          <description>Get a user ID</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Which connection method resource to use&lt;/p&gt;" line="471" type="string" variable="">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$user</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$method</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="504" package="phpLDAPadmin\DataStore">
        <name>getLoginBaseDN</name>
        <full_name>\myldap::getLoginBaseDN()</full_name>
        <docblock line="504">
          <description>Return the login base DNs
If no login base DNs are defined, then the LDAP server Base DNs are used.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="517" package="phpLDAPadmin\DataStore">
        <name>getLoginClass</name>
        <full_name>\myldap::getLoginClass()</full_name>
        <docblock line="517">
          <description>Return the login classes that a user must have to login</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="527" package="phpLDAPadmin\DataStore">
        <name>isAnonBindAllowed</name>
        <full_name>\myldap::isAnonBindAllowed()</full_name>
        <docblock line="527">
          <description>Return if anonymous bind is allowed in the configuration</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="544" package="phpLDAPadmin\DataStore">
        <name>isTLSEnabled</name>
        <full_name>\myldap::isTLSEnabled()</full_name>
        <docblock line="544">
          <description>Fetches whether TLS has been configured for use with a certain server.</description>
          <long-description>Users may configure phpLDAPadmin to use TLS in config,php thus:
&lt;code&gt;
$servers-&gt;setValue('server','tls',true|false);
&lt;/code&gt;</long-description>
          <tag name="return" description="" line="544" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="559" package="phpLDAPadmin\DataStore">
        <name>startTLS</name>
        <full_name>\myldap::startTLS()</full_name>
        <docblock line="559">
          <description>If TLS is configured, then start it</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$resource</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="585" package="phpLDAPadmin\DataStore">
        <name>isSASLEnabled</name>
        <full_name>\myldap::isSASLEnabled()</full_name>
        <docblock line="585">
          <description>Fetches whether SASL has been configured for use with a certain server.</description>
          <long-description>Users may configure phpLDAPadmin to use SASL in config,php thus:
&lt;code&gt;
$servers-&gt;setValue('server','sasl',true|false);
&lt;/code&gt;</long-description>
          <tag name="return" description="" line="585" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="603" package="phpLDAPadmin\DataStore">
        <name>startSASL</name>
        <full_name>\myldap::startSASL()</full_name>
        <docblock line="603">
          <description>If SASL is configured, then start it
To be able to use SASL, PHP should have been compliled with --with-ldap-sasl=DIR</description>
          <long-description></long-description>
          <tag name="todo" description="This has not been tested, please let the developers know if this function works as expected." line="603"/>
        </docblock>
        <argument line="0">
          <name>$resource</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$method</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="667" package="phpLDAPadmin\DataStore">
        <name>isProxyEnabled</name>
        <full_name>\myldap::isProxyEnabled()</full_name>
        <docblock line="667">
          <description>Fetches whether PROXY AUTH has been configured for use with a certain server.</description>
          <long-description>Users may configure phpLDAPadmin to use PROXY AUTH in config,php thus:
&lt;code&gt;
$servers-&gt;setValue('login','auth_type','proxy');
&lt;/code&gt;</long-description>
          <tag name="return" description="" line="667" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="677" package="phpLDAPadmin\DataStore">
        <name>startProxy</name>
        <full_name>\myldap::startProxy()</full_name>
        <docblock line="677">
          <description>If PROXY AUTH is configured, then start it</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$resource</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$method</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="766" package="phpLDAPadmin\DataStore">
        <name>modify</name>
        <full_name>\myldap::modify()</full_name>
        <docblock line="766">
          <description>Modify attributes of a DN</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$attrs</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$method</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="789" package="phpLDAPadmin\DataStore">
        <name>getBaseDN</name>
        <full_name>\myldap::getBaseDN()</full_name>
        <docblock line="789">
          <description>Gets the root DN of the specified LDAPServer, or null if it
can't find it (ie, the server won't give it to us, or it isnt
specified in the configuration file).</description>
          <long-description>Tested with OpenLDAP 2.0, Netscape iPlanet, and Novell eDirectory 8.7 (nldap.com)
Please report any and all bugs!!

Please note: On FC systems, it seems that php_ldap uses /etc/openldap/ldap.conf in
the search base if it is blank - so edit that file and comment out the BASE line.</long-description>
          <tag name="param" description="&lt;p&gt;Which connection method resource to use&lt;/p&gt;" line="789" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="return" description="dn|null The root DN of the server on success (string) or null on error." line="789" type="array">
            <type>array</type>
          </tag>
          <tag name="todo" description="Sort the entries, so that they are in the correct DN order." line="789"/>
        </docblock>
        <argument line="0">
          <name>$method</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="839" package="phpLDAPadmin\DataStore">
        <name>dnExists</name>
        <full_name>\myldap::dnExists()</full_name>
        <docblock line="839">
          <description>Gets whether an entry exists based on its DN. If the entry exists,
returns true. Otherwise returns false.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The DN of the entry of interest.&lt;/p&gt;" line="839" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Which connection method resource to use&lt;/p&gt;" line="839" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="return" description="" line="839" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$method</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="857" package="phpLDAPadmin\DataStore">
        <name>getContainerTop</name>
        <full_name>\myldap::getContainerTop()</full_name>
        <docblock line="857">
          <description>Given a DN string, this returns the top container portion of the string.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The DN whose container string to return.&lt;/p&gt;" line="857" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="return" description="The container" line="857" type="string">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="883" package="phpLDAPadmin\DataStore">
        <name>getContainerPath</name>
        <full_name>\myldap::getContainerPath()</full_name>
        <docblock line="883">
          <description>Given a DN string and a path like syntax, this returns the parent container portion of the string.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The DN whose container string to return.&lt;/p&gt;" line="883" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Either '/', '.' or something like '../../&lt;rdn&gt;'&lt;/p&gt;&#10;" line="883" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="return" description="The container" line="883" type="string">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$path</name>
          <default>'..'</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="930" package="phpLDAPadmin\DataStore">
        <name>getContainer</name>
        <full_name>\myldap::getContainer()</full_name>
        <docblock line="930">
          <description>Given a DN string, this returns the parent container portion of the string.</description>
          <long-description>For example. given 'cn=Manager,dc=example,dc=com', this function returns
'dc=example,dc=com'.</long-description>
          <tag name="param" description="&lt;p&gt;The DN whose container string to return.&lt;/p&gt;" line="930" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="return" description="The container" line="930" type="string">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="985" package="phpLDAPadmin\DataStore">
        <name>getContainerContents</name>
        <full_name>\myldap::getContainerContents()</full_name>
        <docblock line="985">
          <description>Gets a list of child entries for an entry. Given a DN, this function fetches the list of DNs of
child entries one level beneath the parent. For example, for the following tree:</description>
          <long-description>&lt;code&gt;
dc=example,dc=com
	ou=People
		cn=Dave
		cn=Fred
		cn=Joe
	ou=More People
		cn=Mark
		cn=Bob
&lt;/code&gt;

Calling &lt;code&gt;getContainerContents("ou=people,dc=example,dc=com")&lt;/code&gt;
would return the following list:

&lt;code&gt;
cn=Dave
cn=Fred
cn=Joe
ou=More People
&lt;/code&gt;</long-description>
          <tag name="param" description="&lt;p&gt;The DN of the entry whose children to return.&lt;/p&gt;" line="985" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Which connection method resource to use&lt;/p&gt;" line="985" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;(optional) The maximum number of entries to return.&#10;           If unspecified, no limit is applied to the number of entries in the returned.&lt;/p&gt;&#10;" line="985" type="int" variable="">
            <type>int</type>
          </tag>
          <tag name="param" description="&lt;p&gt;(optional) An LDAP filter to apply when fetching children, example: &quot;(objectClass=inetOrgPerson)&quot;&lt;/p&gt;&#10;" line="985" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;(optional) The LDAP deref setting to use in the query&lt;/p&gt;&#10;" line="985" type="\constant" variable="">
            <type>\constant</type>
          </tag>
          <tag name="return" description="An array of DN strings listing the immediate children of the specified entry." line="985" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$method</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$size_limit</name>
          <default>0</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$filter</name>
          <default>'(objectClass=*)'</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$deref</name>
          <default>LDAP_DEREF_NEVER</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1035" package="phpLDAPadmin\DataStore">
        <name>explodeDN</name>
        <full_name>\myldap::explodeDN()</full_name>
        <docblock line="1035">
          <description>Explode a DN into an array of its RDN parts.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The DN to explode.&lt;/p&gt;" line="1035" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;(optional) Whether to include attribute names (see http://php.net/ldap_explode_dn for details)&lt;/p&gt;&#10;" line="1035" type="int" variable="">
            <type>int</type>
          </tag>
          <tag name="return" description="An array of RDN parts of this format:&#10;&amp;lt;code&amp;gt;&#10;Array&#10;&#9;(&#10;&#9;&#9;[0] =&amp;gt; uid=ppratt&#10;&#9;&#9;[1] =&amp;gt; ou=People&#10;&#9;&#9;[2] =&amp;gt; dc=example&#10;&#9;&#9;[3] =&amp;gt; dc=com&#10;&#9;)&#10;&amp;lt;/code&amp;gt;&#10;NOTE: When a multivalue RDN is passed to ldap_explode_dn, the results returns with &amp;#039;value + value&amp;#039;;" line="1035" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$with_attributes</name>
          <default>0</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1083" package="phpLDAPadmin\DataStore">
        <name>escapeDN</name>
        <full_name>\myldap::escapeDN()</full_name>
        <docblock line="1083">
          <description>Parse a DN and escape any special characters</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1102" package="phpLDAPadmin\DataStore">
        <name>getRootDSE</name>
        <full_name>\myldap::getRootDSE()</full_name>
        <docblock line="1102">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$method</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1130" package="phpLDAPadmin\DataStore">
        <name>getSchemaDN</name>
        <full_name>\myldap::getSchemaDN()</full_name>
        <docblock line="1130">
          <description>This function will query the ldap server and request the subSchemaSubEntry which should be the Schema DN.</description>
          <long-description>If we cant connect to the LDAP server, we'll return false.
If we can connect but cant get the entry, then we'll return null.</long-description>
          <tag name="param" description="&lt;p&gt;Which connection method resource to use&lt;/p&gt;" line="1130" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;The DN to use to obtain the schema&lt;/p&gt;" line="1130" type="\dn" variable="">
            <type>\dn</type>
          </tag>
          <tag name="return" description="Schema if available, null if its not or false if we cant connect." line="1130" type="array|false">
            <type>array</type>
            <type>false</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$method</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$dn</name>
          <default>''</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1234" package="phpLDAPadmin\DataStore">
        <name>getRawSchema</name>
        <full_name>\myldap::getRawSchema()</full_name>
        <docblock line="1234">
          <description>Fetches the raw schema array for the subschemaSubentry of the server. Note,
this function has grown many hairs to accomodate more LDAP servers. It is
needfully complicated as it now supports many popular LDAP servers that
don't necessarily expose their schema "the right way".</description>
          <long-description>Please note: On FC systems, it seems that php_ldap uses /etc/openldap/ldap.conf in
the search base if it is blank - so edit that file and comment out the BASE line.</long-description>
          <tag name="param" description="&lt;p&gt;Which connection method resource to use&lt;/p&gt;" line="1234" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;A string indicating which type of schema to&#10;&#9;fetch. Five valid values: 'objectclasses', 'attributetypes',&#10;&#9;'ldapsyntaxes', 'matchingruleuse', or 'matchingrules'.&#10;&#9;Case insensitive.&lt;/p&gt;" line="1234" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;(optional) This paremeter is the DN of the entry whose schema you&#10;        would like to fetch. Entries have the option of specifying&#10;        their own subschemaSubentry that points to the DN of the system&#10;        schema entry which applies to this attribute. If unspecified,&#10;    this will try to retrieve the schema from the RootDSE subschemaSubentry.&#10;    Failing that, we use some commonly known schema DNs. Default&#10;    value is the Root DSE DN (zero-length string)&lt;/p&gt;&#10;" line="1234" type="\dn" variable="">
            <type>\dn</type>
          </tag>
          <tag name="return" description="an array of strings of this form:&#10;Array (&#10;&#9;[0] =&amp;gt; &amp;quot;(1.3.6.1.4.1.7165.1.2.2.4 NAME &amp;#039;gidPool&amp;#039; DESC &amp;#039;Pool ...&#10;&#9;[1] =&amp;gt; &amp;quot;(1.3.6.1.4.1.7165.2.2.3 NAME &amp;#039;sambaAccount&amp;#039; DESC &amp;#039;Sa ...&#10;etc." line="1234" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$method</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$schema_to_fetch</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$dn</name>
          <default>''</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1464" package="phpLDAPadmin\DataStore">
        <name>getSchemaObjectClass</name>
        <full_name>\myldap::getSchemaObjectClass()</full_name>
        <docblock line="1464">
          <description>Gets a single ObjectClass object specified by name.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The name of the objectClass to fetch.&lt;/p&gt;" line="1464" type="string" variable="$oclass_name">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;(optional) It is easier to fetch schema if a DN is provided&#10;              which defines the subschemaSubEntry attribute (all entries should).&lt;/p&gt;&#10;" line="1464" type="string" variable="$dn">
            <type>string</type>
          </tag>
          <tag name="return" description="The specified ObjectClass object or false on error." line="1464" type="\ObjectClass">
            <type>\ObjectClass</type>
          </tag>
          <tag name="see" description="" line="1464"/>
          <tag name="see" description="" line="1464"/>
        </docblock>
        <argument line="0">
          <name>$oclass_name</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$method</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$dn</name>
          <default>''</default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1495" package="phpLDAPadmin\DataStore">
        <name>getSchemaAttribute</name>
        <full_name>\myldap::getSchemaAttribute()</full_name>
        <docblock line="1495">
          <description>Gets a single AttributeType object specified by name.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The name of the AttributeType to fetch.&lt;/p&gt;" line="1495" type="string" variable="$oclass_name">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;(optional) It is easier to fetch schema if a DN is provided&#10;            which defines the subschemaSubEntry attribute (all entries should).&lt;/p&gt;&#10;" line="1495" type="string" variable="$dn">
            <type>string</type>
          </tag>
          <tag name="return" description="The specified AttributeType object or false on error." line="1495" type="\AttributeType">
            <type>\AttributeType</type>
          </tag>
          <tag name="see" description="" line="1495"/>
          <tag name="see" description="" line="1495"/>
        </docblock>
        <argument line="0">
          <name>$attr_name</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$method</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$dn</name>
          <default>''</default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1527" package="phpLDAPadmin\DataStore">
        <name>SchemaObjectClasses</name>
        <full_name>\myldap::SchemaObjectClasses()</full_name>
        <docblock line="1527">
          <description>Gets an associative array of ObjectClass objects for the specified
server. Each array entry's key is the name of the objectClass
in lower-case and the value is an ObjectClass object.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;(optional) It is easier to fetch schema if a DN is provided&#10;              which defines the subschemaSubEntry attribute (all entries should).&lt;/p&gt;&#10;" line="1527" type="string" variable="$dn">
            <type>string</type>
          </tag>
          <tag name="return" description="An array of ObjectClass objects." line="1527" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="1527"/>
          <tag name="see" description="" line="1527"/>
        </docblock>
        <argument line="0">
          <name>$method</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$dn</name>
          <default>''</default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1583" package="phpLDAPadmin\DataStore">
        <name>SchemaAttributes</name>
        <full_name>\myldap::SchemaAttributes()</full_name>
        <docblock line="1583">
          <description>Gets an associative array of AttributeType objects for the specified
server. Each array entry's key is the name of the attributeType
in lower-case and the value is an AttributeType object.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;(optional) It is easier to fetch schema if a DN is provided&#10;            which defines the subschemaSubEntry attribute (all entries should).&lt;/p&gt;&#10;" line="1583" type="string" variable="$dn">
            <type>string</type>
          </tag>
          <tag name="return" description="An array of AttributeType objects." line="1583" type="array">
            <type>array</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$method</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$dn</name>
          <default>''</default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1762" package="phpLDAPadmin\DataStore">
        <name>MatchingRules</name>
        <full_name>\myldap::MatchingRules()</full_name>
        <docblock line="1762">
          <description>Returns an array of MatchingRule objects for the specified server.</description>
          <long-description>The key of each entry is the OID of the matching rule.</long-description>
        </docblock>
        <argument line="0">
          <name>$method</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$dn</name>
          <default>''</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1838" package="phpLDAPadmin\DataStore">
        <name>SchemaSyntaxes</name>
        <full_name>\myldap::SchemaSyntaxes()</full_name>
        <docblock line="1838">
          <description>Returns an array of Syntax objects that this LDAP server uses mapped to
their descriptions. The key of each entry is the OID of the Syntax.</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$method</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$dn</name>
          <default>''</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1890" package="phpLDAPadmin\DataStore">
        <name>isForceMay</name>
        <full_name>\myldap::isForceMay()</full_name>
        <docblock line="1890">
          <description>This function determines if the specified attribute is contained in the force_may list
as configured in config.php.</description>
          <long-description></long-description>
          <tag name="return" description="True if the specified attribute is in the $force_may list and false&#10;             otherwise." line="1890" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attr_name</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1925" package="phpLDAPadmin\DataStore">
        <name>getDNAttrValue</name>
        <full_name>\myldap::getDNAttrValue()</full_name>
        <docblock line="1925">
          <description>Much like getDNAttrValues(), but only returns the values for
one attribute of an object. Example calls:</description>
          <long-description>&lt;code&gt;
print_r(getDNAttrValue('cn=Bob,ou=people,dc=example,dc=com','sn'));
Array (
	[0] =&gt; Smith
)

print_r(getDNAttrValue('cn=Bob,ou=people,dc=example,dc=com','objectClass'));
Array (
	[0] =&gt; top
	[1] =&gt; person
)
&lt;/code&gt;</long-description>
          <tag name="param" description="&lt;p&gt;The distinguished name (DN) of the entry whose attributes/values to fetch.&lt;/p&gt;&#10;" line="1925" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;The attribute whose value(s) to return (ie, &quot;objectClass&quot;, &quot;cn&quot;, &quot;userPassword&quot;)&lt;/p&gt;&#10;" line="1925" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Which connection method resource to use&lt;/p&gt;" line="1925" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;For aliases and referrals, this parameter specifies whether to&#10;           follow references to the referenced DN or to fetch the attributes for&#10;           the referencing DN. See http://php.net/ldap_search for the 4 valid&#10;           options.&lt;/p&gt;&#10;" line="1925" type="\constant" variable="">
            <type>\constant</type>
          </tag>
          <tag name="return" description="" line="1925" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="1925"/>
          <tag name="todo" description="Caching these values may be problematic with multiple calls and different deref values." line="1925"/>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$attr</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$method</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$deref</name>
          <default>LDAP_DEREF_NEVER</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="1979" package="phpLDAPadmin\DataStore">
        <name>getDNAttrValues</name>
        <full_name>\myldap::getDNAttrValues()</full_name>
        <docblock line="1979">
          <description>Gets the attributes/values of an entry. Returns an associative array whose
keys are attribute value names and whose values are arrays of values for
said attribute.</description>
          <long-description>Optionally, callers may specify true for the parameter
$lower_case_attr_names to force all keys in the associate array (attribute
names) to be lower case.

Example of its usage:
&lt;code&gt;
print_r(getDNAttrValues('cn=Bob,ou=pepole,dc=example,dc=com')
Array (
	[objectClass] =&gt; Array (
		[0] =&gt; person
		[1] =&gt; top
	)
	[cn] =&gt; Array (
		[0] =&gt; Bob
	)
	[sn] =&gt; Array (
		[0] =&gt; Jones
	)
	[dn] =&gt; Array (
		[0] =&gt; cn=Bob,ou=pepole,dc=example,dc=com
	)
)
&lt;/code&gt;</long-description>
          <tag name="param" description="&lt;p&gt;The distinguished name (DN) of the entry whose attributes/values to fetch.&lt;/p&gt;&#10;" line="1979" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Which connection method resource to use&lt;/p&gt;" line="1979" type="string" variable="">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;For aliases and referrals, this parameter specifies whether to&#10;           follow references to the referenced DN or to fetch the attributes for&#10;           the referencing DN. See http://php.net/ldap_search for the 4 valid&#10;           options.&lt;/p&gt;&#10;" line="1979" type="\constant" variable="">
            <type>\constant</type>
          </tag>
          <tag name="return" description="" line="1979" type="array">
            <type>array</type>
          </tag>
          <tag name="see" description="" line="1979"/>
          <tag name="see" description="" line="1979"/>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$method</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$deref</name>
          <default>LDAP_DEREF_NEVER</default>
          <type/>
        </argument>
        <argument line="0">
          <name>$attrs</name>
          <default>array('*', '+')</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2037" package="phpLDAPadmin\DataStore">
        <name>isDNAttr</name>
        <full_name>\myldap::isDNAttr()</full_name>
        <docblock line="2037">
          <description>Returns true if the attribute specified is required to take as input a DN.</description>
          <long-description>Some examples include 'distinguishedName', 'member' and 'uniqueMember'.</long-description>
          <tag name="param" description="&lt;p&gt;The name of the attribute of interest (case insensitive)&lt;/p&gt;&#10;" line="2037" type="string" variable="$attr_name">
            <type>string</type>
          </tag>
          <tag name="return" description="" line="2037" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attr_name</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$method</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2078" package="phpLDAPadmin\DataStore">
        <name>isJpegPhoto</name>
        <full_name>\myldap::isJpegPhoto()</full_name>
        <docblock line="2078">
          <description>Used to determine if the specified attribute is indeed a jpegPhoto. If the
specified attribute is one that houses jpeg data, true is returned. Otherwise
this function returns false.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The name of the attribute to test.&lt;/p&gt;" line="2078" type="string" variable="$attr_name">
            <type>string</type>
          </tag>
          <tag name="return" description="" line="2078" type="boolean">
            <type>boolean</type>
          </tag>
          <tag name="see" description="" line="2078"/>
        </docblock>
        <argument line="0">
          <name>$attr_name</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2109" package="phpLDAPadmin\DataStore">
        <name>isAttrBoolean</name>
        <full_name>\myldap::isAttrBoolean()</full_name>
        <docblock line="2109">
          <description>Given an attribute name and server ID number, this function returns
whether the attrbiute contains boolean data. This is useful for
developers who wish to display the contents of a boolean attribute
with a drop-down.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The name of the attribute to test.&lt;/p&gt;" line="2109" type="string" variable="$attr_name">
            <type>string</type>
          </tag>
          <tag name="return" description="" line="2109" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attr_name</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2135" package="phpLDAPadmin\DataStore">
        <name>isAttrBinary</name>
        <full_name>\myldap::isAttrBinary()</full_name>
        <docblock line="2135">
          <description>Given an attribute name and server ID number, this function returns
whether the attribute may contain binary data. This is useful for
developers who wish to display the contents of an arbitrary attribute
but don't want to dump binary data on the page.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;The name of the attribute to test.&lt;/p&gt;" line="2135" type="string" variable="$attr_name">
            <type>string</type>
          </tag>
          <tag name="return" description="" line="2135" type="boolean">
            <type>boolean</type>
          </tag>
          <tag name="see" description="" line="2135"/>
        </docblock>
        <argument line="0">
          <name>$attr_name</name>
          <default></default>
          <type>string</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="2221" package="phpLDAPadmin\DataStore">
        <name>userIsMember</name>
        <full_name>\myldap::userIsMember()</full_name>
        <docblock line="2221">
          <description>This function will test if a user is a member of a group.</description>
          <long-description>Inputs:</long-description>
          <tag name="param" description="&lt;p&gt;membership value that is being checked&lt;/p&gt;" line="2221" type="string" variable="$user">
            <type>string</type>
          </tag>
          <tag name="param" description="&lt;p&gt;DN to see if user is a member&lt;/p&gt;" line="2221" type="\dn" variable="$group">
            <type>\dn</type>
          </tag>
          <tag name="return" description="true|false" line="2221" type="bool">
            <type>bool</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$user</name>
          <default></default>
          <type>string</type>
        </argument>
        <argument line="0">
          <name>$group</name>
          <default></default>
          <type>\dn</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="2252" package="phpLDAPadmin\DataStore">
        <name>userIsAllowedLogin</name>
        <full_name>\myldap::userIsAllowedLogin()</full_name>
        <docblock line="2252">
          <description>This function will determine if the user is allowed to login based on a filter</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type/>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/common.php" generated-path="templates.3rdParty.pla.lib.common.html" hash="567c07393a4d9b23bd6041b0fb1ae6d4" package="phpLDAPadmin">
    <docblock line="0">
      <description>Contains code to be executed at the top of each application page.</description>
      <long-description>include this file at the top of every PHP file.

This file will "pre-initialise" an application environment so that any PHP file will have a consistent
environment with other application PHP files.

This code WILL NOT check that all required functions are usable/readable, etc. This process has
been moved to index.php (which really is only called once when a browser hits the application for the first time).

The list of ADDITIONAL function files is now defined in functions.php.</long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <constant namespace="" line="29" package="phpLDAPadmin">
      <name>APPCONFIG</name>
      <full_name>\\APPCONFIG</full_name>
      <value>'plaConfig'</value>
      <docblock line="29">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="115" package="phpLDAPadmin">
      <name>LIBDIR</name>
      <full_name>\\LIBDIR</full_name>
      <value>'../lib/'</value>
      <docblock line="115">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="119" package="phpLDAPadmin">
      <name>E_STRICT</name>
      <full_name>\\E_STRICT</full_name>
      <value>2048</value>
      <docblock line="119">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="170" package="phpLDAPadmin">
      <name>CSSDIR</name>
      <full_name>\\CSSDIR</full_name>
      <value>sprintf('css/%s', $app['theme'])</value>
      <docblock line="170">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="171" package="phpLDAPadmin">
      <name>IMGDIR</name>
      <full_name>\\IMGDIR</full_name>
      <value>sprintf('images/%s', $app['theme'])</value>
      <docblock line="171">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="205" package="phpLDAPadmin">
      <name>DEBUG_ENABLED</name>
      <full_name>\\DEBUG_ENABLED</full_name>
      <value>0</value>
      <docblock line="205">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <function namespace="" line="87" package="phpLDAPadmin">
      <name>stopwatch</name>
      <full_name>\stopwatch()</full_name>
      <docblock line="87">
        <description></description>
        <long-description></long-description>
      </docblock>
    </function>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/MassRender.php" generated-path="templates.3rdParty.pla.lib.MassRender.html" hash="ae2063510c5064c07f9dc6ece2a9d307" package="phpLDAPadmin">
    <docblock line="0">
      <description>This class will render the editing of multiple LDAP entries.</description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="15" package="phpLDAPadmin\Templates">
      <extends>\TemplateRender</extends>
      <name>MassRender</name>
      <full_name>\MassRender</full_name>
      <docblock line="15">
        <description>TemplateRender class</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="15"/>
        <tag name="subpackage" description="Templates" line="15"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="16" package="phpLDAPadmin\Templates">
        <name>drawMassFormReadWriteValueAttribute</name>
        <full_name>\MassRender::drawMassFormReadWriteValueAttribute()</full_name>
        <docblock line="16">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$j</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="40" package="phpLDAPadmin\Templates">
        <name>drawMassFormReadWriteValueBinaryAttribute</name>
        <full_name>\MassRender::drawMassFormReadWriteValueBinaryAttribute()</full_name>
        <docblock line="40">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$j</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="44" package="phpLDAPadmin\Templates">
        <name>drawMassFormReadWriteValueJpegAttribute</name>
        <full_name>\MassRender::drawMassFormReadWriteValueJpegAttribute()</full_name>
        <docblock line="44">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$j</name>
          <default></default>
          <type/>
        </argument>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/GidAttribute.php" generated-path="templates.3rdParty.pla.lib.GidAttribute.html" hash="637879c2395ef0a5f5b07cd6dc431f81" package="phpLDAPadmin">
    <docblock line="0">
      <description>Classes and functions for the template engine.</description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="15" package="phpLDAPadmin\Templates">
      <extends>\Attribute</extends>
      <name>GidAttribute</name>
      <full_name>\GidAttribute</full_name>
      <docblock line="15">
        <description>Represents a 'gidNumber' attribute</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="15"/>
        <tag name="subpackage" description="Templates" line="15"/>
      </docblock>
    </class>
    <source>eJx1j8EKwjAQRO/5ir0VerA/ILZFwYuISH9g22zbYJOGZCOC+O+mxSAevO7Mm5ndlna0oshzATnsJ/SePKCR0AfTsZqNh352wCMBk7YTMgGZQRnaRGKBKgw8RksTLTHrdKgvKLUyIOlO02w1GY4s6tVssbvh8OuMQiHShitZRz4ycQZkg5LnoFtyGSCzU21gSr1/oqDyoU1a89ns145u+Q+OStYpC+jBZKSH7+UpXqLciTfmx1tW</source>
  </file>
  <file path="templates/3rdParty/pla/lib/PageRender.php" generated-path="templates.3rdParty.pla.lib.PageRender.html" hash="d914f95cb89c7c020706061f570ef333" package="phpLDAPadmin">
    <docblock line="0">
      <description></description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="13" package="phpLDAPadmin\Templates">
      <extends>\Visitor</extends>
      <name>PageRender</name>
      <full_name>\PageRender</full_name>
      <docblock line="13">
        <description>PageRender class</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="13"/>
        <tag name="subpackage" description="Templates" line="13"/>
      </docblock>
      <property static="false" visibility="protected" line="15" namespace="" package="phpLDAPadmin\Templates">
        <name>$template_id</name>
        <default></default>
        <docblock line="15">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="16" namespace="" package="phpLDAPadmin\Templates">
        <name>$template</name>
        <default>null</default>
        <docblock line="16">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="18" namespace="" package="phpLDAPadmin\Templates">
        <name>$dn</name>
        <default></default>
        <docblock line="18">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="19" namespace="" package="phpLDAPadmin\Templates">
        <name>$container</name>
        <default></default>
        <docblock line="19">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="21" namespace="" package="phpLDAPadmin\Templates">
        <name>$page</name>
        <default></default>
        <docblock line="21">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="23" package="phpLDAPadmin\Templates">
        <name>__construct</name>
        <full_name>\PageRender::__construct()</full_name>
        <docblock line="23">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$server_id</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$template_id</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="34" package="phpLDAPadmin\Templates">
        <name>visitAttribute</name>
        <full_name>\PageRender::visitAttribute()</full_name>
        <docblock line="34">
          <description>Dummy method.</description>
          <long-description>..</long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="39" package="phpLDAPadmin\Templates">
        <name>getTemplates</name>
        <full_name>\PageRender::getTemplates()</full_name>
        <docblock line="39">
          <description>Get our templates applicable for this object</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="46" package="phpLDAPadmin\Templates">
        <name>getTemplate</name>
        <full_name>\PageRender::getTemplate()</full_name>
        <docblock line="46">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="53" package="phpLDAPadmin\Templates">
        <name>getTemplateID</name>
        <full_name>\PageRender::getTemplateID()</full_name>
        <docblock line="53">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="63" package="phpLDAPadmin\Templates">
        <name>accept</name>
        <full_name>\PageRender::accept()</full_name>
        <docblock line="63">
          <description>Initialise the PageRender</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="103" package="phpLDAPadmin\Templates">
        <name>drawTitle</name>
        <full_name>\PageRender::drawTitle()</full_name>
        <docblock line="103">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$title</name>
          <default>'Title'</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="107" package="phpLDAPadmin\Templates">
        <name>drawSubTitle</name>
        <full_name>\PageRender::drawSubTitle()</full_name>
        <docblock line="107">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$subtitle</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="115" package="phpLDAPadmin\Templates">
        <name>setDN</name>
        <full_name>\PageRender::setDN()</full_name>
        <docblock line="115">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="128" package="phpLDAPadmin\Templates">
        <name>setContainer</name>
        <full_name>\PageRender::setContainer()</full_name>
        <docblock line="128">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$dn</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="144" package="phpLDAPadmin\Templates">
        <name>getMode</name>
        <full_name>\PageRender::getMode()</full_name>
        <docblock line="144">
          <description>May be overloaded in other classes</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="145" package="phpLDAPadmin\Templates">
        <name>getModeContainer</name>
        <full_name>\PageRender::getModeContainer()</full_name>
        <docblock line="145">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="150" package="phpLDAPadmin\Templates">
        <name>getPostAttribute</name>
        <full_name>\PageRender::getPostAttribute()</full_name>
        <docblock line="150">
          <description>Process our &lt;post&gt; arguments from the templates</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="313" package="phpLDAPadmin\Templates">
        <name>getTemplateChoice</name>
        <full_name>\PageRender::getTemplateChoice()</full_name>
        <docblock line="313">
          <description>This function is invoked if we dont know which template we should be using.</description>
          <long-description></long-description>
          <tag name="return" description="Template ID to be used or null if the user was presented with a list." line="313" type="string">
            <type>string</type>
          </tag>
        </docblock>
      </method>
      <method final="true" abstract="false" static="false" visibility="protected" namespace="" line="362" package="phpLDAPadmin\Templates">
        <name>drawNameAttribute</name>
        <full_name>\PageRender::drawNameAttribute()</full_name>
        <docblock line="362">
          <description>DRAW ATTRIBUTE NAME *</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="383" package="phpLDAPadmin\Templates">
        <name>drawNotesAttribute</name>
        <full_name>\PageRender::drawNotesAttribute()</full_name>
        <docblock line="383">
          <description>ATTRIBUTE NOTES</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="403" package="phpLDAPadmin\Templates">
        <name>getNoteAliasAttribute</name>
        <full_name>\PageRender::getNoteAliasAttribute()</full_name>
        <docblock line="403">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="408" package="phpLDAPadmin\Templates">
        <name>getNoteRequiredAttribute</name>
        <full_name>\PageRender::getNoteRequiredAttribute()</full_name>
        <docblock line="408">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="450" package="phpLDAPadmin\Templates">
        <name>getNoteRDNAttribute</name>
        <full_name>\PageRender::getNoteRDNAttribute()</full_name>
        <docblock line="450">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="463" package="phpLDAPadmin\Templates">
        <name>getNoteHintAttribute</name>
        <full_name>\PageRender::getNoteHintAttribute()</full_name>
        <docblock line="463">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="476" package="phpLDAPadmin\Templates">
        <name>getNoteROAttribute</name>
        <full_name>\PageRender::getNoteROAttribute()</full_name>
        <docblock line="476">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="true" abstract="false" static="false" visibility="public" namespace="" line="489" package="phpLDAPadmin\Templates">
        <name>drawHiddenAttributes</name>
        <full_name>\PageRender::drawHiddenAttributes()</full_name>
        <docblock line="489">
          <description>Draw all hidden attributes</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="true" abstract="false" static="false" visibility="protected" namespace="" line="508" package="phpLDAPadmin\Templates">
        <name>drawHiddenValueAttribute</name>
        <full_name>\PageRender::drawHiddenValueAttribute()</full_name>
        <docblock line="508">
          <description>Draw specific hidden attribute</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="519" package="phpLDAPadmin\Templates">
        <name>drawOldValuesAttribute</name>
        <full_name>\PageRender::drawOldValuesAttribute()</full_name>
        <docblock line="519">
          <description>DRAW DISPLAYED OLD VALUES *</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="true" abstract="false" static="false" visibility="protected" namespace="" line="526" package="phpLDAPadmin\Templates">
        <name>drawOldValueAttribute</name>
        <full_name>\PageRender::drawOldValueAttribute()</full_name>
        <docblock line="526">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="534" package="phpLDAPadmin\Templates">
        <name>drawCurrentValuesAttribute</name>
        <full_name>\PageRender::drawCurrentValuesAttribute()</full_name>
        <docblock line="534">
          <description>DRAW DISPLAYED CURRENT VALUES *</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="true" abstract="false" static="false" visibility="protected" namespace="" line="548" package="phpLDAPadmin\Templates">
        <name>drawCurrentValueAttribute</name>
        <full_name>\PageRender::drawCurrentValueAttribute()</full_name>
        <docblock line="548">
          <description>Draw the current specific value of an attribute</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="558" package="phpLDAPadmin\Templates">
        <name>drawFormValueAttribute</name>
        <full_name>\PageRender::drawFormValueAttribute()</full_name>
        <docblock line="558">
          <description>Draw a input value for an attribute - used in a form.</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="577" package="phpLDAPadmin\Templates">
        <name>drawFormReadOnlyValueAttribute</name>
        <full_name>\PageRender::drawFormReadOnlyValueAttribute()</full_name>
        <docblock line="577">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="586" package="phpLDAPadmin\Templates">
        <name>drawFormReadWriteValueAttribute</name>
        <full_name>\PageRender::drawFormReadWriteValueAttribute()</full_name>
        <docblock line="586">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="true" abstract="false" static="false" visibility="protected" namespace="" line="630" package="phpLDAPadmin\Templates">
        <name>drawHiddenValueBinaryAttribute</name>
        <full_name>\PageRender::drawHiddenValueBinaryAttribute()</full_name>
        <docblock line="630">
          <description>Draw specific hidden binary attribute</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="true" abstract="false" static="false" visibility="protected" namespace="" line="639" package="phpLDAPadmin\Templates">
        <name>drawOldValueBinaryAttribute</name>
        <full_name>\PageRender::drawOldValueBinaryAttribute()</full_name>
        <docblock line="639">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="true" abstract="false" static="false" visibility="protected" namespace="" line="647" package="phpLDAPadmin\Templates">
        <name>drawCurrentValueBinaryAttribute</name>
        <full_name>\PageRender::drawCurrentValueBinaryAttribute()</full_name>
        <docblock line="647">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="654" package="phpLDAPadmin\Templates">
        <name>drawFormReadOnlyValueBinaryAttribute</name>
        <full_name>\PageRender::drawFormReadOnlyValueBinaryAttribute()</full_name>
        <docblock line="654">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="669" package="phpLDAPadmin\Templates">
        <name>drawFormReadWriteValueBinaryAttribute</name>
        <full_name>\PageRender::drawFormReadWriteValueBinaryAttribute()</full_name>
        <docblock line="669">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="690" package="phpLDAPadmin\Templates">
        <name>drawFormReadWriteValueDateAttribute</name>
        <full_name>\PageRender::drawFormReadWriteValueDateAttribute()</full_name>
        <docblock line="690">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="708" package="phpLDAPadmin\Templates">
        <name>drawFormReadWriteValueDnAttribute</name>
        <full_name>\PageRender::drawFormReadWriteValueDnAttribute()</full_name>
        <docblock line="708">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="739" package="phpLDAPadmin\Templates">
        <name>drawFormReadWriteValueGidAttribute</name>
        <full_name>\PageRender::drawFormReadWriteValueGidAttribute()</full_name>
        <docblock line="739">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="true" abstract="false" static="false" visibility="protected" namespace="" line="792" package="phpLDAPadmin\Templates">
        <name>drawOldValueJpegAttribute</name>
        <full_name>\PageRender::drawOldValueJpegAttribute()</full_name>
        <docblock line="792">
          <description>Draw a Jpeg Attribute</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="true" abstract="false" static="false" visibility="protected" namespace="" line="806" package="phpLDAPadmin\Templates">
        <name>drawCurrentValueJpegAttribute</name>
        <full_name>\PageRender::drawCurrentValueJpegAttribute()</full_name>
        <docblock line="806">
          <description>Draw a Jpeg Attribute</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="822" package="phpLDAPadmin\Templates">
        <name>drawFormReadOnlyValueJpegAttribute</name>
        <full_name>\PageRender::drawFormReadOnlyValueJpegAttribute()</full_name>
        <docblock line="822">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="829" package="phpLDAPadmin\Templates">
        <name>drawFormReadOnlyValueMultiLineAttribute</name>
        <full_name>\PageRender::drawFormReadOnlyValueMultiLineAttribute()</full_name>
        <docblock line="829">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="842" package="phpLDAPadmin\Templates">
        <name>drawFormReadWriteValueMultiLineAttribute</name>
        <full_name>\PageRender::drawFormReadWriteValueMultiLineAttribute()</full_name>
        <docblock line="842">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="857" package="phpLDAPadmin\Templates">
        <name>drawFormValueObjectClassAttribute</name>
        <full_name>\PageRender::drawFormValueObjectClassAttribute()</full_name>
        <docblock line="857">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="888" package="phpLDAPadmin\Templates">
        <name>getAutoPostPasswordAttribute</name>
        <full_name>\PageRender::getAutoPostPasswordAttribute()</full_name>
        <docblock line="888">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="897" package="phpLDAPadmin\Templates">
        <name>drawOldValuePasswordAttribute</name>
        <full_name>\PageRender::drawOldValuePasswordAttribute()</full_name>
        <docblock line="897">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="true" abstract="false" static="false" visibility="protected" namespace="" line="909" package="phpLDAPadmin\Templates">
        <name>drawCurrentValuePasswordAttribute</name>
        <full_name>\PageRender::drawCurrentValuePasswordAttribute()</full_name>
        <docblock line="909">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="921" package="phpLDAPadmin\Templates">
        <name>drawFormReadOnlyValuePasswordAttribute</name>
        <full_name>\PageRender::drawFormReadOnlyValuePasswordAttribute()</full_name>
        <docblock line="921">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="943" package="phpLDAPadmin\Templates">
        <name>drawFormReadWriteValuePasswordAttribute</name>
        <full_name>\PageRender::drawFormReadWriteValuePasswordAttribute()</full_name>
        <docblock line="943">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="996" package="phpLDAPadmin\Templates">
        <name>drawFormReadWriteValueSelectionAttribute</name>
        <full_name>\PageRender::drawFormReadWriteValueSelectionAttribute()</full_name>
        <docblock line="996">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="1128" package="phpLDAPadmin\Templates">
        <name>shadow_date</name>
        <full_name>\PageRender::shadow_date()</full_name>
        <docblock line="1128">
          <description>Takes a shadow* attribute and returns the date as an integer.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Attribute objects&lt;/p&gt;" line="1128" type="array" variable="">
            <type>array</type>
          </tag>
          <tag name="param" description="&lt;p&gt;A shadow attribute name&lt;/p&gt;" line="1128" type="string" variable="">
            <type>string</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1167" package="phpLDAPadmin\Templates">
        <name>drawShadowDateShadowAttribute</name>
        <full_name>\PageRender::drawShadowDateShadowAttribute()</full_name>
        <docblock line="1167">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1195" package="phpLDAPadmin\Templates">
        <name>drawFormReadOnlyValueShadowAttribute</name>
        <full_name>\PageRender::drawFormReadOnlyValueShadowAttribute()</full_name>
        <docblock line="1195">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="1202" package="phpLDAPadmin\Templates">
        <name>drawFormReadWriteValueShadowAttribute</name>
        <full_name>\PageRender::drawFormReadWriteValueShadowAttribute()</full_name>
        <docblock line="1202">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$attribute</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$i</name>
          <default></default>
          <type/>
        </argument>
      </method>
    </class>
    <parse_markers>
      <error line="0" code="PPC:ERR-50000">No summary was found for this file</error>
      <error line="15" code="PPC:ERR-50007">No summary for property $template_id</error>
      <error line="16" code="PPC:ERR-50007">No summary for property $template</error>
      <error line="18" code="PPC:ERR-50007">No summary for property $dn</error>
      <error line="19" code="PPC:ERR-50007">No summary for property $container</error>
      <error line="21" code="PPC:ERR-50007">No summary for property $page</error>
      <error line="23" code="PPC:ERR-50008">No summary for method __construct()</error>
      <error line="46" code="PPC:ERR-50008">No summary for method getTemplate()</error>
      <error line="53" code="PPC:ERR-50008">No summary for method getTemplateID()</error>
      <error line="103" code="PPC:ERR-50008">No summary for method drawTitle()</error>
      <error line="107" code="PPC:ERR-50008">No summary for method drawSubTitle()</error>
      <error line="115" code="PPC:ERR-50008">No summary for method setDN()</error>
      <error line="128" code="PPC:ERR-50008">No summary for method setContainer()</error>
      <error line="145" code="PPC:ERR-50008">No summary for method getModeContainer()</error>
      <error line="403" code="PPC:ERR-50008">No summary for method getNoteAliasAttribute()</error>
      <error line="408" code="PPC:ERR-50008">No summary for method getNoteRequiredAttribute()</error>
      <error line="450" code="PPC:ERR-50008">No summary for method getNoteRDNAttribute()</error>
      <error line="463" code="PPC:ERR-50008">No summary for method getNoteHintAttribute()</error>
      <error line="476" code="PPC:ERR-50008">No summary for method getNoteROAttribute()</error>
      <error line="526" code="PPC:ERR-50008">No summary for method drawOldValueAttribute()</error>
      <error line="577" code="PPC:ERR-50008">No summary for method drawFormReadOnlyValueAttribute()</error>
      <error line="586" code="PPC:ERR-50008">No summary for method drawFormReadWriteValueAttribute()</error>
      <error line="639" code="PPC:ERR-50008">No summary for method drawOldValueBinaryAttribute()</error>
      <error line="647" code="PPC:ERR-50008">No summary for method drawCurrentValueBinaryAttribute()</error>
      <error line="654" code="PPC:ERR-50008">No summary for method drawFormReadOnlyValueBinaryAttribute()</error>
      <error line="669" code="PPC:ERR-50008">No summary for method drawFormReadWriteValueBinaryAttribute()</error>
      <error line="690" code="PPC:ERR-50008">No summary for method drawFormReadWriteValueDateAttribute()</error>
      <error line="708" code="PPC:ERR-50008">No summary for method drawFormReadWriteValueDnAttribute()</error>
      <error line="739" code="PPC:ERR-50008">No summary for method drawFormReadWriteValueGidAttribute()</error>
      <error line="822" code="PPC:ERR-50008">No summary for method drawFormReadOnlyValueJpegAttribute()</error>
      <error line="829" code="PPC:ERR-50008">No summary for method drawFormReadOnlyValueMultiLineAttribute()</error>
      <error line="842" code="PPC:ERR-50008">No summary for method drawFormReadWriteValueMultiLineAttribute()</error>
      <error line="857" code="PPC:ERR-50008">No summary for method drawFormValueObjectClassAttribute()</error>
      <error line="888" code="PPC:ERR-50008">No summary for method getAutoPostPasswordAttribute()</error>
      <error line="897" code="PPC:ERR-50008">No summary for method drawOldValuePasswordAttribute()</error>
      <error line="909" code="PPC:ERR-50008">No summary for method drawCurrentValuePasswordAttribute()</error>
      <error line="921" code="PPC:ERR-50008">No summary for method drawFormReadOnlyValuePasswordAttribute()</error>
      <error line="943" code="PPC:ERR-50008">No summary for method drawFormReadWriteValuePasswordAttribute()</error>
      <error line="996" code="PPC:ERR-50008">No summary for method drawFormReadWriteValueSelectionAttribute()</error>
      <error line="1167" code="PPC:ERR-50008">No summary for method drawShadowDateShadowAttribute()</error>
      <error line="1195" code="PPC:ERR-50008">No summary for method drawFormReadOnlyValueShadowAttribute()</error>
      <error line="1202" code="PPC:ERR-50008">No summary for method drawFormReadWriteValueShadowAttribute()</error>
    </parse_markers>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/export_functions.php" generated-path="templates.3rdParty.pla.lib.export_functions.html" hash="f46c7864d7d296749c4bc576aebd9cf7" package="phpLDAPadmin">
    <docblock line="0">
      <description>Classes and functions for export data from LDAP</description>
      <long-description>These classes provide differnet export formats.</long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="see" description="and export_form.php" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="21" package="phpLDAPadmin\Export">
      <extends/>
      <name>Exporter</name>
      <full_name>\Exporter</full_name>
      <docblock line="21">
        <description>Exporter Class</description>
        <long-description>This class serves as a top level exporter class, which will return
the correct Export class.</long-description>
        <tag name="package" description="phpLDAPadmin" line="21"/>
        <tag name="subpackage" description="Export" line="21"/>
      </docblock>
      <property static="false" visibility="private" line="23" namespace="" package="phpLDAPadmin\Export">
        <name>$server_id</name>
        <default></default>
        <docblock line="23">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="25" namespace="" package="phpLDAPadmin\Export">
        <name>$template_id</name>
        <default></default>
        <docblock line="25">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="26" namespace="" package="phpLDAPadmin\Export">
        <name>$template</name>
        <default></default>
        <docblock line="26">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="28" package="phpLDAPadmin\Export">
        <name>__construct</name>
        <full_name>\Exporter::__construct()</full_name>
        <docblock line="28">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$server_id</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$template_id</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="35" package="phpLDAPadmin\Export">
        <name>types</name>
        <full_name>\Exporter::types()</full_name>
        <docblock line="35">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="50" package="phpLDAPadmin\Export">
        <name>accept</name>
        <full_name>\Exporter::accept()</full_name>
        <docblock line="50">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="75" package="phpLDAPadmin\Export">
        <name>getTemplate</name>
        <full_name>\Exporter::getTemplate()</full_name>
        <docblock line="75">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
    </class>
    <class final="false" abstract="true" namespace="" line="89" package="phpLDAPadmin\Export">
      <extends/>
      <name>Export</name>
      <full_name>\Export</full_name>
      <docblock line="89">
        <description>Export Class</description>
        <long-description>This abstract classes provides all the common methods and variables for the
custom export classes.</long-description>
        <tag name="package" description="phpLDAPadmin" line="89"/>
        <tag name="subpackage" description="Export" line="89"/>
      </docblock>
      <property static="false" visibility="protected" line="91" namespace="" package="phpLDAPadmin\Export">
        <name>$br</name>
        <default></default>
        <docblock line="91">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="93" namespace="" package="phpLDAPadmin\Export">
        <name>$compress</name>
        <default></default>
        <docblock line="93">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="95" namespace="" package="phpLDAPadmin\Export">
        <name>$results</name>
        <default></default>
        <docblock line="95">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="96" namespace="" package="phpLDAPadmin\Export">
        <name>$resultsdata</name>
        <default></default>
        <docblock line="96">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="protected" line="97" namespace="" package="phpLDAPadmin\Export">
        <name>$items</name>
        <default>0</default>
        <docblock line="97">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="104" package="phpLDAPadmin\Export">
        <name>getServer</name>
        <full_name>\Export::getServer()</full_name>
        <docblock line="104">
          <description>Return this LDAP Server object</description>
          <long-description></long-description>
          <tag name="return" description="DataStore Server" line="104" type="object">
            <type>object</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="113" package="phpLDAPadmin\Export">
        <name>getServerID</name>
        <full_name>\Export::getServerID()</full_name>
        <docblock line="113">
          <description>Return the LDAP server ID</description>
          <long-description></long-description>
          <tag name="return" description="Server ID" line="113" type="int">
            <type>int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="117" package="phpLDAPadmin\Export">
        <name>accept</name>
        <full_name>\Export::accept()</full_name>
        <docblock line="117">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="190" package="phpLDAPadmin\Export">
        <name>isCompressed</name>
        <full_name>\Export::isCompressed()</full_name>
        <docblock line="190">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="194" package="phpLDAPadmin\Export">
        <name>getHeader</name>
        <full_name>\Export::getHeader()</full_name>
        <docblock line="194">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="218" package="phpLDAPadmin\Export">
        <name>isSafeAscii</name>
        <full_name>\Export::isSafeAscii()</full_name>
        <docblock line="218">
          <description>Helper method to check if the attribute value should be base 64 encoded.</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;string to check.&lt;/p&gt;" line="218" type="\The" variable="">
            <type>\The</type>
          </tag>
          <tag name="return" description="true if the string is safe ascii, false otherwise." line="218" type="boolean">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$str</name>
          <default></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="233" package="phpLDAPadmin\Export">
      <extends>\Export</extends>
      <name>ExportCSV</name>
      <full_name>\ExportCSV</full_name>
      <docblock line="233">
        <description>Export entries to CSV</description>
        <long-description>This abstract classes provides all the common methods and variables for the
custom export classes.</long-description>
        <tag name="package" description="phpLDAPadmin" line="233"/>
        <tag name="subpackage" description="Export" line="233"/>
      </docblock>
      <property static="false" visibility="private" line="234" namespace="" package="phpLDAPadmin\Export">
        <name>$separator</name>
        <default>','</default>
        <docblock line="234">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="235" namespace="" package="phpLDAPadmin\Export">
        <name>$qualifier</name>
        <default>'"'</default>
        <docblock line="235">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="236" namespace="" package="phpLDAPadmin\Export">
        <name>$multivalue_separator</name>
        <default>' | '</default>
        <docblock line="236">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="237" namespace="" package="phpLDAPadmin\Export">
        <name>$escapeCode</name>
        <default>'"'</default>
        <docblock line="237">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="239" package="phpLDAPadmin\Export">
        <name>getType</name>
        <full_name>\ExportCSV::getType()</full_name>
        <docblock line="239">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="243" package="phpLDAPadmin\Export">
        <name>export</name>
        <full_name>\ExportCSV::export()</full_name>
        <docblock line="243">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="330" package="phpLDAPadmin\Export">
        <name>LdapEscape</name>
        <full_name>\ExportCSV::LdapEscape()</full_name>
        <docblock line="330">
          <description>Function to escape data, where the qualifier happens to also
be in the data.</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$var</name>
          <default></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="341" package="phpLDAPadmin\Export">
      <extends>\Export</extends>
      <name>ExportDSML</name>
      <full_name>\ExportDSML</full_name>
      <docblock line="341">
        <description>Export entries to DSML v.1</description>
        <long-description>This abstract classes provides all the common methods and variables for the
custom export classes.</long-description>
        <tag name="package" description="phpLDAPadmin" line="341"/>
        <tag name="subpackage" description="Export" line="341"/>
      </docblock>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="342" package="phpLDAPadmin\Export">
        <name>getType</name>
        <full_name>\ExportDSML::getType()</full_name>
        <docblock line="342">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="349" package="phpLDAPadmin\Export">
        <name>export</name>
        <full_name>\ExportDSML::export()</full_name>
        <docblock line="349">
          <description>Export entries to DSML format</description>
          <long-description></long-description>
        </docblock>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="437" package="phpLDAPadmin\Export">
      <extends>\Export</extends>
      <name>ExportLDIF</name>
      <full_name>\ExportLDIF</full_name>
      <docblock line="437">
        <description>Export from LDAP using an LDIF format</description>
        <long-description>This abstract classes provides all the common methods and variables for the
custom export classes.</long-description>
        <tag name="package" description="phpLDAPadmin" line="437"/>
        <tag name="subpackage" description="Export" line="437"/>
      </docblock>
      <property static="false" visibility="private" line="439" namespace="" package="phpLDAPadmin\Export">
        <name>$line_length</name>
        <default>76</default>
        <docblock line="439">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="441" package="phpLDAPadmin\Export">
        <name>getType</name>
        <full_name>\ExportLDIF::getType()</full_name>
        <docblock line="441">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="448" package="phpLDAPadmin\Export">
        <name>export</name>
        <full_name>\ExportLDIF::export()</full_name>
        <docblock line="448">
          <description>Export entries to LDIF format</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="" line="513" package="phpLDAPadmin\Export">
        <name>multiLineDisplay</name>
        <full_name>\ExportLDIF::multiLineDisplay()</full_name>
        <docblock line="513">
          <description>Helper method to wrap ldif lines</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;line to be wrapped if needed.&lt;/p&gt;" line="513" type="\The" variable="">
            <type>\The</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$str</name>
          <default></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="" line="541" package="phpLDAPadmin\Export">
      <extends>\Export</extends>
      <name>ExportVCARD</name>
      <full_name>\ExportVCARD</full_name>
      <docblock line="541">
        <description>Export entries to VCARD v2.1</description>
        <long-description>This abstract classes provides all the common methods and variables for the
custom export classes.</long-description>
        <tag name="package" description="phpLDAPadmin" line="541"/>
        <tag name="subpackage" description="Export" line="541"/>
      </docblock>
      <property static="false" visibility="private" line="547" namespace="" package="phpLDAPadmin\Export">
        <name>$mapping</name>
        <default>array('cn' =&gt; 'FN', 'title' =&gt; 'TITLE', 'homephone' =&gt; 'TEL;HOME', 'mobile' =&gt; 'TEL;CELL', 'mail' =&gt; 'EMAIL;Internet', 'labeleduri' =&gt; 'URL', 'o' =&gt; 'ORG', 'audio' =&gt; 'SOUND', 'facsmiletelephoneNumber' =&gt; 'TEL;WORK;HOME;VOICE;FAX', 'jpegphoto' =&gt; 'PHOTO;ENCODING=BASE64', 'businesscategory' =&gt; 'ROLE', 'description' =&gt; 'NOTE')</default>
        <docblock line="547">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <property static="false" visibility="private" line="562" namespace="" package="phpLDAPadmin\Export">
        <name>$deliveryAddress</name>
        <default>array('postofficebox', 'street', 'l', 'st', 'postalcode', 'c')</default>
        <docblock line="562">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="true" visibility="public" namespace="" line="542" package="phpLDAPadmin\Export">
        <name>getType</name>
        <full_name>\ExportVCARD::getType()</full_name>
        <docblock line="542">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="573" package="phpLDAPadmin\Export">
        <name>export</name>
        <full_name>\ExportVCARD::export()</full_name>
        <docblock line="573">
          <description>Export entries to VCARD format</description>
          <long-description></long-description>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/lib/SambaPasswordAttribute.php" generated-path="templates.3rdParty.pla.lib.SambaPasswordAttribute.html" hash="0735f025617457725ac03ae50ba8b460" package="phpLDAPadmin">
    <docblock line="0">
      <description>Classes and functions for the template engine.</description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="15" package="phpLDAPadmin\Templates">
      <extends>\PasswordAttribute</extends>
      <name>SambaPasswordAttribute</name>
      <full_name>\SambaPasswordAttribute</full_name>
      <docblock line="15">
        <description>Represents an attribute whose values are SAMBA passwords</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="15"/>
        <tag name="subpackage" description="Templates" line="15"/>
      </docblock>
    </class>
    <source>eJx1j0sOAUEQhvd9ilrPggsIBksSwQVqpouZmH6kqxqJuLsaMRIR6//1/ZNZbKIZF4WBApYdMhMDegvH7Gtpg2c4hgTSEAi52KEQkD+1nkaa6ENzzNKo5aAW7Vqvyi1a13qwdKEuREdeNIvuZY5Yn/H07VRhbAaGHcVErJkeA1AktVXW0WsTmOCCXe4BE8G+3CxKiEp8DcnyQPNnAOacq0E7vJ/wa7nuX8MeXYXbd1v5maWbkLcMv8rdPMxsap4BpWsH</source>
  </file>
  <file path="templates/3rdParty/pla/lib/HTMLTree.php" generated-path="templates.3rdParty.pla.lib.HTMLTree.html" hash="1e6911b1ccddcbb8c316364bf770a6c4" package="phpLDAPadmin">
    <docblock line="0">
      <description>Classes and functions for the LDAP tree.</description>
      <long-description></long-description>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <class final="false" abstract="false" namespace="" line="16" package="phpLDAPadmin\Tree">
      <extends>\Tree</extends>
      <name>HTMLTree</name>
      <full_name>\HTMLTree</full_name>
      <docblock line="16">
        <description>This class implements a straight HTML tree - no AJAX rendering is used.</description>
        <long-description></long-description>
        <tag name="package" description="phpLDAPadmin" line="16"/>
        <tag name="subpackage" description="Tree" line="16"/>
        <tag name="see" description="Tree" line="16"/>
      </docblock>
      <property static="false" visibility="protected" line="17" namespace="" package="phpLDAPadmin\Tree">
        <name>$javascript</name>
        <default>''</default>
        <docblock line="17">
          <description></description>
          <long-description></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="27" package="phpLDAPadmin\Tree">
        <name>draw</name>
        <full_name>\HTMLTree::draw()</full_name>
        <docblock line="27">
          <description>Displays the tree in HTML</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Only display the tree, or include the server name and menu items&lt;/p&gt;" line="27" type="boolean" variable="">
            <type>boolean</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$onlytree</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="158" package="phpLDAPadmin\Tree">
        <name>draw_server_name</name>
        <full_name>\HTMLTree::draw_server_name()</full_name>
        <docblock line="158">
          <description>Draw the server name</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="181" package="phpLDAPadmin\Tree">
        <name>draw_menu</name>
        <full_name>\HTMLTree::draw_menu()</full_name>
        <docblock line="181">
          <description>Draw the tree menu options</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="207" package="phpLDAPadmin\Tree">
        <name>get_menu_item</name>
        <full_name>\HTMLTree::get_menu_item()</full_name>
        <docblock line="207">
          <description>Get the HTML for each tree menu option</description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$item</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="325" package="phpLDAPadmin\Tree">
        <name>get_logout_menu_item</name>
        <full_name>\HTMLTree::get_logout_menu_item()</full_name>
        <docblock line="325">
          <description></description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="342" package="phpLDAPadmin\Tree">
        <name>draw_logged_in_user</name>
        <full_name>\HTMLTree::draw_logged_in_user()</full_name>
        <docblock line="342">
          <description>Draw the Logged in User</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="401" package="phpLDAPadmin\Tree">
        <name>draw_item</name>
        <full_name>\HTMLTree::draw_item()</full_name>
        <docblock line="401">
          <description>Recursively descend on the given dn and draw the tree in html</description>
          <long-description></long-description>
          <tag name="param" description="&lt;p&gt;Current dn.&lt;/p&gt;" line="401" type="\dn" variable="$dn">
            <type>\dn</type>
          </tag>
          <tag name="param" description="&lt;p&gt;Level to start drawing (start to -1)&lt;/p&gt;&#10;" line="401" type="int" variable="$level">
            <type>int</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$item</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$level</name>
          <default></default>
          <type>int</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="478" package="phpLDAPadmin\Tree">
        <name>get_formatted_dn</name>
        <full_name>\HTMLTree::get_formatted_dn()</full_name>
        <docblock line="478">
          <description></description>
          <long-description></long-description>
        </docblock>
        <argument line="0">
          <name>$entry</name>
          <default></default>
          <type/>
        </argument>
        <argument line="0">
          <name>$level</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="495" package="phpLDAPadmin\Tree">
        <name>draw_create_link</name>
        <full_name>\HTMLTree::draw_create_link()</full_name>
        <docblock line="495">
          <description>Print the HTML to show the "create new entry here".</description>
          <long-description></long-description>
          <tag name="param" description="" line="495" type="\dn" variable="$rdn">
            <type>\dn</type>
          </tag>
          <tag name="param" description="" line="495" type="int" variable="$level">
            <type>int</type>
          </tag>
          <tag name="param" description="" line="495" type="\dn" variable="$encoded_dn">
            <type>\dn</type>
          </tag>
        </docblock>
        <argument line="0">
          <name>$rdn</name>
          <default></default>
          <type>\dn</type>
        </argument>
        <argument line="0">
          <name>$level</name>
          <default></default>
          <type>int</type>
        </argument>
        <argument line="0">
          <name>$encoded_dn</name>
          <default></default>
          <type>\dn</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="513" package="phpLDAPadmin\Tree">
        <name>draw_login_link</name>
        <full_name>\HTMLTree::draw_login_link()</full_name>
        <docblock line="513">
          <description>Draw login link</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="" line="542" package="phpLDAPadmin\Tree">
        <name>draw_javascript</name>
        <full_name>\HTMLTree::draw_javascript()</full_name>
        <docblock line="542">
          <description>If there is javascript, draw it</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="" line="557" package="phpLDAPadmin\Tree">
        <name>getDepth</name>
        <full_name>\HTMLTree::getDepth()</full_name>
        <docblock line="557">
          <description>Work out how deep the "opened" tree is.</description>
          <long-description></long-description>
        </docblock>
      </method>
    </class>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/tools/unserialize.php" generated-path="templates.3rdParty.pla.tools.unserialize.html" hash="ae481967b63baf14a849a4a471cb36b7" package="main">
    <docblock line="0">
      <description></description>
      <long-description></long-description>
    </docblock>
    <parse_markers>
      <error line="0" code="PPC:ERR-50000">No summary was found for this file</error>
    </parse_markers>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/config/config.php" generated-path="templates.3rdParty.pla.config.config.html" hash="8de431d8d6880ec3444e2e2926e0881f" package="main">
    <docblock line="0">
      <description></description>
      <long-description></long-description>
    </docblock>
    <parse_markers>
      <error line="0" code="PPC:ERR-50000">No summary was found for this file</error>
    </parse_markers>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/update.php" generated-path="templates.3rdParty.pla.htdocs.update.html" hash="357db7a91bf4592910602eacefbc307c" package="phpLDAPadmin">
    <docblock line="0">
      <description>Updates or deletes a value from a specified attribute for a specified dn.</description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
      <tag name="see" description="" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/query_engine.php" generated-path="templates.3rdParty.pla.htdocs.query_engine.html" hash="0047d74c76b1f5cc7bc9d7e44aa40c18" package="phpLDAPadmin">
    <docblock line="0">
      <description>Query render engine.</description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
    </docblock>
    <source>eJxtj81uwjAQhO9+ij0gOYlC8gC0oUVwiMQBUnpCCLnOkkQktvEPLW9fJ6RISL1Yq/lmPbMvc1UrkkYRgQi2DvUNNIoSNaCoGoGJ13v0phg/swrB29fL9w0ru0YMwLivP7bxz6AxZ2upYVc/+6HEK7ZSdSgsWGSdN6dkTPeDxotrNAJNUi67TorEb9PZQ1/ni2VeJPTS9zyenOC2kcKMLjLpfWgsvALTmt2CcPbQ9lT5cvTgmcDv+6XFcGgwYUrtqUF9RU0P06xCm3vwE4SxH4/jB8E9lca0WG0/Vx87Gp9YazAWrm3Df5KmGeMcle1bzDPyC+CfdDk=</source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/modify_member_form.php" generated-path="templates.3rdParty.pla.htdocs.modify_member_form.html" hash="c63bbd31d1022a4ae5181c5dbb4fd9e5" package="phpLDAPadmin">
    <docblock line="0">
      <description>Displays a form to allow the user to modify group members.</description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/compare.php" generated-path="templates.3rdParty.pla.htdocs.compare.html" hash="35f1f1001df5fb5b4db110dcf6c1095d" package="phpLDAPadmin">
    <docblock line="0">
      <description>Compares two DN entries side by side.</description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/add_value_form.php" generated-path="templates.3rdParty.pla.htdocs.add_value_form.html" hash="b9f406d331905ad0e6eb72aeb9e8e28f" package="phpLDAPadmin">
    <docblock line="0">
      <description>Displays a form to allow the user to enter a new value to add
to the existing list of values for a multi-valued attribute.</description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/compare_form.php" generated-path="templates.3rdParty.pla.htdocs.compare_form.html" hash="c7405f87250793cac8ba1cff6dcab78a" package="phpLDAPadmin">
    <docblock line="0">
      <description>Compares two DN entries side by side.</description>
      <long-description>This is the entry form to determine which DN to compare this DN with.</long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/password_checker.php" generated-path="templates.3rdParty.pla.htdocs.password_checker.html" hash="5fbabeda6f79189c68a5af000006810d" package="phpLDAPadmin">
    <docblock line="0">
      <description>Check the password used by an entry.</description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/add_oclass_form.php" generated-path="templates.3rdParty.pla.htdocs.add_oclass_form.html" hash="96bac18dd103565fac566d5b7a7fbb41" package="phpLDAPadmin">
    <docblock line="0">
      <description>This page will allow the adding of additional ObjectClasses to an item.</description>
      <long-description>+ If the ObjectClass to be added requires additional MUST attributes to be
  defined, then they will be prompted for.
+ If the ObjectClass doesnt need any additional MUST attributes, then it
  will be silently added to the object.</long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/mass_update.php" generated-path="templates.3rdParty.pla.htdocs.mass_update.html" hash="c25e3b20b5b71edfe7596ae398f63f4d" package="phpLDAPadmin">
    <docblock line="0">
      <description>Main command page for phpLDAPadmin
This script will handle bulk updates.</description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/template_engine.php" generated-path="templates.3rdParty.pla.htdocs.template_engine.html" hash="bf60566a1f495dda47012f15ca0701d8" package="phpLDAPadmin">
    <docblock line="0">
      <description>Template render engine.</description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
      <tag name="author" description="The phpLDAPadmin development team" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/update_confirm.php" generated-path="templates.3rdParty.pla.htdocs.update_confirm.html" hash="425a7034b99d3d9468a5128cf2207b2f" package="phpLDAPadmin">
    <docblock line="0">
      <description>Takes the results of clicking "Save" in template_engine.php and determines
which attributes need to be updated (ie, which ones actually changed). Then,
we present a confirmation table to the user outlining the changes they are
about to make. That form submits directly to update.php, which makes the
change.</description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
      <tag name="see" description="" line="0"/>
    </docblock>
    <function namespace="" line="220" package="phpLDAPadmin">
      <name>getMustAttrs</name>
      <full_name>\getMustAttrs()</full_name>
      <docblock line="220">
        <description></description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$oclasses</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/create.php" generated-path="templates.3rdParty.pla.htdocs.create.html" hash="3f09fab8fd29af156e8b54cbc61693ba" package="phpLDAPadmin">
    <docblock line="0">
      <description>Creates a new object in LDAP.</description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/copy_form.php" generated-path="templates.3rdParty.pla.htdocs.copy_form.html" hash="516e024aa7bba639915f5f34eab459cf" package="phpLDAPadmin">
    <docblock line="0">
      <description>Copies a given object to create a new one.</description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/delete_attr.php" generated-path="templates.3rdParty.pla.htdocs.delete_attr.html" hash="2659d8763ae91d4a7768f086974495b6" package="phpLDAPadmin">
    <docblock line="0">
      <description>Deletes an attribute from an entry with NO confirmation.</description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/refresh.php" generated-path="templates.3rdParty.pla.htdocs.refresh.html" hash="1c9d63ae488928bd537bef8eeb3d5658" package="phpLDAPadmin">
    <docblock line="0">
      <description>This script deletes the session variable 'tree', which will result in re-querying
the LDAP server to grab the contents of all LDAP entries starting from the base.</description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/download_binary_attr.php" generated-path="templates.3rdParty.pla.htdocs.download_binary_attr.html" hash="3f8fe2d183c5629088a4b4d7ba864a89" package="phpLDAPadmin">
    <docblock line="0">
      <description>Download a binary value attribute to the user.</description>
      <long-description>A server ID, DN and Attribute must be provided in the GET attributes.
Optionally an index, type and filename can be supplied.</long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/view_jpeg_photo.php" generated-path="templates.3rdParty.pla.htdocs.view_jpeg_photo.html" hash="e7f0ae84ef4f9cb2a2776cb2a7b9e14d" package="phpLDAPadmin">
    <docblock line="0">
      <description>This script will display the contents of the jpegPhoto attribute to the browser.</description>
      <long-description>A server ID and DN must be provided in the GET attributes.
Optionally an attr name, index, type and filename can be supplied.</long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/import.php" generated-path="templates.3rdParty.pla.htdocs.import.html" hash="4716a8729a9585fe33dbff9095e50606" package="phpLDAPadmin">
    <docblock line="0">
      <description>Imports an LDIF file to the specified LDAP server.</description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
    </docblock>
    <function namespace="" line="90" package="phpLDAPadmin">
      <name>display_pla_parse_error</name>
      <full_name>\display_pla_parse_error()</full_name>
      <docblock line="90">
        <description></description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$request</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/copy.php" generated-path="templates.3rdParty.pla.htdocs.copy.html" hash="130482c0be9dfe78168edec0a8eedee7" package="phpLDAPadmin">
    <docblock line="0">
      <description>Copies a given object to create a new one.</description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
    </docblock>
    <function namespace="" line="114" package="phpLDAPadmin">
      <name>r_copy_dn</name>
      <full_name>\r_copy_dn()</full_name>
      <docblock line="114">
        <description></description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$serverSRC</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$serverDST</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$snapshottree</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$dnSRC</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$dnDST</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$remove</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="161" package="phpLDAPadmin">
      <name>copy_dn</name>
      <full_name>\copy_dn()</full_name>
      <docblock line="161">
        <description></description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$serverSRC</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$serverDST</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$dnSRC</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$dnDST</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$remove</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <function namespace="" line="185" package="phpLDAPadmin">
      <name>build_tree</name>
      <full_name>\build_tree()</full_name>
      <docblock line="185">
        <description></description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$server</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$dn</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$buildtree</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/add_attr_form.php" generated-path="templates.3rdParty.pla.htdocs.add_attr_form.html" hash="85f1a2e7247d0389dbf7c22f085cdd4f" package="phpLDAPadmin">
    <docblock line="0">
      <description>Displays a form for adding an attribute/value to an LDAP entry.</description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/delete_form.php" generated-path="templates.3rdParty.pla.htdocs.delete_form.html" hash="a75b795da1ceeb0c4477bfa8bdf6a97e" package="phpLDAPadmin">
    <docblock line="0">
      <description>Displays a last chance confirmation form to delete a DN.</description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/index.php" generated-path="templates.3rdParty.pla.htdocs.index.html" hash="db1c0be01c73858ab1ee8971d215ad29" package="phpLDAPadmin">
    <docblock line="0">
      <description>phpLDAPadmin Start Page</description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
    </docblock>
    <constant namespace="" line="27" package="phpLDAPadmin">
      <name>APPCONFIG</name>
      <full_name>\\APPCONFIG</full_name>
      <value>'plaConfig'</value>
      <docblock line="27">
        <description>We will perform some sanity checking here, since this file is normally loaded first when users
first access the application.</description>
        <long-description></long-description>
      </docblock>
    </constant>
    <constant namespace="" line="29" package="phpLDAPadmin">
      <name>LIBDIR</name>
      <full_name>\\LIBDIR</full_name>
      <value>sprintf('%s/', realpath('../lib/'))</value>
      <docblock line="29">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/rename_form.php" generated-path="templates.3rdParty.pla.htdocs.rename_form.html" hash="6609319f4854ddcc59e9f08a5faf30f4" package="phpLDAPadmin">
    <docblock line="0">
      <description>Displays a form for renaming an LDAP entry.</description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/import_form.php" generated-path="templates.3rdParty.pla.htdocs.import_form.html" hash="7f75b714f9df8487a2c3c5e093f4ea7e" package="phpLDAPadmin">
    <docblock line="0">
      <description>Displays a form to allow the user to upload and import
an LDIF file.</description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/mass_edit.php" generated-path="templates.3rdParty.pla.htdocs.mass_edit.html" hash="e804b28833604ad9dc9de48f5a4f60a1" package="phpLDAPadmin">
    <docblock line="0">
      <description>Main command page for phpLDAPadmin
Enable mass editing of Attribute values from a list of DNs.</description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/collapse.php" generated-path="templates.3rdParty.pla.htdocs.collapse.html" hash="6d89804b3af8427c333c8799999a22a5" package="phpLDAPadmin">
    <docblock line="0">
      <description>This script alters the session variable 'tree', collapsing it
at the dn specified in the query string.</description>
      <long-description>Note: this script is equal and opposite to expand.php</long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Tree" line="0"/>
      <tag name="see" description="" line="0"/>
    </docblock>
    <source>eJyVUcFOIzEMPZOvsEQh02po70DbXQmEkBDi0BtCVUhMJ0smCbEHsX+/zpQF7aXSnpI8P7/n51yuc5fVYjZTMINN5wnIFp8ZTGAsBNwhEBL5FOHdFG+eA4LmgqhbsCkEk8nHHXiuAobHBheBMlr/4tGBjyP2NmD5DcRF2HPhVvp9YjyX6rer3PBtMAFMdJByTuQZgRPgRxZoXofd9/7Ixr6aHYJAd1c/H4zrfRwLNDz/rW1kzj2G+K/EQn2GlksRS18k1nxhU9+nWDn6QqmJBFnCDnlbKUjcaBd1q2+uN7rlMuD0Qk3qLj5Z1tgO3VZG7puJyflRE5Z3LPrpbCX12+jwo5m2+/XVXowsS1nCKDJyrivSiPFX+WxlQyJsBKD/9Wh1HELQ7agvAqpD47A0lOUb+KXRd8kalr8997Wv5l7v5bbeLU/o9NcQX+U8PiHdqqMDfkVWm/pt5cur4z54d2i+mnAqEzk/Jluv1B8eKtNc</source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/expand.php" generated-path="templates.3rdParty.pla.htdocs.expand.html" hash="4e10c86f6e650a6ee2aab334982d44d5" package="phpLDAPadmin">
    <docblock line="0">
      <description>This script alters the session variable 'tree', expanding it
at the dn specified in the query string.</description>
      <long-description>Note: this script is equal and opposite to collapse.php</long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Tree" line="0"/>
      <tag name="see" description="" line="0"/>
    </docblock>
    <source>eJyVUU1PwzAMPZNfYYmNdFPZ7oxtIDEhJIQ47IbQlDVmDbRJiF0E/x6n40PiMIlTHPv5PT/7fBnrqKbjsYIxrGtHQFVykcE0jImAawRCIhc8vJnkzLZB0JwQdQn4Ho23zu/Ace433OOtB4pYuSeHFpzvc68dpg8gToKeCDbD7wLjmVR/RSXC1840ILQQYgzkGIEDVKFpTCSc5Gn33RfRVC9mhyCp26vLe2Nb5/sCddvv2loG3ecQ/5JM1ZdvCZLIuiTOJtMqtG3wGaNnSg3EzBx2yJsMQeJCW69Lfb1a65JTh6OZGuR1fKEqU9VoNzJ2WwxMjA+aML1h0o+nC6nfeIvvxajcbzD3omdZzBx6kh6zyplChH/Kp4sQ0Rfyp/9KlNp3TaPLnl4IVI3GYiooyiX4qdC3oTIs1z1zuS/bXu7pNs7Oh3Ty3PkXeY+HpEt1dEAvyc1Cu8l4+dXcNs4emi8bHMlE1mF2tlyoTxzs1DA=</source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/draw_tree_node.php" generated-path="templates.3rdParty.pla.htdocs.draw_tree_node.html" hash="731378883d18512a580a000efd9a5c8c" package="phpLDAPadmin">
    <docblock line="0">
      <description>Draw a portion of the LDAP tree.</description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Tree" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/delete.php" generated-path="templates.3rdParty.pla.htdocs.delete.html" hash="05527288c70ada0385d3fcb3bf8c9e3b" package="phpLDAPadmin">
    <docblock line="0">
      <description>Deletes a DN and presents a "job's done" message.</description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/create_confirm.php" generated-path="templates.3rdParty.pla.htdocs.create_confirm.html" hash="b639676d0255d5ce5bd895bd3d9fb846" package="phpLDAPadmin">
    <docblock line="0">
      <description>Creates a new object in LDAP.</description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/export.php" generated-path="templates.3rdParty.pla.htdocs.export.html" hash="2e08bd9cd5e680d9c92ba5c330208c2e" package="phpLDAPadmin">
    <docblock line="0">
      <description>Performs the export of data from the LDAP server</description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/rename.php" generated-path="templates.3rdParty.pla.htdocs.rename.html" hash="d3e90d686fb6716df4d2d2004a9f7536" package="phpLDAPadmin">
    <docblock line="0">
      <description>Renames a DN to a different name.</description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/rdelete.php" generated-path="templates.3rdParty.pla.htdocs.rdelete.html" hash="2aee61706df461e3c27efdeae4ab10d8" package="phpLDAPadmin">
    <docblock line="0">
      <description>Recursively deletes the specified DN and all of its children</description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
    </docblock>
    <function namespace="" line="53" package="phpLDAPadmin">
      <name>pla_rdelete</name>
      <full_name>\pla_rdelete()</full_name>
      <docblock line="53">
        <description></description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$server</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$dn</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/mass_delete.php" generated-path="templates.3rdParty.pla.htdocs.mass_delete.html" hash="57f282c0c701ce9319c478384195c866" package="phpLDAPadmin">
    <docblock line="0">
      <description>Displays a last chance confirmation form to delete a DN.</description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/common.php" generated-path="templates.3rdParty.pla.htdocs.common.html" hash="140600bee54b9752789280da6a0d75d2" package="phpLDAPadmin">
    <docblock line="0">
      <description>This script provides a convienent method to call the proper common.php</description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <constant namespace="" line="12" package="phpLDAPadmin">
      <name>LIBDIR</name>
      <full_name>\\LIBDIR</full_name>
      <value>sprintf('%s/', realpath('../lib/'))</value>
      <docblock line="12">
        <description></description>
        <long-description></long-description>
      </docblock>
    </constant>
    <source>eJxFjsFOwzAQRM/4K5ZD5SSq7A8IogX1UqmHquodGXtTr0jsxTb5/joNgtto5s3svuzYs9BdJ6CDq6cM2SbiApziTA4zGLAxzIQBQ4EJi48OSgRrxhGKxwVkTBWaphjUsgaPsT0b+2VuFfB8OrydjZso1ECL33NV0ADNMzgcKKBr5On4fjheZNuKp9X7s7aZE4UyNHKTtdwmNCOb4huplB7pU9dO24uE3z+U8CMGi7A2lfx/TPZi9yru2xRJpw==</source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/entry_chooser.php" generated-path="templates.3rdParty.pla.htdocs.entry_chooser.html" hash="8b439c4f474240599cd1d4727418d8e7" package="phpLDAPadmin">
    <docblock line="0">
      <description>Display a selection (popup window) to pick a DN.</description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/export_form.php" generated-path="templates.3rdParty.pla.htdocs.export_form.html" hash="95eb226630f0d6d909ad4356be9a1750" package="phpLDAPadmin">
    <docblock line="0">
      <description>Export entries from the LDAP server.</description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
    </docblock>
    <function namespace="" line="147" package="phpLDAPadmin">
      <name>get_line_end_format</name>
      <full_name>\get_line_end_format()</full_name>
      <docblock line="147">
        <description>Helper function for fetching the line end format.</description>
        <long-description></long-description>
        <tag name="return" description="&amp;#039;win&amp;#039;, &amp;#039;unix&amp;#039;, or &amp;#039;mac&amp;#039; based on the user&amp;#039;s browser.." line="147" type="String">
          <type>String</type>
        </tag>
      </docblock>
    </function>
    <function namespace="" line="164" package="phpLDAPadmin">
      <name>get_user_agent_string</name>
      <full_name>\get_user_agent_string()</full_name>
      <docblock line="164">
        <description>Gets the USER_AGENT string from the $_SERVER array, all in lower case in
an E_NOTICE safe manner.</description>
        <long-description></long-description>
        <tag name="return" description="The user agent string as reported by the browser." line="164" type="string|false">
          <type>string</type>
          <type>false</type>
        </tag>
      </docblock>
    </function>
    <function namespace="" line="174" package="phpLDAPadmin">
      <name>is_browser</name>
      <full_name>\is_browser()</full_name>
      <docblock line="174">
        <description>Determine the OS for the browser</description>
        <long-description></long-description>
      </docblock>
      <argument line="0">
        <name>$type</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/htdocs/cmd.php" generated-path="templates.3rdParty.pla.htdocs.cmd.html" hash="c772b7766aff5ae15917d6cf86905260" package="phpLDAPadmin">
    <docblock line="0">
      <description>Main command page for phpLDAPadmin
All pages are rendered through this script.</description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
      <tag name="subpackage" description="Page" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/3rdParty/pla/index.php" generated-path="templates.3rdParty.pla.index.html" hash="fe7bf1aae970c994bd71a162020f3761" package="phpLDAPadmin">
    <docblock line="0">
      <description></description>
      <long-description></long-description>
      <tag name="package" description="phpLDAPadmin" line="0"/>
    </docblock>
    <parse_markers>
      <error line="0" code="PPC:ERR-50000">No summary was found for this file</error>
    </parse_markers>
    <source>eJw1jb0KwjAURvf7FBcstHZodhVrwcEhQ1fHmFya0Da35Afs2xsUp++Dc+Bc+s1uIARWD1KGQgUg2hawxdum9KwmwiLI+zAqszpfgAA44JMzRst5MRhJ50C4cw44ygFfO65qdn7CZAltMqyj+OFyA3PqwH5bTS1Zq+TYn/6e84beXSnWxzMYR02Z/gofik40WA==</source>
  </file>
  <file path="templates/logout.php" generated-path="templates.logout.html" hash="d8e24f95164494e4cc880f9fc511544a" package="main">
    <docblock line="0">
      <description>User is logged off from LDAP server, session is destroyed.</description>
      <long-description></long-description>
      <tag name="package" description="main" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/initsuff.php" generated-path="templates.initsuff.html" hash="177999e54375ea8fa5b2f0b9d7c64223" package="main">
    <docblock line="0">
      <description>Creates main suffixes if they are missing.</description>
      <long-description></long-description>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="package" description="main" line="0"/>
    </docblock>
    <source> </source>
  </file>
  <file path="templates/massBuildAccounts.php" generated-path="templates.massBuildAccounts.html" hash="f5b31c22a7044d1207f99a790737277b" package="tools">
    <docblock line="0">
      <description>Creates the accounts by parsing the uploaded file.</description>
      <long-description></long-description>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="package" description="tools" line="0"/>
    </docblock>
    <function namespace="" line="275" package="tools">
      <name>massPrintBackButton</name>
      <full_name>\massPrintBackButton()</full_name>
      <docblock line="275">
        <description>Prints a back button to the page where the user enters a file to upload.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;account type (e.g. user)&lt;/p&gt;&#10;" line="275" type="String" variable="$scope">
          <type>String</type>
        </tag>
        <tag name="param" description="&lt;p&gt;selected modules for upload&lt;/p&gt;" line="275" type="array" variable="$selectedModules">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;table container&lt;/p&gt;" line="275" type="\htmlTable" variable="$container">
          <type>\htmlTable</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$scope</name>
        <default></default>
        <type>String</type>
      </argument>
      <argument line="0">
        <name>$selectedModules</name>
        <default></default>
        <type>array</type>
      </argument>
      <argument line="0">
        <name>$container</name>
        <default></default>
        <type>\htmlTable</type>
      </argument>
    </function>
    <source> </source>
  </file>
  <file path="templates/help.php" generated-path="templates.help.html" hash="74725a1cbb0d25028e4ea462a10ceb4a" package="Help">
    <docblock line="0">
      <description>LDAP Account Manager help page.</description>
      <long-description></long-description>
      <tag name="author" description="Michael Duergner" line="0"/>
      <tag name="author" description="Roland Gruber" line="0"/>
      <tag name="package" description="Help" line="0"/>
    </docblock>
    <function namespace="" line="58" package="Help">
      <name>echoHTMLHead</name>
      <full_name>\echoHTMLHead()</full_name>
      <docblock line="58">
        <description>Print HTML header of the help page.</description>
        <long-description></long-description>
      </docblock>
    </function>
    <function namespace="" line="71" package="Help">
      <name>echoHTMLFoot</name>
      <full_name>\echoHTMLFoot()</full_name>
      <docblock line="71">
        <description>Print HTML footer of the help page.</description>
        <long-description></long-description>
      </docblock>
    </function>
    <function namespace="" line="84" package="Help">
      <name>displayHelp</name>
      <full_name>\displayHelp()</full_name>
      <docblock line="84">
        <description>Print help site for a specific help number.</description>
        <long-description></long-description>
        <tag name="param" description="&lt;p&gt;The help entry that is to be displayed.&lt;/p&gt;" line="84" type="array" variable="">
          <type>array</type>
        </tag>
        <tag name="param" description="&lt;p&gt;The help variables that are used to replace the spacer in the help text.&lt;/p&gt;" line="84" type="array" variable="">
          <type>array</type>
        </tag>
      </docblock>
      <argument line="0">
        <name>$helpEntry</name>
        <default></default>
        <type/>
      </argument>
      <argument line="0">
        <name>$helpVariables</name>
        <default></default>
        <type/>
      </argument>
    </function>
    <source> </source>
  </file>
  <package name="Crypt_AES" full_name="Crypt_AES"/>
  <package name="Crypt_DES" full_name="Crypt_DES"/>
  <package name="Crypt_Hash" full_name="Crypt_Hash"/>
  <package name="Crypt_RC4" full_name="Crypt_RC4"/>
  <package name="Crypt_RSA" full_name="Crypt_RSA"/>
  <package name="Crypt_Random" full_name="Crypt_Random"/>
  <package name="Crypt_Rijndael" full_name="Crypt_Rijndael"/>
  <package name="Crypt_TerraDES" full_name="Crypt_TerraDES"/>
  <package name="Crypt_TripleDES" full_name="Crypt_TripleDES"/>
  <package name="Help" full_name="Help"/>
  <package name="LDAP" full_name="LDAP"/>
  <package name="Math_BigInteger" full_name="Math_BigInteger"/>
  <package name="Net_SFTP" full_name="Net_SFTP"/>
  <package name="Net_SSH1" full_name="Net_SSH1"/>
  <package name="Net_SSH2" full_name="Net_SSH2"/>
  <package name="PDF" full_name="PDF"/>
  <package name="PHP_Compat" full_name="PHP_Compat"/>
  <package name="configuration" full_name="configuration"/>
  <package name="horde.cipher" full_name="horde.cipher"/>
  <package name="lam" full_name="lam"/>
  <package name="lib" full_name="lib"/>
  <package name="lists" full_name="lists"/>
  <package name="main" full_name="main"/>
  <package name="metaHTML" full_name="metaHTML"/>
  <package name="modules" full_name="modules"/>
  <package name="phpLDAPadmin" full_name="phpLDAPadmin">
    <package name="DataStore" full_name="phpLDAPadmin\DataStore"/>
    <package name="Export" full_name="phpLDAPadmin\Export"/>
    <package name="Import" full_name="phpLDAPadmin\Import"/>
    <package name="Page" full_name="phpLDAPadmin\Page"/>
    <package name="Queries" full_name="phpLDAPadmin\Queries"/>
    <package name="Schema" full_name="phpLDAPadmin\Schema"/>
    <package name="Templates" full_name="phpLDAPadmin\Templates"/>
    <package name="Tree" full_name="phpLDAPadmin\Tree"/>
    <package name="XML" full_name="phpLDAPadmin\XML"/>
  </package>
  <package name="profiles" full_name="profiles"/>
  <package name="selfService" full_name="selfService"/>
  <package name="tools" full_name="tools"/>
  <package name="types" full_name="types"/>
  <namespace name="global" full_name="global"/>
  <deprecated count="0"/>
</project>
