<?xml version="1.0" encoding="utf-8"?>
<project version="2.0.0a10" title="LDAP Account Manager">
  <file path="lib/font/verabi.php" hash="558fc8dd3966e4c99c6a5ab6ac7c50ec" package="PDF">
    <docblock line="24">
      <description><![CDATA[This file includes information about the Bitstream Vera font.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="package" description="PDF"/>
      <tag line="24" name="author" description="Roland Gruber"/>
    </docblock>
  </file>
  <file path="lib/font/vera.php" hash="6673d5b56ca86e2ae069d2da679a6386" package="PDF">
    <docblock line="24">
      <description><![CDATA[This file includes information about the Bitstream Vera font.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="package" description="PDF"/>
      <tag line="24" name="author" description="Roland Gruber"/>
    </docblock>
  </file>
  <file path="lib/font/verab.php" hash="e508250890555c3f6b95882195c66c5b" package="PDF">
    <docblock line="24">
      <description><![CDATA[This file includes information about the Bitstream Vera font.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="package" description="PDF"/>
      <tag line="24" name="author" description="Roland Gruber"/>
    </docblock>
  </file>
  <file path="lib/font/verai.php" hash="13a25d06a4dc03a58ca3e738ff6a7333" package="PDF">
    <docblock line="24">
      <description><![CDATA[This file includes information about the Bitstream Vera font.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="package" description="PDF"/>
      <tag line="24" name="author" description="Roland Gruber"/>
    </docblock>
  </file>
  <file path="lib/profiles.inc" hash="c07df3c81f339b8bd01cbe88278bae6b" package="profiles">
    <docblock line="24">
      <description><![CDATA[This file provides functions to load and save account profiles.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="package" description="profiles"/>
      <tag line="24" name="author" description="Roland Gruber"/>
    </docblock>
    <function namespace="global" line="39" package="profiles">
      <name>getAccountProfiles</name>
      <full_name>\getAccountProfiles</full_name>
      <docblock line="32">
        <description><![CDATA[Returns an array of string with all available profiles for the given account type]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="32" name="param" description="account type" type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="32" name="param" description="server profile name" type="string" variable="$profile">
          <type by_reference="false">string</type>
        </tag>
        <tag line="32" name="return" description="profile names" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="39">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="39">
        <name>$profile</name>
        <default><![CDATA[null]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="73" package="profiles">
      <name>loadAccountProfile</name>
      <full_name>\loadAccountProfile</full_name>
      <docblock line="66">
        <description><![CDATA[Loads an profile of the given account type]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="66" name="param" description="name of the profile (without .&lt;scope&gt; extension)" type="string" variable="$profile">
          <type by_reference="false">string</type>
        </tag>
        <tag line="66" name="param" description="account type" type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="66" name="return" description="hash array (attribute =&gt; value)" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="73">
        <name>$profile</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="73">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="117" package="profiles">
      <name>saveAccountProfile</name>
      <full_name>\saveAccountProfile</full_name>
      <docblock line="107">
        <description><![CDATA[Saves an hash array (attribute => value) to an account profile]]></description>
        <long-description><![CDATA[<p>file is created, if needed</p>]]></long-description>
        <tag line="107" name="param" description="hash array (attribute =&gt; value)" type="array" variable="$attributes">
          <type by_reference="false">array</type>
        </tag>
        <tag line="107" name="param" description="name of the account profile (without .&lt;scope&gt; extension)" type="string" variable="$profile">
          <type by_reference="false">string</type>
        </tag>
        <tag line="107" name="param" description="account type" type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="107" name="return" description="true, if saving succeeded" type="boolean">
          <type by_reference="false">boolean</type>
        </tag>
      </docblock>
      <argument line="117">
        <name>$attributes</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="117">
        <name>$profile</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="117">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="154" package="profiles">
      <name>delAccountProfile</name>
      <full_name>\delAccountProfile</full_name>
      <docblock line="147">
        <description><![CDATA[Deletes an account profile]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="147" name="param" description="name of profile (Without .&lt;scope&gt; extension)" type="string" variable="$file">
          <type by_reference="false">string</type>
        </tag>
        <tag line="147" name="param" description="account type" type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="147" name="return" description="true if profile was deleted" type="boolean">
          <type by_reference="false">boolean</type>
        </tag>
      </docblock>
      <argument line="154">
        <name>$file</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="154">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="174" package="profiles">
      <name>copyAccountProfiles</name>
      <full_name>\copyAccountProfiles</full_name>
      <docblock line="165">
        <description><![CDATA[Copies account profiles to other server profiles.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="165" name="param" description="account profile names" type="array" variable="$accountProfiles">
          <type by_reference="false">array</type>
        </tag>
        <tag line="165" name="param" description="account scope" type="String" variable="$scope">
          <type by_reference="false">String</type>
        </tag>
        <tag line="165" name="param" description="destinations" type="array" variable="$dests">
          <type by_reference="false">array</type>
        </tag>
        <tag line="165" name="return" description="operation succeeded" type="boolean">
          <type by_reference="false">boolean</type>
        </tag>
      </docblock>
      <argument line="174">
        <name>$accountProfiles</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="174">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="174">
        <name>$dests</name>
        <default><![CDATA[array()]]></default>
        <type/>
      </argument>
    </function>
  </file>
  <file path="lib/ldap.inc" hash="dc180ad7cd1df527474d339c04061446" package="LDAP">
    <docblock line="24">
      <description><![CDATA[ldap.inc provides basic functions to connect to the OpenLDAP server.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="package" description="LDAP"/>
      <tag line="24" name="author" description="Roland Gruber"/>
    </docblock>
    <include line="32" type="Include Once" package="main">
      <name>config.inc</name>
      <docblock line="31">
        <description><![CDATA[Access to configuration data]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <function namespace="global" line="40" package="LDAP">
      <name>convertHex2bin</name>
      <full_name>\convertHex2bin</full_name>
      <docblock line="34">
        <description><![CDATA[Converts a HEX string to a binary value]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="34" name="param" description="HEX string" type="string" variable="$value">
          <type by_reference="false">string</type>
        </tag>
        <tag line="34" name="return" description="result binary" type="\binary">
          <type by_reference="false">\binary</type>
        </tag>
      </docblock>
      <argument line="40">
        <name>$value</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <class final="false" abstract="false" namespace="global" line="50" package="LDAP">
      <extends/>
      <name>Ldap</name>
      <full_name>\Ldap</full_name>
      <docblock line="45">
        <description><![CDATA[Ldap manages connection to LDAP and includes several helper functions.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="45" name="package" description="LDAP"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="53" namespace="global" package="main">
        <name>$conf</name>
        <default><![CDATA[]]></default>
        <docblock line="52">
          <description><![CDATA[Object of Config to access preferences]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="56" namespace="global" package="main">
        <name>$server</name>
        <default><![CDATA[]]></default>
        <docblock line="55">
          <description><![CDATA[Server handle]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="59" namespace="global" package="main">
        <name>$is_connected</name>
        <default><![CDATA[false]]></default>
        <docblock line="58">
          <description><![CDATA[LDAP connection established]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="62" namespace="global" package="main">
        <name>$username</name>
        <default><![CDATA[]]></default>
        <docblock line="61">
          <description><![CDATA[LDAP username used for bind]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="64" namespace="global" package="main">
        <name>$password</name>
        <default><![CDATA[]]></default>
        <docblock line="63">
          <description><![CDATA[LDAP password used for bind]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="67" namespace="global" package="main">
        <name>$rand</name>
        <default><![CDATA[]]></default>
        <docblock line="66">
          <description><![CDATA[Random number (changes on every page request)]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="74" package="LDAP">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="69">
          <description><![CDATA[Creates a new LDAP object.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="69" name="param" description="an object of class Config" type="object" variable="$config">
            <type by_reference="false">object</type>
          </tag>
        </docblock>
        <argument line="74">
          <name>$config</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="91" package="LDAP">
        <name>connect</name>
        <full_name>connect</full_name>
        <docblock line="83">
          <description><![CDATA[Connects to the server using the given username and password]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="83" name="param" description="user name" type="string" variable="$user">
            <type by_reference="false">string</type>
          </tag>
          <tag line="83" name="param" description="password" type="string" variable="$passwd">
            <type by_reference="false">string</type>
          </tag>
          <tag line="83" name="param" description="specifies if anonymous binds are allowed" type="boolean" variable="$allowAnonymous">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="83" name="return" description="if connect succeeds the server handle is returned, else false" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="91">
          <name>$user</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="91">
          <name>$passwd</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="91">
          <name>$allowAnonymous</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="127" package="LDAP">
        <name>close</name>
        <full_name>close</full_name>
        <docblock line="126">
          <description><![CDATA[Closes connection to server]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="138" package="LDAP">
        <name>server</name>
        <full_name>server</full_name>
        <docblock line="133">
          <description><![CDATA[Returns the LDAP connection handle]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="133" name="return" description="connection handle" type="object">
            <type by_reference="false">object</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="148" package="LDAP">
        <name>__sleep</name>
        <full_name>__sleep</full_name>
        <docblock line="147">
          <description><![CDATA[Closes connection to LDAP server before serialization]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="155" package="LDAP">
        <name>__wakeup</name>
        <full_name>__wakeup</full_name>
        <docblock line="154">
          <description><![CDATA[Reconnects to LDAP server when deserialized]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="197" package="LDAP">
        <name>new_rand</name>
        <full_name>new_rand</full_name>
        <docblock line="192">
          <description><![CDATA[Calculates a new value for rand]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="192" name="return" description="New random value" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="global" line="212" package="LDAP">
        <name>encrypt</name>
        <full_name>encrypt</full_name>
        <docblock line="205">
          <description><![CDATA[Encrypts a string]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="205" name="param" description="string to encrypt" type="string" variable="$data">
            <type by_reference="false">string</type>
          </tag>
          <tag line="205" name="param" description="prefix for cookie names" type="string" variable="$prefix">
            <type by_reference="false">string</type>
          </tag>
          <tag line="205" name="return" description="encrypted string" type="object">
            <type by_reference="false">object</type>
          </tag>
        </docblock>
        <argument line="212">
          <name>$data</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="212">
          <name>$prefix</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="global" line="239" package="LDAP">
        <name>decrypt</name>
        <full_name>decrypt</full_name>
        <docblock line="232">
          <description><![CDATA[Decrypts a string]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="232" name="param" description="string to decrypt" type="object" variable="$data">
            <type by_reference="false">object</type>
          </tag>
          <tag line="232" name="param" description="prefix for cookie names" type="string" variable="$prefix">
            <type by_reference="false">string</type>
          </tag>
          <tag line="232" name="return" description="decrypted string" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="239">
          <name>$data</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="239">
          <name>$prefix</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="267" package="LDAP">
        <name>encrypt_login</name>
        <full_name>encrypt_login</full_name>
        <docblock line="261">
          <description><![CDATA[Encrypts username and password]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="261" name="param" description="LDAP user name" type="string" variable="$username">
            <type by_reference="false">string</type>
          </tag>
          <tag line="261" name="param" description="LDAP password" type="string" variable="$password">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="267">
          <name>$username</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="267">
          <name>$password</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="278" package="LDAP">
        <name>decrypt_login</name>
        <full_name>decrypt_login</full_name>
        <docblock line="273">
          <description><![CDATA[Decrypts username and password]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="273" name="return" description="array(user name, password)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="287" package="LDAP">
        <name>destroy</name>
        <full_name>destroy</full_name>
        <docblock line="286">
          <description><![CDATA[Closes connection to LDAP server and deletes encrypted username/password]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/tools/serverInfo.inc" hash="c193a9e0f7e76dda35aec2d2f6e4cc7b" package="tools">
    <docblock line="24">
      <description><![CDATA[This file includes the server information tool specification.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="author" description="Roland Gruber"/>
      <tag line="24" name="package" description="tools"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="36" package="tools">
      <extends/>
      <implements>\LAMTool</implements>
      <name>toolServerInformation</name>
      <full_name>\toolServerInformation</full_name>
      <docblock line="31">
        <description><![CDATA[Server information]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="31" name="package" description="tools"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="43" package="tools">
        <name>getName</name>
        <full_name>getName</full_name>
        <docblock line="38">
          <description><![CDATA[Returns the name of the tool.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="38" name="return" description="name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="52" package="tools">
        <name>getDescription</name>
        <full_name>getDescription</full_name>
        <docblock line="47">
          <description><![CDATA[returns a description text for the tool.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="47" name="return" description="description" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="61" package="tools">
        <name>getLink</name>
        <full_name>getLink</full_name>
        <docblock line="56">
          <description><![CDATA[Returns a link to the tool page (relative to templates/).]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="56" name="return" description="link" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="70" package="tools">
        <name>getRequiresWriteAccess</name>
        <full_name>getRequiresWriteAccess</full_name>
        <docblock line="65">
          <description><![CDATA[Returns if the tool requires write access to LDAP.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="65" name="return" description="true if write access is needed" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="79" package="tools">
        <name>getRequiresPasswordChangeRights</name>
        <full_name>getRequiresPasswordChangeRights</full_name>
        <docblock line="74">
          <description><![CDATA[Returns if the tool requires password change rights.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="74" name="return" description="true if password change rights are needed" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="88" package="tools">
        <name>getImageLink</name>
        <full_name>getImageLink</full_name>
        <docblock line="83">
          <description><![CDATA[Returns the link to the tool image (relative to graphics/)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="83" name="return" description="image URL" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="98" package="tools">
        <name>getPosition</name>
        <full_name>getPosition</full_name>
        <docblock line="92">
          <description><![CDATA[Returns the prefered position of this tool on the tools page.]]></description>
          <long-description><![CDATA[<p>The position may be between 0 and 1000. 0 is the top position.</p>]]></long-description>
          <tag line="92" name="return" description="prefered position" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="107" package="tools">
        <name>getSubTools</name>
        <full_name>getSubTools</full_name>
        <docblock line="102">
          <description><![CDATA[Returns a list of sub tools or an empty array.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="102" name="return" description="list of subtools (LAMTool)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="116" package="tools">
        <name>isVisible</name>
        <full_name>isVisible</full_name>
        <docblock line="111">
          <description><![CDATA[Returns if the tool is visible in the menu.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="111" name="return" description="visible" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="125" package="tools">
        <name>isHideable</name>
        <full_name>isHideable</full_name>
        <docblock line="120">
          <description><![CDATA[Returns if a tool may be hidden by configuration in the LAM server profile.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="120" name="return" description="hideable" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/tools/fileUpload.inc" hash="39bee5671778cc65e7624a78dd93564e" package="tools">
    <docblock line="24">
      <description><![CDATA[This file includes the file upload tool specification.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="author" description="Roland Gruber"/>
      <tag line="24" name="package" description="tools"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="36" package="tools">
      <extends/>
      <implements>\LAMTool</implements>
      <name>toolFileUpload</name>
      <full_name>\toolFileUpload</full_name>
      <docblock line="31">
        <description><![CDATA[File upload]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="31" name="package" description="tools"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="43" package="tools">
        <name>getName</name>
        <full_name>getName</full_name>
        <docblock line="38">
          <description><![CDATA[Returns the name of the tool.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="38" name="return" description="name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="52" package="tools">
        <name>getDescription</name>
        <full_name>getDescription</full_name>
        <docblock line="47">
          <description><![CDATA[returns a description text for the tool.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="47" name="return" description="description" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="61" package="tools">
        <name>getLink</name>
        <full_name>getLink</full_name>
        <docblock line="56">
          <description><![CDATA[Returns a link to the tool page (relative to templates/).]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="56" name="return" description="link" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="70" package="tools">
        <name>getRequiresWriteAccess</name>
        <full_name>getRequiresWriteAccess</full_name>
        <docblock line="65">
          <description><![CDATA[Returns if the tool requires write access to LDAP.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="65" name="return" description="true if write access is needed" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="79" package="tools">
        <name>getRequiresPasswordChangeRights</name>
        <full_name>getRequiresPasswordChangeRights</full_name>
        <docblock line="74">
          <description><![CDATA[Returns if the tool requires password change rights.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="74" name="return" description="true if password change rights are needed" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="88" package="tools">
        <name>getImageLink</name>
        <full_name>getImageLink</full_name>
        <docblock line="83">
          <description><![CDATA[Returns the link to the tool image (relative to graphics/)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="83" name="return" description="image URL" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="98" package="tools">
        <name>getPosition</name>
        <full_name>getPosition</full_name>
        <docblock line="92">
          <description><![CDATA[Returns the prefered position of this tool on the tools page.]]></description>
          <long-description><![CDATA[<p>The position may be between 0 and 1000. 0 is the top position.</p>]]></long-description>
          <tag line="92" name="return" description="prefered position" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="107" package="tools">
        <name>getSubTools</name>
        <full_name>getSubTools</full_name>
        <docblock line="102">
          <description><![CDATA[Returns a list of sub tools or an empty array.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="102" name="return" description="list of subtools (LAMTool)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="116" package="tools">
        <name>isVisible</name>
        <full_name>isVisible</full_name>
        <docblock line="111">
          <description><![CDATA[Returns if the tool is visible in the menu.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="111" name="return" description="visible" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="125" package="tools">
        <name>isHideable</name>
        <full_name>isHideable</full_name>
        <docblock line="120">
          <description><![CDATA[Returns if a tool may be hidden by configuration in the LAM server profile.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="120" name="return" description="hideable" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/tools/pdfEdit.inc" hash="7d78629556e4bf2b2de0e05aeb2f593a" package="tools">
    <docblock line="24">
      <description><![CDATA[This file includes the PDF editor tool specification.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="author" description="Roland Gruber"/>
      <tag line="24" name="package" description="tools"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="36" package="tools">
      <extends/>
      <implements>\LAMTool</implements>
      <name>toolPDFEditor</name>
      <full_name>\toolPDFEditor</full_name>
      <docblock line="31">
        <description><![CDATA[PDF editor]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="31" name="package" description="tools"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="43" package="tools">
        <name>getName</name>
        <full_name>getName</full_name>
        <docblock line="38">
          <description><![CDATA[Returns the name of the tool.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="38" name="return" description="name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="52" package="tools">
        <name>getDescription</name>
        <full_name>getDescription</full_name>
        <docblock line="47">
          <description><![CDATA[returns a description text for the tool.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="47" name="return" description="description" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="61" package="tools">
        <name>getLink</name>
        <full_name>getLink</full_name>
        <docblock line="56">
          <description><![CDATA[Returns a link to the tool page (relative to templates/).]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="56" name="return" description="link" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="70" package="tools">
        <name>getRequiresWriteAccess</name>
        <full_name>getRequiresWriteAccess</full_name>
        <docblock line="65">
          <description><![CDATA[Returns if the tool requires write access to LDAP.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="65" name="return" description="true if write access is needed" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="79" package="tools">
        <name>getRequiresPasswordChangeRights</name>
        <full_name>getRequiresPasswordChangeRights</full_name>
        <docblock line="74">
          <description><![CDATA[Returns if the tool requires password change rights.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="74" name="return" description="true if password change rights are needed" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="88" package="tools">
        <name>getImageLink</name>
        <full_name>getImageLink</full_name>
        <docblock line="83">
          <description><![CDATA[Returns the link to the tool image (relative to graphics/)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="83" name="return" description="image URL" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="98" package="tools">
        <name>getPosition</name>
        <full_name>getPosition</full_name>
        <docblock line="92">
          <description><![CDATA[Returns the prefered position of this tool on the tools page.]]></description>
          <long-description><![CDATA[<p>The position may be between 0 and 1000. 0 is the top position.</p>]]></long-description>
          <tag line="92" name="return" description="prefered position" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="107" package="tools">
        <name>getSubTools</name>
        <full_name>getSubTools</full_name>
        <docblock line="102">
          <description><![CDATA[Returns a list of sub tools or an empty array.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="102" name="return" description="list of subtools (LAMTool)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="116" package="tools">
        <name>isVisible</name>
        <full_name>isVisible</full_name>
        <docblock line="111">
          <description><![CDATA[Returns if the tool is visible in the menu.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="111" name="return" description="visible" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="125" package="tools">
        <name>isHideable</name>
        <full_name>isHideable</full_name>
        <docblock line="120">
          <description><![CDATA[Returns if a tool may be hidden by configuration in the LAM server profile.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="120" name="return" description="hideable" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/tools/ouEditor.inc" hash="69d2514d6fa7ece3c9517df1d9c6f2a5" package="tools">
    <docblock line="24">
      <description><![CDATA[This file includes the OU editor tool specification.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="author" description="Roland Gruber"/>
      <tag line="24" name="package" description="tools"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="36" package="tools">
      <extends/>
      <implements>\LAMTool</implements>
      <name>toolOUEditor</name>
      <full_name>\toolOUEditor</full_name>
      <docblock line="31">
        <description><![CDATA[OU editor]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="31" name="package" description="tools"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="43" package="tools">
        <name>getName</name>
        <full_name>getName</full_name>
        <docblock line="38">
          <description><![CDATA[Returns the name of the tool.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="38" name="return" description="name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="52" package="tools">
        <name>getDescription</name>
        <full_name>getDescription</full_name>
        <docblock line="47">
          <description><![CDATA[returns a description text for the tool.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="47" name="return" description="description" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="61" package="tools">
        <name>getLink</name>
        <full_name>getLink</full_name>
        <docblock line="56">
          <description><![CDATA[Returns a link to the tool page (relative to templates/).]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="56" name="return" description="link" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="70" package="tools">
        <name>getRequiresWriteAccess</name>
        <full_name>getRequiresWriteAccess</full_name>
        <docblock line="65">
          <description><![CDATA[Returns if the tool requires write access to LDAP.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="65" name="return" description="true if write access is needed" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="79" package="tools">
        <name>getRequiresPasswordChangeRights</name>
        <full_name>getRequiresPasswordChangeRights</full_name>
        <docblock line="74">
          <description><![CDATA[Returns if the tool requires password change rights.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="74" name="return" description="true if password change rights are needed" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="88" package="tools">
        <name>getImageLink</name>
        <full_name>getImageLink</full_name>
        <docblock line="83">
          <description><![CDATA[Returns the link to the tool image (relative to graphics/)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="83" name="return" description="image URL" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="98" package="tools">
        <name>getPosition</name>
        <full_name>getPosition</full_name>
        <docblock line="92">
          <description><![CDATA[Returns the prefered position of this tool on the tools page.]]></description>
          <long-description><![CDATA[<p>The position may be between 0 and 1000. 0 is the top position.</p>]]></long-description>
          <tag line="92" name="return" description="prefered position" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="107" package="tools">
        <name>getSubTools</name>
        <full_name>getSubTools</full_name>
        <docblock line="102">
          <description><![CDATA[Returns a list of sub tools or an empty array.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="102" name="return" description="list of subtools (LAMTool)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="116" package="tools">
        <name>isVisible</name>
        <full_name>isVisible</full_name>
        <docblock line="111">
          <description><![CDATA[Returns if the tool is visible in the menu.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="111" name="return" description="visible" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="125" package="tools">
        <name>isHideable</name>
        <full_name>isHideable</full_name>
        <docblock line="120">
          <description><![CDATA[Returns if a tool may be hidden by configuration in the LAM server profile.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="120" name="return" description="hideable" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/tools/profileEditor.inc" hash="611ea452d67a37e499c3ac25963807d3" package="tools">
    <docblock line="24">
      <description><![CDATA[This file includes the profile editor tool specification.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="author" description="Roland Gruber"/>
      <tag line="24" name="package" description="tools"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="36" package="tools">
      <extends/>
      <implements>\LAMTool</implements>
      <name>toolProfileEditor</name>
      <full_name>\toolProfileEditor</full_name>
      <docblock line="31">
        <description><![CDATA[Profile editor]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="31" name="package" description="tools"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="43" package="tools">
        <name>getName</name>
        <full_name>getName</full_name>
        <docblock line="38">
          <description><![CDATA[Returns the name of the tool.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="38" name="return" description="name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="52" package="tools">
        <name>getDescription</name>
        <full_name>getDescription</full_name>
        <docblock line="47">
          <description><![CDATA[returns a description text for the tool.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="47" name="return" description="description" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="61" package="tools">
        <name>getLink</name>
        <full_name>getLink</full_name>
        <docblock line="56">
          <description><![CDATA[Returns a link to the tool page (relative to templates/).]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="56" name="return" description="link" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="70" package="tools">
        <name>getRequiresWriteAccess</name>
        <full_name>getRequiresWriteAccess</full_name>
        <docblock line="65">
          <description><![CDATA[Returns if the tool requires write access to LDAP.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="65" name="return" description="true if write access is needed" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="79" package="tools">
        <name>getRequiresPasswordChangeRights</name>
        <full_name>getRequiresPasswordChangeRights</full_name>
        <docblock line="74">
          <description><![CDATA[Returns if the tool requires password change rights.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="74" name="return" description="true if password change rights are needed" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="88" package="tools">
        <name>getImageLink</name>
        <full_name>getImageLink</full_name>
        <docblock line="83">
          <description><![CDATA[Returns the link to the tool image (relative to graphics/)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="83" name="return" description="image URL" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="98" package="tools">
        <name>getPosition</name>
        <full_name>getPosition</full_name>
        <docblock line="92">
          <description><![CDATA[Returns the prefered position of this tool on the tools page.]]></description>
          <long-description><![CDATA[<p>The position may be between 0 and 1000. 0 is the top position.</p>]]></long-description>
          <tag line="92" name="return" description="prefered position" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="107" package="tools">
        <name>getSubTools</name>
        <full_name>getSubTools</full_name>
        <docblock line="102">
          <description><![CDATA[Returns a list of sub tools or an empty array.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="102" name="return" description="list of subtools (LAMTool)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="116" package="tools">
        <name>isVisible</name>
        <full_name>isVisible</full_name>
        <docblock line="111">
          <description><![CDATA[Returns if the tool is visible in the menu.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="111" name="return" description="visible" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="125" package="tools">
        <name>isHideable</name>
        <full_name>isHideable</full_name>
        <docblock line="120">
          <description><![CDATA[Returns if a tool may be hidden by configuration in the LAM server profile.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="120" name="return" description="hideable" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/tools/tests.inc" hash="2d743ecd184d79c391a4ed902ca65e74" package="tools">
    <docblock line="24">
      <description><![CDATA[This file includes the test tool specification.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="author" description="Roland Gruber"/>
      <tag line="24" name="package" description="tools"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="36" package="tools">
      <extends/>
      <implements>\LAMTool</implements>
      <name>toolTests</name>
      <full_name>\toolTests</full_name>
      <docblock line="31">
        <description><![CDATA[Tests page]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="31" name="package" description="tools"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="43" package="tools">
        <name>getName</name>
        <full_name>getName</full_name>
        <docblock line="38">
          <description><![CDATA[Returns the name of the tool.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="38" name="return" description="name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="52" package="tools">
        <name>getDescription</name>
        <full_name>getDescription</full_name>
        <docblock line="47">
          <description><![CDATA[returns a description text for the tool.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="47" name="return" description="description" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="61" package="tools">
        <name>getLink</name>
        <full_name>getLink</full_name>
        <docblock line="56">
          <description><![CDATA[Returns a link to the tool page (relative to templates/).]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="56" name="return" description="link" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="70" package="tools">
        <name>getRequiresWriteAccess</name>
        <full_name>getRequiresWriteAccess</full_name>
        <docblock line="65">
          <description><![CDATA[Returns if the tool requires write access to LDAP.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="65" name="return" description="true if write access is needed" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="79" package="tools">
        <name>getRequiresPasswordChangeRights</name>
        <full_name>getRequiresPasswordChangeRights</full_name>
        <docblock line="74">
          <description><![CDATA[Returns if the tool requires password change rights.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="74" name="return" description="true if password change rights are needed" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="88" package="tools">
        <name>getImageLink</name>
        <full_name>getImageLink</full_name>
        <docblock line="83">
          <description><![CDATA[Returns the link to the tool image (relative to graphics/)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="83" name="return" description="image URL" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="98" package="tools">
        <name>getPosition</name>
        <full_name>getPosition</full_name>
        <docblock line="92">
          <description><![CDATA[Returns the prefered position of this tool on the tools page.]]></description>
          <long-description><![CDATA[<p>The position may be between 0 and 1000. 0 is the top position.</p>]]></long-description>
          <tag line="92" name="return" description="prefered position" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="107" package="tools">
        <name>getSubTools</name>
        <full_name>getSubTools</full_name>
        <docblock line="102">
          <description><![CDATA[Returns a list of sub tools or an empty array.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="102" name="return" description="list of subtools (LAMTool)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="129" package="tools">
        <name>isVisible</name>
        <full_name>isVisible</full_name>
        <docblock line="124">
          <description><![CDATA[Returns if the tool is visible in the menu.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="124" name="return" description="visible" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="138" package="tools">
        <name>isHideable</name>
        <full_name>isHideable</full_name>
        <docblock line="133">
          <description><![CDATA[Returns if a tool may be hidden by configuration in the LAM server profile.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="133" name="return" description="hideable" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/tools/schemaBrowser.inc" hash="dd2d3643970f1973f5b8fa39772f5f6e" package="tools">
    <docblock line="24">
      <description><![CDATA[This file includes the schema browser tool specification.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="author" description="Roland Gruber"/>
      <tag line="24" name="package" description="tools"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="36" package="tools">
      <extends/>
      <implements>\LAMTool</implements>
      <name>toolSchemaBrowser</name>
      <full_name>\toolSchemaBrowser</full_name>
      <docblock line="31">
        <description><![CDATA[Schema browser]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="31" name="package" description="tools"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="43" package="tools">
        <name>getName</name>
        <full_name>getName</full_name>
        <docblock line="38">
          <description><![CDATA[Returns the name of the tool.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="38" name="return" description="name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="52" package="tools">
        <name>getDescription</name>
        <full_name>getDescription</full_name>
        <docblock line="47">
          <description><![CDATA[returns a description text for the tool.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="47" name="return" description="description" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="61" package="tools">
        <name>getLink</name>
        <full_name>getLink</full_name>
        <docblock line="56">
          <description><![CDATA[Returns a link to the tool page (relative to templates/).]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="56" name="return" description="link" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="70" package="tools">
        <name>getRequiresWriteAccess</name>
        <full_name>getRequiresWriteAccess</full_name>
        <docblock line="65">
          <description><![CDATA[Returns if the tool requires write access to LDAP.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="65" name="return" description="true if write access is needed" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="79" package="tools">
        <name>getRequiresPasswordChangeRights</name>
        <full_name>getRequiresPasswordChangeRights</full_name>
        <docblock line="74">
          <description><![CDATA[Returns if the tool requires password change rights.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="74" name="return" description="true if password change rights are needed" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="88" package="tools">
        <name>getImageLink</name>
        <full_name>getImageLink</full_name>
        <docblock line="83">
          <description><![CDATA[Returns the link to the tool image (relative to graphics/)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="83" name="return" description="image URL" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="98" package="tools">
        <name>getPosition</name>
        <full_name>getPosition</full_name>
        <docblock line="92">
          <description><![CDATA[Returns the prefered position of this tool on the tools page.]]></description>
          <long-description><![CDATA[<p>The position may be between 0 and 1000. 0 is the top position.</p>]]></long-description>
          <tag line="92" name="return" description="prefered position" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="107" package="tools">
        <name>getSubTools</name>
        <full_name>getSubTools</full_name>
        <docblock line="102">
          <description><![CDATA[Returns a list of sub tools or an empty array.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="102" name="return" description="list of subtools (LAMTool)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="116" package="tools">
        <name>isVisible</name>
        <full_name>isVisible</full_name>
        <docblock line="111">
          <description><![CDATA[Returns if the tool is visible in the menu.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="111" name="return" description="visible" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="125" package="tools">
        <name>isHideable</name>
        <full_name>isHideable</full_name>
        <docblock line="120">
          <description><![CDATA[Returns if a tool may be hidden by configuration in the LAM server profile.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="120" name="return" description="hideable" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/types/asteriskExt.inc" hash="e490cc35d321d3381bd1f2bd8528f3f2" package="types">
    <docblock line="26">
      <description><![CDATA[The account type for Asterisk extensions.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="26" name="package" description="types"/>
      <tag line="26" name="author" description="Pozdnyak Pavel"/>
      <tag line="26" name="author" description="Roland Gruber"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="39" package="types">
      <extends>\baseType</extends>
      <name>asteriskExt</name>
      <full_name>\asteriskExt</full_name>
      <docblock line="34">
        <description><![CDATA[The account type for Asterisk extensions.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="34" name="package" description="types"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="44" package="types">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="41">
          <description><![CDATA[Constructs a new domain type object.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="55" package="types">
        <name>getAlias</name>
        <full_name>getAlias</full_name>
        <docblock line="50">
          <description><![CDATA[Returns the alias name of this account type.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="50" name="return" description="alias name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="64" package="types">
        <name>getDescription</name>
        <full_name>getDescription</full_name>
        <docblock line="59">
          <description><![CDATA[Returns the description of this account type.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="59" name="return" description="description" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="73" package="types">
        <name>getListClassName</name>
        <full_name>getListClassName</full_name>
        <docblock line="68">
          <description><![CDATA[Returns the class name for the list object.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="68" name="return" description="class name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="82" package="types">
        <name>getDefaultListAttributes</name>
        <full_name>getDefaultListAttributes</full_name>
        <docblock line="77">
          <description><![CDATA[Returns the default attribute list for this account type.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="77" name="return" description="attribute list" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="92" package="types">
        <name>getListAttributeDescriptions</name>
        <full_name>getListAttributeDescriptions</full_name>
        <docblock line="86">
          <description><![CDATA[Returns a list of attributes which have a translated description.]]></description>
          <long-description><![CDATA[<p>This is used for the head row in the list view.</p>]]></long-description>
          <tag line="86" name="return" description="list of descriptions" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="106" package="types">
        <name>getTitleBarTitle</name>
        <full_name>getTitleBarTitle</full_name>
        <docblock line="100">
          <description><![CDATA[Returns the the title text for the title bar on the new/edit page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="100" name="param" description="account container" type="\accountContainer" variable="$container">
            <type by_reference="false">\accountContainer</type>
          </tag>
          <tag line="100" name="return" description="title text" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="106">
          <name>$container</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="132" package="lists">
      <extends>\lamList</extends>
      <name>lamAsteriskExtList</name>
      <full_name>\lamAsteriskExtList</full_name>
      <docblock line="125">
        <description><![CDATA[Generates the list view.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="125" name="package" description="lists"/>
        <tag line="125" name="author" description="Pozdnyak Pavel"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="140" package="lists">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="134">
          <description><![CDATA[Constructor]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="134" name="param" description="account type" type="string" variable="$type">
            <type by_reference="false">string</type>
          </tag>
          <tag line="134" name="return" description="list object" type="\lamList">
            <type by_reference="false">\lamList</type>
          </tag>
        </docblock>
        <argument line="140">
          <name>$type</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="154" package="lists">
        <name>listGetParams</name>
        <full_name>listGetParams</full_name>
        <docblock line="149">
          <description><![CDATA[Forces the list view to show only specific attributes.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="149" name="see" description="\global\lamList::listGetParams()" refers="\global\lamList::listGetParams()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="167" package="lists">
        <name>listRefreshData</name>
        <full_name>listRefreshData</full_name>
        <docblock line="161">
          <description><![CDATA[Groups the extensions.]]></description>
          <long-description><![CDATA[<p>(non-PHPdoc)</p>]]></long-description>
          <tag line="161" name="see" description="\global\lamList::listRefreshData()" refers="\global\lamList::listRefreshData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="192" package="lists">
        <name>normalizeLdapOutput</name>
        <full_name>normalizeLdapOutput</full_name>
        <docblock line="187">
          <description><![CDATA[Groups the extensions.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="187" name="param" description="extension entries" type="array" variable="$entries">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="192">
          <name>$entries</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="lib/types/mailAlias.inc" hash="f0760b7c60512f1ba73bf1ad6e026083" package="types">
    <docblock line="24">
      <description><![CDATA[The account type for mail aliases.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="package" description="types"/>
      <tag line="24" name="author" description="Roland Gruber"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="36" package="types">
      <extends>\baseType</extends>
      <name>mailAlias</name>
      <full_name>\mailAlias</full_name>
      <docblock line="31">
        <description><![CDATA[The account type for mail aliases.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="31" name="package" description="types"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="41" package="types">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="38">
          <description><![CDATA[Constructs a new alias type object.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="52" package="types">
        <name>getAlias</name>
        <full_name>getAlias</full_name>
        <docblock line="47">
          <description><![CDATA[Returns the alias name of this account type.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="47" name="return" description="alias name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="61" package="types">
        <name>getDescription</name>
        <full_name>getDescription</full_name>
        <docblock line="56">
          <description><![CDATA[Returns the description of this account type.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="56" name="return" description="description" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="70" package="types">
        <name>getListClassName</name>
        <full_name>getListClassName</full_name>
        <docblock line="65">
          <description><![CDATA[Returns the class name for the list object.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="65" name="return" description="class name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="79" package="types">
        <name>getDefaultListAttributes</name>
        <full_name>getDefaultListAttributes</full_name>
        <docblock line="74">
          <description><![CDATA[Returns the default attribute list for this account type.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="74" name="return" description="attribute list" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="89" package="types">
        <name>getListAttributeDescriptions</name>
        <full_name>getListAttributeDescriptions</full_name>
        <docblock line="83">
          <description><![CDATA[Returns a list of attributes which have a translated description.]]></description>
          <long-description><![CDATA[<p>This is used for the head row in the list view.</p>]]></long-description>
          <tag line="83" name="return" description="list of descriptions" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="102" package="types">
        <name>getTitleBarTitle</name>
        <full_name>getTitleBarTitle</full_name>
        <docblock line="96">
          <description><![CDATA[Returns the the title text for the title bar on the new/edit page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="96" name="param" description="account container" type="\accountContainer" variable="$container">
            <type by_reference="false">\accountContainer</type>
          </tag>
          <tag line="96" name="return" description="title text" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="102">
          <name>$container</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="130" package="lists">
      <extends>\lamList</extends>
      <name>lamMailAliasList</name>
      <full_name>\lamMailAliasList</full_name>
      <docblock line="123">
        <description><![CDATA[Generates the list view.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="123" name="package" description="lists"/>
        <tag line="123" name="author" description="Roland Gruber"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="138" package="lists">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="132">
          <description><![CDATA[Constructor]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="132" name="param" description="account type" type="string" variable="$type">
            <type by_reference="false">string</type>
          </tag>
          <tag line="132" name="return" description="list object" type="\lamList">
            <type by_reference="false">\lamList</type>
          </tag>
        </docblock>
        <argument line="138">
          <name>$type</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="lib/types/host.inc" hash="cc00769edbc086620d134a94043f778f" package="types">
    <docblock line="24">
      <description><![CDATA[The account type for host accounts (e.g.]]></description>
      <long-description><![CDATA[<p>Samba).</p>]]></long-description>
      <tag line="24" name="package" description="types"/>
      <tag line="24" name="author" description="Roland Gruber"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="36" package="types">
      <extends>\baseType</extends>
      <name>host</name>
      <full_name>\host</full_name>
      <docblock line="31">
        <description><![CDATA[The account type for host accounts (e.g.]]></description>
        <long-description><![CDATA[<p>Samba).</p>]]></long-description>
        <tag line="31" name="package" description="types"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="41" package="types">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="38">
          <description><![CDATA[Constructs a new host type object.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="52" package="types">
        <name>getAlias</name>
        <full_name>getAlias</full_name>
        <docblock line="47">
          <description><![CDATA[Returns the alias name of this account type.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="47" name="return" description="alias name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="61" package="types">
        <name>getDescription</name>
        <full_name>getDescription</full_name>
        <docblock line="56">
          <description><![CDATA[Returns the description of this account type.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="56" name="return" description="description" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="70" package="types">
        <name>getListClassName</name>
        <full_name>getListClassName</full_name>
        <docblock line="65">
          <description><![CDATA[Returns the class name for the list object.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="65" name="return" description="class name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="79" package="types">
        <name>getDefaultListAttributes</name>
        <full_name>getDefaultListAttributes</full_name>
        <docblock line="74">
          <description><![CDATA[Returns the default attribute list for this account type.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="74" name="return" description="attribute list" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="89" package="types">
        <name>getListAttributeDescriptions</name>
        <full_name>getListAttributeDescriptions</full_name>
        <docblock line="83">
          <description><![CDATA[Returns a list of attributes which have a translated description.]]></description>
          <long-description><![CDATA[<p>This is used for the head row in the list view.</p>]]></long-description>
          <tag line="83" name="return" description="list of descriptions" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="107" package="types">
        <name>getTitleBarTitle</name>
        <full_name>getTitleBarTitle</full_name>
        <docblock line="101">
          <description><![CDATA[Returns the the title text for the title bar on the new/edit page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="101" name="param" description="account container" type="\accountContainer" variable="$container">
            <type by_reference="false">\accountContainer</type>
          </tag>
          <tag line="101" name="return" description="title text" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="107">
          <name>$container</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="140" package="types">
        <name>getTitleBarSubtitle</name>
        <full_name>getTitleBarSubtitle</full_name>
        <docblock line="134">
          <description><![CDATA[Returns the the title text for the title bar on the new/edit page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="134" name="param" description="account container" type="\accountContainer" variable="$container">
            <type by_reference="false">\accountContainer</type>
          </tag>
          <tag line="134" name="return" description="title text" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="140">
          <name>$container</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="182" package="lists">
      <extends>\lamList</extends>
      <name>lamHostList</name>
      <full_name>\lamHostList</full_name>
      <docblock line="175">
        <description><![CDATA[Generates the list view.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="175" name="package" description="lists"/>
        <tag line="175" name="author" description="Roland Gruber"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="190" package="lists">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="184">
          <description><![CDATA[Constructor]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="184" name="param" description="account type" type="string" variable="$type">
            <type by_reference="false">string</type>
          </tag>
          <tag line="184" name="return" description="list object" type="\lamList">
            <type by_reference="false">\lamList</type>
          </tag>
        </docblock>
        <argument line="190">
          <name>$type</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="lib/types/smbDomain.inc" hash="e65ff259d582f01e049f4d4d9fa315c7" package="types">
    <docblock line="24">
      <description><![CDATA[The account type for Samba domains.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="package" description="types"/>
      <tag line="24" name="author" description="Roland Gruber"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="36" package="types">
      <extends>\baseType</extends>
      <name>smbDomain</name>
      <full_name>\smbDomain</full_name>
      <docblock line="31">
        <description><![CDATA[The account type for Samba domains.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="31" name="package" description="types"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="41" package="types">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="38">
          <description><![CDATA[Constructs a new domain type object.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="52" package="types">
        <name>getAlias</name>
        <full_name>getAlias</full_name>
        <docblock line="47">
          <description><![CDATA[Returns the alias name of this account type.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="47" name="return" description="alias name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="61" package="types">
        <name>getDescription</name>
        <full_name>getDescription</full_name>
        <docblock line="56">
          <description><![CDATA[Returns the description of this account type.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="56" name="return" description="description" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="70" package="types">
        <name>getListClassName</name>
        <full_name>getListClassName</full_name>
        <docblock line="65">
          <description><![CDATA[Returns the class name for the list object.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="65" name="return" description="class name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="79" package="types">
        <name>getDefaultListAttributes</name>
        <full_name>getDefaultListAttributes</full_name>
        <docblock line="74">
          <description><![CDATA[Returns the default attribute list for this account type.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="74" name="return" description="attribute list" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="89" package="types">
        <name>getListAttributeDescriptions</name>
        <full_name>getListAttributeDescriptions</full_name>
        <docblock line="83">
          <description><![CDATA[Returns a list of attributes which have a translated description.]]></description>
          <long-description><![CDATA[<p>This is used for the head row in the list view.</p>]]></long-description>
          <tag line="83" name="return" description="list of descriptions" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="102" package="types">
        <name>getTitleBarTitle</name>
        <full_name>getTitleBarTitle</full_name>
        <docblock line="96">
          <description><![CDATA[Returns the the title text for the title bar on the new/edit page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="96" name="param" description="account container" type="\accountContainer" variable="$container">
            <type by_reference="false">\accountContainer</type>
          </tag>
          <tag line="96" name="return" description="title text" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="102">
          <name>$container</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="126" package="types">
        <name>getTitleBarSubtitle</name>
        <full_name>getTitleBarSubtitle</full_name>
        <docblock line="120">
          <description><![CDATA[Returns the the title text for the title bar on the new/edit page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="120" name="param" description="account container" type="\accountContainer" variable="$container">
            <type by_reference="false">\accountContainer</type>
          </tag>
          <tag line="120" name="return" description="title text" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="126">
          <name>$container</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="156" package="lists">
      <extends>\lamList</extends>
      <name>lamSmbDomainList</name>
      <full_name>\lamSmbDomainList</full_name>
      <docblock line="149">
        <description><![CDATA[Generates the list view.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="149" name="package" description="lists"/>
        <tag line="149" name="author" description="Roland Gruber"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="164" package="lists">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="158">
          <description><![CDATA[Constructor]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="158" name="param" description="account type" type="string" variable="$type">
            <type by_reference="false">string</type>
          </tag>
          <tag line="158" name="return" description="list object" type="\lamList">
            <type by_reference="false">\lamList</type>
          </tag>
        </docblock>
        <argument line="164">
          <name>$type</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="lib/types/group.inc" hash="244c1baa3cfe9ac510c0c31a4b7c9029" package="types">
    <docblock line="24">
      <description><![CDATA[The account type for group accounts (e.g.]]></description>
      <long-description><![CDATA[<p>Unix and Samba).</p>]]></long-description>
      <tag line="24" name="package" description="types"/>
      <tag line="24" name="author" description="Roland Gruber"/>
      <tag line="24" name="author" description="Ludek Finstrle"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="37" package="types">
      <extends>\baseType</extends>
      <name>group</name>
      <full_name>\group</full_name>
      <docblock line="32">
        <description><![CDATA[The account type for group accounts (e.g.]]></description>
        <long-description><![CDATA[<p>Unix and Samba).</p>]]></long-description>
        <tag line="32" name="package" description="types"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="42" package="types">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="39">
          <description><![CDATA[Constructs a new group type object.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="53" package="types">
        <name>getAlias</name>
        <full_name>getAlias</full_name>
        <docblock line="48">
          <description><![CDATA[Returns the alias name of this account type.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="48" name="return" description="alias name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="62" package="types">
        <name>getDescription</name>
        <full_name>getDescription</full_name>
        <docblock line="57">
          <description><![CDATA[Returns the description of this account type.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="57" name="return" description="description" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="71" package="types">
        <name>getListClassName</name>
        <full_name>getListClassName</full_name>
        <docblock line="66">
          <description><![CDATA[Returns the class name for the list object.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="66" name="return" description="class name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="80" package="types">
        <name>getDefaultListAttributes</name>
        <full_name>getDefaultListAttributes</full_name>
        <docblock line="75">
          <description><![CDATA[Returns the default attribute list for this account type.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="75" name="return" description="attribute list" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="90" package="types">
        <name>getListAttributeDescriptions</name>
        <full_name>getListAttributeDescriptions</full_name>
        <docblock line="84">
          <description><![CDATA[Returns a list of attributes which have a translated description.]]></description>
          <long-description><![CDATA[<p>This is used for the head row in the list view.</p>]]></long-description>
          <tag line="84" name="return" description="list of descriptions" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="106" package="types">
        <name>getTitleBarTitle</name>
        <full_name>getTitleBarTitle</full_name>
        <docblock line="100">
          <description><![CDATA[Returns the the title text for the title bar on the new/edit page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="100" name="param" description="account container" type="\accountContainer" variable="$container">
            <type by_reference="false">\accountContainer</type>
          </tag>
          <tag line="100" name="return" description="title text" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="106">
          <name>$container</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="150" package="types">
        <name>getTitleBarSubtitle</name>
        <full_name>getTitleBarSubtitle</full_name>
        <docblock line="144">
          <description><![CDATA[Returns the the title text for the title bar on the new/edit page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="144" name="param" description="account container" type="\accountContainer" variable="$container">
            <type by_reference="false">\accountContainer</type>
          </tag>
          <tag line="144" name="return" description="title text" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="150">
          <name>$container</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="188" package="lists">
      <extends>\lamList</extends>
      <name>lamGroupList</name>
      <full_name>\lamGroupList</full_name>
      <docblock line="181">
        <description><![CDATA[Generates the list view.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="181" name="package" description="lists"/>
        <tag line="181" name="author" description="Roland Gruber"/>
      </docblock>
      <constant namespace="global" line="197" package="lists">
        <name>TRANS_PRIMARY_OPTION_NAME</name>
        <full_name>TRANS_PRIMARY_OPTION_NAME</full_name>
        <value><![CDATA["LG_TP"]]></value>
        <docblock line="196">
          <description><![CDATA[ID for config option]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <property final="false" static="false" visibility="private" line="191" namespace="global" package="main">
        <name>$use_primary</name>
        <default><![CDATA[false]]></default>
        <docblock line="190">
          <description><![CDATA[Controls if include primary group members into group memebers]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="193" namespace="global" package="main">
        <name>$primary_hash</name>
        <default><![CDATA[array()]]></default>
        <docblock line="192">
          <description><![CDATA[Primary group members hash]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="195" namespace="global" package="main">
        <name>$refresh_primary</name>
        <default><![CDATA[false]]></default>
        <docblock line="194">
          <description><![CDATA[Controls if primary group members needs refresh]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="199" namespace="global" package="main">
        <name>$include_primary</name>
        <default><![CDATA[false]]></default>
        <docblock line="198">
          <description><![CDATA[specifies if primary group members are visible]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="207" package="lists">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="201">
          <description><![CDATA[Constructor]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="201" name="param" description="account type" type="string" variable="$type">
            <type by_reference="false">string</type>
          </tag>
          <tag line="201" name="return" description="list object" type="\lamList">
            <type by_reference="false">\lamList</type>
          </tag>
        </docblock>
        <argument line="207">
          <name>$type</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="219" package="lists">
        <name>listGetParams</name>
        <full_name>listGetParams</full_name>
        <docblock line="216">
          <description><![CDATA[Sets some internal parameters.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="233" package="lists">
        <name>listPrintTableCellContent</name>
        <full_name>listPrintTableCellContent</full_name>
        <docblock line="227">
          <description><![CDATA[Prints the content of a cell in the account list for a given LDAP entry and attribute.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="227" name="param" description="LDAP attributes" type="array" variable="$entry">
            <type by_reference="false">array</type>
          </tag>
          <tag line="227" name="param" description="attribute name" type="string" variable="$attribute">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="233">
          <name>$entry</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="233">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="305" package="lists">
        <name>listRefreshData</name>
        <full_name>listRefreshData</full_name>
        <docblock line="302">
          <description><![CDATA[Rereads the entries from LDAP.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="315" package="lists">
        <name>groupRefreshPrimary</name>
        <full_name>groupRefreshPrimary</full_name>
        <docblock line="312">
          <description><![CDATA[Refreshes the primary group members list.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="341" package="lists">
        <name>listGetAllConfigOptions</name>
        <full_name>listGetAllConfigOptions</full_name>
        <docblock line="336">
          <description><![CDATA[Returns a list of possible configuration options.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="336" name="return" description="list of lamListOption objects" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="350" package="lists">
        <name>listConfigurationChanged</name>
        <full_name>listConfigurationChanged</full_name>
        <docblock line="347">
          <description><![CDATA[Called when the configuration options changed.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/types/user.inc" hash="eccd3c5319fe19ab3386e81cd21e6bb8" package="types">
    <docblock line="24">
      <description><![CDATA[The account type for user accounts (e.g.]]></description>
      <long-description><![CDATA[<p>Unix, Samba and Kolab).</p>]]></long-description>
      <tag line="24" name="package" description="types"/>
      <tag line="24" name="author" description="Roland Gruber"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="36" package="types">
      <extends>\baseType</extends>
      <name>user</name>
      <full_name>\user</full_name>
      <docblock line="31">
        <description><![CDATA[The account type for user accounts (e.g.]]></description>
        <long-description><![CDATA[<p>Unix, Samba and Kolab).</p>]]></long-description>
        <tag line="31" name="package" description="types"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="41" package="types">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="38">
          <description><![CDATA[Constructs a new user type object.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="52" package="types">
        <name>getAlias</name>
        <full_name>getAlias</full_name>
        <docblock line="47">
          <description><![CDATA[Returns the alias name of this account type.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="47" name="return" description="alias name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="61" package="types">
        <name>getDescription</name>
        <full_name>getDescription</full_name>
        <docblock line="56">
          <description><![CDATA[Returns the description of this account type.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="56" name="return" description="description" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="70" package="types">
        <name>getListClassName</name>
        <full_name>getListClassName</full_name>
        <docblock line="65">
          <description><![CDATA[Returns the class name for the list object.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="65" name="return" description="class name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="79" package="types">
        <name>getDefaultListAttributes</name>
        <full_name>getDefaultListAttributes</full_name>
        <docblock line="74">
          <description><![CDATA[Returns the default attribute list for this account type.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="74" name="return" description="attribute list" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="89" package="types">
        <name>getListAttributeDescriptions</name>
        <full_name>getListAttributeDescriptions</full_name>
        <docblock line="83">
          <description><![CDATA[Returns a list of attributes which have a translated description.]]></description>
          <long-description><![CDATA[<p>This is used for the head row in the list view.</p>]]></long-description>
          <tag line="83" name="return" description="list of descriptions" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="114" package="types">
        <name>getTitleBarTitle</name>
        <full_name>getTitleBarTitle</full_name>
        <docblock line="108">
          <description><![CDATA[Returns the the title text for the title bar on the new/edit page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="108" name="param" description="account container" type="\accountContainer" variable="$container">
            <type by_reference="false">\accountContainer</type>
          </tag>
          <tag line="108" name="return" description="title text" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="114">
          <name>$container</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="184" package="types">
        <name>getTitleBarSubtitle</name>
        <full_name>getTitleBarSubtitle</full_name>
        <docblock line="178">
          <description><![CDATA[Returns the the title text for the title bar on the new/edit page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="178" name="param" description="account container" type="\accountContainer" variable="$container">
            <type by_reference="false">\accountContainer</type>
          </tag>
          <tag line="178" name="return" description="title text" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="184">
          <name>$container</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="221" package="types">
        <name>buildAccountStatusIcon</name>
        <full_name>buildAccountStatusIcon</full_name>
        <docblock line="215">
          <description><![CDATA[Builds the HTML code for the icon that shows the account status (locked/unlocked).]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="215" name="param" description="account container" type="\accountContainer" variable="$container">
            <type by_reference="false">\accountContainer</type>
          </tag>
          <tag line="215" name="return" description="HTML code for icon" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="221">
          <name>$container</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="321" package="types">
        <name>buildAccountStatusDialogDiv</name>
        <full_name>buildAccountStatusDialogDiv</full_name>
        <docblock line="309">
          <description><![CDATA[Builds the dialog to (un)lock parts of an account.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="309" name="param" description="Unix part is active" type="boolean" variable="$unixAvailable">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="309" name="param" description="Unix part is locked" type="boolean" variable="$unixLocked">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="309" name="param" description="Samba part is active" type="boolean" variable="$sambaAvailable">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="309" name="param" description="Samba part is locked" type="boolean" variable="$sambaLocked">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="309" name="param" description="PPolicy part is active" type="boolean" variable="$ppolicyAvailable">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="309" name="param" description="PPolicy part is locked" type="boolean" variable="$ppolicyLocked">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="309" name="param" description="Windows part is active" type="boolean" variable="$windowsAvailable">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="309" name="param" description="Windows part is locked" type="boolean" variable="$windowsLocked">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="321">
          <name>$unixAvailable</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="321">
          <name>$unixLocked</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="321">
          <name>$sambaAvailable</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="321">
          <name>$sambaLocked</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="321">
          <name>$ppolicyAvailable</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="321">
          <name>$ppolicyLocked</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="321">
          <name>$windowsAvailable</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="321">
          <name>$windowsLocked</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="441" package="types">
        <name>runEditPagePostAction</name>
        <full_name>runEditPagePostAction</full_name>
        <docblock line="435">
          <description><![CDATA[This function is called after the edit page is processed and before the page content is generated.]]></description>
          <long-description><![CDATA[<p>This can be used to run custom handlers after each page processing.</p>]]></long-description>
          <tag line="435" name="param" description="account container" type="\accountContainer" variable="$container">
            <type by_reference="false">\accountContainer</type>
          </tag>
        </docblock>
        <argument line="441">
          <name>$container</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="502" package="lists">
      <extends>\lamList</extends>
      <name>lamUserList</name>
      <full_name>\lamUserList</full_name>
      <docblock line="495">
        <description><![CDATA[Generates the list view.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="495" name="package" description="lists"/>
        <tag line="495" name="author" description="Roland Gruber"/>
      </docblock>
      <constant namespace="global" line="514" package="lists">
        <name>TRANS_PRIMARY_OPTION_NAME</name>
        <full_name>TRANS_PRIMARY_OPTION_NAME</full_name>
        <value><![CDATA["LU_TP"]]></value>
        <docblock line="513">
          <description><![CDATA[ID for config option to translate primary group GIDs to group names]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="global" line="516" package="lists">
        <name>ACCOUNT_STATUS_OPTION_NAME</name>
        <full_name>ACCOUNT_STATUS_OPTION_NAME</full_name>
        <value><![CDATA["LU_AS"]]></value>
        <docblock line="515">
          <description><![CDATA[ID for config option to show account status]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="global" line="519" package="lists">
        <name>ATTR_ACCOUNT_STATUS</name>
        <full_name>ATTR_ACCOUNT_STATUS</full_name>
        <value><![CDATA['lam_virtual_account_status']]></value>
        <docblock line="518">
          <description><![CDATA[virtual attribute name for account status column]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <property final="false" static="false" visibility="private" line="505" namespace="global" package="main">
        <name>$trans_primary</name>
        <default><![CDATA[false]]></default>
        <docblock line="504">
          <description><![CDATA[Controls if GID number is translated to group name]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="508" namespace="global" package="main">
        <name>$showAccountStatus</name>
        <default><![CDATA[false]]></default>
        <docblock line="507">
          <description><![CDATA[Controls if the account status is shown]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="511" namespace="global" package="main">
        <name>$trans_primary_hash</name>
        <default><![CDATA[array()]]></default>
        <docblock line="510">
          <description><![CDATA[translates GID to group name]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="527" package="lists">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="521">
          <description><![CDATA[Constructor]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="521" name="param" description="account type" type="string" variable="$type">
            <type by_reference="false">string</type>
          </tag>
          <tag line="521" name="return" description="list object" type="\lamList">
            <type by_reference="false">\lamList</type>
          </tag>
        </docblock>
        <argument line="527">
          <name>$type</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="539" package="lists">
        <name>listGetParams</name>
        <full_name>listGetParams</full_name>
        <docblock line="536">
          <description><![CDATA[Sets some internal parameters.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="550" package="lists">
        <name>listRefreshData</name>
        <full_name>listRefreshData</full_name>
        <docblock line="547">
          <description><![CDATA[Rereads the entries from LDAP.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="563" package="lists">
        <name>refreshPrimaryGroupTranslation</name>
        <full_name>refreshPrimaryGroupTranslation</full_name>
        <docblock line="560">
          <description><![CDATA[Refreshes the GID to group name cache.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="581" package="lists">
        <name>listPrintTableCellContent</name>
        <full_name>listPrintTableCellContent</full_name>
        <docblock line="575">
          <description><![CDATA[Prints the content of a cell in the account list for a given LDAP entry and attribute.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="575" name="param" description="LDAP attributes" type="array" variable="$entry">
            <type by_reference="false">array</type>
          </tag>
          <tag line="575" name="param" description="attribute name" type="string" variable="$attribute">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="581">
          <name>$entry</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="581">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="667" package="lists">
        <name>getAdditionalTools</name>
        <full_name>getAdditionalTools</full_name>
        <docblock line="662">
          <description><![CDATA[Returns a list of lamListTool objects to display next to the edit/delete buttons.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="662" name="return" description="tools" type="\lamListTool[]">
            <type by_reference="false">\lamListTool[]</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="680" package="lists">
        <name>listGetAllConfigOptions</name>
        <full_name>listGetAllConfigOptions</full_name>
        <docblock line="675">
          <description><![CDATA[Returns a list of possible configuration options.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="675" name="return" description="list of lamListOption objects" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="690" package="lists">
        <name>listConfigurationChanged</name>
        <full_name>listConfigurationChanged</full_name>
        <docblock line="687">
          <description><![CDATA[Called when the configuration options changed.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="711" package="lists">
        <name>listGetAttributeDescriptionList</name>
        <full_name>listGetAttributeDescriptionList</full_name>
        <docblock line="703">
          <description><![CDATA[Returns an hash array containing with all attributes to be shown and their descriptions.]]></description>
          <long-description><![CDATA[<p><br>Format: array(attribute => description)
<br>
<br>The user list may display an additional account status column</p>]]></long-description>
          <tag line="703" name="return" description="attribute list" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="728" package="lists">
        <name>canBeFiltered</name>
        <full_name>canBeFiltered</full_name>
        <docblock line="719">
          <description><![CDATA[Returns if the given attribute can be filtered.]]></description>
          <long-description><![CDATA[<p>If filtering is not possible then no filter box will be displayed.
<br>
<br>The user list allows no filtering for account status.</p>]]></long-description>
          <tag line="719" name="param" description="attribute name" type="String" variable="$attr">
            <type by_reference="false">String</type>
          </tag>
          <tag line="719" name="return" description="filtering possible" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="728">
          <name>$attr</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="746" package="lists">
        <name>getAdditionalLDAPAttributesToRead</name>
        <full_name>getAdditionalLDAPAttributesToRead</full_name>
        <docblock line="738">
          <description><![CDATA[Returns a list of additional LDAP attributes that should be read.]]></description>
          <long-description><![CDATA[<p>This can be used to show additional data even if the user selected other attributes to show in the list.
<br>
<br>The user list reads pwdAccountLockedTime, sambaAcctFlags and userPassword</p>]]></long-description>
          <tag line="738" name="return" description="additional attribute names" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="761" package="lists">
        <name>injectAccountStatusAttribute</name>
        <full_name>injectAccountStatusAttribute</full_name>
        <docblock line="758">
          <description><![CDATA[Injects values for the virtual account status attribute to make it sortable.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="786" package="lists">
        <name>printAccountStatus</name>
        <full_name>printAccountStatus</full_name>
        <docblock line="781">
          <description><![CDATA[Prints the account status.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="781" name="param" description="LDAP attributes" type="array" variable="$attrs">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="786">
          <name>$attrs</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="global" line="862" package="lists">
        <name>isUnixAvailable</name>
        <full_name>isUnixAvailable</full_name>
        <docblock line="856">
          <description><![CDATA[Returns if the Unix part exists.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="856" name="param" description="LDAP attributes" type="array" variable="$attrs">
            <type by_reference="false">array</type>
          </tag>
          <tag line="856" name="return" description="Unix part exists" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="862">
          <name>$attrs</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="global" line="872" package="lists">
        <name>isUnixLocked</name>
        <full_name>isUnixLocked</full_name>
        <docblock line="866">
          <description><![CDATA[Returns if the Unix part is locked.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="866" name="param" description="LDAP attributes" type="array" variable="$attrs">
            <type by_reference="false">array</type>
          </tag>
          <tag line="866" name="return" description="Unix part locked" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="872">
          <name>$attrs</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="global" line="882" package="lists">
        <name>isSambaAvailable</name>
        <full_name>isSambaAvailable</full_name>
        <docblock line="876">
          <description><![CDATA[Returns if the Samba part exists.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="876" name="param" description="LDAP attributes" type="array" variable="$attrs">
            <type by_reference="false">array</type>
          </tag>
          <tag line="876" name="return" description="Samba part exists" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="882">
          <name>$attrs</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="global" line="892" package="lists">
        <name>isSambaLocked</name>
        <full_name>isSambaLocked</full_name>
        <docblock line="886">
          <description><![CDATA[Returns if the Samba part is locked.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="886" name="param" description="LDAP attributes" type="array" variable="$attrs">
            <type by_reference="false">array</type>
          </tag>
          <tag line="886" name="return" description="Samba part is locked" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="892">
          <name>$attrs</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="global" line="902" package="lists">
        <name>isPPolicyAvailable</name>
        <full_name>isPPolicyAvailable</full_name>
        <docblock line="896">
          <description><![CDATA[Returns if the PPolicy part exists.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="896" name="param" description="LDAP attributes" type="array" variable="$attrs">
            <type by_reference="false">array</type>
          </tag>
          <tag line="896" name="return" description="PPolicy part exists" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="902">
          <name>$attrs</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="global" line="912" package="lists">
        <name>isPPolicyLocked</name>
        <full_name>isPPolicyLocked</full_name>
        <docblock line="906">
          <description><![CDATA[Returns if the PPolicy part is locked.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="906" name="param" description="LDAP attributes" type="array" variable="$attrs">
            <type by_reference="false">array</type>
          </tag>
          <tag line="906" name="return" description="PPolicy part is locked" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="912">
          <name>$attrs</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="global" line="922" package="lists">
        <name>isWindowsAvailable</name>
        <full_name>isWindowsAvailable</full_name>
        <docblock line="916">
          <description><![CDATA[Returns if the Windows part exists.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="916" name="param" description="LDAP attributes" type="array" variable="$attrs">
            <type by_reference="false">array</type>
          </tag>
          <tag line="916" name="return" description="Windows part exists" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="922">
          <name>$attrs</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="global" line="932" package="lists">
        <name>isWindowsLocked</name>
        <full_name>isWindowsLocked</full_name>
        <docblock line="926">
          <description><![CDATA[Returns if the Windows part is locked.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="926" name="param" description="LDAP attributes" type="array" variable="$attrs">
            <type by_reference="false">array</type>
          </tag>
          <tag line="926" name="return" description="Windows part is locked" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="932">
          <name>$attrs</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="lib/types/dhcp.inc" hash="937d4e7daae844244b6a4f708c0f5b8d" package="types">
    <docblock line="26">
      <description><![CDATA[The account type for DHCP]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="26" name="package" description="types"/>
      <tag line="26" name="author" description="Thomas Manninger"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="39" package="types">
      <extends>\baseType</extends>
      <name>dhcp</name>
      <full_name>\dhcp</full_name>
      <docblock line="33">
        <description><![CDATA[The account type for DHCP]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="33" name="package" description="types"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="44" package="types">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="41">
          <description><![CDATA[Constructs a new DHCP type object.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="55" package="types">
        <name>getAlias</name>
        <full_name>getAlias</full_name>
        <docblock line="50">
          <description><![CDATA[Returns the alias name of this account type.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="50" name="return" description="alias name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="64" package="types">
        <name>getDescription</name>
        <full_name>getDescription</full_name>
        <docblock line="59">
          <description><![CDATA[Returns the description of this account type.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="59" name="return" description="description" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="73" package="types">
        <name>getListClassName</name>
        <full_name>getListClassName</full_name>
        <docblock line="68">
          <description><![CDATA[Returns the class name for the list object.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="68" name="return" description="class name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="82" package="types">
        <name>getDefaultListAttributes</name>
        <full_name>getDefaultListAttributes</full_name>
        <docblock line="77">
          <description><![CDATA[Returns the default attribute list for this account type.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="77" name="return" description="attribute list" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="92" package="types">
        <name>getListAttributeDescriptions</name>
        <full_name>getListAttributeDescriptions</full_name>
        <docblock line="86">
          <description><![CDATA[Returns a list of attributes which have a translated description.]]></description>
          <long-description><![CDATA[<p>This is used for the head row in the list view.</p>]]></long-description>
          <tag line="86" name="return" description="list of descriptions" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="106" package="types">
        <name>getTitleBarTitle</name>
        <full_name>getTitleBarTitle</full_name>
        <docblock line="100">
          <description><![CDATA[Returns the the title text for the title bar on the new/edit page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="100" name="param" description="account container" type="\accountContainer" variable="$container">
            <type by_reference="false">\accountContainer</type>
          </tag>
          <tag line="100" name="return" description="title text" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="106">
          <name>$container</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="130" package="types">
        <name>getTitleBarSubtitle</name>
        <full_name>getTitleBarSubtitle</full_name>
        <docblock line="124">
          <description><![CDATA[Returns the the title text for the title bar on the new/edit page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="124" name="param" description="account container" type="\accountContainer" variable="$container">
            <type by_reference="false">\accountContainer</type>
          </tag>
          <tag line="124" name="return" description="title text" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="130">
          <name>$container</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="159" package="lists">
      <extends>\lamList</extends>
      <name>lamDHCPList</name>
      <full_name>\lamDHCPList</full_name>
      <docblock line="152">
        <description><![CDATA[Generates the list view.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="152" name="package" description="lists"/>
        <tag line="152" name="author" description="Thomas Manninger"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="167" package="lists">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="161">
          <description><![CDATA[Constructor]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="161" name="param" description="account type" type="string" variable="$type">
            <type by_reference="false">string</type>
          </tag>
          <tag line="161" name="return" description="list object" type="\lamList">
            <type by_reference="false">\lamList</type>
          </tag>
        </docblock>
        <argument line="167">
          <name>$type</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="183" package="lists">
        <name>listPrintTableCellContent</name>
        <full_name>listPrintTableCellContent</full_name>
        <docblock line="177">
          <description><![CDATA[Prints the content of a cell in the account list for a given LDAP entry and attribute.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="177" name="param" description="LDAP attributes" type="array" variable="$entry">
            <type by_reference="false">array</type>
          </tag>
          <tag line="177" name="param" description="attribute name" type="string" variable="$attribute">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="183">
          <name>$entry</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="183">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="242" package="lists">
        <name>addExtraInputElementsToTopArea</name>
        <full_name>addExtraInputElementsToTopArea</full_name>
        <docblock line="236">
          <description><![CDATA[Add DCP main settings button.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="236" name="param" description="left part" type="\htmlGroup" variable="$left">
            <type by_reference="false">\htmlGroup</type>
          </tag>
          <tag line="236" name="param" description="right part" type="\htmlGroup" variable="$right">
            <type by_reference="false">\htmlGroup</type>
          </tag>
        </docblock>
        <argument line="242">
          <name>$left</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="242">
          <name>$right</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="256" package="lists">
        <name>listDoPost</name>
        <full_name>listDoPost</full_name>
        <docblock line="251">
          <description><![CDATA[Manages all POST actions (e.g.]]></description>
          <long-description><![CDATA[<p>button pressed) for the account lists.</p>]]></long-description>
          <tag line="251" name="return" description="HTML fragment to insert into beginning of account list" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/types/netgroup.inc" hash="3e5481ee65f5972b82ec488e239c2795" package="types">
    <docblock line="24">
      <description><![CDATA[The account type for NIS netgroups.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="package" description="types"/>
      <tag line="24" name="author" description="Roland Gruber"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="36" package="types">
      <extends>\baseType</extends>
      <name>netgroup</name>
      <full_name>\netgroup</full_name>
      <docblock line="31">
        <description><![CDATA[The account type for NIS netgroups.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="31" name="package" description="types"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="41" package="types">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="38">
          <description><![CDATA[Constructs a new group type object.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="52" package="types">
        <name>getAlias</name>
        <full_name>getAlias</full_name>
        <docblock line="47">
          <description><![CDATA[Returns the alias name of this account type.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="47" name="return" description="alias name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="61" package="types">
        <name>getDescription</name>
        <full_name>getDescription</full_name>
        <docblock line="56">
          <description><![CDATA[Returns the description of this account type.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="56" name="return" description="description" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="70" package="types">
        <name>getListClassName</name>
        <full_name>getListClassName</full_name>
        <docblock line="65">
          <description><![CDATA[Returns the class name for the list object.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="65" name="return" description="class name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="79" package="types">
        <name>getDefaultListAttributes</name>
        <full_name>getDefaultListAttributes</full_name>
        <docblock line="74">
          <description><![CDATA[Returns the default attribute list for this account type.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="74" name="return" description="attribute list" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="89" package="types">
        <name>getListAttributeDescriptions</name>
        <full_name>getListAttributeDescriptions</full_name>
        <docblock line="83">
          <description><![CDATA[Returns a list of attributes which have a translated description.]]></description>
          <long-description><![CDATA[<p>This is used for the head row in the list view.</p>]]></long-description>
          <tag line="83" name="return" description="list of descriptions" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="104" package="types">
        <name>getTitleBarTitle</name>
        <full_name>getTitleBarTitle</full_name>
        <docblock line="98">
          <description><![CDATA[Returns the the title text for the title bar on the new/edit page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="98" name="param" description="account container" type="\accountContainer" variable="$container">
            <type by_reference="false">\accountContainer</type>
          </tag>
          <tag line="98" name="return" description="title text" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="104">
          <name>$container</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="128" package="types">
        <name>getTitleBarSubtitle</name>
        <full_name>getTitleBarSubtitle</full_name>
        <docblock line="122">
          <description><![CDATA[Returns the the title text for the title bar on the new/edit page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="122" name="param" description="account container" type="\accountContainer" variable="$container">
            <type by_reference="false">\accountContainer</type>
          </tag>
          <tag line="122" name="return" description="title text" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="128">
          <name>$container</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="158" package="lists">
      <extends>\lamList</extends>
      <name>lamNetgroupList</name>
      <full_name>\lamNetgroupList</full_name>
      <docblock line="151">
        <description><![CDATA[Generates the list view.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="151" name="package" description="lists"/>
        <tag line="151" name="author" description="Roland Gruber"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="166" package="lists">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="160">
          <description><![CDATA[Constructor]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="160" name="param" description="account type" type="string" variable="$type">
            <type by_reference="false">string</type>
          </tag>
          <tag line="160" name="return" description="list object" type="\lamList">
            <type by_reference="false">\lamList</type>
          </tag>
        </docblock>
        <argument line="166">
          <name>$type</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="lib/account.inc" hash="5bbffef4d388a8acc1ae02eb26cd5391" package="lib">
    <docblock line="25">
      <description><![CDATA[This provides several helper function for the account modules.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="25" name="author" description="Tilo Lutz"/>
      <tag line="25" name="author" description="Roland Gruber"/>
      <tag line="25" name="package" description="lib"/>
    </docblock>
    <include line="114" type="Include Once" package="main">
      <name>createntlm.inc</name>
    </include>
    <include line="128" type="Include Once" package="main">
      <name>createntlm.inc</name>
    </include>
    <function namespace="global" line="42" package="lib">
      <name>array_delete</name>
      <full_name>\array_delete</full_name>
      <docblock line="35">
        <description><![CDATA[This function will return all values from $array without values of $values.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="35" name="param" description="list of values which should be removed" type="array" variable="$values">
          <type by_reference="false">array</type>
        </tag>
        <tag line="35" name="param" description="list of original values" type="array" variable="$array">
          <type by_reference="false">array</type>
        </tag>
        <tag line="35" name="return" description="list of remaining values" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="42">
        <name>$values</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="42">
        <name>$array</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="61" package="lib">
      <name>in_array_ignore_case</name>
      <full_name>\in_array_ignore_case</full_name>
      <docblock line="55">
        <description><![CDATA[Checks if a string exists in an array, ignoring case.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="55" name="param" description="search string" type="String" variable="$needle">
          <type by_reference="false">String</type>
        </tag>
        <tag line="55" name="param" description="array" type="array" variable="$haystack">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="61">
        <name>$needle</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="61">
        <name>$haystack</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="77" package="lib">
      <name>getdays</name>
      <full_name>\getdays</full_name>
      <docblock line="72">
        <description><![CDATA[This function will return the days from 1.1.1970 until now.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="72" name="return" description="of days" type="\number">
          <type by_reference="false">\number</type>
        </tag>
      </docblock>
    </function>
    <function namespace="global" line="89" package="lib">
      <name>smbflag</name>
      <full_name>\smbflag</full_name>
      <docblock line="83">
        <description><![CDATA[Takes a list of Samba flags and creates the corresponding flag string.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="83" name="param" description="is an array of Samba flags (e.g. X or D)" type="array" variable="$input">
          <type by_reference="false">array</type>
        </tag>
        <tag line="83" name="return" description="Samba flag string" type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="89">
        <name>$input</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="112" package="lib">
      <name>lmPassword</name>
      <full_name>\lmPassword</full_name>
      <docblock line="106">
        <description><![CDATA[Generates the LM hash of a password.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="106" name="param" description="password original password" type="string" variable="$password">
          <type by_reference="false">string</type>
        </tag>
        <tag line="106" name="return" description="password hash" type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="112">
        <name>$password</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="126" package="lib">
      <name>ntPassword</name>
      <full_name>\ntPassword</full_name>
      <docblock line="120">
        <description><![CDATA[Generates the NT hash of a password.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="120" name="param" description="password original password" type="string" variable="$password">
          <type by_reference="false">string</type>
        </tag>
        <tag line="120" name="return" description="password hash" type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="126">
        <name>$password</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="146" package="lib">
      <name>pwd_hash</name>
      <full_name>\pwd_hash</full_name>
      <docblock line="137">
        <description><![CDATA[Returns the hash value of a plain text password.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="137" name="see" description="\global\getSupportedHashTypes()" refers="\global\getSupportedHashTypes()"/>
        <tag line="137" name="param" description="the password string" type="string" variable="$password">
          <type by_reference="false">string</type>
        </tag>
        <tag line="137" name="param" description="marks the hash as enabled/disabled (e.g. by prefixing &quot;!&quot;)" type="boolean" variable="$enabled">
          <type by_reference="false">boolean</type>
        </tag>
        <tag line="137" name="param" description="password hash type (CRYPT, CRYPT-SHA512, SHA, SSHA, MD5, SMD5, PLAIN)" type="string" variable="$hashType">
          <type by_reference="false">string</type>
        </tag>
        <tag line="137" name="return" description="the password hash" type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="146">
        <name>$password</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="146">
        <name>$enabled</name>
        <default><![CDATA[true]]></default>
        <type/>
      </argument>
      <argument line="146">
        <name>$hashType</name>
        <default><![CDATA['SSHA']]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="196" package="lib">
      <name>getSupportedHashTypes</name>
      <full_name>\getSupportedHashTypes</full_name>
      <docblock line="191">
        <description><![CDATA[Returns the list of supported hash types (e.g.]]></description>
        <long-description><![CDATA[<p>SSHA).</p>]]></long-description>
        <tag line="191" name="return" description="hash types" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
    </function>
    <function namespace="global" line="211" package="lib">
      <name>generateSalt</name>
      <full_name>\generateSalt</full_name>
      <docblock line="204">
        <description><![CDATA[Calculates a password salt of the given legth.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="204" name="param" description="salt length" type="int" variable="$len">
          <type by_reference="false">int</type>
        </tag>
        <tag line="204" name="return" description="the salt string" type="String">
          <type by_reference="false">String</type>
        </tag>
      </docblock>
      <argument line="211">
        <name>$len</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="227" package="lib">
      <name>pwd_enable</name>
      <full_name>\pwd_enable</full_name>
      <docblock line="221">
        <description><![CDATA[Marks an password hash as enabled and returns the new hash string]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="221" name="param" description="hash value to enable" type="string" variable="$hash">
          <type by_reference="false">string</type>
        </tag>
        <tag line="221" name="return" description="enabled password hash" type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="227">
        <name>$hash</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="252" package="lib">
      <name>pwd_disable</name>
      <full_name>\pwd_disable</full_name>
      <docblock line="246">
        <description><![CDATA[Marks an password hash as disabled and returns the new hash string]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="246" name="param" description="hash value to disable" type="string" variable="$hash">
          <type by_reference="false">string</type>
        </tag>
        <tag line="246" name="return" description="disabled hash value" type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="252">
        <name>$hash</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="278" package="lib">
      <name>pwd_is_lockable</name>
      <full_name>\pwd_is_lockable</full_name>
      <docblock line="271">
        <description><![CDATA[Checks if a Unix password can be locked.]]></description>
        <long-description><![CDATA[<p>This checks if the password is not plain text but e.g. contains {SSHA}.</p>]]></long-description>
        <tag line="271" name="param" description="password value" type="String" variable="$password">
          <type by_reference="false">String</type>
        </tag>
        <tag line="271" name="return" description="can be locked" type="boolean">
          <type by_reference="false">boolean</type>
        </tag>
      </docblock>
      <argument line="278">
        <name>$password</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="291" package="lib">
      <name>pwd_is_enabled</name>
      <full_name>\pwd_is_enabled</full_name>
      <docblock line="285">
        <description><![CDATA[Checks if a password hash is enabled/disabled]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="285" name="param" description="password hash to check" type="string" variable="$hash">
          <type by_reference="false">string</type>
        </tag>
        <tag line="285" name="return" description="true if the password is marked as enabled" type="boolean">
          <type by_reference="false">boolean</type>
        </tag>
      </docblock>
      <argument line="291">
        <name>$hash</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="308" package="lib">
      <name>generateRandomPassword</name>
      <full_name>\generateRandomPassword</full_name>
      <docblock line="303">
        <description><![CDATA[Generates a random password with 12 digits.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="303" name="return" description="password" type="String">
          <type by_reference="false">String</type>
        </tag>
      </docblock>
    </function>
    <function namespace="global" line="336" package="lib">
      <name>search_domains</name>
      <full_name>\search_domains</full_name>
      <docblock line="329">
        <description><![CDATA[Returns an array with all Samba 3 domain entries under the given suffix]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="329" name="param" description="LDAP handle (if null then $_SESSION['ldap']-&gt;server() is used)" type="\handle" variable="$server">
          <type by_reference="false">\handle</type>
        </tag>
        <tag line="329" name="param" description="LDAP suffix to search (if null then $_SESSION['config']-&gt;get_Suffix('smbDomain') is used)" type="String" variable="$suffix">
          <type by_reference="false">String</type>
        </tag>
        <tag line="329" name="return" description="list of samba3domain objects" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="336">
        <name>$server</name>
        <default><![CDATA[null]]></default>
        <type/>
      </argument>
      <argument line="336">
        <name>$suffix</name>
        <default><![CDATA[null]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="405" package="lib">
      <name>get_preg</name>
      <full_name>\get_preg</full_name>
      <docblock line="398">
        <description><![CDATA[Checks if a given value matches the selected regular expression.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="398" name="param" description="value to check" type="string" variable="$argument">
          <type by_reference="false">string</type>
        </tag>
        <tag line="398" name="param" description="pattern name" type="string" variable="$regexp">
          <type by_reference="false">string</type>
        </tag>
        <tag line="398" name="return" description="true if matches, otherwise false" type="boolean">
          <type by_reference="false">boolean</type>
        </tag>
      </docblock>
      <argument line="405">
        <name>$argument</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="405">
        <name>$regexp</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="565" package="lib">
      <name>escapeDN</name>
      <full_name>\escapeDN</full_name>
      <docblock line="559">
        <description><![CDATA[Escapes any special characters in an LDAP DN.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="559" name="param" description="DN" type="String" variable="$dn">
          <type by_reference="false">String</type>
        </tag>
        <tag line="559" name="return" description="escaped DN" type="String">
          <type by_reference="false">String</type>
        </tag>
      </docblock>
      <argument line="565">
        <name>$dn</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="584" package="lib">
      <name>searchLDAPByAttribute</name>
      <full_name>\searchLDAPByAttribute</full_name>
      <docblock line="574">
        <description><![CDATA[This will search the given LDAP suffix for all entries which have the given attribute.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="574" name="param" description="attribute name (may be null)" type="String" variable="$name">
          <type by_reference="false">String</type>
        </tag>
        <tag line="574" name="param" description="attribute value" type="String" variable="$value">
          <type by_reference="false">String</type>
        </tag>
        <tag line="574" name="param" description="object class (may be null)" type="String" variable="$objectClass">
          <type by_reference="false">String</type>
        </tag>
        <tag line="574" name="param" description="list of attributes to return" type="array" variable="$attributes">
          <type by_reference="false">array</type>
        </tag>
        <tag line="574" name="param" description="account types" type="array" variable="$scopes">
          <type by_reference="false">array</type>
        </tag>
        <tag line="574" name="return" description="list of found entries" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="584">
        <name>$name</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="584">
        <name>$value</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="584">
        <name>$objectClass</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="584">
        <name>$attributes</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="584">
        <name>$scopes</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="626" package="lib">
      <name>searchLDAPByFilter</name>
      <full_name>\searchLDAPByFilter</full_name>
      <docblock line="617">
        <description><![CDATA[This will search the given LDAP suffix for all entries which match the given filter.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="617" name="param" description="" type="String" variable="$filter">
          <type by_reference="false">String</type>
        </tag>
        <tag line="617" name="param" description="list of attributes to return" type="array" variable="$attributes">
          <type by_reference="false">array</type>
        </tag>
        <tag line="617" name="param" description="account types" type="array" variable="$scopes">
          <type by_reference="false">array</type>
        </tag>
        <tag line="617" name="param" description="get only attributes but no values (default: false)" type="boolean" variable="$attrsOnly">
          <type by_reference="false">boolean</type>
        </tag>
        <tag line="617" name="return" description="list of found entries" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="626">
        <name>$filter</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="626">
        <name>$attributes</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="626">
        <name>$scopes</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="626">
        <name>$attrsOnly</name>
        <default><![CDATA[false]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="656" package="lib">
      <name>searchLDAP</name>
      <full_name>\searchLDAP</full_name>
      <docblock line="648">
        <description><![CDATA[Runs an LDAP search.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="648" name="param" description="LDAP suffix" type="String" variable="$suffix">
          <type by_reference="false">String</type>
        </tag>
        <tag line="648" name="param" description="filter" type="String" variable="$filter">
          <type by_reference="false">String</type>
        </tag>
        <tag line="648" name="param" description="list of attributes to return" type="array" variable="$attributes">
          <type by_reference="false">array</type>
        </tag>
        <tag line="648" name="return" description="list of found entries" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="656">
        <name>$suffix</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="656">
        <name>$filter</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="656">
        <name>$attributes</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="679" package="lib">
      <name>ldapGetDN</name>
      <full_name>\ldapGetDN</full_name>
      <docblock line="671">
        <description><![CDATA[Returns the given DN.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="671" name="param" description="DN" type="String" variable="$dn">
          <type by_reference="false">String</type>
        </tag>
        <tag line="671" name="param" description="list of attributes to fetch" type="array" variable="$attributes">
          <type by_reference="false">array</type>
        </tag>
        <tag line="671" name="param" description="LDAP handle (optional for admin interface pages)" type="\handle" variable="$handle">
          <type by_reference="false">\handle</type>
        </tag>
        <tag line="671" name="return" description="attributes or null if not found" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="679">
        <name>$dn</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="679">
        <name>$attributes</name>
        <default><![CDATA[array('dn')]]></default>
        <type/>
      </argument>
      <argument line="679">
        <name>$handle</name>
        <default><![CDATA[null]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="701" package="lib">
      <name>getLastLDAPError</name>
      <full_name>\getLastLDAPError</full_name>
      <docblock line="696">
        <description><![CDATA[Returns the parameters for a StatusMessage of the last LDAP search.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="696" name="return" description="parameters for StatusMessage or null if all was ok" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
    </function>
    <function namespace="global" line="730" package="lib">
      <name>cleanLDAPResult</name>
      <full_name>\cleanLDAPResult</full_name>
      <docblock line="724">
        <description><![CDATA[Cleans the result of an LDAP search.]]></description>
        <long-description><![CDATA[<p>This will remove all 'count' entries and also all numeric array keys.</p>]]></long-description>
        <tag line="724" name="param" description="LDAP entries in format $entries[entry number][attribute name][attribute values]" type="array" variable="$entries">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="730">
        <name>$entries</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="761" package="lib">
      <name>getAbstractDN</name>
      <full_name>\getAbstractDN</full_name>
      <docblock line="754">
        <description><![CDATA[Transforms a DN into a more user friendly format.]]></description>
        <long-description><![CDATA[<p>E.g. "dc=company,dc=de" is transformed to "company > de".</p>]]></long-description>
        <tag line="754" name="param" description="DN" type="String" variable="$dn">
          <type by_reference="false">String</type>
        </tag>
        <tag line="754" name="return" description="transformed DN" type="String">
          <type by_reference="false">String</type>
        </tag>
      </docblock>
      <argument line="761">
        <name>$dn</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="782" package="lib">
      <name>compareDN</name>
      <full_name>\compareDN</full_name>
      <docblock line="775">
        <description><![CDATA[Helper function to sort DNs.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="775" name="param" description="first argument to compare" type="string" variable="$a">
          <type by_reference="false">string</type>
        </tag>
        <tag line="775" name="param" description="second argument to compare" type="string" variable="$b">
          <type by_reference="false">string</type>
        </tag>
        <tag line="775" name="return" description="0 if equal, 1 if $a is greater, -1 if $b is greater" type="integer">
          <type by_reference="false">integer</type>
        </tag>
      </docblock>
      <argument line="782">
        <name>$a</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="782">
        <name>$b</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="816" package="lib">
      <name>formatLDAPTimestamp</name>
      <full_name>\formatLDAPTimestamp</full_name>
      <docblock line="810">
        <description><![CDATA[Formats an LDAP time string (e.g.]]></description>
        <long-description><![CDATA[<p>from createTimestamp).</p>]]></long-description>
        <tag line="810" name="param" description="LDAP time value" type="String" variable="$time">
          <type by_reference="false">String</type>
        </tag>
        <tag line="810" name="return" description="formated time" type="String">
          <type by_reference="false">String</type>
        </tag>
      </docblock>
      <argument line="816">
        <name>$time</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="826" package="lib">
      <name>obfuscateText</name>
      <full_name>\obfuscateText</full_name>
      <docblock line="821">
        <description><![CDATA[Simple function to obfuscate strings.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="821" name="param" description="text to obfuscate" type="String" variable="$text">
          <type by_reference="false">String</type>
        </tag>
      </docblock>
      <argument line="826">
        <name>$text</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="838" package="lib">
      <name>deobfuscateText</name>
      <full_name>\deobfuscateText</full_name>
      <docblock line="833">
        <description><![CDATA[Simple function to deobfuscate strings.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="833" name="param" description="text to deobfuscate" type="String" variable="$text">
          <type by_reference="false">String</type>
        </tag>
      </docblock>
      <argument line="838">
        <name>$text</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="851" package="lib">
      <name>isObfuscatedText</name>
      <full_name>\isObfuscatedText</full_name>
      <docblock line="845">
        <description><![CDATA[Checks if the given text is obfuscated.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="845" name="param" description="text to check" type="String" variable="$text">
          <type by_reference="false">String</type>
        </tag>
        <tag line="845" name="return" description="obfuscated or not" type="boolean">
          <type by_reference="false">boolean</type>
        </tag>
      </docblock>
      <argument line="851">
        <name>$text</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="870" package="lib">
      <name>extractRDNAttribute</name>
      <full_name>\extractRDNAttribute</full_name>
      <docblock line="864">
        <description><![CDATA[Extracts the RDN attribute name from a given DN.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="864" name="param" description="DN" type="String" variable="$dn">
          <type by_reference="false">String</type>
        </tag>
        <tag line="864" name="return" description="RDN attribute name" type="String">
          <type by_reference="false">String</type>
        </tag>
      </docblock>
      <argument line="870">
        <name>$dn</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="882" package="lib">
      <name>extractRDNValue</name>
      <full_name>\extractRDNValue</full_name>
      <docblock line="876">
        <description><![CDATA[Extracts the RDN attribute value from a given DN.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="876" name="param" description="DN" type="String" variable="$dn">
          <type by_reference="false">String</type>
        </tag>
        <tag line="876" name="return" description="RDN attribute value" type="String">
          <type by_reference="false">String</type>
        </tag>
      </docblock>
      <argument line="882">
        <name>$dn</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="895" package="lib">
      <name>extractDNSuffix</name>
      <full_name>\extractDNSuffix</full_name>
      <docblock line="888">
        <description><![CDATA[Extracts the DN suffix from a given DN.]]></description>
        <long-description><![CDATA[<p>E.g. ou=people,dc=test,dc=com will result in dc=test,dc=com.</p>]]></long-description>
        <tag line="888" name="param" description="DN" type="String" variable="$dn">
          <type by_reference="false">String</type>
        </tag>
        <tag line="888" name="return" description="DN suffix" type="String">
          <type by_reference="false">String</type>
        </tag>
      </docblock>
      <argument line="895">
        <name>$dn</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="908" package="lib">
      <name>sendPasswordMail</name>
      <full_name>\sendPasswordMail</full_name>
      <docblock line="900">
        <description><![CDATA[Sends the password mail.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="900" name="param" description="new password" type="String" variable="$pwd">
          <type by_reference="false">String</type>
        </tag>
        <tag line="900" name="param" description="LDAP attributes of user" type="array" variable="$user">
          <type by_reference="false">array</type>
        </tag>
        <tag line="900" name="param" description="recipient address (optional, $user['mail'][0] used by default)" type="String" variable="$recipient">
          <type by_reference="false">String</type>
        </tag>
        <tag line="900" name="return" description="list of arrays that can be used to create status messages" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="908">
        <name>$pwd</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="908">
        <name>$user</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="908">
        <name>$recipient</name>
        <default><![CDATA[null]]></default>
        <type/>
      </argument>
    </function>
    <class final="false" abstract="false" namespace="global" line="368" package="modules">
      <extends/>
      <name>samba3domain</name>
      <full_name>\samba3domain</full_name>
      <docblock line="363">
        <description><![CDATA[Represents a Samba 3 domain entry]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="363" name="package" description="modules"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="371" namespace="global" package="main">
        <name>$dn</name>
        <default><![CDATA[]]></default>
        <docblock line="370">
          <description><![CDATA[DN]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="374" namespace="global" package="main">
        <name>$name</name>
        <default><![CDATA[]]></default>
        <docblock line="373">
          <description><![CDATA[Domain name]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="377" namespace="global" package="main">
        <name>$SID</name>
        <default><![CDATA[]]></default>
        <docblock line="376">
          <description><![CDATA[Domain SID]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="380" namespace="global" package="main">
        <name>$nextRID</name>
        <default><![CDATA[]]></default>
        <docblock line="379">
          <description><![CDATA[Next RID]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="383" namespace="global" package="main">
        <name>$nextUserRID</name>
        <default><![CDATA[]]></default>
        <docblock line="382">
          <description><![CDATA[Next user RID]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="386" namespace="global" package="main">
        <name>$nextGroupRID</name>
        <default><![CDATA[]]></default>
        <docblock line="385">
          <description><![CDATA[Next group RID]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="389" namespace="global" package="main">
        <name>$RIDbase</name>
        <default><![CDATA[1000]]></default>
        <docblock line="388">
          <description><![CDATA[RID base to calculate RIDs, default 1000]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="392" namespace="global" package="main">
        <name>$minPwdAge</name>
        <default><![CDATA[]]></default>
        <docblock line="391">
          <description><![CDATA[seconds after the password can be changed]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="395" namespace="global" package="main">
        <name>$maxPwdAge</name>
        <default><![CDATA[]]></default>
        <docblock line="394">
          <description><![CDATA[seconds after the password must be changed]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
    </class>
    <class final="false" abstract="false" namespace="global" line="974" package="main">
      <extends/>
      <name>moduleCache</name>
      <full_name>\moduleCache</full_name>
      <docblock line="968">
        <description><![CDATA[Caches module objects.]]></description>
        <long-description><![CDATA[<p>This improves performance if the same module does not need to be created multiple times (calling get_metaData() each time).</p>]]></long-description>
        <tag line="968" name="author" description="Roland Gruber"/>
      </docblock>
      <property final="false" static="true" visibility="private" line="977" namespace="global" package="main">
        <name>$cache</name>
        <default><![CDATA[array()]]></default>
        <docblock line="976">
          <description><![CDATA[module cache ("name:scope" => module)]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="true" visibility="public" namespace="global" line="985" package="main">
        <name>getModule</name>
        <full_name>getModule</full_name>
        <docblock line="979">
          <description><![CDATA[Returns a new/cached module with the given name and scope.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="979" name="param" description="module name" type="String" variable="$name">
            <type by_reference="false">String</type>
          </tag>
          <tag line="979" name="param" description="module scope (e.g. user)" type="String" variable="$scope">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="985">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="985">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="lib/html.inc" hash="331cebdeb3e4a839c123cce7e29d7a1a" package="metaHTML">
    <docblock line="24">
      <description><![CDATA[Interface between modules and other parts of LAM.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="package" description="metaHTML"/>
      <tag line="24" name="author" description="Roland Gruber"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="37" package="metaHTML">
      <extends/>
      <name>htmlElement</name>
      <full_name>\htmlElement</full_name>
      <docblock line="31">
        <description><![CDATA[Represents a HTML element.]]></description>
        <long-description><![CDATA[<p>This is used to build HTML code by using objects.</p>]]></long-description>
        <tag line="31" name="package" description="metaHTML"/>
      </docblock>
      <constant namespace="global" line="40" package="metaHTML">
        <name>ALIGN_TOP</name>
        <full_name>ALIGN_TOP</full_name>
        <value><![CDATA[0]]></value>
        <docblock line="39">
          <description><![CDATA[align to top]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="global" line="42" package="metaHTML">
        <name>ALIGN_LEFT</name>
        <full_name>ALIGN_LEFT</full_name>
        <value><![CDATA[1]]></value>
        <docblock line="41">
          <description><![CDATA[align to left]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="global" line="44" package="metaHTML">
        <name>ALIGN_RIGHT</name>
        <full_name>ALIGN_RIGHT</full_name>
        <value><![CDATA[2]]></value>
        <docblock line="43">
          <description><![CDATA[align to right]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="global" line="46" package="metaHTML">
        <name>ALIGN_BOTTOM</name>
        <full_name>ALIGN_BOTTOM</full_name>
        <value><![CDATA[3]]></value>
        <docblock line="45">
          <description><![CDATA[align to bottom]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="global" line="48" package="metaHTML">
        <name>ALIGN_CENTER</name>
        <full_name>ALIGN_CENTER</full_name>
        <value><![CDATA[4]]></value>
        <docblock line="47">
          <description><![CDATA[align to center]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="global" line="51" package="metaHTML">
        <name>VALIDATE_NUMERIC</name>
        <full_name>VALIDATE_NUMERIC</full_name>
        <value><![CDATA['numeric']]></value>
        <docblock line="50">
          <description><![CDATA[validation rule to allow only numbers ([0-9]+)]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <property final="false" static="false" visibility="public" line="54" namespace="global" package="main">
        <name>$alignment</name>
        <default><![CDATA[null]]></default>
        <docblock line="53">
          <description><![CDATA[alignment when inside a table]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="56" namespace="global" package="main">
        <name>$colspan</name>
        <default><![CDATA[null]]></default>
        <docblock line="55">
          <description><![CDATA[colspan if inside a table]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="58" namespace="global" package="main">
        <name>$rowspan</name>
        <default><![CDATA[null]]></default>
        <docblock line="57">
          <description><![CDATA[rowspan if inside a table]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="60" namespace="global" package="main">
        <name>$cssClasses</name>
        <default><![CDATA[array()]]></default>
        <docblock line="59">
          <description><![CDATA[CSS classes]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="62" namespace="global" package="main">
        <name>$tableCellCssClasses</name>
        <default><![CDATA[array()]]></default>
        <docblock line="61">
          <description><![CDATA[table cell CSS classes]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="true" static="false" visibility="public" namespace="global" line="75" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="64">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="64" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="64" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="64" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="64" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="64" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="64" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="64" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="75">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="75">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="75">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="75">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="75">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="75">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="82" package="metaHTML">
        <name>getAlignmentString</name>
        <full_name>getAlignmentString</full_name>
        <docblock line="77">
          <description><![CDATA[Returns the HTML attributes for the alignment.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="77" name="return" description="alignment HTML attributes (e.g. align=&quot;right&quot; valign=&quot;top&quot;)" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="111" package="metaHTML">
        <name>getColspanString</name>
        <full_name>getColspanString</full_name>
        <docblock line="106">
          <description><![CDATA[Returns the HTML attribute for the colspan.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="106" name="return" description="colspan HTML attribute (e.g. colspan=3)" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="123" package="metaHTML">
        <name>getRowspanString</name>
        <full_name>getRowspanString</full_name>
        <docblock line="118">
          <description><![CDATA[Returns the HTML attribute for the rowspan.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="118" name="return" description="rowspan HTML attribute (e.g. rowspan=3)" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="135" package="metaHTML">
        <name>setCSSClasses</name>
        <full_name>setCSSClasses</full_name>
        <docblock line="130">
          <description><![CDATA[Adds CSS classes to this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="130" name="param" description="CSS class names" type="array" variable="$classes">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="135">
          <name>$classes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="144" package="metaHTML">
        <name>setTableCellCSSClasses</name>
        <full_name>setTableCellCSSClasses</full_name>
        <docblock line="139">
          <description><![CDATA[Adds CSS classes to the surrounding table cell for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="139" name="param" description="CSS class names" type="array" variable="$classes">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="144">
          <name>$classes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="153" package="metaHTML">
        <name>getTableCellCSSClasses</name>
        <full_name>getTableCellCSSClasses</full_name>
        <docblock line="148">
          <description><![CDATA[Returns the CSS classes of the surrounding table cell for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="148" name="return" description="CSS classes" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="164" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlTable</name>
      <full_name>\htmlTable</full_name>
      <docblock line="159">
        <description><![CDATA[Structures elements using a table.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="159" name="package" description="metaHTML"/>
      </docblock>
      <constant namespace="global" line="167" package="metaHTML">
        <name>footer</name>
        <full_name>footer</full_name>
        <value><![CDATA["</table>\n"]]></value>
        <docblock line="166">
          <description><![CDATA[table footer]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="global" line="169" package="metaHTML">
        <name>newLine</name>
        <full_name>newLine</full_name>
        <value><![CDATA["</tr><tr>\n"]]></value>
        <docblock line="168">
          <description><![CDATA[new line]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <property final="false" static="false" visibility="private" line="172" namespace="global" package="main">
        <name>$elements</name>
        <default><![CDATA[array()]]></default>
        <docblock line="171">
          <description><![CDATA[list of subelements]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="174" namespace="global" package="main">
        <name>$rowOpen</name>
        <default><![CDATA[false]]></default>
        <docblock line="173">
          <description><![CDATA[specifies if currently a row is open]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="176" namespace="global" package="main">
        <name>$width</name>
        <default><![CDATA[null]]></default>
        <docblock line="175">
          <description><![CDATA[table width]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="184" package="metaHTML">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="178">
          <description><![CDATA[Constructor]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="178" name="param" description="table width (e.g. 100%)" type="String" variable="$width">
            <type by_reference="false">String</type>
          </tag>
          <tag line="178" name="see" description="\global\htmlElement" refers="\global\htmlElement"/>
        </docblock>
        <argument line="184">
          <name>$width</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="195" package="metaHTML">
        <name>addElement</name>
        <full_name>addElement</full_name>
        <docblock line="188">
          <description><![CDATA[Adds an element to the table.]]></description>
          <long-description><![CDATA[<p>The element may be a htmlElement object or a simple String.</p>]]></long-description>
          <tag line="188" name="param" description="htmlElement object or a simple String" type="mixed" variable="$element">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="188" name="param" description="adds a new line after the element (optional, default false)" type="boolean" variable="$newLine">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="188" name="param" description="specifies if this is a head or body element (default: body)" type="boolean" variable="$isTableHeadElement">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="195">
          <name>$element</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="195">
          <name>$newLine</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
        <argument line="195">
          <name>$isTableHeadElement</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="239" package="metaHTML">
        <name>addNewLine</name>
        <full_name>addNewLine</full_name>
        <docblock line="236">
          <description><![CDATA[Adds another line to the table.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="259" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="248">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="248" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="248" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="248" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="248" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="248" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="248" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="248" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="259">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="259">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="259">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="259">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="259">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="259">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="296" package="metaHTML">
        <name>mergeTableElements</name>
        <full_name>mergeTableElements</full_name>
        <docblock line="291">
          <description><![CDATA[Merges the content of another htmlTable object into this table.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="291" name="param" description="table to get elements" type="\$table" variable="$table">
            <type by_reference="false">\$table</type>
          </tag>
        </docblock>
        <argument line="296">
          <name>$table</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="329" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlTableRow</name>
      <full_name>\htmlTableRow</full_name>
      <docblock line="323">
        <description><![CDATA[A row inside a htmlTable.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="323" name="see" description="\global\htmlTable" refers="\global\htmlTable"/>
        <tag line="323" name="package" description="metaHTML"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="332" namespace="global" package="main">
        <name>$cells</name>
        <default><![CDATA[]]></default>
        <docblock line="331">
          <description><![CDATA[table cells]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="340" package="metaHTML">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="334">
          <description><![CDATA[Constructor]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="334" name="param" description="list of htmlElements" type="array" variable="$cells">
            <type by_reference="false">array</type>
          </tag>
          <tag line="334" name="see" description="\global\htmlElement" refers="\global\htmlElement"/>
        </docblock>
        <argument line="340">
          <name>$cells</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="355" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="344">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="344" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="344" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="344" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="344" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="344" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="344" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="344" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="355">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="355">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="355">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="355">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="355">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="355">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="382" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlInputField</name>
      <full_name>\htmlInputField</full_name>
      <docblock line="377">
        <description><![CDATA[A standard input field.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="377" name="package" description="metaHTML"/>
      </docblock>
      <property final="false" static="false" visibility="protected" line="385" namespace="global" package="main">
        <name>$fieldName</name>
        <default><![CDATA[]]></default>
        <docblock line="384">
          <description><![CDATA[unique field name]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="387" namespace="global" package="main">
        <name>$fieldValue</name>
        <default><![CDATA[]]></default>
        <docblock line="386">
          <description><![CDATA[field value]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="389" namespace="global" package="main">
        <name>$fieldSize</name>
        <default><![CDATA[30]]></default>
        <docblock line="388">
          <description><![CDATA[field size (default 30)]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="391" namespace="global" package="main">
        <name>$fieldMaxLength</name>
        <default><![CDATA[255]]></default>
        <docblock line="390">
          <description><![CDATA[field max length (default 255)]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="393" namespace="global" package="main">
        <name>$onKeyPress</name>
        <default><![CDATA[null]]></default>
        <docblock line="392">
          <description><![CDATA[on keypress event]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="395" namespace="global" package="main">
        <name>$isPassword</name>
        <default><![CDATA[false]]></default>
        <docblock line="394">
          <description><![CDATA[password field]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="397" namespace="global" package="main">
        <name>$isEnabled</name>
        <default><![CDATA[true]]></default>
        <docblock line="396">
          <description><![CDATA[enabled or disabled]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="399" namespace="global" package="main">
        <name>$obfuscate</name>
        <default><![CDATA[false]]></default>
        <docblock line="398">
          <description><![CDATA[indicates that the value should be saved in obfuscated form]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="401" namespace="global" package="main">
        <name>$transient</name>
        <default><![CDATA[false]]></default>
        <docblock line="400">
          <description><![CDATA[indicates that this field should not automatically be saved in the self service or server profile]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="403" namespace="global" package="main">
        <name>$required</name>
        <default><![CDATA[false]]></default>
        <docblock line="402">
          <description><![CDATA[required field]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="405" namespace="global" package="main">
        <name>$validationRule</name>
        <default><![CDATA[null]]></default>
        <docblock line="404">
          <description><![CDATA[validation rule]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="407" namespace="global" package="main">
        <name>$autocomplete</name>
        <default><![CDATA[false]]></default>
        <docblock line="406">
          <description><![CDATA[enable autocomplete]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="409" namespace="global" package="main">
        <name>$autocompleteMultiValue</name>
        <default><![CDATA[false]]></default>
        <docblock line="408">
          <description><![CDATA[multiple values in one field]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="411" namespace="global" package="main">
        <name>$autocompleteMultiValueSeparatorExp</name>
        <default><![CDATA[null]]></default>
        <docblock line="410">
          <description><![CDATA[separator expression for multiple values in one field]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="413" namespace="global" package="main">
        <name>$autocompleteMultiValueSeparator</name>
        <default><![CDATA[null]]></default>
        <docblock line="412">
          <description><![CDATA[separator for multiple values in one field]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="415" namespace="global" package="main">
        <name>$autocompleteValues</name>
        <default><![CDATA[array()]]></default>
        <docblock line="414">
          <description><![CDATA[autocompletion suggestions]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="417" namespace="global" package="main">
        <name>$autocompleteMinLength</name>
        <default><![CDATA[1]]></default>
        <docblock line="416">
          <description><![CDATA[autocomplete start at this input length]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="419" namespace="global" package="main">
        <name>$showCalendar</name>
        <default><![CDATA[false]]></default>
        <docblock line="418">
          <description><![CDATA[show calendar]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="421" namespace="global" package="main">
        <name>$calendarFormat</name>
        <default><![CDATA['']]></default>
        <docblock line="420">
          <description><![CDATA[calendar format]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="430" package="metaHTML">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="423">
          <description><![CDATA[Constructor]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="423" name="param" description="unique field name" type="String" variable="$fieldName">
            <type by_reference="false">String</type>
          </tag>
          <tag line="423" name="param" description="value of input field (optional)" type="String" variable="$fieldValue">
            <type by_reference="false">String</type>
          </tag>
          <tag line="423" name="param" description="maximum input length" type="String" variable="$fieldSize">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="430">
          <name>$fieldName</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="430">
          <name>$fieldValue</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="430">
          <name>$fieldSize</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="452" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="441">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="441" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="441" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="441" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="441" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="441" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="441" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="441" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="452">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="452">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="452">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="452">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="452">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="452">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="564" package="metaHTML">
        <name>setFieldMaxLength</name>
        <full_name>setFieldMaxLength</full_name>
        <docblock line="559">
          <description><![CDATA[Sets the maximum field length.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="559" name="param" description="length" type="int" variable="$fieldMaxLength">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
        <argument line="564">
          <name>$fieldMaxLength</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="573" package="metaHTML">
        <name>setFieldSize</name>
        <full_name>setFieldSize</full_name>
        <docblock line="568">
          <description><![CDATA[Sets the field size.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="568" name="param" description="size" type="int" variable="$fieldSize">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
        <argument line="573">
          <name>$fieldSize</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="582" package="metaHTML">
        <name>setIsPassword</name>
        <full_name>setIsPassword</full_name>
        <docblock line="577">
          <description><![CDATA[Specifies if this is a password field.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="577" name="param" description="password field" type="boolean" variable="$isPassword">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="582">
          <name>$isPassword</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="591" package="metaHTML">
        <name>setIsEnabled</name>
        <full_name>setIsEnabled</full_name>
        <docblock line="586">
          <description><![CDATA[Specifies if this component is enabled and accepts user modification.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="586" name="param" description="enabled if true" type="boolean" variable="$isEnabled">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="591">
          <name>$isEnabled</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="600" package="metaHTML">
        <name>setObfuscate</name>
        <full_name>setObfuscate</full_name>
        <docblock line="595">
          <description><![CDATA[Specifies if the value should be saved in obfuscated form (e.g.]]></description>
          <long-description><![CDATA[<p>self service profile).</p>]]></long-description>
          <tag line="595" name="param" description="obfuscate value" type="boolean" variable="$obfuscate">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="600">
          <name>$obfuscate</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="609" package="metaHTML">
        <name>setTransient</name>
        <full_name>setTransient</full_name>
        <docblock line="604">
          <description><![CDATA[Specifies that the value should not be automatically saved when used in self service or server profile (default: false).]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="604" name="param" description="transient field" type="boolean" variable="$transient">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="609">
          <name>$transient</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="618" package="metaHTML">
        <name>setRequired</name>
        <full_name>setRequired</full_name>
        <docblock line="613">
          <description><![CDATA[Specifies if the input field is required.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="613" name="param" description="required" type="boolean" variable="$required">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="618">
          <name>$required</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="628" package="metaHTML">
        <name>setValidationRule</name>
        <full_name>setValidationRule</full_name>
        <docblock line="622">
          <description><![CDATA[Specifies the validation rule (e.g.]]></description>
          <long-description><![CDATA[<p>htmlElement::VALIDATE_NUMERIC) for this field.
This rule is checked on client side when the input field looses focus.</p>]]></long-description>
          <tag line="622" name="param" description="rule name" type="boolean" variable="$rule">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="628">
          <name>$rule</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="641" package="metaHTML">
        <name>enableAutocompletion</name>
        <full_name>enableAutocompletion</full_name>
        <docblock line="632">
          <description><![CDATA[Enables autocompletion for this input field.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="632" name="param" description="list of values to suggest" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="632" name="param" description="autocompletion starts after this number of caracters entered (default 1; 0 means immediate start)" type="int" variable="$minLength">
            <type by_reference="false">int</type>
          </tag>
          <tag line="632" name="param" description="allow multiple autocompletion values in the same fields (default: false)" type="boolean" variable="$multiValue">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="632" name="param" description="separator expression if multiple autocompletion values are allowed (default &quot;,\s*&quot;)" type="String" variable="$multiSeparator">
            <type by_reference="false">String</type>
          </tag>
          <tag line="632" name="param" description="separator for two values (default &quot;, &quot;)" type="String" variable="$multiSeparator">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="641">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="641">
          <name>$minLength</name>
          <default><![CDATA[1]]></default>
          <type/>
        </argument>
        <argument line="641">
          <name>$multiValue</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
        <argument line="641">
          <name>$multiSeparatorExp</name>
          <default><![CDATA[',\s*']]></default>
          <type/>
        </argument>
        <argument line="641">
          <name>$multiSeparator</name>
          <default><![CDATA[', ']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="658" package="metaHTML">
        <name>setOnKeyPress</name>
        <full_name>setOnKeyPress</full_name>
        <docblock line="653">
          <description><![CDATA[Sets the JavaScript for the onKeyPress event.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="653" name="param" description="JavaScript code" type="String" variable="$onKeyPress">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="658">
          <name>$onKeyPress</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="667" package="metaHTML">
        <name>showCalendar</name>
        <full_name>showCalendar</full_name>
        <docblock line="662">
          <description><![CDATA[Shows a calendar when the field is selected.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="662" name="param" description="calendar format (e.g. yyyy-mm-dd)" type="String" variable="$format">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="667">
          <name>$format</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="679" package="metaHTML">
      <extends>\htmlInputField</extends>
      <name>htmlTableExtendedInputField</name>
      <full_name>\htmlTableExtendedInputField</full_name>
      <docblock line="674">
        <description><![CDATA[An extended input field that combines label, input field and help.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="674" name="package" description="metaHTML"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="682" namespace="global" package="main">
        <name>$label</name>
        <default><![CDATA[]]></default>
        <docblock line="681">
          <description><![CDATA[Descriptive label]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="684" namespace="global" package="main">
        <name>$helpID</name>
        <default><![CDATA[]]></default>
        <docblock line="683">
          <description><![CDATA[help ID]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="694" package="metaHTML">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="686">
          <description><![CDATA[Constructor]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="686" name="param" description="descriptive label" type="String" variable="$label">
            <type by_reference="false">String</type>
          </tag>
          <tag line="686" name="param" description="unique field name" type="String" variable="$fieldName">
            <type by_reference="false">String</type>
          </tag>
          <tag line="686" name="param" description="value of input field (optional)" type="String" variable="$fieldValue">
            <type by_reference="false">String</type>
          </tag>
          <tag line="686" name="param" description="help ID (optional)" type="String" variable="$helpID">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="694">
          <name>$label</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="694">
          <name>$fieldName</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="694">
          <name>$fieldValue</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="694">
          <name>$helpID</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="711" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="700">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="700" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="700" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="700" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="700" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="700" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="700" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="700" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="711">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="711">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="711">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="711">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="711">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="711">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="740" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlHelpLink</name>
      <full_name>\htmlHelpLink</full_name>
      <docblock line="735">
        <description><![CDATA[Renders a help link.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="735" name="package" description="metaHTML"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="743" namespace="global" package="main">
        <name>$helpID</name>
        <default><![CDATA[]]></default>
        <docblock line="742">
          <description><![CDATA[help ID]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="745" namespace="global" package="main">
        <name>$module</name>
        <default><![CDATA[]]></default>
        <docblock line="744">
          <description><![CDATA[module name if it should be forced]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="747" namespace="global" package="main">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <docblock line="746">
          <description><![CDATA[account type if it should be forced]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="756" package="metaHTML">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="749">
          <description><![CDATA[Constructor]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="749" name="param" description="help ID" type="String" variable="$helpID">
            <type by_reference="false">String</type>
          </tag>
          <tag line="749" name="param" description="module name (optional, only if value from generateHTML() should be overwritten)" type="String" variable="$module">
            <type by_reference="false">String</type>
          </tag>
          <tag line="749" name="param" description="account type (e.g. user) (optional, only if value from generateHTML() should be overwritten)" type="String" variable="$scope">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="756">
          <name>$helpID</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="756">
          <name>$module</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="756">
          <name>$scope</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="773" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="762">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="762" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="762" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="762" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="762" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="762" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="762" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="762" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="773">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="773">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="773">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="773">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="773">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="773">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="794" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlButton</name>
      <full_name>\htmlButton</full_name>
      <docblock line="789">
        <description><![CDATA[Simple button.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="789" name="package" description="metaHTML"/>
      </docblock>
      <property final="false" static="false" visibility="protected" line="797" namespace="global" package="main">
        <name>$name</name>
        <default><![CDATA[]]></default>
        <docblock line="796">
          <description><![CDATA[button name]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="799" namespace="global" package="main">
        <name>$value</name>
        <default><![CDATA[]]></default>
        <docblock line="798">
          <description><![CDATA[button text or image]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="801" namespace="global" package="main">
        <name>$isImageButton</name>
        <default><![CDATA[]]></default>
        <docblock line="800">
          <description><![CDATA[image button or text button]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="803" namespace="global" package="main">
        <name>$title</name>
        <default><![CDATA[null]]></default>
        <docblock line="802">
          <description><![CDATA[title]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="805" namespace="global" package="main">
        <name>$isEnabled</name>
        <default><![CDATA[true]]></default>
        <docblock line="804">
          <description><![CDATA[enabled or disabled]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="807" namespace="global" package="main">
        <name>$iconClass</name>
        <default><![CDATA[null]]></default>
        <docblock line="806">
          <description><![CDATA[icon class (CSS) for buttons with icon + text]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="809" namespace="global" package="main">
        <name>$onClick</name>
        <default><![CDATA[null]]></default>
        <docblock line="808">
          <description><![CDATA[onclick event]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="818" package="metaHTML">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="811">
          <description><![CDATA[Constructor.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="811" name="param" description="button name" type="String" variable="$name">
            <type by_reference="false">String</type>
          </tag>
          <tag line="811" name="param" description="button text or image (16x16px, relative to graphics folder)" type="String" variable="$value">
            <type by_reference="false">String</type>
          </tag>
          <tag line="811" name="param" description="image or text button (default text)" type="String" variable="$isImageButton">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="818">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="818">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="818">
          <name>$isImageButton</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="835" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="824">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="824" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="824" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="824" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="824" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="824" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="824" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="824" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="835">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="835">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="835">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="835">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="835">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="835">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="897" package="metaHTML">
        <name>setTitle</name>
        <full_name>setTitle</full_name>
        <docblock line="892">
          <description><![CDATA[Sets the button title (tooltip).]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="892" name="param" description="title" type="String" variable="$title">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="897">
          <name>$title</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="906" package="metaHTML">
        <name>setIsEnabled</name>
        <full_name>setIsEnabled</full_name>
        <docblock line="901">
          <description><![CDATA[Specifies if this component is enabled and accepts user modification.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="901" name="param" description="enabled if true" type="boolean" variable="$isEnabled">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="906">
          <name>$isEnabled</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="916" package="metaHTML">
        <name>setIconClass</name>
        <full_name>setIconClass</full_name>
        <docblock line="910">
          <description><![CDATA[Sets an additional icon for a text button.]]></description>
          <long-description><![CDATA[<p>The icon class is a CSS class that specifies the icon image (e.g. "deleteButton" in layout.css).</p>]]></long-description>
          <tag line="910" name="param" description="icon class" type="String" variable="$iconClass">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="916">
          <name>$iconClass</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="926" package="metaHTML">
        <name>setOnClick</name>
        <full_name>setOnClick</full_name>
        <docblock line="920">
          <description><![CDATA[Sets the onclick event code.]]></description>
          <long-description><![CDATA[<p>This makes this button a simple button that does not submit a form.</p>]]></long-description>
          <tag line="920" name="param" description="JS code" type="String" variable="$onClick">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="926">
          <name>$onClick</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="938" package="metaHTML">
      <extends>\htmlButton</extends>
      <name>htmlAccountPageButton</name>
      <full_name>\htmlAccountPageButton</full_name>
      <docblock line="933">
        <description><![CDATA[Prints a button for the account pages.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="933" name="package" description="metaHTML"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="949" package="metaHTML">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="940">
          <description><![CDATA[Constructor]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="940" name="param" description="module name which renders next page" type="String" variable="$targetModule">
            <type by_reference="false">String</type>
          </tag>
          <tag line="940" name="param" description="name of next page" type="String" variable="$targetPage">
            <type by_reference="false">String</type>
          </tag>
          <tag line="940" name="param" description="identifier for button" type="String" variable="$identifier">
            <type by_reference="false">String</type>
          </tag>
          <tag line="940" name="param" description="button text or image (16x16px, relative to graphics folder)" type="String" variable="$value">
            <type by_reference="false">String</type>
          </tag>
          <tag line="940" name="param" description="image or text button (default text)" type="String" variable="$isImageButton">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="949">
          <name>$targetModule</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="949">
          <name>$targetPage</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="949">
          <name>$identifier</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="949">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="949">
          <name>$isImageButton</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="962" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlSelect</name>
      <full_name>\htmlSelect</full_name>
      <docblock line="957">
        <description><![CDATA[Represents a select box.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="957" name="package" description="metaHTML"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="965" namespace="global" package="main">
        <name>$name</name>
        <default><![CDATA[]]></default>
        <docblock line="964">
          <description><![CDATA[name of select field]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="967" namespace="global" package="main">
        <name>$size</name>
        <default><![CDATA[]]></default>
        <docblock line="966">
          <description><![CDATA[size]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="969" namespace="global" package="main">
        <name>$multiSelect</name>
        <default><![CDATA[false]]></default>
        <docblock line="968">
          <description><![CDATA[allows multi-selection]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="971" namespace="global" package="main">
        <name>$elements</name>
        <default><![CDATA[]]></default>
        <docblock line="970">
          <description><![CDATA[elements]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="973" namespace="global" package="main">
        <name>$selectedElements</name>
        <default><![CDATA[array()]]></default>
        <docblock line="972">
          <description><![CDATA[selected elements]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="975" namespace="global" package="main">
        <name>$hasDescriptiveElements</name>
        <default><![CDATA[false]]></default>
        <docblock line="974">
          <description><![CDATA[descriptive elements]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="977" namespace="global" package="main">
        <name>$containsOptgroups</name>
        <default><![CDATA[false]]></default>
        <docblock line="976">
          <description><![CDATA[contains optgroups]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="979" namespace="global" package="main">
        <name>$sortElements</name>
        <default><![CDATA[true]]></default>
        <docblock line="978">
          <description><![CDATA[sorting enabled]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="981" namespace="global" package="main">
        <name>$rightToLeftTextDirection</name>
        <default><![CDATA[false]]></default>
        <docblock line="980">
          <description><![CDATA[right to left text direction]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="983" namespace="global" package="main">
        <name>$isEnabled</name>
        <default><![CDATA[true]]></default>
        <docblock line="982">
          <description><![CDATA[enabled or disabled]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="985" namespace="global" package="main">
        <name>$width</name>
        <default><![CDATA['']]></default>
        <docblock line="984">
          <description><![CDATA[width of input element]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="987" namespace="global" package="main">
        <name>$transformSingleSelect</name>
        <default><![CDATA[true]]></default>
        <docblock line="986">
          <description><![CDATA[transform select boxes with one element to text]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="989" namespace="global" package="main">
        <name>$onchangeEvent</name>
        <default><![CDATA[null]]></default>
        <docblock line="988">
          <description><![CDATA[onchange event]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="991" namespace="global" package="main">
        <name>$transient</name>
        <default><![CDATA[false]]></default>
        <docblock line="990">
          <description><![CDATA[indicates that this field should not automatically be saved in the self service or server profile]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="993" namespace="global" package="main">
        <name>$tableRowsToHide</name>
        <default><![CDATA[array()]]></default>
        <docblock line="992">
          <description><![CDATA[list of enclosing table rows to hide when checked]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="995" namespace="global" package="main">
        <name>$tableRowsToShow</name>
        <default><![CDATA[array()]]></default>
        <docblock line="994">
          <description><![CDATA[list of enclosing table rows to show when checked]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1016" package="metaHTML">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="997">
          <description><![CDATA[Constructor.]]></description>
          <long-description><![CDATA[<p><br>Examples:
<br>
<br>$select = new htmlSelect('myName', array('value1', 'value2'), array('value1'));
<br>
<br>$select = new htmlSelect('myName', array('label1' => 'value1', 'label2' => 'value2'), array('value1'));
<br>$select->setHasDescriptiveElements(true);
<br>
<br>$select = new htmlSelect('myName', array('optgroupLabel' => array('value1', 'value2')), array('value1'));
<br>$select->setHasDescriptiveElements(true);
<br>$select->setContainsOptgroups(true);</p>]]></long-description>
          <tag line="997" name="param" description="element name" type="String" variable="$name">
            <type by_reference="false">String</type>
          </tag>
          <tag line="997" name="param" description="list of elements array(label =&gt; value) or array(value1, value2) or array('optgroup' =&gt; array(...))" type="array" variable="$elements">
            <type by_reference="false">array</type>
          </tag>
          <tag line="997" name="param" description="list of selected elements (optional, default none)" type="array" variable="$selectedElements">
            <type by_reference="false">array</type>
          </tag>
          <tag line="997" name="param" description="size (optional, default = 1)" type="int" variable="$size">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
        <argument line="1016">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1016">
          <name>$elements</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1016">
          <name>$selectedElements</name>
          <default><![CDATA[array()]]></default>
          <type/>
        </argument>
        <argument line="1016">
          <name>$size</name>
          <default><![CDATA[1]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1036" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="1025">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1025" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1025" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1025" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1025" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="1025" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="1025" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1025" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1036">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1036">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1036">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1036">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1036">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1036">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1123" package="metaHTML">
        <name>printOptionsHTML</name>
        <full_name>printOptionsHTML</full_name>
        <docblock line="1118">
          <description><![CDATA[Prints the HTML code of the option tags.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1118" name="param" description="list of options" type="array" variable="$elements">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1123">
          <name>$elements</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1161" package="metaHTML">
        <name>setHasDescriptiveElements</name>
        <full_name>setHasDescriptiveElements</full_name>
        <docblock line="1156">
          <description><![CDATA[Specifies if the elements are just a simple list or an assoziative array (default: simple list).]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1156" name="param" description="activates descriptive elements" type="boolean" variable="$hasDescriptiveElements">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1161">
          <name>$hasDescriptiveElements</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1170" package="metaHTML">
        <name>setContainsOptgroups</name>
        <full_name>setContainsOptgroups</full_name>
        <docblock line="1165">
          <description><![CDATA[Specifies if the elements are divided into optgroups.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1165" name="param" description="activates optgroups" type="boolean" variable="$containsOptgroups">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1170">
          <name>$containsOptgroups</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1179" package="metaHTML">
        <name>setMultiSelect</name>
        <full_name>setMultiSelect</full_name>
        <docblock line="1174">
          <description><![CDATA[Specifies if multi-selection is enabled (default: disabled).]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1174" name="param" description="allows multi-selection" type="boolean" variable="$multiSelect">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1179">
          <name>$multiSelect</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1188" package="metaHTML">
        <name>setSortElements</name>
        <full_name>setSortElements</full_name>
        <docblock line="1183">
          <description><![CDATA[Specifies if the elemets should be sorted (default: sort).]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1183" name="param" description="sort elements" type="boolean" variable="$sortElements">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1188">
          <name>$sortElements</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1197" package="metaHTML">
        <name>setRightToLeftTextDirection</name>
        <full_name>setRightToLeftTextDirection</full_name>
        <docblock line="1192">
          <description><![CDATA[Specifies if the text direction should be set to right to left.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1192" name="param" description="if true use right to left direction" type="boolean" variable="$rightToLeftTextDirection">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1197">
          <name>$rightToLeftTextDirection</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1206" package="metaHTML">
        <name>setIsEnabled</name>
        <full_name>setIsEnabled</full_name>
        <docblock line="1201">
          <description><![CDATA[Specifies if this component is enabled and accepts user modification.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1201" name="param" description="enabled if true" type="boolean" variable="$isEnabled">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1206">
          <name>$isEnabled</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1215" package="metaHTML">
        <name>setWidth</name>
        <full_name>setWidth</full_name>
        <docblock line="1210">
          <description><![CDATA[Specifies the width of this selection box.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1210" name="param" description="width (e.g. 20em)" type="String" variable="$width">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1215">
          <name>$width</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1224" package="metaHTML">
        <name>setTransformSingleSelect</name>
        <full_name>setTransformSingleSelect</full_name>
        <docblock line="1219">
          <description><![CDATA[Specifies if select boxes that contain only a single element should be transformed to a simple text field.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1219" name="param" description="transform single options to text" type="boolean" variable="$transformSingleSelect">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1224">
          <name>$transformSingleSelect</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1233" package="metaHTML">
        <name>setOnchangeEvent</name>
        <full_name>setOnchangeEvent</full_name>
        <docblock line="1228">
          <description><![CDATA[Sets the JavaScript code for the onchange event.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1228" name="param" description="onchange event code (e.g. myfunction();)" type="String" variable="$onchangeEvent">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1233">
          <name>$onchangeEvent</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1242" package="metaHTML">
        <name>setTransient</name>
        <full_name>setTransient</full_name>
        <docblock line="1237">
          <description><![CDATA[Specifies that the value should not be automatically saved when used in self service or server profile (default: false).]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1237" name="param" description="transient field" type="boolean" variable="$transient">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1242">
          <name>$transient</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1260" package="metaHTML">
        <name>setTableRowsToHide</name>
        <full_name>setTableRowsToHide</full_name>
        <docblock line="1246">
          <description><![CDATA[This will hide the given table rows when the select is changed to the specified value.]]></description>
          <long-description><![CDATA[<p>The given IDs can be of any e.g. input element. Starting from this element
the first parent "<tr>" element will be used to show/hide.
<br>
<br>
<br>Example: <tr><td><input type="checkbox" id="mycheckbox"></td></tr>
<br> Using "mycheckbox" will use this "tr" to hide/show.
<br>
<br> Example for $tableRowsToHide:
<br> array('yes' => array('option1', 'option2'), 'no' => array('option3'))</p>]]></long-description>
          <tag line="1246" name="param" description="array of select value =&gt; array of IDs of child elements to hide" type="array" variable="$tableRowsToHide">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1260">
          <name>$tableRowsToHide</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1278" package="metaHTML">
        <name>setTableRowsToShow</name>
        <full_name>setTableRowsToShow</full_name>
        <docblock line="1264">
          <description><![CDATA[This will show the given table rows when the select is changed to the specified value.]]></description>
          <long-description><![CDATA[<p>The given IDs can be of any e.g. input element. Starting from this element
the first parent "<tr>" element will be used to show/hide.
<br>
<br>
<br>Example: <tr><td><input type="checkbox" id="mycheckbox"></td></tr>
<br> Using "mycheckbox" will use this "tr" to hide/show.
<br>
<br> Example for $tableRowsToShow:
<br> array('yes' => array('option1', 'option2'), 'no' => array('option3'))</p>]]></long-description>
          <tag line="1264" name="param" description="array of select value =&gt; array of IDs of child elements to show" type="array" variable="$tableRowsToShow">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1278">
          <name>$tableRowsToShow</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1287" package="metaHTML">
        <name>printCodeForShowHideTableRows</name>
        <full_name>printCodeForShowHideTableRows</full_name>
        <docblock line="1282">
          <description><![CDATA[Creates the JavaScript code to hide/show table rows based on the select value.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1282" name="param" description="onChange code" type="String" variable="$onChange">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1287">
          <name>$onChange</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="1339" package="metaHTML">
      <extends>\htmlSelect</extends>
      <name>htmlTableExtendedSelect</name>
      <full_name>\htmlTableExtendedSelect</full_name>
      <docblock line="1334">
        <description><![CDATA[Select with label and help link.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="1334" name="package" description="metaHTML"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="1342" namespace="global" package="main">
        <name>$label</name>
        <default><![CDATA[]]></default>
        <docblock line="1341">
          <description><![CDATA[descriptive label]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="1344" namespace="global" package="main">
        <name>$helpID</name>
        <default><![CDATA[]]></default>
        <docblock line="1343">
          <description><![CDATA[help ID]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1356" package="metaHTML">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="1346">
          <description><![CDATA[Constructor.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1346" name="param" description="element name" type="String" variable="$name">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1346" name="param" description="list of elememts" type="array" variable="$elements">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1346" name="param" description="list of selected elements" type="array" variable="$selectedElements">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1346" name="param" description="descriptive label" type="String" variable="$label">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1346" name="param" description="help ID (optional, default none)" type="String" variable="$helpID">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1346" name="param" description="size (optional, default = 1)" type="int" variable="$size">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
        <argument line="1356">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1356">
          <name>$elements</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1356">
          <name>$selectedElements</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1356">
          <name>$label</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1356">
          <name>$helpID</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="1356">
          <name>$size</name>
          <default><![CDATA[1]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1373" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="1362">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1362" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1362" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1362" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1362" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="1362" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="1362" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1362" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1373">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1373">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1373">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1373">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1373">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1373">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="1395" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlRadio</name>
      <full_name>\htmlRadio</full_name>
      <docblock line="1390">
        <description><![CDATA[Represents a radio selection.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="1390" name="package" description="metaHTML"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="1398" namespace="global" package="main">
        <name>$name</name>
        <default><![CDATA[]]></default>
        <docblock line="1397">
          <description><![CDATA[name of select field]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="1400" namespace="global" package="main">
        <name>$elements</name>
        <default><![CDATA[]]></default>
        <docblock line="1399">
          <description><![CDATA[elements]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="1402" namespace="global" package="main">
        <name>$selectedElement</name>
        <default><![CDATA[null]]></default>
        <docblock line="1401">
          <description><![CDATA[selected element]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="1404" namespace="global" package="main">
        <name>$isEnabled</name>
        <default><![CDATA[true]]></default>
        <docblock line="1403">
          <description><![CDATA[enabled or disabled]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="1406" namespace="global" package="main">
        <name>$onchangeEvent</name>
        <default><![CDATA[null]]></default>
        <docblock line="1405">
          <description><![CDATA[on change code]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1419" package="metaHTML">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="1408">
          <description><![CDATA[Constructor.]]></description>
          <long-description><![CDATA[<p><br>Examples:
<br>
<br>$radio = new htmlRadio('myName', array('label1' => 'value1', 'label2' => 'value2'), array('value1'));</p>]]></long-description>
          <tag line="1408" name="param" description="element name" type="String" variable="$name">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1408" name="param" description="list of elements array(label =&gt; value)" type="array" variable="$elements">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1408" name="param" description="value of selected element (optional, default none)" type="String" variable="$selectedElement">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1419">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1419">
          <name>$elements</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1419">
          <name>$selectedElement</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1438" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="1427">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1427" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1427" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1427" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1427" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="1427" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="1427" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1427" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1438">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1438">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1438">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1438">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1438">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1438">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1480" package="metaHTML">
        <name>setIsEnabled</name>
        <full_name>setIsEnabled</full_name>
        <docblock line="1475">
          <description><![CDATA[Specifies if this component is enabled and accepts user modification.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1475" name="param" description="enabled if true" type="boolean" variable="$isEnabled">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1480">
          <name>$isEnabled</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1489" package="metaHTML">
        <name>setOnchangeEvent</name>
        <full_name>setOnchangeEvent</full_name>
        <docblock line="1484">
          <description><![CDATA[Sets the JavaScript code for the onchange event.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1484" name="param" description="onchange event code (e.g. myfunction();)" type="String" variable="$onchangeEvent">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1489">
          <name>$onchangeEvent</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="1500" package="metaHTML">
      <extends>\htmlRadio</extends>
      <name>htmlTableExtendedRadio</name>
      <full_name>\htmlTableExtendedRadio</full_name>
      <docblock line="1495">
        <description><![CDATA[Radio list with descriptive label and help link.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="1495" name="package" description="metaHTML"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="1503" namespace="global" package="main">
        <name>$label</name>
        <default><![CDATA[]]></default>
        <docblock line="1502">
          <description><![CDATA[descriptive label]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="1505" namespace="global" package="main">
        <name>$helpID</name>
        <default><![CDATA[]]></default>
        <docblock line="1504">
          <description><![CDATA[help ID]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1516" package="metaHTML">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="1507">
          <description><![CDATA[Constructor.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1507" name="param" description="descriptive label" type="String" variable="$label">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1507" name="param" description="element name" type="String" variable="$name">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1507" name="param" description="list of elements array(label =&gt; value)" type="array" variable="$elements">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1507" name="param" description="value of selected element (optional, default none)" type="String" variable="$selectedElement">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1507" name="param" description="help ID" type="String" variable="$helpID">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1516">
          <name>$label</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1516">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1516">
          <name>$elements</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1516">
          <name>$selectedElement</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="1516">
          <name>$helpID</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1534" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="1523">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1523" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1523" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1523" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1523" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="1523" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="1523" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1523" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1534">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1534">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1534">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1534">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1534">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1534">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="1558" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlOutputText</name>
      <full_name>\htmlOutputText</full_name>
      <docblock line="1553">
        <description><![CDATA[Prints the text and escapes contained HTML code by default.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="1553" name="package" description="metaHTML"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="1561" namespace="global" package="main">
        <name>$string</name>
        <default><![CDATA[]]></default>
        <docblock line="1560">
          <description><![CDATA[the text to print]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="1563" namespace="global" package="main">
        <name>$escapeHTML</name>
        <default><![CDATA[]]></default>
        <docblock line="1562">
          <description><![CDATA[specifies if HTML code should be escaped]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="1565" namespace="global" package="main">
        <name>$isBold</name>
        <default><![CDATA[false]]></default>
        <docblock line="1564">
          <description><![CDATA[bold text]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="1567" namespace="global" package="main">
        <name>$markAsRequired</name>
        <default><![CDATA[false]]></default>
        <docblock line="1566">
          <description><![CDATA[mark as required]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="1569" namespace="global" package="main">
        <name>$noWrap</name>
        <default><![CDATA[false]]></default>
        <docblock line="1568">
          <description><![CDATA[no wrap]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1577" package="metaHTML">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="1571">
          <description><![CDATA[Constructor.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1571" name="param" description="output text" type="String" variable="$string">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1571" name="param" description="escape HTML code (default yes)" type="boolean" variable="$escapeHTML">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1577">
          <name>$string</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1577">
          <name>$escapeHTML</name>
          <default><![CDATA[true]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1593" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="1582">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1582" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1582" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1582" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1582" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="1582" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="1582" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1582" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1593">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1593">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1593">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1593">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1593">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1593">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1625" package="metaHTML">
        <name>setIsBold</name>
        <full_name>setIsBold</full_name>
        <docblock line="1620">
          <description><![CDATA[Specifies if the whole text should be printed in bold.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1620" name="param" description="bold text" type="boolean" variable="$isBold">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1625">
          <name>$isBold</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1634" package="metaHTML">
        <name>setMarkAsRequired</name>
        <full_name>setMarkAsRequired</full_name>
        <docblock line="1629">
          <description><![CDATA[Adds a marker that indicates a required field.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1629" name="param" description="add marker" type="boolean" variable="$markAsRequired">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1634">
          <name>$markAsRequired</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1643" package="metaHTML">
        <name>setNoWrap</name>
        <full_name>setNoWrap</full_name>
        <docblock line="1638">
          <description><![CDATA[Specifies if word wrap is allowed for this text.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1638" name="param" description="no wrapping if set to true (default false)" type="boolean" variable="$noWrap">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1643">
          <name>$noWrap</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="1654" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlInputCheckbox</name>
      <full_name>\htmlInputCheckbox</full_name>
      <docblock line="1649">
        <description><![CDATA[Prints the HTML code for a checkbox.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="1649" name="package" description="metaHTML"/>
      </docblock>
      <property final="false" static="false" visibility="protected" line="1657" namespace="global" package="main">
        <name>$name</name>
        <default><![CDATA[]]></default>
        <docblock line="1656">
          <description><![CDATA[unique name of input element]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="1659" namespace="global" package="main">
        <name>$checked</name>
        <default><![CDATA[]]></default>
        <docblock line="1658">
          <description><![CDATA[value]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="1661" namespace="global" package="main">
        <name>$isEnabled</name>
        <default><![CDATA[true]]></default>
        <docblock line="1660">
          <description><![CDATA[enabled or disabled]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="1663" namespace="global" package="main">
        <name>$tableRowsToHide</name>
        <default><![CDATA[array()]]></default>
        <docblock line="1662">
          <description><![CDATA[list of enclosing table rows to hide when checked]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="1665" namespace="global" package="main">
        <name>$tableRowsToShow</name>
        <default><![CDATA[array()]]></default>
        <docblock line="1664">
          <description><![CDATA[list of enclosing table rows to show when checked]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="1667" namespace="global" package="main">
        <name>$transient</name>
        <default><![CDATA[false]]></default>
        <docblock line="1666">
          <description><![CDATA[indicates that this field should not automatically be saved in the self service or server profile]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1676" package="metaHTML">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="1670">
          <description><![CDATA[Constructor.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1670" name="param" description="unique name" type="String" variable="$name">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1670" name="param" description="checked" type="boolean" variable="$checked">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1676">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1676">
          <name>$checked</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1692" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="1681">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1681" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1681" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1681" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1681" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="1681" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="1681" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1681" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1692">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1692">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1692">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1692">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1692">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1692">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1765" package="metaHTML">
        <name>setIsEnabled</name>
        <full_name>setIsEnabled</full_name>
        <docblock line="1760">
          <description><![CDATA[Specifies if this component is enabled and accepts user modification.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1760" name="param" description="enabled if true" type="boolean" variable="$isEnabled">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1765">
          <name>$isEnabled</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1780" package="metaHTML">
        <name>setTableRowsToHide</name>
        <full_name>setTableRowsToHide</full_name>
        <docblock line="1769">
          <description><![CDATA[This will hide the given table rows when the checkbox is checked.]]></description>
          <long-description><![CDATA[<p>The given IDs can be of any e.g. input element. Starting from this element
the first parent "<tr>" element will be used to show/hide.
<br>
<br>
<br>Example: <tr><td><input type="checkbox" id="mycheckbox"></td></tr>
<br> Using "mycheckbox" will use this "tr" to hide/show.</p>]]></long-description>
          <tag line="1769" name="param" description="IDs of child elements to hide" type="array" variable="$tableRowsToHide">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1780">
          <name>$tableRowsToHide</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1795" package="metaHTML">
        <name>setTableRowsToShow</name>
        <full_name>setTableRowsToShow</full_name>
        <docblock line="1784">
          <description><![CDATA[This will show the given table rows when the checkbox is checked.]]></description>
          <long-description><![CDATA[<p>The given IDs can be of any e.g. input element. Starting from this element
the first parent "<tr>" element will be used to show/hide.
<br>
<br>
<br>Example: <tr><td><input type="checkbox" id="mycheckbox"></td></tr>
<br> Using "mycheckbox" will use this "tr" to hide/show.</p>]]></long-description>
          <tag line="1784" name="param" description="IDs of child elements to show" type="array" variable="$tableRowsToShow">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1795">
          <name>$tableRowsToShow</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1804" package="metaHTML">
        <name>setTransient</name>
        <full_name>setTransient</full_name>
        <docblock line="1799">
          <description><![CDATA[Specifies that the value should not be automatically saved when used in self service or server profile (default: false).]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1799" name="param" description="transient field" type="boolean" variable="$transient">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1804">
          <name>$transient</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="1815" package="metaHTML">
      <extends>\htmlInputCheckbox</extends>
      <name>htmlTableExtendedInputCheckbox</name>
      <full_name>\htmlTableExtendedInputCheckbox</full_name>
      <docblock line="1810">
        <description><![CDATA[Checkbox with descriptive label and help link.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="1810" name="package" description="metaHTML"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="1818" namespace="global" package="main">
        <name>$label</name>
        <default><![CDATA[]]></default>
        <docblock line="1817">
          <description><![CDATA[descriptive label]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="1820" namespace="global" package="main">
        <name>$helpID</name>
        <default><![CDATA[]]></default>
        <docblock line="1819">
          <description><![CDATA[help ID]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="1822" namespace="global" package="main">
        <name>$labelFirst</name>
        <default><![CDATA[]]></default>
        <docblock line="1821">
          <description><![CDATA[specifies if label is printed before the checkbox]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1833" package="metaHTML">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="1824">
          <description><![CDATA[Constructor.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1824" name="param" description="unique name" type="String" variable="$name">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1824" name="param" description="checked" type="boolean" variable="$checked">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="1824" name="param" description="descriptive label" type="String" variable="$label">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1824" name="param" description="help ID" type="String" variable="$helpID">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1824" name="param" description="specifies if the label is at the beginning or at the end (optional, default beginning)" type="boolean" variable="$labelFirst">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1833">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1833">
          <name>$checked</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1833">
          <name>$label</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1833">
          <name>$helpID</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="1833">
          <name>$labelFirst</name>
          <default><![CDATA[true]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1851" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="1840">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1840" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1840" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1840" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1840" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="1840" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="1840" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1840" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1851">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1851">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1851">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1851">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1851">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1851">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="1883" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlInputFileUpload</name>
      <full_name>\htmlInputFileUpload</full_name>
      <docblock line="1878">
        <description><![CDATA[Prints the HTML code for a file upload field.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="1878" name="package" description="metaHTML"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="1886" namespace="global" package="main">
        <name>$name</name>
        <default><![CDATA[]]></default>
        <docblock line="1885">
          <description><![CDATA[unique name of input element]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="1888" namespace="global" package="main">
        <name>$isEnabled</name>
        <default><![CDATA[true]]></default>
        <docblock line="1887">
          <description><![CDATA[enabled or disabled]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1895" package="metaHTML">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="1890">
          <description><![CDATA[Constructor.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1890" name="param" description="unique name" type="String" variable="$name">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1895">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1910" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="1899">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1899" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1899" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1899" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1899" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="1899" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="1899" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1899" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1910">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1910">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1910">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1910">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1910">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1910">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1926" package="metaHTML">
        <name>setIsEnabled</name>
        <full_name>setIsEnabled</full_name>
        <docblock line="1921">
          <description><![CDATA[Specifies if this component is enabled and accepts user modification.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1921" name="param" description="enabled if true" type="boolean" variable="$isEnabled">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1926">
          <name>$isEnabled</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="1937" package="metaHTML">
      <extends>\htmlInputFileUpload</extends>
      <name>htmlTableExtendedInputFileUpload</name>
      <full_name>\htmlTableExtendedInputFileUpload</full_name>
      <docblock line="1932">
        <description><![CDATA[File upload with descriptive label and help link.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="1932" name="package" description="metaHTML"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="1940" namespace="global" package="main">
        <name>$label</name>
        <default><![CDATA[]]></default>
        <docblock line="1939">
          <description><![CDATA[descriptive label]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="1942" namespace="global" package="main">
        <name>$helpID</name>
        <default><![CDATA[]]></default>
        <docblock line="1941">
          <description><![CDATA[help ID]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1951" package="metaHTML">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="1944">
          <description><![CDATA[Constructor.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1944" name="param" description="unique name" type="String" variable="$name">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1944" name="param" description="descriptive label" type="String" variable="$label">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1944" name="param" description="help ID" type="String" variable="$helpID">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1951">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1951">
          <name>$label</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1951">
          <name>$helpID</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1968" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="1957">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1957" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1957" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1957" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1957" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="1957" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="1957" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1957" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1968">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1968">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1968">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1968">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1968">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1968">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="1990" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlInputTextarea</name>
      <full_name>\htmlInputTextarea</full_name>
      <docblock line="1985">
        <description><![CDATA[Prints the HTML code for a textarea.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="1985" name="package" description="metaHTML"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="1993" namespace="global" package="main">
        <name>$name</name>
        <default><![CDATA[]]></default>
        <docblock line="1992">
          <description><![CDATA[unique name of input element]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="1995" namespace="global" package="main">
        <name>$value</name>
        <default><![CDATA[]]></default>
        <docblock line="1994">
          <description><![CDATA[value]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="1997" namespace="global" package="main">
        <name>$colCount</name>
        <default><![CDATA[]]></default>
        <docblock line="1996">
          <description><![CDATA[column count]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="1999" namespace="global" package="main">
        <name>$rowCount</name>
        <default><![CDATA[]]></default>
        <docblock line="1998">
          <description><![CDATA[row count]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="2001" namespace="global" package="main">
        <name>$isEnabled</name>
        <default><![CDATA[true]]></default>
        <docblock line="2000">
          <description><![CDATA[enabled or disabled]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="2003" namespace="global" package="main">
        <name>$richEdit</name>
        <default><![CDATA[false]]></default>
        <docblock line="2002">
          <description><![CDATA[specifies if LAM should display this field whith a WYSIWYG editor]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2013" package="metaHTML">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="2005">
          <description><![CDATA[Constructor.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2005" name="param" description="unique name" type="String" variable="$name">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2005" name="param" description="value" type="String" variable="$value">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2005" name="param" description="number of characters per line" type="int" variable="$colCount">
            <type by_reference="false">int</type>
          </tag>
          <tag line="2005" name="param" description="number of rows" type="int" variable="$rowCount">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
        <argument line="2013">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2013">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2013">
          <name>$colCount</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2013">
          <name>$rowCount</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2031" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="2020">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2020" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2020" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2020" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2020" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="2020" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="2020" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2020" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2031">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2031">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2031">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2031">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2031">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2031">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2059" package="metaHTML">
        <name>setIsEnabled</name>
        <full_name>setIsEnabled</full_name>
        <docblock line="2054">
          <description><![CDATA[Specifies if this component is enabled and accepts user modification.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2054" name="param" description="enabled if true" type="boolean" variable="$isEnabled">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="2059">
          <name>$isEnabled</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2070" package="metaHTML">
        <name>setIsRichEdit</name>
        <full_name>setIsRichEdit</full_name>
        <docblock line="2063">
          <description><![CDATA[Specifies if the textarea should be displayed whith a WYSIWYG editor.]]></description>
          <long-description><![CDATA[<p><br>This requires that the page which displays the textarea also includes the ckeditor JS.
<br>Rich editing is disabled by default.</p>]]></long-description>
          <tag line="2063" name="param" description="rich edit or standard" type="boolean" variable="$richEdit">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="2070">
          <name>$richEdit</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="2081" package="metaHTML">
      <extends>\htmlInputTextarea</extends>
      <name>htmlTableExtendedInputTextarea</name>
      <full_name>\htmlTableExtendedInputTextarea</full_name>
      <docblock line="2076">
        <description><![CDATA[Text area with label and help link.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="2076" name="package" description="metaHTML"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="2084" namespace="global" package="main">
        <name>$label</name>
        <default><![CDATA[]]></default>
        <docblock line="2083">
          <description><![CDATA[descriptive label]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="2086" namespace="global" package="main">
        <name>$helpID</name>
        <default><![CDATA[]]></default>
        <docblock line="2085">
          <description><![CDATA[help ID]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="2088" namespace="global" package="main">
        <name>$required</name>
        <default><![CDATA[false]]></default>
        <docblock line="2087">
          <description><![CDATA[required field]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2100" package="metaHTML">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="2090">
          <description><![CDATA[Constructor.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2090" name="param" description="unique name" type="String" variable="$name">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2090" name="param" description="value" type="String" variable="$value">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2090" name="param" description="number of characters per line" type="int" variable="$colCount">
            <type by_reference="false">int</type>
          </tag>
          <tag line="2090" name="param" description="number of rows" type="int" variable="$rowCount">
            <type by_reference="false">int</type>
          </tag>
          <tag line="2090" name="param" description="descriptive label" type="String" variable="$label">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2090" name="param" description="help ID" type="String" variable="$helpID">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="2100">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2100">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2100">
          <name>$colCount</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2100">
          <name>$rowCount</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2100">
          <name>$label</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2100">
          <name>$helpID</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2118" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="2107">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2107" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2107" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2107" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2107" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="2107" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="2107" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2107" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2118">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2118">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2118">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2118">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2118">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2118">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2143" package="metaHTML">
        <name>setRequired</name>
        <full_name>setRequired</full_name>
        <docblock line="2138">
          <description><![CDATA[Specifies if this input field must be filled.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2138" name="param" description="required or not" type="boolean" variable="$required">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="2143">
          <name>$required</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="2154" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlImage</name>
      <full_name>\htmlImage</full_name>
      <docblock line="2149">
        <description><![CDATA[Prints the HTML code for an image.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="2149" name="package" description="metaHTML"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="2157" namespace="global" package="main">
        <name>$path</name>
        <default><![CDATA[]]></default>
        <docblock line="2156">
          <description><![CDATA[path to image]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="2159" namespace="global" package="main">
        <name>$width</name>
        <default><![CDATA[]]></default>
        <docblock line="2158">
          <description><![CDATA[width]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="2161" namespace="global" package="main">
        <name>$height</name>
        <default><![CDATA[]]></default>
        <docblock line="2160">
          <description><![CDATA[height]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="2163" namespace="global" package="main">
        <name>$alt</name>
        <default><![CDATA[]]></default>
        <docblock line="2162">
          <description><![CDATA[alt text]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2173" package="metaHTML">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="2165">
          <description><![CDATA[Constructor.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2165" name="param" description="image location" type="String" variable="$path">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2165" name="param" description="image width (optional, default original size)" type="int" variable="$width">
            <type by_reference="false">int</type>
          </tag>
          <tag line="2165" name="param" description="image height (optional, default original size)" type="int" variable="$height">
            <type by_reference="false">int</type>
          </tag>
          <tag line="2165" name="param" description="alt text (optional)" type="String" variable="$alt">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="2173">
          <name>$path</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2173">
          <name>$width</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="2173">
          <name>$height</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="2173">
          <name>$alt</name>
          <default><![CDATA[' ']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2191" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="2180">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2180" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2180" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2180" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2180" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="2180" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="2180" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2180" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2191">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2191">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2191">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2191">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2191">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2191">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="2213" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlSpacer</name>
      <full_name>\htmlSpacer</full_name>
      <docblock line="2208">
        <description><![CDATA[Adds an empty space with given width and height.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="2208" name="package" description="metaHTML"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="2216" namespace="global" package="main">
        <name>$width</name>
        <default><![CDATA[]]></default>
        <docblock line="2215">
          <description><![CDATA[width of spacer in px]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="2218" namespace="global" package="main">
        <name>$height</name>
        <default><![CDATA[]]></default>
        <docblock line="2217">
          <description><![CDATA[height of spacer in px]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2226" package="metaHTML">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="2220">
          <description><![CDATA[Constructor.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2220" name="param" description="width (e.g. 10px)" type="String" variable="$width">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2220" name="param" description="height (e.g. 10px)" type="String" variable="$height">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="2226">
          <name>$width</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2226">
          <name>$height</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2242" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="2231">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2231" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2231" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2231" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2231" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="2231" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="2231" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2231" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2242">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2242">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2242">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2242">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2242">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2242">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="2262" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlStatusMessage</name>
      <full_name>\htmlStatusMessage</full_name>
      <docblock line="2257">
        <description><![CDATA[Prints a status message (e.g.]]></description>
        <long-description><![CDATA[<p>error message).</p>]]></long-description>
        <tag line="2257" name="package" description="metaHTML"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="2265" namespace="global" package="main">
        <name>$type</name>
        <default><![CDATA[]]></default>
        <docblock line="2264">
          <description><![CDATA[message type (e.g.]]></description>
          <long-description><![CDATA[<p>ERROR)</p>]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="2267" namespace="global" package="main">
        <name>$title</name>
        <default><![CDATA[]]></default>
        <docblock line="2266">
          <description><![CDATA[message title]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="2269" namespace="global" package="main">
        <name>$text</name>
        <default><![CDATA[]]></default>
        <docblock line="2268">
          <description><![CDATA[message text]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="2271" namespace="global" package="main">
        <name>$params</name>
        <default><![CDATA[]]></default>
        <docblock line="2270">
          <description><![CDATA[message parameters]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2281" package="metaHTML">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="2273">
          <description><![CDATA[Constructor.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2273" name="param" description="message type (e.g. ERROR)" type="String" variable="$type">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2273" name="param" description="message title" type="String" variable="$title">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2273" name="param" description="message (optional)" type="String" variable="$text">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2273" name="param" description="additional message parameters" type="array" variable="$params">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2281">
          <name>$type</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2281">
          <name>$title</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2281">
          <name>$text</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="2281">
          <name>$params</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2299" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="2288">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2288" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2288" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2288" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2288" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="2288" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="2288" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2288" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2299">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2299">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2299">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2299">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2299">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2299">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="2311" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlFieldset</name>
      <full_name>\htmlFieldset</full_name>
      <docblock line="2306">
        <description><![CDATA[Generates a fieldset.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="2306" name="package" description="metaHTML"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="2314" namespace="global" package="main">
        <name>$content</name>
        <default><![CDATA[]]></default>
        <docblock line="2313">
          <description><![CDATA[fieldset content]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="2316" namespace="global" package="main">
        <name>$label</name>
        <default><![CDATA[null]]></default>
        <docblock line="2315">
          <description><![CDATA[descriptive label]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="2318" namespace="global" package="main">
        <name>$labelImage</name>
        <default><![CDATA[null]]></default>
        <docblock line="2317">
          <description><![CDATA[label image]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2327" package="metaHTML">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="2320">
          <description><![CDATA[Constructor.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2320" name="param" description="content to display inside fieldset" type="\htmlElement" variable="$content">
            <type by_reference="false">\htmlElement</type>
          </tag>
          <tag line="2320" name="param" description="label" type="String" variable="$label">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2320" name="param" description="image to put before label" type="String" variable="$labelImage">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="2327">
          <name>$content</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2327">
          <name>$label</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="2327">
          <name>$labelImage</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2344" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="2333">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2333" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2333" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2333" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2333" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="2333" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="2333" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2333" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2344">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2344">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2344">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2344">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2344">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2344">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="2373" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlTitle</name>
      <full_name>\htmlTitle</full_name>
      <docblock line="2368">
        <description><![CDATA[Generates a title line.]]></description>
        <long-description><![CDATA[<p>This is used for page titles.</p>]]></long-description>
        <tag line="2368" name="package" description="metaHTML"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="2376" namespace="global" package="main">
        <name>$label</name>
        <default><![CDATA[null]]></default>
        <docblock line="2375">
          <description><![CDATA[descriptive label]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2383" package="metaHTML">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="2378">
          <description><![CDATA[Constructor.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2378" name="param" description="label" type="String" variable="$label">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="2383">
          <name>$label</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2400" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="2389">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2389" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2389" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2389" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2389" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="2389" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="2389" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2389" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2400">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2400">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2400">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2400">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2400">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2400">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="2416" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlSubTitle</name>
      <full_name>\htmlSubTitle</full_name>
      <docblock line="2411">
        <description><![CDATA[Generates a subtitle line.]]></description>
        <long-description><![CDATA[<p>This is used to group multiple fields.</p>]]></long-description>
        <tag line="2411" name="package" description="metaHTML"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="2419" namespace="global" package="main">
        <name>$label</name>
        <default><![CDATA[null]]></default>
        <docblock line="2418">
          <description><![CDATA[descriptive label]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="2421" namespace="global" package="main">
        <name>$image</name>
        <default><![CDATA[null]]></default>
        <docblock line="2420">
          <description><![CDATA[optional image]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="2423" namespace="global" package="main">
        <name>$id</name>
        <default><![CDATA[null]]></default>
        <docblock line="2422">
          <description><![CDATA[optional ID for this element (e.g.]]></description>
          <long-description><![CDATA[<p>to use for JavaScript)</p>]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2432" package="metaHTML">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="2425">
          <description><![CDATA[Constructor.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2425" name="param" description="label" type="String" variable="$label">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2425" name="param" description="optional image" type="String" variable="$image">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2425" name="param" description="optional ID for this element (e.g. to use for JavaScript)" type="String" variable="$id">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="2432">
          <name>$label</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2432">
          <name>$image</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="2432">
          <name>$id</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2451" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="2440">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2440" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2440" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2440" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2440" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="2440" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="2440" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2440" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2451">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2451">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2451">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2451">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2451">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2451">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="2474" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlHiddenInput</name>
      <full_name>\htmlHiddenInput</full_name>
      <docblock line="2469">
        <description><![CDATA[Generates a hidden input field.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="2469" name="package" description="metaHTML"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="2477" namespace="global" package="main">
        <name>$name</name>
        <default><![CDATA[null]]></default>
        <docblock line="2476">
          <description><![CDATA[field name]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="2479" namespace="global" package="main">
        <name>$value</name>
        <default><![CDATA[null]]></default>
        <docblock line="2478">
          <description><![CDATA[field value]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2487" package="metaHTML">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="2481">
          <description><![CDATA[Constructor.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2481" name="param" description="input name" type="String" variable="$name">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2481" name="param" description="input value" type="String" variable="$value">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="2487">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2487">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2503" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="2492">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2492" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2492" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2492" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2492" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="2492" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="2492" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2492" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2503">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2503">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2503">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2503">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2503">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2503">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="2516" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlLink</name>
      <full_name>\htmlLink</full_name>
      <docblock line="2510">
        <description><![CDATA[Generates a link.]]></description>
        <long-description><![CDATA[<p>The link can include an optional image in front of the link text.</p>]]></long-description>
        <tag line="2510" name="package" description="metaHTML"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="2519" namespace="global" package="main">
        <name>$text</name>
        <default><![CDATA[null]]></default>
        <docblock line="2518">
          <description><![CDATA[link text]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="2521" namespace="global" package="main">
        <name>$target</name>
        <default><![CDATA[null]]></default>
        <docblock line="2520">
          <description><![CDATA[link target]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="2523" namespace="global" package="main">
        <name>$image</name>
        <default><![CDATA[null]]></default>
        <docblock line="2522">
          <description><![CDATA[optional image]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="2525" namespace="global" package="main">
        <name>$title</name>
        <default><![CDATA[null]]></default>
        <docblock line="2524">
          <description><![CDATA[title]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="2527" namespace="global" package="main">
        <name>$targetWindow</name>
        <default><![CDATA[null]]></default>
        <docblock line="2526">
          <description><![CDATA[target window]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="2529" namespace="global" package="main">
        <name>$onClick</name>
        <default><![CDATA[null]]></default>
        <docblock line="2528">
          <description><![CDATA[onClick event]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="2531" namespace="global" package="main">
        <name>$showAsButton</name>
        <default><![CDATA[false]]></default>
        <docblock line="2530">
          <description><![CDATA[show as button]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2541" package="metaHTML">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="2533">
          <description><![CDATA[Constructor.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2533" name="param" description="label" type="String" variable="$text">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2533" name="param" description="target URL" type="String" variable="$target">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2533" name="param" description="URL of optional image" type="String" variable="$image">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2533" name="param" description="shows this like as a button" type="boolean" variable="$showAsButton">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="2541">
          <name>$text</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2541">
          <name>$target</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2541">
          <name>$image</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="2541">
          <name>$showAsButton</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2559" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="2548">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2548" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2548" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2548" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2548" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="2548" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="2548" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2548" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2559">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2559">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2559">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2559">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2559">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2559">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2601" package="metaHTML">
        <name>setTitle</name>
        <full_name>setTitle</full_name>
        <docblock line="2596">
          <description><![CDATA[Sets the link title.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2596" name="param" description="title" type="String" variable="$title">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="2601">
          <name>$title</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2610" package="metaHTML">
        <name>setTargetWindow</name>
        <full_name>setTargetWindow</full_name>
        <docblock line="2605">
          <description><![CDATA[Sets the target window (e.g.]]></description>
          <long-description><![CDATA[<p>_blank).</p>]]></long-description>
          <tag line="2605" name="param" description="target window (e.g. _blank)" type="String" variable="$window">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="2610">
          <name>$window</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2619" package="metaHTML">
        <name>setOnClick</name>
        <full_name>setOnClick</full_name>
        <docblock line="2614">
          <description><![CDATA[Sets the onClick event.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2614" name="param" description="JavaScript code" type="String" variable="$event">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="2619">
          <name>$event</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="2632" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlGroup</name>
      <full_name>\htmlGroup</full_name>
      <docblock line="2625">
        <description><![CDATA[Groups multiple htmlElements.]]></description>
        <long-description><![CDATA[<p>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.</p>]]></long-description>
        <tag line="2625" name="package" description="metaHTML"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="2635" namespace="global" package="main">
        <name>$subelements</name>
        <default><![CDATA[array()]]></default>
        <docblock line="2634">
          <description><![CDATA[link text]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2648" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="2637">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2637" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2637" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2637" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2637" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="2637" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="2637" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2637" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2648">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2648">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2648">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2648">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2648">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2648">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2661" package="metaHTML">
        <name>addElement</name>
        <full_name>addElement</full_name>
        <docblock line="2656">
          <description><![CDATA[Adds a subelement.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2656" name="param" description="subelement" type="\htmlElement" variable="$sub">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
        <argument line="2661">
          <name>$sub</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="2672" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlHorizontalLine</name>
      <full_name>\htmlHorizontalLine</full_name>
      <docblock line="2667">
        <description><![CDATA[Prints a horizontal line.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="2667" name="package" description="metaHTML"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2685" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="2674">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2674" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2674" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2674" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2674" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="2674" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="2674" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2674" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2685">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2685">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2685">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2685">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2685">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2685">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="2698" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlDiv</name>
      <full_name>\htmlDiv</full_name>
      <docblock line="2693">
        <description><![CDATA[Creates a simple DIV element.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="2693" name="package" description="metaHTML"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="2701" namespace="global" package="main">
        <name>$id</name>
        <default><![CDATA[null]]></default>
        <docblock line="2700">
          <description><![CDATA[unique ID]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="2703" namespace="global" package="main">
        <name>$content</name>
        <default><![CDATA[null]]></default>
        <docblock line="2702">
          <description><![CDATA[htmlElement that generates inner content]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2712" package="metaHTML">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="2705">
          <description><![CDATA[Constructor.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2705" name="param" description="unique ID" type="String" variable="$id">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2705" name="param" description="inner content" type="\htmlElement" variable="$content">
            <type by_reference="false">\htmlElement</type>
          </tag>
          <tag line="2705" name="param" description="CSS classes" type="array" variable="$classes">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2712">
          <name>$id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2712">
          <name>$content</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2728" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="2717">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2717" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2717" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2717" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2717" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="2717" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="2717" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2717" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2728">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2728">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2728">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2728">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2728">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2728">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="2752" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlJavaScript</name>
      <full_name>\htmlJavaScript</full_name>
      <docblock line="2747">
        <description><![CDATA[Creates a JavaScript element.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="2747" name="package" description="metaHTML"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="2755" namespace="global" package="main">
        <name>$content</name>
        <default><![CDATA[null]]></default>
        <docblock line="2754">
          <description><![CDATA[htmlElement that generates inner content]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2762" package="metaHTML">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="2757">
          <description><![CDATA[Constructor.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2757" name="param" description="script" type="String" variable="$content">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="2762">
          <name>$content</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2777" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="2766">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2766" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2766" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2766" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2766" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="2766" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="2766" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2766" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2777">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2777">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2777">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2777">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2777">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2777">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="2792" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlEqualWidth</name>
      <full_name>\htmlEqualWidth</full_name>
      <docblock line="2787">
        <description><![CDATA[Sets all given elements to the same width.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="2787" name="package" description="metaHTML"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="2795" namespace="global" package="main">
        <name>$elements</name>
        <default><![CDATA[array()]]></default>
        <docblock line="2794">
          <description><![CDATA[list of element IDs]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2802" package="metaHTML">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="2797">
          <description><![CDATA[Constructor.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2797" name="param" description="list of element IDs" type="array" variable="$elements">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2802">
          <name>$elements</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2819" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="2808">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2808" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2808" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2808" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2808" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="2808" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="2808" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2808" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2819">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2819">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2819">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2819">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2819">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2819">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="2844" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlEqualHeight</name>
      <full_name>\htmlEqualHeight</full_name>
      <docblock line="2839">
        <description><![CDATA[Sets all given elements to the same height.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="2839" name="package" description="metaHTML"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="2847" namespace="global" package="main">
        <name>$elements</name>
        <default><![CDATA[array()]]></default>
        <docblock line="2846">
          <description><![CDATA[list of element IDs]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2854" package="metaHTML">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="2849">
          <description><![CDATA[Constructor.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2849" name="param" description="list of element IDs" type="array" variable="$elements">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2854">
          <name>$elements</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2871" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="2860">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2860" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2860" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2860" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2860" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="2860" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="2860" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2860" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2871">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2871">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2871">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2871">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2871">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2871">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="2896" package="metaHTML">
      <extends>\htmlElement</extends>
      <name>htmlSortableList</name>
      <full_name>\htmlSortableList</full_name>
      <docblock line="2891">
        <description><![CDATA[Creates a list of elements that can be sorted by the user via drag'n'drop.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="2891" name="package" description="metaHTML"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="2899" namespace="global" package="main">
        <name>$elements</name>
        <default><![CDATA[array()]]></default>
        <docblock line="2898">
          <description><![CDATA[list of elements]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="2901" namespace="global" package="main">
        <name>$id</name>
        <default><![CDATA['']]></default>
        <docblock line="2900">
          <description><![CDATA[HTML ID]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="2903" namespace="global" package="main">
        <name>$elementWidth</name>
        <default><![CDATA['']]></default>
        <docblock line="2902">
          <description><![CDATA[element width]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="2905" namespace="global" package="main">
        <name>$onUpdate</name>
        <default><![CDATA[null]]></default>
        <docblock line="2904">
          <description><![CDATA[on update event]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2914" package="metaHTML">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="2907">
          <description><![CDATA[Constructor.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2907" name="param" description="list of element IDs (HTML special chars must be escaped already)" type="array" variable="$elements">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2907" name="param" description="HTML ID" type="String" variable="$id">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2907" name="param" description="width of elements (default 250px)" type="String" variable="$elementWidth">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="2914">
          <name>$elements</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2914">
          <name>$id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2914">
          <name>$elementWidth</name>
          <default><![CDATA['250px']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2931" package="metaHTML">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="2920">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2920" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2920" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2920" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2920" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="2920" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="2920" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2920" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2931">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2931">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2931">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2931">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2931">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2931">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2970" package="metaHTML">
        <name>setOnUpdate</name>
        <full_name>setOnUpdate</full_name>
        <docblock line="2963">
          <description><![CDATA[Sets the JS code that is executed when the element order was changed.]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="2963" name="param" description="JS code" type="String" variable="$onUpdate">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="2970">
          <name>$onUpdate</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="2980" package="main">
      <extends>\htmlElement</extends>
      <name>htmlAccordion</name>
      <full_name>\htmlAccordion</full_name>
      <docblock line="2976">
        <description><![CDATA[Creates a list of content elements in accordion style.]]></description>
        <long-description><![CDATA[<p>HTML special characters must be escaped before providing to htmlAccordion.</p>]]></long-description>
      </docblock>
      <property final="false" static="false" visibility="private" line="2982" namespace="global" package="main">
        <name>$id</name>
        <default><![CDATA[null]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="2983" namespace="global" package="main">
        <name>$elements</name>
        <default><![CDATA[null]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="2984" namespace="global" package="main">
        <name>$openInitial</name>
        <default><![CDATA['1']]></default>
      </property>
      <property final="false" static="false" visibility="private" line="2985" namespace="global" package="main">
        <name>$collapsible</name>
        <default><![CDATA[false]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2995" package="main">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="2987">
          <description><![CDATA[Constructor.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2987" name="param" description="HTML ID" type="String" variable="$id">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2987" name="param" description="list of content elements array('title' =&gt; htmlElement)" type="array" variable="$elements">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2987" name="param" description="index of element that is initially opened (default: 0), set to 'false' to close all" type="String" variable="$openInitial">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2987" name="param" description="specifies if all elements may be closed at the same time (default: false, true if $openInitial is false)" type="boolean" variable="$collapsible">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="2995">
          <name>$id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2995">
          <name>$elements</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2995">
          <name>$openInitial</name>
          <default><![CDATA['0']]></default>
          <type/>
        </argument>
        <argument line="2995">
          <name>$collapsible</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="3018" package="main">
        <name>generateHTML</name>
        <full_name>generateHTML</full_name>
        <docblock line="3007">
          <description><![CDATA[Prints the HTML code for this element.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="3007" name="param" description="Name of account module" type="string" variable="$module">
            <type by_reference="false">string</type>
          </tag>
          <tag line="3007" name="param" description="List of meta-HTML elements" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
          <tag line="3007" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="3007" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="3007" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="3007" name="param" description="Account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="3007" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="3018">
          <name>$module</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="3018">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="3018">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="3018">
          <name>$restricted</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="3018">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="3018">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <parse_markers>
      <error line="632" code="50014">Name of argument $multiSeparatorExp does not match with the DocBlock's name $multiSeparator in enableAutocompletion()</error>
      <notice line="2705" code="50013">Parameter $classes could not be found in __construct()</notice>
      <error line="2982" code="50018">No DocBlock was found for property $id</error>
      <error line="2983" code="50018">No DocBlock was found for property $elements</error>
      <error line="2984" code="50018">No DocBlock was found for property $openInitial</error>
      <error line="2985" code="50018">No DocBlock was found for property $collapsible</error>
    </parse_markers>
  </file>
  <file path="lib/upgrade.inc" hash="f34d33a378bf09e5cfbb1678d0153f68" package="main">
    <docblock line="26">
      <description><![CDATA[This file includes functions to upgrade the pdf/profiles configuration files.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="26" name="package" description="main"/>
      <tag line="26" name="author" description="Christian Kropp"/>
      <tag line="26" name="author" description="Roland Gruber"/>
    </docblock>
    <function namespace="global" line="40" package="main">
      <name>testPermissions</name>
      <full_name>\testPermissions</full_name>
      <docblock line="35">
        <description><![CDATA[check the write/read permission for the upgrade]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="35" name="return" description="- permission messages" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
    </function>
    <function namespace="global" line="56" package="main">
      <name>testPermissionRecursive</name>
      <full_name>\testPermissionRecursive</full_name>
      <docblock line="50">
        <description><![CDATA[Recursively checks the permissions in a directory.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="50" name="param" description="directory" type="String" variable="$dir">
          <type by_reference="false">String</type>
        </tag>
        <tag line="50" name="return" description="list of files/directories with wrong permission" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="56">
        <name>$dir</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="86" package="main">
      <name>containsFiles</name>
      <full_name>\containsFiles</full_name>
      <docblock line="80">
        <description><![CDATA[Checks if the given directory contains files.]]></description>
        <long-description><![CDATA[<p>This is used to check if config files need to be migrated.</p>]]></long-description>
        <tag line="80" name="param" description="directory path" type="String" variable="$dir">
          <type by_reference="false">String</type>
        </tag>
      </docblock>
      <argument line="86">
        <name>$dir</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="109" package="main">
      <name>upgradeConfigToServerProfileFolders</name>
      <full_name>\upgradeConfigToServerProfileFolders</full_name>
      <docblock line="104">
        <description><![CDATA[Saves an hash array (attribute => value) to an account profile]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="104" name="param" description="server profiles" type="array" variable="$profiles">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="109">
        <name>$profiles</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="146" package="main">
      <name>copyConfigTemplates</name>
      <full_name>\copyConfigTemplates</full_name>
      <docblock line="141">
        <description><![CDATA[Saves an hash array (attribute => value) to an account profile]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="141" name="param" description="server profiles" type="array" variable="$profiles">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="146">
        <name>$profiles</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="163" package="main">
      <name>recursiveCopy</name>
      <full_name>\recursiveCopy</full_name>
      <docblock line="154">
        <description><![CDATA[Copy a file or recursively copy a directory]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="154" name="param" description="- source path to file or directory" type="string" variable="$src">
          <type by_reference="false">string</type>
        </tag>
        <tag line="154" name="param" description="- destination path to file or directory" type="string" variable="$dst">
          <type by_reference="false">string</type>
        </tag>
        <tag line="154" name="param" description="- server profiles (used to avoid copying of newly created folders)" type="array" variable="$profiles">
          <type by_reference="false">array</type>
        </tag>
        <tag line="154" name="param" description="copy only files that start with the given filter" type="string" variable="$fileFilter">
          <type by_reference="false">string</type>
        </tag>
        <tag line="154" name="param" description="overwrite existing files" type="boolean" variable="$overwrite">
          <type by_reference="false">boolean</type>
        </tag>
      </docblock>
      <argument line="163">
        <name>$src</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="163">
        <name>$dst</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="163">
        <name>$profiles</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="163">
        <name>$fileFilter</name>
        <default><![CDATA[null]]></default>
        <type/>
      </argument>
      <argument line="163">
        <name>$overwrite</name>
        <default><![CDATA[true]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="200" package="main">
      <name>recursiveDelete</name>
      <full_name>\recursiveDelete</full_name>
      <docblock line="194">
        <description><![CDATA[Delete a file or recursively delete a directory]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="194" name="param" description="- path to file or directory" type="string" variable="$src">
          <type by_reference="false">string</type>
        </tag>
        <tag line="194" name="param" description="- server profiles (used to avoid copying of newly created folders)" type="array" variable="$profiles">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="200">
        <name>$src</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="200">
        <name>$profiles</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
  </file>
  <file path="lib/tools.inc" hash="8f9587b6ddbc355a5e8f24fb5d801440" package="tools">
    <docblock line="25">
      <description><![CDATA[This file includes functions to manage LAM tools.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="25" name="package" description="tools"/>
      <tag line="25" name="author" description="Roland Gruber"/>
    </docblock>
    <include line="44" type="Include Once" package="main">
      <name/>
    </include>
    <function namespace="global" line="37" package="tools">
      <name>getTools</name>
      <full_name>\getTools</full_name>
      <docblock line="32">
        <description><![CDATA[Returns the tools which are available for LAM.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="32" name="return" description="list of LAMtool classes" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
    </function>
    <interface namespace="global" line="70" package="tools">
      <name>LAMTool</name>
      <full_name>\LAMTool</full_name>
      <docblock line="59">
        <description><![CDATA[Represents a tool.]]></description>
        <long-description><![CDATA[<p>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.</p>]]></long-description>
        <tag line="59" name="author" description="Roland Gruber"/>
        <tag line="59" name="package" description="tools"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="77" package="tools">
        <name>getName</name>
        <full_name>getName</full_name>
        <docblock line="72">
          <description><![CDATA[Returns the name of the tool.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="72" name="return" description="name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="84" package="tools">
        <name>getDescription</name>
        <full_name>getDescription</full_name>
        <docblock line="79">
          <description><![CDATA[returns a description text for the tool.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="79" name="return" description="description" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="91" package="tools">
        <name>getLink</name>
        <full_name>getLink</full_name>
        <docblock line="86">
          <description><![CDATA[Returns a link to the tool page (relative to templates/).]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="86" name="return" description="link" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="98" package="tools">
        <name>getRequiresWriteAccess</name>
        <full_name>getRequiresWriteAccess</full_name>
        <docblock line="93">
          <description><![CDATA[Returns if the tool requires write access to LDAP.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="93" name="return" description="true if write access is needed" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="105" package="tools">
        <name>getRequiresPasswordChangeRights</name>
        <full_name>getRequiresPasswordChangeRights</full_name>
        <docblock line="100">
          <description><![CDATA[Returns if the tool requires password change rights.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="100" name="return" description="true if password change rights are needed" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="112" package="tools">
        <name>getImageLink</name>
        <full_name>getImageLink</full_name>
        <docblock line="107">
          <description><![CDATA[Returns the link to the tool image (relative to graphics/)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="107" name="return" description="image URL" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="120" package="tools">
        <name>getPosition</name>
        <full_name>getPosition</full_name>
        <docblock line="114">
          <description><![CDATA[Returns the prefered position of this tool on the tools page.]]></description>
          <long-description><![CDATA[<p>The position may be between 0 and 1000. 0 is the top position.</p>]]></long-description>
          <tag line="114" name="return" description="prefered position" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="127" package="tools">
        <name>getSubTools</name>
        <full_name>getSubTools</full_name>
        <docblock line="122">
          <description><![CDATA[Returns a list of sub tools or an empty array.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="122" name="return" description="list of subtools (LAMTool)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="134" package="tools">
        <name>isVisible</name>
        <full_name>isVisible</full_name>
        <docblock line="129">
          <description><![CDATA[Returns if the tool is visible in the menu.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="129" name="return" description="visible" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="141" package="tools">
        <name>isHideable</name>
        <full_name>isHideable</full_name>
        <docblock line="136">
          <description><![CDATA[Returns if a tool may be hidden by configuration in the LAM server profile.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="136" name="return" description="hideable" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
    </interface>
    <class final="false" abstract="false" namespace="global" line="151" package="tools">
      <extends/>
      <name>LAMSubTool</name>
      <full_name>\LAMSubTool</full_name>
      <docblock line="145">
        <description><![CDATA[Represents a subtool.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="145" name="author" description="Roland Gruber"/>
        <tag line="145" name="package" description="tools"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="154" namespace="global" package="main">
        <name>$name</name>
        <default><![CDATA[]]></default>
        <docblock line="153">
          <description><![CDATA[visible tool name]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="156" namespace="global" package="main">
        <name>$description</name>
        <default><![CDATA[]]></default>
        <docblock line="155">
          <description><![CDATA[tool description]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="158" namespace="global" package="main">
        <name>$link</name>
        <default><![CDATA[]]></default>
        <docblock line="157">
          <description><![CDATA[tool link (relative to templates/)]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="160" namespace="global" package="main">
        <name>$image</name>
        <default><![CDATA[]]></default>
        <docblock line="159">
          <description><![CDATA[image URL (relative to graphics/)]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
    </class>
  </file>
  <file path="lib/fpdf.php" hash="52e877a2c57c8d7dba92bd4432d80092" package="main">
    <include line="1145" type="Include" package="main">
      <name/>
    </include>
    <constant namespace="global" line="10" package="main">
      <name>FPDF_VERSION</name>
      <full_name>\FPDF_VERSION</full_name>
      <value><![CDATA['1.7']]></value>
    </constant>
    <class final="false" abstract="false" namespace="global" line="12" package="main">
      <extends/>
      <name>FPDF</name>
      <full_name>\FPDF</full_name>
      <property final="false" static="false" visibility="public" line="14" namespace="global" package="main">
        <name>$page</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="15" namespace="global" package="main">
        <name>$n</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="16" namespace="global" package="main">
        <name>$offsets</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="17" namespace="global" package="main">
        <name>$buffer</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="18" namespace="global" package="main">
        <name>$pages</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="19" namespace="global" package="main">
        <name>$state</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="20" namespace="global" package="main">
        <name>$compress</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="21" namespace="global" package="main">
        <name>$k</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="22" namespace="global" package="main">
        <name>$DefOrientation</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="23" namespace="global" package="main">
        <name>$CurOrientation</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="24" namespace="global" package="main">
        <name>$StdPageSizes</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="25" namespace="global" package="main">
        <name>$DefPageSize</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="26" namespace="global" package="main">
        <name>$CurPageSize</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="27" namespace="global" package="main">
        <name>$PageSizes</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="28" namespace="global" package="main">
        <name>$wPt</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="28" namespace="global" package="main">
        <name>$hPt</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="29" namespace="global" package="main">
        <name>$w</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="29" namespace="global" package="main">
        <name>$h</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="30" namespace="global" package="main">
        <name>$lMargin</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="31" namespace="global" package="main">
        <name>$tMargin</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="32" namespace="global" package="main">
        <name>$rMargin</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="33" namespace="global" package="main">
        <name>$bMargin</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="34" namespace="global" package="main">
        <name>$cMargin</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="35" namespace="global" package="main">
        <name>$x</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="35" namespace="global" package="main">
        <name>$y</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="36" namespace="global" package="main">
        <name>$lasth</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="37" namespace="global" package="main">
        <name>$LineWidth</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="38" namespace="global" package="main">
        <name>$fontpath</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="39" namespace="global" package="main">
        <name>$CoreFonts</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="40" namespace="global" package="main">
        <name>$fonts</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="41" namespace="global" package="main">
        <name>$FontFiles</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="42" namespace="global" package="main">
        <name>$diffs</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="43" namespace="global" package="main">
        <name>$FontFamily</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="44" namespace="global" package="main">
        <name>$FontStyle</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="45" namespace="global" package="main">
        <name>$underline</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="46" namespace="global" package="main">
        <name>$CurrentFont</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="47" namespace="global" package="main">
        <name>$FontSizePt</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="48" namespace="global" package="main">
        <name>$FontSize</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="49" namespace="global" package="main">
        <name>$DrawColor</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="50" namespace="global" package="main">
        <name>$FillColor</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="51" namespace="global" package="main">
        <name>$TextColor</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="52" namespace="global" package="main">
        <name>$ColorFlag</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="53" namespace="global" package="main">
        <name>$ws</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="54" namespace="global" package="main">
        <name>$images</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="55" namespace="global" package="main">
        <name>$PageLinks</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="56" namespace="global" package="main">
        <name>$links</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="57" namespace="global" package="main">
        <name>$AutoPageBreak</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="58" namespace="global" package="main">
        <name>$PageBreakTrigger</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="59" namespace="global" package="main">
        <name>$InHeader</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="60" namespace="global" package="main">
        <name>$InFooter</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="61" namespace="global" package="main">
        <name>$ZoomMode</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="62" namespace="global" package="main">
        <name>$LayoutMode</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="63" namespace="global" package="main">
        <name>$title</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="64" namespace="global" package="main">
        <name>$subject</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="65" namespace="global" package="main">
        <name>$author</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="66" namespace="global" package="main">
        <name>$keywords</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="67" namespace="global" package="main">
        <name>$creator</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="68" namespace="global" package="main">
        <name>$AliasNbPages</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="69" namespace="global" package="main">
        <name>$PDFVersion</name>
        <default><![CDATA[]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="76" package="main">
        <name>FPDF</name>
        <full_name>FPDF</full_name>
        <argument line="76">
          <name>$orientation</name>
          <default><![CDATA['P']]></default>
          <type/>
        </argument>
        <argument line="76">
          <name>$unit</name>
          <default><![CDATA['mm']]></default>
          <type/>
        </argument>
        <argument line="76">
          <name>$size</name>
          <default><![CDATA['A4']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="170" package="main">
        <name>SetMargins</name>
        <full_name>SetMargins</full_name>
        <argument line="170">
          <name>$left</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="170">
          <name>$top</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="170">
          <name>$right</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="180" package="main">
        <name>SetLeftMargin</name>
        <full_name>SetLeftMargin</full_name>
        <argument line="180">
          <name>$margin</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="188" package="main">
        <name>SetTopMargin</name>
        <full_name>SetTopMargin</full_name>
        <argument line="188">
          <name>$margin</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="194" package="main">
        <name>SetRightMargin</name>
        <full_name>SetRightMargin</full_name>
        <argument line="194">
          <name>$margin</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="200" package="main">
        <name>SetAutoPageBreak</name>
        <full_name>SetAutoPageBreak</full_name>
        <argument line="200">
          <name>$auto</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="200">
          <name>$margin</name>
          <default><![CDATA[0]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="208" package="main">
        <name>SetDisplayMode</name>
        <full_name>SetDisplayMode</full_name>
        <argument line="208">
          <name>$zoom</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="208">
          <name>$layout</name>
          <default><![CDATA['default']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="221" package="main">
        <name>SetCompression</name>
        <full_name>SetCompression</full_name>
        <argument line="221">
          <name>$compress</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="230" package="main">
        <name>SetTitle</name>
        <full_name>SetTitle</full_name>
        <argument line="230">
          <name>$title</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="230">
          <name>$isUTF8</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="238" package="main">
        <name>SetSubject</name>
        <full_name>SetSubject</full_name>
        <argument line="238">
          <name>$subject</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="238">
          <name>$isUTF8</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="246" package="main">
        <name>SetAuthor</name>
        <full_name>SetAuthor</full_name>
        <argument line="246">
          <name>$author</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="246">
          <name>$isUTF8</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="254" package="main">
        <name>SetKeywords</name>
        <full_name>SetKeywords</full_name>
        <argument line="254">
          <name>$keywords</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="254">
          <name>$isUTF8</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="262" package="main">
        <name>SetCreator</name>
        <full_name>SetCreator</full_name>
        <argument line="262">
          <name>$creator</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="262">
          <name>$isUTF8</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="270" package="main">
        <name>AliasNbPages</name>
        <full_name>AliasNbPages</full_name>
        <argument line="270">
          <name>$alias</name>
          <default><![CDATA['{nb}']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="276" package="main">
        <name>Error</name>
        <full_name>Error</full_name>
        <argument line="276">
          <name>$msg</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="282" package="main">
        <name>Open</name>
        <full_name>Open</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="288" package="main">
        <name>Close</name>
        <full_name>Close</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="305" package="main">
        <name>AddPage</name>
        <full_name>AddPage</full_name>
        <argument line="305">
          <name>$orientation</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
        <argument line="305">
          <name>$size</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="374" package="main">
        <name>Header</name>
        <full_name>Header</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="379" package="main">
        <name>Footer</name>
        <full_name>Footer</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="384" package="main">
        <name>PageNo</name>
        <full_name>PageNo</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="390" package="main">
        <name>SetDrawColor</name>
        <full_name>SetDrawColor</full_name>
        <argument line="390">
          <name>$r</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="390">
          <name>$g</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="390">
          <name>$b</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="401" package="main">
        <name>SetFillColor</name>
        <full_name>SetFillColor</full_name>
        <argument line="401">
          <name>$r</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="401">
          <name>$g</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="401">
          <name>$b</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="413" package="main">
        <name>SetTextColor</name>
        <full_name>SetTextColor</full_name>
        <argument line="413">
          <name>$r</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="413">
          <name>$g</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="413">
          <name>$b</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="423" package="main">
        <name>GetStringWidth</name>
        <full_name>GetStringWidth</full_name>
        <argument line="423">
          <name>$s</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="435" package="main">
        <name>SetLineWidth</name>
        <full_name>SetLineWidth</full_name>
        <argument line="435">
          <name>$width</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="443" package="main">
        <name>Line</name>
        <full_name>Line</full_name>
        <argument line="443">
          <name>$x1</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="443">
          <name>$y1</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="443">
          <name>$x2</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="443">
          <name>$y2</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="449" package="main">
        <name>Rect</name>
        <full_name>Rect</full_name>
        <argument line="449">
          <name>$x</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="449">
          <name>$y</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="449">
          <name>$w</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="449">
          <name>$h</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="449">
          <name>$style</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="461" package="main">
        <name>AddFont</name>
        <full_name>AddFont</full_name>
        <argument line="461">
          <name>$family</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="461">
          <name>$style</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
        <argument line="461">
          <name>$file</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="497" package="main">
        <name>SetFont</name>
        <full_name>SetFont</full_name>
        <argument line="497">
          <name>$family</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="497">
          <name>$style</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
        <argument line="497">
          <name>$size</name>
          <default><![CDATA[0]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="547" package="main">
        <name>SetFontSize</name>
        <full_name>SetFontSize</full_name>
        <argument line="547">
          <name>$size</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="558" package="main">
        <name>AddLink</name>
        <full_name>AddLink</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="566" package="main">
        <name>SetLink</name>
        <full_name>SetLink</full_name>
        <argument line="566">
          <name>$link</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="566">
          <name>$y</name>
          <default><![CDATA[0]]></default>
          <type/>
        </argument>
        <argument line="566">
          <name>$page</name>
          <default><![CDATA[-1]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="576" package="main">
        <name>Link</name>
        <full_name>Link</full_name>
        <argument line="576">
          <name>$x</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="576">
          <name>$y</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="576">
          <name>$w</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="576">
          <name>$h</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="576">
          <name>$link</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="582" package="main">
        <name>Text</name>
        <full_name>Text</full_name>
        <argument line="582">
          <name>$x</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="582">
          <name>$y</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="582">
          <name>$txt</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="593" package="main">
        <name>AcceptPageBreak</name>
        <full_name>AcceptPageBreak</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="599" package="main">
        <name>Cell</name>
        <full_name>Cell</full_name>
        <argument line="599">
          <name>$w</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="599">
          <name>$h</name>
          <default><![CDATA[0]]></default>
          <type/>
        </argument>
        <argument line="599">
          <name>$txt</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
        <argument line="599">
          <name>$border</name>
          <default><![CDATA[0]]></default>
          <type/>
        </argument>
        <argument line="599">
          <name>$ln</name>
          <default><![CDATA[0]]></default>
          <type/>
        </argument>
        <argument line="599">
          <name>$align</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
        <argument line="599">
          <name>$fill</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
        <argument line="599">
          <name>$link</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="678" package="main">
        <name>MultiCell</name>
        <full_name>MultiCell</full_name>
        <argument line="678">
          <name>$w</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="678">
          <name>$h</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="678">
          <name>$txt</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="678">
          <name>$border</name>
          <default><![CDATA[0]]></default>
          <type/>
        </argument>
        <argument line="678">
          <name>$align</name>
          <default><![CDATA['J']]></default>
          <type/>
        </argument>
        <argument line="678">
          <name>$fill</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="791" package="main">
        <name>Write</name>
        <full_name>Write</full_name>
        <argument line="791">
          <name>$h</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="791">
          <name>$txt</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="791">
          <name>$link</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="872" package="main">
        <name>Ln</name>
        <full_name>Ln</full_name>
        <argument line="872">
          <name>$h</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="882" package="main">
        <name>Image</name>
        <full_name>Image</full_name>
        <argument line="882">
          <name>$file</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="882">
          <name>$x</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="882">
          <name>$y</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="882">
          <name>$w</name>
          <default><![CDATA[0]]></default>
          <type/>
        </argument>
        <argument line="882">
          <name>$h</name>
          <default><![CDATA[0]]></default>
          <type/>
        </argument>
        <argument line="882">
          <name>$type</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
        <argument line="882">
          <name>$link</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="945" package="main">
        <name>GetX</name>
        <full_name>GetX</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="951" package="main">
        <name>SetX</name>
        <full_name>SetX</full_name>
        <argument line="951">
          <name>$x</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="960" package="main">
        <name>GetY</name>
        <full_name>GetY</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="966" package="main">
        <name>SetY</name>
        <full_name>SetY</full_name>
        <argument line="966">
          <name>$y</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="976" package="main">
        <name>SetXY</name>
        <full_name>SetXY</full_name>
        <argument line="976">
          <name>$x</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="976">
          <name>$y</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="983" package="main">
        <name>Output</name>
        <full_name>Output</full_name>
        <argument line="983">
          <name>$name</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
        <argument line="983">
          <name>$dest</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1045" package="main">
        <name>_dochecks</name>
        <full_name>_dochecks</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1058" package="main">
        <name>_checkoutput</name>
        <full_name>_checkoutput</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1078" package="main">
        <name>_getpagesize</name>
        <full_name>_getpagesize</full_name>
        <argument line="1078">
          <name>$size</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1097" package="main">
        <name>_beginpage</name>
        <full_name>_beginpage</full_name>
        <argument line="1097">
          <name>$orientation</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1097">
          <name>$size</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1137" package="main">
        <name>_endpage</name>
        <full_name>_endpage</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1142" package="main">
        <name>_loadfont</name>
        <full_name>_loadfont</full_name>
        <argument line="1142">
          <name>$font</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1152" package="main">
        <name>_escape</name>
        <full_name>_escape</full_name>
        <argument line="1152">
          <name>$s</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1162" package="main">
        <name>_textstring</name>
        <full_name>_textstring</full_name>
        <argument line="1162">
          <name>$s</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1168" package="main">
        <name>_UTF8toUTF16</name>
        <full_name>_UTF8toUTF16</full_name>
        <argument line="1168">
          <name>$s</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1201" package="main">
        <name>_dounderline</name>
        <full_name>_dounderline</full_name>
        <argument line="1201">
          <name>$x</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1201">
          <name>$y</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1201">
          <name>$txt</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1210" package="main">
        <name>_parsejpg</name>
        <full_name>_parsejpg</full_name>
        <argument line="1210">
          <name>$file</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1229" package="main">
        <name>_parsepng</name>
        <full_name>_parsepng</full_name>
        <argument line="1229">
          <name>$file</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1240" package="main">
        <name>_parsepngstream</name>
        <full_name>_parsepngstream</full_name>
        <argument line="1240">
          <name>$f</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1240">
          <name>$file</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1365" package="main">
        <name>_readstream</name>
        <full_name>_readstream</full_name>
        <argument line="1365">
          <name>$f</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1365">
          <name>$n</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1382" package="main">
        <name>_readint</name>
        <full_name>_readint</full_name>
        <argument line="1382">
          <name>$f</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1389" package="main">
        <name>_parsegif</name>
        <full_name>_parsegif</full_name>
        <argument line="1389">
          <name>$file</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1428" package="main">
        <name>_newobj</name>
        <full_name>_newobj</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1436" package="main">
        <name>_putstream</name>
        <full_name>_putstream</full_name>
        <argument line="1436">
          <name>$s</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1443" package="main">
        <name>_out</name>
        <full_name>_out</full_name>
        <argument line="1443">
          <name>$s</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1452" package="main">
        <name>_putpages</name>
        <full_name>_putpages</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1525" package="main">
        <name>_putfonts</name>
        <full_name>_putfonts</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1619" package="main">
        <name>_putimages</name>
        <full_name>_putimages</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1629" package="main">
        <name>_putimage</name>
        <full_name>_putimage</full_name>
        <argument line="1629">
          <name>$info</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1681" package="main">
        <name>_putxobjectdict</name>
        <full_name>_putxobjectdict</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1687" package="main">
        <name>_putresourcedict</name>
        <full_name>_putresourcedict</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1699" package="main">
        <name>_putresources</name>
        <full_name>_putresources</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1712" package="main">
        <name>_putinfo</name>
        <full_name>_putinfo</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1728" package="main">
        <name>_putcatalog</name>
        <full_name>_putcatalog</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1748" package="main">
        <name>_putheader</name>
        <full_name>_putheader</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1753" package="main">
        <name>_puttrailer</name>
        <full_name>_puttrailer</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1760" package="main">
        <name>_enddoc</name>
        <full_name>_enddoc</full_name>
      </method>
    </class>
    <parse_markers>
      <error line="0" code="50007">No page-level DocBlock was found in file lib/fpdf.php</error>
      <error line="12" code="50000">No DocBlock was found for \FPDF</error>
      <error line="14" code="50018">No DocBlock was found for property $page</error>
      <error line="15" code="50018">No DocBlock was found for property $n</error>
      <error line="16" code="50018">No DocBlock was found for property $offsets</error>
      <error line="17" code="50018">No DocBlock was found for property $buffer</error>
      <error line="18" code="50018">No DocBlock was found for property $pages</error>
      <error line="19" code="50018">No DocBlock was found for property $state</error>
      <error line="20" code="50018">No DocBlock was found for property $compress</error>
      <error line="21" code="50018">No DocBlock was found for property $k</error>
      <error line="22" code="50018">No DocBlock was found for property $DefOrientation</error>
      <error line="23" code="50018">No DocBlock was found for property $CurOrientation</error>
      <error line="24" code="50018">No DocBlock was found for property $StdPageSizes</error>
      <error line="25" code="50018">No DocBlock was found for property $DefPageSize</error>
      <error line="26" code="50018">No DocBlock was found for property $CurPageSize</error>
      <error line="27" code="50018">No DocBlock was found for property $PageSizes</error>
      <error line="28" code="50018">No DocBlock was found for property $wPt</error>
      <error line="28" code="50018">No DocBlock was found for property $hPt</error>
      <error line="29" code="50018">No DocBlock was found for property $w</error>
      <error line="29" code="50018">No DocBlock was found for property $h</error>
      <error line="30" code="50018">No DocBlock was found for property $lMargin</error>
      <error line="31" code="50018">No DocBlock was found for property $tMargin</error>
      <error line="32" code="50018">No DocBlock was found for property $rMargin</error>
      <error line="33" code="50018">No DocBlock was found for property $bMargin</error>
      <error line="34" code="50018">No DocBlock was found for property $cMargin</error>
      <error line="35" code="50018">No DocBlock was found for property $x</error>
      <error line="35" code="50018">No DocBlock was found for property $y</error>
      <error line="36" code="50018">No DocBlock was found for property $lasth</error>
      <error line="37" code="50018">No DocBlock was found for property $LineWidth</error>
      <error line="38" code="50018">No DocBlock was found for property $fontpath</error>
      <error line="39" code="50018">No DocBlock was found for property $CoreFonts</error>
      <error line="40" code="50018">No DocBlock was found for property $fonts</error>
      <error line="41" code="50018">No DocBlock was found for property $FontFiles</error>
      <error line="42" code="50018">No DocBlock was found for property $diffs</error>
      <error line="43" code="50018">No DocBlock was found for property $FontFamily</error>
      <error line="44" code="50018">No DocBlock was found for property $FontStyle</error>
      <error line="45" code="50018">No DocBlock was found for property $underline</error>
      <error line="46" code="50018">No DocBlock was found for property $CurrentFont</error>
      <error line="47" code="50018">No DocBlock was found for property $FontSizePt</error>
      <error line="48" code="50018">No DocBlock was found for property $FontSize</error>
      <error line="49" code="50018">No DocBlock was found for property $DrawColor</error>
      <error line="50" code="50018">No DocBlock was found for property $FillColor</error>
      <error line="51" code="50018">No DocBlock was found for property $TextColor</error>
      <error line="52" code="50018">No DocBlock was found for property $ColorFlag</error>
      <error line="53" code="50018">No DocBlock was found for property $ws</error>
      <error line="54" code="50018">No DocBlock was found for property $images</error>
      <error line="55" code="50018">No DocBlock was found for property $PageLinks</error>
      <error line="56" code="50018">No DocBlock was found for property $links</error>
      <error line="57" code="50018">No DocBlock was found for property $AutoPageBreak</error>
      <error line="58" code="50018">No DocBlock was found for property $PageBreakTrigger</error>
      <error line="59" code="50018">No DocBlock was found for property $InHeader</error>
      <error line="60" code="50018">No DocBlock was found for property $InFooter</error>
      <error line="61" code="50018">No DocBlock was found for property $ZoomMode</error>
      <error line="62" code="50018">No DocBlock was found for property $LayoutMode</error>
      <error line="63" code="50018">No DocBlock was found for property $title</error>
      <error line="64" code="50018">No DocBlock was found for property $subject</error>
      <error line="65" code="50018">No DocBlock was found for property $author</error>
      <error line="66" code="50018">No DocBlock was found for property $keywords</error>
      <error line="67" code="50018">No DocBlock was found for property $creator</error>
      <error line="68" code="50018">No DocBlock was found for property $AliasNbPages</error>
      <error line="69" code="50018">No DocBlock was found for property $PDFVersion</error>
      <error line="76" code="50010">No DocBlock was found for method FPDF()</error>
      <error line="170" code="50010">No DocBlock was found for method SetMargins()</error>
      <error line="180" code="50010">No DocBlock was found for method SetLeftMargin()</error>
      <error line="188" code="50010">No DocBlock was found for method SetTopMargin()</error>
      <error line="194" code="50010">No DocBlock was found for method SetRightMargin()</error>
      <error line="200" code="50010">No DocBlock was found for method SetAutoPageBreak()</error>
      <error line="208" code="50010">No DocBlock was found for method SetDisplayMode()</error>
      <error line="221" code="50010">No DocBlock was found for method SetCompression()</error>
      <error line="230" code="50010">No DocBlock was found for method SetTitle()</error>
      <error line="238" code="50010">No DocBlock was found for method SetSubject()</error>
      <error line="246" code="50010">No DocBlock was found for method SetAuthor()</error>
      <error line="254" code="50010">No DocBlock was found for method SetKeywords()</error>
      <error line="262" code="50010">No DocBlock was found for method SetCreator()</error>
      <error line="270" code="50010">No DocBlock was found for method AliasNbPages()</error>
      <error line="276" code="50010">No DocBlock was found for method Error()</error>
      <error line="282" code="50010">No DocBlock was found for method Open()</error>
      <error line="288" code="50010">No DocBlock was found for method Close()</error>
      <error line="305" code="50010">No DocBlock was found for method AddPage()</error>
      <error line="374" code="50010">No DocBlock was found for method Header()</error>
      <error line="379" code="50010">No DocBlock was found for method Footer()</error>
      <error line="384" code="50010">No DocBlock was found for method PageNo()</error>
      <error line="390" code="50010">No DocBlock was found for method SetDrawColor()</error>
      <error line="401" code="50010">No DocBlock was found for method SetFillColor()</error>
      <error line="413" code="50010">No DocBlock was found for method SetTextColor()</error>
      <error line="423" code="50010">No DocBlock was found for method GetStringWidth()</error>
      <error line="435" code="50010">No DocBlock was found for method SetLineWidth()</error>
      <error line="443" code="50010">No DocBlock was found for method Line()</error>
      <error line="449" code="50010">No DocBlock was found for method Rect()</error>
      <error line="461" code="50010">No DocBlock was found for method AddFont()</error>
      <error line="497" code="50010">No DocBlock was found for method SetFont()</error>
      <error line="547" code="50010">No DocBlock was found for method SetFontSize()</error>
      <error line="558" code="50010">No DocBlock was found for method AddLink()</error>
      <error line="566" code="50010">No DocBlock was found for method SetLink()</error>
      <error line="576" code="50010">No DocBlock was found for method Link()</error>
      <error line="582" code="50010">No DocBlock was found for method Text()</error>
      <error line="593" code="50010">No DocBlock was found for method AcceptPageBreak()</error>
      <error line="599" code="50010">No DocBlock was found for method Cell()</error>
      <error line="678" code="50010">No DocBlock was found for method MultiCell()</error>
      <error line="791" code="50010">No DocBlock was found for method Write()</error>
      <error line="872" code="50010">No DocBlock was found for method Ln()</error>
      <error line="882" code="50010">No DocBlock was found for method Image()</error>
      <error line="945" code="50010">No DocBlock was found for method GetX()</error>
      <error line="951" code="50010">No DocBlock was found for method SetX()</error>
      <error line="960" code="50010">No DocBlock was found for method GetY()</error>
      <error line="966" code="50010">No DocBlock was found for method SetY()</error>
      <error line="976" code="50010">No DocBlock was found for method SetXY()</error>
      <error line="983" code="50010">No DocBlock was found for method Output()</error>
      <error line="1045" code="50010">No DocBlock was found for method _dochecks()</error>
      <error line="1058" code="50010">No DocBlock was found for method _checkoutput()</error>
      <error line="1078" code="50010">No DocBlock was found for method _getpagesize()</error>
      <error line="1097" code="50010">No DocBlock was found for method _beginpage()</error>
      <error line="1137" code="50010">No DocBlock was found for method _endpage()</error>
      <error line="1142" code="50010">No DocBlock was found for method _loadfont()</error>
      <error line="1152" code="50010">No DocBlock was found for method _escape()</error>
      <error line="1162" code="50010">No DocBlock was found for method _textstring()</error>
      <error line="1168" code="50010">No DocBlock was found for method _UTF8toUTF16()</error>
      <error line="1201" code="50010">No DocBlock was found for method _dounderline()</error>
      <error line="1210" code="50010">No DocBlock was found for method _parsejpg()</error>
      <error line="1229" code="50010">No DocBlock was found for method _parsepng()</error>
      <error line="1240" code="50010">No DocBlock was found for method _parsepngstream()</error>
      <error line="1365" code="50010">No DocBlock was found for method _readstream()</error>
      <error line="1382" code="50010">No DocBlock was found for method _readint()</error>
      <error line="1389" code="50010">No DocBlock was found for method _parsegif()</error>
      <error line="1428" code="50010">No DocBlock was found for method _newobj()</error>
      <error line="1436" code="50010">No DocBlock was found for method _putstream()</error>
      <error line="1443" code="50010">No DocBlock was found for method _out()</error>
      <error line="1452" code="50010">No DocBlock was found for method _putpages()</error>
      <error line="1525" code="50010">No DocBlock was found for method _putfonts()</error>
      <error line="1619" code="50010">No DocBlock was found for method _putimages()</error>
      <error line="1629" code="50010">No DocBlock was found for method _putimage()</error>
      <error line="1681" code="50010">No DocBlock was found for method _putxobjectdict()</error>
      <error line="1687" code="50010">No DocBlock was found for method _putresourcedict()</error>
      <error line="1699" code="50010">No DocBlock was found for method _putresources()</error>
      <error line="1712" code="50010">No DocBlock was found for method _putinfo()</error>
      <error line="1728" code="50010">No DocBlock was found for method _putcatalog()</error>
      <error line="1748" code="50010">No DocBlock was found for method _putheader()</error>
      <error line="1753" code="50010">No DocBlock was found for method _puttrailer()</error>
      <error line="1760" code="50010">No DocBlock was found for method _enddoc()</error>
    </parse_markers>
  </file>
  <file path="lib/types.inc" hash="9bd360b877504118ff364814401d622d" package="types">
    <docblock line="24">
      <description><![CDATA[This file is the interface to the different account types.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="package" description="types"/>
      <tag line="24" name="author" description="Roland Gruber"/>
    </docblock>
    <include line="32" type="Include Once" package="main">
      <name>baseType.inc</name>
      <docblock line="31">
        <description><![CDATA[parent class of account types]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="34" type="Include Once" package="main">
      <name>lists.inc</name>
      <docblock line="33">
        <description><![CDATA[parent class of list views]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="36" type="Include Once" package="main">
      <name>selfService.inc</name>
      <docblock line="35">
        <description><![CDATA[Used to check if this is a LAM Pro release.]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="47" type="Include Once" package="main">
      <name/>
    </include>
    <function namespace="global" line="56" package="types">
      <name>getTypes</name>
      <full_name>\getTypes</full_name>
      <docblock line="51">
        <description><![CDATA[Returns a list of available account types.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="51" name="return" description="list of types" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
    </function>
    <function namespace="global" line="75" package="types">
      <name>getTypeAlias</name>
      <full_name>\getTypeAlias</full_name>
      <docblock line="69">
        <description><![CDATA[Returns the alias name of an account type.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="69" name="param" description="type name" type="string" variable="$type">
          <type by_reference="false">string</type>
        </tag>
        <tag line="69" name="return" description="type alias" type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="75">
        <name>$type</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="86" package="types">
      <name>getTypeDescription</name>
      <full_name>\getTypeDescription</full_name>
      <docblock line="80">
        <description><![CDATA[Returns the description of an account type.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="80" name="param" description="type name" type="string" variable="$type">
          <type by_reference="false">string</type>
        </tag>
        <tag line="80" name="return" description="type description" type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="86">
        <name>$type</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="97" package="types">
      <name>getListClassName</name>
      <full_name>\getListClassName</full_name>
      <docblock line="91">
        <description><![CDATA[Returns the class name for the list object.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="91" name="param" description="account type" type="string" variable="$type">
          <type by_reference="false">string</type>
        </tag>
        <tag line="91" name="return" description="class name" type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="97">
        <name>$type</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="109" package="types">
      <name>getDefaultListAttributes</name>
      <full_name>\getDefaultListAttributes</full_name>
      <docblock line="102">
        <description><![CDATA[Returns the default attribute list for an account type.]]></description>
        <long-description><![CDATA[<p>It is used as default value for the configuration editor.</p>]]></long-description>
        <tag line="102" name="param" description="account type" type="string" variable="$type">
          <type by_reference="false">string</type>
        </tag>
        <tag line="102" name="return" description="attribute list" type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="109">
        <name>$type</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="121" package="types">
      <name>getListAttributeDescriptions</name>
      <full_name>\getListAttributeDescriptions</full_name>
      <docblock line="114">
        <description><![CDATA[Returns a list of attributes which have a translated description.]]></description>
        <long-description><![CDATA[<p>This is used for the head row in the list view.</p>]]></long-description>
        <tag line="114" name="param" description="account type" type="string" variable="$type">
          <type by_reference="false">string</type>
        </tag>
        <tag line="114" name="return" description="list of descriptions" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="121">
        <name>$type</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
  </file>
  <file path="lib/selfService.inc" hash="c339ec506c13d42d9330d138ac2b66e6" package="selfService">
    <docblock line="25">
      <description><![CDATA[Interface between modules and self service pages.]]></description>
      <long-description><![CDATA[<p>This file also includes the self service profile class and helper functions.</p>]]></long-description>
      <tag line="25" name="package" description="selfService"/>
      <tag line="25" name="author" description="Roland Gruber"/>
    </docblock>
    <include line="34" type="Include Once" package="main">
      <name>modules.inc</name>
      <docblock line="33">
        <description><![CDATA[modules]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="36" type="Include Once" package="main">
      <name>types.inc</name>
      <docblock line="35">
        <description><![CDATA[account types]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <function namespace="global" line="43" package="selfService">
      <name>isLAMProVersion</name>
      <full_name>\isLAMProVersion</full_name>
      <docblock line="38">
        <description><![CDATA[Returns if this is a LAM Pro installation.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="38" name="return" description="LAM Pro installation" type="boolean">
          <type by_reference="false">boolean</type>
        </tag>
      </docblock>
    </function>
    <function namespace="global" line="55" package="selfService">
      <name>getSelfServiceSearchAttributes</name>
      <full_name>\getSelfServiceSearchAttributes</full_name>
      <docblock line="49">
        <description><![CDATA[Returns a list of possible search attributes for the self service.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="49" name="param" description="account type" type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="49" name="return" description="attributes" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="55">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="75" package="selfService">
      <name>getSelfServiceFieldSettings</name>
      <full_name>\getSelfServiceFieldSettings</full_name>
      <docblock line="69">
        <description><![CDATA[Returns the field settings for the self service.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="69" name="param" description="account type" type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="69" name="return" description="settings" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="75">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="97" package="selfService">
      <name>getSelfServiceOptions</name>
      <full_name>\getSelfServiceOptions</full_name>
      <docblock line="87">
        <description><![CDATA[Returns meta HTML code for each self service field.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="87" name="param" description="account type" type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="87" name="param" description="input fields (array(&lt;moduleName&gt; =&gt; array(&lt;field1&gt;, &lt;field2&gt;, ...)))" type="array" variable="$fields">
          <type by_reference="false">array</type>
        </tag>
        <tag line="87" name="param" description="LDAP attributes (attribute names in lower case)" type="array" variable="$attributes">
          <type by_reference="false">array</type>
        </tag>
        <tag line="87" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
          <type by_reference="false">boolean</type>
        </tag>
        <tag line="87" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
          <type by_reference="false">array</type>
        </tag>
        <tag line="87" name="return" description="meta HTML code (array(&lt;moduleName&gt; =&gt; htmlTableRow))" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="97">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="97">
        <name>$fields</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="97">
        <name>$attributes</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="97">
        <name>$passwordChangeOnly</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="97">
        <name>$readOnlyFields</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="127" package="selfService">
      <name>checkSelfServiceOptions</name>
      <full_name>\checkSelfServiceOptions</full_name>
      <docblock line="117">
        <description><![CDATA[Checks if all input values are correct and returns the LDAP commands which should be executed.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="117" name="param" description="account type" type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="117" name="param" description="input fields (array(&lt;moduleName&gt; =&gt; array(&lt;field1&gt;, &lt;field2&gt;, ...)))" type="string" variable="$fields">
          <type by_reference="false">string</type>
        </tag>
        <tag line="117" name="param" description="LDAP attributes" type="array" variable="$attributes">
          <type by_reference="false">array</type>
        </tag>
        <tag line="117" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
          <type by_reference="false">boolean</type>
        </tag>
        <tag line="117" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
          <type by_reference="false">array</type>
        </tag>
        <tag line="117" name="return" description="messages and LDAP commands (array('messages' =&gt; array(), 'add' =&gt; array(), 'del' =&gt; array(), 'mod' =&gt; array()))" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="127">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="127">
        <name>$fields</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="127">
        <name>$attributes</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="127">
        <name>$passwordChangeOnly</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="127">
        <name>$readOnlyFields</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="156" package="selfService">
      <name>getSelfServiceProfiles</name>
      <full_name>\getSelfServiceProfiles</full_name>
      <docblock line="151">
        <description><![CDATA[Returns a list of all available self service profiles (without .conf)]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="151" name="return" description="profile names (array(&lt;account type&gt; =&gt; array(&lt;profile1&gt;, &lt;profile2&gt;, ...)))" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
    </function>
    <function namespace="global" line="183" package="selfService">
      <name>loadSelfServiceProfile</name>
      <full_name>\loadSelfServiceProfile</full_name>
      <docblock line="176">
        <description><![CDATA[Loads all settings of a self service profile.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="176" name="param" description="profile name" type="string" variable="$name">
          <type by_reference="false">string</type>
        </tag>
        <tag line="176" name="param" description="account type" type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="176" name="return" description="true if file was readable" type="\selfServiceProfile">
          <type by_reference="false">\selfServiceProfile</type>
        </tag>
      </docblock>
      <argument line="183">
        <name>$name</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="183">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="216" package="selfService">
      <name>saveSelfServiceProfile</name>
      <full_name>\saveSelfServiceProfile</full_name>
      <docblock line="206">
        <description><![CDATA[Saves a self service profile.]]></description>
        <long-description><![CDATA[<p>File is created, if needed</p>]]></long-description>
        <tag line="206" name="param" description="name of the account profile" type="string" variable="$name">
          <type by_reference="false">string</type>
        </tag>
        <tag line="206" name="param" description="account type" type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="206" name="param" description="self service profile" type="\selfServiceProfile" variable="$profile">
          <type by_reference="false">\selfServiceProfile</type>
        </tag>
        <tag line="206" name="return" description="true, if saving succeeded" type="boolean">
          <type by_reference="false">boolean</type>
        </tag>
      </docblock>
      <argument line="216">
        <name>$name</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="216">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="216">
        <name>$profile</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="244" package="selfService">
      <name>isSelfServiceProfileWritable</name>
      <full_name>\isSelfServiceProfileWritable</full_name>
      <docblock line="237">
        <description><![CDATA[Checks if a service profile is writable.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="237" name="param" description="profile name" type="string" variable="$name">
          <type by_reference="false">string</type>
        </tag>
        <tag line="237" name="param" description="account type" type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="237" name="return" description="true if file is writable" type="boolean">
          <type by_reference="false">boolean</type>
        </tag>
      </docblock>
      <argument line="244">
        <name>$name</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="244">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="259" package="selfService">
      <name>getSelfServiceSettings</name>
      <full_name>\getSelfServiceSettings</full_name>
      <docblock line="252">
        <description><![CDATA[Returns a hash array (module name => elements) of all module options for the configuration page.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="252" name="param" description="account type" type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="252" name="param" description="currently edited profile" type="\selfServiceProfile" variable="$profile">
          <type by_reference="false">\selfServiceProfile</type>
        </tag>
        <tag line="252" name="return" description="configuration options" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="259">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="259">
        <name>$profile</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="277" package="selfService">
      <name>checkSelfServiceSettings</name>
      <full_name>\checkSelfServiceSettings</full_name>
      <docblock line="269">
        <description><![CDATA[Checks if the self service settings are valid]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="269" name="param" description="account type" type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="269" name="param" description="hash array containing all options (name =&gt; array(...))" type="array" variable="$options">
          <type by_reference="false">array</type>
        </tag>
        <tag line="269" name="param" description="profile" type="\selfServiceProfile" variable="$profile">
          <type by_reference="false">\selfServiceProfile</type>
        </tag>
        <tag line="269" name="return" description="list of error messages" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="277">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="277">
        <name>$options</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="277">
        <name>$profile</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <class final="false" abstract="false" namespace="global" line="294" package="selfService">
      <extends/>
      <name>selfServiceProfile</name>
      <full_name>\selfServiceProfile</full_name>
      <docblock line="289">
        <description><![CDATA[Includes all settings of a self service profile.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="289" name="package" description="selfService"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="297" namespace="global" package="main">
        <name>$serverURL</name>
        <default><![CDATA[]]></default>
        <docblock line="296">
          <description><![CDATA[server address]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="300" namespace="global" package="main">
        <name>$useTLS</name>
        <default><![CDATA[]]></default>
        <docblock line="299">
          <description><![CDATA[use TLS]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="303" namespace="global" package="main">
        <name>$LDAPSuffix</name>
        <default><![CDATA[]]></default>
        <docblock line="302">
          <description><![CDATA[LDAP suffix]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="306" namespace="global" package="main">
        <name>$LDAPUser</name>
        <default><![CDATA[]]></default>
        <docblock line="305">
          <description><![CDATA[LDAP user DN]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="309" namespace="global" package="main">
        <name>$LDAPPassword</name>
        <default><![CDATA[]]></default>
        <docblock line="308">
          <description><![CDATA[LDAP password]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="312" namespace="global" package="main">
        <name>$searchAttribute</name>
        <default><![CDATA[]]></default>
        <docblock line="311">
          <description><![CDATA[LDAP search attribute]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="315" namespace="global" package="main">
        <name>$httpAuthentication</name>
        <default><![CDATA[]]></default>
        <docblock line="314">
          <description><![CDATA[HTTP authentication]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="318" namespace="global" package="main">
        <name>$pageHeader</name>
        <default><![CDATA[]]></default>
        <docblock line="317">
          <description><![CDATA[header for self service pages]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="321" namespace="global" package="main">
        <name>$additionalCSS</name>
        <default><![CDATA[]]></default>
        <docblock line="320">
          <description><![CDATA[list of additional CSS links (separated by \n)]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="324" namespace="global" package="main">
        <name>$loginCaption</name>
        <default><![CDATA[]]></default>
        <docblock line="323">
          <description><![CDATA[describing text for user login]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="327" namespace="global" package="main">
        <name>$loginAttributeText</name>
        <default><![CDATA[]]></default>
        <docblock line="326">
          <description><![CDATA[describing text for search attribute]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="330" namespace="global" package="main">
        <name>$mainPageText</name>
        <default><![CDATA[]]></default>
        <docblock line="329">
          <description><![CDATA[describing text for self service main page]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="339" namespace="global" package="main">
        <name>$inputFields</name>
        <default><![CDATA[]]></default>
        <docblock line="332">
          <description><![CDATA[input fields
Format: array(
<br> array(array('name' => <group name 1>, 'fields' => array(<field1>, <field2>))),
<br> array(array('name' => <group name 2>, 'fields' => array(<field3>, <field4>)))
<br> )]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="344" namespace="global" package="main">
        <name>$readOnlyFields</name>
        <default><![CDATA[]]></default>
        <docblock line="341">
          <description><![CDATA[List of fields that are set in read-only mode.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="347" namespace="global" package="main">
        <name>$moduleSettings</name>
        <default><![CDATA[]]></default>
        <docblock line="346">
          <description><![CDATA[configuration settings of modules]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="354" package="selfService">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="349">
          <description><![CDATA[Constructor]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="349" name="return" description="" type="\selfServiceProfile">
            <type by_reference="false">\selfServiceProfile</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/lamPDF.inc" hash="0b14cce81906f1ee3eda0da19a4a8099" package="PDF">
    <docblock line="24">
      <description><![CDATA[LDAP Account Manager PDF printing library.]]></description>
      <long-description><![CDATA[<p>It consists of lamPDF class,
the createModulePDF() function that may be called by other pages
and furthermore some helper functions.</p>]]></long-description>
      <tag line="24" name="author" description="Michael Duergner"/>
      <tag line="24" name="author" description="Roland Gruber"/>
      <tag line="24" name="package" description="PDF"/>
    </docblock>
    <constant namespace="global" line="70" package="PDF">
      <name>FPDF_FONTPATH</name>
      <full_name>\FPDF_FONTPATH</full_name>
      <value><![CDATA[dirname(__FILE__) . '/font/']]></value>
    </constant>
    <class final="false" abstract="false" namespace="global" line="41" package="PDF">
      <extends>\UFPDF</extends>
      <name>lamPDF</name>
      <full_name>\lamPDF</full_name>
      <docblock line="34">
        <description><![CDATA[Creates a LAM information page in PDF format.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="34" name="package" description="PDF"/>
        <tag line="34" name="author" description="Michael Duergner"/>
        <tag line="34" name="author" description="Roland Gruber"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="46" namespace="global" package="main">
        <name>$page_definitions</name>
        <default><![CDATA[]]></default>
        <docblock line="43">
          <description><![CDATA[format settings for page layout]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="51" namespace="global" package="main">
        <name>$fontName</name>
        <default><![CDATA[]]></default>
        <docblock line="48">
          <description><![CDATA[current active font name]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="57" namespace="global" package="main">
        <name>$fontList</name>
        <default><![CDATA[array('BitstreamVeraSans-Roman' => array('vera.php', 'verab.php', 'verabi.php', 'verai.php'))]]></default>
        <docblock line="53">
          <description><![CDATA[list of supported fonts
format: <font name> => array(<file for default font style>, <file for bold>, <italic>, <bold italic>)]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="67" package="PDF">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="61">
          <description><![CDATA[Creates a new lamPDF object.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="61" name="param" description="page settings" type="array" variable="$page_definitions">
            <type by_reference="false">array</type>
          </tag>
          <tag line="61" name="param" description="font name" type="String" variable="$fontName">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="67">
          <name>$page_definitions</name>
          <default><![CDATA[array()]]></default>
          <type/>
        </argument>
        <argument line="67">
          <name>$fontName</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="93" package="PDF">
        <name>header</name>
        <full_name>header</full_name>
        <docblock line="90">
          <description><![CDATA[Creates the PDF page header.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="120" package="PDF">
        <name>footer</name>
        <full_name>footer</full_name>
        <docblock line="117">
          <description><![CDATA[Creates the PDF page footer.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/config.inc" hash="62c65f006c80845a35bdf125a918e646" package="configuration">
    <docblock line="25">
      <description><![CDATA[This file includes functions to manage the configuration files.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="25" name="package" description="configuration"/>
      <tag line="25" name="author" description="Roland Gruber"/>
      <tag line="25" name="author" description="Thomas Manninger"/>
    </docblock>
    <include line="34" type="Include Once" package="main">
      <name>status.inc</name>
      <docblock line="33">
        <description><![CDATA[Used to print messages.]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="36" type="Include Once" package="main">
      <name>modules.inc</name>
      <docblock line="35">
        <description><![CDATA[Used to get module information.]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="38" type="Include Once" package="main">
      <name>types.inc</name>
      <docblock line="37">
        <description><![CDATA[Used to get type information.]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <function namespace="global" line="43" package="configuration">
      <name>setlanguage</name>
      <full_name>\setlanguage</full_name>
      <docblock line="40">
        <description><![CDATA[Sets language settings for automatic translation]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </function>
    <function namespace="global" line="66" package="configuration">
      <name>checkChmod</name>
      <full_name>\checkChmod</full_name>
      <docblock line="57">
        <description><![CDATA[Checks whether a specific flag in the rights string is set.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="57" name="param" description="read,write or execute" type="\$right" variable="$right">
          <type by_reference="false">\$right</type>
        </tag>
        <tag line="57" name="param" description="owner,group or other" type="\$target" variable="$target">
          <type by_reference="false">\$target</type>
        </tag>
        <tag line="57" name="param" description="the chmod rights" type="\$chmod" variable="$chmod">
          <type by_reference="false">\$chmod</type>
        </tag>
        <tag line="57" name="return" description="if the chmod $right for $target were set" type="\true,">
          <type by_reference="false">\true,</type>
        </tag>
      </docblock>
      <argument line="66">
        <name>$right</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="66">
        <name>$target</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="66">
        <name>$chmod</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="102" package="configuration">
      <name>getConfigProfiles</name>
      <full_name>\getConfigProfiles</full_name>
      <docblock line="97">
        <description><![CDATA[Returns an array of string with all available configuration profiles (without .conf)]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="97" name="return" description="profile names" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
    </function>
    <function namespace="global" line="125" package="configuration">
      <name>deleteConfigProfile</name>
      <full_name>\deleteConfigProfile</full_name>
      <docblock line="119">
        <description><![CDATA[Deletes the given server profile.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="119" name="param" description="profile name" type="String" variable="$name">
          <type by_reference="false">String</type>
        </tag>
        <tag line="119" name="return" description="null if success or error message if failed" type="String">
          <type by_reference="false">String</type>
        </tag>
      </docblock>
      <argument line="125">
        <name>$name</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="165" package="configuration">
      <name>LAMVersion</name>
      <full_name>\LAMVersion</full_name>
      <docblock line="158">
        <description><![CDATA[Returns the version number of this LAM installation.]]></description>
        <long-description><![CDATA[<p>Format: <major version>.<minor version>.<patch level>
<br> Major/minor version are always numbers, patch level may contain letters for inofficial releases only (e.g. 0.5.alpha1).</p>]]></long-description>
        <tag line="158" name="return" description="version number" type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
    </function>
    <function namespace="global" line="183" package="configuration">
      <name>metaRefresh</name>
      <full_name>\metaRefresh</full_name>
      <docblock line="178">
        <description><![CDATA[Prints a meta refresh page]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="178" name="param" description="the URL of the target page" type="string" variable="$page">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="183">
        <name>$page</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="209" package="configuration">
      <name>isAccountTypeHidden</name>
      <full_name>\isAccountTypeHidden</full_name>
      <docblock line="203">
        <description><![CDATA[Checks if the given account type is hidden.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="203" name="param" description="account type (e.g. user)" type="String" variable="$type">
          <type by_reference="false">String</type>
        </tag>
        <tag line="203" name="return" description="is hidden" type="boolean">
          <type by_reference="false">boolean</type>
        </tag>
      </docblock>
      <argument line="209">
        <name>$type</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <class final="false" abstract="false" namespace="global" line="219" package="configuration">
      <extends/>
      <name>LAMConfig</name>
      <full_name>\LAMConfig</full_name>
      <docblock line="214">
        <description><![CDATA[This class manages .conf files.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="214" name="package" description="configuration"/>
      </docblock>
      <constant namespace="global" line="222" package="configuration">
        <name>ACCESS_ALL</name>
        <full_name>ACCESS_ALL</full_name>
        <value><![CDATA[100]]></value>
      </constant>
      <constant namespace="global" line="223" package="configuration">
        <name>ACCESS_PASSWORD_CHANGE</name>
        <full_name>ACCESS_PASSWORD_CHANGE</full_name>
        <value><![CDATA[20]]></value>
      </constant>
      <constant namespace="global" line="224" package="configuration">
        <name>ACCESS_READ_ONLY</name>
        <full_name>ACCESS_READ_ONLY</full_name>
        <value><![CDATA[0]]></value>
      </constant>
      <constant namespace="global" line="227" package="configuration">
        <name>SAVE_OK</name>
        <full_name>SAVE_OK</full_name>
        <value><![CDATA[0]]></value>
      </constant>
      <constant namespace="global" line="228" package="configuration">
        <name>SAVE_FAIL</name>
        <full_name>SAVE_FAIL</full_name>
        <value><![CDATA[1]]></value>
      </constant>
      <constant namespace="global" line="231" package="configuration">
        <name>LOGIN_LIST</name>
        <full_name>LOGIN_LIST</full_name>
        <value><![CDATA['list']]></value>
      </constant>
      <constant namespace="global" line="232" package="configuration">
        <name>LOGIN_SEARCH</name>
        <full_name>LOGIN_SEARCH</full_name>
        <value><![CDATA['search']]></value>
      </constant>
      <constant namespace="global" line="235" package="configuration">
        <name>LINE_SEPARATOR</name>
        <full_name>LINE_SEPARATOR</full_name>
        <value><![CDATA['+::+']]></value>
        <docblock line="234">
          <description><![CDATA[line separator]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <property final="false" static="false" visibility="private" line="238" namespace="global" package="main">
        <name>$ServerURL</name>
        <default><![CDATA[]]></default>
        <docblock line="237">
          <description><![CDATA[Server address (e.g.]]></description>
          <long-description><![CDATA[<p>ldap://127.0.0.1:389)</p>]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="241" namespace="global" package="main">
        <name>$useTLS</name>
        <default><![CDATA[]]></default>
        <docblock line="240">
          <description><![CDATA[enables/disables TLS encryption]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="244" namespace="global" package="main">
        <name>$Admins</name>
        <default><![CDATA[]]></default>
        <docblock line="243">
          <description><![CDATA[Array of string: users with admin rights]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="247" namespace="global" package="main">
        <name>$Passwd</name>
        <default><![CDATA[]]></default>
        <docblock line="246">
          <description><![CDATA[Password to edit preferences]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="250" namespace="global" package="main">
        <name>$treesuffix</name>
        <default><![CDATA[]]></default>
        <docblock line="249">
          <description><![CDATA[LDAP suffix for tree view]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="253" namespace="global" package="main">
        <name>$defaultLanguage</name>
        <default><![CDATA[]]></default>
        <docblock line="252">
          <description><![CDATA[Default language]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="256" namespace="global" package="main">
        <name>$moduleSettings</name>
        <default><![CDATA[array()]]></default>
        <docblock line="255">
          <description><![CDATA[module settings]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="259" namespace="global" package="main">
        <name>$typeSettings</name>
        <default><![CDATA[array()]]></default>
        <docblock line="258">
          <description><![CDATA[type settings]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="262" namespace="global" package="main">
        <name>$toolSettings</name>
        <default><![CDATA[array()]]></default>
        <docblock line="261">
          <description><![CDATA[tool settings]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="270" namespace="global" package="main">
        <name>$scriptPath</name>
        <default><![CDATA[]]></default>
        <docblock line="264">
          <description><![CDATA[Path to external lamdaemon script on server where it is executed]]></description>
          <long-description><![CDATA[<p>This is used for managing quota and home directories.
optional setting, may not be defined</p>]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="275" namespace="global" package="main">
        <name>$scriptRights</name>
        <default><![CDATA['750']]></default>
        <docblock line="272">
          <description><![CDATA[The rights for the home directory]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="283" namespace="global" package="main">
        <name>$scriptServer</name>
        <default><![CDATA[]]></default>
        <docblock line="277">
          <description><![CDATA[Servers where lamdaemon script is executed]]></description>
          <long-description><![CDATA[<p>This is used for managing quota and home directories.
optional setting, may not be defined</p>]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="286" namespace="global" package="main">
        <name>$cachetimeout</name>
        <default><![CDATA[]]></default>
        <docblock line="285">
          <description><![CDATA[LDAP cache timeout]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="289" namespace="global" package="main">
        <name>$searchLimit</name>
        <default><![CDATA[0]]></default>
        <docblock line="288">
          <description><![CDATA[LDAP search limit]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="292" namespace="global" package="main">
        <name>$activeTypes</name>
        <default><![CDATA["user,group,host,smbDomain"]]></default>
        <docblock line="291">
          <description><![CDATA[Active account types]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="295" namespace="global" package="main">
        <name>$file</name>
        <default><![CDATA[]]></default>
        <docblock line="294">
          <description><![CDATA[Name of configuration file]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="298" namespace="global" package="main">
        <name>$accessLevel</name>
        <default><![CDATA[\LAMconfig::ACCESS_ALL]]></default>
        <docblock line="297">
          <description><![CDATA[access level]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="301" namespace="global" package="main">
        <name>$loginMethod</name>
        <default><![CDATA[\LAMconfig::LOGIN_LIST]]></default>
        <docblock line="300">
          <description><![CDATA[login method]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="304" namespace="global" package="main">
        <name>$loginSearchSuffix</name>
        <default><![CDATA['dc=yourdomain,dc=org']]></default>
        <docblock line="303">
          <description><![CDATA[search suffix for login]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="307" namespace="global" package="main">
        <name>$loginSearchFilter</name>
        <default><![CDATA['uid=%USER%']]></default>
        <docblock line="306">
          <description><![CDATA[search filter for login]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="310" namespace="global" package="main">
        <name>$loginSearchDN</name>
        <default><![CDATA['']]></default>
        <docblock line="309">
          <description><![CDATA[bind user for login search]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="313" namespace="global" package="main">
        <name>$loginSearchPassword</name>
        <default><![CDATA['']]></default>
        <docblock line="312">
          <description><![CDATA[bind password for login search]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="316" namespace="global" package="main">
        <name>$httpAuthentication</name>
        <default><![CDATA['false']]></default>
        <docblock line="315">
          <description><![CDATA[specifies if HTTP authentication should be used]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="319" namespace="global" package="main">
        <name>$lamProMailFrom</name>
        <default><![CDATA['']]></default>
        <docblock line="318">
          <description><![CDATA[email address for sender of password reset mails]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="322" namespace="global" package="main">
        <name>$lamProMailReplyTo</name>
        <default><![CDATA['']]></default>
        <docblock line="321">
          <description><![CDATA[reply-to email address for password reset mails]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="325" namespace="global" package="main">
        <name>$lamProMailSubject</name>
        <default><![CDATA['']]></default>
        <docblock line="324">
          <description><![CDATA[subject for password reset mails]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="328" namespace="global" package="main">
        <name>$lamProMailIsHTML</name>
        <default><![CDATA['false']]></default>
        <docblock line="327">
          <description><![CDATA[treat password reset mail body as HTML]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="331" namespace="global" package="main">
        <name>$lamProMailText</name>
        <default><![CDATA['']]></default>
        <docblock line="330">
          <description><![CDATA[mail body for password reset mails]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="334" namespace="global" package="main">
        <name>$settings</name>
        <default><![CDATA[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="333">
          <description><![CDATA[List of all settings in config file]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="346" package="configuration">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="341">
          <description><![CDATA[Loads preferences from config file]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="341" name="param" description="file name without &quot;.conf&quot; (e.g. lam)" type="String" variable="$file">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="346">
          <name>$file</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="365" package="configuration">
        <name>reload</name>
        <full_name>reload</full_name>
        <docblock line="360">
          <description><![CDATA[Reloads preferences from config file]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="360" name="return" description="true if file was readable" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="441" package="configuration">
        <name>save</name>
        <full_name>save</full_name>
        <docblock line="440">
          <description><![CDATA[Saves preferences to config file]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="565" package="configuration">
        <name>getName</name>
        <full_name>getName</full_name>
        <docblock line="560">
          <description><![CDATA[Returns the name of the config file]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="560" name="return" description="name" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="574" package="configuration">
        <name>isWritable</name>
        <full_name>isWritable</full_name>
        <docblock line="569">
          <description><![CDATA[Returns if the file can be written on the filesystem.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="569" name="return" description="true if file is writable" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="583" package="configuration">
        <name>getPath</name>
        <full_name>getPath</full_name>
        <docblock line="578">
          <description><![CDATA[Returns the path to the config file.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="578" name="return" description="path on filesystem" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="594" package="configuration">
        <name>get_ServerURL</name>
        <full_name>get_ServerURL</full_name>
        <docblock line="589">
          <description><![CDATA[Returns the server address as string]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="589" name="return" description="server address" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="604" package="configuration">
        <name>set_ServerURL</name>
        <full_name>set_ServerURL</full_name>
        <docblock line="598">
          <description><![CDATA[Sets the server address]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="598" name="param" description="new server address" type="string" variable="$value">
            <type by_reference="false">string</type>
          </tag>
          <tag line="598" name="return" description="true if $value has correct format" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="604">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="615" package="configuration">
        <name>getUseTLS</name>
        <full_name>getUseTLS</full_name>
        <docblock line="610">
          <description><![CDATA[Returns if TLS is activated.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="610" name="return" description="yes or no" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="625" package="configuration">
        <name>setUseTLS</name>
        <full_name>setUseTLS</full_name>
        <docblock line="619">
          <description><![CDATA[Sets if TLS is activated.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="619" name="param" description="yes or no" type="String" variable="$useTLS">
            <type by_reference="false">String</type>
          </tag>
          <tag line="619" name="return" description="true if $useTLS has correct format" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="625">
          <name>$useTLS</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="639" package="configuration">
        <name>get_Admins</name>
        <full_name>get_Admins</full_name>
        <docblock line="634">
          <description><![CDATA[Returns an array of string with all admin names]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="634" name="return" description="the admin names" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="648" package="configuration">
        <name>get_Adminstring</name>
        <full_name>get_Adminstring</full_name>
        <docblock line="643">
          <description><![CDATA[Returns all admin users seperated by semicolons]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="643" name="return" description="the admin string" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="658" package="configuration">
        <name>set_Adminstring</name>
        <full_name>set_Adminstring</full_name>
        <docblock line="652">
          <description><![CDATA[Sets the admin string]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="652" name="param" description="new admin string that contains all admin users seperated by semicolons" type="string" variable="$value">
            <type by_reference="false">string</type>
          </tag>
          <tag line="652" name="return" description="true if $value has correct format" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="658">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="673" package="configuration">
        <name>check_Passwd</name>
        <full_name>check_Passwd</full_name>
        <docblock line="667">
          <description><![CDATA[Checks if the given password matches.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="667" name="param" description="" type="String" variable="$password">
            <type by_reference="false">String</type>
          </tag>
          <tag line="667" name="return" description="true, if matches" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="673">
          <name>$password</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="693" package="configuration">
        <name>set_Passwd</name>
        <full_name>set_Passwd</full_name>
        <docblock line="687">
          <description><![CDATA[Sets the preferences wizard password]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="687" name="param" description="new password" type="string" variable="$value">
            <type by_reference="false">string</type>
          </tag>
          <tag line="687" name="return" description="true if $value has correct format" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="693">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="714" package="configuration">
        <name>hashPassword</name>
        <full_name>hashPassword</full_name>
        <docblock line="707">
          <description><![CDATA[Returns the hashed password.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="707" name="param" description="password" type="String" variable="$password">
            <type by_reference="false">String</type>
          </tag>
          <tag line="707" name="param" description="salt" type="String" variable="$salt">
            <type by_reference="false">String</type>
          </tag>
          <tag line="707" name="return" description="hash value" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="714">
          <name>$password</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="714">
          <name>$salt</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="724" package="configuration">
        <name>get_Suffix</name>
        <full_name>get_Suffix</full_name>
        <docblock line="718">
          <description><![CDATA[Returns the LDAP suffix for the given account type]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="718" name="param" description="account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="718" name="return" description="the LDAP suffix" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="724">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="740" package="configuration">
        <name>set_Suffix</name>
        <full_name>set_Suffix</full_name>
        <docblock line="733">
          <description><![CDATA[Sets the LDAP suffix where accounts are saved]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="733" name="param" description="account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="733" name="param" description="new LDAP suffix" type="string" variable="$value">
            <type by_reference="false">string</type>
          </tag>
          <tag line="733" name="return" description="true if $value has correct format" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="740">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="740">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="760" package="configuration">
        <name>get_listAttributes</name>
        <full_name>get_listAttributes</full_name>
        <docblock line="754">
          <description><![CDATA[Returns the list of attributes to show in user list]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="754" name="param" description="account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="754" name="return" description="the attribute list" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="760">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="771" package="configuration">
        <name>set_listAttributes</name>
        <full_name>set_listAttributes</full_name>
        <docblock line="764">
          <description><![CDATA[Sets the list of attributes to show in user list]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="764" name="param" description="new attribute string" type="string" variable="$value">
            <type by_reference="false">string</type>
          </tag>
          <tag line="764" name="param" description="account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="764" name="return" description="true if $value has correct format" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="771">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="771">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="786" package="configuration">
        <name>get_defaultLanguage</name>
        <full_name>get_defaultLanguage</full_name>
        <docblock line="781">
          <description><![CDATA[Returns the default language string]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="781" name="return" description="default language" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="796" package="configuration">
        <name>set_defaultLanguage</name>
        <full_name>set_defaultLanguage</full_name>
        <docblock line="790">
          <description><![CDATA[Sets the default language string]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="790" name="param" description="new default language" type="string" variable="$value">
            <type by_reference="false">string</type>
          </tag>
          <tag line="790" name="return" description="true if $value has correct format" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="796">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="807" package="configuration">
        <name>get_scriptPath</name>
        <full_name>get_scriptPath</full_name>
        <docblock line="802">
          <description><![CDATA[Returns the path to the external script]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="802" name="return" description="script path" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="817" package="configuration">
        <name>set_scriptPath</name>
        <full_name>set_scriptPath</full_name>
        <docblock line="811">
          <description><![CDATA[Sets the path to the external script]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="811" name="param" description="new script path" type="string" variable="$value">
            <type by_reference="false">string</type>
          </tag>
          <tag line="811" name="return" description="true if $value has correct format" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="817">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="829" package="configuration">
        <name>get_scriptServers</name>
        <full_name>get_scriptServers</full_name>
        <docblock line="824">
          <description><![CDATA[Returns the servers of the external script as a Array]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="824" name="return" description="script servers" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="839" package="configuration">
        <name>set_scriptServers</name>
        <full_name>set_scriptServers</full_name>
        <docblock line="833">
          <description><![CDATA[Sets the servers of the external script]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="833" name="param" description="new script servers" type="string" variable="$value">
            <type by_reference="false">string</type>
          </tag>
          <tag line="833" name="return" description="true if $value has correct format" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="839">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="894" package="configuration">
        <name>get_scriptRights</name>
        <full_name>get_scriptRights</full_name>
        <docblock line="889">
          <description><![CDATA[Returns the chmod value for new home directories.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="889" name="return" description="rights" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="905" package="configuration">
        <name>set_scriptRights</name>
        <full_name>set_scriptRights</full_name>
        <docblock line="899">
          <description><![CDATA[Sets the rights for the home directory.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="899" name="param" description="the rights" type="string" variable="$chmod">
            <type by_reference="false">string</type>
          </tag>
          <tag line="899" name="return" description="true if values has correct format" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="905">
          <name>$chmod</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="921" package="configuration">
        <name>get_cacheTimeout</name>
        <full_name>get_cacheTimeout</full_name>
        <docblock line="916">
          <description><![CDATA[Returns the LDAP cache timeout in minutes]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="916" name="return" description="cache time" type="integer">
            <type by_reference="false">integer</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="931" package="configuration">
        <name>get_cacheTimeoutSec</name>
        <full_name>get_cacheTimeoutSec</full_name>
        <docblock line="926">
          <description><![CDATA[Returns the LDAP cache timeout in seconds]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="926" name="return" description="cache time" type="integer">
            <type by_reference="false">integer</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="941" package="configuration">
        <name>set_cacheTimeout</name>
        <full_name>set_cacheTimeout</full_name>
        <docblock line="935">
          <description><![CDATA[Sets the LDAP cache timeout in minutes (0,1,2,5,10,15)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="935" name="param" description="new cache timeout" type="integer" variable="$value">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="935" name="return" description="true if $value has correct format" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="941">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="954" package="configuration">
        <name>get_searchLimit</name>
        <full_name>get_searchLimit</full_name>
        <docblock line="949">
          <description><![CDATA[Returns the LDAP search limit.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="949" name="return" description="search limit" type="integer">
            <type by_reference="false">integer</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="964" package="configuration">
        <name>set_searchLimit</name>
        <full_name>set_searchLimit</full_name>
        <docblock line="958">
          <description><![CDATA[Sets the LDAP search limit.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="958" name="param" description="new search limit" type="integer" variable="$value">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="958" name="return" description="true if $value has correct format" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="964">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="978" package="configuration">
        <name>get_AccountModules</name>
        <full_name>get_AccountModules</full_name>
        <docblock line="972">
          <description><![CDATA[Returns an array of all selected account modules]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="972" name="param" description="account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="972" name="return" description="user modules" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="978">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1001" package="configuration">
        <name>set_AccountModules</name>
        <full_name>set_AccountModules</full_name>
        <docblock line="994">
          <description><![CDATA[Sets the selected account modules]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="994" name="param" description="array with module names (not aliases!)" type="array" variable="$modules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="994" name="param" description="account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
          <tag line="994" name="return" description="true if $modules has correct format" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1001">
          <name>$modules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1001">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1021" package="configuration">
        <name>set_moduleSettings</name>
        <full_name>set_moduleSettings</full_name>
        <docblock line="1015">
          <description><![CDATA[Sets the settings for the account modules.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1015" name="param" description="list of module setting array(name =&gt; value)" type="array" variable="$settings">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1015" name="return" description="true if $settings has correct format" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1021">
          <name>$settings</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1032" package="configuration">
        <name>get_moduleSettings</name>
        <full_name>get_moduleSettings</full_name>
        <docblock line="1027">
          <description><![CDATA[Returns a list of saved module settings]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1027" name="return" description="list of settings: array(name =&gt; value)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1041" package="configuration">
        <name>get_ActiveTypes</name>
        <full_name>get_ActiveTypes</full_name>
        <docblock line="1036">
          <description><![CDATA[Returns a list of active account types.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1036" name="return" description="list of types" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1051" package="configuration">
        <name>set_ActiveTypes</name>
        <full_name>set_ActiveTypes</full_name>
        <docblock line="1046">
          <description><![CDATA[Sets the list of active types.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1046" name="param" description="list of types" type="array" variable="$types">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1051">
          <name>$types</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1061" package="configuration">
        <name>set_typeSettings</name>
        <full_name>set_typeSettings</full_name>
        <docblock line="1055">
          <description><![CDATA[Sets the settings for the account types.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1055" name="param" description="list of type setting array(name =&gt; value)" type="array" variable="$settings">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1055" name="return" description="true if $settings has correct format" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1061">
          <name>$settings</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1072" package="configuration">
        <name>get_typeSettings</name>
        <full_name>get_typeSettings</full_name>
        <docblock line="1067">
          <description><![CDATA[Returns a list of saved type settings]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1067" name="return" description="list of settings: array(name =&gt; value)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1081" package="configuration">
        <name>getToolSettings</name>
        <full_name>getToolSettings</full_name>
        <docblock line="1076">
          <description><![CDATA[Returns the tool settings.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1076" name="return" description="$toolSettings tool settings" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1091" package="configuration">
        <name>setToolSettings</name>
        <full_name>setToolSettings</full_name>
        <docblock line="1085">
          <description><![CDATA[Sets the tool settings.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1085" name="param" description="tool settings" type="array" variable="$toolSettings">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1085" name="return" description="true if ok" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1091">
          <name>$toolSettings</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1102" package="configuration">
        <name>getAccessLevel</name>
        <full_name>getAccessLevel</full_name>
        <docblock line="1097">
          <description><![CDATA[Returns the access level for this profile.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1097" name="return" description="level" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1111" package="configuration">
        <name>setAccessLevel</name>
        <full_name>setAccessLevel</full_name>
        <docblock line="1106">
          <description><![CDATA[Sets the access level for this profile.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1106" name="param" description="level" type="int" variable="$level">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
        <argument line="1111">
          <name>$level</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1122" package="configuration">
        <name>getLoginMethod</name>
        <full_name>getLoginMethod</full_name>
        <docblock line="1115">
          <description><![CDATA[Returns the login method.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1115" name="return" description="login method" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1115" name="see" description="\global\LAMconfig::LOGIN_LIST" refers="\global\LAMconfig::LOGIN_LIST"/>
          <tag line="1115" name="see" description="\global\LAMconfig::LOGIN_SEARCH" refers="\global\LAMconfig::LOGIN_SEARCH"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1131" package="configuration">
        <name>setLoginMethod</name>
        <full_name>setLoginMethod</full_name>
        <docblock line="1126">
          <description><![CDATA[Sets the login method.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1126" name="param" description="" type="String" variable="$loginMethod">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1131">
          <name>$loginMethod</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1140" package="configuration">
        <name>getLoginSearchFilter</name>
        <full_name>getLoginSearchFilter</full_name>
        <docblock line="1135">
          <description><![CDATA[Returns the login search filter.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1135" name="return" description="search filter" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1149" package="configuration">
        <name>setLoginSearchFilter</name>
        <full_name>setLoginSearchFilter</full_name>
        <docblock line="1144">
          <description><![CDATA[Sets the login search filter.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1144" name="param" description="search filter" type="String" variable="$loginSearchFilter">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1149">
          <name>$loginSearchFilter</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1158" package="configuration">
        <name>getLoginSearchSuffix</name>
        <full_name>getLoginSearchSuffix</full_name>
        <docblock line="1153">
          <description><![CDATA[Returns the login search suffix.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1153" name="return" description="suffix" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1167" package="configuration">
        <name>setLoginSearchSuffix</name>
        <full_name>setLoginSearchSuffix</full_name>
        <docblock line="1162">
          <description><![CDATA[Sets the login search suffix.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1162" name="param" description="suffix" type="String" variable="$loginSearchSuffix">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1167">
          <name>$loginSearchSuffix</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1177" package="configuration">
        <name>setLoginSearchDN</name>
        <full_name>setLoginSearchDN</full_name>
        <docblock line="1171">
          <description><![CDATA[Sets the DN for the login search bind user.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1171" name="param" description="DN" type="String" variable="$loginSearchDN">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1171" name="return" description="true if DN is valid" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1177">
          <name>$loginSearchDN</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1190" package="configuration">
        <name>getLoginSearchDN</name>
        <full_name>getLoginSearchDN</full_name>
        <docblock line="1185">
          <description><![CDATA[Returns the DN for the login search bind user.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1185" name="return" description="DN" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1199" package="configuration">
        <name>setLoginSearchPassword</name>
        <full_name>setLoginSearchPassword</full_name>
        <docblock line="1194">
          <description><![CDATA[Sets the password for the login search bind user.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1194" name="param" description="password" type="String" variable="$loginSearchPassword">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1199">
          <name>$loginSearchPassword</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1208" package="configuration">
        <name>getLoginSearchPassword</name>
        <full_name>getLoginSearchPassword</full_name>
        <docblock line="1203">
          <description><![CDATA[Returns the password for the login search bind user.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1203" name="return" description="password" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1217" package="configuration">
        <name>getHttpAuthentication</name>
        <full_name>getHttpAuthentication</full_name>
        <docblock line="1212">
          <description><![CDATA[Returns if HTTP authentication should be used.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1212" name="return" description="$httpAuthentication use HTTP authentication ('true' or 'false')" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1226" package="configuration">
        <name>setHttpAuthentication</name>
        <full_name>setHttpAuthentication</full_name>
        <docblock line="1221">
          <description><![CDATA[Specifies if HTTP authentication should be used.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1221" name="param" description="use HTTP authentication ('true' or 'false')" type="String" variable="$httpAuthentication">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1226">
          <name>$httpAuthentication</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1235" package="configuration">
        <name>getLamProMailFrom</name>
        <full_name>getLamProMailFrom</full_name>
        <docblock line="1230">
          <description><![CDATA[Returns the sender address for password reset mails.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1230" name="return" description="mail address" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1245" package="configuration">
        <name>setLamProMailFrom</name>
        <full_name>setLamProMailFrom</full_name>
        <docblock line="1239">
          <description><![CDATA[Sets the sender address for password reset mails.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1239" name="param" description="mail address" type="String" variable="$lamProMailFrom">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1239" name="return" description="true if address is valid" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1245">
          <name>$lamProMailFrom</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1258" package="configuration">
        <name>getLamProMailReplyTo</name>
        <full_name>getLamProMailReplyTo</full_name>
        <docblock line="1253">
          <description><![CDATA[Returns the reply-to address for password reset mails.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1253" name="return" description="mail address" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1268" package="configuration">
        <name>setLamProMailReplyTo</name>
        <full_name>setLamProMailReplyTo</full_name>
        <docblock line="1262">
          <description><![CDATA[Sets the reply-to address for password reset mails.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1262" name="param" description="mail address" type="String" variable="$lamProMailReplyTo">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1262" name="return" description="true if address is valid" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1268">
          <name>$lamProMailReplyTo</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1281" package="configuration">
        <name>getLamProMailSubject</name>
        <full_name>getLamProMailSubject</full_name>
        <docblock line="1276">
          <description><![CDATA[Returns the subject for password reset mails.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1276" name="return" description="subject" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1290" package="configuration">
        <name>setLamProMailSubject</name>
        <full_name>setLamProMailSubject</full_name>
        <docblock line="1285">
          <description><![CDATA[Sets the subject for password reset mails.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1285" name="param" description="subject" type="String" variable="$lamProMailSubject">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1290">
          <name>$lamProMailSubject</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1299" package="configuration">
        <name>getLamProMailIsHTML</name>
        <full_name>getLamProMailIsHTML</full_name>
        <docblock line="1294">
          <description><![CDATA[Returns if the password reset mail content should be treated as HTML.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1294" name="return" description="HTML or text" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1308" package="configuration">
        <name>setLamProMailIsHTML</name>
        <full_name>setLamProMailIsHTML</full_name>
        <docblock line="1303">
          <description><![CDATA[Sets if the password reset mail content should be treated as HTML.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1303" name="param" description="" type="boolean" variable="$lamProMailIsHTML">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1308">
          <name>$lamProMailIsHTML</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1317" package="configuration">
        <name>getLamProMailText</name>
        <full_name>getLamProMailText</full_name>
        <docblock line="1312">
          <description><![CDATA[Returns the mail body for password reset mails.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1312" name="return" description="body" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1326" package="configuration">
        <name>setLamProMailText</name>
        <full_name>setLamProMailText</full_name>
        <docblock line="1321">
          <description><![CDATA[Sets the mail body for password reset mails.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1321" name="param" description="body" type="String" variable="$lamProMailText">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1326">
          <name>$lamProMailText</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="1338" package="configuration">
      <extends/>
      <name>LAMCfgMain</name>
      <full_name>\LAMCfgMain</full_name>
      <docblock line="1333">
        <description><![CDATA[This class manages config.cfg.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="1333" name="package" description="configuration"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="1341" namespace="global" package="main">
        <name>$default</name>
        <default><![CDATA[]]></default>
        <docblock line="1340">
          <description><![CDATA[Default profile]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="1344" namespace="global" package="main">
        <name>$password</name>
        <default><![CDATA[]]></default>
        <docblock line="1343">
          <description><![CDATA[Password to change config.cfg]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="1347" namespace="global" package="main">
        <name>$sessionTimeout</name>
        <default><![CDATA[]]></default>
        <docblock line="1346">
          <description><![CDATA[Time of inactivity before session times out (minutes)]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="1350" namespace="global" package="main">
        <name>$logLevel</name>
        <default><![CDATA[]]></default>
        <docblock line="1349">
          <description><![CDATA[log level]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="1353" namespace="global" package="main">
        <name>$logDestination</name>
        <default><![CDATA[]]></default>
        <docblock line="1352">
          <description><![CDATA[log destination ("SYSLOG":syslog, "/.]]></description>
          <long-description><![CDATA[<p>..":file, "NONE":none)</p>]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="1356" namespace="global" package="main">
        <name>$allowedHosts</name>
        <default><![CDATA[]]></default>
        <docblock line="1355">
          <description><![CDATA[list of hosts which may access LAM]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="1359" namespace="global" package="main">
        <name>$passwordMinLength</name>
        <default><![CDATA[0]]></default>
        <docblock line="1358">
          <description><![CDATA[minimum length for passwords]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="1362" namespace="global" package="main">
        <name>$passwordMinUpper</name>
        <default><![CDATA[0]]></default>
        <docblock line="1361">
          <description><![CDATA[minimum uppercase characters]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="1365" namespace="global" package="main">
        <name>$passwordMinLower</name>
        <default><![CDATA[0]]></default>
        <docblock line="1364">
          <description><![CDATA[minimum lowercase characters]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="1368" namespace="global" package="main">
        <name>$passwordMinNumeric</name>
        <default><![CDATA[0]]></default>
        <docblock line="1367">
          <description><![CDATA[minimum numeric characters]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="1371" namespace="global" package="main">
        <name>$passwordMinSymbol</name>
        <default><![CDATA[0]]></default>
        <docblock line="1370">
          <description><![CDATA[minimum symbol characters]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="1374" namespace="global" package="main">
        <name>$passwordMinClasses</name>
        <default><![CDATA[0]]></default>
        <docblock line="1373">
          <description><![CDATA[minimum character classes (upper, lower, numeric, symbols)]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="1377" namespace="global" package="main">
        <name>$conffile</name>
        <default><![CDATA[]]></default>
        <docblock line="1376">
          <description><![CDATA[path to config file]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="1380" namespace="global" package="main">
        <name>$settings</name>
        <default><![CDATA[array("password", "default", "sessionTimeout", "logLevel", "logDestination", "allowedHosts", "passwordMinLength", "passwordMinUpper", "passwordMinLower", "passwordMinNumeric", "passwordMinClasses", "passwordMinSymbol")]]></default>
        <docblock line="1379">
          <description><![CDATA[list of data fields to save in config file]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1388" package="configuration">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="1385">
          <description><![CDATA[Loads preferences from config file]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1403" package="configuration">
        <name>reload</name>
        <full_name>reload</full_name>
        <docblock line="1398">
          <description><![CDATA[Reloads preferences from config file config.cfg]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1398" name="return" description="true if file was readable" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1429" package="configuration">
        <name>save</name>
        <full_name>save</full_name>
        <docblock line="1426">
          <description><![CDATA[Saves preferences to config file config.cfg]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1483" package="configuration">
        <name>setPassword</name>
        <full_name>setPassword</full_name>
        <docblock line="1478">
          <description><![CDATA[Sets a new config password.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1478" name="param" description="new password" type="String" variable="$password">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1483">
          <name>$password</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1497" package="configuration">
        <name>checkPassword</name>
        <full_name>checkPassword</full_name>
        <docblock line="1491">
          <description><![CDATA[Checks if the given password matches.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1491" name="param" description="password" type="String" variable="$password">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1491" name="return" description="true, if password matches" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1497">
          <name>$password</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1518" package="configuration">
        <name>hashPassword</name>
        <full_name>hashPassword</full_name>
        <docblock line="1511">
          <description><![CDATA[Returns the hashed password.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1511" name="param" description="password" type="String" variable="$password">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1511" name="param" description="salt" type="String" variable="$salt">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1511" name="return" description="hash value" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1518">
          <name>$password</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1518">
          <name>$salt</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1527" package="configuration">
        <name>isWritable</name>
        <full_name>isWritable</full_name>
        <docblock line="1522">
          <description><![CDATA[Returns if the configuration file is writable.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1522" name="return" description="writable" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1536" package="configuration">
        <name>isConfigFileExisting</name>
        <full_name>isConfigFileExisting</full_name>
        <docblock line="1531">
          <description><![CDATA[Returns if the configuration file is existing.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1531" name="return" description="exists" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/ufpdf.php" hash="5c65c26a80d0335242c25be28495d1d4" package="PDF">
    <docblock line="2">
      <description><![CDATA[This file includes UFPDF which adds Unicode support to FPDF.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="Steven Wittens"/>
      <tag line="2" name="author" description="Andrea Rossato"/>
      <tag line="2" name="package" description="PDF"/>
    </docblock>
    <include line="86" type="Include" package="main">
      <name/>
    </include>
    <constant namespace="global" line="27" package="PDF">
      <name>UFPDF_VERSION</name>
      <full_name>\UFPDF_VERSION</full_name>
      <value><![CDATA['0.1']]></value>
    </constant>
    <class final="false" abstract="false" namespace="global" line="35" package="PDF">
      <extends>\FPDF</extends>
      <name>UFPDF</name>
      <full_name>\UFPDF</full_name>
      <docblock line="29">
        <description><![CDATA[Main UFPDF class for creating Unicode PDF documents]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="29" name="package" description="PDF"/>
        <tag line="29" name="see" description="\global\FPDF" refers="\global\FPDF"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="43" package="PDF">
        <name>UFPDF</name>
        <full_name>UFPDF</full_name>
        <argument line="43">
          <name>$orientation</name>
          <default><![CDATA['P']]></default>
          <type/>
        </argument>
        <argument line="43">
          <name>$unit</name>
          <default><![CDATA['mm']]></default>
          <type/>
        </argument>
        <argument line="43">
          <name>$format</name>
          <default><![CDATA['A4']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="48" package="PDF">
        <name>GetStringWidth</name>
        <full_name>GetStringWidth</full_name>
        <argument line="48">
          <name>$s</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="71" package="PDF">
        <name>AddFont</name>
        <full_name>AddFont</full_name>
        <argument line="71">
          <name>$family</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="71">
          <name>$style</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
        <argument line="71">
          <name>$file</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="100" package="PDF">
        <name>Text</name>
        <full_name>Text</full_name>
        <argument line="100">
          <name>$x</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="100">
          <name>$y</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="100">
          <name>$txt</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="111" package="PDF">
        <name>AcceptPageBreak</name>
        <full_name>AcceptPageBreak</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="117" package="PDF">
        <name>Cell</name>
        <full_name>Cell</full_name>
        <argument line="117">
          <name>$w</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="117">
          <name>$h</name>
          <default><![CDATA[0]]></default>
          <type/>
        </argument>
        <argument line="117">
          <name>$txt</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
        <argument line="117">
          <name>$border</name>
          <default><![CDATA[0]]></default>
          <type/>
        </argument>
        <argument line="117">
          <name>$ln</name>
          <default><![CDATA[0]]></default>
          <type/>
        </argument>
        <argument line="117">
          <name>$align</name>
          <default><![CDATA['J']]></default>
          <type/>
        </argument>
        <argument line="117">
          <name>$fill</name>
          <default><![CDATA[0]]></default>
          <type/>
        </argument>
        <argument line="117">
          <name>$link</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="197" package="PDF">
        <name>MultiCell</name>
        <full_name>MultiCell</full_name>
        <argument line="197">
          <name>$w</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="197">
          <name>$h</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="197">
          <name>$txt</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="197">
          <name>$border</name>
          <default><![CDATA[0]]></default>
          <type/>
        </argument>
        <argument line="197">
          <name>$align</name>
          <default><![CDATA['J']]></default>
          <type/>
        </argument>
        <argument line="197">
          <name>$fill</name>
          <default><![CDATA[0]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="322" package="PDF">
        <name>Write</name>
        <full_name>Write</full_name>
        <argument line="322">
          <name>$h</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="322">
          <name>$txt</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="322">
          <name>$link</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="405" package="PDF">
        <name>AliasNbPages</name>
        <full_name>AliasNbPages</full_name>
        <argument line="405">
          <name>$alias</name>
          <default><![CDATA['{nb}']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="417" package="PDF">
        <name>_puttruetypeunicode</name>
        <full_name>_puttruetypeunicode</full_name>
        <argument line="417">
          <name>$font</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="479" package="PDF">
        <name>_dounderlineU</name>
        <full_name>_dounderlineU</full_name>
        <argument line="479">
          <name>$x</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="479">
          <name>$y</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="479">
          <name>$width</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="479">
          <name>$txt</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="488" package="PDF">
        <name>_textstring</name>
        <full_name>_textstring</full_name>
        <argument line="488">
          <name>$s</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="496" package="PDF">
        <name>_escapetext</name>
        <full_name>_escapetext</full_name>
        <argument line="496">
          <name>$s</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="504" package="PDF">
        <name>_putinfo</name>
        <full_name>_putinfo</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="520" package="PDF">
        <name>_putpages</name>
        <full_name>_putpages</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="595" package="PDF">
        <name>utf8_to_utf16be</name>
        <full_name>utf8_to_utf16be</full_name>
        <argument line="595">
          <name>$txt</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="595">
          <name>$bom</name>
          <default><![CDATA[true]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="695" package="PDF">
        <name>code2utf</name>
        <full_name>code2utf</full_name>
        <argument line="695">
          <name>$num</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="703" package="PDF">
        <name>strlen</name>
        <full_name>strlen</full_name>
        <argument line="703">
          <name>$s</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="707" package="PDF">
        <name>utf8_substr</name>
        <full_name>utf8_substr</full_name>
        <argument line="707">
          <name>$str</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="707">
          <name>$start</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="725" package="PDF">
        <name>utf8_to_codepoints</name>
        <full_name>utf8_to_codepoints</full_name>
        <argument line="725">
          <name>$txt</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <parse_markers>
      <error line="43" code="50010">No DocBlock was found for method UFPDF()</error>
      <error line="48" code="50010">No DocBlock was found for method GetStringWidth()</error>
      <error line="71" code="50010">No DocBlock was found for method AddFont()</error>
      <error line="100" code="50010">No DocBlock was found for method Text()</error>
      <error line="111" code="50010">No DocBlock was found for method AcceptPageBreak()</error>
      <error line="117" code="50010">No DocBlock was found for method Cell()</error>
      <error line="197" code="50010">No DocBlock was found for method MultiCell()</error>
      <error line="322" code="50010">No DocBlock was found for method Write()</error>
      <error line="405" code="50010">No DocBlock was found for method AliasNbPages()</error>
      <error line="417" code="50010">No DocBlock was found for method _puttruetypeunicode()</error>
      <error line="479" code="50010">No DocBlock was found for method _dounderlineU()</error>
      <error line="488" code="50010">No DocBlock was found for method _textstring()</error>
      <error line="496" code="50010">No DocBlock was found for method _escapetext()</error>
      <error line="504" code="50010">No DocBlock was found for method _putinfo()</error>
      <error line="520" code="50010">No DocBlock was found for method _putpages()</error>
      <error line="595" code="50010">No DocBlock was found for method utf8_to_utf16be()</error>
      <error line="695" code="50010">No DocBlock was found for method code2utf()</error>
      <error line="703" code="50010">No DocBlock was found for method strlen()</error>
      <error line="707" code="50010">No DocBlock was found for method utf8_substr()</error>
      <error line="725" code="50010">No DocBlock was found for method utf8_to_codepoints()</error>
    </parse_markers>
  </file>
  <file path="lib/modules/asteriskAccount.inc" hash="53af8bf48c1b4e24bbc23ff4761ca8e4" package="modules">
    <docblock line="26">
      <description><![CDATA[Manages the Asterisk extension of user accounts.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="26" name="package" description="modules"/>
      <tag line="26" name="author" description="Pavel Pozdnyak"/>
      <tag line="26" name="author" description="Roland Gruber"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="40" package="modules">
      <extends>\baseModule</extends>
      <implements>\passwordService</implements>
      <name>asteriskAccount</name>
      <full_name>\asteriskAccount</full_name>
      <docblock line="35">
        <description><![CDATA[Manages the Asterisk extension of user accounts.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="35" name="package" description="modules"/>
      </docblock>
      <constant namespace="global" line="42" package="modules">
        <name>ASTERISK_DEFAULT_REALM</name>
        <full_name>ASTERISK_DEFAULT_REALM</full_name>
        <value><![CDATA["asterisk"]]></value>
      </constant>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="49" package="modules">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="44">
          <description><![CDATA[Creates a new asteriskAccount object.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="44" name="param" description="account type (user, group, host)" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="49">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="60" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="55">
          <description><![CDATA[Returns meta data that is interpreted by parent class.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="55" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="616" package="modules">
        <name>load_Messages</name>
        <full_name>load_Messages</full_name>
        <docblock line="613">
          <description><![CDATA[This function fills the error message array with messages]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="647" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="642">
          <description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="642" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="976" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="973">
          <description><![CDATA[Write variables into object and do some regex checks]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1176" package="modules">
        <name>save_attributes</name>
        <full_name>save_attributes</full_name>
        <docblock line="1164">
          <description><![CDATA[Returns a list of modifications which have to be made to the LDAP account.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1164" name="return" description="list of modifications &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 may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) &lt;br&gt;&quot;add&quot; are attributes which have to be added to LDAP entry &lt;br&gt;&quot;remove&quot; are attributes which have to be removed from LDAP entry &lt;br&gt;&quot;modify&quot; are attributes which have to been modified in LDAP entry &lt;br&gt;&quot;info&quot; are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1186" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="1183">
          <description><![CDATA[Returns a list of PDF entries]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1233" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>build_uploadAccounts</full_name>
        <docblock line="1224">
          <description><![CDATA[In this function the LDAP account is built up.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1224" name="param" description="list of hash arrays (name =&gt; value) from user input" type="array" variable="$rawAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1224" name="param" description="list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1224" name="param" description="list of hash arrays (name =&gt; value) which are later added to LDAP" type="array" variable="$partialAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1224" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1224" name="return" description="list of error messages if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1233">
          <name>$rawAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1233">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1233">
          <name>$partialAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1233">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1447" package="modules">
        <name>managesPasswordAttributes</name>
        <full_name>managesPasswordAttributes</full_name>
        <docblock line="1441">
          <description><![CDATA[This method specifies if a module manages password attributes.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1441" name="see" description="\global\passwordService::managesPasswordAttributes" refers="\global\passwordService::managesPasswordAttributes"/>
          <tag line="1441" name="return" description="true if this module manages password attributes" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1459" package="modules">
        <name>supportsForcePasswordChange</name>
        <full_name>supportsForcePasswordChange</full_name>
        <docblock line="1454">
          <description><![CDATA[Specifies if this module supports to force that a user must change his password on next login.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1454" name="return" description="force password change supported" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1474" package="modules">
        <name>passwordChangeRequested</name>
        <full_name>passwordChangeRequested</full_name>
        <docblock line="1463">
          <description><![CDATA[This function is called whenever the password should be changed.]]></description>
          <long-description><![CDATA[<p>Account modules
must change their password attributes only if the modules list contains their module name.</p>]]></long-description>
          <tag line="1463" name="param" description="new password" type="String" variable="$password">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1463" name="param" description="list of modules for which the password should be changed" type="\$modules" variable="$modules">
            <type by_reference="false">\$modules</type>
          </tag>
          <tag line="1463" name="param" description="force the user to change his password at next login" type="boolean" variable="$forcePasswordChange">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="1463" name="return" description="list of error messages if any as parameter array for StatusMessage e.g. return arrray(array('ERROR', 'Password change failed.'))" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1463" name="see" description="\global\passwordService::passwordChangeRequested" refers="\global\passwordService::passwordChangeRequested"/>
        </docblock>
        <argument line="1474">
          <name>$password</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1474">
          <name>$modules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1474">
          <name>$forcePasswordChange</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="global" line="1490" package="modules">
        <name>buildPasswordString</name>
        <full_name>buildPasswordString</full_name>
        <docblock line="1482">
          <description><![CDATA[Builds the password string for the password attribute.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1482" name="param" description="LDAP attributes" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1482" name="param" description="module configuration settings" type="array" variable="$moduleSettings">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1482" name="param" description="password" type="String" variable="$password">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1482" name="return" description="value for password attribute" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1490">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1490">
          <name>$moduleSettings</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1490">
          <name>$password</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="private" namespace="global" line="1505" package="modules">
        <name>hashPassword</name>
        <full_name>hashPassword</full_name>
        <docblock line="1499">
          <description><![CDATA[Hashes a password value to Asterisk format.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1499" name="param" description="password" type="String" variable="$password">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1499" name="return" description="hash" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1505">
          <name>$password</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1526" package="modules">
        <name>checkSelfServiceOptions</name>
        <full_name>checkSelfServiceOptions</full_name>
        <docblock line="1509">
          <description><![CDATA[Checks if all input values are correct and returns the LDAP attributes which should be changed.]]></description>
          <long-description><![CDATA[<p><br>Return values:
<br>messages: array of parameters to create status messages
<br>add: array of attributes to add
<br>del: array of attributes to remove
<br>mod: array of attributes to modify
<br>info: array of values with informational value (e.g. to be used later by pre/postModify actions)</p>

<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.</p>]]></long-description>
          <tag line="1509" name="param" description="input fields" type="string" variable="$fields">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1509" name="param" description="LDAP attributes" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1509" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="1509" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1509" name="return" description="messages and attributes (array('messages' =&gt; array(), 'add' =&gt; array('mail' =&gt; array('test@test.com')), 'del' =&gt; array(), 'mod' =&gt; array(), 'info' =&gt; array()))" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1526">
          <name>$fields</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1526">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1526">
          <name>$passwordChangeOnly</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1526">
          <name>$readOnlyFields</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="lib/modules/account.inc" hash="edf7f37ce9556d6c6cecb5d59af40def" package="modules">
    <docblock line="24">
      <description><![CDATA[Manages the object class "account" for users and hosts.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="package" description="modules"/>
      <tag line="24" name="author" description="Tilo Lutz"/>
      <tag line="24" name="author" description="Roland Gruber"/>
      <tag line="24" name="author" description="Michael Duergner"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="39" package="modules">
      <extends>\baseModule</extends>
      <name>account</name>
      <full_name>\account</full_name>
      <docblock line="34">
        <description><![CDATA[Manages the object class "account" for users and hosts.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="34" name="package" description="modules"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="48" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="41">
          <description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="41" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="41" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="116" package="modules">
        <name>load_Messages</name>
        <full_name>load_Messages</full_name>
        <docblock line="113">
          <description><![CDATA[This function fills the message array.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="128" package="modules">
        <name>module_complete</name>
        <full_name>module_complete</full_name>
        <docblock line="123">
          <description><![CDATA[This functions returns true if all needed settings are done.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="123" name="return" description="true if LDAP operation can be done" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="139" package="modules">
        <name>getButtonStatus</name>
        <full_name>getButtonStatus</full_name>
        <docblock line="134">
          <description><![CDATA[Controls if the module button the account page is visible and activated.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="134" name="return" description="status (&quot;enabled&quot;, &quot;disabled&quot;, &quot;hidden&quot;)" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="162" package="modules">
        <name>save_attributes</name>
        <full_name>save_attributes</full_name>
        <docblock line="150">
          <description><![CDATA[Returns a list of modifications which have to be made to the LDAP account.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="150" name="return" description="list of modifications &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 may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) &lt;br&gt;&quot;add&quot; are attributes which have to be added to LDAP entry &lt;br&gt;&quot;remove&quot; are attributes which have to be removed from LDAP entry &lt;br&gt;&quot;modify&quot; are attributes which have to been modified in LDAP entry &lt;br&gt;&quot;info&quot; are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="179" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="173">
          <description><![CDATA[Processes user input of the primary module page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="173" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="198" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="193">
          <description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="193" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="230" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="225">
          <description><![CDATA[Returns the PDF entries for this module.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="225" name="return" description="list of possible PDF entries" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="252" package="modules">
        <name>get_uploadColumns</name>
        <full_name>get_uploadColumns</full_name>
        <docblock line="237">
          <description><![CDATA[Returns an array containing all input columns for the file upload.]]></description>
          <long-description><![CDATA[<p>Syntax:
<br> array(
<br>  string: name,  // fixed non-translated name which is used as column name (should be of format: <module name>_<column name>)
<br>  string: description,  // short descriptive name
<br>  string: help,  // help ID
<br>  string: example,  // example value
<br>  boolean: required  // true, if user must set a value for this column
<br> )</p>]]></long-description>
          <tag line="237" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="237" name="return" description="column list" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="252">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="274" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>build_uploadAccounts</full_name>
        <docblock line="265">
          <description><![CDATA[In this function the LDAP account is built up.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="265" name="param" description="list of hash arrays (name =&gt; value) from user input" type="array" variable="$rawAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="265" name="param" description="list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="265" name="param" description="list of hash arrays (name =&gt; value) which are later added to LDAP" type="array" variable="$partialAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="265" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="265" name="return" description="list of error messages if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="274">
          <name>$rawAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="274">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="274">
          <name>$partialAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="274">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="lib/modules/ieee802device.inc" hash="9f721a849ac00bae33a375c7b4a8df2d" package="modules">
    <docblock line="23">
      <description><![CDATA[Provides MAC addresses for hosts.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="23" name="package" description="modules"/>
      <tag line="23" name="author" description="Roland Gruber"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="35" package="modules">
      <extends>\baseModule</extends>
      <name>ieee802device</name>
      <full_name>\ieee802device</full_name>
      <docblock line="30">
        <description><![CDATA[Provides MAC addresses for hosts.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="30" name="package" description="modules"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="44" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="37">
          <description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="37" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="37" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="87" package="modules">
        <name>load_Messages</name>
        <full_name>load_Messages</full_name>
        <docblock line="84">
          <description><![CDATA[This function fills the error message array with messages]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="97" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="92">
          <description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="92" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="131" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="125">
          <description><![CDATA[Processes user input of the primary module page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="125" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="174" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>build_uploadAccounts</full_name>
        <docblock line="165">
          <description><![CDATA[In this function the LDAP account is built up.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="165" name="param" description="list of hash arrays (name =&gt; value) from user input" type="array" variable="$rawAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="165" name="param" description="list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="165" name="param" description="list of hash arrays (name =&gt; value) which are later added to LDAP" type="array" variable="$partialAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="165" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="165" name="return" description="list of error messages if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="174">
          <name>$rawAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="174">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="174">
          <name>$partialAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="174">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="203" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="198">
          <description><![CDATA[Returns the PDF entries for this module.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="198" name="return" description="list of possible PDF entries" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/modules/puppetClient.inc" hash="e58bff948676091c09a3137bedc249c5" package="modules">
    <docblock line="25">
      <description><![CDATA[Manages Puppet configuration options.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="25" name="package" description="modules"/>
      <tag line="25" name="author" description="Roland Gruber"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="37" package="modules">
      <extends>\baseModule</extends>
      <name>puppetClient</name>
      <full_name>\puppetClient</full_name>
      <docblock line="32">
        <description><![CDATA[Manages Puppet configuration options.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="32" name="package" description="modules"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="44" package="modules">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="39">
          <description><![CDATA[Creates a new authorizedServiceObject object.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="39" name="param" description="account type (user, group, host)" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="44">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="56" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="51">
          <description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="51" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="176" package="modules">
        <name>load_Messages</name>
        <full_name>load_Messages</full_name>
        <docblock line="173">
          <description><![CDATA[This function fills the error message array with messages]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="198" package="modules">
        <name>save_attributes</name>
        <full_name>save_attributes</full_name>
        <docblock line="186">
          <description><![CDATA[Returns a list of modifications which have to be made to the LDAP account.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="186" name="return" description="list of modifications &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 may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) &lt;br&gt;&quot;add&quot; are attributes which have to be added to LDAP entry &lt;br&gt;&quot;remove&quot; are attributes which have to be removed from LDAP entry &lt;br&gt;&quot;modify&quot; are attributes which have to been modified in LDAP entry &lt;br&gt;&quot;info&quot; are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="211" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="206">
          <description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="206" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="285" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="279">
          <description><![CDATA[Processes user input of the primary module page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="279" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="362" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>build_uploadAccounts</full_name>
        <docblock line="353">
          <description><![CDATA[In this function the LDAP account is built up.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="353" name="param" description="list of hash arrays (name =&gt; value) from user input" type="array" variable="$rawAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="353" name="param" description="list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="353" name="param" description="list of hash arrays (name =&gt; value) which are later added to LDAP" type="array" variable="$partialAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="353" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="353" name="return" description="list of error messages if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="362">
          <name>$rawAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="362">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="362">
          <name>$partialAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="362">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="418" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="413">
          <description><![CDATA[Returns the PDF entries for this module.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="413" name="return" description="list of possible PDF entries" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="455" package="modules">
        <name>get_profileOptions</name>
        <full_name>get_profileOptions</full_name>
        <docblock line="440">
          <description><![CDATA[This function defines what attributes will be used in the account profiles and their appearance in the profile editor.]]></description>
          <long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
<br>
The return value is an object implementing htmlElement.<br>
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.</p>]]></long-description>
          <tag line="440" name="return" description="meta HTML object" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
          <tag line="440" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
          <tag line="440" name="see" description="\global\htmlElement" refers="\global\htmlElement"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="469" package="modules">
        <name>load_profile</name>
        <full_name>load_profile</full_name>
        <docblock line="464">
          <description><![CDATA[Loads the values of an account profile into internal variables.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="464" name="param" description="hash array with profile values (identifier =&gt; value)" type="array" variable="$profile">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="469">
          <name>$profile</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="497" package="modules">
        <name>getPossibleParentNodes</name>
        <full_name>getPossibleParentNodes</full_name>
        <docblock line="492">
          <description><![CDATA[Reurns a list of valid parent nodes for this node.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="492" name="return" description="parent nodes (e.g. array('node1', 'node2'))" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/modules/windowsHost.inc" hash="df1c33c3581f4c43bb5845b55b7911c1" package="modules">
    <docblock line="23">
      <description><![CDATA[Manages Windows AD (e.g.]]></description>
      <long-description><![CDATA[<p>Samba 4) hosts.</p>]]></long-description>
      <tag line="23" name="package" description="modules"/>
      <tag line="23" name="author" description="Roland Gruber"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="35" package="modules">
      <extends>\baseModule</extends>
      <name>windowsHost</name>
      <full_name>\windowsHost</full_name>
      <docblock line="30">
        <description><![CDATA[Manages Windows AD (e.g.]]></description>
        <long-description><![CDATA[<p>Samba 4) hosts.</p>]]></long-description>
        <tag line="30" name="package" description="modules"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="44" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="37">
          <description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="37" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="37" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="123" package="modules">
        <name>load_Messages</name>
        <full_name>load_Messages</full_name>
        <docblock line="120">
          <description><![CDATA[This function fills the $messages variable with output messages from this module.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="133" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="128">
          <description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="128" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="163" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="157">
          <description><![CDATA[Processes user input of the primary module page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="157" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="190" package="modules">
        <name>display_html_managedBy</name>
        <full_name>display_html_managedBy</full_name>
        <docblock line="185">
          <description><![CDATA[This function will create the meta HTML code to show a page to change the member attribute.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="185" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="230" package="modules">
        <name>process_managedBy</name>
        <full_name>process_managedBy</full_name>
        <docblock line="224">
          <description><![CDATA[Processes user input of the members page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="224" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="247" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>build_uploadAccounts</full_name>
        <docblock line="238">
          <description><![CDATA[In this function the LDAP account is built up.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="238" name="param" description="list of hash arrays (name =&gt; value) from user input" type="array" variable="$rawAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="238" name="param" description="list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="238" name="param" description="list of hash arrays (name =&gt; value) which are later added to LDAP" type="array" variable="$partialAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="238" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="238" name="return" description="list of error messages if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="247">
          <name>$rawAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="247">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="247">
          <name>$partialAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="247">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="285" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="282">
          <description><![CDATA[Returns a list of PDF entries]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/modules/posixGroup.inc" hash="067998c892e4919040ba34c75cc0413a" package="modules">
    <docblock line="25">
      <description><![CDATA[Manages Unix accounts for groups.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="25" name="package" description="modules"/>
      <tag line="25" name="author" description="Tilo Lutz"/>
      <tag line="25" name="author" description="Roland Gruber"/>
      <tag line="25" name="author" description="Michael Duergner"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="40" package="modules">
      <extends>\baseModule</extends>
      <implements>\passwordService</implements>
      <name>posixGroup</name>
      <full_name>\posixGroup</full_name>
      <docblock line="35">
        <description><![CDATA[Manages the object class "posixGroup" for groups.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="35" name="package" description="modules"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="43" namespace="global" package="main">
        <name>$changegids</name>
        <default><![CDATA[]]></default>
        <docblock line="42">
          <description><![CDATA[change GIDs of users and hosts?]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="45" namespace="global" package="main">
        <name>$manageCnAttribute</name>
        <default><![CDATA[true]]></default>
        <docblock line="44">
          <description><![CDATA[specifies if the cn attribute should be managed by this module]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="47" namespace="global" package="main">
        <name>$manageDescriptionAttribute</name>
        <default><![CDATA[true]]></default>
        <docblock line="46">
          <description><![CDATA[specifies if the description attribute should be managed by this module]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="49" namespace="global" package="main">
        <name>$cachedGIDList</name>
        <default><![CDATA[null]]></default>
        <docblock line="48">
          <description><![CDATA[cache for existing GID numbers]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="51" namespace="global" package="main">
        <name>$cachedUserToGIDList</name>
        <default><![CDATA[null]]></default>
        <docblock line="50">
          <description><![CDATA[cache for existing users and their GIDs]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="53" namespace="global" package="main">
        <name>$cachedGroupNameList</name>
        <default><![CDATA[null]]></default>
        <docblock line="52">
          <description><![CDATA[cache for existing groups]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="64" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>build_uploadAccounts</full_name>
        <docblock line="55">
          <description><![CDATA[In this function the LDAP account is built up.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="55" name="param" description="list of hash arrays (name =&gt; value) from user input" type="array" variable="$rawAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="55" name="param" description="list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="55" name="param" description="list of hash arrays (name =&gt; value) which are later added to LDAP" type="array" variable="$partialAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="55" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="55" name="return" description="list of error messages if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="64">
          <name>$rawAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="64">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="64">
          <name>$partialAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="64">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="144" package="modules">
        <name>delete_attributes</name>
        <full_name>delete_attributes</full_name>
        <docblock line="139">
          <description><![CDATA[Checks if the group which should be deleted is still used as primary group.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="139" name="return" description="of LDAP operations, same as for save_attributes()" type="\List">
            <type by_reference="false">\List</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="170" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="163">
          <description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="163" name="return" description="HTML meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="163" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="230" package="modules">
        <name>display_html_user</name>
        <full_name>display_html_user</full_name>
        <docblock line="225">
          <description><![CDATA[Displays selections to add or remove users from current group.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="225" name="return" description="meta HTML output" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="319" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="314">
          <description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="314" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="484" package="modules">
        <name>get_configOptions</name>
        <full_name>get_configOptions</full_name>
        <docblock line="477">
          <description><![CDATA[Returns a list of elements for the configuration.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="477" name="param" description="account types (user, group, host)" type="array" variable="$scopes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="477" name="param" description="list of all modules and active scopes" type="array" variable="$allScopes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="477" name="return" description="configuration elements" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="484">
          <name>$scopes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="484">
          <name>$allScopes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="498" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="493">
          <description><![CDATA[Returns the PDF entries for this module.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="493" name="return" description="list of possible PDF entries" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="518" package="modules">
        <name>init</name>
        <full_name>init</full_name>
        <docblock line="513">
          <description><![CDATA[This functin will be called when the module will be loaded]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="513" name="param" description="the name of the {@link accountContainer} object ($_SESSION[$base])" type="String" variable="$base">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="518">
          <name>$base</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="528" package="modules">
        <name>load_Messages</name>
        <full_name>load_Messages</full_name>
        <docblock line="525">
          <description><![CDATA[This function fills the $messages variable with output messages from this module.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="553" package="modules">
        <name>module_complete</name>
        <full_name>module_complete</full_name>
        <docblock line="548">
          <description><![CDATA[This functions is used to check if all settings for this module have been made.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="548" name="return" description="true, if settings are complete" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="572" package="modules">
        <name>getButtonStatus</name>
        <full_name>getButtonStatus</full_name>
        <docblock line="567">
          <description><![CDATA[Controls if the module button the account page is visible and activated.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="567" name="return" description="status (&quot;enabled&quot;, &quot;disabled&quot;, &quot;hidden&quot;)" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="590" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="584">
          <description><![CDATA[Processes user input of the primary module page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="584" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="718" package="modules">
        <name>process_user</name>
        <full_name>process_user</full_name>
        <docblock line="712">
          <description><![CDATA[Processes user input of the user selection page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="712" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="743" package="modules">
        <name>save_attributes</name>
        <full_name>save_attributes</full_name>
        <docblock line="731">
          <description><![CDATA[Returns a list of modifications which have to be made to the LDAP account.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="731" name="return" description="list of modifications &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 may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) &lt;br&gt;&quot;add&quot; are attributes which have to be added to LDAP entry &lt;br&gt;&quot;remove&quot; are attributes which have to be removed from LDAP entry &lt;br&gt;&quot;modify&quot; are attributes which have to been modified in LDAP entry &lt;br&gt;&quot;info&quot; are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="776" package="modules">
        <name>check_configOptions</name>
        <full_name>check_configOptions</full_name>
        <docblock line="762">
          <description><![CDATA[Checks input values of module settings.]]></description>
          <long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
<br>
If the input data is invalid the return value is an array that contains subarrays to build StatusMessages ('message type', 'message head', 'message text').
<br>If no errors occured the function returns an empty array.</p>]]></long-description>
          <tag line="762" name="param" description="list of account types which are used" type="array" variable="$scopes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="762" name="param" description="hash array (option name =&gt; value) that contains the input. The option values are all arrays containing one or more elements." type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="762" name="return" description="list of error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="762" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
        <argument line="776">
          <name>$scopes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="776">
          <name>$options</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="814" package="modules">
        <name>getNextGIDs</name>
        <full_name>getNextGIDs</full_name>
        <docblock line="807">
          <description><![CDATA[Returns one or more free GID numbers.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="807" name="param" description="Number of needed free GIDs." type="integer" variable="$count">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="807" name="param" description="list of error messages where errors can be added" type="array" variable="$errors">
            <type by_reference="false">array</type>
          </tag>
          <tag line="807" name="return" description="Null if no GIDs are free else an array of free GIDs." type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="814">
          <name>$count</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="814">
          <name>$errors</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="872" package="modules">
        <name>getNextSambaPoolGIDs</name>
        <full_name>getNextSambaPoolGIDs</full_name>
        <docblock line="865">
          <description><![CDATA[Gets the free GID numbers from an Samba pool entry in LDAP.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="865" name="param" description="number of needed free GIDs." type="integer" variable="$count">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="865" name="param" description="list of error messages where errors can be added" type="array" variable="$errors">
            <type by_reference="false">array</type>
          </tag>
          <tag line="865" name="return" description="null if no GIDs are free else an array of free GIDs" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="872">
          <name>$count</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="872">
          <name>$errors</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="899" package="modules">
        <name>managesPasswordAttributes</name>
        <full_name>managesPasswordAttributes</full_name>
        <docblock line="893">
          <description><![CDATA[This method specifies if a module manages password attributes.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="893" name="see" description="\global\passwordService::managesPasswordAttributes" refers="\global\passwordService::managesPasswordAttributes"/>
          <tag line="893" name="return" description="true if this module manages password attributes" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="908" package="modules">
        <name>supportsForcePasswordChange</name>
        <full_name>supportsForcePasswordChange</full_name>
        <docblock line="903">
          <description><![CDATA[Specifies if this module supports to force that a user must change his password on next login.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="903" name="return" description="force password change supported" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="923" package="modules">
        <name>passwordChangeRequested</name>
        <full_name>passwordChangeRequested</full_name>
        <docblock line="912">
          <description><![CDATA[This function is called whenever the password should be changed.]]></description>
          <long-description><![CDATA[<p>Account modules
must change their password attributes only if the modules list contains their module name.</p>]]></long-description>
          <tag line="912" name="param" description="new password" type="String" variable="$password">
            <type by_reference="false">String</type>
          </tag>
          <tag line="912" name="param" description="list of modules for which the password should be changed" type="\$modules" variable="$modules">
            <type by_reference="false">\$modules</type>
          </tag>
          <tag line="912" name="param" description="force the user to change his password at next login" type="boolean" variable="$forcePasswordChange">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="912" name="return" description="list of error messages if any as parameter array for StatusMessage e.g. return arrray(array('ERROR', 'Password change failed.'))" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="912" name="see" description="\global\passwordService::passwordChangeRequested" refers="\global\passwordService::passwordChangeRequested"/>
        </docblock>
        <argument line="923">
          <name>$password</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="923">
          <name>$modules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="923">
          <name>$forcePasswordChange</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="936" package="modules">
        <name>getGIDs</name>
        <full_name>getGIDs</full_name>
        <docblock line="931">
          <description><![CDATA[Returns a list of existing GID numbers.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="931" name="return" description="list of GID numbers" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="960" package="modules">
        <name>getUsers</name>
        <full_name>getUsers</full_name>
        <docblock line="955">
          <description><![CDATA[Returns a list of existing users and their GID numbers and cn.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="955" name="return" description="list in format array(uid =&gt; array('gid' =&gt; 123, 'cn' =&gt; 'Some user'))" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="979" package="modules">
        <name>groupNameExists</name>
        <full_name>groupNameExists</full_name>
        <docblock line="973">
          <description><![CDATA[Checks if the given group name already exists in LDAP.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="973" name="param" description="group name" type="String" variable="$groupName">
            <type by_reference="false">String</type>
          </tag>
          <tag line="973" name="return" description="true if already exists" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="979">
          <name>$groupName</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="988" package="modules">
        <name>getGroupNames</name>
        <full_name>getGroupNames</full_name>
        <docblock line="983">
          <description><![CDATA[Returns a list of all group names in LDAP.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="983" name="return" description="group names" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/modules/dhcp_settings.inc" hash="357a383d085725c1722f1b74b82fc50e" package="modules">
    <docblock line="25">
      <description><![CDATA[Manages DHCP entries.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="25" name="package" description="modules"/>
      <tag line="25" name="author" description="Thomas Manninger"/>
      <tag line="25" name="author" description="Roland Gruber"/>
    </docblock>
    <function namespace="global" line="49" package="modules">
      <name>check_ip</name>
      <full_name>\check_ip</full_name>
      <docblock line="43">
        <description><![CDATA[Checks if the given IP is valid.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="43" name="param" description="IP address" type="String" variable="$ip">
          <type by_reference="false">String</type>
        </tag>
        <tag line="43" name="param" description="IP must be a subnet" type="boolean" variable="$subnet">
          <type by_reference="false">boolean</type>
        </tag>
      </docblock>
      <argument line="49">
        <name>$ip</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="49">
        <name>$subnet</name>
        <default><![CDATA[false]]></default>
        <type/>
      </argument>
    </function>
    <class final="false" abstract="false" namespace="global" line="79" package="modules">
      <extends>\baseModule</extends>
      <name>dhcp_settings</name>
      <full_name>\dhcp_settings</full_name>
      <docblock line="74">
        <description><![CDATA[Manages DHCP entries.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="74" name="package" description="modules"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="82" namespace="global" package="main">
        <name>$all_netbios_node_types</name>
        <default><![CDATA[]]></default>
        <docblock line="81">
          <description><![CDATA[all netbios node types]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="84" namespace="global" package="main">
        <name>$attributes</name>
        <default><![CDATA[]]></default>
        <docblock line="83">
          <description><![CDATA[LDAP attributes]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="91" package="modules">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="86">
          <description><![CDATA[Creates a new dhcp_settings object.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="86" name="param" description="account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="91">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="108" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="103">
          <description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="103" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="289" package="modules">
        <name>load_Messages</name>
        <full_name>load_Messages</full_name>
        <docblock line="286">
          <description><![CDATA[This function fills the message array.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="325" package="modules">
        <name>save_attributes</name>
        <full_name>save_attributes</full_name>
        <docblock line="313">
          <description><![CDATA[Returns a list of modifications which have to be made to the LDAP account.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="313" name="return" description="list of modifications &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 may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) &lt;br&gt;&quot;add&quot; are attributes which have to be added to LDAP entry &lt;br&gt;&quot;remove&quot; are attributes which have to be removed from LDAP entry &lt;br&gt;&quot;modify&quot; are attributes which have to been modified in LDAP entry &lt;br&gt;&quot;info&quot; are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="342" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="336">
          <description><![CDATA[Processes user input of the primary module page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="336" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="481" package="modules">
        <name>checkSubnetMask</name>
        <full_name>checkSubnetMask</full_name>
        <docblock line="475">
          <description><![CDATA[Checks if the subnet mask is valid.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="475" name="param" description="subnet mask" type="String" variable="$mask">
            <type by_reference="false">String</type>
          </tag>
          <tag line="475" name="return" description="correct or incorrect" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="481">
          <name>$mask</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="501" package="modules">
        <name>calculateNetMask</name>
        <full_name>calculateNetMask</full_name>
        <docblock line="495">
          <description><![CDATA[Calculates the net mask from the subnet.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="495" name="param" description="subnet" type="String" variable="$subnet">
            <type by_reference="false">String</type>
          </tag>
          <tag line="495" name="return" description="netmask" type="integer">
            <type by_reference="false">integer</type>
          </tag>
        </docblock>
        <argument line="501">
          <name>$subnet</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="516" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="511">
          <description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="511" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="590" package="modules">
        <name>load_profile</name>
        <full_name>load_profile</full_name>
        <docblock line="585">
          <description><![CDATA[Loads the values of an account profile into internal variables.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="585" name="param" description="hash array with profile values (identifier =&gt; value)" type="array" variable="$profile">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="590">
          <name>$profile</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="623" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="618">
          <description><![CDATA[Returns the PDF entries for this module.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="618" name="return" description="list of possible PDF entries" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="651" package="modules">
        <name>getDHCPOption</name>
        <full_name>getDHCPOption</full_name>
        <docblock line="645">
          <description><![CDATA[Returns a DHCP option.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="645" name="param" description="option name" type="String" variable="$name">
            <type by_reference="false">String</type>
          </tag>
          <tag line="645" name="return" description="value" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="651">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="671" package="modules">
        <name>setDHCPOption</name>
        <full_name>setDHCPOption</full_name>
        <docblock line="665">
          <description><![CDATA[Sets a DHCP option.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="665" name="param" description="option name" type="String" variable="$name">
            <type by_reference="false">String</type>
          </tag>
          <tag line="665" name="param" description="option value" type="String" variable="$value">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="671">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="671">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="691" package="modules">
        <name>getDefaultLeaseTime</name>
        <full_name>getDefaultLeaseTime</full_name>
        <docblock line="686">
          <description><![CDATA[Returns the default lease time.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="686" name="return" description="time" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="709" package="modules">
        <name>setDefaultLeaseTime</name>
        <full_name>setDefaultLeaseTime</full_name>
        <docblock line="704">
          <description><![CDATA[Sets the default lease time.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="704" name="param" description="time" type="String" variable="$time">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="709">
          <name>$time</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="729" package="modules">
        <name>getMaxLeaseTime</name>
        <full_name>getMaxLeaseTime</full_name>
        <docblock line="724">
          <description><![CDATA[Returns the maximum lease time.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="724" name="return" description="time" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="747" package="modules">
        <name>setMaxLeaseTime</name>
        <full_name>setMaxLeaseTime</full_name>
        <docblock line="742">
          <description><![CDATA[Sets the maximum lease time.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="742" name="param" description="time" type="String" variable="$time">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="747">
          <name>$time</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="771" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>build_uploadAccounts</full_name>
        <docblock line="762">
          <description><![CDATA[In this function the LDAP account is built up.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="762" name="param" description="list of hash arrays (name =&gt; value) from user input" type="array" variable="$rawAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="762" name="param" description="list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="762" name="param" description="list of hash arrays (name =&gt; value) which are later added to LDAP" type="array" variable="$partialAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="762" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="762" name="return" description="list of error messages if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="771">
          <name>$rawAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="771">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="771">
          <name>$partialAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="771">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="lib/modules/eduPerson.inc" hash="b6ca5797f002a3063775333f7d2f8ed6" package="modules">
    <docblock line="23">
      <description><![CDATA[Manages the eduPerson extension for user accounts.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="23" name="package" description="modules"/>
      <tag line="23" name="author" description="Roland Gruber"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="35" package="modules">
      <extends>\baseModule</extends>
      <name>eduPerson</name>
      <full_name>\eduPerson</full_name>
      <docblock line="30">
        <description><![CDATA[Manages the eduPerson extension for user accounts.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="30" name="package" description="modules"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="38" namespace="global" package="main">
        <name>$affiliationTypes</name>
        <default><![CDATA[array('faculty', 'student', 'staff', 'alum', 'member', 'affiliate', 'employee', 'library-walk-in')]]></default>
        <docblock line="37">
          <description><![CDATA[possible affiliation types]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="46" package="modules">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="41">
          <description><![CDATA[Creates a new eduPerson object.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="41" name="param" description="account type (user, group, host)" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="46">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="58" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="51">
          <description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="51" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="51" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="235" package="modules">
        <name>load_Messages</name>
        <full_name>load_Messages</full_name>
        <docblock line="232">
          <description><![CDATA[This function fills the error message array with messages]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="254" package="modules">
        <name>module_complete</name>
        <full_name>module_complete</full_name>
        <docblock line="249">
          <description><![CDATA[This functions return true if all needed settings are done.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="249" name="return" description="true, if all is ok" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="266" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="261">
          <description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="261" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="492" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="486">
          <description><![CDATA[Processes user input of the primary module page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="486" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="623" package="modules">
        <name>load_profile</name>
        <full_name>load_profile</full_name>
        <docblock line="618">
          <description><![CDATA[Loads the values of an account profile into internal variables.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="618" name="param" description="hash array with profile values (identifier =&gt; value)" type="array" variable="$profile">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="623">
          <name>$profile</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="642" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>build_uploadAccounts</full_name>
        <docblock line="633">
          <description><![CDATA[In this function the LDAP account is built up.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="633" name="param" description="list of hash arrays (name =&gt; value) from user input" type="array" variable="$rawAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="633" name="param" description="list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="633" name="param" description="list of hash arrays (name =&gt; value) which are later added to LDAP" type="array" variable="$partialAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="633" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="633" name="return" description="list of error messages if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="642">
          <name>$rawAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="642">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="642">
          <name>$partialAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="642">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="764" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="759">
          <description><![CDATA[Returns the PDF entries for this module.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="759" name="return" description="list of possible PDF entries" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/modules/quota.inc" hash="f6b0ad7fd6f30235d33f60389089a624" package="modules">
    <docblock line="25">
      <description><![CDATA[Manages quotas for users and groups.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="25" name="package" description="modules"/>
      <tag line="25" name="author" description="Tilo Lutz"/>
      <tag line="25" name="author" description="Roland Gruber"/>
      <tag line="25" name="author" description="Michael Duergner"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="40" package="modules">
      <extends>\baseModule</extends>
      <name>quota</name>
      <full_name>\quota</full_name>
      <docblock line="35">
        <description><![CDATA[Manages quotas for users and groups.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="35" name="package" description="modules"/>
      </docblock>
      <property final="false" static="true" visibility="private" line="43" namespace="global" package="main">
        <name>$SPLIT_DELIMITER</name>
        <default><![CDATA["###x##y##x###"]]></default>
        <docblock line="42">
          <description><![CDATA[delimiter for lamdaemon commands]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="true" visibility="private" line="45" namespace="global" package="main">
        <name>$QUOTA_PREFIX</name>
        <default><![CDATA['QUOTA_ENTRY ']]></default>
        <docblock line="44">
          <description><![CDATA[prefix for lamdaemon results]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="154" namespace="global" package="main">
        <name>$quota</name>
        <default><![CDATA[]]></default>
        <docblock line="153">
          <description><![CDATA[Saves the quota settings]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="49" package="modules">
        <name>load_Messages</name>
        <full_name>load_Messages</full_name>
        <docblock line="47">
          <description><![CDATA[this functin fills the error message array with messages]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="73" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="66">
          <description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="66" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="66" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="160" package="modules">
        <name>initQuotas</name>
        <full_name>initQuotas</full_name>
        <docblock line="156">
          <description><![CDATA[Initializes the quota values.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="203" package="modules">
        <name>getCn</name>
        <full_name>getCn</full_name>
        <docblock line="198">
          <description><![CDATA[Gets the cn from the Unix group module.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="198" name="return" description="cn attribute" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="222" package="modules">
        <name>module_ready</name>
        <full_name>module_ready</full_name>
        <docblock line="216">
          <description><![CDATA[This function is used to check if this module page can be displayed.]]></description>
          <long-description><![CDATA[<p>It returns false if a module depends on data from other modules which was not yet entered.</p>]]></long-description>
          <tag line="216" name="return" description="true, if page can be displayed" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="244" package="modules">
        <name>postModifyActions</name>
        <full_name>postModifyActions</full_name>
        <docblock line="235">
          <description><![CDATA[Quotas are set in postmodify.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="235" name="see" description="\global\baseModule::postModifyActions()" refers="\global\baseModule::postModifyActions()"/>
          <tag line="235" name="param" description="is new account" type="boolean" variable="$newAccount">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="235" name="param" description="LDAP attributes of this entry" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="235" name="return" description="array which contains status messages. Each entry is an array containing the status message parameters." type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="244">
          <name>$newAccount</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="244">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="283" package="modules">
        <name>preDeleteActions</name>
        <full_name>preDeleteActions</full_name>
        <docblock line="278">
          <description><![CDATA[Allows the module to run commands before the LDAP entry is deleted.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="278" name="return" description="Array which contains status messages. Each entry is an array containing the status message parameters." type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="323" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="317">
          <description><![CDATA[Processes user input of the primary module page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="317" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="370" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="365">
          <description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="365" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="454" package="modules">
        <name>replaceSpecialChars</name>
        <full_name>replaceSpecialChars</full_name>
        <docblock line="448">
          <description><![CDATA[Replaces special characters in HTML name values.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="448" name="param" description="input string" type="string" variable="$input">
            <type by_reference="false">string</type>
          </tag>
          <tag line="448" name="return" description="output string" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="454">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="464" package="modules">
        <name>get_profileOptions</name>
        <full_name>get_profileOptions</full_name>
        <docblock line="459">
          <description><![CDATA[Returns a list of elements for the account profiles.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="459" name="return" description="profile elements" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="545" package="modules">
        <name>check_profileOptions</name>
        <full_name>check_profileOptions</full_name>
        <docblock line="539">
          <description><![CDATA[Checks input values of account profiles.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="539" name="param" description="a hash array (name =&gt; value) containing the options" type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="539" name="return" description="list of error messages (array(type, title, text)) to generate StatusMessages, if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="545">
          <name>$options</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="586" package="modules">
        <name>load_profile</name>
        <full_name>load_profile</full_name>
        <docblock line="581">
          <description><![CDATA[Loads the values of an account profile into internal variables.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="581" name="param" description="hash array with profile values (identifier =&gt; value)" type="array" variable="$profile">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="586">
          <name>$profile</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="608" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="603">
          <description><![CDATA[Returns the PDF entries for this module.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="603" name="return" description="list of possible PDF entries" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="663" package="modules">
        <name>get_uploadColumns</name>
        <full_name>get_uploadColumns</full_name>
        <docblock line="648">
          <description><![CDATA[Returns an array containing all input columns for the file upload.]]></description>
          <long-description><![CDATA[<p>Syntax:
<br> array(
<br>  string: name,  // fixed non-translated name which is used as column name (should be of format: <module name>_<column name>)
<br>  string: description,  // short descriptive name
<br>  string: help,  // help ID
<br>  string: example,  // example value
<br>  boolean: required  // true, if user must set a value for this column
<br> )</p>]]></long-description>
          <tag line="648" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="648" name="return" description="column list" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="663">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="715" package="modules">
        <name>doUploadPostActions</name>
        <full_name>doUploadPostActions</full_name>
        <docblock line="700">
          <description><![CDATA[This function executes one post upload action.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="700" name="param" description="array containing one account in each element" type="array" variable="$data">
            <type by_reference="false">array</type>
          </tag>
          <tag line="700" name="param" description="array(&lt;column_name&gt; =&gt; &lt;column number&gt;)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="700" name="param" description="list of accounts which were not created successfully" type="array" variable="$failed">
            <type by_reference="false">array</type>
          </tag>
          <tag line="700" name="param" description="variable to store temporary data between two post actions" type="array" variable="$temp">
            <type by_reference="false">array</type>
          </tag>
          <tag line="700" name="param" description="list of LDAP entries" type="array" variable="$accounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="700" name="return" description="current status &lt;br&gt; array ( &lt;br&gt; 'status' =&gt; 'finished' | 'inProgress' &lt;br&gt; 'progress' =&gt; 0..100 &lt;br&gt; 'errors' =&gt; array (&lt;array of parameters for StatusMessage&gt;) &lt;br&gt; )" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="715">
          <name>$data</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="715">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="715">
          <name>$failed</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="715">
          <name>$temp</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="715">
          <name>$accounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="lib/modules/sambaSamAccount.inc" hash="bc6d1ef8463289c23f4f6a62181b9973" package="modules">
    <docblock line="24">
      <description><![CDATA[Manages Samba 3 accounts for users and hosts.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="package" description="modules"/>
      <tag line="24" name="author" description="Tilo Lutz"/>
      <tag line="24" name="author" description="Roland Gruber"/>
      <tag line="24" name="author" description="Michael Duergner"/>
    </docblock>
    <include line="35" type="Include Once" package="main">
      <name>sambaSamAccount/sambaMungedDial.inc</name>
      <docblock line="34">
        <description><![CDATA[terminals server options]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <class final="false" abstract="false" namespace="global" line="42" package="modules">
      <extends>\baseModule</extends>
      <implements>\passwordService</implements>
      <name>sambaSamAccount</name>
      <full_name>\sambaSamAccount</full_name>
      <docblock line="37">
        <description><![CDATA[Manages the object class "sambaSamAccount" for users and hosts.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="37" name="package" description="modules"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="46" namespace="global" package="main">
        <name>$nopwd</name>
        <default><![CDATA[]]></default>
        <docblock line="45">
          <description><![CDATA[use no password?]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="48" namespace="global" package="main">
        <name>$noexpire</name>
        <default><![CDATA[]]></default>
        <docblock line="47">
          <description><![CDATA[password does not expire?]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="50" namespace="global" package="main">
        <name>$deactivated</name>
        <default><![CDATA[]]></default>
        <docblock line="49">
          <description><![CDATA[account deactivated?]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="52" namespace="global" package="main">
        <name>$groupRids</name>
        <default><![CDATA[]]></default>
        <docblock line="51">
          <description><![CDATA[array of well known group rids]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="54" namespace="global" package="main">
        <name>$userRids</name>
        <default><![CDATA[]]></default>
        <docblock line="53">
          <description><![CDATA[array of well known user rids]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="56" namespace="global" package="main">
        <name>$hex2bitstring</name>
        <default><![CDATA[array('0' => '0000', '1' => '0001', '2' => '0010', '3' => '0011', '4' => '0100', '5' => '0101', '6' => '0110', '7' => '0111', '8' => '1000', '9' => '1001', 'A' => '1010', 'B' => '1011', 'C' => '1100', 'D' => '1101', 'E' => '1110', 'F' => '1111')]]></default>
        <docblock line="55">
          <description><![CDATA[HEX to binary conversion table]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="60" namespace="global" package="main">
        <name>$expirePassword</name>
        <default><![CDATA[false]]></default>
        <docblock line="59">
          <description><![CDATA[specifies if the password should be expired]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="62" namespace="global" package="main">
        <name>$cachedHostList</name>
        <default><![CDATA[null]]></default>
        <docblock line="61">
          <description><![CDATA[host cache to reduce LDAP queries]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="64" namespace="global" package="main">
        <name>$cachedGroupSIDList</name>
        <default><![CDATA[null]]></default>
        <docblock line="63">
          <description><![CDATA[group cache to reduce LDAP queries]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="66" namespace="global" package="main">
        <name>$cachedDomainList</name>
        <default><![CDATA[null]]></default>
        <docblock line="65">
          <description><![CDATA[cache for domain list]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="true" visibility="private" line="68" namespace="global" package="main">
        <name>$SPLIT_DELIMITER</name>
        <default><![CDATA["###x##y##x###"]]></default>
        <docblock line="67">
          <description><![CDATA[delimiter for lamdaemon commands]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="76" package="modules">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="71">
          <description><![CDATA[Creates a new sambaSamAccount object.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="71" name="param" description="account type (user, group, host)" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="76">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="92" package="modules">
        <name>load_Messages</name>
        <full_name>load_Messages</full_name>
        <docblock line="90">
          <description><![CDATA[this functin fills the error message array with messages]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="132" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="125">
          <description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="125" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="125" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="604" package="modules">
        <name>init</name>
        <full_name>init</full_name>
        <docblock line="599">
          <description><![CDATA[Initializes the module after it became part of an accountContainer]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="599" name="param" description="the name of the accountContainer object ($_SESSION[$base])" type="string" variable="$base">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="604">
          <name>$base</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="618" package="modules">
        <name>module_ready</name>
        <full_name>module_ready</full_name>
        <docblock line="612">
          <description><![CDATA[This function is used to check if this module page can be displayed.]]></description>
          <long-description><![CDATA[<p>It returns false if a module depends on data from other modules which was not yet entered.</p>]]></long-description>
          <tag line="612" name="return" description="true, if page can be displayed" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="633" package="modules">
        <name>module_complete</name>
        <full_name>module_complete</full_name>
        <docblock line="626">
          <description><![CDATA[This function is used to check if all settings for this module have been made.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="626" name="see" description="\global\baseModule::module_complete" refers="\global\baseModule::module_complete"/>
          <tag line="626" name="return" description="true, if settings are complete" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="655" package="modules">
        <name>load_attributes</name>
        <full_name>load_attributes</full_name>
        <docblock line="650">
          <description><![CDATA[This function loads the LDAP attributes for this module.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="650" name="param" description="attribute list" type="array" variable="$attr">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="655">
          <name>$attr</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="682" package="modules">
        <name>save_attributes</name>
        <full_name>save_attributes</full_name>
        <docblock line="670">
          <description><![CDATA[Returns a list of modifications which have to be made to the LDAP account.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="670" name="return" description="list of modifications &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 may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) &lt;br&gt;&quot;add&quot; are attributes which have to be added to LDAP entry &lt;br&gt;&quot;remove&quot; are attributes which have to be removed from LDAP entry &lt;br&gt;&quot;modify&quot; are attributes which have to been modified in LDAP entry &lt;br&gt;&quot;info&quot; are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="704" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="698">
          <description><![CDATA[Processes user input of the primary module page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="698" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="890" package="modules">
        <name>process_sambaUserWorkstations</name>
        <full_name>process_sambaUserWorkstations</full_name>
        <docblock line="884">
          <description><![CDATA[Processes user input of the primary module page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="884" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="946" package="modules">
        <name>process_logonHours</name>
        <full_name>process_logonHours</full_name>
        <docblock line="940">
          <description><![CDATA[Processes user input of the logon hours page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="940" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="972" package="modules">
        <name>process_time</name>
        <full_name>process_time</full_name>
        <docblock line="967">
          <description><![CDATA[Processes user input of the time selection page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="967" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1041" package="modules">
        <name>process_terminalServer</name>
        <full_name>process_terminalServer</full_name>
        <docblock line="1035">
          <description><![CDATA[Processes user input of the terminal server page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="1035" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1072" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="1067">
          <description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1067" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1296" package="modules">
        <name>display_html_sambaUserWorkstations</name>
        <full_name>display_html_sambaUserWorkstations</full_name>
        <docblock line="1291">
          <description><![CDATA[This function will create the HTML page to edit the allowed workstations.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1291" name="return" description="meta HTML code" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1344" package="modules">
        <name>display_html_logonHours</name>
        <full_name>display_html_logonHours</full_name>
        <docblock line="1339">
          <description><![CDATA[This function will create the HTML page to edit logon hours.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1339" name="return" description="meta HTML code" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1417" package="modules">
        <name>display_html_time</name>
        <full_name>display_html_time</full_name>
        <docblock line="1412">
          <description><![CDATA[This function will create the meta HTML code to show a page to change time values.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1412" name="return" description="meta HTML code" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1467" package="modules">
        <name>display_html_terminalServer</name>
        <full_name>display_html_terminalServer</full_name>
        <docblock line="1462">
          <description><![CDATA[This function will create the HTML page to edit the terminal server options.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1462" name="return" description="meta HTML code" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1553" package="modules">
        <name>display_html_profilePath</name>
        <full_name>display_html_profilePath</full_name>
        <docblock line="1548">
          <description><![CDATA[Displays manage profile path page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1548" name="return" description="meta HTML code" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1626" package="modules">
        <name>process_profilePath</name>
        <full_name>process_profilePath</full_name>
        <docblock line="1620">
          <description><![CDATA[Processes user input of the profile path check page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="1620" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1699" package="modules">
        <name>get_profileOptions</name>
        <full_name>get_profileOptions</full_name>
        <docblock line="1694">
          <description><![CDATA[Returns a list of elements for the account profiles.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1694" name="return" description="profile elements" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1781" package="modules">
        <name>load_profile</name>
        <full_name>load_profile</full_name>
        <docblock line="1776">
          <description><![CDATA[Loads the values of an account profile into internal variables.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1776" name="param" description="hash array with profile values (identifier =&gt; value)" type="array" variable="$profile">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1781">
          <name>$profile</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1872" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="1867">
          <description><![CDATA[Returns the PDF entries for this module.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1867" name="return" description="list of possible PDF entries" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1959" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>build_uploadAccounts</full_name>
        <docblock line="1950">
          <description><![CDATA[In this function the LDAP account is built up.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1950" name="param" description="list of hash arrays (name =&gt; value) from user input" type="array" variable="$rawAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1950" name="param" description="list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1950" name="param" description="list of hash arrays (name =&gt; value) which are later added to LDAP" type="array" variable="$partialAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1950" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1950" name="return" description="list of error messages if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1959">
          <name>$rawAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1959">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1959">
          <name>$partialAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1959">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2279" package="modules">
        <name>getSelfServiceOptions</name>
        <full_name>getSelfServiceOptions</full_name>
        <docblock line="2268">
          <description><![CDATA[Returns the meta HTML code for each input field.]]></description>
          <long-description><![CDATA[<p>format: array(<field1> => array(<META HTML>), ...)
It is not possible to display help links.</p>]]></long-description>
          <tag line="2268" name="param" description="list of active fields" type="array" variable="$fields">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2268" name="param" description="attributes of LDAP account" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2268" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="2268" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2268" name="return" description="list of meta HTML elements (field name =&gt; htmlTableRow)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2279">
          <name>$fields</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2279">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2279">
          <name>$passwordChangeOnly</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2279">
          <name>$readOnlyFields</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2320" package="modules">
        <name>checkSelfServiceOptions</name>
        <full_name>checkSelfServiceOptions</full_name>
        <docblock line="2303">
          <description><![CDATA[Checks if all input values are correct and returns the LDAP attributes which should be changed.]]></description>
          <long-description><![CDATA[<p><br>Return values:
<br>messages: array of parameters to create status messages
<br>add: array of attributes to add
<br>del: array of attributes to remove
<br>mod: array of attributes to modify
<br>info: array of values with informational value (e.g. to be used later by pre/postModify actions)</p>

<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.</p>]]></long-description>
          <tag line="2303" name="param" description="input fields" type="string" variable="$fields">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2303" name="param" description="LDAP attributes" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2303" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="2303" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2303" name="return" description="messages and attributes (array('messages' =&gt; array(), 'add' =&gt; array('mail' =&gt; array('test@test.com')), 'del' =&gt; array(), 'mod' =&gt; array(), 'info' =&gt; array()))" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2320">
          <name>$fields</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2320">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2320">
          <name>$passwordChangeOnly</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2320">
          <name>$readOnlyFields</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2388" package="modules">
        <name>managesPasswordAttributes</name>
        <full_name>managesPasswordAttributes</full_name>
        <docblock line="2382">
          <description><![CDATA[This method specifies if a module manages password attributes.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2382" name="see" description="\global\passwordService::managesPasswordAttributes" refers="\global\passwordService::managesPasswordAttributes"/>
          <tag line="2382" name="return" description="true if this module manages password attributes" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2399" package="modules">
        <name>supportsForcePasswordChange</name>
        <full_name>supportsForcePasswordChange</full_name>
        <docblock line="2394">
          <description><![CDATA[Specifies if this module supports to force that a user must change his password on next login.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2394" name="return" description="force password change supported" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2414" package="modules">
        <name>passwordChangeRequested</name>
        <full_name>passwordChangeRequested</full_name>
        <docblock line="2403">
          <description><![CDATA[This function is called whenever the password should be changed.]]></description>
          <long-description><![CDATA[<p>Account modules
must change their password attributes only if the modules list contains their module name.</p>]]></long-description>
          <tag line="2403" name="param" description="new password" type="String" variable="$password">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2403" name="param" description="list of modules for which the password should be changed" type="\$modules" variable="$modules">
            <type by_reference="false">\$modules</type>
          </tag>
          <tag line="2403" name="param" description="force the user to change his password at next login" type="boolean" variable="$forcePasswordChange">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="2403" name="return" description="list of error messages if any as parameter array for StatusMessage e.g. return arrray(array('ERROR', 'Password change failed.'))" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2403" name="see" description="\global\passwordService::passwordChangeRequested" refers="\global\passwordService::passwordChangeRequested"/>
        </docblock>
        <argument line="2414">
          <name>$password</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2414">
          <name>$modules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2414">
          <name>$forcePasswordChange</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2435" package="modules">
        <name>getGroupName</name>
        <full_name>getGroupName</full_name>
        <docblock line="2429">
          <description><![CDATA[Returns the group name of the group with the given group ID.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2429" name="param" description="group ID" type="String" variable="$groupID">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2429" name="return" description="group name" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="2435">
          <name>$groupID</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2449" package="modules">
        <name>getPasswordMustChangeTime</name>
        <full_name>getPasswordMustChangeTime</full_name>
        <docblock line="2443">
          <description><![CDATA[Returns the time when the user needs to change his password.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2443" name="param" description="list of domain objects" type="array" variable="$domains">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2443" name="param" description="selected domain name" type="String" variable="$selectedDomain">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="2449">
          <name>$domains</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2449">
          <name>$selectedDomain</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2481" package="modules">
        <name>getPasswordCanChangeTime</name>
        <full_name>getPasswordCanChangeTime</full_name>
        <docblock line="2475">
          <description><![CDATA[Returns the time when the user can change his password.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2475" name="param" description="list of domain objects" type="array" variable="$domains">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2475" name="param" description="selected domain name" type="String" variable="$selectedDomain">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="2481">
          <name>$domains</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2481">
          <name>$selectedDomain</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2508" package="modules">
        <name>getHostList</name>
        <full_name>getHostList</full_name>
        <docblock line="2503">
          <description><![CDATA[Returns a list of existing hosts.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2503" name="return" description="host names" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2524" package="modules">
        <name>getGroupSIDList</name>
        <full_name>getGroupSIDList</full_name>
        <docblock line="2519">
          <description><![CDATA[Returns a list of existing hosts.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2519" name="return" description="host names" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2543" package="modules">
        <name>getDomains</name>
        <full_name>getDomains</full_name>
        <docblock line="2538">
          <description><![CDATA[Returns a list of existing Samba 3 domains.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2538" name="return" description="list of samba3domain objects" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2559" package="modules">
        <name>setExpirationDate</name>
        <full_name>setExpirationDate</full_name>
        <docblock line="2551">
          <description><![CDATA[Sets the expiration date of this account.]]></description>
          <long-description><![CDATA[<p>If all parameters are null the expiration date will be removed.</p>]]></long-description>
          <tag line="2551" name="param" description="year (e.g. 2040)" type="String" variable="$year">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2551" name="param" description="month (e.g. 8)" type="String" variable="$month">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2551" name="param" description="day (e.g. 27)" type="String" variable="$day">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="2559">
          <name>$year</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2559">
          <name>$month</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2559">
          <name>$day</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2573" package="modules">
        <name>isExtensionEnabled</name>
        <full_name>isExtensionEnabled</full_name>
        <docblock line="2568">
          <description><![CDATA[Returns if the Samba extension is enabled.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2568" name="return" description="Samba extension is active" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2582" package="modules">
        <name>isDeactivated</name>
        <full_name>isDeactivated</full_name>
        <docblock line="2577">
          <description><![CDATA[Returns if the Samba part of the current account is deactivated.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2577" name="return" description="account is locked" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2589" package="modules">
        <name>deactivate</name>
        <full_name>deactivate</full_name>
        <docblock line="2586">
          <description><![CDATA[Deactivates this account.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2601" package="modules">
        <name>activate</name>
        <full_name>activate</full_name>
        <docblock line="2598">
          <description><![CDATA[Activates this account.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/modules/posixAccount.inc" hash="72f224c418fbf9ea457dcc8e53cbaf6a" package="modules">
    <docblock line="24">
      <description><![CDATA[Manages Unix accounts for users and hosts.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="package" description="modules"/>
      <tag line="24" name="author" description="Tilo Lutz"/>
      <tag line="24" name="author" description="Roland Gruber"/>
      <tag line="24" name="author" description="Michael Duergner"/>
      <tag line="24" name="author" description="Thomas Manninger"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="40" package="modules">
      <extends>\baseModule</extends>
      <implements>\passwordService</implements>
      <name>posixAccount</name>
      <full_name>\posixAccount</full_name>
      <docblock line="35">
        <description><![CDATA[Manages the object class "posixAccount" for users and hosts.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="35" name="package" description="modules"/>
      </docblock>
      <property final="false" static="true" visibility="private" line="44" namespace="global" package="main">
        <name>$SPLIT_DELIMITER</name>
        <default><![CDATA["###x##y##x###"]]></default>
        <docblock line="43">
          <description><![CDATA[delimiter for lamdaemon commands]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="48" namespace="global" package="main">
        <name>$groups</name>
        <default><![CDATA[]]></default>
        <docblock line="47">
          <description><![CDATA[current group list]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="50" namespace="global" package="main">
        <name>$groups_orig</name>
        <default><![CDATA[]]></default>
        <docblock line="49">
          <description><![CDATA[original group list]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="54" namespace="global" package="main">
        <name>$gonList</name>
        <default><![CDATA[array()]]></default>
        <docblock line="53">
          <description><![CDATA[current group of names list]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="56" namespace="global" package="main">
        <name>$gonList_orig</name>
        <default><![CDATA[array()]]></default>
        <docblock line="55">
          <description><![CDATA[original group of names list]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="58" namespace="global" package="main">
        <name>$lamdaemonServers</name>
        <default><![CDATA[array()]]></default>
        <docblock line="57">
          <description><![CDATA[lamdaemon servers]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="60" namespace="global" package="main">
        <name>$groupCache</name>
        <default><![CDATA[null]]></default>
        <docblock line="59">
          <description><![CDATA[cache for group objects]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="62" namespace="global" package="main">
        <name>$gonCache</name>
        <default><![CDATA[null]]></default>
        <docblock line="61">
          <description><![CDATA[cache for group of names objects]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="64" namespace="global" package="main">
        <name>$clearTextPassword</name>
        <default><![CDATA[]]></default>
        <docblock line="63">
          <description><![CDATA[clear text password]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="66" namespace="global" package="main">
        <name>$cachedUIDList</name>
        <default><![CDATA[null]]></default>
        <docblock line="65">
          <description><![CDATA[caches the list of known UIDs]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="68" namespace="global" package="main">
        <name>$cachedUserNameList</name>
        <default><![CDATA[null]]></default>
        <docblock line="67">
          <description><![CDATA[caches the list of known user names]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="71" namespace="global" package="main">
        <name>$umlautReplacements</name>
        <default><![CDATA[array('ä' => 'ae', 'Ä' => 'Ae', 'ö' => 'oe', 'Ö' => 'Oe', 'ü' => 'ue', 'Ü' => 'Ue', 'ß' => 'ss', 'é' => 'e', 'è' => 'e', 'ô' => 'o', 'ç' => 'c')]]></default>
        <docblock line="70">
          <description><![CDATA[replacements for common umlauts]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="79" package="modules">
        <name>load_Messages</name>
        <full_name>load_Messages</full_name>
        <docblock line="76">
          <description><![CDATA[This function fills the error message array with messages.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="129" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="122">
          <description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="122" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="122" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="540" package="modules">
        <name>init</name>
        <full_name>init</full_name>
        <docblock line="535">
          <description><![CDATA[Initializes the module after it became part of an accountContainer]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="535" name="param" description="the name of the accountContainer object ($_SESSION[$base])" type="string" variable="$base">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="540">
          <name>$base</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="559" package="modules">
        <name>module_complete</name>
        <full_name>module_complete</full_name>
        <docblock line="554">
          <description><![CDATA[This functions is used to check if all settings for this module have been made.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="554" name="return" description="true, if settings are complete" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="573" package="modules">
        <name>load_attributes</name>
        <full_name>load_attributes</full_name>
        <docblock line="568">
          <description><![CDATA[This function loads all needed LDAP attributes.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="568" name="param" description="list of attributes" type="array" variable="$attr">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="573">
          <name>$attr</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="608" package="modules">
        <name>save_attributes</name>
        <full_name>save_attributes</full_name>
        <docblock line="596">
          <description><![CDATA[Returns a list of modifications which have to be made to the LDAP account.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="596" name="return" description="list of modifications &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 may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) &lt;br&gt;&quot;add&quot; are attributes which have to be added to LDAP entry &lt;br&gt;&quot;remove&quot; are attributes which have to be removed from LDAP entry &lt;br&gt;&quot;modify&quot; are attributes which have to been modified in LDAP entry &lt;br&gt;&quot;info&quot; are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="682" package="modules">
        <name>postModifyActions</name>
        <full_name>postModifyActions</full_name>
        <docblock line="673">
          <description><![CDATA[Runs the postmodify actions.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="673" name="see" description="\global\baseModule::postModifyActions()" refers="\global\baseModule::postModifyActions()"/>
          <tag line="673" name="param" description="" type="boolean" variable="$newAccount">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="673" name="param" description="LDAP attributes of this entry" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="673" name="return" description="array which contains status messages. Each entry is an array containing the status message parameters." type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="682">
          <name>$newAccount</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="682">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="830" package="modules">
        <name>delete_attributes</name>
        <full_name>delete_attributes</full_name>
        <docblock line="825">
          <description><![CDATA[Additional LDAP operations on delete.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="825" name="return" description="of LDAP operations, same as for save_attributes()" type="\List">
            <type by_reference="false">\List</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="861" package="modules">
        <name>preDeleteActions</name>
        <full_name>preDeleteActions</full_name>
        <docblock line="856">
          <description><![CDATA[Allows the module to run commands before the LDAP entry is deleted.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="856" name="return" description="Array which contains status messages. Each entry is an array containing the status message parameters." type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="906" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="900">
          <description><![CDATA[Processes user input of the primary module page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="900" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1089" package="modules">
        <name>checkASCII</name>
        <full_name>checkASCII</full_name>
        <docblock line="1083">
          <description><![CDATA[Checks if an attribute contains only ASCII charaters and replaces invalid characters.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1083" name="param" description="attribute value" type="string" variable="$attribute">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1083" name="return" description="attribute value with replaced non-ASCII characters" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="1089">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1111" package="modules">
        <name>process_group</name>
        <full_name>process_group</full_name>
        <docblock line="1105">
          <description><![CDATA[Processes user input of the group selection page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="1105" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1141" package="modules">
        <name>process_homedir</name>
        <full_name>process_homedir</full_name>
        <docblock line="1135">
          <description><![CDATA[Processes user input of the homedir check page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="1135" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1208" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="1203">
          <description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1203" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1346" package="modules">
        <name>display_html_delete</name>
        <full_name>display_html_delete</full_name>
        <docblock line="1341">
          <description><![CDATA[Displays the delete homedir option for the delete page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1341" name="return" description="meta HTML code" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1360" package="modules">
        <name>display_html_group</name>
        <full_name>display_html_group</full_name>
        <docblock line="1355">
          <description><![CDATA[Displays the group selection.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1355" name="return" description="meta HTML code" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1465" package="modules">
        <name>display_html_homedir</name>
        <full_name>display_html_homedir</full_name>
        <docblock line="1460">
          <description><![CDATA[Displays the delete homedir option for the homedir page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1460" name="return" description="meta HTML code" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1537" package="modules">
        <name>get_profileOptions</name>
        <full_name>get_profileOptions</full_name>
        <docblock line="1532">
          <description><![CDATA[Returns a list of elements for the account profiles.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1532" name="return" description="elements" type="\profile">
            <type by_reference="false">\profile</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1603" package="modules">
        <name>load_profile</name>
        <full_name>load_profile</full_name>
        <docblock line="1598">
          <description><![CDATA[Loads the values of an account profile into internal variables.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1598" name="param" description="hash array with profile values (identifier =&gt; value)" type="array" variable="$profile">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1603">
          <name>$profile</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1644" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="1639">
          <description><![CDATA[Returns the PDF entries for this module.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1639" name="return" description="list of possible PDF entries" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1686" package="modules">
        <name>check_configOptions</name>
        <full_name>check_configOptions</full_name>
        <docblock line="1679">
          <description><![CDATA[Checks input values of module settings.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1679" name="param" description="list of account types which are used" type="array" variable="$scopes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1679" name="param" description="hash array containing the settings (array('option' =&gt; array('value')))" type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1679" name="return" description="list of error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1686">
          <name>$scopes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1686">
          <name>$options</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1761" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>build_uploadAccounts</full_name>
        <docblock line="1752">
          <description><![CDATA[In this function the LDAP account is built up.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1752" name="param" description="list of hash arrays (name =&gt; value) from user input" type="array" variable="$rawAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1752" name="param" description="list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1752" name="param" description="list of hash arrays (name =&gt; value) which are later added to LDAP" type="array" variable="$partialAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1752" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1752" name="return" description="list of error messages if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1761">
          <name>$rawAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1761">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1761">
          <name>$partialAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1761">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2039" package="modules">
        <name>doUploadPostActions</name>
        <full_name>doUploadPostActions</full_name>
        <docblock line="2024">
          <description><![CDATA[This function executes one post upload action.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2024" name="param" description="array containing one account in each element" type="array" variable="$data">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2024" name="param" description="array(&lt;column_name&gt; =&gt; &lt;column number&gt;)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2024" name="param" description="list of accounts which were not created successfully" type="array" variable="$failed">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2024" name="param" description="variable to store temporary data between two post actions" type="array" variable="$temp">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2024" name="param" description="list of LDAP entries" type="array" variable="$accounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2024" name="return" description="current status &lt;br&gt; array ( &lt;br&gt; 'status' =&gt; 'finished' | 'inProgress' &lt;br&gt; 'progress' =&gt; 0..100 &lt;br&gt; 'errors' =&gt; array (&lt;array of parameters for StatusMessage&gt;) &lt;br&gt; )" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2039">
          <name>$data</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2039">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2039">
          <name>$failed</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2039">
          <name>$temp</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2039">
          <name>$accounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2220" package="modules">
        <name>getNextUIDs</name>
        <full_name>getNextUIDs</full_name>
        <docblock line="2213">
          <description><![CDATA[Returns one or more free UID numbers.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2213" name="param" description="Number of needed free UIDs." type="integer" variable="$count">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="2213" name="param" description="list of error messages where errors can be added" type="array" variable="$errors">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2213" name="return" description="Null if no UIDs are free else an array of free UIDs." type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="2220">
          <name>$count</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2220">
          <name>$errors</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2287" package="modules">
        <name>getNextSambaPoolUIDs</name>
        <full_name>getNextSambaPoolUIDs</full_name>
        <docblock line="2280">
          <description><![CDATA[Gets the free UID numbers from an Samba pool entry in LDAP.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2280" name="param" description="number of needed free UIDs." type="integer" variable="$count">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="2280" name="param" description="list of error messages where errors can be added" type="array" variable="$errors">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2280" name="return" description="null if no UIDs are free else an array of free UIDs" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="2287">
          <name>$count</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2287">
          <name>$errors</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2324" package="modules">
        <name>getSelfServiceOptions</name>
        <full_name>getSelfServiceOptions</full_name>
        <docblock line="2313">
          <description><![CDATA[Returns the meta HTML code for each input field.]]></description>
          <long-description><![CDATA[<p>format: array(<field1> => array(<META HTML>), ...)
It is not possible to display help links.</p>]]></long-description>
          <tag line="2313" name="param" description="list of active fields" type="array" variable="$fields">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2313" name="param" description="attributes of LDAP account" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2313" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="2313" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2313" name="return" description="list of meta HTML elements (field name =&gt; htmlTableRow)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2324">
          <name>$fields</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2324">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2324">
          <name>$passwordChangeOnly</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2324">
          <name>$readOnlyFields</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2385" package="modules">
        <name>checkSelfServiceOptions</name>
        <full_name>checkSelfServiceOptions</full_name>
        <docblock line="2368">
          <description><![CDATA[Checks if all input values are correct and returns the LDAP attributes which should be changed.]]></description>
          <long-description><![CDATA[<p><br>Return values:
<br>messages: array of parameters to create status messages
<br>add: array of attributes to add
<br>del: array of attributes to remove
<br>mod: array of attributes to modify
<br>"info" are values with informational value (e.g. to be used later by pre/postModify actions)</p>

<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.</p>]]></long-description>
          <tag line="2368" name="param" description="input fields" type="string" variable="$fields">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2368" name="param" description="LDAP attributes" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2368" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="2368" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2368" name="return" description="messages and attributes (array('messages' =&gt; array(), 'add' =&gt; array('mail' =&gt; array('test@test.com')), 'del' =&gt; array(), 'mod' =&gt; array(), 'info' =&gt; array()))" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2385">
          <name>$fields</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2385">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2385">
          <name>$passwordChangeOnly</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2385">
          <name>$readOnlyFields</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2445" package="modules">
        <name>managesPasswordAttributes</name>
        <full_name>managesPasswordAttributes</full_name>
        <docblock line="2439">
          <description><![CDATA[This method specifies if a module manages password attributes.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2439" name="see" description="\global\passwordService::managesPasswordAttributes" refers="\global\passwordService::managesPasswordAttributes"/>
          <tag line="2439" name="return" description="true if this module manages password attributes" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2454" package="modules">
        <name>supportsForcePasswordChange</name>
        <full_name>supportsForcePasswordChange</full_name>
        <docblock line="2449">
          <description><![CDATA[Specifies if this module supports to force that a user must change his password on next login.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2449" name="return" description="force password change supported" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2469" package="modules">
        <name>passwordChangeRequested</name>
        <full_name>passwordChangeRequested</full_name>
        <docblock line="2458">
          <description><![CDATA[This function is called whenever the password should be changed.]]></description>
          <long-description><![CDATA[<p>Account modules
must change their password attributes only if the modules list contains their module name.</p>]]></long-description>
          <tag line="2458" name="param" description="new password" type="String" variable="$password">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2458" name="param" description="list of modules for which the password should be changed" type="\$modules" variable="$modules">
            <type by_reference="false">\$modules</type>
          </tag>
          <tag line="2458" name="param" description="force the user to change his password at next login" type="boolean" variable="$forcePasswordChange">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="2458" name="return" description="list of error messages if any as parameter array for StatusMessage e.g. return arrray(array('ERROR', 'Password change failed.'))" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2458" name="see" description="\global\passwordService::passwordChangeRequested" refers="\global\passwordService::passwordChangeRequested"/>
        </docblock>
        <argument line="2469">
          <name>$password</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2469">
          <name>$modules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2469">
          <name>$forcePasswordChange</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2484" package="modules">
        <name>getGID</name>
        <full_name>getGID</full_name>
        <docblock line="2478">
          <description><![CDATA[Returns the group ID of the given group.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2478" name="param" description="group name" type="String" variable="$groupname">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2478" name="return" description="GID" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="2484">
          <name>$groupname</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2498" package="modules">
        <name>getGroupName</name>
        <full_name>getGroupName</full_name>
        <docblock line="2492">
          <description><![CDATA[Returns the group name of the group with the given group ID.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2492" name="param" description="group ID" type="String" variable="$groupID">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2492" name="return" description="group name" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="2498">
          <name>$groupID</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2512" package="modules">
        <name>getGroupDN</name>
        <full_name>getGroupDN</full_name>
        <docblock line="2506">
          <description><![CDATA[Returns the group DN of the given group.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2506" name="param" description="group name" type="String" variable="$groupname">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2506" name="return" description="DN" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="2512">
          <name>$groupname</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2525" package="modules">
        <name>findGroups</name>
        <full_name>findGroups</full_name>
        <docblock line="2520">
          <description><![CDATA[Finds all existing LDAP groups.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2520" name="return" description="groups array(array(gidnumber, cn), array(gidnumber, cn), ...)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2545" package="modules">
        <name>findGroupOfNames</name>
        <full_name>findGroupOfNames</full_name>
        <docblock line="2540">
          <description><![CDATA[Finds all existing LDAP group of names.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2540" name="return" description="groups array(dn =&gt; array('cn' =&gt; array('groupName'), 'objectClass' =&gt; array('top', 'groupOfNames')))" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2574" package="modules">
        <name>getUIDs</name>
        <full_name>getUIDs</full_name>
        <docblock line="2569">
          <description><![CDATA[Returns a list of existing UID numbers.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2569" name="return" description="list of UID numbers" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2616" package="modules">
        <name>userNameExists</name>
        <full_name>userNameExists</full_name>
        <docblock line="2610">
          <description><![CDATA[Checks if the given user name already exists in LDAP.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2610" name="param" description="user name" type="String" variable="$userName">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2610" name="return" description="true if already exists" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="2616">
          <name>$userName</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2625" package="modules">
        <name>getUserNames</name>
        <full_name>getUserNames</full_name>
        <docblock line="2620">
          <description><![CDATA[Returns a list of all user names in LDAP.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2620" name="return" description="user names" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="global" line="2665" package="modules">
        <name>areGroupOfNamesActive</name>
        <full_name>areGroupOfNamesActive</full_name>
        <docblock line="2660">
          <description><![CDATA[Returns if LAM manages group of names entries.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2660" name="return" description="group of names are active" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="2691" package="modules">
        <name>getUserNameSuggestion</name>
        <full_name>getUserNameSuggestion</full_name>
        <docblock line="2684">
          <description><![CDATA[Returns a suggestion for the user name.]]></description>
          <long-description><![CDATA[<p>By deafult this wil be the first character of the first name plus the last name.</p>]]></long-description>
          <tag line="2684" name="param" description="LDAP attributes" type="array" variable="$attrs">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2684" name="return" description="user name" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="2691">
          <name>$attrs</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2728" package="modules">
        <name>isLockable</name>
        <full_name>isLockable</full_name>
        <docblock line="2724">
          <description><![CDATA[Returns if this account can be locked.]]></description>
          <long-description><![CDATA[<p>This is the case if a hashed password is set ("{" at the beginning).</p>]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2740" package="modules">
        <name>isLocked</name>
        <full_name>isLocked</full_name>
        <docblock line="2735">
          <description><![CDATA[Returns if the Unix part of the current account is locked.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2735" name="return" description="password is locked" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2747" package="modules">
        <name>lock</name>
        <full_name>lock</full_name>
        <docblock line="2744">
          <description><![CDATA[Locks the user password of this account.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2756" package="modules">
        <name>unlock</name>
        <full_name>unlock</full_name>
        <docblock line="2753">
          <description><![CDATA[Unlocks the user password of this account.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2765" package="modules">
        <name>removeFromUnixGroups</name>
        <full_name>removeFromUnixGroups</full_name>
        <docblock line="2762">
          <description><![CDATA[Removes all Unix group memberships from this user.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2772" package="modules">
        <name>removeFromGONGroups</name>
        <full_name>removeFromGONGroups</full_name>
        <docblock line="2769">
          <description><![CDATA[Removes all group of names memberships from this user.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="2786" package="modules">
        <name>getNextUserName</name>
        <full_name>getNextUserName</full_name>
        <docblock line="2776">
          <description><![CDATA[Returns the next possible user name based on the given one.]]></description>
          <long-description><![CDATA[<p>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.
<br>
<br>Attention: This user name might still be in use. This needs to be checked separately.</p>]]></long-description>
          <tag line="2776" name="param" description="user name" type="String" variable="$userName">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2776" name="return" description="new user name" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="2786">
          <name>$userName</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2839" package="modules">
        <name>getShells</name>
        <full_name>getShells</full_name>
        <docblock line="2834">
          <description><![CDATA[Returns the list of possible login shells.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2834" name="return" description="login shells" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/modules/windowsUser.inc" hash="0f8ca37abc9d4d1d0c81bbcebf518e09" package="modules">
    <docblock line="23">
      <description><![CDATA[Manages Windows AD (e.g.]]></description>
      <long-description><![CDATA[<p>Samba 4) users.</p>]]></long-description>
      <tag line="23" name="package" description="modules"/>
      <tag line="23" name="author" description="Roland Gruber"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="35" package="modules">
      <extends>\baseModule</extends>
      <implements>\passwordService</implements>
      <name>windowsUser</name>
      <full_name>\windowsUser</full_name>
      <docblock line="30">
        <description><![CDATA[Manages Windows AD (e.g.]]></description>
        <long-description><![CDATA[<p>Samba 4) users.</p>]]></long-description>
        <tag line="30" name="package" description="modules"/>
      </docblock>
      <constant namespace="global" line="38" package="modules">
        <name>DEFAULT_ACCOUNT_CONTROL</name>
        <full_name>DEFAULT_ACCOUNT_CONTROL</full_name>
        <value><![CDATA[512]]></value>
        <docblock line="37">
          <description><![CDATA[initial account flags]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="global" line="40" package="modules">
        <name>AC_PWD_NEVER_EXPIRES</name>
        <full_name>AC_PWD_NEVER_EXPIRES</full_name>
        <value><![CDATA[65536]]></value>
        <docblock line="39">
          <description><![CDATA[password never expires]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="global" line="42" package="modules">
        <name>AC_SMARTCARD_REQUIRED</name>
        <full_name>AC_SMARTCARD_REQUIRED</full_name>
        <value><![CDATA[262144]]></value>
        <docblock line="41">
          <description><![CDATA[login requires smartcard]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="global" line="44" package="modules">
        <name>AC_ACCOUNT_DISABLED</name>
        <full_name>AC_ACCOUNT_DISABLED</full_name>
        <value><![CDATA[2]]></value>
        <docblock line="43">
          <description><![CDATA[account is disabled]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="global" line="46" package="modules">
        <name>AC_LOCKED_OUT</name>
        <full_name>AC_LOCKED_OUT</full_name>
        <value><![CDATA[16]]></value>
        <docblock line="45">
          <description><![CDATA[currently locked out, read only flag]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <property final="false" static="false" visibility="private" line="49" namespace="global" package="main">
        <name>$groupList</name>
        <default><![CDATA[array()]]></default>
        <docblock line="48">
          <description><![CDATA[current group of names list]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="51" namespace="global" package="main">
        <name>$groupList_orig</name>
        <default><![CDATA[array()]]></default>
        <docblock line="50">
          <description><![CDATA[original group of names list]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="53" namespace="global" package="main">
        <name>$groupCache</name>
        <default><![CDATA[null]]></default>
        <docblock line="52">
          <description><![CDATA[cache for groups]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="55" namespace="global" package="main">
        <name>$pwdLastSet</name>
        <default><![CDATA[null]]></default>
        <docblock line="54">
          <description><![CDATA[option for forcing password change, used in postModifyActions]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="57" namespace="global" package="main">
        <name>$clearTextPassword</name>
        <default><![CDATA[]]></default>
        <docblock line="56">
          <description><![CDATA[clear text password]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="67" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="60">
          <description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="60" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="60" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="432" package="modules">
        <name>init</name>
        <full_name>init</full_name>
        <docblock line="427">
          <description><![CDATA[Initializes the module after it became part of an accountContainer]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="427" name="param" description="the name of the accountContainer object ($_SESSION[$base])" type="string" variable="$base">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="432">
          <name>$base</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="442" package="modules">
        <name>load_Messages</name>
        <full_name>load_Messages</full_name>
        <docblock line="439">
          <description><![CDATA[This function fills the $messages variable with output messages from this module.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="474" package="modules">
        <name>load_attributes</name>
        <full_name>load_attributes</full_name>
        <docblock line="469">
          <description><![CDATA[This function loads all needed LDAP attributes.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="469" name="param" description="list of attributes" type="array" variable="$attr">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="474">
          <name>$attr</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="500" package="modules">
        <name>save_attributes</name>
        <full_name>save_attributes</full_name>
        <docblock line="488">
          <description><![CDATA[Returns a list of modifications which have to be made to the LDAP account.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="488" name="return" description="list of modifications &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 may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) &lt;br&gt;&quot;add&quot; are attributes which have to be added to LDAP entry &lt;br&gt;&quot;remove&quot; are attributes which have to be removed from LDAP entry &lt;br&gt;&quot;modify&quot; are attributes which have to been modified in LDAP entry &lt;br&gt;&quot;info&quot; are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="512" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="507">
          <description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="507" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="609" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="603">
          <description><![CDATA[Processes user input of the primary module page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="603" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="717" package="modules">
        <name>display_html_group</name>
        <full_name>display_html_group</full_name>
        <docblock line="712">
          <description><![CDATA[Displays the group selection.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="712" name="return" description="meta HTML code" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="784" package="modules">
        <name>process_group</name>
        <full_name>process_group</full_name>
        <docblock line="778">
          <description><![CDATA[Processes user input of the group selection page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="778" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="804" package="modules">
        <name>postModifyActions</name>
        <full_name>postModifyActions</full_name>
        <docblock line="795">
          <description><![CDATA[Runs the postmodify actions.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="795" name="see" description="\global\baseModule::postModifyActions()" refers="\global\baseModule::postModifyActions()"/>
          <tag line="795" name="param" description="" type="boolean" variable="$newAccount">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="795" name="param" description="LDAP attributes of this entry" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="795" name="return" description="array which contains status messages. Each entry is an array containing the status message parameters." type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="804">
          <name>$newAccount</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="804">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="860" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>build_uploadAccounts</full_name>
        <docblock line="851">
          <description><![CDATA[In this function the LDAP account is built up.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="851" name="param" description="list of hash arrays (name =&gt; value) from user input" type="array" variable="$rawAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="851" name="param" description="list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="851" name="param" description="list of hash arrays (name =&gt; value) which are later added to LDAP" type="array" variable="$partialAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="851" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="851" name="return" description="list of error messages if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="860">
          <name>$rawAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="860">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="860">
          <name>$partialAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="860">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1110" package="modules">
        <name>doUploadPostActions</name>
        <full_name>doUploadPostActions</full_name>
        <docblock line="1095">
          <description><![CDATA[This function executes one post upload action.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1095" name="param" description="array containing one account in each element" type="array" variable="$data">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1095" name="param" description="array(&lt;column_name&gt; =&gt; &lt;column number&gt;)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1095" name="param" description="list of accounts which were not created successfully" type="array" variable="$failed">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1095" name="param" description="variable to store temporary data between two post actions" type="array" variable="$temp">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1095" name="param" description="list of LDAP entries" type="array" variable="$accounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1095" name="return" description="current status &lt;br&gt; array ( &lt;br&gt; 'status' =&gt; 'finished' | 'inProgress' &lt;br&gt; 'progress' =&gt; 0..100 &lt;br&gt; 'errors' =&gt; array (&lt;array of parameters for StatusMessage&gt;) &lt;br&gt; )" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1110">
          <name>$data</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1110">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1110">
          <name>$failed</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1110">
          <name>$temp</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1110">
          <name>$accounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1213" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="1210">
          <description><![CDATA[Returns a list of PDF entries]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1275" package="modules">
        <name>get_profileOptions</name>
        <full_name>get_profileOptions</full_name>
        <docblock line="1270">
          <description><![CDATA[Returns a list of elements for the account profiles.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1270" name="return" description="profile elements" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1294" package="modules">
        <name>load_profile</name>
        <full_name>load_profile</full_name>
        <docblock line="1289">
          <description><![CDATA[Loads the values of an account profile into internal variables.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1289" name="param" description="hash array with profile values (identifier =&gt; value)" type="array" variable="$profile">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1294">
          <name>$profile</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1314" package="modules">
        <name>getSelfServiceOptions</name>
        <full_name>getSelfServiceOptions</full_name>
        <docblock line="1303">
          <description><![CDATA[Returns the meta HTML code for each input field.]]></description>
          <long-description><![CDATA[<p>format: array(<field1> => array(<META HTML>), ...)
It is not possible to display help links.</p>]]></long-description>
          <tag line="1303" name="param" description="list of active fields" type="array" variable="$fields">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1303" name="param" description="attributes of LDAP account" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1303" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="1303" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1303" name="return" description="list of meta HTML elements (field name =&gt; htmlTableRow)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1314">
          <name>$fields</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1314">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1314">
          <name>$passwordChangeOnly</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1314">
          <name>$readOnlyFields</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1364" package="modules">
        <name>checkSelfServiceOptions</name>
        <full_name>checkSelfServiceOptions</full_name>
        <docblock line="1347">
          <description><![CDATA[Checks if all input values are correct and returns the LDAP attributes which should be changed.]]></description>
          <long-description><![CDATA[<p><br>Return values:
<br>messages: array of parameters to create status messages
<br>add: array of attributes to add
<br>del: array of attributes to remove
<br>mod: array of attributes to modify
<br>info: array of values with informational value (e.g. to be used later by pre/postModify actions)</p>

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

<p>Enter description here ...</p>]]></long-description>
          <tag line="1406" name="param" description="return value for checkSelfServiceOptions() (used to add message if any)" type="array" variable="$return">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1406" name="param" description="LDAP attributes" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1414">
          <name>$return</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1414">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1483" package="modules">
        <name>managesPasswordAttributes</name>
        <full_name>managesPasswordAttributes</full_name>
        <docblock line="1476">
          <description><![CDATA[This method specifies if a module manages password attributes.]]></description>
          <long-description><![CDATA[<p>The module alias will
then appear as option in the GUI.
<br>If the module only wants to get notified about password changes then return false.</p>]]></long-description>
          <tag line="1476" name="return" description="true if this module manages password attributes" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1492" package="modules">
        <name>supportsForcePasswordChange</name>
        <full_name>supportsForcePasswordChange</full_name>
        <docblock line="1487">
          <description><![CDATA[Specifies if this module supports to force that a user must change his password on next login.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1487" name="return" description="force password change supported" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1506" package="modules">
        <name>passwordChangeRequested</name>
        <full_name>passwordChangeRequested</full_name>
        <docblock line="1496">
          <description><![CDATA[This function is called whenever the password should be changed.]]></description>
          <long-description><![CDATA[<p>Account modules
must change their password attributes only if the modules list contains their module name.</p>]]></long-description>
          <tag line="1496" name="param" description="new password" type="String" variable="$password">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1496" name="param" description="list of modules for which the password should be changed" type="array" variable="$modules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1496" name="param" description="force the user to change his password at next login" type="boolean" variable="$forcePasswordChange">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="1496" name="return" description="list of error messages if any as parameter array for StatusMessage e.g. return arrray(array('ERROR', 'Password change failed.'))" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1506">
          <name>$password</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1506">
          <name>$modules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1506">
          <name>$forcePasswordChange</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="global" line="1526" package="modules">
        <name>pwdAttributeValue</name>
        <full_name>pwdAttributeValue</full_name>
        <docblock line="1521">
          <description><![CDATA[Creates the LDAP password value.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1521" name="param" description="password" type="String" variable="$password">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1526">
          <name>$password</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="global" line="1536" package="modules">
        <name>isDeactivated</name>
        <full_name>isDeactivated</full_name>
        <docblock line="1530">
          <description><![CDATA[Returns if the account is currently deactivated.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1530" name="param" description="LDAP attributes" type="array" variable="$attrs">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1530" name="return" description="is deactivated" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1536">
          <name>$attrs</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1550" package="modules">
        <name>setIsDeactivated</name>
        <full_name>setIsDeactivated</full_name>
        <docblock line="1544">
          <description><![CDATA[Sets if the account is currently deactivated.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1544" name="param" description="is deactivated" type="boolean" variable="$deactivated">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="1544" name="param" description="LDAP attributes to modify (default $this-&gt;attributes)" type="array" variable="$attrs">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1550">
          <name>$deactivated</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1550">
          <name>$attrs</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="private" namespace="global" line="1574" package="modules">
        <name>isLockedOut</name>
        <full_name>isLockedOut</full_name>
        <docblock line="1568">
          <description><![CDATA[Returns if the account is currently locked out.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1568" name="param" description="LDAP attributes" type="array" variable="$attrs">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1568" name="return" description="is locked out" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1574">
          <name>$attrs</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="global" line="1587" package="modules">
        <name>unlock</name>
        <full_name>unlock</full_name>
        <docblock line="1582">
          <description><![CDATA[Unlocks the account.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1582" name="param" description="LDAP attributes to modify" type="array" variable="$attrs">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1587">
          <name>$attrs</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="global" line="1603" package="modules">
        <name>isSmartCardRequired</name>
        <full_name>isSmartCardRequired</full_name>
        <docblock line="1597">
          <description><![CDATA[Returns if the account requires a smartcard to login.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1597" name="param" description="LDAP attributes" type="array" variable="$attrs">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1597" name="return" description="requires a smartcard" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1603">
          <name>$attrs</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="global" line="1617" package="modules">
        <name>setIsSmartCardRequired</name>
        <full_name>setIsSmartCardRequired</full_name>
        <docblock line="1611">
          <description><![CDATA[Sets if the account requires a smartcard to login.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1611" name="param" description="LDAP attributes to modify" type="array" variable="$attrs">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1611" name="param" description="requires a smartcard" type="boolean" variable="$requireCard">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1617">
          <name>$attrs</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1617">
          <name>$requireCard</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="global" line="1638" package="modules">
        <name>isNeverExpiring</name>
        <full_name>isNeverExpiring</full_name>
        <docblock line="1632">
          <description><![CDATA[Returns if the account never expires.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1632" name="param" description="LDAP attributes" type="array" variable="$attrs">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1632" name="return" description="never expires" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1638">
          <name>$attrs</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="global" line="1652" package="modules">
        <name>setIsNeverExpiring</name>
        <full_name>setIsNeverExpiring</full_name>
        <docblock line="1646">
          <description><![CDATA[Sets if the account never expires.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1646" name="param" description="LDAP attributes to modify" type="array" variable="$attrs">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1646" name="param" description="never expires" type="boolean" variable="$neverExpires">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1652">
          <name>$attrs</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1652">
          <name>$neverExpires</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1672" package="modules">
        <name>findGroups</name>
        <full_name>findGroups</full_name>
        <docblock line="1667">
          <description><![CDATA[Finds all existing groups.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1667" name="return" description="group DNs" type="array">
            <type by_reference="false">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>
  </file>
  <file path="lib/modules/kolabUser.inc" hash="f61764131dc1e2a17dbdd2d2e31d5d7e" package="modules">
    <docblock line="23">
      <description><![CDATA[Manages Kolab user accounts.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="23" name="package" description="modules"/>
      <tag line="23" name="author" description="Roland Gruber"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="35" package="modules">
      <extends>\baseModule</extends>
      <name>kolabUser</name>
      <full_name>\kolabUser</full_name>
      <docblock line="30">
        <description><![CDATA[Manages Kolab user accounts.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="30" name="package" description="modules"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="38" namespace="global" package="main">
        <name>$invitationPolicies</name>
        <default><![CDATA[]]></default>
        <docblock line="37">
          <description><![CDATA[list of invitation policies]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="45" package="modules">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="40">
          <description><![CDATA[Creates a new kolabUser object.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="40" name="param" description="account type (user, group, host)" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="45">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="66" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="59">
          <description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="59" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="59" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="177" package="modules">
        <name>load_Messages</name>
        <full_name>load_Messages</full_name>
        <docblock line="174">
          <description><![CDATA[This function fills the error message array with messages]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="193" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="188">
          <description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="188" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="330" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="324">
          <description><![CDATA[Processes user input of the primary module page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="324" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="448" package="modules">
        <name>display_html_deleteUser</name>
        <full_name>display_html_deleteUser</full_name>
        <docblock line="443">
          <description><![CDATA[This function will create the meta HTML code to show a page to mark an account for deletion.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="443" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="462" package="modules">
        <name>process_deleteUser</name>
        <full_name>process_deleteUser</full_name>
        <docblock line="459">
          <description><![CDATA[Write variables into object and do some regex checks]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="474" package="modules">
        <name>module_complete</name>
        <full_name>module_complete</full_name>
        <docblock line="469">
          <description><![CDATA[This function returns true if all needed settings are done.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="469" name="return" description="if account can be saved" type="\true,">
            <type by_reference="false">\true,</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="503" package="modules">
        <name>save_attributes</name>
        <full_name>save_attributes</full_name>
        <docblock line="491">
          <description><![CDATA[Returns a list of modifications which have to be made to the LDAP account.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="491" name="return" description="list of modifications &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 may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) &lt;br&gt;&quot;add&quot; are attributes which have to be added to LDAP entry &lt;br&gt;&quot;remove&quot; are attributes which have to be removed from LDAP entry &lt;br&gt;&quot;modify&quot; are attributes which have to been modified in LDAP entry &lt;br&gt;&quot;info&quot; are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="520" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>build_uploadAccounts</full_name>
        <docblock line="511">
          <description><![CDATA[In this function the LDAP account is built up.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="511" name="param" description="list of hash arrays (name =&gt; value) from user input" type="array" variable="$rawAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="511" name="param" description="list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="511" name="param" description="list of hash arrays (name =&gt; value) which are later added to LDAP" type="array" variable="$partialAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="511" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="511" name="return" description="list of error messages if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="520">
          <name>$rawAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="520">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="520">
          <name>$partialAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="520">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="622" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="617">
          <description><![CDATA[Returns the PDF entries for this module.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="617" name="return" description="list of possible PDF entries" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="659" package="modules">
        <name>getSelfServiceOptions</name>
        <full_name>getSelfServiceOptions</full_name>
        <docblock line="648">
          <description><![CDATA[Returns the meta HTML code for each input field.]]></description>
          <long-description><![CDATA[<p>format: array(<field1> => array(<META HTML>), ...)
It is not possible to display help links.</p>]]></long-description>
          <tag line="648" name="param" description="list of active fields" type="array" variable="$fields">
            <type by_reference="false">array</type>
          </tag>
          <tag line="648" name="param" description="attributes of LDAP account" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="648" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="648" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
            <type by_reference="false">array</type>
          </tag>
          <tag line="648" name="return" description="list of meta HTML elements (field name =&gt; htmlTableRow)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="659">
          <name>$fields</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="659">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="659">
          <name>$passwordChangeOnly</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="659">
          <name>$readOnlyFields</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="783" package="modules">
        <name>checkSelfServiceOptions</name>
        <full_name>checkSelfServiceOptions</full_name>
        <docblock line="766">
          <description><![CDATA[Checks if all input values are correct and returns the LDAP attributes which should be changed.]]></description>
          <long-description><![CDATA[<p><br>Return values:
<br>messages: array of parameters to create status messages
<br>add: array of attributes to add
<br>del: array of attributes to remove
<br>mod: array of attributes to modify
<br>info: array of values with informational value (e.g. to be used later by pre/postModify actions)</p>

<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.</p>]]></long-description>
          <tag line="766" name="param" description="input fields" type="string" variable="$fields">
            <type by_reference="false">string</type>
          </tag>
          <tag line="766" name="param" description="LDAP attributes" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="766" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="766" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
            <type by_reference="false">array</type>
          </tag>
          <tag line="766" name="return" description="messages and attributes (array('messages' =&gt; array(), 'add' =&gt; array('mail' =&gt; array('test@test.com')), 'del' =&gt; array(), 'mod' =&gt; array(), 'info' =&gt; array()))" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="783">
          <name>$fields</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="783">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="783">
          <name>$passwordChangeOnly</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="783">
          <name>$readOnlyFields</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="lib/modules/range.inc" hash="ae04380e14c433b88895200069581ed0" package="modules">
    <docblock line="26">
      <description><![CDATA[Manages DHCP ranges for DHCP server.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="26" name="package" description="modules"/>
      <tag line="26" name="author" description="Thomas Manninger"/>
      <tag line="26" name="author" description="Roland Gruber"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="41" package="modules">
      <extends>\baseModule</extends>
      <name>range</name>
      <full_name>\range</full_name>
      <docblock line="35">
        <description><![CDATA[Manages DHCP ranges for DHCP server.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="35" name="package" description="modules"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="44" namespace="global" package="main">
        <name>$subnet</name>
        <default><![CDATA[]]></default>
        <docblock line="43">
          <description><![CDATA[subnet]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="47" namespace="global" package="main">
        <name>$ranges</name>
        <default><![CDATA[]]></default>
        <docblock line="46">
          <description><![CDATA[ranges]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="50" namespace="global" package="main">
        <name>$processed</name>
        <default><![CDATA[]]></default>
        <docblock line="49">
          <description><![CDATA[Range -> Function attibute_processed already running?]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="53" namespace="global" package="main">
        <name>$overlaped</name>
        <default><![CDATA[]]></default>
        <docblock line="52">
          <description><![CDATA[For check, if IPs overlaped.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="62" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="55">
          <description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="55" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="55" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="106" package="modules">
        <name>load_Messages</name>
        <full_name>load_Messages</full_name>
        <docblock line="103">
          <description><![CDATA[This function fills the error message array with messages.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="true" visibility="private" namespace="global" line="118" package="modules">
        <name>calculateSubnet</name>
        <full_name>calculateSubnet</full_name>
        <docblock line="112">
          <description><![CDATA[Calculates the subnet for a given IP and netmask.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="112" name="param" description="IP address" type="String" variable="$ip">
            <type by_reference="false">String</type>
          </tag>
          <tag line="112" name="param" description="network mask" type="String" variable="$mask">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="118">
          <name>$ip</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="118">
          <name>$mask</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="131" package="modules">
        <name>check_range</name>
        <full_name>check_range</full_name>
        <docblock line="122">
          <description><![CDATA[Checks if the first IP is smaller than the second IP.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="122" name="param" description="first ip" type="String" variable="$first_ip">
            <type by_reference="false">String</type>
          </tag>
          <tag line="122" name="param" description="second ip" type="String" variable="$second_ip">
            <type by_reference="false">String</type>
          </tag>
          <tag line="122" name="return" description="if it's a valid Range, else false;" type="\true,">
            <type by_reference="false">\true,</type>
          </tag>
        </docblock>
        <argument line="131">
          <name>$first_ip</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="131">
          <name>$second_ip</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="global" line="154" package="modules">
        <name>check_subnet_range</name>
        <full_name>check_subnet_range</full_name>
        <docblock line="146">
          <description><![CDATA[Check if an IP address is in the correct subnet.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="146" name="param" description="IP address" type="String" variable="$ip">
            <type by_reference="false">String</type>
          </tag>
          <tag line="146" name="param" description="subnet" type="String" variable="$subnet">
            <type by_reference="false">String</type>
          </tag>
          <tag line="146" name="param" description="network mask" type="String" variable="$mask">
            <type by_reference="false">String</type>
          </tag>
          <tag line="146" name="return" description="if the range and subnet valid, else false" type="true">
            <type by_reference="false">true</type>
          </tag>
        </docblock>
        <argument line="154">
          <name>$ip</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="154">
          <name>$subnet</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="154">
          <name>$mask</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="169" package="modules">
        <name>overlaped_range</name>
        <full_name>overlaped_range</full_name>
        <docblock line="159">
          <description><![CDATA[Checked, if Ranges are overlaped.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="159" name="param" description="ip" type="\first" variable="$ip">
            <type by_reference="false">\first</type>
          </tag>
          <tag line="159" name="param" description="ip" type="\second" variable="$ipB">
            <type by_reference="false">\second</type>
          </tag>
          <tag line="159" name="return" description="if overlaped, else true." type="\false,">
            <type by_reference="false">\false,</type>
          </tag>
        </docblock>
        <argument line="169">
          <name>$ip</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="169">
          <name>$ipB</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="192" package="modules">
        <name>reset_overlaped_range</name>
        <full_name>reset_overlaped_range</full_name>
        <docblock line="187">
          <description><![CDATA[Reset the overlaped_range() function]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="201" package="modules">
        <name>getButtonStatus</name>
        <full_name>getButtonStatus</full_name>
        <docblock line="196">
          <description><![CDATA[Controls if the module button the account page is visible and activated.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="196" name="return" description="status (&quot;enabled&quot;, &quot;disabled&quot;, &quot;hidden&quot;)" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="215" package="modules">
        <name>load_attributes</name>
        <full_name>load_attributes</full_name>
        <docblock line="210">
          <description><![CDATA[This function loads all needed LDAP attributes.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="210" name="param" description="list of attributes" type="array" variable="$attr">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="215">
          <name>$attr</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="242" package="modules">
        <name>reload_ranges</name>
        <full_name>reload_ranges</full_name>
        <docblock line="235">
          <description><![CDATA[Adapt the Ranges with the subnet.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="235" name="return" description="if ranges were edit." type="\true,">
            <type by_reference="false">\true,</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="283" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="277">
          <description><![CDATA[Processes user input of the primary module page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="277" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="391" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="386">
          <description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="386" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="467" package="modules">
        <name>save_attributes</name>
        <full_name>save_attributes</full_name>
        <docblock line="455">
          <description><![CDATA[Returns a list of modifications which have to be made to the LDAP account.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="455" name="return" description="list of modifications &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 may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) &lt;br&gt;&quot;add&quot; are attributes which have to be added to LDAP entry &lt;br&gt;&quot;remove&quot; are attributes which have to be removed from LDAP entry &lt;br&gt;&quot;modify&quot; are attributes which have to been modified in LDAP entry &lt;br&gt;&quot;info&quot; are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="482" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="477">
          <description><![CDATA[Returns the PDF entries for this module.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="477" name="return" description="list of possible PDF entries" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/modules/ddns.inc" hash="d5f24b737263b26159c0a9f0401cc54b" package="modules">
    <docblock line="25">
      <description><![CDATA[Manages DDNS entries.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="25" name="package" description="modules"/>
      <tag line="25" name="author" description="Thomas Manninger"/>
      <tag line="25" name="author" description="Roland Gruber"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="40" package="modules">
      <extends>\baseModule</extends>
      <name>ddns</name>
      <full_name>\ddns</full_name>
      <docblock line="34">
        <description><![CDATA[Manages DDNS entries.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="34" name="package" description="modules"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="43" namespace="global" package="main">
        <name>$ddns</name>
        <default><![CDATA[array()]]></default>
        <docblock line="42">
          <description><![CDATA[standard DDNS settings]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="51" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="46">
          <description><![CDATA[Returns meta data that is interpreted by parent class.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="46" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="141" package="modules">
        <name>load_Messages</name>
        <full_name>load_Messages</full_name>
        <docblock line="138">
          <description><![CDATA[This function fills the message array.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="155" package="modules">
        <name>module_complete</name>
        <full_name>module_complete</full_name>
        <docblock line="150">
          <description><![CDATA[This functions returns true if all needed settings are done.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="150" name="return" description="true if LDAP operation can be done" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="193" package="modules">
        <name>save_attributes</name>
        <full_name>save_attributes</full_name>
        <docblock line="181">
          <description><![CDATA[Returns a list of modifications which have to be made to the LDAP account.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="181" name="return" description="list of modifications &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 may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) &lt;br&gt;&quot;add&quot; are attributes which have to be added to LDAP entry &lt;br&gt;&quot;remove&quot; are attributes which have to be removed from LDAP entry &lt;br&gt;&quot;modify&quot; are attributes which have to been modified in LDAP entry &lt;br&gt;&quot;info&quot; are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="200" package="modules">
        <name>check_if_ddns_is_enable</name>
        <full_name>check_if_ddns_is_enable</full_name>
        <docblock line="197">
          <description><![CDATA[This function check if ddns is enable.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="229" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="223">
          <description><![CDATA[Processes user input of the primary module page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="223" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="252" package="modules">
        <name>process_attributes_mainSettings</name>
        <full_name>process_attributes_mainSettings</full_name>
        <docblock line="249">
          <description><![CDATA[Process for mainsettings]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="289" package="modules">
        <name>process_attributes_account</name>
        <full_name>process_attributes_account</full_name>
        <docblock line="286">
          <description><![CDATA[Process for account]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="348" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="343">
          <description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="343" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="403" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="398">
          <description><![CDATA[Returns the PDF entries for this module.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="398" name="return" description="list of possible PDF entries" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="428" package="modules">
        <name>getDNSServer</name>
        <full_name>getDNSServer</full_name>
        <docblock line="423">
          <description><![CDATA[Returns the IP of the DNS server.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="423" name="return" description="IP address" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="451" package="modules">
        <name>getZoneNames</name>
        <full_name>getZoneNames</full_name>
        <docblock line="446">
          <description><![CDATA[Returns the zone names.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="446" name="return" description="zone names array(zone, reverse zone)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="479" package="modules">
        <name>isDynDNSActivated</name>
        <full_name>isDynDNSActivated</full_name>
        <docblock line="474">
          <description><![CDATA[Returns if DDNS is activated.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="474" name="return" description="activated" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="497" package="modules">
        <name>setDynDNSActivated</name>
        <full_name>setDynDNSActivated</full_name>
        <docblock line="492">
          <description><![CDATA[Sets if DDNS is activated.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="492" name="param" description="activated" type="boolean" variable="$activated">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="497">
          <name>$activated</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="519" package="modules">
        <name>addFixIPs</name>
        <full_name>addFixIPs</full_name>
        <docblock line="514">
          <description><![CDATA[Returns if fixed IPs are added to DDNS.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="514" name="return" description="add fixed IPs" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="537" package="modules">
        <name>setFixIPs</name>
        <full_name>setFixIPs</full_name>
        <docblock line="532">
          <description><![CDATA[Sets if client updates are ignored.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="532" name="param" description="add fixed IPs" type="boolean" variable="$add">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="537">
          <name>$add</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="556" package="modules">
        <name>isIgnoreClientUpdates</name>
        <full_name>isIgnoreClientUpdates</full_name>
        <docblock line="551">
          <description><![CDATA[Returns if client updates are ignored.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="551" name="return" description="ignore client updates" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="574" package="modules">
        <name>setIgnoreClientUpdates</name>
        <full_name>setIgnoreClientUpdates</full_name>
        <docblock line="569">
          <description><![CDATA[Sets if client updates are ignored.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="569" name="param" description="ignore client updates" type="boolean" variable="$ignore">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="574">
          <name>$ignore</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="596" package="modules">
        <name>getUpdateKey</name>
        <full_name>getUpdateKey</full_name>
        <docblock line="591">
          <description><![CDATA[Returns the key for DNS updates.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="591" name="return" description="key" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="614" package="modules">
        <name>setUpdateKey</name>
        <full_name>setUpdateKey</full_name>
        <docblock line="609">
          <description><![CDATA[Sets the key for DNS updates.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="609" name="param" description="key" type="String" variable="$key">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="614">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="639" package="modules">
        <name>load_attributes</name>
        <full_name>load_attributes</full_name>
        <docblock line="629">
          <description><![CDATA[This function loads the LDAP attributes when an account should be loaded.]]></description>
          <long-description><![CDATA[<p>Calling this method requires the existence of an enclosing {@link accountContainer}.<br>
<br>
By default this method loads the object classes and accounts which are specified in {@link getManagedObjectClasses()}
and {@link getManagedAttributes()}.</p>]]></long-description>
          <tag line="629" name="param" description="array like the array returned by get_ldap_attributes(dn of account) but without count indices" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="639">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="652" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>build_uploadAccounts</full_name>
        <docblock line="643">
          <description><![CDATA[In this function the LDAP account is built up.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="643" name="param" description="list of hash arrays (name =&gt; value) from user input" type="array" variable="$rawAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="643" name="param" description="list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="643" name="param" description="list of hash arrays (name =&gt; value) which are later added to LDAP" type="array" variable="$partialAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="643" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="643" name="return" description="list of error messages if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="652">
          <name>$rawAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="652">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="652">
          <name>$partialAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="652">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="lib/modules/sambaGroupMapping.inc" hash="df3115bc4fd4e70a211e3bc58ad805c9" package="modules">
    <docblock line="25">
      <description><![CDATA[Manages Samba 3 accounts for groups.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="25" name="package" description="modules"/>
      <tag line="25" name="author" description="Tilo Lutz"/>
      <tag line="25" name="author" description="Roland Gruber"/>
      <tag line="25" name="author" description="Michael Duergner"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="40" package="modules">
      <extends>\baseModule</extends>
      <name>sambaGroupMapping</name>
      <full_name>\sambaGroupMapping</full_name>
      <docblock line="35">
        <description><![CDATA[Manages the object class "sambaGroupMapping" for groups.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="35" name="package" description="modules"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="44" namespace="global" package="main">
        <name>$rids</name>
        <default><![CDATA[]]></default>
        <docblock line="43">
          <description><![CDATA[Array of well known RIDs]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="46" namespace="global" package="main">
        <name>$sambaGroupTypes</name>
        <default><![CDATA[]]></default>
        <docblock line="45">
          <description><![CDATA[Array of sambaGroupTypes]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="48" namespace="global" package="main">
        <name>$cachedDomainList</name>
        <default><![CDATA[null]]></default>
        <docblock line="47">
          <description><![CDATA[cache for domain list]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="55" package="modules">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="50">
          <description><![CDATA[Creates a new module for Samba 3 groups.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="50" name="param" description="account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="55">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="83" package="modules">
        <name>getGID</name>
        <full_name>getGID</full_name>
        <docblock line="78">
          <description><![CDATA[Gets the GID number from the Unix group module.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="78" name="return" description="GID number" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="101" package="modules">
        <name>getCn</name>
        <full_name>getCn</full_name>
        <docblock line="96">
          <description><![CDATA[Gets the cn from the Unix group module.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="96" name="return" description="cn attribute" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="138" package="modules">
        <name>get_uploadColumns</name>
        <full_name>get_uploadColumns</full_name>
        <docblock line="114">
          <description><![CDATA[Returns an array containing all input columns for the file upload.]]></description>
          <long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
<br>
This funtion returns an array which contains subarrays which represent an upload column.
<b>Syntax of column arrays:</b>
<br>
<br> array(
<br>  string: name,  // fixed non-translated name which is used as column name (should be of format: <module name>_<column name>)
<br>  string: description,  // short descriptive name
<br>  string: help,  // help ID
<br>  string: example,  // example value
<br>  string: values, // possible input values (optional)
<br>  string: default, // default value (optional)
<br>  boolean: required  // true, if user must set a value for this column
<br>  boolean: unique // true if all values of this column must be different values (optional, default: "false")
<br> )</p>]]></long-description>
          <tag line="114" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="114" name="return" description="column list" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="114" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
        <argument line="138">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="163" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>build_uploadAccounts</full_name>
        <docblock line="154">
          <description><![CDATA[In this function the LDAP account is built up.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="154" name="param" description="list of hash arrays (name =&gt; value) from user input" type="array" variable="$rawAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="154" name="param" description="list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="154" name="param" description="list of hash arrays (name =&gt; value) which are later added to LDAP" type="array" variable="$partialAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="154" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="154" name="return" description="list of error messages if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="163">
          <name>$rawAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="163">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="163">
          <name>$partialAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="163">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="233" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="228">
          <description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="228" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="301" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="294">
          <description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="294" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="294" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="382" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="377">
          <description><![CDATA[Returns the PDF entries for this module.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="377" name="return" description="list of possible PDF entries" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="398" package="modules">
        <name>get_profileOptions</name>
        <full_name>get_profileOptions</full_name>
        <docblock line="393">
          <description><![CDATA[Returns a list of elements for the account profiles.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="393" name="return" description="profile elements" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="418" package="modules">
        <name>load_profile</name>
        <full_name>load_profile</full_name>
        <docblock line="413">
          <description><![CDATA[Loads the values of an account profile into internal variables.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="413" name="param" description="hash array with profile values (identifier =&gt; value)" type="array" variable="$profile">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="418">
          <name>$profile</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="433" package="modules">
        <name>load_Messages</name>
        <full_name>load_Messages</full_name>
        <docblock line="431">
          <description><![CDATA[this functin fills the error message array with messages]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="446" package="modules">
        <name>module_ready</name>
        <full_name>module_ready</full_name>
        <docblock line="440">
          <description><![CDATA[This function is used to check if this module page can be displayed.]]></description>
          <long-description><![CDATA[<p>It returns false if a module depends on data from other modules which was not yet entered.</p>]]></long-description>
          <tag line="440" name="return" description="true, if page can be displayed" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="460" package="modules">
        <name>module_complete</name>
        <full_name>module_complete</full_name>
        <docblock line="453">
          <description><![CDATA[This function is used to check if all settings for this module have been made.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="453" name="see" description="\global\baseModule::module_complete" refers="\global\baseModule::module_complete"/>
          <tag line="453" name="return" description="true, if settings are complete" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="476" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="470">
          <description><![CDATA[Processes user input of the primary module page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="470" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="537" package="modules">
        <name>save_attributes</name>
        <full_name>save_attributes</full_name>
        <docblock line="525">
          <description><![CDATA[Returns a list of modifications which have to be made to the LDAP account.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="525" name="return" description="list of modifications &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 may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) &lt;br&gt;&quot;add&quot; are attributes which have to be added to LDAP entry &lt;br&gt;&quot;remove&quot; are attributes which have to be removed from LDAP entry &lt;br&gt;&quot;modify&quot; are attributes which have to been modified in LDAP entry &lt;br&gt;&quot;info&quot; are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="549" package="modules">
        <name>getDomains</name>
        <full_name>getDomains</full_name>
        <docblock line="544">
          <description><![CDATA[Returns a list of existing Samba 3 domains.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="544" name="return" description="list of samba3domain objects" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/modules/shadowAccount.inc" hash="6c95a9c15d9937a63083cca46de2757f" package="modules">
    <docblock line="24">
      <description><![CDATA[Manages Unix shadow accounts for users.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="package" description="modules"/>
      <tag line="24" name="author" description="Tilo Lutz"/>
      <tag line="24" name="author" description="Roland Gruber"/>
      <tag line="24" name="author" description="Michael Duergner"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="39" package="modules">
      <extends>\baseModule</extends>
      <implements>\passwordService</implements>
      <name>shadowAccount</name>
      <full_name>\shadowAccount</full_name>
      <docblock line="34">
        <description><![CDATA[Manages the object class "shadowAccount" for users.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="34" name="package" description="modules"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="46" package="modules">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="41">
          <description><![CDATA[Creates a new shadowAccount object.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="41" name="param" description="account type (user, group, host)" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="46">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="55" package="modules">
        <name>load_Messages</name>
        <full_name>load_Messages</full_name>
        <docblock line="52">
          <description><![CDATA[This function builds up the message array.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="77" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="70">
          <description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="70" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="70" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="246" package="modules">
        <name>save_attributes</name>
        <full_name>save_attributes</full_name>
        <docblock line="234">
          <description><![CDATA[Returns a list of modifications which have to be made to the LDAP account.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="234" name="return" description="list of modifications &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 may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) &lt;br&gt;&quot;add&quot; are attributes which have to be added to LDAP entry &lt;br&gt;&quot;remove&quot; are attributes which have to be removed from LDAP entry &lt;br&gt;&quot;modify&quot; are attributes which have to been modified in LDAP entry &lt;br&gt;&quot;info&quot; are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="260" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="254">
          <description><![CDATA[Processes user input of the primary module page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="254" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="297" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="292">
          <description><![CDATA[This function will create the meta HTML code to show a page with all attributes.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="292" name="return" description="meta HTML code" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="382" package="modules">
        <name>process_expire</name>
        <full_name>process_expire</full_name>
        <docblock line="376">
          <description><![CDATA[Processes user input of the expiration page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="376" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="434" package="modules">
        <name>display_html_expire</name>
        <full_name>display_html_expire</full_name>
        <docblock line="429">
          <description><![CDATA[This function will create the meta HTML code to show a page with the expiration date.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="429" name="return" description="meta HTML code" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="480" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="475">
          <description><![CDATA[Returns the PDF entries for this module.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="475" name="return" description="list of possible PDF entries" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="508" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>build_uploadAccounts</full_name>
        <docblock line="499">
          <description><![CDATA[In this function the LDAP account is built up.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="499" name="param" description="list of hash arrays (name =&gt; value) from user input" type="array" variable="$rawAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="499" name="param" description="list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="499" name="param" description="list of hash arrays (name =&gt; value) which are later added to LDAP" type="array" variable="$partialAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="499" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="499" name="return" description="list of error messages if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="508">
          <name>$rawAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="508">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="508">
          <name>$partialAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="508">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="588" package="modules">
        <name>load_profile</name>
        <full_name>load_profile</full_name>
        <docblock line="583">
          <description><![CDATA[Loads the values of an account profile into internal variables.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="583" name="param" description="hash array with profile values (identifier =&gt; value)" type="array" variable="$profile">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="588">
          <name>$profile</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="612" package="modules">
        <name>managesPasswordAttributes</name>
        <full_name>managesPasswordAttributes</full_name>
        <docblock line="606">
          <description><![CDATA[This method specifies if a module manages password attributes.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="606" name="see" description="\global\passwordService::managesPasswordAttributes" refers="\global\passwordService::managesPasswordAttributes"/>
          <tag line="606" name="return" description="true if this module manages password attributes" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="622" package="modules">
        <name>supportsForcePasswordChange</name>
        <full_name>supportsForcePasswordChange</full_name>
        <docblock line="617">
          <description><![CDATA[Specifies if this module supports to force that a user must change his password on next login.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="617" name="return" description="force password change supported" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="637" package="modules">
        <name>passwordChangeRequested</name>
        <full_name>passwordChangeRequested</full_name>
        <docblock line="626">
          <description><![CDATA[This function is called whenever the password should be changed.]]></description>
          <long-description><![CDATA[<p>Account modules
must change their password attributes only if the modules list contains their module name.</p>]]></long-description>
          <tag line="626" name="param" description="new password" type="String" variable="$password">
            <type by_reference="false">String</type>
          </tag>
          <tag line="626" name="param" description="list of modules for which the password should be changed" type="\$modules" variable="$modules">
            <type by_reference="false">\$modules</type>
          </tag>
          <tag line="626" name="param" description="force the user to change his password at next login" type="boolean" variable="$forcePasswordChange">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="626" name="return" description="list of error messages if any as parameter array for StatusMessage e.g. return arrray(array('ERROR', 'Password change failed.'))" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="626" name="see" description="\global\passwordService::passwordChangeRequested" refers="\global\passwordService::passwordChangeRequested"/>
        </docblock>
        <argument line="637">
          <name>$password</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="637">
          <name>$modules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="637">
          <name>$forcePasswordChange</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="659" package="modules">
        <name>setExpirationDate</name>
        <full_name>setExpirationDate</full_name>
        <docblock line="651">
          <description><![CDATA[Sets the expiration date of this account.]]></description>
          <long-description><![CDATA[<p>If all parameters are null the expiration date will be removed.</p>]]></long-description>
          <tag line="651" name="param" description="year (e.g. 2040)" type="String" variable="$year">
            <type by_reference="false">String</type>
          </tag>
          <tag line="651" name="param" description="month (e.g. 8)" type="String" variable="$month">
            <type by_reference="false">String</type>
          </tag>
          <tag line="651" name="param" description="day (e.g. 27)" type="String" variable="$day">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="659">
          <name>$year</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="659">
          <name>$month</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="659">
          <name>$day</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="lib/modules/ldapPublicKey.inc" hash="936ec626e27d4f2c7d4a9a80165cf4ca" package="modules">
    <docblock line="23">
      <description><![CDATA[Manages SSH public keys.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="23" name="package" description="modules"/>
      <tag line="23" name="author" description="Roland Gruber"/>
      <tag line="23" name="author" description="Andrew Dibble &lt;adibble@mobitv.com&gt;"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="36" package="modules">
      <extends>\baseModule</extends>
      <name>ldapPublicKey</name>
      <full_name>\ldapPublicKey</full_name>
      <docblock line="31">
        <description><![CDATA[Manages SSH public keys.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="31" name="package" description="modules"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="45" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="38">
          <description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="38" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="38" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="96" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="91">
          <description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="91" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="130" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="124">
          <description><![CDATA[Processes user input of the primary module page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="124" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="158" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>build_uploadAccounts</full_name>
        <docblock line="149">
          <description><![CDATA[In this function the LDAP account is built up.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="149" name="param" description="list of hash arrays (name =&gt; value) from user input" type="array" variable="$rawAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="149" name="param" description="list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="149" name="param" description="list of hash arrays (name =&gt; value) which are later added to LDAP" type="array" variable="$partialAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="149" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="149" name="return" description="list of error messages if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="158">
          <name>$rawAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="158">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="158">
          <name>$partialAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="158">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="178" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="175">
          <description><![CDATA[Returns a list of PDF entries]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="200" package="modules">
        <name>getSelfServiceOptions</name>
        <full_name>getSelfServiceOptions</full_name>
        <docblock line="189">
          <description><![CDATA[Returns the meta HTML code for each input field.]]></description>
          <long-description><![CDATA[<p>format: array(<field1> => array(<META HTML>), ...)
It is not possible to display help links.</p>]]></long-description>
          <tag line="189" name="param" description="list of active fields" type="array" variable="$fields">
            <type by_reference="false">array</type>
          </tag>
          <tag line="189" name="param" description="attributes of LDAP account" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="189" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="189" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
            <type by_reference="false">array</type>
          </tag>
          <tag line="189" name="return" description="list of meta HTML elements (field name =&gt; htmlTableRow)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="200">
          <name>$fields</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="200">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="200">
          <name>$passwordChangeOnly</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="200">
          <name>$readOnlyFields</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="247" package="modules">
        <name>checkSelfServiceOptions</name>
        <full_name>checkSelfServiceOptions</full_name>
        <docblock line="230">
          <description><![CDATA[Checks if all input values are correct and returns the LDAP attributes which should be changed.]]></description>
          <long-description><![CDATA[<p><br>Return values:
<br>messages: array of parameters to create status messages
<br>add: array of attributes to add
<br>del: array of attributes to remove
<br>mod: array of attributes to modify
<br>info: array of values with informational value (e.g. to be used later by pre/postModify actions)</p>

<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.</p>]]></long-description>
          <tag line="230" name="param" description="input fields" type="string" variable="$fields">
            <type by_reference="false">string</type>
          </tag>
          <tag line="230" name="param" description="LDAP attributes" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="230" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="230" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
            <type by_reference="false">array</type>
          </tag>
          <tag line="230" name="return" description="messages and attributes (array('messages' =&gt; array(), 'add' =&gt; array('mail' =&gt; array('test@test.com')), 'del' =&gt; array(), 'mod' =&gt; array(), 'info' =&gt; array()))" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="247">
          <name>$fields</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="247">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="247">
          <name>$passwordChangeOnly</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="247">
          <name>$readOnlyFields</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="lib/modules/nisnetgroup.inc" hash="d2d3fc0b586fb829e99182d9a501c9a5" package="modules">
    <docblock line="24">
      <description><![CDATA[Manages entries based on the object class nisNetgroup.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="package" description="modules"/>
      <tag line="24" name="author" description="Roland Gruber"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="36" package="modules">
      <extends>\baseModule</extends>
      <name>nisnetgroup</name>
      <full_name>\nisnetgroup</full_name>
      <docblock line="31">
        <description><![CDATA[Manages entries based on the object class nisNetgroup.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="31" name="package" description="modules"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="40" namespace="global" package="main">
        <name>$cachedUserList</name>
        <default><![CDATA[null]]></default>
        <docblock line="39">
          <description><![CDATA[user cache]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="42" namespace="global" package="main">
        <name>$cachedHostList</name>
        <default><![CDATA[null]]></default>
        <docblock line="41">
          <description><![CDATA[host cache]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="44" namespace="global" package="main">
        <name>$cachedGroupList</name>
        <default><![CDATA[null]]></default>
        <docblock line="43">
          <description><![CDATA[group cache]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="53" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="46">
          <description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="46" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="46" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="143" package="modules">
        <name>load_Messages</name>
        <full_name>load_Messages</full_name>
        <docblock line="140">
          <description><![CDATA[This function fills the $messages variable with output messages from this module.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="162" package="modules">
        <name>save_attributes</name>
        <full_name>save_attributes</full_name>
        <docblock line="150">
          <description><![CDATA[Returns a list of modifications which have to be made to the LDAP account.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="150" name="return" description="list of modifications &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 may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) &lt;br&gt;&quot;add&quot; are attributes which have to be added to LDAP entry &lt;br&gt;&quot;remove&quot; are attributes which have to be removed from LDAP entry &lt;br&gt;&quot;modify&quot; are attributes which have to been modified in LDAP entry &lt;br&gt;&quot;info&quot; are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="181" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="176">
          <description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="176" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="292" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="286">
          <description><![CDATA[Processes user input of the primary module page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="286" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="363" package="modules">
        <name>display_html_group</name>
        <full_name>display_html_group</full_name>
        <docblock line="358">
          <description><![CDATA[Displays the group selection.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="358" name="return" description="meta HTML code" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="405" package="modules">
        <name>process_group</name>
        <full_name>process_group</full_name>
        <docblock line="399">
          <description><![CDATA[Processes user input of the group selection page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="399" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="424" package="modules">
        <name>display_html_select</name>
        <full_name>display_html_select</full_name>
        <docblock line="419">
          <description><![CDATA[Displays the host/user selection.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="419" name="return" description="meta HTML code" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="500" package="modules">
        <name>process_select</name>
        <full_name>process_select</full_name>
        <docblock line="494">
          <description><![CDATA[Processes user input of the host/user selection page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="494" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="519" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>build_uploadAccounts</full_name>
        <docblock line="510">
          <description><![CDATA[In this function the LDAP account is built up.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="510" name="param" description="list of hash arrays (name =&gt; value) from user input" type="array" variable="$rawAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="510" name="param" description="list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="510" name="param" description="list of hash arrays (name =&gt; value) which are later added to LDAP" type="array" variable="$partialAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="510" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="510" name="return" description="list of error messages if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="519">
          <name>$rawAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="519">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="519">
          <name>$partialAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="519">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="560" package="modules">
        <name>module_complete</name>
        <full_name>module_complete</full_name>
        <docblock line="555">
          <description><![CDATA[This functions is used to check if all settings for this module have been made.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="555" name="return" description="true, if settings are complete" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="572" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="569">
          <description><![CDATA[Returns a list of PDF entries]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="603" package="modules">
        <name>getGroupList</name>
        <full_name>getGroupList</full_name>
        <docblock line="598">
          <description><![CDATA[Returns a list of existing NIS net groups.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="598" name="return" description="group names" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="619" package="modules">
        <name>getUserList</name>
        <full_name>getUserList</full_name>
        <docblock line="614">
          <description><![CDATA[Returns a list of existing users.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="614" name="return" description="user names" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="635" package="modules">
        <name>getHostList</name>
        <full_name>getHostList</full_name>
        <docblock line="630">
          <description><![CDATA[Returns a list of existing hosts.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="630" name="return" description="host names" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/modules/sambaDomain.inc" hash="98e02c6f4de894f57f2bc7b767919c15" package="modules">
    <docblock line="23">
      <description><![CDATA[Manages Samba 3 domain entries.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="23" name="package" description="modules"/>
      <tag line="23" name="author" description="Roland Gruber"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="35" package="modules">
      <extends>\baseModule</extends>
      <name>sambaDomain</name>
      <full_name>\sambaDomain</full_name>
      <docblock line="30">
        <description><![CDATA[Manages Samba 3 domain entries.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="30" name="package" description="modules"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="44" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="37">
          <description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="37" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="37" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="200" package="modules">
        <name>load_Messages</name>
        <full_name>load_Messages</full_name>
        <docblock line="197">
          <description><![CDATA[This function fills the error message array with messages]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="226" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="221">
          <description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="221" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="395" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="389">
          <description><![CDATA[Processes user input of the primary module page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="389" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="553" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>build_uploadAccounts</full_name>
        <docblock line="544">
          <description><![CDATA[In this function the LDAP account is built up.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="544" name="param" description="list of hash arrays (name =&gt; value) from user input" type="array" variable="$rawAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="544" name="param" description="list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="544" name="param" description="list of hash arrays (name =&gt; value) which are later added to LDAP" type="array" variable="$partialAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="544" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="544" name="return" description="list of error messages if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="553">
          <name>$rawAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="553">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="553">
          <name>$partialAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="553">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="632" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="627">
          <description><![CDATA[Returns the PDF entries for this module.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="627" name="return" description="list of possible PDF entries" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/modules/inetOrgPerson.inc" hash="93d23946c092dadec75502ba52c366a5" package="modules">
    <docblock line="24">
      <description><![CDATA[Manages the atrributes of object class inetOrgPerson.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="package" description="modules"/>
      <tag line="24" name="author" description="Tilo Lutz"/>
      <tag line="24" name="author" description="Roland Gruber"/>
      <tag line="24" name="author" description="Michael Duergner"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="38" package="modules">
      <extends>\baseModule</extends>
      <implements>\passwordService</implements>
      <name>inetOrgPerson</name>
      <full_name>\inetOrgPerson</full_name>
      <docblock line="33">
        <description><![CDATA[This module manages LDAP attributes of the object class inetOrgPerson (e.g.]]></description>
        <long-description><![CDATA[<p>name and address).</p>]]></long-description>
        <tag line="33" name="package" description="modules"/>
      </docblock>
      <constant namespace="global" line="58" package="modules">
        <name>SESS_CERTIFICATES_LIST</name>
        <full_name>SESS_CERTIFICATES_LIST</full_name>
        <value><![CDATA['inetOrgPerson_certificatesList']]></value>
        <docblock line="57">
          <description><![CDATA[session variable for existing user certificates in self service]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <property final="false" static="false" visibility="private" line="41" namespace="global" package="main">
        <name>$cachedManagers</name>
        <default><![CDATA[null]]></default>
        <docblock line="40">
          <description><![CDATA[caches the list of possible managers]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="43" namespace="global" package="main">
        <name>$clearTextPassword</name>
        <default><![CDATA[null]]></default>
        <docblock line="42">
          <description><![CDATA[clear text password]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="45" namespace="global" package="main">
        <name>$departmentCache</name>
        <default><![CDATA[null]]></default>
        <docblock line="44">
          <description><![CDATA[cache for departments]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="47" namespace="global" package="main">
        <name>$oCache</name>
        <default><![CDATA[null]]></default>
        <docblock line="46">
          <description><![CDATA[organization cache]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="49" namespace="global" package="main">
        <name>$ouCache</name>
        <default><![CDATA[null]]></default>
        <docblock line="48">
          <description><![CDATA[organizational unit cache]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="51" namespace="global" package="main">
        <name>$titleCache</name>
        <default><![CDATA[null]]></default>
        <docblock line="50">
          <description><![CDATA[title cache]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="53" namespace="global" package="main">
        <name>$employeeTypeCache</name>
        <default><![CDATA[null]]></default>
        <docblock line="52">
          <description><![CDATA[employee type cache]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="55" namespace="global" package="main">
        <name>$businessCategoryCache</name>
        <default><![CDATA[null]]></default>
        <docblock line="54">
          <description><![CDATA[business category cache]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="63" package="modules">
        <name>load_Messages</name>
        <full_name>load_Messages</full_name>
        <docblock line="60">
          <description><![CDATA[This function fills the message array.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="110" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="103">
          <description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="103" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="103" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="924" package="modules">
        <name>module_complete</name>
        <full_name>module_complete</full_name>
        <docblock line="919">
          <description><![CDATA[This functions return true if all needed settings are done.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="919" name="return" description="true, if all is ok" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="947" package="modules">
        <name>getButtonStatus</name>
        <full_name>getButtonStatus</full_name>
        <docblock line="942">
          <description><![CDATA[Controls if the module button the account page is visible and activated.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="942" name="return" description="status (&quot;enabled&quot;, &quot;disabled&quot;, &quot;hidden&quot;)" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="970" package="modules">
        <name>save_attributes</name>
        <full_name>save_attributes</full_name>
        <docblock line="958">
          <description><![CDATA[Returns a list of modifications which have to be made to the LDAP account.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="958" name="return" description="list of modifications &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 may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) &lt;br&gt;&quot;add&quot; are attributes which have to be added to LDAP entry &lt;br&gt;&quot;remove&quot; are attributes which have to be removed from LDAP entry &lt;br&gt;&quot;modify&quot; are attributes which have to been modified in LDAP entry &lt;br&gt;&quot;info&quot; are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1011" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="1005">
          <description><![CDATA[Processes user input of the primary module page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="1005" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1394" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="1389">
          <description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1389" name="return" description="HTML meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2118" package="modules">
        <name>process_photo</name>
        <full_name>process_photo</full_name>
        <docblock line="2115">
          <description><![CDATA[Sets a new photo.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2140" package="modules">
        <name>display_html_photo</name>
        <full_name>display_html_photo</full_name>
        <docblock line="2135">
          <description><![CDATA[Displays the photo upload page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2135" name="return" description="meta HTML code" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2155" package="modules">
        <name>display_html_manager</name>
        <full_name>display_html_manager</full_name>
        <docblock line="2150">
          <description><![CDATA[This function will create the meta HTML code to show a page to change the manager attribute.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2150" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2232" package="modules">
        <name>process_manager</name>
        <full_name>process_manager</full_name>
        <docblock line="2226">
          <description><![CDATA[Processes user input of the manager page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="2226" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2257" package="modules">
        <name>display_html_userCertificate</name>
        <full_name>display_html_userCertificate</full_name>
        <docblock line="2252">
          <description><![CDATA[Displays the certificate upload page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2252" name="return" description="meta HTML code" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2313" package="modules">
        <name>process_userCertificate</name>
        <full_name>process_userCertificate</full_name>
        <docblock line="2310">
          <description><![CDATA[Sets a new certificate or deletes old ones.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2354" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="2349">
          <description><![CDATA[Returns the PDF entries for this module.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2349" name="return" description="list of possible PDF entries" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2394" package="modules">
        <name>load_profile</name>
        <full_name>load_profile</full_name>
        <docblock line="2389">
          <description><![CDATA[Loads the values of an account profile into internal variables.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2389" name="param" description="hash array with profile values (identifier =&gt; value)" type="array" variable="$profile">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2394">
          <name>$profile</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2457" package="modules">
        <name>check_profileOptions</name>
        <full_name>check_profileOptions</full_name>
        <docblock line="2451">
          <description><![CDATA[Checks input values of account profiles.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2451" name="param" description="a hash array (name =&gt; value) containing the options" type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2451" name="return" description="list of error messages (array(type, title, text)) to generate StatusMessages, if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2457">
          <name>$options</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2495" package="modules">
        <name>get_uploadColumns</name>
        <full_name>get_uploadColumns</full_name>
        <docblock line="2480">
          <description><![CDATA[Returns an array containing all input columns for the file upload.]]></description>
          <long-description><![CDATA[<p>Syntax:
<br> array(
<br>  string: name,  // fixed non-translated name which is used as column name (should be of format: <module name>_<column name>)
<br>  string: description,  // short descriptive name
<br>  string: help,  // help ID
<br>  string: example,  // example value
<br>  boolean: required  // true, if user must set a value for this column
<br> )</p>]]></long-description>
          <tag line="2480" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2480" name="return" description="column list" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2495">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2535" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>build_uploadAccounts</full_name>
        <docblock line="2526">
          <description><![CDATA[In this function the LDAP account is built up.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2526" name="param" description="list of hash arrays (name =&gt; value) from user input" type="array" variable="$rawAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2526" name="param" description="list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2526" name="param" description="list of hash arrays (name =&gt; value) which are later added to LDAP" type="array" variable="$partialAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2526" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2526" name="return" description="list of error messages if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2535">
          <name>$rawAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2535">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2535">
          <name>$partialAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2535">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2855" package="modules">
        <name>doUploadPostActions</name>
        <full_name>doUploadPostActions</full_name>
        <docblock line="2840">
          <description><![CDATA[This function executes one post upload action.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2840" name="param" description="array containing one account in each element" type="array" variable="$data">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2840" name="param" description="array(&lt;column_name&gt; =&gt; &lt;column number&gt;)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2840" name="param" description="list of accounts which were not created successfully" type="array" variable="$failed">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2840" name="param" description="variable to store temporary data between two post actions" type="array" variable="$temp">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2840" name="param" description="list of LDAP entries" type="array" variable="$accounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2840" name="return" description="current status &lt;br&gt; array ( &lt;br&gt; 'status' =&gt; 'finished' | 'inProgress' &lt;br&gt; 'progress' =&gt; 0..100 &lt;br&gt; 'errors' =&gt; array (&lt;array of parameters for StatusMessage&gt;) &lt;br&gt; )" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2855">
          <name>$data</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2855">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2855">
          <name>$failed</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2855">
          <name>$temp</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2855">
          <name>$accounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2910" package="modules">
        <name>getSelfServiceOptions</name>
        <full_name>getSelfServiceOptions</full_name>
        <docblock line="2899">
          <description><![CDATA[Returns the meta HTML code for each input field.]]></description>
          <long-description><![CDATA[<p>format: array(<field1> => array(<META HTML>), ...)
It is not possible to display help links.</p>]]></long-description>
          <tag line="2899" name="param" description="list of active fields" type="array" variable="$fields">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2899" name="param" description="attributes of LDAP account" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2899" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="2899" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2899" name="return" description="list of meta HTML elements (field name =&gt; htmlTableRow)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2910">
          <name>$fields</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2910">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2910">
          <name>$passwordChangeOnly</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2910">
          <name>$readOnlyFields</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="private" namespace="global" line="3223" package="modules">
        <name>getSelfServiceUserCertificates</name>
        <full_name>getSelfServiceUserCertificates</full_name>
        <docblock line="3217">
          <description><![CDATA[Returns the meta HTML code to display the certificate area.]]></description>
          <long-description><![CDATA[<p>This also includes the file upload.</p>]]></long-description>
          <tag line="3217" name="return" description="certificate content" type="\htmlTable">
            <type by_reference="false">\htmlTable</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="true" visibility="private" namespace="global" line="3271" package="modules">
        <name>getSelfServiceUserCertificatesJSBlock</name>
        <full_name>getSelfServiceUserCertificatesJSBlock</full_name>
        <docblock line="3266">
          <description><![CDATA[Returns the Java Script functions to manage the certificates.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="3266" name="return" description="JS block" type="\htmlJavaScript">
            <type by_reference="false">\htmlJavaScript</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="3339" package="modules">
        <name>checkSelfServiceOptions</name>
        <full_name>checkSelfServiceOptions</full_name>
        <docblock line="3322">
          <description><![CDATA[Checks if all input values are correct and returns the LDAP attributes which should be changed.]]></description>
          <long-description><![CDATA[<p><br>Return values:
<br>messages: array of parameters to create status messages
<br>add: array of attributes to add
<br>del: array of attributes to remove
<br>mod: array of attributes to modify
<br>info: array of values with informational value (e.g. to be used later by pre/postModify actions)</p>

<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.</p>]]></long-description>
          <tag line="3322" name="param" description="input fields" type="string" variable="$fields">
            <type by_reference="false">string</type>
          </tag>
          <tag line="3322" name="param" description="LDAP attributes" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="3322" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="3322" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
            <type by_reference="false">array</type>
          </tag>
          <tag line="3322" name="return" description="messages and attributes (array('messages' =&gt; array(), 'add' =&gt; array('mail' =&gt; array('test@test.com')), 'del' =&gt; array(), 'mod' =&gt; array(), 'info' =&gt; array()))" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="3339">
          <name>$fields</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="3339">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="3339">
          <name>$passwordChangeOnly</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="3339">
          <name>$readOnlyFields</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="3608" package="modules">
        <name>handleAjaxRequest</name>
        <full_name>handleAjaxRequest</full_name>
        <docblock line="3604">
          <description><![CDATA[Manages AJAX requests.]]></description>
          <long-description><![CDATA[<p>This function may be called with or without an account container.</p>]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="3627" package="modules">
        <name>ajaxUpload</name>
        <full_name>ajaxUpload</full_name>
        <docblock line="3624">
          <description><![CDATA[Handles an AJAX file upload and prints the JSON result.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="3666" package="modules">
        <name>ajaxDeleteSelfServiceUserCertificate</name>
        <full_name>ajaxDeleteSelfServiceUserCertificate</full_name>
        <docblock line="3661">
          <description><![CDATA[Manages the deletion of a certificate.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="3661" name="param" description="JSON data" type="array" variable="$data">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="3666">
          <name>$data</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="global" line="3694" package="modules">
        <name>invalidAjaxRequest</name>
        <full_name>invalidAjaxRequest</full_name>
        <docblock line="3689">
          <description><![CDATA[Invalid AJAX request received.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="3689" name="param" description="error message" type="String" variable="$message">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="3694">
          <name>$message</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="3707" package="modules">
        <name>managesPasswordAttributes</name>
        <full_name>managesPasswordAttributes</full_name>
        <docblock line="3701">
          <description><![CDATA[This method specifies if a module manages password attributes.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="3701" name="see" description="\global\passwordService::managesPasswordAttributes" refers="\global\passwordService::managesPasswordAttributes"/>
          <tag line="3701" name="return" description="true if this module manages password attributes" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="3720" package="modules">
        <name>supportsForcePasswordChange</name>
        <full_name>supportsForcePasswordChange</full_name>
        <docblock line="3715">
          <description><![CDATA[Specifies if this module supports to force that a user must change his password on next login.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="3715" name="return" description="force password change supported" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="3735" package="modules">
        <name>passwordChangeRequested</name>
        <full_name>passwordChangeRequested</full_name>
        <docblock line="3724">
          <description><![CDATA[This function is called whenever the password should be changed.]]></description>
          <long-description><![CDATA[<p>Account modules
must change their password attributes only if the modules list contains their module name.</p>]]></long-description>
          <tag line="3724" name="param" description="new password" type="String" variable="$password">
            <type by_reference="false">String</type>
          </tag>
          <tag line="3724" name="param" description="list of modules for which the password should be changed" type="\$modules" variable="$modules">
            <type by_reference="false">\$modules</type>
          </tag>
          <tag line="3724" name="param" description="force the user to change his password at next login" type="boolean" variable="$forcePasswordChange">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="3724" name="return" description="list of error messages if any as parameter array for StatusMessage e.g. return arrray(array('ERROR', 'Password change failed.'))" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="3724" name="see" description="\global\passwordService::passwordChangeRequested" refers="\global\passwordService::passwordChangeRequested"/>
        </docblock>
        <argument line="3735">
          <name>$password</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="3735">
          <name>$modules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="3735">
          <name>$forcePasswordChange</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="3749" package="modules">
        <name>getManagers</name>
        <full_name>getManagers</full_name>
        <docblock line="3744">
          <description><![CDATA[Returns a list of possible managers.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="3744" name="return" description="list of format array(abstract DN =&gt; DN)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="3769" package="modules">
        <name>initCache</name>
        <full_name>initCache</full_name>
        <docblock line="3766">
          <description><![CDATA[Loads cached data from LDAP such as departmets etc.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/modules/systemQuotas.inc" hash="e82d9463ec00ed5b5fe39fd29ebccb75" package="modules">
    <docblock line="23">
      <description><![CDATA[Manages user quotas with the object class systemQuotas.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="23" name="package" description="modules"/>
      <tag line="23" name="author" description="Roland Gruber"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="35" package="modules">
      <extends>\baseModule</extends>
      <name>systemQuotas</name>
      <full_name>\systemQuotas</full_name>
      <docblock line="30">
        <description><![CDATA[Manages user quotas with the object class systemQuotas.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="30" name="package" description="modules"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="44" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="37">
          <description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="37" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="37" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="89" package="modules">
        <name>load_Messages</name>
        <full_name>load_Messages</full_name>
        <docblock line="86">
          <description><![CDATA[This function fills the $messages variable with output messages from this module.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="111" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="106">
          <description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="106" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="178" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="172">
          <description><![CDATA[Processes user input of the primary module page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="172" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="234" package="modules">
        <name>checkQuota</name>
        <full_name>checkQuota</full_name>
        <docblock line="223">
          <description><![CDATA[Checks if the quota parameters are valid.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="223" name="param" description="mountpoint" type="String" variable="$path">
            <type by_reference="false">String</type>
          </tag>
          <tag line="223" name="param" description="soft block limit" type="int" variable="$softBlock">
            <type by_reference="false">int</type>
          </tag>
          <tag line="223" name="param" description="hard block limit" type="int" variable="$hardBlock">
            <type by_reference="false">int</type>
          </tag>
          <tag line="223" name="param" description="soft inode limit" type="int" variable="$softInode">
            <type by_reference="false">int</type>
          </tag>
          <tag line="223" name="param" description="hard inode limit" type="int" variable="$hardInode">
            <type by_reference="false">int</type>
          </tag>
          <tag line="223" name="param" description="position is upload table" type="boolean" variable="$uploadIndex">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="223" name="return" description="array where error messages are returned" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="234">
          <name>$path</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="234">
          <name>$softBlock</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="234">
          <name>$hardBlock</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="234">
          <name>$softInode</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="234">
          <name>$hardInode</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="234">
          <name>$uploadIndex</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="315" package="modules">
        <name>check_profileOptions</name>
        <full_name>check_profileOptions</full_name>
        <docblock line="309">
          <description><![CDATA[Checks input values of account profiles.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="309" name="param" description="a hash array (name =&gt; value) containing the options" type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="309" name="return" description="list of error messages (array(type, title, text)) to generate StatusMessages, if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="315">
          <name>$options</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="333" package="modules">
        <name>load_profile</name>
        <full_name>load_profile</full_name>
        <docblock line="328">
          <description><![CDATA[Loads the values of an account profile into internal variables.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="328" name="param" description="hash array with profile values (identifier =&gt; value)" type="array" variable="$profile">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="333">
          <name>$profile</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="350" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>build_uploadAccounts</full_name>
        <docblock line="341">
          <description><![CDATA[In this function the LDAP account is built up.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="341" name="param" description="list of hash arrays (name =&gt; value) from user input" type="array" variable="$rawAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="341" name="param" description="list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="341" name="param" description="list of hash arrays (name =&gt; value) which are later added to LDAP" type="array" variable="$partialAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="341" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="341" name="return" description="list of error messages if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="350">
          <name>$rawAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="350">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="350">
          <name>$partialAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="350">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="371" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="368">
          <description><![CDATA[Returns a list of PDF entries]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/modules/freeRadius.inc" hash="e3c1425abc51704bd88107052e40440e" package="modules">
    <docblock line="23">
      <description><![CDATA[Manages FreeRadius accounts.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="23" name="package" description="modules"/>
      <tag line="23" name="author" description="Roland Gruber"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="35" package="modules">
      <extends>\baseModule</extends>
      <name>freeRadius</name>
      <full_name>\freeRadius</full_name>
      <docblock line="30">
        <description><![CDATA[Manages FreeRadius accounts.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="30" name="package" description="modules"/>
      </docblock>
      <property final="false" static="true" visibility="private" line="38" namespace="global" package="main">
        <name>$monthList</name>
        <default><![CDATA[array('01' => 'Jan', '02' => 'Feb', '03' => 'Mar', '04' => 'Apr', '05' => 'May', '06' => 'Jun', '07' => 'Jul', '08' => 'Aug', '09' => 'Sep', '10' => 'Oct', '11' => 'Nov', '12' => 'Dec')]]></default>
        <docblock line="37">
          <description><![CDATA[list of possible months]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="48" package="modules">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="43">
          <description><![CDATA[Creates a new freeRadius object.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="43" name="param" description="account type (user, group, host)" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="48">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="60" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="53">
          <description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="53" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="53" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="241" package="modules">
        <name>load_Messages</name>
        <full_name>load_Messages</full_name>
        <docblock line="238">
          <description><![CDATA[This function fills the error message array with messages]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="261" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="256">
          <description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="256" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="356" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="350">
          <description><![CDATA[Processes user input of the primary module page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="350" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="429" package="modules">
        <name>display_html_expiration</name>
        <full_name>display_html_expiration</full_name>
        <docblock line="424">
          <description><![CDATA[This function will create the meta HTML code to show a page to change the expiration date.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="424" name="return" description="meta HTML code" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="489" package="modules">
        <name>process_expiration</name>
        <full_name>process_expiration</full_name>
        <docblock line="484">
          <description><![CDATA[Processes user input of the time selection page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="484" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="527" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>build_uploadAccounts</full_name>
        <docblock line="518">
          <description><![CDATA[In this function the LDAP account is built up.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="518" name="param" description="list of hash arrays (name =&gt; value) from user input" type="array" variable="$rawAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="518" name="param" description="list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="518" name="param" description="list of hash arrays (name =&gt; value) which are later added to LDAP" type="array" variable="$partialAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="518" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="518" name="return" description="list of error messages if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="527">
          <name>$rawAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="527">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="527">
          <name>$partialAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="527">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="614" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="609">
          <description><![CDATA[Returns the PDF entries for this module.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="609" name="return" description="list of possible PDF entries" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="633" package="modules">
        <name>check_profileOptions</name>
        <full_name>check_profileOptions</full_name>
        <docblock line="627">
          <description><![CDATA[Checks input values of account profiles.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="627" name="param" description="a hash array (name =&gt; value) containing the options" type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="627" name="return" description="list of error messages (array(type, title, text)) to generate StatusMessages, if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="633">
          <name>$options</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="655" package="modules">
        <name>load_profile</name>
        <full_name>load_profile</full_name>
        <docblock line="650">
          <description><![CDATA[Loads the values of an account profile into internal variables.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="650" name="param" description="hash array with profile values (identifier =&gt; value)" type="array" variable="$profile">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="655">
          <name>$profile</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="671" package="modules">
        <name>formatExpirationDate</name>
        <full_name>formatExpirationDate</full_name>
        <docblock line="666">
          <description><![CDATA[Formats the expiration date attribute.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="666" name="param" description="date value" type="String" variable="$date">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="671">
          <name>$date</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="lib/modules/asteriskExtension.inc" hash="1d215ec460a6b35281289779d79675fc" package="modules">
    <docblock line="27">
      <description><![CDATA[Manages Asterisk extensions.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="27" name="package" description="modules"/>
      <tag line="27" name="author" description="Pavel Pozdniak"/>
      <tag line="27" name="author" description="Roland Gruber"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="41" package="modules">
      <extends>\baseModule</extends>
      <name>asteriskExtension</name>
      <full_name>\asteriskExtension</full_name>
      <docblock line="36">
        <description><![CDATA[Manages Asterisk extensions.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="36" name="package" description="modules"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="44" namespace="global" package="main">
        <name>$filterOwnerForAsteriskAccounts</name>
        <default><![CDATA[true]]></default>
        <docblock line="43">
          <description><![CDATA[if true then only Asterisk accounts are shown as possible owners]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="47" namespace="global" package="main">
        <name>$searchOwnersInTreeSuffix</name>
        <default><![CDATA[false]]></default>
        <docblock line="46">
          <description><![CDATA[if true then the tree suffix will be used to search potential owners]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="49" namespace="global" package="main">
        <name>$extensionRows</name>
        <default><![CDATA[array()]]></default>
        <docblock line="48">
          <description><![CDATA[Contains all attributes information for set of accounts]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="51" namespace="global" package="main">
        <name>$extensionRowsOrig</name>
        <default><![CDATA[array()]]></default>
        <docblock line="50">
          <description><![CDATA[Contains all original attributes information for set of accounts]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="53" namespace="global" package="main">
        <name>$extensionOwners</name>
        <default><![CDATA[array()]]></default>
        <docblock line="52">
          <description><![CDATA[extension owners]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="55" namespace="global" package="main">
        <name>$addRuleFlag</name>
        <default><![CDATA[false]]></default>
        <docblock line="54">
          <description><![CDATA[flag if new rule should be added]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="62" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="57">
          <description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="57" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="177" package="modules">
        <name>load_Messages</name>
        <full_name>load_Messages</full_name>
        <docblock line="174">
          <description><![CDATA[This function fills the error message array with messages]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="195" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="190">
          <description><![CDATA[This function will create the meta HTML code to show a page with all attributes.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="190" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="224" package="modules">
        <name>render_exten_owners_set_controls</name>
        <full_name>render_exten_owners_set_controls</full_name>
        <docblock line="219">
          <description><![CDATA[This function prints management elements to manipulate owners of an extension.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="219" name="param" description="container" type="\htmlTable" variable="$renderContainer">
            <type by_reference="false">\htmlTable</type>
          </tag>
        </docblock>
        <argument line="224">
          <name>$renderContainer</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="250" package="modules">
        <name>load_extension_parts</name>
        <full_name>load_extension_parts</full_name>
        <docblock line="245">
          <description><![CDATA[Loads all related extension entries.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="245" name="param" description="extension name" type="String" variable="$extension">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="250">
          <name>$extension</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="273" package="modules">
        <name>render_extensions_by_priority</name>
        <full_name>render_extensions_by_priority</full_name>
        <docblock line="267">
          <description><![CDATA[Generates the meta HTML for the rules.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="267" name="param" description="extension name" type="String" variable="$extension">
            <type by_reference="false">String</type>
          </tag>
          <tag line="267" name="param" description="container" type="\htmlTable" variable="$renderContainer">
            <type by_reference="false">\htmlTable</type>
          </tag>
        </docblock>
        <argument line="273">
          <name>$extension</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="273">
          <name>$renderContainer</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="353" package="modules">
        <name>render_extension</name>
        <full_name>render_extension</full_name>
        <docblock line="346">
          <description><![CDATA[Generates the meta HTML for a single rule.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="346" name="param" description="attributes of rule" type="array" variable="$extensLine">
            <type by_reference="false">array</type>
          </tag>
          <tag line="346" name="param" description="rule position" type="int" variable="$placeInList">
            <type by_reference="false">int</type>
          </tag>
          <tag line="346" name="param" description="container" type="\htmlTable" variable="$renderContainer">
            <type by_reference="false">\htmlTable</type>
          </tag>
        </docblock>
        <argument line="353">
          <name>$extensLine</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="353">
          <name>$placeInList</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="353">
          <name>$renderContainer</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="379" package="modules">
        <name>array_sort</name>
        <full_name>array_sort</full_name>
        <docblock line="372">
          <description><![CDATA[Sorts an array of arrays by the given key.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="372" name="param" description="array" type="array" variable="$array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="372" name="param" description="key" type="String" variable="$on">
            <type by_reference="false">String</type>
          </tag>
          <tag line="372" name="param" description="order (SORT_ASC or SORT_DESC)" type="String" variable="$order">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="379">
          <name>$array</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="379">
          <name>$on</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="379">
          <name>$order</name>
          <default><![CDATA['SORT_ASC']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="417" package="modules">
        <name>display_html_user</name>
        <full_name>display_html_user</full_name>
        <docblock line="412">
          <description><![CDATA[Displays a list of possible owners of this extension.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="412" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="489" package="modules">
        <name>process_user</name>
        <full_name>process_user</full_name>
        <docblock line="483">
          <description><![CDATA[Processes user input of the user selection page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="483" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="522" package="modules">
        <name>isMoveToNewSuffix</name>
        <full_name>isMoveToNewSuffix</full_name>
        <docblock line="517">
          <description><![CDATA[Returns if the extension was moved to another OU.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="517" name="return" description="true if moved" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="537" package="modules">
        <name>isExtensionOwnerSet</name>
        <full_name>isExtensionOwnerSet</full_name>
        <docblock line="532">
          <description><![CDATA[Returns true if at least one owner is set and false otherwise]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="532" name="return" description="true if one or more owners" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="549" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="544">
          <description><![CDATA[Writes variables into object and does some regex checks.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="544" name="return" description="error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="603" package="modules">
        <name>processExtensionRows</name>
        <full_name>processExtensionRows</full_name>
        <docblock line="596">
          <description><![CDATA[Processes the rule data.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="596" name="param" description="extension name" type="String" variable="$extensionName">
            <type by_reference="false">String</type>
          </tag>
          <tag line="596" name="param" description="extension context" type="String" variable="$extensionContext">
            <type by_reference="false">String</type>
          </tag>
          <tag line="596" name="return" description="error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="603">
          <name>$extensionName</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="603">
          <name>$extensionContext</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="644" package="modules">
        <name>setDefaultExtensionOwner</name>
        <full_name>setDefaultExtensionOwner</full_name>
        <docblock line="641">
          <description><![CDATA[Set extension owner as current logged in user.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="655" package="modules">
        <name>getDefaultExtensionOwner</name>
        <full_name>getDefaultExtensionOwner</full_name>
        <docblock line="650">
          <description><![CDATA[Returns the default extension owner.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="650" name="return" description="owner" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="672" package="modules">
        <name>processSingleExtension</name>
        <full_name>processSingleExtension</full_name>
        <docblock line="661">
          <description><![CDATA[Fills the fileds of a single extension row.]]></description>
          <long-description><![CDATA[<p>In Asterisk it would only be an extension name,a priority,an application, but LDAP spicific
add to processing context field.</p>]]></long-description>
          <tag line="661" name="param" description="- hash array to store single extension properties;" type="array" variable="$extRow">
            <type by_reference="false">array</type>
          </tag>
          <tag line="661" name="param" description="extension name" type="String" variable="$extensionName">
            <type by_reference="false">String</type>
          </tag>
          <tag line="661" name="param" description="extension context" type="String" variable="$extensionContext">
            <type by_reference="false">String</type>
          </tag>
          <tag line="661" name="param" description="- counter to distinguish single extensuion properties from $_POST" type="int" variable="$entryCounter">
            <type by_reference="false">int</type>
          </tag>
          <tag line="661" name="param" description="- it is the variable where actual number of extension rules wuld be aggregated" type="int" variable="$extensionPriorityCntr">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
        <argument line="672">
          <name>$extRow</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="672">
          <name>$extensionName</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="672">
          <name>$extensionContext</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="672">
          <name>$entryCounter</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="672">
          <name>$extensionPriorityCntr</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="713" package="modules">
        <name>processPriorityChange</name>
        <full_name>processPriorityChange</full_name>
        <docblock line="710">
          <description><![CDATA[Reorders the rules if the user clicked on a move button.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="734" package="modules">
        <name>isThisExtensionPresented</name>
        <full_name>isThisExtensionPresented</full_name>
        <docblock line="726">
          <description><![CDATA[Search by extension name and retun true if fields with this extension name exists
and false otherwise.]]></description>
          <long-description><![CDATA[<p>Equal extension names are allowed in different OUs.</p>]]></long-description>
          <tag line="726" name="param" description="extension name" type="String" variable="$extension">
            <type by_reference="false">String</type>
          </tag>
          <tag line="726" name="return" description="true if there are entries with this extension name." type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="734">
          <name>$extension</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="758" package="modules">
        <name>generateNextExtensionName</name>
        <full_name>generateNextExtensionName</full_name>
        <docblock line="751">
          <description><![CDATA[This function searches in the base subtree and finds all extensions names within.]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="751" name="return" description="suggested extension name" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="793" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="790">
          <description><![CDATA[Returns a list of PDF entries]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="844" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>build_uploadAccounts</full_name>
        <docblock line="835">
          <description><![CDATA[In this function the LDAP account is built up.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="835" name="param" description="list of hash arrays (name =&gt; value) from user input" type="array" variable="$rawAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="835" name="param" description="list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="835" name="param" description="list of hash arrays (name =&gt; value) which are later added to LDAP" type="array" variable="$partialAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="835" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="835" name="return" description="list of error messages if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="844">
          <name>$rawAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="844">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="844">
          <name>$partialAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="844">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="896" package="modules">
        <name>moveExtentionToNewSuffix</name>
        <full_name>moveExtentionToNewSuffix</full_name>
        <docblock line="890">
          <description><![CDATA[Get list of all applications for given extension and move it into new suffix.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="890" name="param" description="attributes of original extension" type="array" variable="$rowOrig">
            <type by_reference="false">array</type>
          </tag>
          <tag line="890" name="return" description="list of error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="896">
          <name>$rowOrig</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="930" package="modules">
        <name>save_attributes</name>
        <full_name>save_attributes</full_name>
        <docblock line="910">
          <description><![CDATA[Returns a list of modifications which have to be made to the LDAP account.]]></description>
          <long-description><![CDATA[<p>Calling this method requires the existence of an enclosing {@link accountContainer}.<br>
<br></p>

<p><br>This function returns an array with 3 entries:
<br>array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... )
<br>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)<br>
<br><b>"add"</b> are attributes which have to be added to the LDAP entry
<br><b>"remove"</b> are attributes which have to be removed from the LDAP entry
<br><b>"modify"</b> are attributes which have to be modified in the LDAP entry
<br><b>"notchanged"</b> are attributes which stay unchanged
<br><b>"info"</b> values with informational value (e.g. to be used later by pre/postModify actions)
<br>
<br>This builds the required comands from $this-attributes and $this->orig.</p>]]></long-description>
          <tag line="910" name="return" description="list of modifications" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="989" package="modules">
        <name>postDeleteActions</name>
        <full_name>postDeleteActions</full_name>
        <docblock line="983">
          <description><![CDATA[Runs ufter main deltete procedure was done and do postmorten for other parts of extension
wtith priority > 1.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="983" name="return" description="error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/modules/generalInformation.inc" hash="f591c0c33582dcb5498fd59dcda7fdfe" package="modules">
    <docblock line="23">
      <description><![CDATA[Shows general information like the creation time of an account.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="23" name="package" description="modules"/>
      <tag line="23" name="author" description="Roland Gruber"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="35" package="modules">
      <extends>\baseModule</extends>
      <name>generalInformation</name>
      <full_name>\generalInformation</full_name>
      <docblock line="30">
        <description><![CDATA[Shows general information like the creation time of an account.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="30" name="package" description="modules"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="44" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="37">
          <description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="37" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="37" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="65" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="60">
          <description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="60" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="121" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="115">
          <description><![CDATA[Processes user input of the primary module page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="115" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/modules/sambaSamAccount/sambaMungedDial.inc" hash="3705fc3908439bcedb6a3e873febbfc9" package="modules">
    <docblock line="22">
      <description><![CDATA[Manages terminal server settings for Samba 3.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="22" name="package" description="modules"/>
      <tag line="22" name="author" description="Cajus Pollmeier"/>
    </docblock>
    <constant namespace="global" line="32" package="modules">
      <name>SAMBA_MUNGEDDIAL_FILEHEADER</name>
      <full_name>\SAMBA_MUNGEDDIAL_FILEHEADER</full_name>
      <value><![CDATA[((((("20002000200020002000200020002000" . "20002000200020002000200020002000") . "20002000200020002000200020002000") . "20002000200020002000200020002000") . "20002000200020002000200020002000") . "20002000200020002000200020002000") . "5000"]]></value>
      <docblock line="29">
        <description><![CDATA[File header]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="43" package="modules">
      <name>SAMBA_MUNGEDDIAL_FILEHEADER_OLD</name>
      <full_name>\SAMBA_MUNGEDDIAL_FILEHEADER_OLD</full_name>
      <value><![CDATA[((((("6d000800200020002000200020002000" . "20002000200020002000200020002000") . "20002000200020002000200064000100") . "20002000200020002000200020002000") . "20002000200020002000200020002000") . "20002000200020002000200020002000") . "50001000"]]></value>
      <docblock line="40">
        <description><![CDATA[File header for old format.]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <class final="false" abstract="false" namespace="global" line="57" package="modules">
      <extends/>
      <name>sambaMungedDial</name>
      <full_name>\sambaMungedDial</full_name>
      <docblock line="51">
        <description><![CDATA[Manages terminal server settings for Samba 3.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="51" name="author" description="Cajus Pollmeier"/>
        <tag line="51" name="package" description="modules"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="60" namespace="global" package="main">
        <name>$ctx</name>
        <default><![CDATA[array('CtxCfgPresent' => '551e0bb0', 'CtxCfgFlags1' => '00e00010', 'CtxCallback' => '', 'CtxShadow' => '01000000', 'CtxMaxConnectionTime' => '', 'CtxMaxDisconnectionTime' => '', 'CtxMaxIdleTime' => '', 'CtxKeyboardLayout' => '', 'CtxMinEncryptionLevel' => '00', 'CtxWorkDirectory' => '', 'CtxNWLogonServer' => '', 'CtxWFHomeDir' => '', 'CtxWFHomeDirDrive' => '', 'CtxWFProfilePath' => '', 'CtxInitialProgram' => '', 'CtxCallbackNumber' => '')]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="79" namespace="global" package="main">
        <name>$ctxattributes</name>
        <default><![CDATA[array("CtxCfgPresent", "CtxCfgFlags1", "CtxCallback", "CtxShadow", "CtxMaxConnectionTime", "CtxMaxDisconnectionTime", "CtxMaxIdleTime", "CtxKeyboardLayout", "CtxMinEncryptionLevel", "CtxWorkDirectory", "CtxNWLogonServer", "CtxWFHomeDir", "CtxWFHomeDirDrive", "CtxWFProfilePath", "CtxInitialProgram", "CtxCallbackNumber")]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="87" namespace="global" package="main">
        <name>$stringParams</name>
        <default><![CDATA[array("CtxWorkDirectory", "CtxNWLogonServer", "CtxWFHomeDir", "CtxWFHomeDirDrive", "CtxWFProfilePath", "CtxInitialProgram", "CtxCallbackNumber")]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="92" namespace="global" package="main">
        <name>$timeParams</name>
        <default><![CDATA[array("CtxMaxConnectionTime", "CtxMaxDisconnectionTime", "CtxMaxIdleTime")]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="94" namespace="global" package="main">
        <name>$old_behavior</name>
        <default><![CDATA[false]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="97" package="modules">
        <name>strhex</name>
        <full_name>strhex</full_name>
        <docblock line="96">
          <description><![CDATA[strhex]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="97">
          <name>$string</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="109" package="modules">
        <name>hexstr</name>
        <full_name>hexstr</full_name>
        <docblock line="108">
          <description><![CDATA[hexstr]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="109">
          <name>$hex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="121" package="modules">
        <name>endian</name>
        <full_name>endian</full_name>
        <docblock line="120">
          <description><![CDATA[endian]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="121">
          <name>$src</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="127" package="modules">
        <name>genTime</name>
        <full_name>genTime</full_name>
        <docblock line="126">
          <description><![CDATA[genTime]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="127">
          <name>$minutes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="135" package="modules">
        <name>readTime</name>
        <full_name>readTime</full_name>
        <docblock line="134">
          <description><![CDATA[readTime]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="135">
          <name>$time</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="147" package="modules">
        <name>to8bit</name>
        <full_name>to8bit</full_name>
        <docblock line="146">
          <description><![CDATA[to8bit]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="147">
          <name>$string</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="162" package="modules">
        <name>is_samba_path</name>
        <full_name>is_samba_path</full_name>
        <docblock line="161">
          <description><![CDATA[Checks if this is a valid Samba path.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="162">
          <name>$path</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="176" package="modules">
        <name>encode_munged</name>
        <full_name>encode_munged</full_name>
        <docblock line="175">
          <description><![CDATA[Encode full MungedDial-String]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="176">
          <name>$params</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="212" package="modules">
        <name>munge</name>
        <full_name>munge</full_name>
        <docblock line="211">
          <description><![CDATA[Setup parameter given by paramName to MungedDial-Format]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="212">
          <name>$paramName</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="212">
          <name>$paramValue</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="212">
          <name>$isString</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="250" package="modules">
        <name>decode_munged</name>
        <full_name>decode_munged</full_name>
        <docblock line="249">
          <description><![CDATA[Takes a base64-encoded MungedDial-String and returns an array of included parameters and values]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="250">
          <name>$munge</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="305" package="modules">
        <name>load</name>
        <full_name>load</full_name>
        <docblock line="304">
          <description><![CDATA[function takes a base64-encoded sambaMungedDial]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="305">
          <name>$mungedDial</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="311" package="modules">
        <name>getMunged</name>
        <full_name>getMunged</full_name>
        <docblock line="310">
          <description><![CDATA[Returns ready-to-run mungedDialString to be filled into ldap]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="325" package="modules">
        <name>getOnDemandFlags</name>
        <full_name>getOnDemandFlags</full_name>
        <docblock line="324">
          <description><![CDATA[Returns array of flags, which can be set on-demand with activated java-script]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="336" package="modules">
        <name>getTsLogin</name>
        <full_name>getTsLogin</full_name>
        <docblock line="335">
          <description><![CDATA[Gets Terminal-Server-Login value: enabled/disabled]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="350" package="modules">
        <name>setTsLogin</name>
        <full_name>setTsLogin</full_name>
        <docblock line="349">
          <description><![CDATA[Sets Terminal-Server-Login value: enabled/disabled]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="350">
          <name>$checked</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="364" package="modules">
        <name>getBrokenConn</name>
        <full_name>getBrokenConn</full_name>
        <docblock line="363">
          <description><![CDATA[gets Broken-Connection value: disconnect/reset]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="377" package="modules">
        <name>setBrokenConn</name>
        <full_name>setBrokenConn</full_name>
        <docblock line="376">
          <description><![CDATA[sets Broken-Connection value: disconnect/reset]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="377">
          <name>$checked</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="391" package="modules">
        <name>getReConn</name>
        <full_name>getReConn</full_name>
        <docblock line="390">
          <description><![CDATA[gets Reconnection value: from any client/from previous client only]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="404" package="modules">
        <name>setReConn</name>
        <full_name>setReConn</full_name>
        <docblock line="403">
          <description><![CDATA[sets Reconnection value: from any client/from previous client only]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="404">
          <name>$checked</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="418" package="modules">
        <name>getInheritMode</name>
        <full_name>getInheritMode</full_name>
        <docblock line="417">
          <description><![CDATA[gets Inherit-config-from-client value: enabled/disabled]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="430" package="modules">
        <name>setInheritMode</name>
        <full_name>setInheritMode</full_name>
        <docblock line="429">
          <description><![CDATA[sets Inherit-config-from-client value: enabled/disabled]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="430">
          <name>$checked</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="446" package="modules">
        <name>getShadow</name>
        <full_name>getShadow</full_name>
        <docblock line="439">
          <description><![CDATA[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><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="457" package="modules">
        <name>setShadow</name>
        <full_name>setShadow</full_name>
        <docblock line="456">
          <description><![CDATA[sets shadow value]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="457">
          <name>$checked</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="457">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="469" package="modules">
        <name>getConnectClientDrives</name>
        <full_name>getConnectClientDrives</full_name>
        <docblock line="468">
          <description><![CDATA[gets connect-client-drive-at-logon value: enabled/disabled]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="482" package="modules">
        <name>setConnectClientDrives</name>
        <full_name>setConnectClientDrives</full_name>
        <docblock line="481">
          <description><![CDATA[sets connect-client-drive-at-logon value: enabled/disabled]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="482">
          <name>$checked</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="495" package="modules">
        <name>getConnectClientPrinters</name>
        <full_name>getConnectClientPrinters</full_name>
        <docblock line="494">
          <description><![CDATA[gets connect-client-printers-at-logon value: enabled/disabled]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="508" package="modules">
        <name>setConnectClientPrinters</name>
        <full_name>setConnectClientPrinters</full_name>
        <docblock line="507">
          <description><![CDATA[sets connect-client-printers-at-logon value: enabled/disabled]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="508">
          <name>$checked</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="522" package="modules">
        <name>getDefaultPrinter</name>
        <full_name>getDefaultPrinter</full_name>
        <docblock line="521">
          <description><![CDATA[gets set-client-printer-to-default value: enabled/disabled]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="535" package="modules">
        <name>setDefaultPrinter</name>
        <full_name>setDefaultPrinter</full_name>
        <docblock line="534">
          <description><![CDATA[sets set-client-printer-to-default value: enabled/disabled]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="535">
          <name>$checked</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="549" package="modules">
        <name>getCtxMaxConnectionTimeF</name>
        <full_name>getCtxMaxConnectionTimeF</full_name>
        <docblock line="548">
          <description><![CDATA[SMARTY: gets the checkbox state of "Connection"]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="562" package="modules">
        <name>setCtxMaxConnectionTimeF</name>
        <full_name>setCtxMaxConnectionTimeF</full_name>
        <docblock line="561">
          <description><![CDATA[SMARTY: sets the checkbox "Connection" to unchecked]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="562">
          <name>$checked</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="570" package="modules">
        <name>getCtxMaxDisconnectionTimeF</name>
        <full_name>getCtxMaxDisconnectionTimeF</full_name>
        <docblock line="569">
          <description><![CDATA[SMARTY: gets the checkbox state of "Disconnection"]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="583" package="modules">
        <name>setCtxMaxDisconnectionTimeF</name>
        <full_name>setCtxMaxDisconnectionTimeF</full_name>
        <docblock line="582">
          <description><![CDATA[SMARTY: sets the checkbox "Disconnection" to unchecked]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="583">
          <name>$checked</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="591" package="modules">
        <name>getCtxMaxIdleTimeF</name>
        <full_name>getCtxMaxIdleTimeF</full_name>
        <docblock line="590">
          <description><![CDATA[SMARTY: gets the checkbox state of "Idle"]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="604" package="modules">
        <name>setCtxMaxIdleTimeF</name>
        <full_name>setCtxMaxIdleTimeF</full_name>
        <docblock line="603">
          <description><![CDATA[SMARTY: sets the checkbox "Idle" to unchecked]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="604">
          <name>$checked</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <parse_markers>
      <error line="60" code="50018">No DocBlock was found for property $ctx</error>
      <error line="79" code="50018">No DocBlock was found for property $ctxattributes</error>
      <error line="87" code="50018">No DocBlock was found for property $stringParams</error>
      <error line="92" code="50018">No DocBlock was found for property $timeParams</error>
      <error line="94" code="50018">No DocBlock was found for property $old_behavior</error>
      <error line="96" code="50015">Argument $string is missing from the Docblock of strhex()</error>
      <error line="108" code="50015">Argument $hex is missing from the Docblock of hexstr()</error>
      <error line="120" code="50015">Argument $src is missing from the Docblock of endian()</error>
      <error line="126" code="50015">Argument $minutes is missing from the Docblock of genTime()</error>
      <error line="134" code="50015">Argument $time is missing from the Docblock of readTime()</error>
      <error line="146" code="50015">Argument $string is missing from the Docblock of to8bit()</error>
      <error line="161" code="50015">Argument $path is missing from the Docblock of is_samba_path()</error>
      <error line="175" code="50015">Argument $params is missing from the Docblock of encode_munged()</error>
      <error line="211" code="50015">Argument $paramName is missing from the Docblock of munge()</error>
      <error line="211" code="50015">Argument $paramValue is missing from the Docblock of munge()</error>
      <error line="211" code="50015">Argument $isString is missing from the Docblock of munge()</error>
      <error line="249" code="50015">Argument $munge is missing from the Docblock of decode_munged()</error>
      <error line="304" code="50015">Argument $mungedDial is missing from the Docblock of load()</error>
      <error line="349" code="50015">Argument $checked is missing from the Docblock of setTsLogin()</error>
      <error line="376" code="50015">Argument $checked is missing from the Docblock of setBrokenConn()</error>
      <error line="403" code="50015">Argument $checked is missing from the Docblock of setReConn()</error>
      <error line="429" code="50015">Argument $checked is missing from the Docblock of setInheritMode()</error>
      <error line="456" code="50015">Argument $checked is missing from the Docblock of setShadow()</error>
      <error line="456" code="50015">Argument $value is missing from the Docblock of setShadow()</error>
      <error line="481" code="50015">Argument $checked is missing from the Docblock of setConnectClientDrives()</error>
      <error line="507" code="50015">Argument $checked is missing from the Docblock of setConnectClientPrinters()</error>
      <error line="534" code="50015">Argument $checked is missing from the Docblock of setDefaultPrinter()</error>
      <error line="561" code="50015">Argument $checked is missing from the Docblock of setCtxMaxConnectionTimeF()</error>
      <error line="582" code="50015">Argument $checked is missing from the Docblock of setCtxMaxDisconnectionTimeF()</error>
      <error line="603" code="50015">Argument $checked is missing from the Docblock of setCtxMaxIdleTimeF()</error>
    </parse_markers>
  </file>
  <file path="lib/modules/asteriskVoicemail.inc" hash="eb4b8e848006e8ded07bbc6b4f857d5e" package="modules">
    <docblock line="26">
      <description><![CDATA[Manages the Asterisk extension of user accounts.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="26" name="package" description="modules"/>
      <tag line="26" name="author" description="Pavel Pozdnyak"/>
      <tag line="26" name="author" description="Roland Gruber"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="40" package="modules">
      <extends>\baseModule</extends>
      <implements>\passwordService</implements>
      <name>asteriskVoicemail</name>
      <full_name>\asteriskVoicemail</full_name>
      <docblock line="35">
        <description><![CDATA[Manages the Asterisk extension of user accounts.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="35" name="package" description="modules"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="47" package="modules">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="42">
          <description><![CDATA[Creates a new asteriskVoicemail object.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="42" name="param" description="account type (user, group, host)" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="47">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="58" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="53">
          <description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="53" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="198" package="modules">
        <name>load_Messages</name>
        <full_name>load_Messages</full_name>
        <docblock line="195">
          <description><![CDATA[This function fills the error message array with messages]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="223" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="218">
          <description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="218" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="296" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="293">
          <description><![CDATA[Write variables into object and do some regex checks]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="386" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="383">
          <description><![CDATA[Returns a list of PDF entries]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="407" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>build_uploadAccounts</full_name>
        <docblock line="398">
          <description><![CDATA[In this function the LDAP account is built up.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="398" name="param" description="list of hash arrays (name =&gt; value) from user input" type="array" variable="$rawAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="398" name="param" description="list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="398" name="param" description="list of hash arrays (name =&gt; value) which are later added to LDAP" type="array" variable="$partialAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="398" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="398" name="return" description="list of error messages if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="407">
          <name>$rawAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="407">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="407">
          <name>$partialAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="407">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="487" package="modules">
        <name>module_complete</name>
        <full_name>module_complete</full_name>
        <docblock line="482">
          <description><![CDATA[This functions returns true if all needed settings are done.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="482" name="return" description="true if LDAP operation can be done" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="508" package="modules">
        <name>save_attributes</name>
        <full_name>save_attributes</full_name>
        <docblock line="496">
          <description><![CDATA[Returns a list of modifications which have to be made to the LDAP account.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="496" name="return" description="list of modifications &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 may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) &lt;br&gt;&quot;add&quot; are attributes which have to be added to LDAP entry &lt;br&gt;&quot;remove&quot; are attributes which have to be removed from LDAP entry &lt;br&gt;&quot;modify&quot; are attributes which have to been modified in LDAP entry &lt;br&gt;&quot;info&quot; are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="522" package="modules">
        <name>managesPasswordAttributes</name>
        <full_name>managesPasswordAttributes</full_name>
        <docblock line="516">
          <description><![CDATA[This method specifies if a module manages password attributes.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="516" name="see" description="\global\passwordService::managesPasswordAttributes" refers="\global\passwordService::managesPasswordAttributes"/>
          <tag line="516" name="return" description="true if this module manages password attributes" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="534" package="modules">
        <name>supportsForcePasswordChange</name>
        <full_name>supportsForcePasswordChange</full_name>
        <docblock line="529">
          <description><![CDATA[Specifies if this module supports to force that a user must change his password on next login.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="529" name="return" description="force password change supported" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="549" package="modules">
        <name>passwordChangeRequested</name>
        <full_name>passwordChangeRequested</full_name>
        <docblock line="538">
          <description><![CDATA[This function is called whenever the password should be changed.]]></description>
          <long-description><![CDATA[<p>Account modules
must change their password attributes only if the modules list contains their module name.</p>]]></long-description>
          <tag line="538" name="param" description="new password" type="String" variable="$password">
            <type by_reference="false">String</type>
          </tag>
          <tag line="538" name="param" description="list of modules for which the password should be changed" type="\$modules" variable="$modules">
            <type by_reference="false">\$modules</type>
          </tag>
          <tag line="538" name="param" description="force the user to change his password at next login" type="boolean" variable="$forcePasswordChange">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="538" name="return" description="list of error messages if any as parameter array for StatusMessage e.g. return arrray(array('ERROR', 'Password change failed.'))" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="538" name="see" description="\global\passwordService::passwordChangeRequested" refers="\global\passwordService::passwordChangeRequested"/>
        </docblock>
        <argument line="549">
          <name>$password</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="549">
          <name>$modules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="549">
          <name>$forcePasswordChange</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="574" package="modules">
        <name>checkSelfServiceOptions</name>
        <full_name>checkSelfServiceOptions</full_name>
        <docblock line="557">
          <description><![CDATA[Checks if all input values are correct and returns the LDAP attributes which should be changed.]]></description>
          <long-description><![CDATA[<p><br>Return values:
<br>messages: array of parameters to create status messages
<br>add: array of attributes to add
<br>del: array of attributes to remove
<br>mod: array of attributes to modify
<br>info: array of values with informational value (e.g. to be used later by pre/postModify actions)</p>

<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.</p>]]></long-description>
          <tag line="557" name="param" description="input fields" type="string" variable="$fields">
            <type by_reference="false">string</type>
          </tag>
          <tag line="557" name="param" description="LDAP attributes" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="557" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="557" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
            <type by_reference="false">array</type>
          </tag>
          <tag line="557" name="return" description="messages and attributes (array('messages' =&gt; array(), 'add' =&gt; array('mail' =&gt; array('test@test.com')), 'del' =&gt; array(), 'mod' =&gt; array(), 'info' =&gt; array()))" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="574">
          <name>$fields</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="574">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="574">
          <name>$passwordChangeOnly</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="574">
          <name>$readOnlyFields</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="lib/modules/inetLocalMailRecipient.inc" hash="82b354e711be7ce61bac356400191607" package="modules">
    <docblock line="23">
      <description><![CDATA[Provides mail routing for user accounts.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="23" name="package" description="modules"/>
      <tag line="23" name="author" description="Roland Gruber"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="35" package="modules">
      <extends>\baseModule</extends>
      <name>inetLocalMailRecipient</name>
      <full_name>\inetLocalMailRecipient</full_name>
      <docblock line="30">
        <description><![CDATA[Provides mail routing for users.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="30" name="package" description="modules"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="44" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="37">
          <description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="37" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="37" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="122" package="modules">
        <name>load_Messages</name>
        <full_name>load_Messages</full_name>
        <docblock line="119">
          <description><![CDATA[This function fills the error message array with messages]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="136" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="131">
          <description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="131" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="170" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="164">
          <description><![CDATA[Processes user input of the primary module page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="164" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="244" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>build_uploadAccounts</full_name>
        <docblock line="235">
          <description><![CDATA[In this function the LDAP account is built up.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="235" name="param" description="list of hash arrays (name =&gt; value) from user input" type="array" variable="$rawAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="235" name="param" description="list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="235" name="param" description="list of hash arrays (name =&gt; value) which are later added to LDAP" type="array" variable="$partialAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="235" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="235" name="return" description="list of error messages if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="244">
          <name>$rawAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="244">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="244">
          <name>$partialAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="244">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="297" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="292">
          <description><![CDATA[Returns the PDF entries for this module.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="292" name="return" description="list of possible PDF entries" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/modules/imapAccess.inc" hash="a11c0efe1e1e1703081f3995dc285289" package="modules">
    <docblock line="24">
      <description><![CDATA[Manages mailboxes on an IMAP server.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="package" description="modules"/>
      <tag line="24" name="author" description="Pavel Pozdniak"/>
      <tag line="24" name="author" description="Roland Gruber"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="39" package="modules">
      <extends>\baseModule</extends>
      <name>imapAccess</name>
      <full_name>\imapAccess</full_name>
      <docblock line="32">
        <description><![CDATA[Manages mailboxes on an IMAP server.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="32" name="package" description="modules"/>
        <tag line="32" name="author" description="Pavel Pozdniak"/>
        <tag line="32" name="author" description="Roland Gruber"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="42" namespace="global" package="main">
        <name>$profileQuotaLimit</name>
        <default><![CDATA[null]]></default>
        <docblock line="41">
          <description><![CDATA[quota limit from profile]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="51" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="44">
          <description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="44" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="44" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="157" package="modules">
        <name>load_Messages</name>
        <full_name>load_Messages</full_name>
        <docblock line="154">
          <description><![CDATA[This function fills the error message array with messages]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="176" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="171">
          <description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="171" name="return" description="HTML meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="261" package="modules">
        <name>display_html_password</name>
        <full_name>display_html_password</full_name>
        <docblock line="256">
          <description><![CDATA[Returns the HTML meta data for the password page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="256" name="return" description="HTML meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="287" package="modules">
        <name>renderQuotasForMailbox</name>
        <full_name>renderQuotasForMailbox</full_name>
        <docblock line="279">
          <description><![CDATA[Display the mailbox quota.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="279" name="param" description="structure that contained information to be displayed" type="\htmlTable" variable="$htmlTable">
            <type by_reference="false">\htmlTable</type>
          </tag>
          <tag line="279" name="param" description="stream to open IMAP session" type="\stream" variable="$mbox">
            <type by_reference="false">\stream</type>
          </tag>
          <tag line="279" name="param" description="user name to connect to IMAP server" type="String" variable="$username">
            <type by_reference="false">String</type>
          </tag>
          <tag line="279" name="return" description="table with added information about user quotas or controls to add quota" type="\htmlTable">
            <type by_reference="false">\htmlTable</type>
          </tag>
        </docblock>
        <argument line="287">
          <name>$htmlTable</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="287">
          <name>$mbox</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="287">
          <name>$username</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="323" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="317">
          <description><![CDATA[Processes user input of the primary module page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="317" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="433" package="modules">
        <name>load_profile</name>
        <full_name>load_profile</full_name>
        <docblock line="428">
          <description><![CDATA[Loads the values of an account profile into internal variables.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="428" name="param" description="hash array with profile values (identifier =&gt; value)" type="array" variable="$profile">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="433">
          <name>$profile</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="446" package="modules">
        <name>getAdminPassword</name>
        <full_name>getAdminPassword</full_name>
        <docblock line="441">
          <description><![CDATA[Returns the admin password.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="441" name="return" description="password" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="464" package="modules">
        <name>doLogin</name>
        <full_name>doLogin</full_name>
        <docblock line="459">
          <description><![CDATA[Checks the password given by user and save it as session parameter.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="459" name="return" description="list of error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="489" package="modules">
        <name>getServerAddress</name>
        <full_name>getServerAddress</full_name>
        <docblock line="484">
          <description><![CDATA[This function returns the IMAP server address including encryption options.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="484" name="return" description="server address" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="520" package="modules">
        <name>getMailboxPrefix</name>
        <full_name>getMailboxPrefix</full_name>
        <docblock line="514">
          <description><![CDATA[This function returns the prefix for mailboxes.]]></description>
          <long-description><![CDATA[<p>If no prefix was given during configuration then "user" will be used (default for Cyrus).</p>]]></long-description>
          <tag line="514" name="return" description="prefix" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="536" package="modules">
        <name>isWrongDomain</name>
        <full_name>isWrongDomain</full_name>
        <docblock line="529">
          <description><![CDATA[This function checks if the domain of the mailbox is not in the list of domains listed in the configuration.]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="529" name="param" description="email domain" type="String" variable="$email_domain">
            <type by_reference="false">String</type>
          </tag>
          <tag line="529" name="return" description="true if domains match" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="536">
          <name>$email_domain</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="558" package="modules">
        <name>getSep</name>
        <full_name>getSep</full_name>
        <docblock line="553">
          <description><![CDATA[Returns the path separator.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="553" name="return" description="separator char" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/modules/fixed_ip.inc" hash="a1a0644e062bce628f7bdd289ae2d82b" package="modules">
    <docblock line="26">
      <description><![CDATA[Manages fixed IP addresses.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="26" name="package" description="modules"/>
      <tag line="26" name="author" description="Thomas Manninger"/>
      <tag line="26" name="author" description="Roland Gruber"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="41" package="modules">
      <extends>\baseModule</extends>
      <name>fixed_ip</name>
      <full_name>\fixed_ip</full_name>
      <docblock line="35">
        <description><![CDATA[Manages fixed IP addresses.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="35" name="package" description="modules"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="44" namespace="global" package="main">
        <name>$fixed_ip</name>
        <default><![CDATA[]]></default>
        <docblock line="43">
          <description><![CDATA[fixed ips]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="47" namespace="global" package="main">
        <name>$processed</name>
        <default><![CDATA[false]]></default>
        <docblock line="46">
          <description><![CDATA[already processed?]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="50" namespace="global" package="main">
        <name>$overlapd</name>
        <default><![CDATA[]]></default>
        <docblock line="49">
          <description><![CDATA[for check if IPs overlap]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="53" namespace="global" package="main">
        <name>$orig_ips</name>
        <default><![CDATA[array()]]></default>
        <docblock line="52">
          <description><![CDATA[original IPs]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="56" namespace="global" package="main">
        <name>$attributes</name>
        <default><![CDATA[]]></default>
        <docblock line="55">
          <description><![CDATA[LDAP attributes]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="65" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="58">
          <description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="58" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="58" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="105" package="modules">
        <name>load_Messages</name>
        <full_name>load_Messages</full_name>
        <docblock line="102">
          <description><![CDATA[This function fills the error message array with messages.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="114" package="modules">
        <name>getButtonStatus</name>
        <full_name>getButtonStatus</full_name>
        <docblock line="109">
          <description><![CDATA[Controls if the module button the account page is visible and activated.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="109" name="return" description="status (&quot;enabled&quot;, &quot;disabled&quot;, &quot;hidden&quot;)" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="132" package="modules">
        <name>overlapd_ip</name>
        <full_name>overlapd_ip</full_name>
        <docblock line="123">
          <description><![CDATA[Checked, if ips are overlapd.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="123" name="param" description="ip" type="" variable="$ip"/>
          <tag line="123" name="return" description="if overlapd, else true." type="\false,">
            <type by_reference="false">\false,</type>
          </tag>
        </docblock>
        <argument line="132">
          <name>$ip</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="146" package="modules">
        <name>reset_overlapd_ip</name>
        <full_name>reset_overlapd_ip</full_name>
        <docblock line="141">
          <description><![CDATA[Reset the overlapd_range() function]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="157" package="modules">
        <name>check_mac</name>
        <full_name>check_mac</full_name>
        <docblock line="150">
          <description><![CDATA[Check, if a mac address is invalid]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="150" name="param" description="adress" type="\mac" variable="$mac">
            <type by_reference="false">\mac</type>
          </tag>
          <tag line="150" name="return" description="if mac is invalid" type="\true,">
            <type by_reference="false">\true,</type>
          </tag>
        </docblock>
        <argument line="157">
          <name>$mac</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="179" package="modules">
        <name>reload_ips</name>
        <full_name>reload_ips</full_name>
        <docblock line="172">
          <description><![CDATA[Adapt the fixed ip with the subnet.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="172" name="return" description="if ip were edit." type="\true,">
            <type by_reference="false">\true,</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="205" package="modules">
        <name>load_attributes</name>
        <full_name>load_attributes</full_name>
        <docblock line="200">
          <description><![CDATA[This function loads all needed LDAP attributes.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="200" name="param" description="list of attributes" type="array" variable="$attr">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="205">
          <name>$attr</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="231" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="225">
          <description><![CDATA[Processes user input of the primary module page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="225" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="326" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="321">
          <description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="321" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="437" package="modules">
        <name>save_attributes</name>
        <full_name>save_attributes</full_name>
        <docblock line="425">
          <description><![CDATA[Returns a list of modifications which have to be made to the LDAP account.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="425" name="return" description="list of modifications &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 may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) &lt;br&gt;&quot;add&quot; are attributes which have to be added to LDAP entry &lt;br&gt;&quot;remove&quot; are attributes which have to be removed from LDAP entry &lt;br&gt;&quot;modify&quot; are attributes which have to been modified in LDAP entry &lt;br&gt;&quot;info&quot; are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="450" package="modules">
        <name>postModifyActions</name>
        <full_name>postModifyActions</full_name>
        <docblock line="441">
          <description><![CDATA[This function is overwritten because the fixed IPs are set after the ldap_add command.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="441" name="see" description="\global\baseModule::postModifyActions()" refers="\global\baseModule::postModifyActions()"/>
          <tag line="441" name="param" description="" type="boolean" variable="$newAccount">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="441" name="param" description="LDAP attributes of this entry" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="441" name="return" description="array which contains status messages. Each entry is an array containing the status message parameters." type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="450">
          <name>$newAccount</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="450">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="520" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="515">
          <description><![CDATA[Returns the PDF entries for this module.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="515" name="return" description="list of possible PDF entries" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/modules/authorizedServiceObject.inc" hash="6fbebe7dba16b5c1a524b6275b0be83c" package="modules">
    <docblock line="26">
      <description><![CDATA[Provides Authorized Service for accounts.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="26" name="package" description="modules"/>
      <tag line="26" name="author" description="J de Jong"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="38" package="modules">
      <extends>\baseModule</extends>
      <name>authorizedServiceObject</name>
      <full_name>\authorizedServiceObject</full_name>
      <docblock line="33">
        <description><![CDATA[Provides Authorized Service for accounts.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="33" name="package" description="modules"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="45" package="modules">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="40">
          <description><![CDATA[Creates a new authorizedServiceObject object.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="40" name="param" description="account type (user, group, host)" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="45">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="57" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="52">
          <description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="52" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="121" package="modules">
        <name>load_Messages</name>
        <full_name>load_Messages</full_name>
        <docblock line="118">
          <description><![CDATA[This function fills the error message array with messages]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="138" package="modules">
        <name>save_attributes</name>
        <full_name>save_attributes</full_name>
        <docblock line="126">
          <description><![CDATA[Returns a list of modifications which have to be made to the LDAP account.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="126" name="return" description="list of modifications &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 may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) &lt;br&gt;&quot;add&quot; are attributes which have to be added to LDAP entry &lt;br&gt;&quot;remove&quot; are attributes which have to be removed from LDAP entry &lt;br&gt;&quot;modify&quot; are attributes which have to been modified in LDAP entry &lt;br&gt;&quot;info&quot; are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="151" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="146">
          <description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="146" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="208" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="202">
          <description><![CDATA[Processes user input of the primary module page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="202" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="261" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>build_uploadAccounts</full_name>
        <docblock line="252">
          <description><![CDATA[In this function the LDAP account is built up.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="252" name="param" description="list of hash arrays (name =&gt; value) from user input" type="array" variable="$rawAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="252" name="param" description="list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="252" name="param" description="list of hash arrays (name =&gt; value) which are later added to LDAP" type="array" variable="$partialAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="252" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="252" name="return" description="list of error messages if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="261">
          <name>$rawAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="261">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="261">
          <name>$partialAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="261">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="289" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="284">
          <description><![CDATA[Returns the PDF entries for this module.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="284" name="return" description="list of possible PDF entries" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="302" package="modules">
        <name>load_profile</name>
        <full_name>load_profile</full_name>
        <docblock line="297">
          <description><![CDATA[Loads the values of an account profile into internal variables.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="297" name="param" description="hash array with profile values (identifier =&gt; value)" type="array" variable="$profile">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="302">
          <name>$profile</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="lib/modules/windowsGroup.inc" hash="474c9218a68328c640eb0d925af5b9cd" package="modules">
    <docblock line="23">
      <description><![CDATA[Manages Windows AD (e.g.]]></description>
      <long-description><![CDATA[<p>Samba 4) groups.</p>]]></long-description>
      <tag line="23" name="package" description="modules"/>
      <tag line="23" name="author" description="Roland Gruber"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="35" package="modules">
      <extends>\baseModule</extends>
      <name>windowsGroup</name>
      <full_name>\windowsGroup</full_name>
      <docblock line="30">
        <description><![CDATA[Manages Windows AD (e.g.]]></description>
        <long-description><![CDATA[<p>Samba 4) groups.</p>]]></long-description>
        <tag line="30" name="package" description="modules"/>
      </docblock>
      <constant namespace="global" line="43" package="modules">
        <name>TYPE_SECURITY</name>
        <full_name>TYPE_SECURITY</full_name>
        <value><![CDATA['security']]></value>
        <docblock line="42">
          <description><![CDATA[security group]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="global" line="45" package="modules">
        <name>TYPE_DISTRIBUTION</name>
        <full_name>TYPE_DISTRIBUTION</full_name>
        <value><![CDATA['distribution']]></value>
        <docblock line="44">
          <description><![CDATA[email list]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="global" line="47" package="modules">
        <name>SCOPE_DOMAIN_LOCAL</name>
        <full_name>SCOPE_DOMAIN_LOCAL</full_name>
        <value><![CDATA['domain']]></value>
        <docblock line="46">
          <description><![CDATA[domain local group]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="global" line="49" package="modules">
        <name>SCOPE_GLOBAL</name>
        <full_name>SCOPE_GLOBAL</full_name>
        <value><![CDATA['global']]></value>
        <docblock line="48">
          <description><![CDATA[global group]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="global" line="51" package="modules">
        <name>SCOPE_UNIVERSAL</name>
        <full_name>SCOPE_UNIVERSAL</full_name>
        <value><![CDATA['universal']]></value>
        <docblock line="50">
          <description><![CDATA[universal group]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <property final="false" static="false" visibility="private" line="38" namespace="global" package="main">
        <name>$groupTypes</name>
        <default><![CDATA[]]></default>
        <docblock line="37">
          <description><![CDATA[possible group types (e.g.]]></description>
          <long-description><![CDATA[<p>distribution)</p>]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="40" namespace="global" package="main">
        <name>$groupScopes</name>
        <default><![CDATA[]]></default>
        <docblock line="39">
          <description><![CDATA[possible group scopes (e.g.]]></description>
          <long-description><![CDATA[<p>universal)</p>]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="58" package="modules">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="53">
          <description><![CDATA[Creates a new module for Samba 3 groups.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="53" name="param" description="account type" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="58">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="79" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="72">
          <description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="72" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="72" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="239" package="modules">
        <name>load_Messages</name>
        <full_name>load_Messages</full_name>
        <docblock line="236">
          <description><![CDATA[This function fills the $messages variable with output messages from this module.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="255" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="250">
          <description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="250" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="342" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="336">
          <description><![CDATA[Processes user input of the primary module page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="336" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="389" package="modules">
        <name>display_html_user</name>
        <full_name>display_html_user</full_name>
        <docblock line="384">
          <description><![CDATA[This function will create the meta HTML code to show a page to change the member attribute.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="384" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="476" package="modules">
        <name>process_user</name>
        <full_name>process_user</full_name>
        <docblock line="470">
          <description><![CDATA[Processes user input of the members page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="470" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="513" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>build_uploadAccounts</full_name>
        <docblock line="504">
          <description><![CDATA[In this function the LDAP account is built up.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="504" name="param" description="list of hash arrays (name =&gt; value) from user input" type="array" variable="$rawAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="504" name="param" description="list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="504" name="param" description="list of hash arrays (name =&gt; value) which are later added to LDAP" type="array" variable="$partialAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="504" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="504" name="return" description="list of error messages if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="513">
          <name>$rawAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="513">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="513">
          <name>$partialAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="513">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="613" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="610">
          <description><![CDATA[Returns a list of PDF entries]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/modules/nisMailAlias.inc" hash="badb27f599275f53195926fefa9023ac" package="modules">
    <docblock line="23">
      <description><![CDATA[Provides NIS mail alias management.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="23" name="package" description="modules"/>
      <tag line="23" name="author" description="Roland Gruber"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="35" package="modules">
      <extends>\baseModule</extends>
      <name>nisMailAlias</name>
      <full_name>\nisMailAlias</full_name>
      <docblock line="30">
        <description><![CDATA[Provides NIS mail alias management.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="30" name="package" description="modules"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="38" namespace="global" package="main">
        <name>$cachedMailList</name>
        <default><![CDATA[null]]></default>
        <docblock line="37">
          <description><![CDATA[mail cache]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="47" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="40">
          <description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="40" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="40" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="113" package="modules">
        <name>load_Messages</name>
        <full_name>load_Messages</full_name>
        <docblock line="110">
          <description><![CDATA[This function fills the error message array with messages]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="132" package="modules">
        <name>save_attributes</name>
        <full_name>save_attributes</full_name>
        <docblock line="120">
          <description><![CDATA[Returns a list of modifications which have to be made to the LDAP account.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="120" name="return" description="list of modifications &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 may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) &lt;br&gt;&quot;add&quot; are attributes which have to be added to LDAP entry &lt;br&gt;&quot;remove&quot; are attributes which have to be removed from LDAP entry &lt;br&gt;&quot;modify&quot; are attributes which have to been modified in LDAP entry &lt;br&gt;&quot;info&quot; are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="145" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="140">
          <description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="140" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="199" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="193">
          <description><![CDATA[Processes user input of the primary module page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="193" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="249" package="modules">
        <name>display_html_select</name>
        <full_name>display_html_select</full_name>
        <docblock line="244">
          <description><![CDATA[Displays the host/user selection.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="244" name="return" description="meta HTML code" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="297" package="modules">
        <name>process_select</name>
        <full_name>process_select</full_name>
        <docblock line="291">
          <description><![CDATA[Processes user input of the host/user selection page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="291" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="316" package="modules">
        <name>getButtonStatus</name>
        <full_name>getButtonStatus</full_name>
        <docblock line="311">
          <description><![CDATA[Controls if the module button the account page is visible and activated.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="311" name="return" description="status (&quot;enabled&quot;, &quot;disabled&quot;, &quot;hidden&quot;)" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="336" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>build_uploadAccounts</full_name>
        <docblock line="327">
          <description><![CDATA[In this function the LDAP account is built up.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="327" name="param" description="list of hash arrays (name =&gt; value) from user input" type="array" variable="$rawAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="327" name="param" description="list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="327" name="param" description="list of hash arrays (name =&gt; value) which are later added to LDAP" type="array" variable="$partialAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="327" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="327" name="return" description="list of error messages if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="336">
          <name>$rawAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="336">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="336">
          <name>$partialAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="336">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="375" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="370">
          <description><![CDATA[Returns the PDF entries for this module.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="370" name="return" description="list of possible PDF entries" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="387" package="modules">
        <name>getMailList</name>
        <full_name>getMailList</full_name>
        <docblock line="382">
          <description><![CDATA[Returns a list of existing email addresses.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="382" name="return" description="email addresses" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/modules/hostObject.inc" hash="083f59c9ea1de48c9401d778b875207a" package="modules">
    <docblock line="23">
      <description><![CDATA[Manages the hosts to which a user may login.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="23" name="package" description="modules"/>
      <tag line="23" name="author" description="Roland Gruber"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="35" package="modules">
      <extends>\baseModule</extends>
      <name>hostObject</name>
      <full_name>\hostObject</full_name>
      <docblock line="30">
        <description><![CDATA[Manages the hosts to which a user may login.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="30" name="package" description="modules"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="42" package="modules">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="37">
          <description><![CDATA[Creates a new hostObject object.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="37" name="param" description="account type (user, group, host)" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="42">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="55" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="48">
          <description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="48" name="return" description="array with meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="48" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="102" package="modules">
        <name>load_Messages</name>
        <full_name>load_Messages</full_name>
        <docblock line="99">
          <description><![CDATA[This function fills the error message array with messages]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="119" package="modules">
        <name>save_attributes</name>
        <full_name>save_attributes</full_name>
        <docblock line="107">
          <description><![CDATA[Returns a list of modifications which have to be made to the LDAP account.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="107" name="return" description="list of modifications &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 may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) &lt;br&gt;&quot;add&quot; are attributes which have to be added to LDAP entry &lt;br&gt;&quot;remove&quot; are attributes which have to be removed from LDAP entry &lt;br&gt;&quot;modify&quot; are attributes which have to been modified in LDAP entry &lt;br&gt;&quot;info&quot; are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="132" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="127">
          <description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="127" name="return" description="HTML meta data" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="173" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="167">
          <description><![CDATA[Processes user input of the primary module page.]]></description>
          <long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
          <tag line="167" name="return" description="list of info/error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="224" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>build_uploadAccounts</full_name>
        <docblock line="215">
          <description><![CDATA[In this function the LDAP account is built up.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="215" name="param" description="list of hash arrays (name =&gt; value) from user input" type="array" variable="$rawAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="215" name="param" description="list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="215" name="param" description="list of hash arrays (name =&gt; value) which are later added to LDAP" type="array" variable="$partialAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="215" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="215" name="return" description="list of error messages if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="224">
          <name>$rawAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="224">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="224">
          <name>$partialAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="224">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="253" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="248">
          <description><![CDATA[Returns the PDF entries for this module.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="248" name="return" description="list of possible PDF entries" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="264" package="modules">
        <name>load_profile</name>
        <full_name>load_profile</full_name>
        <docblock line="259">
          <description><![CDATA[Loads the values of an account profile into internal variables.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="259" name="param" description="hash array with profile values (identifier =&gt; value)" type="array" variable="$profile">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="264">
          <name>$profile</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="lib/xml_parser.inc" hash="92aee2c4a0e0305cf0862c2389ce0a6f" package="PDF">
    <docblock line="23">
      <description><![CDATA[Simple XML parser.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="23" name="author" description="Michael Duergner"/>
      <tag line="23" name="package" description="PDF"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="36" package="PDF">
      <extends/>
      <name>xmlParser</name>
      <full_name>\xmlParser</full_name>
      <docblock line="30">
        <description><![CDATA[Simple XML parser.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="30" name="author" description="Michael Duergner"/>
        <tag line="30" name="package" description="PDF"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="39" namespace="global" package="main">
        <name>$xmlParser</name>
        <default><![CDATA[]]></default>
        <docblock line="38">
          <description><![CDATA[XML parser]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="44" package="PDF">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="41">
          <description><![CDATA[Constructor]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="57" package="PDF">
        <name>parse</name>
        <full_name>parse</full_name>
        <docblock line="51">
          <description><![CDATA[Starts the parsing.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="51" name="param" description="file name" type="String" variable="$filename">
            <type by_reference="false">String</type>
          </tag>
          <tag line="51" name="return" description="XML structure" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="57">
          <name>$filename</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="lib/baseType.inc" hash="69ce5e350b3bc35ee96baa70e7c285f0" package="types">
    <docblock line="24">
      <description><![CDATA[This is the parent class of all account types.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="package" description="types"/>
      <tag line="24" name="author" description="Roland Gruber"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="36" package="types">
      <extends/>
      <name>baseType</name>
      <full_name>\baseType</full_name>
      <docblock line="31">
        <description><![CDATA[This is the parent class of all account types.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="31" name="package" description="types"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="39" namespace="global" package="main">
        <name>$LABEL_CREATE_ANOTHER_ACCOUNT</name>
        <default><![CDATA[]]></default>
        <docblock line="38">
          <description><![CDATA[label to create another account]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="41" namespace="global" package="main">
        <name>$LABEL_BACK_TO_ACCOUNT_LIST</name>
        <default><![CDATA[]]></default>
        <docblock line="40">
          <description><![CDATA[label to return to account list]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="46" package="types">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="43">
          <description><![CDATA[Creates a new type object.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="57" package="types">
        <name>getAlias</name>
        <full_name>getAlias</full_name>
        <docblock line="51">
          <description><![CDATA[Returns the alias name of this account type.]]></description>
          <long-description><![CDATA[<p>This function must be overwritten by the child classes.</p>]]></long-description>
          <tag line="51" name="return" description="alias name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="67" package="types">
        <name>getDescription</name>
        <full_name>getDescription</full_name>
        <docblock line="61">
          <description><![CDATA[Returns the description of this account type.]]></description>
          <long-description><![CDATA[<p>This function must be overwritten by the child classes.</p>]]></long-description>
          <tag line="61" name="return" description="description" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="76" package="types">
        <name>getListClassName</name>
        <full_name>getListClassName</full_name>
        <docblock line="71">
          <description><![CDATA[Returns the class name for the list object.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="71" name="return" description="class name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="86" package="types">
        <name>getDefaultListAttributes</name>
        <full_name>getDefaultListAttributes</full_name>
        <docblock line="80">
          <description><![CDATA[Returns the default attribute list for this account type.]]></description>
          <long-description><![CDATA[<p>This function must be overwritten by the child classes.</p>]]></long-description>
          <tag line="80" name="return" description="attribute list" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="96" package="types">
        <name>getListAttributeDescriptions</name>
        <full_name>getListAttributeDescriptions</full_name>
        <docblock line="90">
          <description><![CDATA[Returns a list of attributes which have a translated description.]]></description>
          <long-description><![CDATA[<p>This is used for the head row in the list view.</p>]]></long-description>
          <tag line="90" name="return" description="list of descriptions" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="105" package="types">
        <name>supportsFileUpload</name>
        <full_name>supportsFileUpload</full_name>
        <docblock line="100">
          <description><![CDATA[Returns if entries of this type may be created via file upload.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="100" name="return" description="true, if file upload is supported" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="115" package="types">
        <name>getTitleBarTitle</name>
        <full_name>getTitleBarTitle</full_name>
        <docblock line="109">
          <description><![CDATA[Returns the the title text for the title bar on the new/edit page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="109" name="param" description="account container" type="\accountContainer" variable="$container">
            <type by_reference="false">\accountContainer</type>
          </tag>
          <tag line="109" name="return" description="title text" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="115">
          <name>$container</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="128" package="types">
        <name>getTitleBarSubtitle</name>
        <full_name>getTitleBarSubtitle</full_name>
        <docblock line="122">
          <description><![CDATA[Returns the the title text for the title bar on the new/edit page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="122" name="param" description="account container" type="\accountContainer" variable="$container">
            <type by_reference="false">\accountContainer</type>
          </tag>
          <tag line="122" name="return" description="title text" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="128">
          <name>$container</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="137" package="types">
        <name>getSuffixList</name>
        <full_name>getSuffixList</full_name>
        <docblock line="132">
          <description><![CDATA[Returns a list of LDAP suffixes for this type.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="132" name="return" description="sorted list of possible suffixes for this type." type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="178" package="types">
        <name>runEditPagePostAction</name>
        <full_name>runEditPagePostAction</full_name>
        <docblock line="172">
          <description><![CDATA[This function is called after the edit page is processed and before the page content is generated.]]></description>
          <long-description><![CDATA[<p>This can be used to run custom handlers after each page processing.</p>]]></long-description>
          <tag line="172" name="param" description="account container" type="\accountContainer" variable="$container">
            <type by_reference="false">\accountContainer</type>
          </tag>
        </docblock>
        <argument line="178">
          <name>$container</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="lib/checkEnvironment.inc" hash="886ee872f8e9cc8e2ea97c5398575397" package="main">
    <docblock line="24">
      <description><![CDATA[Checks if the environment fits to run LAM.]]></description>
      <long-description><![CDATA[<p>This code checks if the PHP version is ok, the required extensions are active
and the memory limit is high enough.</p>]]></long-description>
      <tag line="24" name="author" description="Roland Gruber"/>
      <tag line="24" name="package" description="main"/>
    </docblock>
    <include line="34" type="Include Once" package="main">
      <name>../lib/status.inc</name>
      <docblock line="33">
        <description><![CDATA[status messages]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="37" type="Include Once" package="main">
      <name>../lib/config.inc</name>
      <docblock line="36">
        <description><![CDATA[config]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="lib/pdfstruct.inc" hash="217f55914436874c1778b21f658ed9aa" package="PDF">
    <docblock line="24">
      <description><![CDATA[Functions to manage the PDF structures.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="author" description="Michael Duergner"/>
      <tag line="24" name="package" description="PDF"/>
    </docblock>
    <include line="32" type="Include Once" package="main">
      <name>config.inc</name>
      <docblock line="31">
        <description><![CDATA[LAM configuration]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="35" type="Include Once" package="main">
      <name>ldap.inc</name>
      <docblock line="34">
        <description><![CDATA[LDAP object]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <function namespace="global" line="49" package="PDF">
      <name>getPDFStructureDefinitions</name>
      <full_name>\getPDFStructureDefinitions</full_name>
      <docblock line="37">
        <description><![CDATA[This function will return all available PDF structure definitions for the submitted
account scope.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="37" name="param" description="The account scope the PDF structure definitions should be returned." type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="37" name="param" description="server profile name" type="string" variable="$profile">
          <type by_reference="false">string</type>
        </tag>
        <tag line="37" name="return" description="$scope All available PDF structure definitions for the submitted account scope. Each entry is a string being the filename that may be passed to the createModulePDF() function as second argument." type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="49">
        <name>$scope</name>
        <default><![CDATA["user"]]></default>
        <type/>
      </argument>
      <argument line="49">
        <name>$profile</name>
        <default><![CDATA[null]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="78" package="PDF">
      <name>loadPDFStructureDefinitions</name>
      <full_name>\loadPDFStructureDefinitions</full_name>
      <docblock line="69">
        <description><![CDATA[This function is used to get pdf structure from xml file.]]></description>
        <long-description><![CDATA[<p>Used in createModulePDF.</p>]]></long-description>
        <tag line="69" name="param" description="The account scope for wich the PDF structure should be returned." type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="69" name="param" description="Structure name of selected scope wich should be returned." type="string" variable="$pdf_structure">
          <type by_reference="false">string</type>
        </tag>
        <tag line="69" name="return" description="PDF structure" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="78">
        <name>$scope</name>
        <default><![CDATA['user']]></default>
        <type/>
      </argument>
      <argument line="78">
        <name>$pdf_structure</name>
        <default><![CDATA['default']]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="106" package="PDF">
      <name>savePDFStructureDefinitions</name>
      <full_name>\savePDFStructureDefinitions</full_name>
      <docblock line="99">
        <description><![CDATA[Saves PDF structure definitions to XML file in format: <name>.<scope>.xml]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="99" name="param" description="account type" type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="99" name="param" description="Name of definition" type="string" variable="$definition">
          <type by_reference="false">string</type>
        </tag>
        <tag line="99" name="return" description="&quot;no perms&quot; if access denied or &quot;ok&quot;." type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="106">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="106">
        <name>$definition</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="164" package="PDF">
      <name>deletePDFStructureDefinition</name>
      <full_name>\deletePDFStructureDefinition</full_name>
      <docblock line="156">
        <description><![CDATA[Deletes XML file with PDF structure definitions.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="156" name="param" description="account type" type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="156" name="param" description="Name of definition to delete" type="string" variable="$definition">
          <type by_reference="false">string</type>
        </tag>
        <tag line="156" name="return" description="True if file was deleted or false if a problem occured." type="boolean">
          <type by_reference="false">boolean</type>
        </tag>
      </docblock>
      <argument line="164">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="164">
        <name>$definition</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="182" package="PDF">
      <name>getAvailableLogos</name>
      <full_name>\getAvailableLogos</full_name>
      <docblock line="177">
        <description><![CDATA[This function returns an array with all aviliable logo images.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="177" name="return" description="list of logo files" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
    </function>
    <function namespace="global" line="208" package="PDF">
      <name>copyPdfProfiles</name>
      <full_name>\copyPdfProfiles</full_name>
      <docblock line="199">
        <description><![CDATA[Copies PDF profiles to other server profiles.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="199" name="param" description="PDF profile names" type="array" variable="$pdfProfiles">
          <type by_reference="false">array</type>
        </tag>
        <tag line="199" name="param" description="account scope" type="String" variable="$scope">
          <type by_reference="false">String</type>
        </tag>
        <tag line="199" name="param" description="destinations" type="array" variable="$dests">
          <type by_reference="false">array</type>
        </tag>
        <tag line="199" name="return" description="operation succeeded" type="boolean">
          <type by_reference="false">boolean</type>
        </tag>
      </docblock>
      <argument line="208">
        <name>$pdfProfiles</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="208">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="208">
        <name>$dests</name>
        <default><![CDATA[array()]]></default>
        <type/>
      </argument>
    </function>
  </file>
  <file path="lib/lists.inc" hash="40f71c66da243d3297b9f3af4846fa30" package="lists">
    <docblock line="25">
      <description><![CDATA[This file includes functions to manage the list views.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="25" name="package" description="lists"/>
      <tag line="25" name="author" description="Roland Gruber"/>
    </docblock>
    <include line="33" type="Include Once" package="main">
      <name>types.inc</name>
      <docblock line="32">
        <description><![CDATA[Used to get type information.]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="35" type="Include Once" package="main">
      <name>pdfstruct.inc</name>
      <docblock line="34">
        <description><![CDATA[Used to get PDF information.]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="37" type="Include Once" package="main">
      <name>pdf.inc</name>
      <docblock line="36">
        <description><![CDATA[Used to create PDF files.]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="809" type="Include" package="main">
      <name>../main_header.php</name>
    </include>
    <include line="828" type="Include" package="main">
      <name>../main_footer.php</name>
    </include>
    <class final="false" abstract="false" namespace="global" line="47" package="lists">
      <extends/>
      <name>lamList</name>
      <full_name>\lamList</full_name>
      <docblock line="40">
        <description><![CDATA[Generates the list view.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="40" name="package" description="lists"/>
        <tag line="40" name="author" description="Roland Gruber"/>
      </docblock>
      <constant namespace="global" line="98" package="lists">
        <name>LIST_SIZE_OPTION_NAME</name>
        <full_name>LIST_SIZE_OPTION_NAME</full_name>
        <value><![CDATA["L_SIZE"]]></value>
        <docblock line="97">
          <description><![CDATA[ID for list size config option]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="global" line="101" package="lists">
        <name>VIRTUAL_ATTRIBUTE_PREFIX</name>
        <full_name>VIRTUAL_ATTRIBUTE_PREFIX</full_name>
        <value><![CDATA['lam_virtual_']]></value>
        <docblock line="100">
          <description><![CDATA[prefix for virtual (non-LDAP) attributes]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <property final="false" static="false" visibility="protected" line="50" namespace="global" package="main">
        <name>$type</name>
        <default><![CDATA[]]></default>
        <docblock line="49">
          <description><![CDATA[Account type]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="53" namespace="global" package="main">
        <name>$page</name>
        <default><![CDATA[1]]></default>
        <docblock line="52">
          <description><![CDATA[current page number]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="56" namespace="global" package="main">
        <name>$attrArray</name>
        <default><![CDATA[array()]]></default>
        <docblock line="55">
          <description><![CDATA[list of LDAP attributes]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="59" namespace="global" package="main">
        <name>$descArray</name>
        <default><![CDATA[array()]]></default>
        <docblock line="58">
          <description><![CDATA[list of attribute descriptions]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="62" namespace="global" package="main">
        <name>$maxPageEntries</name>
        <default><![CDATA[30]]></default>
        <docblock line="61">
          <description><![CDATA[maximum count of entries per page]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="65" namespace="global" package="main">
        <name>$sortColumn</name>
        <default><![CDATA[]]></default>
        <docblock line="64">
          <description><![CDATA[sort column name]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="68" namespace="global" package="main">
        <name>$sortDirection</name>
        <default><![CDATA[1]]></default>
        <docblock line="67">
          <description><![CDATA[sort direction: 1 for ascending, -1 for descending]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="71" namespace="global" package="main">
        <name>$suffix</name>
        <default><![CDATA[]]></default>
        <docblock line="70">
          <description><![CDATA[LDAP suffix]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="74" namespace="global" package="main">
        <name>$refresh</name>
        <default><![CDATA[true]]></default>
        <docblock line="73">
          <description><![CDATA[refresh page switch]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="77" namespace="global" package="main">
        <name>$entries</name>
        <default><![CDATA[]]></default>
        <docblock line="76">
          <description><![CDATA[LDAP entries]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="80" namespace="global" package="main">
        <name>$sortMapping</name>
        <default><![CDATA[]]></default>
        <docblock line="79">
          <description><![CDATA[sort mapping for entries array(original index => sorted index)]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="83" namespace="global" package="main">
        <name>$filters</name>
        <default><![CDATA[array()]]></default>
        <docblock line="82">
          <description><![CDATA[list of filters (attribute name => filter input)]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="86" namespace="global" package="main">
        <name>$possibleSuffixes</name>
        <default><![CDATA[]]></default>
        <docblock line="85">
          <description><![CDATA[list of possible LDAP suffixes(organizational units)]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="89" namespace="global" package="main">
        <name>$labels</name>
        <default><![CDATA[]]></default>
        <docblock line="88">
          <description><![CDATA[list of account specific labels]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="92" namespace="global" package="main">
        <name>$configOptions</name>
        <default><![CDATA[]]></default>
        <docblock line="91">
          <description><![CDATA[configuration options]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="95" namespace="global" package="main">
        <name>$tabindex</name>
        <default><![CDATA[1]]></default>
        <docblock line="94">
          <description><![CDATA[tabindex for GUI elements]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="109" package="lists">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="103">
          <description><![CDATA[Constructor]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="103" name="param" description="account type" type="string" variable="$type">
            <type by_reference="false">string</type>
          </tag>
          <tag line="103" name="return" description="list object" type="\lamList">
            <type by_reference="false">\lamList</type>
          </tag>
        </docblock>
        <argument line="109">
          <name>$type</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="123" package="lists">
        <name>listReadOptionsFromCookie</name>
        <full_name>listReadOptionsFromCookie</full_name>
        <docblock line="120">
          <description><![CDATA[Reads the list options from the cookie value.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="149" package="lists">
        <name>showPage</name>
        <full_name>showPage</full_name>
        <docblock line="146">
          <description><![CDATA[Prints the HTML code to display the list view.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="208" package="lists">
        <name>listBuildFilter</name>
        <full_name>listBuildFilter</full_name>
        <docblock line="205">
          <description><![CDATA[Builds the regular expressions from the filter values.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="242" package="lists">
        <name>listCreateSortMapping</name>
        <full_name>listCreateSortMapping</full_name>
        <docblock line="236">
          <description><![CDATA[Determines the sort mapping and stores it in $this->sortMapping.]]></description>
          <long-description><![CDATA[<p>The sort mapping is used to display the right rows when the account table is created.</p>]]></long-description>
          <tag line="236" name="param" description="the account list" type="array" variable="$info">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="242">
          <name>$info</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="281" package="lists">
        <name>listDrawNavigationBar</name>
        <full_name>listDrawNavigationBar</full_name>
        <docblock line="276">
          <description><![CDATA[Draws a navigation bar to switch between pages]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="276" name="param" description="number of account entries" type="integer" variable="$count">
            <type by_reference="false">integer</type>
          </tag>
        </docblock>
        <argument line="281">
          <name>$count</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="336" package="lists">
        <name>getFilterAsTextForURL</name>
        <full_name>getFilterAsTextForURL</full_name>
        <docblock line="331">
          <description><![CDATA[Returns the filter as text to be used as URL parameter.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="331" name="return" description="filter text" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="347" package="lists">
        <name>listPrintTableHeader</name>
        <full_name>listPrintTableHeader</full_name>
        <docblock line="344">
          <description><![CDATA[Prints the attribute and filter row at the account table head]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="415" package="lists">
        <name>canBeFiltered</name>
        <full_name>canBeFiltered</full_name>
        <docblock line="407">
          <description><![CDATA[Returns if the given attribute can be filtered.]]></description>
          <long-description><![CDATA[<p>If filtering is not possible then no filter box will be displayed.
By default all attributes can be filtered.</p>]]></long-description>
          <tag line="407" name="param" description="attribute name" type="String" variable="$attr">
            <type by_reference="false">String</type>
          </tag>
          <tag line="407" name="return" description="filtering possible" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="415">
          <name>$attr</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="424" package="lists">
        <name>listPrintTableBody</name>
        <full_name>listPrintTableBody</full_name>
        <docblock line="419">
          <description><![CDATA[Prints the entry list]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="419" name="param" description="entries" type="array" variable="$info">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="424">
          <name>$info</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="480" package="lists">
        <name>listPrintToolLinks</name>
        <full_name>listPrintToolLinks</full_name>
        <docblock line="474">
          <description><![CDATA[Prints the tool image links (e.g.]]></description>
          <long-description><![CDATA[<p>edit and delete) for each account.</p>]]></long-description>
          <tag line="474" name="param" description="LDAP attributes" type="array" variable="$account">
            <type by_reference="false">array</type>
          </tag>
          <tag line="474" name="param" description="account ID" type="String" variable="$id">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="480">
          <name>$account</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="480">
          <name>$id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="520" package="lists">
        <name>listPrintTableCellContent</name>
        <full_name>listPrintTableCellContent</full_name>
        <docblock line="514">
          <description><![CDATA[Prints the content of a cell in the account list for a given LDAP entry and attribute.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="514" name="param" description="LDAP attributes" type="array" variable="$entry">
            <type by_reference="false">array</type>
          </tag>
          <tag line="514" name="param" description="attribute name" type="string" variable="$attribute">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="520">
          <name>$entry</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="520">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="539" package="lists">
        <name>listDoPost</name>
        <full_name>listDoPost</full_name>
        <docblock line="534">
          <description><![CDATA[Manages all POST actions (e.g.]]></description>
          <long-description><![CDATA[<p>button pressed) for the account lists.</p>]]></long-description>
          <tag line="534" name="return" description="HTML fragment to insert into beginning of account list" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="657" package="lists">
        <name>showPDFPage</name>
        <full_name>showPDFPage</full_name>
        <docblock line="652">
          <description><![CDATA[Shows the page where the user may select the PDF options.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="652" name="param" description="account ID" type="String" variable="$id">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="657">
          <name>$id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="722" package="lists">
        <name>listShowOUSelection</name>
        <full_name>listShowOUSelection</full_name>
        <docblock line="717">
          <description><![CDATA[Prints a combobox with possible sub-DNs.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="717" name="return" description="OU selection (may be empty)" type="\htmlGroup">
            <type by_reference="false">\htmlGroup</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="746" package="lists">
        <name>listPrintButtons</name>
        <full_name>listPrintButtons</full_name>
        <docblock line="740">
          <description><![CDATA[Prints the create and delete buttons.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="740" name="param" description="true if only the create button should be displayed" type="boolean" variable="$createOnly">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="740" name="param" description="HTML tabindex counter" type="int" variable="$tabindex">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
        <argument line="746">
          <name>$createOnly</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="801" package="lists">
        <name>addExtraInputElementsToTopArea</name>
        <full_name>addExtraInputElementsToTopArea</full_name>
        <docblock line="795">
          <description><![CDATA[Can be used by subclasses to add e.g.]]></description>
          <long-description><![CDATA[<p>additional buttons to the top area.</p>]]></long-description>
          <tag line="795" name="param" description="left part" type="\htmlGroup" variable="$left">
            <type by_reference="false">\htmlGroup</type>
          </tag>
          <tag line="795" name="param" description="right part" type="\htmlGroup" variable="$right">
            <type by_reference="false">\htmlGroup</type>
          </tag>
        </docblock>
        <argument line="801">
          <name>$left</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="801">
          <name>$right</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="808" package="lists">
        <name>listPrintHeader</name>
        <full_name>listPrintHeader</full_name>
        <docblock line="805">
          <description><![CDATA[Prints the HTML header.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="815" package="lists">
        <name>listPrintFooter</name>
        <full_name>listPrintFooter</full_name>
        <docblock line="812">
          <description><![CDATA[Prints the HTML footer.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="837" package="lists">
        <name>listGetAttributeDescriptionList</name>
        <full_name>listGetAttributeDescriptionList</full_name>
        <docblock line="831">
          <description><![CDATA[Returns an hash array containing with all attributes to be shown and their descriptions.]]></description>
          <long-description><![CDATA[<p>Format: array(attribute => description)</p>]]></long-description>
          <tag line="831" name="return" description="attribute list" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="871" package="lists">
        <name>listGetParams</name>
        <full_name>listGetParams</full_name>
        <docblock line="868">
          <description><![CDATA[Sets some internal parameters.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="921" package="lists">
        <name>listRefreshData</name>
        <full_name>listRefreshData</full_name>
        <docblock line="918">
          <description><![CDATA[Rereads the entries from LDAP.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="959" package="lists">
        <name>buildLDAPAttributeFilter</name>
        <full_name>buildLDAPAttributeFilter</full_name>
        <docblock line="954">
          <description><![CDATA[Builds the LDAP filter based on the filter entries in the GUI.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="954" name="return" description="LDAP filter" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="971" package="lists">
        <name>forceRefresh</name>
        <full_name>forceRefresh</full_name>
        <docblock line="967">
          <description><![CDATA[Forces a refresh of the LDAP data.]]></description>
          <long-description><![CDATA[<p>Function must be called before $this->refresh option is checked to load new LDAP data (e.g. in listGetParams).</p>]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="984" package="lists">
        <name>getAdditionalLDAPAttributesToRead</name>
        <full_name>getAdditionalLDAPAttributesToRead</full_name>
        <docblock line="978">
          <description><![CDATA[Returns a list of additional LDAP attributes that should be read.]]></description>
          <long-description><![CDATA[<p>This can be used to show additional data even if the user selected other attributes to show in the list.</p>]]></long-description>
          <tag line="978" name="return" description="additional attribute names" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="993" package="lists">
        <name>getAdditionalTools</name>
        <full_name>getAdditionalTools</full_name>
        <docblock line="988">
          <description><![CDATA[Returns a list of lamListTool objects to display next to the edit/delete buttons.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="988" name="return" description="tools" type="\lamListTool[]">
            <type by_reference="false">\lamListTool[]</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1002" package="lists">
        <name>listGetAllConfigOptions</name>
        <full_name>listGetAllConfigOptions</full_name>
        <docblock line="997">
          <description><![CDATA[Returns a list of possible configuration options.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="997" name="return" description="list of lamListOption objects" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1012" package="lists">
        <name>listPrintConfigurationPage</name>
        <full_name>listPrintConfigurationPage</full_name>
        <docblock line="1009">
          <description><![CDATA[Prints the list configuration page.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1035" package="lists">
        <name>listGetConfigOptionByID</name>
        <full_name>listGetConfigOptionByID</full_name>
        <docblock line="1030">
          <description><![CDATA[Returns the configuration option with the given ID.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1030" name="param" description="ID" type="String" variable="$ID">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1035">
          <name>$ID</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1047" package="lists">
        <name>listConfigurationChanged</name>
        <full_name>listConfigurationChanged</full_name>
        <docblock line="1044">
          <description><![CDATA[Called when the configuration options changed.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1058" package="lists">
        <name>listPrintRedirectMessages</name>
        <full_name>listPrintRedirectMessages</full_name>
        <docblock line="1055">
          <description><![CDATA[Prints messages when another page (e.g.]]></description>
          <long-description><![CDATA[<p>delete/upload) redirects to the list view.</p>]]></long-description>
        </docblock>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="1084" package="lists">
      <extends/>
      <name>lamListTool</name>
      <full_name>\lamListTool</full_name>
      <docblock line="1078">
        <description><![CDATA[Represents a tool which can be included in the account lists.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="1078" name="package" description="lists"/>
        <tag line="1078" name="author" description="Roland Gruber"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="1087" namespace="global" package="main">
        <name>$name</name>
        <default><![CDATA[]]></default>
        <docblock line="1086">
          <description><![CDATA[tool name]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="1089" namespace="global" package="main">
        <name>$image</name>
        <default><![CDATA[]]></default>
        <docblock line="1088">
          <description><![CDATA[tool image]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="1091" namespace="global" package="main">
        <name>$target</name>
        <default><![CDATA[]]></default>
        <docblock line="1090">
          <description><![CDATA[link target]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1101" package="lists">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="1093">
          <description><![CDATA[Constructor]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1093" name="param" description="tool name" type="String" variable="$name">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1093" name="param" description="image file" type="String" variable="$image">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1093" name="param" description="target page" type="String" variable="$target">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1093" name="return" description="tool object" type="\lamListTool">
            <type by_reference="false">\lamListTool</type>
          </tag>
        </docblock>
        <argument line="1101">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1101">
          <name>$image</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1101">
          <name>$target</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1113" package="lists">
        <name>getImage</name>
        <full_name>getImage</full_name>
        <docblock line="1107">
          <description><![CDATA[Returns the name of the tool image.]]></description>
          <long-description><![CDATA[<p>The image is returned without path (e.g. mytool.png). All images must reside in the graphics folder.</p>]]></long-description>
          <tag line="1107" name="return" description="image name" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1123" package="lists">
        <name>getName</name>
        <full_name>getName</full_name>
        <docblock line="1117">
          <description><![CDATA[Returns the tool name.]]></description>
          <long-description><![CDATA[<p>This is used for the tool tip.</p>]]></long-description>
          <tag line="1117" name="return" description="name" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1133" package="lists">
        <name>getLinkTarget</name>
        <full_name>getLinkTarget</full_name>
        <docblock line="1127">
          <description><![CDATA[Returns the PHP file (relative to 'templates/lists') which will be the target for this tool.]]></description>
          <long-description><![CDATA[<p>The target page will be opened with two GET parameters: DN and type (e.g. user)</p>]]></long-description>
          <tag line="1127" name="return" description="page file (e.g. 'mytool.php')" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="1145" package="lists">
      <extends/>
      <name>lamListOption</name>
      <full_name>\lamListOption</full_name>
      <docblock line="1139">
        <description><![CDATA[Represents a list configuration option.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="1139" name="package" description="lists"/>
        <tag line="1139" name="author" description="Roland Gruber"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="1148" namespace="global" package="main">
        <name>$ID</name>
        <default><![CDATA[]]></default>
        <docblock line="1147">
          <description><![CDATA[unique ID]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="1150" namespace="global" package="main">
        <name>$value</name>
        <default><![CDATA[]]></default>
        <docblock line="1149">
          <description><![CDATA[option value]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1158" package="lists">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="1152">
          <description><![CDATA[Creates a new config option.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1152" name="param" description="unique ID" type="String" variable="$ID">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1152" name="return" description="config option" type="\lamConfigOption">
            <type by_reference="false">\lamConfigOption</type>
          </tag>
        </docblock>
        <argument line="1158">
          <name>$ID</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1167" package="lists">
        <name>getID</name>
        <full_name>getID</full_name>
        <docblock line="1162">
          <description><![CDATA[Returns the option ID.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1162" name="return" description="ID" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="true" static="false" visibility="public" namespace="global" line="1176" package="lists">
        <name>fillFromPostData</name>
        <full_name>fillFromPostData</full_name>
        <docblock line="1171">
          <description><![CDATA[Fills the config option from POST data.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1171" name="return" description="list of StatusMessages (array(&lt;type&gt;, &lt;head line&gt;, &lt;body&gt;))" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1183" package="lists">
        <name>getValue</name>
        <full_name>getValue</full_name>
        <docblock line="1178">
          <description><![CDATA[Returns the option value.]]></description>
          <long-description><![CDATA[<p>The value must not contain "=" and ";".</p>]]></long-description>
          <tag line="1178" name="return" description="value" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1192" package="lists">
        <name>setValue</name>
        <full_name>setValue</full_name>
        <docblock line="1187">
          <description><![CDATA[Sets the config option value.]]></description>
          <long-description><![CDATA[<p>The value must not contain "=" and ";".</p>]]></long-description>
          <tag line="1187" name="param" description="" type="String" variable="$value">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1192">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="true" static="false" visibility="public" namespace="global" line="1204" package="lists">
        <name>getMetaHTML</name>
        <full_name>getMetaHTML</full_name>
        <docblock line="1199">
          <description><![CDATA[Returns the meta HTML data to display this option.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1199" name="return" description="meta HTML" type="\htmlTable">
            <type by_reference="false">\htmlTable</type>
          </tag>
        </docblock>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="1214" package="lists">
      <extends>\lamListOption</extends>
      <name>lamBooleanListOption</name>
      <full_name>\lamBooleanListOption</full_name>
      <docblock line="1208">
        <description><![CDATA[Boolean option for list configuration.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="1208" name="package" description="lists"/>
        <tag line="1208" name="author" description="Roland Gruber"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="1217" namespace="global" package="main">
        <name>$name</name>
        <default><![CDATA[]]></default>
        <docblock line="1216">
          <description><![CDATA[option name]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1226" package="lists">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="1219">
          <description><![CDATA[Creates a new boolean option.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1219" name="param" description="name to show on config page" type="String" variable="$name">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1219" name="param" description="unique ID" type="String" variable="$ID">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1219" name="return" description="config option" type="\lamBooleanListOption">
            <type by_reference="false">\lamBooleanListOption</type>
          </tag>
        </docblock>
        <argument line="1226">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1226">
          <name>$ID</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1236" package="lists">
        <name>isSelected</name>
        <full_name>isSelected</full_name>
        <docblock line="1231">
          <description><![CDATA[Returns if this option is selected.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1231" name="return" description="true, if selected" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1245" package="lists">
        <name>fillFromPostData</name>
        <full_name>fillFromPostData</full_name>
        <docblock line="1240">
          <description><![CDATA[Fills the config option from POST data.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1240" name="return" description="list of StatusMessages (array(&lt;type&gt;, &lt;head line&gt;, &lt;body&gt;))" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1259" package="lists">
        <name>getMetaHTML</name>
        <full_name>getMetaHTML</full_name>
        <docblock line="1254">
          <description><![CDATA[Returns the meta HTML data to display this option.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1254" name="return" description="meta HTML" type="\htmlTable">
            <type by_reference="false">\htmlTable</type>
          </tag>
        </docblock>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="1273" package="lists">
      <extends>\lamListOption</extends>
      <name>lamSelectListOption</name>
      <full_name>\lamSelectListOption</full_name>
      <docblock line="1267">
        <description><![CDATA[Boolean option for list configuration.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="1267" name="package" description="lists"/>
        <tag line="1267" name="author" description="Roland Gruber"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="1276" namespace="global" package="main">
        <name>$name</name>
        <default><![CDATA[]]></default>
        <docblock line="1275">
          <description><![CDATA[option name]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="1278" namespace="global" package="main">
        <name>$options</name>
        <default><![CDATA[]]></default>
        <docblock line="1277">
          <description><![CDATA[possible select options]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="1280" namespace="global" package="main">
        <name>$helpID</name>
        <default><![CDATA[]]></default>
        <docblock line="1279">
          <description><![CDATA[help ID]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1290" package="lists">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="1282">
          <description><![CDATA[Creates a new selection list option.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1282" name="param" description="name to show on config page" type="String" variable="$name">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1282" name="param" description="list of possible values" type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1282" name="param" description="unique ID" type="String" variable="$ID">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1282" name="return" description="config option" type="\lamBooleanListOption">
            <type by_reference="false">\lamBooleanListOption</type>
          </tag>
        </docblock>
        <argument line="1290">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1290">
          <name>$options</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1290">
          <name>$ID</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1301" package="lists">
        <name>setHelpID</name>
        <full_name>setHelpID</full_name>
        <docblock line="1296">
          <description><![CDATA[Sets the help ID.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1296" name="param" description="help ID" type="\Strign" variable="$id">
            <type by_reference="false">\Strign</type>
          </tag>
        </docblock>
        <argument line="1301">
          <name>$id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1310" package="lists">
        <name>fillFromPostData</name>
        <full_name>fillFromPostData</full_name>
        <docblock line="1305">
          <description><![CDATA[Fills the config option from POST data.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1305" name="return" description="list of StatusMessages (array(&lt;type&gt;, &lt;head line&gt;, &lt;body&gt;))" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1324" package="lists">
        <name>getMetaHTML</name>
        <full_name>getMetaHTML</full_name>
        <docblock line="1319">
          <description><![CDATA[Returns the meta HTML data to display this option.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1319" name="return" description="meta HTML" type="\htmlTable">
            <type by_reference="false">\htmlTable</type>
          </tag>
        </docblock>
      </method>
    </class>
    <parse_markers>
      <notice line="740" code="50013">Parameter $tabindex could not be found in listPrintButtons()</notice>
    </parse_markers>
  </file>
  <file path="lib/pdf.inc" hash="95bf0fd8e8546c6c80e87dd59891eb00" package="PDF">
    <docblock line="24">
      <description><![CDATA[LDAP Account Manager PDF printing library.]]></description>
      <long-description><![CDATA[<p>It consists of lamPDF class,
the createModulePDF() function that may be called by other pages
and furthermore some helper functions.</p>]]></long-description>
      <tag line="24" name="author" description="Michael Duergner"/>
      <tag line="24" name="author" description="Roland Gruber"/>
      <tag line="24" name="package" description="PDF"/>
    </docblock>
    <include line="38" type="Include Once" package="main">
      <name>xml_parser.inc</name>
      <docblock line="37">
        <description><![CDATA[XML functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="41" type="Include Once" package="main">
      <name>pdfstruct.inc</name>
      <docblock line="40">
        <description><![CDATA[access to PDF configuration files]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="60" type="Include Once" package="main">
      <name>fpdf.php</name>
      <docblock line="59">
        <description><![CDATA[PDF generator class]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="62" type="Include Once" package="main">
      <name>ufpdf.php</name>
      <docblock line="61">
        <description><![CDATA[Unicode support for FPDF]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="64" type="Include Once" package="main">
      <name>lamPDF.inc</name>
      <docblock line="63">
        <description><![CDATA[LAM PDF generator class]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <constant namespace="global" line="35" package="PDF">
      <name>LAMPDF_LINEWIDTH</name>
      <full_name>\LAMPDF_LINEWIDTH</full_name>
      <value><![CDATA[190]]></value>
      <docblock line="34">
        <description><![CDATA[PDF line width]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <function namespace="global" line="57" package="PDF">
      <name>createModulePDF</name>
      <full_name>\createModulePDF</full_name>
      <docblock line="46">
        <description><![CDATA[This function creates the PDF output of one or more accounts.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="46" name="param" description="A numbered array containing all accounts the PDF page should be created for. The entries of the array must be AccountContainer objects." type="array" variable="$accounts">
          <type by_reference="false">array</type>
        </tag>
        <tag line="46" name="param" description="The filename of the structure definition that should be used to create the PDF page. If not submitted the 'default.user' structure definition for the appropriate account type." type="string" variable="$pdf_structure">
          <type by_reference="false">string</type>
        </tag>
        <tag line="46" name="param" description="returns the PDF output as String value instead of writing it to a file" type="\$returnAsString" variable="$returnAsString">
          <type by_reference="false">\$returnAsString</type>
        </tag>
        <tag line="46" name="return" description="PDF file name" type="String">
          <type by_reference="false">String</type>
        </tag>
      </docblock>
      <argument line="57">
        <name>$accounts</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="57">
        <name>$pdf_structure</name>
        <default><![CDATA["default"]]></default>
        <type/>
      </argument>
      <argument line="57">
        <name>$returnAsString</name>
        <default><![CDATA[false]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="169" package="PDF">
      <name>getSectionHeadline</name>
      <full_name>\getSectionHeadline</full_name>
      <docblock line="162">
        <description><![CDATA[Creates a section headline.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="162" name="param" description="section name" type="string" variable="$line">
          <type by_reference="false">string</type>
        </tag>
        <tag line="162" name="return" description="XML code for headline" type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="169">
        <name>$line</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="189" package="PDF">
      <name>processLine</name>
      <full_name>\processLine</full_name>
      <docblock line="180">
        <description><![CDATA[Creates the XML code for an PDF entry.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="180" name="param" description="XML code of PDF entry" type="string" variable="$line">
          <type by_reference="false">string</type>
        </tag>
        <tag line="180" name="param" description="True if this is the first column" type="boolean" variable="$first_td">
          <type by_reference="false">boolean</type>
        </tag>
        <tag line="180" name="param" description="font name" type="String" variable="$fontName">
          <type by_reference="false">String</type>
        </tag>
        <tag line="180" name="return" description="XML codes" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="189">
        <name>$line</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="189">
        <name>$first_td</name>
        <default><![CDATA[true]]></default>
        <type/>
      </argument>
      <argument line="189">
        <name>$fontName</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="265" package="PDF">
      <name>processFormatTags</name>
      <full_name>\processFormatTags</full_name>
      <docblock line="257">
        <description><![CDATA[Formats the XML code.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="257" name="param" description="XML code of PDF entry" type="string" variable="$line">
          <type by_reference="false">string</type>
        </tag>
        <tag line="257" name="param" description="style commands" type="string" variable="$style">
          <type by_reference="false">string</type>
        </tag>
        <tag line="257" name="return" description="XML code" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="265">
        <name>$line</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="265">
        <name>$style</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="298" package="PDF">
      <name>processAttributes</name>
      <full_name>\processAttributes</full_name>
      <docblock line="290">
        <description><![CDATA[Processes width, height and alignment attributes.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="290" name="param" description="attributes" type="string" variable="$attrs">
          <type by_reference="false">string</type>
        </tag>
        <tag line="290" name="param" description="XML code" type="array" variable="$return">
          <type by_reference="false">array</type>
        </tag>
        <tag line="290" name="return" description="XML code" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="298">
        <name>$attrs</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="298">
        <name>$return</name>
        <default><![CDATA[array()]]></default>
        <type/>
      </argument>
    </function>
  </file>
  <file path="lib/3rdParty/phpseclib/PHP/Compat/Function/str_split.php" hash="d2cbe83a5e5112f78f82679a268b124d" package="PHP\Compat">
    <docblock line="2">
      <description><![CDATA[Replace str_split()]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="category" description="PHP"/>
      <tag line="2" name="package" description="PHP_Compat"/>
      <tag line="2" name="license" description="LGPL - http://www.gnu.org/licenses/lgpl.html"/>
      <tag line="2" name="copyright" description="2004-2007 Aidan Lister &lt;aidan@php.net&gt;, Arpad Ray &lt;arpad@php.net&gt;"/>
      <tag line="2" name="link" description="http://php.net/function.str_split" link="http://php.net/function.str_split"/>
      <tag line="2" name="author" description="Aidan Lister &lt;aidan@php.net&gt;"/>
      <tag line="2" name="version" description="$Revision: 3620 $"/>
      <tag line="2" name="since" description="PHP 5"/>
      <tag line="2" name="require" description="PHP 4.0.0 (user_error)"/>
    </docblock>
    <function namespace="global" line="15" package="PHP\Compat">
      <name>php_compat_str_split</name>
      <full_name>\php_compat_str_split</full_name>
      <argument line="15">
        <name>$string</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="15">
        <name>$split_length</name>
        <default><![CDATA[1]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="55" package="PHP\Compat">
      <name>str_split</name>
      <full_name>\str_split</full_name>
      <argument line="55">
        <name>$string</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="55">
        <name>$split_length</name>
        <default><![CDATA[1]]></default>
        <type/>
      </argument>
    </function>
    <parse_markers>
      <error line="15" code="50009">No DocBlock was found for function \php_compat_str_split()</error>
      <error line="55" code="50009">No DocBlock was found for function \str_split()</error>
    </parse_markers>
  </file>
  <file path="lib/3rdParty/phpseclib/PHP/Compat/Function/bcpowmod.php" hash="2718ab9ac22e715aab512fe2a4ccee84" package="PHP\Compat">
    <docblock line="5">
      <description><![CDATA[Replace bcpowmod()]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="5" name="category" description="PHP"/>
      <tag line="5" name="package" description="PHP_Compat"/>
      <tag line="5" name="license" description="LGPL - http://www.gnu.org/licenses/lgpl.html"/>
      <tag line="5" name="copyright" description="2004-2007 Aidan Lister &lt;aidan@php.net&gt;, Arpad Ray &lt;arpad@php.net&gt;"/>
      <tag line="5" name="link" description="http://php.net/function.bcpowmod" link="http://php.net/function.bcpowmod"/>
      <tag line="5" name="author" description="Sara Golemon &lt;pollita@php.net&gt;"/>
      <tag line="5" name="version" description="$Revision: 4105 $"/>
      <tag line="5" name="since" description="PHP 5.0.0"/>
      <tag line="5" name="require" description="PHP 4.0.0 (user_error)"/>
    </docblock>
    <function namespace="global" line="18" package="PHP\Compat">
      <name>php_compat_bcpowmod</name>
      <full_name>\php_compat_bcpowmod</full_name>
      <argument line="18">
        <name>$x</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="18">
        <name>$y</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="18">
        <name>$modulus</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="18">
        <name>$scale</name>
        <default><![CDATA[0]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="62" package="PHP\Compat">
      <name>bcpowmod</name>
      <full_name>\bcpowmod</full_name>
      <argument line="62">
        <name>$x</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="62">
        <name>$y</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="62">
        <name>$modulus</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="62">
        <name>$scale</name>
        <default><![CDATA[0]]></default>
        <type/>
      </argument>
    </function>
    <parse_markers>
      <error line="18" code="50009">No DocBlock was found for function \php_compat_bcpowmod()</error>
      <error line="62" code="50009">No DocBlock was found for function \bcpowmod()</error>
    </parse_markers>
  </file>
  <file path="lib/3rdParty/phpseclib/PHP/Compat/Function/array_fill.php" hash="0a4909a7081ee84a72df5bc450aa0f75" package="PHP\Compat">
    <docblock line="5">
      <description><![CDATA[Replace array_fill()]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="5" name="category" description="PHP"/>
      <tag line="5" name="package" description="PHP_Compat"/>
      <tag line="5" name="license" description="http://www.opensource.org/licenses/mit-license.html  MIT License"/>
      <tag line="5" name="copyright" description="2004-2007 Aidan Lister &lt;aidan@php.net&gt;, Arpad Ray &lt;arpad@php.net&gt;"/>
      <tag line="5" name="link" description="http://php.net/function.array_fill" link="http://php.net/function.array_fill"/>
      <tag line="5" name="author" description="Jim Wigginton &lt;terrafrost@php.net&gt;"/>
      <tag line="5" name="version" description="$Revision: 4105 $"/>
      <tag line="5" name="since" description="PHP 4.2.0"/>
    </docblock>
    <function namespace="global" line="17" package="PHP\Compat">
      <name>php_compat_array_fill</name>
      <full_name>\php_compat_array_fill</full_name>
      <argument line="17">
        <name>$start_index</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="17">
        <name>$num</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="17">
        <name>$value</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="37" package="PHP\Compat">
      <name>array_fill</name>
      <full_name>\array_fill</full_name>
      <argument line="37">
        <name>$start_index</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="37">
        <name>$num</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="37">
        <name>$value</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <parse_markers>
      <error line="17" code="50009">No DocBlock was found for function \php_compat_array_fill()</error>
      <error line="37" code="50009">No DocBlock was found for function \array_fill()</error>
    </parse_markers>
  </file>
  <file path="lib/3rdParty/phpseclib/Net/SSH1.php" hash="754f94a0f8a09338469e4d466ec4cb25" package="Net\SSH1">
    <docblock line="4">
      <description><![CDATA[Pure-PHP implementation of SSHv1.]]></description>
      <long-description><![CDATA[<p>PHP versions 4 and 5</p>

<p>Here's a short example of how to use this library:</p>

<pre><code><?php
   include('Net/SSH1.php');

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

   echo $ssh->exec('ls -la');
?>
</code></pre>

<p>Here's another short example:</p>

<pre><code><?php
   include('Net/SSH1.php');

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

   echo $ssh->read('username@username:~$');
   $ssh->write("ls -la\n");
   echo $ssh->read('username@username:~$');
?>
</code></pre>

<p>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}.</p>

<p>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:</p>

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

<p>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.</p>]]></long-description>
      <tag line="4" name="category" description="Net"/>
      <tag line="4" name="package" description="Net_SSH1"/>
      <tag line="4" name="author" description="Jim Wigginton &lt;terrafrost@php.net&gt;"/>
      <tag line="4" name="copyright" description="MMVII Jim Wigginton"/>
      <tag line="4" name="license" description="http://www.opensource.org/licenses/mit-license.html  MIT License"/>
      <tag line="4" name="version" description="$Id: SSH1.php 4506 2012-05-20 09:53:15Z gruberroland $"/>
      <tag line="4" name="link" description="http://phpseclib.sourceforge.net" link="http://phpseclib.sourceforge.net"/>
    </docblock>
    <include line="74" type="Require Once" package="main">
      <name>Math/BigInteger.php</name>
      <docblock line="69">
        <description><![CDATA[Include Math_BigInteger]]></description>
        <long-description><![CDATA[<p>Used to do RSA encryption.</p>]]></long-description>
      </docblock>
    </include>
    <include line="84" type="Require Once" package="main">
      <name>Crypt/DES.php</name>
      <docblock line="81">
        <description><![CDATA[Include Crypt_DES]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="89" type="Require Once" package="main">
      <name>Crypt/TripleDES.php</name>
      <docblock line="86">
        <description><![CDATA[Include Crypt_TripleDES]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="94" type="Require Once" package="main">
      <name>Crypt/RC4.php</name>
      <docblock line="91">
        <description><![CDATA[Include Crypt_RC4]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="99" type="Require Once" package="main">
      <name>Crypt/Random.php</name>
      <docblock line="96">
        <description><![CDATA[Include Crypt_Random]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <constant namespace="global" line="112" package="Net\SSH1">
      <name>NET_SSH1_CIPHER_NONE</name>
      <full_name>\NET_SSH1_CIPHER_NONE</full_name>
      <value><![CDATA[0]]></value>
      <docblock line="107">
        <description><![CDATA[No encryption]]></description>
        <long-description><![CDATA[<p>Not supported.</p>]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="118" package="Net\SSH1">
      <name>NET_SSH1_CIPHER_IDEA</name>
      <full_name>\NET_SSH1_CIPHER_IDEA</full_name>
      <value><![CDATA[1]]></value>
      <docblock line="113">
        <description><![CDATA[IDEA in CFB mode]]></description>
        <long-description><![CDATA[<p>Not supported.</p>]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="122" package="Net\SSH1">
      <name>NET_SSH1_CIPHER_DES</name>
      <full_name>\NET_SSH1_CIPHER_DES</full_name>
      <value><![CDATA[2]]></value>
      <docblock line="119">
        <description><![CDATA[DES in CBC mode]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="128" package="Net\SSH1">
      <name>NET_SSH1_CIPHER_3DES</name>
      <full_name>\NET_SSH1_CIPHER_3DES</full_name>
      <value><![CDATA[3]]></value>
      <docblock line="123">
        <description><![CDATA[Triple-DES in CBC mode]]></description>
        <long-description><![CDATA[<p>All implementations are required to support this</p>]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="135" package="Net\SSH1">
      <name>NET_SSH1_CIPHER_BROKEN_TSS</name>
      <full_name>\NET_SSH1_CIPHER_BROKEN_TSS</full_name>
      <value><![CDATA[4]]></value>
      <docblock line="129">
        <description><![CDATA[TRI's Simple Stream encryption CBC]]></description>
        <long-description><![CDATA[<p>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)</p>]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="151" package="Net\SSH1">
      <name>NET_SSH1_CIPHER_RC4</name>
      <full_name>\NET_SSH1_CIPHER_RC4</full_name>
      <value><![CDATA[5]]></value>
      <docblock line="136">
        <description><![CDATA[RC4]]></description>
        <long-description><![CDATA[<p>Not supported.</p>]]></long-description>
        <tag line="136" name="internal" description="According to the SSH1 specs:&#10;&quot;The first 16 bytes of the session key are used as the key for&#10;the server to client direction.  The remaining 16 bytes are used&#10;as the key for the client to server direction.  This gives&#10;independent 128-bit keys for each direction.&quot;&#10;This library currently only supports encryption when the same key is being used for both directions.  This is&#10;because there's only one $crypto object.  Two could be added ($encrypt and $decrypt, perhaps)."/>
      </docblock>
    </constant>
    <constant namespace="global" line="158" package="Net\SSH1">
      <name>NET_SSH1_CIPHER_BLOWFISH</name>
      <full_name>\NET_SSH1_CIPHER_BLOWFISH</full_name>
      <value><![CDATA[6]]></value>
      <docblock line="152">
        <description><![CDATA[Blowfish]]></description>
        <long-description><![CDATA[<p>Not supported nor is it defined in the official SSH1 specs.  OpenSSH, however, defines it (see cipher.h) and
uses it (see cipher.c)</p>]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="170" package="Net\SSH1">
      <name>NET_SSH1_AUTH_RHOSTS</name>
      <full_name>\NET_SSH1_AUTH_RHOSTS</full_name>
      <value><![CDATA[1]]></value>
      <docblock line="167">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="174" package="Net\SSH1">
      <name>NET_SSH1_AUTH_RSA</name>
      <full_name>\NET_SSH1_AUTH_RSA</full_name>
      <value><![CDATA[2]]></value>
      <docblock line="171">
        <description><![CDATA[pure RSA authentication]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="180" package="Net\SSH1">
      <name>NET_SSH1_AUTH_PASSWORD</name>
      <full_name>\NET_SSH1_AUTH_PASSWORD</full_name>
      <value><![CDATA[3]]></value>
      <docblock line="175">
        <description><![CDATA[password authentication]]></description>
        <long-description><![CDATA[<p>This is the only method that is supported by this library.</p>]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="184" package="Net\SSH1">
      <name>NET_SSH1_AUTH_RHOSTS_RSA</name>
      <full_name>\NET_SSH1_AUTH_RHOSTS_RSA</full_name>
      <value><![CDATA[4]]></value>
      <docblock line="181">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="193" package="Net\SSH1">
      <name>NET_SSH1_TTY_OP_END</name>
      <full_name>\NET_SSH1_TTY_OP_END</full_name>
      <value><![CDATA[0]]></value>
    </constant>
    <constant namespace="global" line="202" package="Net\SSH1">
      <name>NET_SSH1_RESPONSE_TYPE</name>
      <full_name>\NET_SSH1_RESPONSE_TYPE</full_name>
      <value><![CDATA[1]]></value>
      <docblock line="196">
        <description><![CDATA[The Response Type]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="196" name="see" description="\global\Net_SSH1::_get_binary_packet()" refers="\global\Net_SSH1::_get_binary_packet()"/>
        <tag line="196" name="access" description="private"/>
      </docblock>
    </constant>
    <constant namespace="global" line="210" package="Net\SSH1">
      <name>NET_SSH1_RESPONSE_DATA</name>
      <full_name>\NET_SSH1_RESPONSE_DATA</full_name>
      <value><![CDATA[2]]></value>
      <docblock line="204">
        <description><![CDATA[The Response Data]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="204" name="see" description="\global\Net_SSH1::_get_binary_packet()" refers="\global\Net_SSH1::_get_binary_packet()"/>
        <tag line="204" name="access" description="private"/>
      </docblock>
    </constant>
    <constant namespace="global" line="218" package="Net\SSH1">
      <name>NET_SSH1_MASK_CONSTRUCTOR</name>
      <full_name>\NET_SSH1_MASK_CONSTRUCTOR</full_name>
      <value><![CDATA[1]]></value>
    </constant>
    <constant namespace="global" line="219" package="Net\SSH1">
      <name>NET_SSH1_MASK_LOGIN</name>
      <full_name>\NET_SSH1_MASK_LOGIN</full_name>
      <value><![CDATA[2]]></value>
    </constant>
    <constant namespace="global" line="220" package="Net\SSH1">
      <name>NET_SSH1_MASK_SHELL</name>
      <full_name>\NET_SSH1_MASK_SHELL</full_name>
      <value><![CDATA[4]]></value>
    </constant>
    <constant namespace="global" line="230" package="Net\SSH1">
      <name>NET_SSH1_LOG_SIMPLE</name>
      <full_name>\NET_SSH1_LOG_SIMPLE</full_name>
      <value><![CDATA[1]]></value>
      <docblock line="227">
        <description><![CDATA[Returns the message numbers]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="234" package="Net\SSH1">
      <name>NET_SSH1_LOG_COMPLEX</name>
      <full_name>\NET_SSH1_LOG_COMPLEX</full_name>
      <value><![CDATA[2]]></value>
      <docblock line="231">
        <description><![CDATA[Returns the message content]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="244" package="Net\SSH1">
      <name>NET_SSH1_READ_SIMPLE</name>
      <full_name>\NET_SSH1_READ_SIMPLE</full_name>
      <value><![CDATA[1]]></value>
      <docblock line="241">
        <description><![CDATA[Returns when a string matching $expect exactly is found]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="248" package="Net\SSH1">
      <name>NET_SSH1_READ_REGEX</name>
      <full_name>\NET_SSH1_READ_REGEX</full_name>
      <value><![CDATA[2]]></value>
      <docblock line="245">
        <description><![CDATA[Returns when a string matching the regular expression $expect is found]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="1229" package="Net\SSH1">
      <name>$value</name>
      <full_name>\$value</full_name>
      <value><![CDATA[$key]]></value>
    </constant>
    <class final="false" abstract="false" namespace="global" line="259" package="Net\SSH1">
      <extends/>
      <name>Net_SSH1</name>
      <full_name>\Net_SSH1</full_name>
      <docblock line="251">
        <description><![CDATA[Pure-PHP implementation of SSHv1.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="251" name="author" description="Jim Wigginton &lt;terrafrost@php.net&gt;"/>
        <tag line="251" name="version" description="0.1.0"/>
        <tag line="251" name="access" description="public"/>
        <tag line="251" name="package" description="Net_SSH1"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="266" namespace="global" package="main">
        <name>$identifier</name>
        <default><![CDATA['SSH-1.5-phpseclib']]></default>
        <docblock line="260">
          <description><![CDATA[The SSH identifier]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="260" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="260" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="274" namespace="global" package="main">
        <name>$fsock</name>
        <default><![CDATA[]]></default>
        <docblock line="268">
          <description><![CDATA[The Socket Object]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="268" name="var" description="" type="Object">
            <type by_reference="false">Object</type>
          </tag>
          <tag line="268" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="282" namespace="global" package="main">
        <name>$crypto</name>
        <default><![CDATA[false]]></default>
        <docblock line="276">
          <description><![CDATA[The cryptography object]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="276" name="var" description="" type="Object">
            <type by_reference="false">Object</type>
          </tag>
          <tag line="276" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="293" namespace="global" package="main">
        <name>$bitmap</name>
        <default><![CDATA[0]]></default>
        <docblock line="284">
          <description><![CDATA[Execution Bitmap]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="284" name="var" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="284" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="304" namespace="global" package="main">
        <name>$server_key_public_exponent</name>
        <default><![CDATA[]]></default>
        <docblock line="295">
          <description><![CDATA[The Server Key Public Exponent]]></description>
          <long-description><![CDATA[<p>Logged for debug purposes</p>]]></long-description>
          <tag line="295" name="see" description="\global\Net_SSH1::getServerKeyPublicExponent()" refers="\global\Net_SSH1::getServerKeyPublicExponent()"/>
          <tag line="295" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="295" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="315" namespace="global" package="main">
        <name>$server_key_public_modulus</name>
        <default><![CDATA[]]></default>
        <docblock line="306">
          <description><![CDATA[The Server Key Public Modulus]]></description>
          <long-description><![CDATA[<p>Logged for debug purposes</p>]]></long-description>
          <tag line="306" name="see" description="\global\Net_SSH1::getServerKeyPublicModulus()" refers="\global\Net_SSH1::getServerKeyPublicModulus()"/>
          <tag line="306" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="306" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="326" namespace="global" package="main">
        <name>$host_key_public_exponent</name>
        <default><![CDATA[]]></default>
        <docblock line="317">
          <description><![CDATA[The Host Key Public Exponent]]></description>
          <long-description><![CDATA[<p>Logged for debug purposes</p>]]></long-description>
          <tag line="317" name="see" description="\global\Net_SSH1::getHostKeyPublicExponent()" refers="\global\Net_SSH1::getHostKeyPublicExponent()"/>
          <tag line="317" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="317" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="337" namespace="global" package="main">
        <name>$host_key_public_modulus</name>
        <default><![CDATA[]]></default>
        <docblock line="328">
          <description><![CDATA[The Host Key Public Modulus]]></description>
          <long-description><![CDATA[<p>Logged for debug purposes</p>]]></long-description>
          <tag line="328" name="see" description="\global\Net_SSH1::getHostKeyPublicModulus()" refers="\global\Net_SSH1::getHostKeyPublicModulus()"/>
          <tag line="328" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="328" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="348" namespace="global" package="main">
        <name>$supported_ciphers</name>
        <default><![CDATA[array(NET_SSH1_CIPHER_NONE => 'No encryption', NET_SSH1_CIPHER_IDEA => 'IDEA in CFB mode', NET_SSH1_CIPHER_DES => 'DES in CBC mode', NET_SSH1_CIPHER_3DES => 'Triple-DES in CBC mode', NET_SSH1_CIPHER_BROKEN_TSS => 'TRI\'s Simple Stream encryption CBC', NET_SSH1_CIPHER_RC4 => 'RC4', NET_SSH1_CIPHER_BLOWFISH => 'Blowfish')]]></default>
        <docblock line="339">
          <description><![CDATA[Supported Ciphers]]></description>
          <long-description><![CDATA[<p>Logged for debug purposes</p>]]></long-description>
          <tag line="339" name="see" description="\global\Net_SSH1::getSupportedCiphers()" refers="\global\Net_SSH1::getSupportedCiphers()"/>
          <tag line="339" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="339" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="367" namespace="global" package="main">
        <name>$supported_authentications</name>
        <default><![CDATA[array(NET_SSH1_AUTH_RHOSTS => '.rhosts or /etc/hosts.equiv', NET_SSH1_AUTH_RSA => 'pure RSA authentication', NET_SSH1_AUTH_PASSWORD => 'password authentication', NET_SSH1_AUTH_RHOSTS_RSA => '.rhosts with RSA host authentication')]]></default>
        <docblock line="358">
          <description><![CDATA[Supported Authentications]]></description>
          <long-description><![CDATA[<p>Logged for debug purposes</p>]]></long-description>
          <tag line="358" name="see" description="\global\Net_SSH1::getSupportedAuthentications()" refers="\global\Net_SSH1::getSupportedAuthentications()"/>
          <tag line="358" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="358" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="381" namespace="global" package="main">
        <name>$server_identification</name>
        <default><![CDATA['']]></default>
        <docblock line="374">
          <description><![CDATA[Server Identification]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="374" name="see" description="\global\Net_SSH1::getServerIdentification()" refers="\global\Net_SSH1::getServerIdentification()"/>
          <tag line="374" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="374" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="390" namespace="global" package="main">
        <name>$protocol_flags</name>
        <default><![CDATA[array()]]></default>
        <docblock line="383">
          <description><![CDATA[Protocol Flags]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="383" name="see" description="\global\Net_SSH1::Net_SSH1()" refers="\global\Net_SSH1::Net_SSH1()"/>
          <tag line="383" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="383" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="399" namespace="global" package="main">
        <name>$protocol_flag_log</name>
        <default><![CDATA[array()]]></default>
        <docblock line="392">
          <description><![CDATA[Protocol Flag Log]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="392" name="see" description="\global\Net_SSH1::getLog()" refers="\global\Net_SSH1::getLog()"/>
          <tag line="392" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="392" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="408" namespace="global" package="main">
        <name>$message_log</name>
        <default><![CDATA[array()]]></default>
        <docblock line="401">
          <description><![CDATA[Message Log]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="401" name="see" description="\global\Net_SSH1::getLog()" refers="\global\Net_SSH1::getLog()"/>
          <tag line="401" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="401" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="417" namespace="global" package="main">
        <name>$interactive_buffer</name>
        <default><![CDATA['']]></default>
        <docblock line="410">
          <description><![CDATA[Interactive Buffer]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="410" name="see" description="\global\Net_SSH1::read()" refers="\global\Net_SSH1::read()"/>
          <tag line="410" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="410" name="access" description="private"/>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="431" package="Net\SSH1">
        <name>Net_SSH1</name>
        <full_name>Net_SSH1</full_name>
        <docblock line="419">
          <description><![CDATA[Default Constructor.]]></description>
          <long-description><![CDATA[<p>Connects to an SSHv1 server</p>]]></long-description>
          <tag line="419" name="param" description="" type="String" variable="$host">
            <type by_reference="false">String</type>
          </tag>
          <tag line="419" name="param" description="Integer $port" type="\optional" variable="$port">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="419" name="param" description="Integer $timeout" type="\optional" variable="$timeout">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="419" name="param" description="Integer $cipher" type="\optional" variable="$cipher">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="419" name="return" description="" type="\Net_SSH1">
            <type by_reference="false">\Net_SSH1</type>
          </tag>
          <tag line="419" name="access" description="public"/>
        </docblock>
        <argument line="431">
          <name>$host</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="431">
          <name>$port</name>
          <default><![CDATA[22]]></default>
          <type/>
        </argument>
        <argument line="431">
          <name>$timeout</name>
          <default><![CDATA[10]]></default>
          <type/>
        </argument>
        <argument line="431">
          <name>$cipher</name>
          <default><![CDATA[NET_SSH1_CIPHER_3DES]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="618" package="Net\SSH1">
        <name>login</name>
        <full_name>login</full_name>
        <docblock line="610">
          <description><![CDATA[Login]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="610" name="param" description="" type="String" variable="$username">
            <type by_reference="false">String</type>
          </tag>
          <tag line="610" name="param" description="String $password" type="\optional" variable="$password">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="610" name="return" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="610" name="access" description="public"/>
        </docblock>
        <argument line="618">
          <name>$username</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="618">
          <name>$password</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="687" package="Net\SSH1">
        <name>exec</name>
        <full_name>exec</full_name>
        <docblock line="667">
          <description><![CDATA[Executes a command on a non-interactive shell, returns the output, and quits.]]></description>
          <long-description><![CDATA[<p>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:</p>

<p>{@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}</p>

<p>To execute further commands, a new Net_SSH1 object will need to be created.</p>

<p>Returns false on failure and the output, otherwise.</p>]]></long-description>
          <tag line="667" name="see" description="\global\Net_SSH1::interactiveRead()" refers="\global\Net_SSH1::interactiveRead()"/>
          <tag line="667" name="see" description="\global\Net_SSH1::interactiveWrite()" refers="\global\Net_SSH1::interactiveWrite()"/>
          <tag line="667" name="param" description="" type="String" variable="$cmd">
            <type by_reference="false">String</type>
          </tag>
          <tag line="667" name="return" description="" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="667" name="access" description="public"/>
        </docblock>
        <argument line="687">
          <name>$cmd</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="687">
          <name>$block</name>
          <default><![CDATA[true]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="734" package="Net\SSH1">
        <name>_initShell</name>
        <full_name>_initShell</full_name>
        <docblock line="726">
          <description><![CDATA[Creates an interactive shell]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="726" name="see" description="\global\Net_SSH1::interactiveRead()" refers="\global\Net_SSH1::interactiveRead()"/>
          <tag line="726" name="see" description="\global\Net_SSH1::interactiveWrite()" refers="\global\Net_SSH1::interactiveWrite()"/>
          <tag line="726" name="return" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="726" name="access" description="private"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="775" package="Net\SSH1">
        <name>write</name>
        <full_name>write</full_name>
        <docblock line="767">
          <description><![CDATA[Inputs a command into an interactive shell.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="767" name="see" description="\global\Net_SSH1::interactiveWrite()" refers="\global\Net_SSH1::interactiveWrite()"/>
          <tag line="767" name="param" description="" type="String" variable="$cmd">
            <type by_reference="false">String</type>
          </tag>
          <tag line="767" name="return" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="767" name="access" description="public"/>
        </docblock>
        <argument line="775">
          <name>$cmd</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="792" package="Net\SSH1">
        <name>read</name>
        <full_name>read</full_name>
        <docblock line="780">
          <description><![CDATA[Returns the output of an interactive shell when there's a match for $expect]]></description>
          <long-description><![CDATA[<p>$expect can take the form of a string literal or, if $mode == NET_SSH1_READ_REGEX,
a regular expression.</p>]]></long-description>
          <tag line="780" name="see" description="\global\Net_SSH1::write()" refers="\global\Net_SSH1::write()"/>
          <tag line="780" name="param" description="" type="String" variable="$expect">
            <type by_reference="false">String</type>
          </tag>
          <tag line="780" name="param" description="" type="Integer" variable="$mode">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="780" name="return" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="780" name="access" description="public"/>
        </docblock>
        <argument line="792">
          <name>$expect</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="792">
          <name>$mode</name>
          <default><![CDATA[NET_SSH1_READ_SIMPLE]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="827" package="Net\SSH1">
        <name>interactiveWrite</name>
        <full_name>interactiveWrite</full_name>
        <docblock line="819">
          <description><![CDATA[Inputs a command into an interactive shell.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="819" name="see" description="\global\Net_SSH1::interactiveRead()" refers="\global\Net_SSH1::interactiveRead()"/>
          <tag line="819" name="param" description="" type="String" variable="$cmd">
            <type by_reference="false">String</type>
          </tag>
          <tag line="819" name="return" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="819" name="access" description="public"/>
        </docblock>
        <argument line="827">
          <name>$cmd</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="862" package="Net\SSH1">
        <name>interactiveRead</name>
        <full_name>interactiveRead</full_name>
        <docblock line="849">
          <description><![CDATA[Returns the output of an interactive shell when no more output is available.]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="849" name="see" description="\global\Net_SSH1::interactiveRead()" refers="\global\Net_SSH1::interactiveRead()"/>
          <tag line="849" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="849" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="889" package="Net\SSH1">
        <name>disconnect</name>
        <full_name>disconnect</full_name>
        <docblock line="884">
          <description><![CDATA[Disconnect]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="884" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="902" package="Net\SSH1">
        <name>__destruct</name>
        <full_name>__destruct</full_name>
        <docblock line="894">
          <description><![CDATA[Destructor.]]></description>
          <long-description><![CDATA[<p>Will be called, automatically, if you're supporting just PHP5.  If you're supporting PHP4, you'll need to call
disconnect().</p>]]></long-description>
          <tag line="894" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="913" package="Net\SSH1">
        <name>_disconnect</name>
        <full_name>_disconnect</full_name>
        <docblock line="907">
          <description><![CDATA[Disconnect]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="907" name="param" description="" type="String" variable="$msg">
            <type by_reference="false">String</type>
          </tag>
          <tag line="907" name="access" description="private"/>
        </docblock>
        <argument line="913">
          <name>$msg</name>
          <default><![CDATA['Client Quit']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="946" package="Net\SSH1">
        <name>_get_binary_packet</name>
        <full_name>_get_binary_packet</full_name>
        <docblock line="934">
          <description><![CDATA[Gets Binary Packets]]></description>
          <long-description><![CDATA[<p>See 'The Binary Packet Protocol' of protocol-1.5.txt for more info.</p>

<p>Also, this function could be improved upon by adding detection for the following exploit:
http://www.securiteam.com/securitynews/5LP042K3FY.html</p>]]></long-description>
          <tag line="934" name="see" description="\global\Net_SSH1::_send_binary_packet()" refers="\global\Net_SSH1::_send_binary_packet()"/>
          <tag line="934" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="934" name="access" description="private"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1004" package="Net\SSH1">
        <name>_send_binary_packet</name>
        <full_name>_send_binary_packet</full_name>
        <docblock line="994">
          <description><![CDATA[Sends Binary Packets]]></description>
          <long-description><![CDATA[<p>Returns true on success, false on failure.</p>]]></long-description>
          <tag line="994" name="see" description="\global\Net_SSH1::_get_binary_packet()" refers="\global\Net_SSH1::_get_binary_packet()"/>
          <tag line="994" name="param" description="" type="String" variable="$data">
            <type by_reference="false">String</type>
          </tag>
          <tag line="994" name="return" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="994" name="access" description="private"/>
        </docblock>
        <argument line="1004">
          <name>$data</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1056" package="Net\SSH1">
        <name>_crc</name>
        <full_name>_crc</full_name>
        <docblock line="1043">
          <description><![CDATA[Cyclic Redundancy Check (CRC)]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="1043" name="see" description="\global\Net_SSH1::_get_binary_packet()" refers="\global\Net_SSH1::_get_binary_packet()"/>
          <tag line="1043" name="see" description="\global\Net_SSH1::_send_binary_packet()" refers="\global\Net_SSH1::_send_binary_packet()"/>
          <tag line="1043" name="param" description="" type="String" variable="$data">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1043" name="return" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="1043" name="access" description="private"/>
        </docblock>
        <argument line="1056">
          <name>$data</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1153" package="Net\SSH1">
        <name>_string_shift</name>
        <full_name>_string_shift</full_name>
        <docblock line="1143">
          <description><![CDATA[String Shift]]></description>
          <long-description><![CDATA[<p>Inspired by array_shift</p>]]></long-description>
          <tag line="1143" name="param" description="" type="String" variable="$string">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1143" name="param" description="Integer $index" type="\optional" variable="$index">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="1143" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1143" name="access" description="private"/>
        </docblock>
        <argument line="1153">
          <name>$string</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1153">
          <name>$index</name>
          <default><![CDATA[1]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1173" package="Net\SSH1">
        <name>_rsa_crypt</name>
        <full_name>_rsa_crypt</full_name>
        <docblock line="1160">
          <description><![CDATA[RSA Encrypt]]></description>
          <long-description><![CDATA[<p>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...</p>]]></long-description>
          <tag line="1160" name="see" description="\global\Net_SSH1::Net_SSH1()" refers="\global\Net_SSH1::Net_SSH1()"/>
          <tag line="1160" name="param" description="" type="\Math_BigInteger" variable="$m">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="1160" name="param" description="" type="Array" variable="$key">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1160" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="1160" name="access" description="private"/>
        </docblock>
        <argument line="1173">
          <name>$m</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1173">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1223" package="Net\SSH1">
        <name>_define_array</name>
        <full_name>_define_array</full_name>
        <docblock line="1213">
          <description><![CDATA[Define Array]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="1213" name="param" description="" type="Array" variable="$array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1213" name="access" description="private"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1245" package="Net\SSH1">
        <name>getLog</name>
        <full_name>getLog</full_name>
        <docblock line="1237">
          <description><![CDATA[Returns a log of the packets that have been sent and received.]]></description>
          <long-description><![CDATA[<p>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')</p>]]></long-description>
          <tag line="1237" name="access" description="public"/>
          <tag line="1237" name="return" description="or Array" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1271" package="Net\SSH1">
        <name>_format_log</name>
        <full_name>_format_log</full_name>
        <docblock line="1263">
          <description><![CDATA[Formats a log for printing]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1263" name="param" description="" type="Array" variable="$message_log">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1263" name="param" description="" type="Array" variable="$message_number_log">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1263" name="access" description="private"/>
          <tag line="1263" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1271">
          <name>$message_log</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1271">
          <name>$message_number_log</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1315" package="Net\SSH1">
        <name>getServerKeyPublicExponent</name>
        <full_name>getServerKeyPublicExponent</full_name>
        <docblock line="1305">
          <description><![CDATA[Return the server key public exponent]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="1305" name="param" description="Boolean $raw_output" type="\optional" variable="$raw_output">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="1305" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1305" name="access" description="public"/>
        </docblock>
        <argument line="1315">
          <name>$raw_output</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1330" package="Net\SSH1">
        <name>getServerKeyPublicModulus</name>
        <full_name>getServerKeyPublicModulus</full_name>
        <docblock line="1320">
          <description><![CDATA[Return the server key public modulus]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="1320" name="param" description="Boolean $raw_output" type="\optional" variable="$raw_output">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="1320" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1320" name="access" description="public"/>
        </docblock>
        <argument line="1330">
          <name>$raw_output</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1345" package="Net\SSH1">
        <name>getHostKeyPublicExponent</name>
        <full_name>getHostKeyPublicExponent</full_name>
        <docblock line="1335">
          <description><![CDATA[Return the host key public exponent]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="1335" name="param" description="Boolean $raw_output" type="\optional" variable="$raw_output">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="1335" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1335" name="access" description="public"/>
        </docblock>
        <argument line="1345">
          <name>$raw_output</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1360" package="Net\SSH1">
        <name>getHostKeyPublicModulus</name>
        <full_name>getHostKeyPublicModulus</full_name>
        <docblock line="1350">
          <description><![CDATA[Return the host key public modulus]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="1350" name="param" description="Boolean $raw_output" type="\optional" variable="$raw_output">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="1350" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1350" name="access" description="public"/>
        </docblock>
        <argument line="1360">
          <name>$raw_output</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1376" package="Net\SSH1">
        <name>getSupportedCiphers</name>
        <full_name>getSupportedCiphers</full_name>
        <docblock line="1365">
          <description><![CDATA[Return a list of ciphers supported by SSH1 server.]]></description>
          <long-description><![CDATA[<p>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).</p>]]></long-description>
          <tag line="1365" name="param" description="Boolean $raw_output" type="\optional" variable="$raw_output">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="1365" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1365" name="access" description="public"/>
        </docblock>
        <argument line="1376">
          <name>$raw_output</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1392" package="Net\SSH1">
        <name>getSupportedAuthentications</name>
        <full_name>getSupportedAuthentications</full_name>
        <docblock line="1381">
          <description><![CDATA[Return a list of authentications supported by SSH1 server.]]></description>
          <long-description><![CDATA[<p>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).</p>]]></long-description>
          <tag line="1381" name="param" description="Boolean $raw_output" type="\optional" variable="$raw_output">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="1381" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1381" name="access" description="public"/>
        </docblock>
        <argument line="1392">
          <name>$raw_output</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1403" package="Net\SSH1">
        <name>getServerIdentification</name>
        <full_name>getServerIdentification</full_name>
        <docblock line="1397">
          <description><![CDATA[Return the server identification.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1397" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1397" name="access" description="public"/>
        </docblock>
      </method>
    </class>
    <parse_markers>
      <error line="667" code="50015">Argument $block is missing from the Docblock of exec()</error>
      <notice line="1213" code="50013">Parameter $array could not be found in _define_array()</notice>
    </parse_markers>
  </file>
  <file path="lib/3rdParty/phpseclib/Net/SSH2.php" hash="6f13dcae07cbedc80ccb805b4603f0e9" package="Net\SSH2">
    <docblock line="4">
      <description><![CDATA[Pure-PHP implementation of SSHv2.]]></description>
      <long-description><![CDATA[<p>PHP versions 4 and 5</p>

<p>Here are some examples of how to use this library:</p>

<pre><code><?php
   include('Net/SSH2.php');

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

   echo $ssh->exec('pwd');
   echo $ssh->exec('ls -la');
?>
</code></pre>

<pre><code><?php
   include('Crypt/RSA.php');
   include('Net/SSH2.php');

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

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

   echo $ssh->read('username@username:~$');
   $ssh->write("ls -la\n");
   echo $ssh->read('username@username:~$');
?>
</code></pre>

<p>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:</p>

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

<p>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.</p>]]></long-description>
      <tag line="4" name="category" description="Net"/>
      <tag line="4" name="package" description="Net_SSH2"/>
      <tag line="4" name="author" description="Jim Wigginton &lt;terrafrost@php.net&gt;"/>
      <tag line="4" name="copyright" description="MMVII Jim Wigginton"/>
      <tag line="4" name="license" description="http://www.opensource.org/licenses/mit-license.html  MIT License"/>
      <tag line="4" name="version" description="$Id: SSH2.php 4119 2011-05-31 16:32:25Z gruberroland $"/>
      <tag line="4" name="link" description="http://phpseclib.sourceforge.net" link="http://phpseclib.sourceforge.net"/>
    </docblock>
    <include line="76" type="Require Once" package="main">
      <name>Math/BigInteger.php</name>
      <docblock line="71">
        <description><![CDATA[Include Math_BigInteger]]></description>
        <long-description><![CDATA[<p>Used to do Diffie-Hellman key exchange and DSA/RSA signature verification.</p>]]></long-description>
      </docblock>
    </include>
    <include line="81" type="Require Once" package="main">
      <name>Crypt/Random.php</name>
      <docblock line="78">
        <description><![CDATA[Include Crypt_Random]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="86" type="Require Once" package="main">
      <name>Crypt/Hash.php</name>
      <docblock line="83">
        <description><![CDATA[Include Crypt_Hash]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="91" type="Require Once" package="main">
      <name>Crypt/TripleDES.php</name>
      <docblock line="88">
        <description><![CDATA[Include Crypt_TripleDES]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="96" type="Require Once" package="main">
      <name>Crypt/RC4.php</name>
      <docblock line="93">
        <description><![CDATA[Include Crypt_RC4]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="101" type="Require Once" package="main">
      <name>Crypt/AES.php</name>
      <docblock line="98">
        <description><![CDATA[Include Crypt_AES]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <constant namespace="global" line="109" package="Net\SSH2">
      <name>NET_SSH2_MASK_CONSTRUCTOR</name>
      <full_name>\NET_SSH2_MASK_CONSTRUCTOR</full_name>
      <value><![CDATA[1]]></value>
    </constant>
    <constant namespace="global" line="110" package="Net\SSH2">
      <name>NET_SSH2_MASK_LOGIN</name>
      <full_name>\NET_SSH2_MASK_LOGIN</full_name>
      <value><![CDATA[2]]></value>
    </constant>
    <constant namespace="global" line="111" package="Net\SSH2">
      <name>NET_SSH2_MASK_SHELL</name>
      <full_name>\NET_SSH2_MASK_SHELL</full_name>
      <value><![CDATA[4]]></value>
    </constant>
    <constant namespace="global" line="130" package="Net\SSH2">
      <name>NET_SSH2_CHANNEL_EXEC</name>
      <full_name>\NET_SSH2_CHANNEL_EXEC</full_name>
      <value><![CDATA[0]]></value>
    </constant>
    <constant namespace="global" line="131" package="Net\SSH2">
      <name>NET_SSH2_CHANNEL_SHELL</name>
      <full_name>\NET_SSH2_CHANNEL_SHELL</full_name>
      <value><![CDATA[1]]></value>
    </constant>
    <constant namespace="global" line="141" package="Net\SSH2">
      <name>NET_SSH2_LOG_SIMPLE</name>
      <full_name>\NET_SSH2_LOG_SIMPLE</full_name>
      <value><![CDATA[1]]></value>
      <docblock line="138">
        <description><![CDATA[Returns the message numbers]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="145" package="Net\SSH2">
      <name>NET_SSH2_LOG_COMPLEX</name>
      <full_name>\NET_SSH2_LOG_COMPLEX</full_name>
      <value><![CDATA[2]]></value>
      <docblock line="142">
        <description><![CDATA[Returns the message content]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="155" package="Net\SSH2">
      <name>NET_SSH2_READ_SIMPLE</name>
      <full_name>\NET_SSH2_READ_SIMPLE</full_name>
      <value><![CDATA[1]]></value>
      <docblock line="152">
        <description><![CDATA[Returns when a string matching $expect exactly is found]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="159" package="Net\SSH2">
      <name>NET_SSH2_READ_REGEX</name>
      <full_name>\NET_SSH2_READ_REGEX</full_name>
      <value><![CDATA[2]]></value>
      <docblock line="156">
        <description><![CDATA[Returns when a string matching the regular expression $expect is found]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="2319" package="Net\SSH2">
      <name>$value</name>
      <full_name>\$value</full_name>
      <value><![CDATA[$key]]></value>
    </constant>
    <class final="false" abstract="false" namespace="global" line="170" package="Net\SSH2">
      <extends/>
      <name>Net_SSH2</name>
      <full_name>\Net_SSH2</full_name>
      <docblock line="162">
        <description><![CDATA[Pure-PHP implementation of SSHv2.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="162" name="author" description="Jim Wigginton &lt;terrafrost@php.net&gt;"/>
        <tag line="162" name="version" description="0.1.0"/>
        <tag line="162" name="access" description="public"/>
        <tag line="162" name="package" description="Net_SSH2"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="177" namespace="global" package="main">
        <name>$identifier</name>
        <default><![CDATA['SSH-2.0-phpseclib_0.2']]></default>
        <docblock line="171">
          <description><![CDATA[The SSH identifier]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="171" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="171" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="185" namespace="global" package="main">
        <name>$fsock</name>
        <default><![CDATA[]]></default>
        <docblock line="179">
          <description><![CDATA[The Socket Object]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="179" name="var" description="" type="Object">
            <type by_reference="false">Object</type>
          </tag>
          <tag line="179" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="196" namespace="global" package="main">
        <name>$bitmap</name>
        <default><![CDATA[0]]></default>
        <docblock line="187">
          <description><![CDATA[Execution Bitmap]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="187" name="var" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="187" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="206" namespace="global" package="main">
        <name>$errors</name>
        <default><![CDATA[array()]]></default>
        <docblock line="198">
          <description><![CDATA[Error information]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="198" name="see" description="\global\Net_SSH2::getErrors()" refers="\global\Net_SSH2::getErrors()"/>
          <tag line="198" name="see" description="\global\Net_SSH2::getLastError()" refers="\global\Net_SSH2::getLastError()"/>
          <tag line="198" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="198" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="215" namespace="global" package="main">
        <name>$server_identifier</name>
        <default><![CDATA['']]></default>
        <docblock line="208">
          <description><![CDATA[Server Identifier]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="208" name="see" description="\global\Net_SSH2::getServerIdentification()" refers="\global\Net_SSH2::getServerIdentification()"/>
          <tag line="208" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="208" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="224" namespace="global" package="main">
        <name>$kex_algorithms</name>
        <default><![CDATA[]]></default>
        <docblock line="217">
          <description><![CDATA[Key Exchange Algorithms]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="217" name="see" description="\global\Net_SSH2::getKexAlgorithims()" refers="\global\Net_SSH2::getKexAlgorithims()"/>
          <tag line="217" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="217" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="233" namespace="global" package="main">
        <name>$server_host_key_algorithms</name>
        <default><![CDATA[]]></default>
        <docblock line="226">
          <description><![CDATA[Server Host Key Algorithms]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="226" name="see" description="\global\Net_SSH2::getServerHostKeyAlgorithms()" refers="\global\Net_SSH2::getServerHostKeyAlgorithms()"/>
          <tag line="226" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="226" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="242" namespace="global" package="main">
        <name>$encryption_algorithms_client_to_server</name>
        <default><![CDATA[]]></default>
        <docblock line="235">
          <description><![CDATA[Encryption Algorithms: Client to Server]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="235" name="see" description="\global\Net_SSH2::getEncryptionAlgorithmsClient2Server()" refers="\global\Net_SSH2::getEncryptionAlgorithmsClient2Server()"/>
          <tag line="235" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="235" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="251" namespace="global" package="main">
        <name>$encryption_algorithms_server_to_client</name>
        <default><![CDATA[]]></default>
        <docblock line="244">
          <description><![CDATA[Encryption Algorithms: Server to Client]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="244" name="see" description="\global\Net_SSH2::getEncryptionAlgorithmsServer2Client()" refers="\global\Net_SSH2::getEncryptionAlgorithmsServer2Client()"/>
          <tag line="244" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="244" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="260" namespace="global" package="main">
        <name>$mac_algorithms_client_to_server</name>
        <default><![CDATA[]]></default>
        <docblock line="253">
          <description><![CDATA[MAC Algorithms: Client to Server]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="253" name="see" description="\global\Net_SSH2::getMACAlgorithmsClient2Server()" refers="\global\Net_SSH2::getMACAlgorithmsClient2Server()"/>
          <tag line="253" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="253" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="269" namespace="global" package="main">
        <name>$mac_algorithms_server_to_client</name>
        <default><![CDATA[]]></default>
        <docblock line="262">
          <description><![CDATA[MAC Algorithms: Server to Client]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="262" name="see" description="\global\Net_SSH2::getMACAlgorithmsServer2Client()" refers="\global\Net_SSH2::getMACAlgorithmsServer2Client()"/>
          <tag line="262" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="262" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="278" namespace="global" package="main">
        <name>$compression_algorithms_client_to_server</name>
        <default><![CDATA[]]></default>
        <docblock line="271">
          <description><![CDATA[Compression Algorithms: Client to Server]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="271" name="see" description="\global\Net_SSH2::getCompressionAlgorithmsClient2Server()" refers="\global\Net_SSH2::getCompressionAlgorithmsClient2Server()"/>
          <tag line="271" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="271" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="287" namespace="global" package="main">
        <name>$compression_algorithms_server_to_client</name>
        <default><![CDATA[]]></default>
        <docblock line="280">
          <description><![CDATA[Compression Algorithms: Server to Client]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="280" name="see" description="\global\Net_SSH2::getCompressionAlgorithmsServer2Client()" refers="\global\Net_SSH2::getCompressionAlgorithmsServer2Client()"/>
          <tag line="280" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="280" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="296" namespace="global" package="main">
        <name>$languages_server_to_client</name>
        <default><![CDATA[]]></default>
        <docblock line="289">
          <description><![CDATA[Languages: Server to Client]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="289" name="see" description="\global\Net_SSH2::getLanguagesServer2Client()" refers="\global\Net_SSH2::getLanguagesServer2Client()"/>
          <tag line="289" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="289" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="305" namespace="global" package="main">
        <name>$languages_client_to_server</name>
        <default><![CDATA[]]></default>
        <docblock line="298">
          <description><![CDATA[Languages: Client to Server]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="298" name="see" description="\global\Net_SSH2::getLanguagesClient2Server()" refers="\global\Net_SSH2::getLanguagesClient2Server()"/>
          <tag line="298" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="298" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="322" namespace="global" package="main">
        <name>$encrypt_block_size</name>
        <default><![CDATA[8]]></default>
        <docblock line="307">
          <description><![CDATA[Block Size for Server to Client Encryption]]></description>
          <long-description><![CDATA[<p>"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."</p>

<p>-- http://tools.ietf.org/html/rfc4253#section-6</p>]]></long-description>
          <tag line="307" name="see" description="\global\Net_SSH2::Net_SSH2()" refers="\global\Net_SSH2::Net_SSH2()"/>
          <tag line="307" name="see" description="\global\Net_SSH2::_send_binary_packet()" refers="\global\Net_SSH2::_send_binary_packet()"/>
          <tag line="307" name="var" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="307" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="332" namespace="global" package="main">
        <name>$decrypt_block_size</name>
        <default><![CDATA[8]]></default>
        <docblock line="324">
          <description><![CDATA[Block Size for Client to Server Encryption]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="324" name="see" description="\global\Net_SSH2::Net_SSH2()" refers="\global\Net_SSH2::Net_SSH2()"/>
          <tag line="324" name="see" description="\global\Net_SSH2::_get_binary_packet()" refers="\global\Net_SSH2::_get_binary_packet()"/>
          <tag line="324" name="var" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="324" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="341" namespace="global" package="main">
        <name>$decrypt</name>
        <default><![CDATA[false]]></default>
        <docblock line="334">
          <description><![CDATA[Server to Client Encryption Object]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="334" name="see" description="\global\Net_SSH2::_get_binary_packet()" refers="\global\Net_SSH2::_get_binary_packet()"/>
          <tag line="334" name="var" description="" type="Object">
            <type by_reference="false">Object</type>
          </tag>
          <tag line="334" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="350" namespace="global" package="main">
        <name>$encrypt</name>
        <default><![CDATA[false]]></default>
        <docblock line="343">
          <description><![CDATA[Client to Server Encryption Object]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="343" name="see" description="\global\Net_SSH2::_send_binary_packet()" refers="\global\Net_SSH2::_send_binary_packet()"/>
          <tag line="343" name="var" description="" type="Object">
            <type by_reference="false">Object</type>
          </tag>
          <tag line="343" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="359" namespace="global" package="main">
        <name>$hmac_create</name>
        <default><![CDATA[false]]></default>
        <docblock line="352">
          <description><![CDATA[Client to Server HMAC Object]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="352" name="see" description="\global\Net_SSH2::_send_binary_packet()" refers="\global\Net_SSH2::_send_binary_packet()"/>
          <tag line="352" name="var" description="" type="Object">
            <type by_reference="false">Object</type>
          </tag>
          <tag line="352" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="368" namespace="global" package="main">
        <name>$hmac_check</name>
        <default><![CDATA[false]]></default>
        <docblock line="361">
          <description><![CDATA[Server to Client HMAC Object]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="361" name="see" description="\global\Net_SSH2::_get_binary_packet()" refers="\global\Net_SSH2::_get_binary_packet()"/>
          <tag line="361" name="var" description="" type="Object">
            <type by_reference="false">Object</type>
          </tag>
          <tag line="361" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="381" namespace="global" package="main">
        <name>$hmac_size</name>
        <default><![CDATA[false]]></default>
        <docblock line="370">
          <description><![CDATA[Size of server to client HMAC]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="370" name="see" description="\global\Net_SSH2::_get_binary_packet()" refers="\global\Net_SSH2::_get_binary_packet()"/>
          <tag line="370" name="var" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="370" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="390" namespace="global" package="main">
        <name>$server_public_host_key</name>
        <default><![CDATA[]]></default>
        <docblock line="383">
          <description><![CDATA[Server Public Host Key]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="383" name="see" description="\global\Net_SSH2::getServerPublicHostKey()" refers="\global\Net_SSH2::getServerPublicHostKey()"/>
          <tag line="383" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="383" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="405" namespace="global" package="main">
        <name>$session_id</name>
        <default><![CDATA[false]]></default>
        <docblock line="392">
          <description><![CDATA[Session identifer]]></description>
          <long-description><![CDATA[<p>"The exchange hash H from the first key exchange is additionally
 used as the session identifier, which is a unique identifier for
 this connection."</p>

<p>-- http://tools.ietf.org/html/rfc4253#section-7.2</p>]]></long-description>
          <tag line="392" name="see" description="\global\Net_SSH2::_key_exchange()" refers="\global\Net_SSH2::_key_exchange()"/>
          <tag line="392" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="392" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="416" namespace="global" package="main">
        <name>$exchange_hash</name>
        <default><![CDATA[false]]></default>
        <docblock line="407">
          <description><![CDATA[Exchange hash]]></description>
          <long-description><![CDATA[<p>The current exchange hash</p>]]></long-description>
          <tag line="407" name="see" description="\global\Net_SSH2::_key_exchange()" refers="\global\Net_SSH2::_key_exchange()"/>
          <tag line="407" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="407" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="425" namespace="global" package="main">
        <name>$message_numbers</name>
        <default><![CDATA[array()]]></default>
        <docblock line="418">
          <description><![CDATA[Message Numbers]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="418" name="see" description="\global\Net_SSH2::Net_SSH2()" refers="\global\Net_SSH2::Net_SSH2()"/>
          <tag line="418" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="418" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="434" namespace="global" package="main">
        <name>$disconnect_reasons</name>
        <default><![CDATA[array()]]></default>
        <docblock line="427">
          <description><![CDATA[Disconnection Message 'reason codes' defined in RFC4253]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="427" name="see" description="\global\Net_SSH2::Net_SSH2()" refers="\global\Net_SSH2::Net_SSH2()"/>
          <tag line="427" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="427" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="443" namespace="global" package="main">
        <name>$channel_open_failure_reasons</name>
        <default><![CDATA[array()]]></default>
        <docblock line="436">
          <description><![CDATA[SSH_MSG_CHANNEL_OPEN_FAILURE 'reason codes', defined in RFC4254]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="436" name="see" description="\global\Net_SSH2::Net_SSH2()" refers="\global\Net_SSH2::Net_SSH2()"/>
          <tag line="436" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="436" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="453" namespace="global" package="main">
        <name>$terminal_modes</name>
        <default><![CDATA[array()]]></default>
        <docblock line="445">
          <description><![CDATA[Terminal Modes]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="445" name="link" description="http://tools.ietf.org/html/rfc4254#section-8" link="http://tools.ietf.org/html/rfc4254#section-8"/>
          <tag line="445" name="see" description="\global\Net_SSH2::Net_SSH2()" refers="\global\Net_SSH2::Net_SSH2()"/>
          <tag line="445" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="445" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="463" namespace="global" package="main">
        <name>$channel_extended_data_type_codes</name>
        <default><![CDATA[array()]]></default>
        <docblock line="455">
          <description><![CDATA[SSH_MSG_CHANNEL_EXTENDED_DATA's data_type_codes]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="455" name="link" description="http://tools.ietf.org/html/rfc4254#section-5.2" link="http://tools.ietf.org/html/rfc4254#section-5.2"/>
          <tag line="455" name="see" description="\global\Net_SSH2::Net_SSH2()" refers="\global\Net_SSH2::Net_SSH2()"/>
          <tag line="455" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="455" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="474" namespace="global" package="main">
        <name>$send_seq_no</name>
        <default><![CDATA[0]]></default>
        <docblock line="465">
          <description><![CDATA[Send Sequence Number]]></description>
          <long-description><![CDATA[<p>See 'Section 6.4.  Data Integrity' of rfc4253 for more info.</p>]]></long-description>
          <tag line="465" name="see" description="\global\Net_SSH2::_send_binary_packet()" refers="\global\Net_SSH2::_send_binary_packet()"/>
          <tag line="465" name="var" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="465" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="485" namespace="global" package="main">
        <name>$get_seq_no</name>
        <default><![CDATA[0]]></default>
        <docblock line="476">
          <description><![CDATA[Get Sequence Number]]></description>
          <long-description><![CDATA[<p>See 'Section 6.4.  Data Integrity' of rfc4253 for more info.</p>]]></long-description>
          <tag line="476" name="see" description="\global\Net_SSH2::_get_binary_packet()" refers="\global\Net_SSH2::_get_binary_packet()"/>
          <tag line="476" name="var" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="476" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="497" namespace="global" package="main">
        <name>$server_channels</name>
        <default><![CDATA[array()]]></default>
        <docblock line="487">
          <description><![CDATA[Server Channels]]></description>
          <long-description><![CDATA[<p>Maps client channels to server channels</p>]]></long-description>
          <tag line="487" name="see" description="\global\Net_SSH2::_get_channel_packet()" refers="\global\Net_SSH2::_get_channel_packet()"/>
          <tag line="487" name="see" description="\global\Net_SSH2::exec()" refers="\global\Net_SSH2::exec()"/>
          <tag line="487" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="487" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="510" namespace="global" package="main">
        <name>$channel_buffers</name>
        <default><![CDATA[array()]]></default>
        <docblock line="499">
          <description><![CDATA[Channel Buffers]]></description>
          <long-description><![CDATA[<p>If a client requests a packet from one channel but receives two packets from another those packets should
be placed in a buffer</p>]]></long-description>
          <tag line="499" name="see" description="\global\Net_SSH2::_get_channel_packet()" refers="\global\Net_SSH2::_get_channel_packet()"/>
          <tag line="499" name="see" description="\global\Net_SSH2::exec()" refers="\global\Net_SSH2::exec()"/>
          <tag line="499" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="499" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="521" namespace="global" package="main">
        <name>$channel_status</name>
        <default><![CDATA[array()]]></default>
        <docblock line="512">
          <description><![CDATA[Channel Status]]></description>
          <long-description><![CDATA[<p>Contains the type of the last sent message</p>]]></long-description>
          <tag line="512" name="see" description="\global\Net_SSH2::_get_channel_packet()" refers="\global\Net_SSH2::_get_channel_packet()"/>
          <tag line="512" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="512" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="532" namespace="global" package="main">
        <name>$packet_size_client_to_server</name>
        <default><![CDATA[array()]]></default>
        <docblock line="523">
          <description><![CDATA[Packet Size]]></description>
          <long-description><![CDATA[<p>Maximum packet size indexed by channel</p>]]></long-description>
          <tag line="523" name="see" description="\global\Net_SSH2::_send_channel_packet()" refers="\global\Net_SSH2::_send_channel_packet()"/>
          <tag line="523" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="523" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="541" namespace="global" package="main">
        <name>$message_number_log</name>
        <default><![CDATA[array()]]></default>
        <docblock line="534">
          <description><![CDATA[Message Number Log]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="534" name="see" description="\global\Net_SSH2::getLog()" refers="\global\Net_SSH2::getLog()"/>
          <tag line="534" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="534" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="550" namespace="global" package="main">
        <name>$message_log</name>
        <default><![CDATA[array()]]></default>
        <docblock line="543">
          <description><![CDATA[Message Log]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="543" name="see" description="\global\Net_SSH2::getLog()" refers="\global\Net_SSH2::getLog()"/>
          <tag line="543" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="543" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="562" namespace="global" package="main">
        <name>$window_size</name>
        <default><![CDATA[2147483647]]></default>
        <docblock line="552">
          <description><![CDATA[The Window Size]]></description>
          <long-description><![CDATA[<p>Bytes the other party can send before it must wait for the window to be adjusted (0x7FFFFFFF = 4GB)</p>]]></long-description>
          <tag line="552" name="var" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="552" name="see" description="\global\Net_SSH2::_send_channel_packet()" refers="\global\Net_SSH2::_send_channel_packet()"/>
          <tag line="552" name="see" description="\global\Net_SSH2::exec()" refers="\global\Net_SSH2::exec()"/>
          <tag line="552" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="573" namespace="global" package="main">
        <name>$window_size_client_to_server</name>
        <default><![CDATA[array()]]></default>
        <docblock line="564">
          <description><![CDATA[Window size]]></description>
          <long-description><![CDATA[<p>Window size indexed by channel</p>]]></long-description>
          <tag line="564" name="see" description="\global\Net_SSH2::_send_channel_packet()" refers="\global\Net_SSH2::_send_channel_packet()"/>
          <tag line="564" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="564" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="584" namespace="global" package="main">
        <name>$signature</name>
        <default><![CDATA['']]></default>
        <docblock line="575">
          <description><![CDATA[Server signature]]></description>
          <long-description><![CDATA[<p>Verified against $this->session_id</p>]]></long-description>
          <tag line="575" name="see" description="\global\Net_SSH2::getServerPublicHostKey()" refers="\global\Net_SSH2::getServerPublicHostKey()"/>
          <tag line="575" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="575" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="595" namespace="global" package="main">
        <name>$signature_format</name>
        <default><![CDATA['']]></default>
        <docblock line="586">
          <description><![CDATA[Server signature format]]></description>
          <long-description><![CDATA[<p>ssh-rsa or ssh-dss.</p>]]></long-description>
          <tag line="586" name="see" description="\global\Net_SSH2::getServerPublicHostKey()" refers="\global\Net_SSH2::getServerPublicHostKey()"/>
          <tag line="586" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="586" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="604" namespace="global" package="main">
        <name>$interactiveBuffer</name>
        <default><![CDATA['']]></default>
        <docblock line="597">
          <description><![CDATA[Interactive Buffer]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="597" name="see" description="\global\Net_SSH2::read()" refers="\global\Net_SSH2::read()"/>
          <tag line="597" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="597" name="access" description="private"/>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="617" package="Net\SSH2">
        <name>Net_SSH2</name>
        <full_name>Net_SSH2</full_name>
        <docblock line="606">
          <description><![CDATA[Default Constructor.]]></description>
          <long-description><![CDATA[<p>Connects to an SSHv2 server</p>]]></long-description>
          <tag line="606" name="param" description="" type="String" variable="$host">
            <type by_reference="false">String</type>
          </tag>
          <tag line="606" name="param" description="Integer $port" type="\optional" variable="$port">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="606" name="param" description="Integer $timeout" type="\optional" variable="$timeout">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="606" name="return" description="" type="\Net_SSH2">
            <type by_reference="false">\Net_SSH2</type>
          </tag>
          <tag line="606" name="access" description="public"/>
        </docblock>
        <argument line="617">
          <name>$host</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="617">
          <name>$port</name>
          <default><![CDATA[22]]></default>
          <type/>
        </argument>
        <argument line="617">
          <name>$timeout</name>
          <default><![CDATA[10]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="777" package="Net\SSH2">
        <name>_key_exchange</name>
        <full_name>_key_exchange</full_name>
        <docblock line="771">
          <description><![CDATA[Key Exchange]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="771" name="param" description="" type="String" variable="$kexinit_payload_server">
            <type by_reference="false">String</type>
          </tag>
          <tag line="771" name="access" description="private"/>
        </docblock>
        <argument line="777">
          <name>$kexinit_payload_server</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1309" package="Net\SSH2">
        <name>login</name>
        <full_name>login</full_name>
        <docblock line="1297">
          <description><![CDATA[Login]]></description>
          <long-description><![CDATA[<p>The $password parameter can be a plaintext password or a Crypt_RSA object.</p>]]></long-description>
          <tag line="1297" name="param" description="" type="String" variable="$username">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1297" name="param" description="String $password" type="\optional" variable="$password">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="1297" name="return" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="1297" name="access" description="public"/>
          <tag line="1297" name="internal" description="It might be worthwhile, at some point, to protect against {@link http://tools.ietf.org/html/rfc4251#section-9.3.9 traffic analysis}&#10;by sending dummy SSH_MSG_IGNORE messages."/>
        </docblock>
        <argument line="1309">
          <name>$username</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1309">
          <name>$password</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1407" package="Net\SSH2">
        <name>_keyboard_interactive_login</name>
        <full_name>_keyboard_interactive_login</full_name>
        <docblock line="1397">
          <description><![CDATA[Login via keyboard-interactive authentication]]></description>
          <long-description><![CDATA[<p>See {@link http://tools.ietf.org/html/rfc4256 RFC4256} for details.  This is not a full-featured keyboard-interactive authenticator.</p>]]></long-description>
          <tag line="1397" name="param" description="" type="String" variable="$username">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1397" name="param" description="" type="String" variable="$password">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1397" name="return" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="1397" name="access" description="private"/>
        </docblock>
        <argument line="1407">
          <name>$username</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1407">
          <name>$password</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1428" package="Net\SSH2">
        <name>_keyboard_interactive_process</name>
        <full_name>_keyboard_interactive_process</full_name>
        <docblock line="1421">
          <description><![CDATA[Handle the keyboard-interactive requests / responses.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1421" name="param" description="" type="String" variable="$responses...">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1421" name="return" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="1421" name="access" description="private"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1518" package="Net\SSH2">
        <name>_privatekey_login</name>
        <full_name>_privatekey_login</full_name>
        <docblock line="1508">
          <description><![CDATA[Login with an RSA private key]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1508" name="param" description="" type="String" variable="$username">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1508" name="param" description="" type="\Crypt_RSA" variable="$password">
            <type by_reference="false">\Crypt_RSA</type>
          </tag>
          <tag line="1508" name="return" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="1508" name="access" description="private"/>
          <tag line="1508" name="internal" description="It might be worthwhile, at some point, to protect against {@link http://tools.ietf.org/html/rfc4251#section-9.3.9 traffic analysis}&#10;by sending dummy SSH_MSG_IGNORE messages."/>
        </docblock>
        <argument line="1518">
          <name>$username</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1518">
          <name>$privatekey</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1611" package="Net\SSH2">
        <name>exec</name>
        <full_name>exec</full_name>
        <docblock line="1600">
          <description><![CDATA[Execute Command]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="1600" name="param" description="" type="String" variable="$command">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1600" name="param" description="Boolean $block" type="\optional" variable="$block">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="1600" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1600" name="access" description="public"/>
        </docblock>
        <argument line="1611">
          <name>$command</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1611">
          <name>$block</name>
          <default><![CDATA[true]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1690" package="Net\SSH2">
        <name>_initShell</name>
        <full_name>_initShell</full_name>
        <docblock line="1682">
          <description><![CDATA[Creates an interactive shell]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1682" name="see" description="\global\Net_SSH2::read()" refers="\global\Net_SSH2::read()"/>
          <tag line="1682" name="see" description="\global\Net_SSH2::write()" refers="\global\Net_SSH2::write()"/>
          <tag line="1682" name="return" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="1682" name="access" description="private"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1768" package="Net\SSH2">
        <name>read</name>
        <full_name>read</full_name>
        <docblock line="1756">
          <description><![CDATA[Returns the output of an interactive shell]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="1756" name="see" description="\global\Net_SSH2::read()" refers="\global\Net_SSH2::read()"/>
          <tag line="1756" name="param" description="" type="String" variable="$expect">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1756" name="param" description="" type="Integer" variable="$mode">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="1756" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1756" name="access" description="public"/>
        </docblock>
        <argument line="1768">
          <name>$expect</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1768">
          <name>$mode</name>
          <default><![CDATA[NET_SSH2_READ_SIMPLE]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1804" package="Net\SSH2">
        <name>write</name>
        <full_name>write</full_name>
        <docblock line="1796">
          <description><![CDATA[Inputs a command into an interactive shell.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1796" name="see" description="\global\Net_SSH1::interactiveWrite()" refers="\global\Net_SSH1::interactiveWrite()"/>
          <tag line="1796" name="param" description="" type="String" variable="$cmd">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1796" name="return" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="1796" name="access" description="public"/>
        </docblock>
        <argument line="1804">
          <name>$cmd</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1824" package="Net\SSH2">
        <name>disconnect</name>
        <full_name>disconnect</full_name>
        <docblock line="1819">
          <description><![CDATA[Disconnect]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1819" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1837" package="Net\SSH2">
        <name>__destruct</name>
        <full_name>__destruct</full_name>
        <docblock line="1829">
          <description><![CDATA[Destructor.]]></description>
          <long-description><![CDATA[<p>Will be called, automatically, if you're supporting just PHP5.  If you're supporting PHP4, you'll need to call
disconnect().</p>]]></long-description>
          <tag line="1829" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1851" package="Net\SSH2">
        <name>_get_binary_packet</name>
        <full_name>_get_binary_packet</full_name>
        <docblock line="1842">
          <description><![CDATA[Gets Binary Packets]]></description>
          <long-description><![CDATA[<p>See '6. Binary Packet Protocol' of rfc4253 for more info.</p>]]></long-description>
          <tag line="1842" name="see" description="\global\Net_SSH2::_send_binary_packet()" refers="\global\Net_SSH2::_send_binary_packet()"/>
          <tag line="1842" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1842" name="access" description="private"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1922" package="Net\SSH2">
        <name>_filter</name>
        <full_name>_filter</full_name>
        <docblock line="1913">
          <description><![CDATA[Filter Binary Packets]]></description>
          <long-description><![CDATA[<p>Because some binary packets need to be ignored...</p>]]></long-description>
          <tag line="1913" name="see" description="\global\Net_SSH2::_get_binary_packet()" refers="\global\Net_SSH2::_get_binary_packet()"/>
          <tag line="1913" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1913" name="access" description="private"/>
        </docblock>
        <argument line="1922">
          <name>$payload</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2008" package="Net\SSH2">
        <name>_get_channel_packet</name>
        <full_name>_get_channel_packet</full_name>
        <docblock line="1999">
          <description><![CDATA[Gets channel data]]></description>
          <long-description><![CDATA[<p>Returns the data as a string if it's available and false if not.</p>]]></long-description>
          <tag line="1999" name="param" description="" type="" variable="$client_channel"/>
          <tag line="1999" name="return" description="" type="Mixed">
            <type by_reference="false">Mixed</type>
          </tag>
          <tag line="1999" name="access" description="private"/>
        </docblock>
        <argument line="2008">
          <name>$client_channel</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2008">
          <name>$skip_extended</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2138" package="Net\SSH2">
        <name>_send_binary_packet</name>
        <full_name>_send_binary_packet</full_name>
        <docblock line="2128">
          <description><![CDATA[Sends Binary Packets]]></description>
          <long-description><![CDATA[<p>See '6. Binary Packet Protocol' of rfc4253 for more info.</p>]]></long-description>
          <tag line="2128" name="param" description="" type="String" variable="$data">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2128" name="see" description="\global\Net_SSH2::_get_binary_packet()" refers="\global\Net_SSH2::_get_binary_packet()"/>
          <tag line="2128" name="return" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="2128" name="access" description="private"/>
        </docblock>
        <argument line="2138">
          <name>$data</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2201" package="Net\SSH2">
        <name>_send_channel_packet</name>
        <full_name>_send_channel_packet</full_name>
        <docblock line="2191">
          <description><![CDATA[Sends channel data]]></description>
          <long-description><![CDATA[<p>Spans multiple SSH_MSG_CHANNEL_DATAs if appropriate</p>]]></long-description>
          <tag line="2191" name="param" description="" type="Integer" variable="$client_channel">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="2191" name="param" description="" type="String" variable="$data">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2191" name="return" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="2191" name="access" description="private"/>
        </docblock>
        <argument line="2201">
          <name>$client_channel</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2201">
          <name>$data</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2254" package="Net\SSH2">
        <name>_close_channel</name>
        <full_name>_close_channel</full_name>
        <docblock line="2243">
          <description><![CDATA[Closes and flushes a channel]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="2243" name="param" description="" type="Integer" variable="$client_channel">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="2243" name="return" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="2243" name="access" description="private"/>
        </docblock>
        <argument line="2254">
          <name>$client_channel</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2275" package="Net\SSH2">
        <name>_disconnect</name>
        <full_name>_disconnect</full_name>
        <docblock line="2268">
          <description><![CDATA[Disconnect]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2268" name="param" description="" type="Integer" variable="$reason">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="2268" name="return" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="2268" name="access" description="private"/>
        </docblock>
        <argument line="2275">
          <name>$reason</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2296" package="Net\SSH2">
        <name>_string_shift</name>
        <full_name>_string_shift</full_name>
        <docblock line="2286">
          <description><![CDATA[String Shift]]></description>
          <long-description><![CDATA[<p>Inspired by array_shift</p>]]></long-description>
          <tag line="2286" name="param" description="" type="String" variable="$string">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2286" name="param" description="Integer $index" type="\optional" variable="$index">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="2286" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2286" name="access" description="private"/>
        </docblock>
        <argument line="2296">
          <name>$string</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2296">
          <name>$index</name>
          <default><![CDATA[1]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2313" package="Net\SSH2">
        <name>_define_array</name>
        <full_name>_define_array</full_name>
        <docblock line="2303">
          <description><![CDATA[Define Array]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="2303" name="param" description="" type="Array" variable="$array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="2303" name="access" description="private"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2335" package="Net\SSH2">
        <name>getLog</name>
        <full_name>getLog</full_name>
        <docblock line="2327">
          <description><![CDATA[Returns a log of the packets that have been sent and received.]]></description>
          <long-description><![CDATA[<p>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')</p>]]></long-description>
          <tag line="2327" name="access" description="public"/>
          <tag line="2327" name="return" description="or Array" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2361" package="Net\SSH2">
        <name>_format_log</name>
        <full_name>_format_log</full_name>
        <docblock line="2353">
          <description><![CDATA[Formats a log for printing]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2353" name="param" description="" type="Array" variable="$message_log">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="2353" name="param" description="" type="Array" variable="$message_number_log">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="2353" name="access" description="private"/>
          <tag line="2353" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="2361">
          <name>$message_log</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2361">
          <name>$message_number_log</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2401" package="Net\SSH2">
        <name>getErrors</name>
        <full_name>getErrors</full_name>
        <docblock line="2395">
          <description><![CDATA[Returns all errors]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2395" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2395" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2412" package="Net\SSH2">
        <name>getLastError</name>
        <full_name>getLastError</full_name>
        <docblock line="2406">
          <description><![CDATA[Returns the last error]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2406" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2406" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2423" package="Net\SSH2">
        <name>getServerIdentification</name>
        <full_name>getServerIdentification</full_name>
        <docblock line="2417">
          <description><![CDATA[Return the server identification.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2417" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2417" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2434" package="Net\SSH2">
        <name>getKexAlgorithms</name>
        <full_name>getKexAlgorithms</full_name>
        <docblock line="2428">
          <description><![CDATA[Return a list of the key exchange algorithms the server supports.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2428" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="2428" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2445" package="Net\SSH2">
        <name>getServerHostKeyAlgorithms</name>
        <full_name>getServerHostKeyAlgorithms</full_name>
        <docblock line="2439">
          <description><![CDATA[Return a list of the host key (public key) algorithms the server supports.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2439" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="2439" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2456" package="Net\SSH2">
        <name>getEncryptionAlgorithmsClient2Server</name>
        <full_name>getEncryptionAlgorithmsClient2Server</full_name>
        <docblock line="2450">
          <description><![CDATA[Return a list of the (symmetric key) encryption algorithms the server supports, when receiving stuff from the client.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2450" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="2450" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2467" package="Net\SSH2">
        <name>getEncryptionAlgorithmsServer2Client</name>
        <full_name>getEncryptionAlgorithmsServer2Client</full_name>
        <docblock line="2461">
          <description><![CDATA[Return a list of the (symmetric key) encryption algorithms the server supports, when sending stuff to the client.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2461" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="2461" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2478" package="Net\SSH2">
        <name>getMACAlgorithmsClient2Server</name>
        <full_name>getMACAlgorithmsClient2Server</full_name>
        <docblock line="2472">
          <description><![CDATA[Return a list of the MAC algorithms the server supports, when receiving stuff from the client.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2472" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="2472" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2489" package="Net\SSH2">
        <name>getMACAlgorithmsServer2Client</name>
        <full_name>getMACAlgorithmsServer2Client</full_name>
        <docblock line="2483">
          <description><![CDATA[Return a list of the MAC algorithms the server supports, when sending stuff to the client.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2483" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="2483" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2500" package="Net\SSH2">
        <name>getCompressionAlgorithmsClient2Server</name>
        <full_name>getCompressionAlgorithmsClient2Server</full_name>
        <docblock line="2494">
          <description><![CDATA[Return a list of the compression algorithms the server supports, when receiving stuff from the client.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2494" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="2494" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2511" package="Net\SSH2">
        <name>getCompressionAlgorithmsServer2Client</name>
        <full_name>getCompressionAlgorithmsServer2Client</full_name>
        <docblock line="2505">
          <description><![CDATA[Return a list of the compression algorithms the server supports, when sending stuff to the client.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2505" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="2505" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2522" package="Net\SSH2">
        <name>getLanguagesServer2Client</name>
        <full_name>getLanguagesServer2Client</full_name>
        <docblock line="2516">
          <description><![CDATA[Return a list of the languages the server supports, when sending stuff to the client.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2516" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="2516" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2533" package="Net\SSH2">
        <name>getLanguagesClient2Server</name>
        <full_name>getLanguagesClient2Server</full_name>
        <docblock line="2527">
          <description><![CDATA[Return a list of the languages the server supports, when receiving stuff from the client.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2527" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="2527" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2547" package="Net\SSH2">
        <name>getServerPublicHostKey</name>
        <full_name>getServerPublicHostKey</full_name>
        <docblock line="2538">
          <description><![CDATA[Returns the server public host key.]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="2538" name="return" description="" type="Mixed">
            <type by_reference="false">Mixed</type>
          </tag>
          <tag line="2538" name="access" description="public"/>
        </docblock>
      </method>
    </class>
    <parse_markers>
      <notice line="1421" code="50013">Parameter $responses... could not be found in _keyboard_interactive_process()</notice>
      <error line="1508" code="50014">Name of argument $privatekey does not match with the DocBlock's name $password in _privatekey_login()</error>
      <notice line="1508" code="50013">Parameter $password could not be found in _privatekey_login()</notice>
      <error line="1913" code="50015">Argument $payload is missing from the Docblock of _filter()</error>
      <error line="1999" code="50015">Argument $skip_extended is missing from the Docblock of _get_channel_packet()</error>
      <notice line="2303" code="50013">Parameter $array could not be found in _define_array()</notice>
    </parse_markers>
  </file>
  <file path="lib/3rdParty/phpseclib/Net/SFTP.php" hash="45df2d5020b4aacac771cea7e6cf39af" package="Net\SFTP">
    <docblock line="4">
      <description><![CDATA[Pure-PHP implementation of SFTP.]]></description>
      <long-description><![CDATA[<p>PHP versions 4 and 5</p>

<p>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.</p>

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

<p>Here's a short example of how to use this library:</p>

<pre><code><?php
   include('Net/SFTP.php');

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

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

<p>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:</p>

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

<p>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.</p>]]></long-description>
      <tag line="4" name="category" description="Net"/>
      <tag line="4" name="package" description="Net_SFTP"/>
      <tag line="4" name="author" description="Jim Wigginton &lt;terrafrost@php.net&gt;"/>
      <tag line="4" name="copyright" description="MMIX Jim Wigginton"/>
      <tag line="4" name="license" description="http://www.opensource.org/licenses/mit-license.html  MIT License"/>
      <tag line="4" name="link" description="http://phpseclib.sourceforge.net" link="http://phpseclib.sourceforge.net"/>
    </docblock>
    <include line="60" type="Require Once" package="main">
      <name>Net/SSH2.php</name>
      <docblock line="57">
        <description><![CDATA[Include Net_SSH2]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <constant namespace="global" line="69" package="Net\SFTP">
      <name>NET_SFTP_LOG_SIMPLE</name>
      <full_name>\NET_SFTP_LOG_SIMPLE</full_name>
      <value><![CDATA[NET_SSH2_LOG_SIMPLE]]></value>
      <docblock line="66">
        <description><![CDATA[Returns the message numbers]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="73" package="Net\SFTP">
      <name>NET_SFTP_LOG_COMPLEX</name>
      <full_name>\NET_SFTP_LOG_COMPLEX</full_name>
      <value><![CDATA[NET_SSH2_LOG_COMPLEX]]></value>
      <docblock line="70">
        <description><![CDATA[Returns the message content]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="85" package="Net\SFTP">
      <name>NET_SFTP_CHANNEL</name>
      <full_name>\NET_SFTP_CHANNEL</full_name>
      <value><![CDATA[2]]></value>
      <docblock line="76">
        <description><![CDATA[SFTP channel constant]]></description>
        <long-description><![CDATA[<p>Net_SSH2::exec() uses 0 and Net_SSH2::read() / Net_SSH2::write() use 1.</p>]]></long-description>
        <tag line="76" name="see" description="\global\Net_SSH2::_send_channel_packet()" refers="\global\Net_SSH2::_send_channel_packet()"/>
        <tag line="76" name="see" description="\global\Net_SSH2::_get_channel_packet()" refers="\global\Net_SSH2::_get_channel_packet()"/>
        <tag line="76" name="access" description="private"/>
      </docblock>
    </constant>
    <constant namespace="global" line="94" package="Net\SFTP">
      <name>NET_SFTP_LOCAL_FILE</name>
      <full_name>\NET_SFTP_LOCAL_FILE</full_name>
      <value><![CDATA[1]]></value>
      <docblock line="91">
        <description><![CDATA[Reads data from a local file.]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="98" package="Net\SFTP">
      <name>NET_SFTP_STRING</name>
      <full_name>\NET_SFTP_STRING</full_name>
      <value><![CDATA[2]]></value>
      <docblock line="95">
        <description><![CDATA[Reads data from a string.]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <class final="false" abstract="false" namespace="global" line="109" package="Net\SFTP">
      <extends>\Net_SSH2</extends>
      <name>Net_SFTP</name>
      <full_name>\Net_SFTP</full_name>
      <docblock line="101">
        <description><![CDATA[Pure-PHP implementations of SFTP.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="101" name="author" description="Jim Wigginton &lt;terrafrost@php.net&gt;"/>
        <tag line="101" name="version" description="0.1.0"/>
        <tag line="101" name="access" description="public"/>
        <tag line="101" name="package" description="Net_SFTP"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="117" namespace="global" package="main">
        <name>$packet_types</name>
        <default><![CDATA[array()]]></default>
        <docblock line="110">
          <description><![CDATA[Packet Types]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="110" name="see" description="\global\Net_SFTP::Net_SFTP()" refers="\global\Net_SFTP::Net_SFTP()"/>
          <tag line="110" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="110" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="126" namespace="global" package="main">
        <name>$status_codes</name>
        <default><![CDATA[array()]]></default>
        <docblock line="119">
          <description><![CDATA[Status Codes]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="119" name="see" description="\global\Net_SFTP::Net_SFTP()" refers="\global\Net_SFTP::Net_SFTP()"/>
          <tag line="119" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="119" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="138" namespace="global" package="main">
        <name>$request_id</name>
        <default><![CDATA[false]]></default>
        <docblock line="128">
          <description><![CDATA[The Request ID]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="128" name="var" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="128" name="see" description="\global\Net_SFTP::_send_sftp_packet()" refers="\global\Net_SFTP::_send_sftp_packet()"/>
          <tag line="128" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="150" namespace="global" package="main">
        <name>$packet_type</name>
        <default><![CDATA[-1]]></default>
        <docblock line="140">
          <description><![CDATA[The Packet Type]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="140" name="var" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="140" name="see" description="\global\Net_SFTP::_get_sftp_packet()" refers="\global\Net_SFTP::_get_sftp_packet()"/>
          <tag line="140" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="159" namespace="global" package="main">
        <name>$packet_buffer</name>
        <default><![CDATA['']]></default>
        <docblock line="152">
          <description><![CDATA[Packet Buffer]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="152" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="152" name="see" description="\global\Net_SFTP::_get_sftp_packet()" refers="\global\Net_SFTP::_get_sftp_packet()"/>
          <tag line="152" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="168" namespace="global" package="main">
        <name>$extensions</name>
        <default><![CDATA[array()]]></default>
        <docblock line="161">
          <description><![CDATA[Extensions supported by the server]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="161" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="161" name="see" description="\global\Net_SFTP::_initChannel()" refers="\global\Net_SFTP::_initChannel()"/>
          <tag line="161" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="177" namespace="global" package="main">
        <name>$version</name>
        <default><![CDATA[]]></default>
        <docblock line="170">
          <description><![CDATA[Server SFTP version]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="170" name="var" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="170" name="see" description="\global\Net_SFTP::_initChannel()" refers="\global\Net_SFTP::_initChannel()"/>
          <tag line="170" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="187" namespace="global" package="main">
        <name>$pwd</name>
        <default><![CDATA[false]]></default>
        <docblock line="179">
          <description><![CDATA[Current working directory]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="179" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="179" name="see" description="\global\Net_SFTP::_realpath()" refers="\global\Net_SFTP::_realpath()"/>
          <tag line="179" name="see" description="\global\Net_SFTP::chdir()" refers="\global\Net_SFTP::chdir()"/>
          <tag line="179" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="196" namespace="global" package="main">
        <name>$packet_type_log</name>
        <default><![CDATA[array()]]></default>
        <docblock line="189">
          <description><![CDATA[Packet Type Log]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="189" name="see" description="\global\Net_SFTP::getLog()" refers="\global\Net_SFTP::getLog()"/>
          <tag line="189" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="189" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="205" namespace="global" package="main">
        <name>$packet_log</name>
        <default><![CDATA[array()]]></default>
        <docblock line="198">
          <description><![CDATA[Packet Log]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="198" name="see" description="\global\Net_SFTP::getLog()" refers="\global\Net_SFTP::getLog()"/>
          <tag line="198" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="198" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="215" namespace="global" package="main">
        <name>$sftp_errors</name>
        <default><![CDATA[array()]]></default>
        <docblock line="207">
          <description><![CDATA[Error information]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="207" name="see" description="\global\Net_SFTP::getSFTPErrors()" refers="\global\Net_SFTP::getSFTPErrors()"/>
          <tag line="207" name="see" description="\global\Net_SFTP::getLastSFTPError()" refers="\global\Net_SFTP::getLastSFTPError()"/>
          <tag line="207" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="207" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="224" namespace="global" package="main">
        <name>$fileType</name>
        <default><![CDATA[0]]></default>
        <docblock line="217">
          <description><![CDATA[File Type]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="217" name="see" description="\global\Net_SFTP::_parseLongname()" refers="\global\Net_SFTP::_parseLongname()"/>
          <tag line="217" name="var" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="217" name="access" description="private"/>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="237" package="Net\SFTP">
        <name>Net_SFTP</name>
        <full_name>Net_SFTP</full_name>
        <docblock line="226">
          <description><![CDATA[Default Constructor.]]></description>
          <long-description><![CDATA[<p>Connects to an SFTP server</p>]]></long-description>
          <tag line="226" name="param" description="" type="String" variable="$host">
            <type by_reference="false">String</type>
          </tag>
          <tag line="226" name="param" description="Integer $port" type="\optional" variable="$port">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="226" name="param" description="Integer $timeout" type="\optional" variable="$timeout">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="226" name="return" description="" type="\Net_SFTP">
            <type by_reference="false">\Net_SFTP</type>
          </tag>
          <tag line="226" name="access" description="public"/>
        </docblock>
        <argument line="237">
          <name>$host</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="237">
          <name>$port</name>
          <default><![CDATA[22]]></default>
          <type/>
        </argument>
        <argument line="237">
          <name>$timeout</name>
          <default><![CDATA[10]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="333" package="Net\SFTP">
        <name>login</name>
        <full_name>login</full_name>
        <docblock line="325">
          <description><![CDATA[Login]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="325" name="param" description="" type="String" variable="$username">
            <type by_reference="false">String</type>
          </tag>
          <tag line="325" name="param" description="String $password" type="\optional" variable="$password">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="325" name="return" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="325" name="access" description="public"/>
        </docblock>
        <argument line="333">
          <name>$username</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="333">
          <name>$password</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="444" package="Net\SFTP">
        <name>pwd</name>
        <full_name>pwd</full_name>
        <docblock line="438">
          <description><![CDATA[Returns the current directory name]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="438" name="return" description="" type="Mixed">
            <type by_reference="false">Mixed</type>
          </tag>
          <tag line="438" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="462" package="Net\SFTP">
        <name>_realpath</name>
        <full_name>_realpath</full_name>
        <docblock line="449">
          <description><![CDATA[Canonicalize the Server-Side Path Name]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="449" name="see" description="\global\Net_SFTP::chdir()" refers="\global\Net_SFTP::chdir()"/>
          <tag line="449" name="param" description="" type="String" variable="$dir">
            <type by_reference="false">String</type>
          </tag>
          <tag line="449" name="param" description="Integer $mode" type="\optional" variable="">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="449" name="return" description="" type="Mixed">
            <type by_reference="false">Mixed</type>
          </tag>
          <tag line="449" name="access" description="private"/>
        </docblock>
        <argument line="462">
          <name>$dir</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="546" package="Net\SFTP">
        <name>chdir</name>
        <full_name>chdir</full_name>
        <docblock line="539">
          <description><![CDATA[Changes the current directory]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="539" name="param" description="" type="String" variable="$dir">
            <type by_reference="false">String</type>
          </tag>
          <tag line="539" name="return" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="539" name="access" description="public"/>
        </docblock>
        <argument line="546">
          <name>$dir</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="605" package="Net\SFTP">
        <name>nlist</name>
        <full_name>nlist</full_name>
        <docblock line="598">
          <description><![CDATA[Returns a list of files in the given directory]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="598" name="param" description="String $dir" type="\optional" variable="$dir">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="598" name="return" description="" type="Mixed">
            <type by_reference="false">Mixed</type>
          </tag>
          <tag line="598" name="access" description="public"/>
        </docblock>
        <argument line="605">
          <name>$dir</name>
          <default><![CDATA['.']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="617" package="Net\SFTP">
        <name>rawlist</name>
        <full_name>rawlist</full_name>
        <docblock line="610">
          <description><![CDATA[Returns a detailed list of files in the given directory]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="610" name="param" description="String $dir" type="\optional" variable="$dir">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="610" name="return" description="" type="Mixed">
            <type by_reference="false">Mixed</type>
          </tag>
          <tag line="610" name="access" description="public"/>
        </docblock>
        <argument line="617">
          <name>$dir</name>
          <default><![CDATA['.']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="629" package="Net\SFTP">
        <name>_list</name>
        <full_name>_list</full_name>
        <docblock line="622">
          <description><![CDATA[Reads a list, be it detailed or not, of files in the given directory]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="622" name="param" description="String $dir" type="\optional" variable="$dir">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="622" name="return" description="" type="Mixed">
            <type by_reference="false">Mixed</type>
          </tag>
          <tag line="622" name="access" description="private"/>
        </docblock>
        <argument line="629">
          <name>$dir</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="629">
          <name>$raw</name>
          <default><![CDATA[true]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="740" package="Net\SFTP">
        <name>size</name>
        <full_name>size</full_name>
        <docblock line="731">
          <description><![CDATA[Returns the file size, in bytes, or false, on failure]]></description>
          <long-description><![CDATA[<p>Files larger than 4GB will show up as being exactly 4GB.</p>]]></long-description>
          <tag line="731" name="param" description="" type="String" variable="$filename">
            <type by_reference="false">String</type>
          </tag>
          <tag line="731" name="return" description="" type="Mixed">
            <type by_reference="false">Mixed</type>
          </tag>
          <tag line="731" name="access" description="public"/>
        </docblock>
        <argument line="740">
          <name>$filename</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="763" package="Net\SFTP">
        <name>stat</name>
        <full_name>stat</full_name>
        <docblock line="754">
          <description><![CDATA[Returns general information about a file.]]></description>
          <long-description><![CDATA[<p>Returns an array on success and false otherwise.</p>]]></long-description>
          <tag line="754" name="param" description="" type="String" variable="$filename">
            <type by_reference="false">String</type>
          </tag>
          <tag line="754" name="return" description="" type="Mixed">
            <type by_reference="false">Mixed</type>
          </tag>
          <tag line="754" name="access" description="public"/>
        </docblock>
        <argument line="763">
          <name>$filename</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="786" package="Net\SFTP">
        <name>lstat</name>
        <full_name>lstat</full_name>
        <docblock line="777">
          <description><![CDATA[Returns general information about a file or symbolic link.]]></description>
          <long-description><![CDATA[<p>Returns an array on success and false otherwise.</p>]]></long-description>
          <tag line="777" name="param" description="" type="String" variable="$filename">
            <type by_reference="false">String</type>
          </tag>
          <tag line="777" name="return" description="" type="Mixed">
            <type by_reference="false">Mixed</type>
          </tag>
          <tag line="777" name="access" description="public"/>
        </docblock>
        <argument line="786">
          <name>$filename</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="811" package="Net\SFTP">
        <name>_stat</name>
        <full_name>_stat</full_name>
        <docblock line="800">
          <description><![CDATA[Returns general information about a file or symbolic link]]></description>
          <long-description><![CDATA[<p>Determines information without calling Net_SFTP::_realpath().
The second parameter can be either NET_SFTP_STAT or NET_SFTP_LSTAT.</p>]]></long-description>
          <tag line="800" name="param" description="" type="String" variable="$filename">
            <type by_reference="false">String</type>
          </tag>
          <tag line="800" name="param" description="" type="Integer" variable="$type">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="800" name="return" description="" type="Mixed">
            <type by_reference="false">Mixed</type>
          </tag>
          <tag line="800" name="access" description="private"/>
        </docblock>
        <argument line="811">
          <name>$filename</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="811">
          <name>$type</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="846" package="Net\SFTP">
        <name>_size</name>
        <full_name>_size</full_name>
        <docblock line="837">
          <description><![CDATA[Returns the file size, in bytes, or false, on failure]]></description>
          <long-description><![CDATA[<p>Determines the size without calling Net_SFTP::_realpath()</p>]]></long-description>
          <tag line="837" name="param" description="" type="String" variable="$filename">
            <type by_reference="false">String</type>
          </tag>
          <tag line="837" name="return" description="" type="Mixed">
            <type by_reference="false">Mixed</type>
          </tag>
          <tag line="837" name="access" description="private"/>
        </docblock>
        <argument line="846">
          <name>$filename</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="862" package="Net\SFTP">
        <name>chmod</name>
        <full_name>chmod</full_name>
        <docblock line="852">
          <description><![CDATA[Set permissions on a file.]]></description>
          <long-description><![CDATA[<p>Returns the new file permissions on success or FALSE on error.</p>]]></long-description>
          <tag line="852" name="param" description="" type="Integer" variable="$mode">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="852" name="param" description="" type="String" variable="$filename">
            <type by_reference="false">String</type>
          </tag>
          <tag line="852" name="return" description="" type="Mixed">
            <type by_reference="false">Mixed</type>
          </tag>
          <tag line="852" name="access" description="public"/>
        </docblock>
        <argument line="862">
          <name>$mode</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="862">
          <name>$filename</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="929" package="Net\SFTP">
        <name>mkdir</name>
        <full_name>mkdir</full_name>
        <docblock line="922">
          <description><![CDATA[Creates a directory.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="922" name="param" description="" type="String" variable="$dir">
            <type by_reference="false">String</type>
          </tag>
          <tag line="922" name="return" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="922" name="access" description="public"/>
        </docblock>
        <argument line="929">
          <name>$dir</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="969" package="Net\SFTP">
        <name>rmdir</name>
        <full_name>rmdir</full_name>
        <docblock line="962">
          <description><![CDATA[Removes a directory.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="962" name="param" description="" type="String" variable="$dir">
            <type by_reference="false">String</type>
          </tag>
          <tag line="962" name="return" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="962" name="access" description="public"/>
        </docblock>
        <argument line="969">
          <name>$dir</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1022" package="Net\SFTP">
        <name>put</name>
        <full_name>put</full_name>
        <docblock line="1001">
          <description><![CDATA[Uploads a file to the SFTP server.]]></description>
          <long-description><![CDATA[<p>By default, Net_SFTP::put() does not read from the local filesystem.  $data is dumped directly into $remote_file.
So, for example, if you set $data to 'filename.ext' and then do Net_SFTP::get(), you will get a file, twelve bytes
long, containing 'filename.ext' as its contents.</p>

<p>Setting $mode to NET_SFTP_LOCAL_FILE will change the above behavior.  With NET_SFTP_LOCAL_FILE, $remote_file will
contain as many bytes as filename.ext does on your local filesystem.  If your filename.ext is 1MB then that is how
large $remote_file will be, as well.</p>

<p>Currently, only binary mode is supported.  As such, if the line endings need to be adjusted, you will need to take
care of that, yourself.</p>]]></long-description>
          <tag line="1001" name="param" description="" type="String" variable="$remote_file">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1001" name="param" description="" type="String" variable="$data">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1001" name="param" description="Integer $mode" type="\optional" variable="$mode">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="1001" name="return" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="1001" name="access" description="public"/>
          <tag line="1001" name="internal" description="ASCII mode for SFTPv4/5/6 can be supported by adding a new function - Net_SFTP::setMode()."/>
        </docblock>
        <argument line="1022">
          <name>$remote_file</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1022">
          <name>$data</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1022">
          <name>$mode</name>
          <default><![CDATA[NET_SFTP_STRING]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1131" package="Net\SFTP">
        <name>_read_put_responses</name>
        <full_name>_read_put_responses</full_name>
        <docblock line="1121">
          <description><![CDATA[Reads multiple successive SSH_FXP_WRITE responses]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="1121" name="param" description="" type="Integer" variable="$i">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="1121" name="return" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="1121" name="access" description="private"/>
        </docblock>
        <argument line="1131">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1163" package="Net\SFTP">
        <name>get</name>
        <full_name>get</full_name>
        <docblock line="1151">
          <description><![CDATA[Downloads a file from the SFTP server.]]></description>
          <long-description><![CDATA[<p>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</p>]]></long-description>
          <tag line="1151" name="param" description="" type="String" variable="$remote_file">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1151" name="param" description="String $local_file" type="\optional" variable="$local_file">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="1151" name="return" description="" type="Mixed">
            <type by_reference="false">Mixed</type>
          </tag>
          <tag line="1151" name="access" description="public"/>
        </docblock>
        <argument line="1163">
          <name>$remote_file</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1163">
          <name>$local_file</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1275" package="Net\SFTP">
        <name>delete</name>
        <full_name>delete</full_name>
        <docblock line="1268">
          <description><![CDATA[Deletes a file on the SFTP server.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1268" name="param" description="" type="String" variable="$path">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1268" name="return" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="1268" name="access" description="public"/>
        </docblock>
        <argument line="1275">
          <name>$path</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1316" package="Net\SFTP">
        <name>rename</name>
        <full_name>rename</full_name>
        <docblock line="1308">
          <description><![CDATA[Renames a file or a directory on the SFTP server]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1308" name="param" description="" type="String" variable="$oldname">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1308" name="param" description="" type="String" variable="$newname">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1308" name="return" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="1308" name="access" description="public"/>
        </docblock>
        <argument line="1316">
          <name>$oldname</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1316">
          <name>$newname</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1360" package="Net\SFTP">
        <name>_parseAttributes</name>
        <full_name>_parseAttributes</full_name>
        <docblock line="1351">
          <description><![CDATA[Parse Attributes]]></description>
          <long-description><![CDATA[<p>See '7.  File Attributes' of draft-ietf-secsh-filexfer-13 for more info.</p>]]></long-description>
          <tag line="1351" name="param" description="" type="String" variable="$response">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1351" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1351" name="access" description="private"/>
        </docblock>
        <argument line="1360">
          <name>$response</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1417" package="Net\SFTP">
        <name>_parseLongname</name>
        <full_name>_parseLongname</full_name>
        <docblock line="1402">
          <description><![CDATA[Parse Longname]]></description>
          <long-description><![CDATA[<p>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}.</p>

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

<p>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.</p>]]></long-description>
          <tag line="1469" name="see" description="\global\Net_SFTP::_send_sftp_packet()" refers="\global\Net_SFTP::_send_sftp_packet()"/>
          <tag line="1469" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1469" name="access" description="private"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1544" package="Net\SFTP">
        <name>getSFTPLog</name>
        <full_name>getSFTPLog</full_name>
        <docblock line="1536">
          <description><![CDATA[Returns a log of the packets that have been sent and received.]]></description>
          <long-description><![CDATA[<p>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')</p>]]></long-description>
          <tag line="1536" name="access" description="public"/>
          <tag line="1536" name="return" description="or Array" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1566" package="Net\SFTP">
        <name>getSFTPErrors</name>
        <full_name>getSFTPErrors</full_name>
        <docblock line="1560">
          <description><![CDATA[Returns all errors]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1560" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1560" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1577" package="Net\SFTP">
        <name>getLastSFTPError</name>
        <full_name>getLastSFTPError</full_name>
        <docblock line="1571">
          <description><![CDATA[Returns the last error]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1571" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1571" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1588" package="Net\SFTP">
        <name>getSupportedVersions</name>
        <full_name>getSupportedVersions</full_name>
        <docblock line="1582">
          <description><![CDATA[Get supported SFTP versions]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1582" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1582" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1604" package="Net\SFTP">
        <name>_disconnect</name>
        <full_name>_disconnect</full_name>
        <docblock line="1597">
          <description><![CDATA[Disconnect]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1597" name="param" description="" type="Integer" variable="$reason">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="1597" name="return" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="1597" name="access" description="private"/>
        </docblock>
        <argument line="1604">
          <name>$reason</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <parse_markers>
      <notice line="449" code="50013">Parameter  could not be found in _realpath()</notice>
      <error line="622" code="50015">Argument $raw is missing from the Docblock of _list()</error>
    </parse_markers>
  </file>
  <file path="lib/3rdParty/phpseclib/Math/BigInteger.php" hash="257550e82cb4ca5042a85a2a9235771b" package="Math\BigInteger">
    <docblock line="4">
      <description><![CDATA[Pure-PHP arbitrary precision integer arithmetic library.]]></description>
      <long-description><![CDATA[<p>Supports base-2, base-10, base-16, and base-256 numbers.  Uses the GMP or BCMath extensions, if available,
and an internal implementation, otherwise.</p>

<p>PHP versions 4 and 5</p>

<p>{@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)</p>

<p>Math_BigInteger uses base-2<strong>26 to perform operations such as multiplication and division and
base-2</strong>52 (ie. two base 2<strong>26 digits) to perform addition and subtraction.  Because the largest possible
value when multiplying two base-2</strong>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 >> 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.</p>

<p>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<strong>31 (or 2</strong>62 for addition /
subtraction).</p>

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

<p>Useful resources are as follows:</p>

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

<p>Here's an example of how to use this library:</p>

<pre><code><?php
   include('Math/BigInteger.php');

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

   $c = $a->add($b);

   echo $c->toString(); // outputs 5
?>
</code></pre>

<p>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:</p>

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

<p>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.</p>]]></long-description>
      <tag line="4" name="category" description="Math"/>
      <tag line="4" name="package" description="Math_BigInteger"/>
      <tag line="4" name="author" description="Jim Wigginton &lt;terrafrost@php.net&gt;"/>
      <tag line="4" name="copyright" description="MMVI Jim Wigginton"/>
      <tag line="4" name="license" description="http://www.opensource.org/licenses/mit-license.html  MIT License"/>
      <tag line="4" name="version" description="$Id: BigInteger.php 4105 2011-05-19 18:02:11Z gruberroland $"/>
      <tag line="4" name="link" description="http://pear.php.net/package/Math_BigInteger" link="http://pear.php.net/package/Math_BigInteger"/>
    </docblock>
    <constant namespace="global" line="87" package="Math\BigInteger">
      <name>MATH_BIGINTEGER_MONTGOMERY</name>
      <full_name>\MATH_BIGINTEGER_MONTGOMERY</full_name>
      <value><![CDATA[0]]></value>
      <docblock line="83">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="83" name="see" description="\global\Math_BigInteger::_montgomery()" refers="\global\Math_BigInteger::_montgomery()"/>
        <tag line="83" name="see" description="\global\Math_BigInteger::_prepMontgomery()" refers="\global\Math_BigInteger::_prepMontgomery()"/>
      </docblock>
    </constant>
    <constant namespace="global" line="91" package="Math\BigInteger">
      <name>MATH_BIGINTEGER_BARRETT</name>
      <full_name>\MATH_BIGINTEGER_BARRETT</full_name>
      <value><![CDATA[1]]></value>
      <docblock line="88">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="88" name="see" description="\global\Math_BigInteger::_barrett()" refers="\global\Math_BigInteger::_barrett()"/>
      </docblock>
    </constant>
    <constant namespace="global" line="95" package="Math\BigInteger">
      <name>MATH_BIGINTEGER_POWEROF2</name>
      <full_name>\MATH_BIGINTEGER_POWEROF2</full_name>
      <value><![CDATA[2]]></value>
      <docblock line="92">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="92" name="see" description="\global\Math_BigInteger::_mod2()" refers="\global\Math_BigInteger::_mod2()"/>
      </docblock>
    </constant>
    <constant namespace="global" line="99" package="Math\BigInteger">
      <name>MATH_BIGINTEGER_CLASSIC</name>
      <full_name>\MATH_BIGINTEGER_CLASSIC</full_name>
      <value><![CDATA[3]]></value>
      <docblock line="96">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="96" name="see" description="\global\Math_BigInteger::_remainder()" refers="\global\Math_BigInteger::_remainder()"/>
      </docblock>
    </constant>
    <constant namespace="global" line="103" package="Math\BigInteger">
      <name>MATH_BIGINTEGER_NONE</name>
      <full_name>\MATH_BIGINTEGER_NONE</full_name>
      <value><![CDATA[4]]></value>
      <docblock line="100">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="100" name="see" description="\global\Math_BigInteger::__clone()" refers="\global\Math_BigInteger::__clone()"/>
      </docblock>
    </constant>
    <constant namespace="global" line="117" package="Math\BigInteger">
      <name>MATH_BIGINTEGER_VALUE</name>
      <full_name>\MATH_BIGINTEGER_VALUE</full_name>
      <value><![CDATA[0]]></value>
      <docblock line="114">
        <description><![CDATA[$result[MATH_BIGINTEGER_VALUE] contains the value.]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="121" package="Math\BigInteger">
      <name>MATH_BIGINTEGER_SIGN</name>
      <full_name>\MATH_BIGINTEGER_SIGN</full_name>
      <value><![CDATA[1]]></value>
      <docblock line="118">
        <description><![CDATA[$result[MATH_BIGINTEGER_SIGN] contains the sign.]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="134" package="Math\BigInteger">
      <name>MATH_BIGINTEGER_VARIABLE</name>
      <full_name>\MATH_BIGINTEGER_VARIABLE</full_name>
      <value><![CDATA[0]]></value>
      <docblock line="129">
        <description><![CDATA[Cache constants]]></description>
        <long-description><![CDATA[<p>$cache[MATH_BIGINTEGER_VARIABLE] tells us whether or not the cached data is still valid.</p>]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="138" package="Math\BigInteger">
      <name>MATH_BIGINTEGER_DATA</name>
      <full_name>\MATH_BIGINTEGER_DATA</full_name>
      <value><![CDATA[1]]></value>
      <docblock line="135">
        <description><![CDATA[$cache[MATH_BIGINTEGER_DATA] contains the cached data.]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="150" package="Math\BigInteger">
      <name>MATH_BIGINTEGER_MODE_INTERNAL</name>
      <full_name>\MATH_BIGINTEGER_MODE_INTERNAL</full_name>
      <value><![CDATA[1]]></value>
      <docblock line="147">
        <description><![CDATA[To use the pure-PHP implementation]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="156" package="Math\BigInteger">
      <name>MATH_BIGINTEGER_MODE_BCMATH</name>
      <full_name>\MATH_BIGINTEGER_MODE_BCMATH</full_name>
      <value><![CDATA[2]]></value>
      <docblock line="151">
        <description><![CDATA[To use the BCMath library]]></description>
        <long-description><![CDATA[<p>(if enabled; otherwise, the internal implementation will be used)</p>]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="162" package="Math\BigInteger">
      <name>MATH_BIGINTEGER_MODE_GMP</name>
      <full_name>\MATH_BIGINTEGER_MODE_GMP</full_name>
      <value><![CDATA[3]]></value>
      <docblock line="157">
        <description><![CDATA[To use the GMP library]]></description>
        <long-description><![CDATA[<p>(if present; otherwise, either the BCMath or the internal implementation will be used)</p>]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="173" package="Math\BigInteger">
      <name>MATH_BIGINTEGER_MAX_DIGIT52</name>
      <full_name>\MATH_BIGINTEGER_MAX_DIGIT52</full_name>
      <value><![CDATA[pow(2, 52)]]></value>
      <docblock line="165">
        <description><![CDATA[The largest digit that may be used in addition / subtraction]]></description>
        <long-description><![CDATA[<p>(we do pow(2, 52) instead of using 4503599627370496, directly, because some PHP installations
 will truncate 4503599627370496)</p>]]></long-description>
        <tag line="165" name="access" description="private"/>
      </docblock>
    </constant>
    <constant namespace="global" line="182" package="Math\BigInteger">
      <name>MATH_BIGINTEGER_KARATSUBA_CUTOFF</name>
      <full_name>\MATH_BIGINTEGER_KARATSUBA_CUTOFF</full_name>
      <value><![CDATA[25]]></value>
      <docblock line="175">
        <description><![CDATA[Karatsuba Cutoff]]></description>
        <long-description><![CDATA[<p>At what point do we switch between Karatsuba multiplication and schoolbook long multiplication?</p>]]></long-description>
        <tag line="175" name="access" description="private"/>
      </docblock>
    </constant>
    <constant namespace="global" line="281" package="Math\BigInteger">
      <name>MATH_BIGINTEGER_MODE</name>
      <full_name>\MATH_BIGINTEGER_MODE</full_name>
      <value><![CDATA[MATH_BIGINTEGER_MODE_INTERNAL]]></value>
    </constant>
    <class final="false" abstract="false" namespace="global" line="193" package="Math\BigInteger">
      <extends/>
      <name>Math_BigInteger</name>
      <full_name>\Math_BigInteger</full_name>
      <docblock line="184">
        <description><![CDATA[Pure-PHP arbitrary precision integer arithmetic library.]]></description>
        <long-description><![CDATA[<p>Supports base-2, base-10, base-16, and base-256
numbers.</p>]]></long-description>
        <tag line="184" name="author" description="Jim Wigginton &lt;terrafrost@php.net&gt;"/>
        <tag line="184" name="version" description="1.0.0RC4"/>
        <tag line="184" name="access" description="public"/>
        <tag line="184" name="package" description="Math_BigInteger"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="200" namespace="global" package="main">
        <name>$value</name>
        <default><![CDATA[]]></default>
        <docblock line="194">
          <description><![CDATA[Holds the BigInteger's value.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="194" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="194" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="208" namespace="global" package="main">
        <name>$is_negative</name>
        <default><![CDATA[false]]></default>
        <docblock line="202">
          <description><![CDATA[Holds the BigInteger's magnitude.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="202" name="var" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="202" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="216" namespace="global" package="main">
        <name>$generator</name>
        <default><![CDATA['mt_rand']]></default>
        <docblock line="210">
          <description><![CDATA[Random number generator function]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="210" name="see" description="\global\setRandomGenerator()" refers="\global\setRandomGenerator()"/>
          <tag line="210" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="224" namespace="global" package="main">
        <name>$precision</name>
        <default><![CDATA[-1]]></default>
        <docblock line="218">
          <description><![CDATA[Precision]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="218" name="see" description="\global\setPrecision()" refers="\global\setPrecision()"/>
          <tag line="218" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="232" namespace="global" package="main">
        <name>$bitmask</name>
        <default><![CDATA[false]]></default>
        <docblock line="226">
          <description><![CDATA[Precision Bitmask]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="226" name="see" description="\global\setPrecision()" refers="\global\setPrecision()"/>
          <tag line="226" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="246" namespace="global" package="main">
        <name>$hex</name>
        <default><![CDATA[]]></default>
        <docblock line="234">
          <description><![CDATA[Mode independant value used for serialization.]]></description>
          <long-description><![CDATA[<p>If the bcmath or gmp extensions are installed $this->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->value,
however, $this->hex is only calculated when $this->__sleep() is called.</p>]]></long-description>
          <tag line="234" name="see" description="\global\__sleep()" refers="\global\__sleep()"/>
          <tag line="234" name="see" description="\global\__wakeup()" refers="\global\__wakeup()"/>
          <tag line="234" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="234" name="access" description="private"/>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="270" package="Math\BigInteger">
        <name>Math_BigInteger</name>
        <full_name>Math_BigInteger</full_name>
        <docblock line="248">
          <description><![CDATA[Converts base-2, base-10, base-16, and binary strings (eg.]]></description>
          <long-description><![CDATA[<p>base-256) to BigIntegers.</p>

<p>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.</p>

<p>Here's an example:</p>

<pre><code><?php
   include('Math/BigInteger.php');

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

   echo $a->toString(); // outputs 50
?>
</code></pre>]]></long-description>
          <tag line="248" name="param" description="base-10 number or base-$base number if $base set." type="\optional" variable="$x">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="248" name="param" description="integer $base" type="\optional" variable="$base">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="248" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="248" name="access" description="public"/>
        </docblock>
        <argument line="270">
          <name>$x</name>
          <default><![CDATA[0]]></default>
          <type/>
        </argument>
        <argument line="270">
          <name>$base</name>
          <default><![CDATA[10]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="474" package="Math\BigInteger">
        <name>toBytes</name>
        <full_name>toBytes</full_name>
        <docblock line="452">
          <description><![CDATA[Converts a BigInteger to a byte string (eg.]]></description>
          <long-description><![CDATA[<p>base-256).</p>

<p>Negative numbers are saved as positive numbers, unless $twos_compliment is set to true, at which point, they're
saved as two's compliment.</p>

<p>Here's an example:</p>

<pre><code><?php
   include('Math/BigInteger.php');

   $a = new Math_BigInteger('65');

   echo $a->toBytes(); // outputs chr(65)
?>
</code></pre>]]></long-description>
          <tag line="452" name="param" description="" type="Boolean" variable="$twos_compliment">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="452" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="452" name="access" description="public"/>
          <tag line="452" name="internal" description="Converts a base-2**26 number to base-2**8"/>
        </docblock>
        <argument line="474">
          <name>$twos_compliment</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="571" package="Math\BigInteger">
        <name>toHex</name>
        <full_name>toHex</full_name>
        <docblock line="549">
          <description><![CDATA[Converts a BigInteger to a hex string (eg.]]></description>
          <long-description><![CDATA[<p>base-16)).</p>

<p>Negative numbers are saved as positive numbers, unless $twos_compliment is set to true, at which point, they're
saved as two's compliment.</p>

<p>Here's an example:</p>

<pre><code><?php
   include('Math/BigInteger.php');

   $a = new Math_BigInteger('65');

   echo $a->toHex(); // outputs '41'
?>
</code></pre>]]></long-description>
          <tag line="549" name="param" description="" type="Boolean" variable="$twos_compliment">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="549" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="549" name="access" description="public"/>
          <tag line="549" name="internal" description="Converts a base-2**26 number to base-2**8"/>
        </docblock>
        <argument line="571">
          <name>$twos_compliment</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="598" package="Math\BigInteger">
        <name>toBits</name>
        <full_name>toBits</full_name>
        <docblock line="576">
          <description><![CDATA[Converts a BigInteger to a bit string (eg.]]></description>
          <long-description><![CDATA[<p>base-2).</p>

<p>Negative numbers are saved as positive numbers, unless $twos_compliment is set to true, at which point, they're
saved as two's compliment.</p>

<p>Here's an example:</p>

<pre><code><?php
   include('Math/BigInteger.php');

   $a = new Math_BigInteger('65');

   echo $a->toBits(); // outputs '1000001'
?>
</code></pre>]]></long-description>
          <tag line="576" name="param" description="" type="Boolean" variable="$twos_compliment">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="576" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="576" name="access" description="public"/>
          <tag line="576" name="internal" description="Converts a base-2**26 number to base-2**2"/>
        </docblock>
        <argument line="598">
          <name>$twos_compliment</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="629" package="Math\BigInteger">
        <name>toString</name>
        <full_name>toString</full_name>
        <docblock line="611">
          <description><![CDATA[Converts a BigInteger to a base-10 number.]]></description>
          <long-description><![CDATA[<p>Here's an example:</p>

<pre><code><?php
   include('Math/BigInteger.php');

   $a = new Math_BigInteger('50');

   echo $a->toString(); // outputs 50
?>
</code></pre>]]></long-description>
          <tag line="611" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="611" name="access" description="public"/>
          <tag line="611" name="internal" description="Converts a base-2**26 number to base-10**7 (which is pretty much base-10)"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="680" package="Math\BigInteger">
        <name>copy</name>
        <full_name>copy</full_name>
        <docblock line="668">
          <description><![CDATA[Copy an object]]></description>
          <long-description><![CDATA[<p>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:</p>

<p>{@link http://php.net/language.oop5.basic#51624}</p>]]></long-description>
          <tag line="668" name="access" description="public"/>
          <tag line="668" name="see" description="\global\__clone()" refers="\global\__clone()"/>
          <tag line="668" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="700" package="Math\BigInteger">
        <name>__toString</name>
        <full_name>__toString</full_name>
        <docblock line="691">
          <description><![CDATA[__toString() magic method]]></description>
          <long-description><![CDATA[<p>Will be called, automatically, if you're supporting just PHP5.  If you're supporting PHP4, you'll need to call
toString().</p>]]></long-description>
          <tag line="691" name="access" description="public"/>
          <tag line="691" name="internal" description="Implemented per a suggestion by Techie-Michael - thanks!"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="717" package="Math\BigInteger">
        <name>__clone</name>
        <full_name>__clone</full_name>
        <docblock line="705">
          <description><![CDATA[__clone() magic method]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="705" name="access" description="public"/>
          <tag line="705" name="see" description="\global\copy()" refers="\global\copy()"/>
          <tag line="705" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="730" package="Math\BigInteger">
        <name>__sleep</name>
        <full_name>__sleep</full_name>
        <docblock line="722">
          <description><![CDATA[__sleep() magic method]]></description>
          <long-description><![CDATA[<p>Will be called, automatically, when serialize() is called on a Math_BigInteger object.</p>]]></long-description>
          <tag line="722" name="see" description="\global\__wakeup()" refers="\global\__wakeup()"/>
          <tag line="722" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="752" package="Math\BigInteger">
        <name>__wakeup</name>
        <full_name>__wakeup</full_name>
        <docblock line="744">
          <description><![CDATA[__wakeup() magic method]]></description>
          <long-description><![CDATA[<p>Will be called, automatically, when unserialize() is called on a Math_BigInteger object.</p>]]></long-description>
          <tag line="744" name="see" description="\global\__sleep()" refers="\global\__sleep()"/>
          <tag line="744" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="786" package="Math\BigInteger">
        <name>add</name>
        <full_name>add</full_name>
        <docblock line="764">
          <description><![CDATA[Adds two BigIntegers.]]></description>
          <long-description><![CDATA[<p>Here's an example:</p>

<pre><code><?php
   include('Math/BigInteger.php');

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

   $c = $a->add($b);

   echo $c->toString(); // outputs 30
?>
</code></pre>]]></long-description>
          <tag line="764" name="param" description="" type="\Math_BigInteger" variable="$y">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="764" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="764" name="access" description="public"/>
          <tag line="764" name="internal" description="Performs base-2**52 addition"/>
        </docblock>
        <argument line="786">
          <name>$y</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="820" package="Math\BigInteger">
        <name>_add</name>
        <full_name>_add</full_name>
        <docblock line="810">
          <description><![CDATA[Performs addition.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="810" name="param" description="" type="Array" variable="$x_value">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="810" name="param" description="" type="Boolean" variable="$x_negative">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="810" name="param" description="" type="Array" variable="$y_value">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="810" name="param" description="" type="Boolean" variable="$y_negative">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="810" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="810" name="access" description="private"/>
        </docblock>
        <argument line="820">
          <name>$x_value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="820">
          <name>$x_negative</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="820">
          <name>$y_value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="820">
          <name>$y_negative</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="917" package="Math\BigInteger">
        <name>subtract</name>
        <full_name>subtract</full_name>
        <docblock line="895">
          <description><![CDATA[Subtracts two BigIntegers.]]></description>
          <long-description><![CDATA[<p>Here's an example:</p>

<pre><code><?php
   include('Math/BigInteger.php');

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

   $c = $a->subtract($b);

   echo $c->toString(); // outputs -10
?>
</code></pre>]]></long-description>
          <tag line="895" name="param" description="" type="\Math_BigInteger" variable="$y">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="895" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="895" name="access" description="public"/>
          <tag line="895" name="internal" description="Performs base-2**52 subtraction"/>
        </docblock>
        <argument line="917">
          <name>$y</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="951" package="Math\BigInteger">
        <name>_subtract</name>
        <full_name>_subtract</full_name>
        <docblock line="941">
          <description><![CDATA[Performs subtraction.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="941" name="param" description="" type="Array" variable="$x_value">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="941" name="param" description="" type="Boolean" variable="$x_negative">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="941" name="param" description="" type="Array" variable="$y_value">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="941" name="param" description="" type="Boolean" variable="$y_negative">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="941" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="941" name="access" description="private"/>
        </docblock>
        <argument line="951">
          <name>$x_value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="951">
          <name>$x_negative</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="951">
          <name>$y_value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="951">
          <name>$y_negative</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1052" package="Math\BigInteger">
        <name>multiply</name>
        <full_name>multiply</full_name>
        <docblock line="1031">
          <description><![CDATA[Multiplies two BigIntegers]]></description>
          <long-description><![CDATA[<p>Here's an example:</p>

<pre><code><?php
   include('Math/BigInteger.php');

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

   $c = $a->multiply($b);

   echo $c->toString(); // outputs 200
?>
</code></pre>]]></long-description>
          <tag line="1031" name="param" description="" type="\Math_BigInteger" variable="$x">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="1031" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="1031" name="access" description="public"/>
        </docblock>
        <argument line="1052">
          <name>$x</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1086" package="Math\BigInteger">
        <name>_multiply</name>
        <full_name>_multiply</full_name>
        <docblock line="1076">
          <description><![CDATA[Performs multiplication.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1076" name="param" description="" type="Array" variable="$x_value">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1076" name="param" description="" type="Boolean" variable="$x_negative">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="1076" name="param" description="" type="Array" variable="$y_value">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1076" name="param" description="" type="Boolean" variable="$y_negative">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="1076" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1076" name="access" description="private"/>
        </docblock>
        <argument line="1086">
          <name>$x_value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1086">
          <name>$x_negative</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1086">
          <name>$y_value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1086">
          <name>$y_negative</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1123" package="Math\BigInteger">
        <name>_regularMultiply</name>
        <full_name>_regularMultiply</full_name>
        <docblock line="1113">
          <description><![CDATA[Performs long multiplication on two BigIntegers]]></description>
          <long-description><![CDATA[<p>Modeled after 'multiply' in MutableBigInteger.java.</p>]]></long-description>
          <tag line="1113" name="param" description="" type="Array" variable="$x_value">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1113" name="param" description="" type="Array" variable="$y_value">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1113" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1113" name="access" description="private"/>
        </docblock>
        <argument line="1123">
          <name>$x_value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1123">
          <name>$y_value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1187" package="Math\BigInteger">
        <name>_karatsuba</name>
        <full_name>_karatsuba</full_name>
        <docblock line="1176">
          <description><![CDATA[Performs Karatsuba multiplication on two BigIntegers]]></description>
          <long-description><![CDATA[<p>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}.</p>]]></long-description>
          <tag line="1176" name="param" description="" type="Array" variable="$x_value">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1176" name="param" description="" type="Array" variable="$y_value">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1176" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1176" name="access" description="private"/>
        </docblock>
        <argument line="1187">
          <name>$x_value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1187">
          <name>$y_value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1225" package="Math\BigInteger">
        <name>_square</name>
        <full_name>_square</full_name>
        <docblock line="1218">
          <description><![CDATA[Performs squaring]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1218" name="param" description="" type="Array" variable="$x">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1218" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1218" name="access" description="private"/>
        </docblock>
        <argument line="1225">
          <name>$x</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1243" package="Math\BigInteger">
        <name>_baseSquare</name>
        <full_name>_baseSquare</full_name>
        <docblock line="1232">
          <description><![CDATA[Performs traditional squaring on two BigIntegers]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="1232" name="param" description="" type="Array" variable="$value">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1232" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1232" name="access" description="private"/>
        </docblock>
        <argument line="1243">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1282" package="Math\BigInteger">
        <name>_karatsubaSquare</name>
        <full_name>_karatsubaSquare</full_name>
        <docblock line="1272">
          <description><![CDATA[Performs Karatsuba "squaring" on two BigIntegers]]></description>
          <long-description><![CDATA[<p>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}.</p>]]></long-description>
          <tag line="1272" name="param" description="" type="Array" variable="$value">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1272" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1272" name="access" description="private"/>
        </docblock>
        <argument line="1282">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1339" package="Math\BigInteger">
        <name>divide</name>
        <full_name>divide</full_name>
        <docblock line="1310">
          <description><![CDATA[Divides two BigIntegers.]]></description>
          <long-description><![CDATA[<p>Returns an array whose first element contains the quotient and whose second element contains the
"common residue".  If the remainder would be positive, the "common residue" and the remainder are the
same.  If the remainder would be negative, the "common residue" is equal to the sum of the remainder
and the divisor (basically, the "common residue" is the first positive modulo).</p>

<p>Here's an example:</p>

<pre><code><?php
   include('Math/BigInteger.php');

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

   list($quotient, $remainder) = $a->divide($b);

   echo $quotient->toString(); // outputs 0
   echo "\r\n";
   echo $remainder->toString(); // outputs 10
?>
</code></pre>]]></long-description>
          <tag line="1310" name="param" description="" type="\Math_BigInteger" variable="$y">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="1310" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1310" name="access" description="public"/>
          <tag line="1310" name="internal" description="This function is based off of {@link http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf#page=9 HAC 14.20}."/>
        </docblock>
        <argument line="1339">
          <name>$y</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1521" package="Math\BigInteger">
        <name>_divide_digit</name>
        <full_name>_divide_digit</full_name>
        <docblock line="1511">
          <description><![CDATA[Divides a BigInteger by a regular integer]]></description>
          <long-description><![CDATA[<p>abc / x = a00 / x + b0 / x + c / x</p>]]></long-description>
          <tag line="1511" name="param" description="" type="Array" variable="$dividend">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1511" name="param" description="" type="Array" variable="$divisor">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1511" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1511" name="access" description="private"/>
        </docblock>
        <argument line="1521">
          <name>$dividend</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1521">
          <name>$divisor</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1577" package="Math\BigInteger">
        <name>modPow</name>
        <full_name>modPow</full_name>
        <docblock line="1535">
          <description><![CDATA[Performs modular exponentiation.]]></description>
          <long-description><![CDATA[<p>Here's an example:</p>

<pre><code><?php
   include('Math/BigInteger.php');

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

   $c = $a->modPow($b, $c);

   echo $c->toString(); // outputs 10
?>
</code></pre>]]></long-description>
          <tag line="1535" name="param" description="" type="\Math_BigInteger" variable="$e">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="1535" name="param" description="" type="\Math_BigInteger" variable="$n">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="1535" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="1535" name="access" description="public"/>
          <tag line="1535" name="internal" description="The most naive approach to modular exponentiation has very unreasonable requirements, and&#10;and although the approach involving repeated squaring does vastly better, it, too, is impractical&#10;for our purposes.  The reason being that division - by far the most complicated and time-consuming&#10;of the basic operations (eg. +,-,*,/) - occurs multiple times within it.&#10;Modular reductions resolve this issue.  Although an individual modular reduction takes more time&#10;then an individual division, when performed in succession (with the same modulo), they're a lot faster.&#10;The two most commonly used modular reductions are Barrett and Montgomery reduction.  Montgomery reduction,&#10;although faster, only works when the gcd of the modulo and of the base being used is 1.  In RSA, when the&#10;base is a power of two, the modulo - a product of two primes - is always going to have a gcd of 1 (because&#10;the product of two odd numbers is odd), but what about when RSA isn't used?&#10;In contrast, Barrett reduction has no such constraint.  As such, some bigint implementations perform a&#10;Barrett reduction after every operation in the modpow function.  Others perform Barrett reductions when the&#10;modulo is even and Montgomery reductions when the modulo is odd.  BigInteger.java's modPow method, however,&#10;uses a trick involving the Chinese Remainder Theorem to factor the even modulo into two numbers - one odd and&#10;the other, a power of two - and recombine them, later.  This is the method that this modPow function uses.&#10;{@link http://islab.oregonstate.edu/papers/j34monex.pdf Montgomery Reduction with Even Modulus} elaborates."/>
        </docblock>
        <argument line="1577">
          <name>$e</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1577">
          <name>$n</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1676" package="Math\BigInteger">
        <name>powMod</name>
        <full_name>powMod</full_name>
        <docblock line="1666">
          <description><![CDATA[Performs modular exponentiation.]]></description>
          <long-description><![CDATA[<p>Alias for Math_BigInteger::modPow()</p>]]></long-description>
          <tag line="1666" name="param" description="" type="\Math_BigInteger" variable="$e">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="1666" name="param" description="" type="\Math_BigInteger" variable="$n">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="1666" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="1666" name="access" description="public"/>
        </docblock>
        <argument line="1676">
          <name>$e</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1676">
          <name>$n</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1695" package="Math\BigInteger">
        <name>_slidingWindow</name>
        <full_name>_slidingWindow</full_name>
        <docblock line="1681">
          <description><![CDATA[Sliding Window k-ary Modular Exponentiation]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="1681" name="param" description="" type="\Math_BigInteger" variable="$e">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="1681" name="param" description="" type="\Math_BigInteger" variable="$n">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="1681" name="param" description="" type="Integer" variable="$mode">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="1681" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="1681" name="access" description="private"/>
        </docblock>
        <argument line="1695">
          <name>$e</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1695">
          <name>$n</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1695">
          <name>$mode</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1770" package="Math\BigInteger">
        <name>_reduce</name>
        <full_name>_reduce</full_name>
        <docblock line="1758">
          <description><![CDATA[Modular reduction]]></description>
          <long-description><![CDATA[<p>For most $modes this will return the remainder.</p>]]></long-description>
          <tag line="1758" name="see" description="\global\_slidingWindow()" refers="\global\_slidingWindow()"/>
          <tag line="1758" name="access" description="private"/>
          <tag line="1758" name="param" description="" type="Array" variable="$x">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1758" name="param" description="" type="Array" variable="$n">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1758" name="param" description="" type="Integer" variable="$mode">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="1758" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
        </docblock>
        <argument line="1770">
          <name>$x</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1770">
          <name>$n</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1770">
          <name>$mode</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1807" package="Math\BigInteger">
        <name>_prepareReduce</name>
        <full_name>_prepareReduce</full_name>
        <docblock line="1797">
          <description><![CDATA[Modular reduction preperation]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1797" name="see" description="\global\_slidingWindow()" refers="\global\_slidingWindow()"/>
          <tag line="1797" name="access" description="private"/>
          <tag line="1797" name="param" description="" type="Array" variable="$x">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1797" name="param" description="" type="Array" variable="$n">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1797" name="param" description="" type="Integer" variable="$mode">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="1797" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
        </docblock>
        <argument line="1807">
          <name>$x</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1807">
          <name>$n</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1807">
          <name>$mode</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1826" package="Math\BigInteger">
        <name>_multiplyReduce</name>
        <full_name>_multiplyReduce</full_name>
        <docblock line="1815">
          <description><![CDATA[Modular multiply]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1815" name="see" description="\global\_slidingWindow()" refers="\global\_slidingWindow()"/>
          <tag line="1815" name="access" description="private"/>
          <tag line="1815" name="param" description="" type="Array" variable="$x">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1815" name="param" description="" type="Array" variable="$y">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1815" name="param" description="" type="Array" variable="$n">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1815" name="param" description="" type="Integer" variable="$mode">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="1815" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
        </docblock>
        <argument line="1826">
          <name>$x</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1826">
          <name>$y</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1826">
          <name>$n</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1826">
          <name>$mode</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1845" package="Math\BigInteger">
        <name>_squareReduce</name>
        <full_name>_squareReduce</full_name>
        <docblock line="1835">
          <description><![CDATA[Modular square]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1835" name="see" description="\global\_slidingWindow()" refers="\global\_slidingWindow()"/>
          <tag line="1835" name="access" description="private"/>
          <tag line="1835" name="param" description="" type="Array" variable="$x">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1835" name="param" description="" type="Array" variable="$n">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1835" name="param" description="" type="Integer" variable="$mode">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="1835" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
        </docblock>
        <argument line="1845">
          <name>$x</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1845">
          <name>$n</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1845">
          <name>$mode</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1864" package="Math\BigInteger">
        <name>_mod2</name>
        <full_name>_mod2</full_name>
        <docblock line="1853">
          <description><![CDATA[Modulos for Powers of Two]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="1853" name="see" description="\global\_slidingWindow()" refers="\global\_slidingWindow()"/>
          <tag line="1853" name="access" description="private"/>
          <tag line="1853" name="param" description="Math_BigInteger" type="" variable="$n"/>
          <tag line="1853" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
        </docblock>
        <argument line="1864">
          <name>$n</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1895" package="Math\BigInteger">
        <name>_barrett</name>
        <full_name>_barrett</full_name>
        <docblock line="1871">
          <description><![CDATA[Barrett Modular Reduction]]></description>
          <long-description><![CDATA[<p>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).</p>

<p>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."</p>

<p>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 >> 1) + (x >> 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.</p>]]></long-description>
          <tag line="1871" name="see" description="\global\_slidingWindow()" refers="\global\_slidingWindow()"/>
          <tag line="1871" name="access" description="private"/>
          <tag line="1871" name="param" description="" type="Array" variable="$n">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1871" name="param" description="" type="Array" variable="$m">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1871" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
        </docblock>
        <argument line="1895">
          <name>$n</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1895">
          <name>$m</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1992" package="Math\BigInteger">
        <name>_regularBarrett</name>
        <full_name>_regularBarrett</full_name>
        <docblock line="1980">
          <description><![CDATA[(Regular) Barrett Modular Reduction]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="1980" name="see" description="\global\_slidingWindow()" refers="\global\_slidingWindow()"/>
          <tag line="1980" name="access" description="private"/>
          <tag line="1980" name="param" description="" type="Array" variable="$x">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1980" name="param" description="" type="Array" variable="$n">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="1980" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
        </docblock>
        <argument line="1992">
          <name>$x</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1992">
          <name>$n</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2065" package="Math\BigInteger">
        <name>_multiplyLower</name>
        <full_name>_multiplyLower</full_name>
        <docblock line="2052">
          <description><![CDATA[Performs long multiplication up to $stop digits]]></description>
          <long-description><![CDATA[<p>If you're going to be doing array_slice($product->value, 0, $stop), some cycles can be saved.</p>]]></long-description>
          <tag line="2052" name="see" description="\global\_regularBarrett()" refers="\global\_regularBarrett()"/>
          <tag line="2052" name="param" description="" type="Array" variable="$x_value">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="2052" name="param" description="" type="Boolean" variable="$x_negative">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="2052" name="param" description="" type="Array" variable="$y_value">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="2052" name="param" description="" type="Boolean" variable="$y_negative">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="2052" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="2052" name="access" description="private"/>
        </docblock>
        <argument line="2065">
          <name>$x_value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2065">
          <name>$x_negative</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2065">
          <name>$y_value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2065">
          <name>$y_negative</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2065">
          <name>$stop</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2144" package="Math\BigInteger">
        <name>_montgomery</name>
        <full_name>_montgomery</full_name>
        <docblock line="2129">
          <description><![CDATA[Montgomery Modular Reduction]]></description>
          <long-description><![CDATA[<p>($x->_prepMontgomery($n))->_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.</p>]]></long-description>
          <tag line="2129" name="see" description="\global\_prepMontgomery()" refers="\global\_prepMontgomery()"/>
          <tag line="2129" name="see" description="\global\_slidingWindow()" refers="\global\_slidingWindow()"/>
          <tag line="2129" name="access" description="private"/>
          <tag line="2129" name="param" description="" type="Array" variable="$x">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="2129" name="param" description="" type="Array" variable="$n">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="2129" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
        </docblock>
        <argument line="2144">
          <name>$x</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2144">
          <name>$n</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2192" package="Math\BigInteger">
        <name>_montgomeryMultiply</name>
        <full_name>_montgomeryMultiply</full_name>
        <docblock line="2178">
          <description><![CDATA[Montgomery Multiply]]></description>
          <long-description><![CDATA[<p>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}</p>]]></long-description>
          <tag line="2178" name="see" description="\global\_prepMontgomery()" refers="\global\_prepMontgomery()"/>
          <tag line="2178" name="see" description="\global\_montgomery()" refers="\global\_montgomery()"/>
          <tag line="2178" name="access" description="private"/>
          <tag line="2178" name="param" description="" type="Array" variable="$x">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="2178" name="param" description="" type="Array" variable="$y">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="2178" name="param" description="" type="Array" variable="$m">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="2178" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
        </docblock>
        <argument line="2192">
          <name>$x</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2192">
          <name>$y</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2192">
          <name>$m</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2238" package="Math\BigInteger">
        <name>_prepMontgomery</name>
        <full_name>_prepMontgomery</full_name>
        <docblock line="2228">
          <description><![CDATA[Prepare a number for use in Montgomery Modular Reductions]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2228" name="see" description="\global\_montgomery()" refers="\global\_montgomery()"/>
          <tag line="2228" name="see" description="\global\_slidingWindow()" refers="\global\_slidingWindow()"/>
          <tag line="2228" name="access" description="private"/>
          <tag line="2228" name="param" description="" type="Array" variable="$x">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="2228" name="param" description="" type="Array" variable="$n">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="2228" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
        </docblock>
        <argument line="2238">
          <name>$x</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2238">
          <name>$n</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2275" package="Math\BigInteger">
        <name>_modInverse67108864</name>
        <full_name>_modInverse67108864</full_name>
        <docblock line="2249">
          <description><![CDATA[Modular Inverse of a number mod 2**26 (eg.]]></description>
          <long-description><![CDATA[<p>67108864)</p>

<p>Based off of the bnpInvDigit function implemented and justified in the following URL:</p>

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

<p>The following URL provides more info:</p>

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

<p>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.</p>

<p>Thanks to Pedro Gimeno Fortea for input!</p>]]></long-description>
          <tag line="2249" name="see" description="\global\_montgomery()" refers="\global\_montgomery()"/>
          <tag line="2249" name="access" description="private"/>
          <tag line="2249" name="param" description="" type="Array" variable="$x">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="2249" name="return" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
        </docblock>
        <argument line="2275">
          <name>$x</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2315" package="Math\BigInteger">
        <name>modInverse</name>
        <full_name>modInverse</full_name>
        <docblock line="2286">
          <description><![CDATA[Calculates modular inverses.]]></description>
          <long-description><![CDATA[<p>Say you have (30 mod 17 * x mod 17) mod 17 == 1.  x can be found using modular inverses.</p>

<p>Here's an example:</p>

<pre><code><?php
   include('Math/BigInteger.php');

   $a = new Math_BigInteger(30);
   $b = new Math_BigInteger(17);

   $c = $a->modInverse($b);
   echo $c->toString(); // outputs 4

   echo "\r\n";

   $d = $a->multiply($c);
   list(, $d) = $d->divide($b);
   echo $d; // outputs 1 (as per the definition of modular inverse)
?>
</code></pre>]]></long-description>
          <tag line="2286" name="param" description="" type="\Math_BigInteger" variable="$n">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="2286" name="return" description="false, if no modular inverse exists, Math_BigInteger, otherwise." type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="2286" name="access" description="public"/>
          <tag line="2286" name="internal" description="See {@link http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf#page=21 HAC 14.64} for more information."/>
        </docblock>
        <argument line="2315">
          <name>$n</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2381" package="Math\BigInteger">
        <name>extendedGCD</name>
        <full_name>extendedGCD</full_name>
        <docblock line="2351">
          <description><![CDATA[]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="2381">
          <name>$n</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2512" package="Math\BigInteger">
        <name>gcd</name>
        <full_name>gcd</full_name>
        <docblock line="2489">
          <description><![CDATA[Calculates the greatest common divisor]]></description>
          <long-description><![CDATA[<p>Say you have 693 and 609.  The GCD is 21.</p>

<p>Here's an example:</p>

<pre><code><?php
   include('Math/BigInteger.php');

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

   $gcd = a->extendedGCD($b);

   echo $gcd->toString() . "\r\n"; // outputs 21
?>
</code></pre>]]></long-description>
          <tag line="2489" name="param" description="" type="\Math_BigInteger" variable="$n">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="2489" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="2489" name="access" description="public"/>
        </docblock>
        <argument line="2512">
          <name>$n</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2524" package="Math\BigInteger">
        <name>abs</name>
        <full_name>abs</full_name>
        <docblock line="2518">
          <description><![CDATA[Absolute value.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2518" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="2518" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2560" package="Math\BigInteger">
        <name>compare</name>
        <full_name>compare</full_name>
        <docblock line="2542">
          <description><![CDATA[Compares two numbers.]]></description>
          <long-description><![CDATA[<p>Although one might think !$x->compare($y) means $x != $y, it, in fact, means the opposite.  The reason for this is
demonstrated thusly:</p>

<p>$x  > $y: $x->compare($y)  > 0
$x  &lt; $y: $x->compare($y)  &lt; 0
$x == $y: $x->compare($y) == 0</p>

<p>Note how the same comparison operator is used.  If you want to test for equality, use $x->equals($y).</p>]]></long-description>
          <tag line="2542" name="param" description="" type="\Math_BigInteger" variable="$x">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="2542" name="return" description="&lt; 0 if $this is less than $x; &gt; 0 if $this is greater than $x, and 0 if they are equal." type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="2542" name="access" description="public"/>
          <tag line="2542" name="see" description="\global\equals()" refers="\global\equals()"/>
          <tag line="2542" name="internal" description="Could return $this-&gt;subtract($x), but that's not as fast as what we do do."/>
        </docblock>
        <argument line="2560">
          <name>$y</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2583" package="Math\BigInteger">
        <name>_compare</name>
        <full_name>_compare</full_name>
        <docblock line="2572">
          <description><![CDATA[Compares two numbers.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2572" name="param" description="" type="Array" variable="$x_value">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="2572" name="param" description="" type="Boolean" variable="$x_negative">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="2572" name="param" description="" type="Array" variable="$y_value">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="2572" name="param" description="" type="Boolean" variable="$y_negative">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="2572" name="return" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="2572" name="see" description="\global\compare()" refers="\global\compare()"/>
          <tag line="2572" name="access" description="private"/>
        </docblock>
        <argument line="2583">
          <name>$x_value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2583">
          <name>$x_negative</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2583">
          <name>$y_value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2583">
          <name>$y_negative</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2618" package="Math\BigInteger">
        <name>equals</name>
        <full_name>equals</full_name>
        <docblock line="2608">
          <description><![CDATA[Tests the equality of two numbers.]]></description>
          <long-description><![CDATA[<p>If you need to see if one number is greater than or less than another number, use Math_BigInteger::compare()</p>]]></long-description>
          <tag line="2608" name="param" description="" type="\Math_BigInteger" variable="$x">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="2608" name="return" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="2608" name="access" description="public"/>
          <tag line="2608" name="see" description="\global\compare()" refers="\global\compare()"/>
        </docblock>
        <argument line="2618">
          <name>$x</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2638" package="Math\BigInteger">
        <name>setPrecision</name>
        <full_name>setPrecision</full_name>
        <docblock line="2628">
          <description><![CDATA[Set Precision]]></description>
          <long-description><![CDATA[<p>Some bitwise operations give different results depending on the precision being used.  Examples include left
shift, not, and rotates.</p>]]></long-description>
          <tag line="2628" name="param" description="" type="\Math_BigInteger" variable="$x">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="2628" name="access" description="public"/>
          <tag line="2628" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
        </docblock>
        <argument line="2638">
          <name>$bits</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2659" package="Math\BigInteger">
        <name>bitwise_and</name>
        <full_name>bitwise_and</full_name>
        <docblock line="2651">
          <description><![CDATA[Logical And]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2651" name="param" description="" type="\Math_BigInteger" variable="$x">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="2651" name="access" description="public"/>
          <tag line="2651" name="internal" description="Implemented per a request by Lluis Pamies i Juarez &lt;lluis _a_ pamies.cat&gt;"/>
          <tag line="2651" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
        </docblock>
        <argument line="2659">
          <name>$x</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2700" package="Math\BigInteger">
        <name>bitwise_or</name>
        <full_name>bitwise_or</full_name>
        <docblock line="2692">
          <description><![CDATA[Logical Or]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2692" name="param" description="" type="\Math_BigInteger" variable="$x">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="2692" name="access" description="public"/>
          <tag line="2692" name="internal" description="Implemented per a request by Lluis Pamies i Juarez &lt;lluis _a_ pamies.cat&gt;"/>
          <tag line="2692" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
        </docblock>
        <argument line="2700">
          <name>$x</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2740" package="Math\BigInteger">
        <name>bitwise_xor</name>
        <full_name>bitwise_xor</full_name>
        <docblock line="2732">
          <description><![CDATA[Logical Exclusive-Or]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2732" name="param" description="" type="\Math_BigInteger" variable="$x">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="2732" name="access" description="public"/>
          <tag line="2732" name="internal" description="Implemented per a request by Lluis Pamies i Juarez &lt;lluis _a_ pamies.cat&gt;"/>
          <tag line="2732" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
        </docblock>
        <argument line="2740">
          <name>$x</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2779" package="Math\BigInteger">
        <name>bitwise_not</name>
        <full_name>bitwise_not</full_name>
        <docblock line="2772">
          <description><![CDATA[Logical Not]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2772" name="access" description="public"/>
          <tag line="2772" name="internal" description="Implemented per a request by Lluis Pamies i Juarez &lt;lluis _a_ pamies.cat&gt;"/>
          <tag line="2772" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2818" package="Math\BigInteger">
        <name>bitwise_rightShift</name>
        <full_name>bitwise_rightShift</full_name>
        <docblock line="2808">
          <description><![CDATA[Logical Right Shift]]></description>
          <long-description><![CDATA[<p>Shifts BigInteger's by $shift bits, effectively dividing by 2**$shift.</p>]]></long-description>
          <tag line="2808" name="param" description="" type="Integer" variable="$shift">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="2808" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="2808" name="access" description="public"/>
          <tag line="2808" name="internal" description="The only version that yields any speed increases is the internal version."/>
        </docblock>
        <argument line="2818">
          <name>$shift</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2856" package="Math\BigInteger">
        <name>bitwise_leftShift</name>
        <full_name>bitwise_leftShift</full_name>
        <docblock line="2846">
          <description><![CDATA[Logical Left Shift]]></description>
          <long-description><![CDATA[<p>Shifts BigInteger's by $shift bits, effectively multiplying by 2**$shift.</p>]]></long-description>
          <tag line="2846" name="param" description="" type="Integer" variable="$shift">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="2846" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="2846" name="access" description="public"/>
          <tag line="2846" name="internal" description="The only version that yields any speed increases is the internal version."/>
        </docblock>
        <argument line="2856">
          <name>$shift</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2893" package="Math\BigInteger">
        <name>bitwise_leftRotate</name>
        <full_name>bitwise_leftRotate</full_name>
        <docblock line="2884">
          <description><![CDATA[Logical Left Rotate]]></description>
          <long-description><![CDATA[<p>Instead of the top x bits being dropped they're appended to the shifted bit string.</p>]]></long-description>
          <tag line="2884" name="param" description="" type="Integer" variable="$shift">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="2884" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="2884" name="access" description="public"/>
        </docblock>
        <argument line="2893">
          <name>$shift</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2937" package="Math\BigInteger">
        <name>bitwise_rightRotate</name>
        <full_name>bitwise_rightRotate</full_name>
        <docblock line="2928">
          <description><![CDATA[Logical Right Rotate]]></description>
          <long-description><![CDATA[<p>Instead of the bottom x bits being dropped they're prepended to the shifted bit string.</p>]]></long-description>
          <tag line="2928" name="param" description="" type="Integer" variable="$shift">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="2928" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="2928" name="access" description="public"/>
        </docblock>
        <argument line="2937">
          <name>$shift</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2956" package="Math\BigInteger">
        <name>setRandomGenerator</name>
        <full_name>setRandomGenerator</full_name>
        <docblock line="2942">
          <description><![CDATA[Set random number generator function]]></description>
          <long-description><![CDATA[<p>$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()</p>

<p>If the random generating function is not explicitly set, it'll be assumed to be mt_rand().</p>]]></long-description>
          <tag line="2942" name="see" description="\global\random()" refers="\global\random()"/>
          <tag line="2942" name="see" description="\global\randomPrime()" refers="\global\randomPrime()"/>
          <tag line="2942" name="param" description="String $generator" type="\optional" variable="$generator">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="2942" name="access" description="public"/>
        </docblock>
        <argument line="2956">
          <name>$generator</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2969" package="Math\BigInteger">
        <name>random</name>
        <full_name>random</full_name>
        <docblock line="2961">
          <description><![CDATA[Generate a random number]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2961" name="param" description="Integer $min" type="\optional" variable="$min">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="2961" name="param" description="Integer $max" type="\optional" variable="$max">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="2961" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="2961" name="access" description="public"/>
        </docblock>
        <argument line="2969">
          <name>$min</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
        <argument line="2969">
          <name>$max</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="3033" package="Math\BigInteger">
        <name>randomPrime</name>
        <full_name>randomPrime</full_name>
        <docblock line="3020">
          <description><![CDATA[Generate a random prime number.]]></description>
          <long-description><![CDATA[<p>If there's not a prime within the given range, false will be returned.  If more than $timeout seconds have elapsed,
give up and return false.</p>]]></long-description>
          <tag line="3020" name="param" description="Integer $min" type="\optional" variable="$min">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="3020" name="param" description="Integer $max" type="\optional" variable="$max">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="3020" name="param" description="Integer $timeout" type="\optional" variable="$timeout">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="3020" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="3020" name="access" description="public"/>
          <tag line="3020" name="internal" description="See {@link http://www.cacr.math.uwaterloo.ca/hac/about/chap4.pdf#page=15 HAC 4.44}."/>
        </docblock>
        <argument line="3033">
          <name>$min</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
        <argument line="3033">
          <name>$max</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
        <argument line="3033">
          <name>$timeout</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="3134" package="Math\BigInteger">
        <name>_make_odd</name>
        <full_name>_make_odd</full_name>
        <docblock line="3126">
          <description><![CDATA[Make the current number odd]]></description>
          <long-description><![CDATA[<p>If the current number is odd it'll be unchanged.  If it's even, one will be added to it.</p>]]></long-description>
          <tag line="3126" name="see" description="\global\randomPrime()" refers="\global\randomPrime()"/>
          <tag line="3126" name="access" description="private"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="3164" package="Math\BigInteger">
        <name>isPrime</name>
        <full_name>isPrime</full_name>
        <docblock line="3150">
          <description><![CDATA[Checks a numer to see if it's prime]]></description>
          <long-description><![CDATA[<p>Assuming the $t parameter is not set, this function has an error rate of 2**-80.  The main motivation for the
$t parameter is distributability.  Math_BigInteger::randomPrime() can be distributed accross multiple pageloads
on a website instead of just one.</p>]]></long-description>
          <tag line="3150" name="param" description="Integer $t" type="\optional" variable="$t">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="3150" name="return" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="3150" name="access" description="public"/>
          <tag line="3150" name="internal" description="Uses the&#10;{@link http://en.wikipedia.org/wiki/Miller%E2%80%93Rabin_primality_test Miller-Rabin primality test}.  See&#10;{@link http://www.cacr.math.uwaterloo.ca/hac/about/chap4.pdf#page=8 HAC 4.24}."/>
        </docblock>
        <argument line="3164">
          <name>$t</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="3310" package="Math\BigInteger">
        <name>_lshift</name>
        <full_name>_lshift</full_name>
        <docblock line="3302">
          <description><![CDATA[Logical Left Shift]]></description>
          <long-description><![CDATA[<p>Shifts BigInteger's by $shift bits.</p>]]></long-description>
          <tag line="3302" name="param" description="" type="Integer" variable="$shift">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="3302" name="access" description="private"/>
        </docblock>
        <argument line="3310">
          <name>$shift</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="3345" package="Math\BigInteger">
        <name>_rshift</name>
        <full_name>_rshift</full_name>
        <docblock line="3337">
          <description><![CDATA[Logical Right Shift]]></description>
          <long-description><![CDATA[<p>Shifts BigInteger's by $shift bits.</p>]]></long-description>
          <tag line="3337" name="param" description="" type="Integer" variable="$shift">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="3337" name="access" description="private"/>
        </docblock>
        <argument line="3345">
          <name>$shift</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="3381" package="Math\BigInteger">
        <name>_normalize</name>
        <full_name>_normalize</full_name>
        <docblock line="3371">
          <description><![CDATA[Normalize]]></description>
          <long-description><![CDATA[<p>Removes leading zeros and truncates (if necessary) to maintain the appropriate precision</p>]]></long-description>
          <tag line="3371" name="param" description="Math_BigInteger" type="" variable="$result"/>
          <tag line="3371" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="3371" name="see" description="\global\_trim()" refers="\global\_trim()"/>
          <tag line="3371" name="access" description="private"/>
        </docblock>
        <argument line="3381">
          <name>$result</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="3429" package="Math\BigInteger">
        <name>_trim</name>
        <full_name>_trim</full_name>
        <docblock line="3421">
          <description><![CDATA[Trim]]></description>
          <long-description><![CDATA[<p>Removes leading zeros</p>]]></long-description>
          <tag line="3421" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="3421" name="access" description="private"/>
        </docblock>
        <argument line="3429">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="3449" package="Math\BigInteger">
        <name>_array_repeat</name>
        <full_name>_array_repeat</full_name>
        <docblock line="3441">
          <description><![CDATA[Array Repeat]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="3441" name="param" description="Array" type="\$input" variable="$input">
            <type by_reference="false">\$input</type>
          </tag>
          <tag line="3441" name="param" description="mixed" type="\$multiplier" variable="$multiplier">
            <type by_reference="false">\$multiplier</type>
          </tag>
          <tag line="3441" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="3441" name="access" description="private"/>
        </docblock>
        <argument line="3449">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="3449">
          <name>$multiplier</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="3464" package="Math\BigInteger">
        <name>_base256_lshift</name>
        <full_name>_base256_lshift</full_name>
        <docblock line="3454">
          <description><![CDATA[Logical Left Shift]]></description>
          <long-description><![CDATA[<p>Shifts binary strings $shift bits, essentially multiplying by 2**$shift.</p>]]></long-description>
          <tag line="3454" name="param" description="String" type="\$x" variable="$x">
            <type by_reference="false">\$x</type>
          </tag>
          <tag line="3454" name="param" description="Integer" type="\$shift" variable="$shift">
            <type by_reference="false">\$shift</type>
          </tag>
          <tag line="3454" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="3454" name="access" description="private"/>
        </docblock>
        <argument line="3464">
          <name>$x</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="3464">
          <name>$shift</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="3493" package="Math\BigInteger">
        <name>_base256_rshift</name>
        <full_name>_base256_rshift</full_name>
        <docblock line="3483">
          <description><![CDATA[Logical Right Shift]]></description>
          <long-description><![CDATA[<p>Shifts binary strings $shift bits, essentially dividing by 2**$shift and returning the remainder.</p>]]></long-description>
          <tag line="3483" name="param" description="String" type="\$x" variable="$x">
            <type by_reference="false">\$x</type>
          </tag>
          <tag line="3483" name="param" description="Integer" type="\$shift" variable="$shift">
            <type by_reference="false">\$shift</type>
          </tag>
          <tag line="3483" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="3483" name="access" description="private"/>
        </docblock>
        <argument line="3493">
          <name>$x</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="3493">
          <name>$shift</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="3534" package="Math\BigInteger">
        <name>_int2bytes</name>
        <full_name>_int2bytes</full_name>
        <docblock line="3527">
          <description><![CDATA[Converts 32-bit integers to bytes.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="3527" name="param" description="" type="Integer" variable="$x">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="3527" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="3527" name="access" description="private"/>
        </docblock>
        <argument line="3534">
          <name>$x</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="3546" package="Math\BigInteger">
        <name>_bytes2int</name>
        <full_name>_bytes2int</full_name>
        <docblock line="3539">
          <description><![CDATA[Converts bytes to 32-bit integers]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="3539" name="param" description="" type="String" variable="$x">
            <type by_reference="false">String</type>
          </tag>
          <tag line="3539" name="return" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="3539" name="access" description="private"/>
        </docblock>
        <argument line="3546">
          <name>$x</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <parse_markers>
      <error line="2052" code="50015">Argument $stop is missing from the Docblock of _multiplyLower()</error>
      <error line="2351" code="50012">No short description for method extendedGCD()</error>
      <error line="2351" code="50015">Argument $n is missing from the Docblock of extendedGCD()</error>
      <error line="2542" code="50014">Name of argument $y does not match with the DocBlock's name $x in compare()</error>
      <notice line="2542" code="50013">Parameter $x could not be found in compare()</notice>
      <error line="2628" code="50014">Name of argument $bits does not match with the DocBlock's name $x in setPrecision()</error>
      <notice line="2628" code="50013">Parameter $x could not be found in setPrecision()</notice>
      <error line="3421" code="50015">Argument $value is missing from the Docblock of _trim()</error>
    </parse_markers>
  </file>
  <file path="lib/3rdParty/phpseclib/Crypt/RSA.php" hash="a09946ef8877e3df4470fbba3e49467f" package="Crypt\RSA">
    <docblock line="4">
      <description><![CDATA[Pure-PHP PKCS#1 (v2.1) compliant implementation of RSA.]]></description>
      <long-description><![CDATA[<p>PHP versions 4 and 5</p>

<p>Here's an example of how to encrypt and decrypt text with this library:</p>

<pre><code><?php
   include('Crypt/RSA.php');

   $rsa = new Crypt_RSA();
   extract($rsa->createKey());

   $plaintext = 'terrafrost';

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

   $rsa->loadKey($publickey);
   echo $rsa->decrypt($ciphertext);
?>
</code></pre>

<p>Here's an example of how to create signatures and verify signatures with this library:</p>

<pre><code><?php
   include('Crypt/RSA.php');

   $rsa = new Crypt_RSA();
   extract($rsa->createKey());

   $plaintext = 'terrafrost';

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

   $rsa->loadKey($publickey);
   echo $rsa->verify($plaintext, $signature) ? 'verified' : 'unverified';
?>
</code></pre>

<p>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:</p>

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

<p>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.</p>]]></long-description>
      <tag line="4" name="category" description="Crypt"/>
      <tag line="4" name="package" description="Crypt_RSA"/>
      <tag line="4" name="author" description="Jim Wigginton &lt;terrafrost@php.net&gt;"/>
      <tag line="4" name="copyright" description="MMIX Jim Wigginton"/>
      <tag line="4" name="license" description="http://www.opensource.org/licenses/mit-license.html  MIT License"/>
      <tag line="4" name="version" description="$Id: RSA.php 4105 2011-05-19 18:02:11Z gruberroland $"/>
      <tag line="4" name="link" description="http://phpseclib.sourceforge.net" link="http://phpseclib.sourceforge.net"/>
    </docblock>
    <include line="75" type="Require Once" package="main">
      <name>Math/BigInteger.php</name>
      <docblock line="72">
        <description><![CDATA[Include Math_BigInteger]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="80" type="Require Once" package="main">
      <name>Crypt/Random.php</name>
      <docblock line="77">
        <description><![CDATA[Include Crypt_Random]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="85" type="Require Once" package="main">
      <name>Crypt/Hash.php</name>
      <docblock line="82">
        <description><![CDATA[Include Crypt_Hash]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="684" type="Require Once" package="main">
      <name>Crypt/TripleDES.php</name>
    </include>
    <include line="829" type="Require Once" package="main">
      <name>Crypt/AES.php</name>
    </include>
    <include line="836" type="Require Once" package="main">
      <name>Crypt/TripleDES.php</name>
    </include>
    <include line="842" type="Require Once" package="main">
      <name>Crypt/TripleDES.php</name>
    </include>
    <include line="848" type="Require Once" package="main">
      <name>Crypt/DES.php</name>
    </include>
    <include line="1028" type="Require Once" package="main">
      <name>Crypt/AES.php</name>
    </include>
    <constant namespace="global" line="101" package="Crypt\RSA">
      <name>CRYPT_RSA_ENCRYPTION_OAEP</name>
      <full_name>\CRYPT_RSA_ENCRYPTION_OAEP</full_name>
      <value><![CDATA[1]]></value>
      <docblock line="92">
        <description><![CDATA[Use {@link http://en.wikipedia.org/wiki/Optimal_Asymmetric_Encryption_Padding Optimal Asymmetric Encryption Padding}
(OAEP) for encryption / decryption.]]></description>
        <long-description><![CDATA[<p>Uses sha1 by default.</p>]]></long-description>
        <tag line="92" name="see" description="\global\Crypt_RSA::setHash()" refers="\global\Crypt_RSA::setHash()"/>
        <tag line="92" name="see" description="\global\Crypt_RSA::setMGFHash()" refers="\global\Crypt_RSA::setMGFHash()"/>
      </docblock>
    </constant>
    <constant namespace="global" line="108" package="Crypt\RSA">
      <name>CRYPT_RSA_ENCRYPTION_PKCS1</name>
      <full_name>\CRYPT_RSA_ENCRYPTION_PKCS1</full_name>
      <value><![CDATA[2]]></value>
      <docblock line="102">
        <description><![CDATA[Use PKCS#1 padding.]]></description>
        <long-description><![CDATA[<p>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.</p>]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="125" package="Crypt\RSA">
      <name>CRYPT_RSA_SIGNATURE_PSS</name>
      <full_name>\CRYPT_RSA_SIGNATURE_PSS</full_name>
      <value><![CDATA[1]]></value>
      <docblock line="117">
        <description><![CDATA[Use the Probabilistic Signature Scheme for signing]]></description>
        <long-description><![CDATA[<p>Uses sha1 by default.</p>]]></long-description>
        <tag line="117" name="see" description="\global\Crypt_RSA::setSaltLength()" refers="\global\Crypt_RSA::setSaltLength()"/>
        <tag line="117" name="see" description="\global\Crypt_RSA::setMGFHash()" refers="\global\Crypt_RSA::setMGFHash()"/>
      </docblock>
    </constant>
    <constant namespace="global" line="132" package="Crypt\RSA">
      <name>CRYPT_RSA_SIGNATURE_PKCS1</name>
      <full_name>\CRYPT_RSA_SIGNATURE_PKCS1</full_name>
      <value><![CDATA[2]]></value>
      <docblock line="126">
        <description><![CDATA[Use the PKCS#1 scheme by default.]]></description>
        <long-description><![CDATA[<p>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.</p>]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="142" package="Crypt\RSA">
      <name>CRYPT_RSA_ASN1_INTEGER</name>
      <full_name>\CRYPT_RSA_ASN1_INTEGER</full_name>
      <value><![CDATA[2]]></value>
      <docblock line="139">
        <description><![CDATA[ASN1 Integer]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="146" package="Crypt\RSA">
      <name>CRYPT_RSA_ASN1_SEQUENCE</name>
      <full_name>\CRYPT_RSA_ASN1_SEQUENCE</full_name>
      <value><![CDATA[48]]></value>
      <docblock line="143">
        <description><![CDATA[ASN1 Sequence (with the constucted bit set)]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="156" package="Crypt\RSA">
      <name>CRYPT_RSA_MODE_INTERNAL</name>
      <full_name>\CRYPT_RSA_MODE_INTERNAL</full_name>
      <value><![CDATA[1]]></value>
      <docblock line="153">
        <description><![CDATA[To use the pure-PHP implementation]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="162" package="Crypt\RSA">
      <name>CRYPT_RSA_MODE_OPENSSL</name>
      <full_name>\CRYPT_RSA_MODE_OPENSSL</full_name>
      <value><![CDATA[2]]></value>
      <docblock line="157">
        <description><![CDATA[To use the OpenSSL library]]></description>
        <long-description><![CDATA[<p>(if enabled; otherwise, the internal implementation will be used)</p>]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="175" package="Crypt\RSA">
      <name>CRYPT_RSA_PRIVATE_FORMAT_PKCS1</name>
      <full_name>\CRYPT_RSA_PRIVATE_FORMAT_PKCS1</full_name>
      <value><![CDATA[0]]></value>
      <docblock line="170">
        <description><![CDATA[PKCS#1 formatted private key]]></description>
        <long-description><![CDATA[<p>Used by OpenSSH</p>]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="179" package="Crypt\RSA">
      <name>CRYPT_RSA_PRIVATE_FORMAT_PUTTY</name>
      <full_name>\CRYPT_RSA_PRIVATE_FORMAT_PUTTY</full_name>
      <value><![CDATA[1]]></value>
      <docblock line="176">
        <description><![CDATA[PuTTY formatted private key]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="183" package="Crypt\RSA">
      <name>CRYPT_RSA_PRIVATE_FORMAT_XML</name>
      <full_name>\CRYPT_RSA_PRIVATE_FORMAT_XML</full_name>
      <value><![CDATA[2]]></value>
      <docblock line="180">
        <description><![CDATA[XML formatted private key]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="204" package="Crypt\RSA">
      <name>CRYPT_RSA_PUBLIC_FORMAT_RAW</name>
      <full_name>\CRYPT_RSA_PUBLIC_FORMAT_RAW</full_name>
      <value><![CDATA[3]]></value>
      <docblock line="191">
        <description><![CDATA[Raw public key]]></description>
        <long-description><![CDATA[<p>An array containing two Math_BigInteger objects.</p>

<p>The exponent can be indexed with any of the following:</p>

<p>0, e, exponent, publicExponent</p>

<p>The modulus can be indexed with any of the following:</p>

<p>1, n, modulo, modulus</p>]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="208" package="Crypt\RSA">
      <name>CRYPT_RSA_PUBLIC_FORMAT_PKCS1</name>
      <full_name>\CRYPT_RSA_PUBLIC_FORMAT_PKCS1</full_name>
      <value><![CDATA[4]]></value>
      <docblock line="205">
        <description><![CDATA[PKCS#1 formatted public key]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="212" package="Crypt\RSA">
      <name>CRYPT_RSA_PUBLIC_FORMAT_XML</name>
      <full_name>\CRYPT_RSA_PUBLIC_FORMAT_XML</full_name>
      <value><![CDATA[5]]></value>
      <docblock line="209">
        <description><![CDATA[XML formatted public key]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="218" package="Crypt\RSA">
      <name>CRYPT_RSA_PUBLIC_FORMAT_OPENSSH</name>
      <full_name>\CRYPT_RSA_PUBLIC_FORMAT_OPENSSH</full_name>
      <value><![CDATA[6]]></value>
      <docblock line="213">
        <description><![CDATA[OpenSSH formatted public key]]></description>
        <long-description><![CDATA[<p>Place in $HOME/.ssh/authorized_keys</p>]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="432" package="Crypt\RSA">
      <name>CRYPT_RSA_MODE</name>
      <full_name>\CRYPT_RSA_MODE</full_name>
      <value><![CDATA[CRYPT_RSA_MODE_INTERNAL]]></value>
    </constant>
    <constant namespace="global" line="484" package="Crypt\RSA">
      <name>CRYPT_RSA_EXPONENT</name>
      <full_name>\CRYPT_RSA_EXPONENT</full_name>
      <value><![CDATA['65537']]></value>
    </constant>
    <constant namespace="global" line="487" package="Crypt\RSA">
      <name>CRYPT_RSA_COMMENT</name>
      <full_name>\CRYPT_RSA_COMMENT</full_name>
      <value><![CDATA['phpseclib-generated-key']]></value>
    </constant>
    <constant namespace="global" line="492" package="Crypt\RSA">
      <name>CRYPT_RSA_SMALLEST_PRIME</name>
      <full_name>\CRYPT_RSA_SMALLEST_PRIME</full_name>
      <value><![CDATA[4096]]></value>
    </constant>
    <class final="false" abstract="false" namespace="global" line="229" package="Crypt\RSA">
      <extends/>
      <name>Crypt_RSA</name>
      <full_name>\Crypt_RSA</full_name>
      <docblock line="221">
        <description><![CDATA[Pure-PHP PKCS#1 compliant implementation of RSA.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="221" name="author" description="Jim Wigginton &lt;terrafrost@php.net&gt;"/>
        <tag line="221" name="version" description="0.1.0"/>
        <tag line="221" name="access" description="public"/>
        <tag line="221" name="package" description="Crypt_RSA"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="236" namespace="global" package="main">
        <name>$zero</name>
        <default><![CDATA[]]></default>
        <docblock line="230">
          <description><![CDATA[Precomputed Zero]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="230" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="230" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="244" namespace="global" package="main">
        <name>$one</name>
        <default><![CDATA[]]></default>
        <docblock line="238">
          <description><![CDATA[Precomputed One]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="238" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="238" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="252" namespace="global" package="main">
        <name>$privateKeyFormat</name>
        <default><![CDATA[CRYPT_RSA_PRIVATE_FORMAT_PKCS1]]></default>
        <docblock line="246">
          <description><![CDATA[Private Key Format]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="246" name="var" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="246" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="260" namespace="global" package="main">
        <name>$publicKeyFormat</name>
        <default><![CDATA[CRYPT_RSA_PUBLIC_FORMAT_PKCS1]]></default>
        <docblock line="254">
          <description><![CDATA[Public Key Format]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="254" name="var" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="254" name="access" description="public"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="268" namespace="global" package="main">
        <name>$modulus</name>
        <default><![CDATA[]]></default>
        <docblock line="262">
          <description><![CDATA[Modulus (ie.]]></description>
          <long-description><![CDATA[<p>n)</p>]]></long-description>
          <tag line="262" name="var" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="262" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="276" namespace="global" package="main">
        <name>$k</name>
        <default><![CDATA[]]></default>
        <docblock line="270">
          <description><![CDATA[Modulus length]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="270" name="var" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="270" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="284" namespace="global" package="main">
        <name>$exponent</name>
        <default><![CDATA[]]></default>
        <docblock line="278">
          <description><![CDATA[Exponent (ie.]]></description>
          <long-description><![CDATA[<p>e or d)</p>]]></long-description>
          <tag line="278" name="var" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="278" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="292" namespace="global" package="main">
        <name>$primes</name>
        <default><![CDATA[]]></default>
        <docblock line="286">
          <description><![CDATA[Primes for Chinese Remainder Theorem (ie.]]></description>
          <long-description><![CDATA[<p>p and q)</p>]]></long-description>
          <tag line="286" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="286" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="300" namespace="global" package="main">
        <name>$exponents</name>
        <default><![CDATA[]]></default>
        <docblock line="294">
          <description><![CDATA[Exponents for Chinese Remainder Theorem (ie.]]></description>
          <long-description><![CDATA[<p>dP and dQ)</p>]]></long-description>
          <tag line="294" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="294" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="308" namespace="global" package="main">
        <name>$coefficients</name>
        <default><![CDATA[]]></default>
        <docblock line="302">
          <description><![CDATA[Coefficients for Chinese Remainder Theorem (ie.]]></description>
          <long-description><![CDATA[<p>qInv)</p>]]></long-description>
          <tag line="302" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="302" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="316" namespace="global" package="main">
        <name>$hashName</name>
        <default><![CDATA[]]></default>
        <docblock line="310">
          <description><![CDATA[Hash name]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="310" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="310" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="324" namespace="global" package="main">
        <name>$hash</name>
        <default><![CDATA[]]></default>
        <docblock line="318">
          <description><![CDATA[Hash function]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="318" name="var" description="" type="\Crypt_Hash">
            <type by_reference="false">\Crypt_Hash</type>
          </tag>
          <tag line="318" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="332" namespace="global" package="main">
        <name>$hLen</name>
        <default><![CDATA[]]></default>
        <docblock line="326">
          <description><![CDATA[Length of hash function output]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="326" name="var" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="326" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="340" namespace="global" package="main">
        <name>$sLen</name>
        <default><![CDATA[]]></default>
        <docblock line="334">
          <description><![CDATA[Length of salt]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="334" name="var" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="334" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="348" namespace="global" package="main">
        <name>$mgfHash</name>
        <default><![CDATA[]]></default>
        <docblock line="342">
          <description><![CDATA[Hash function for the Mask Generation Function]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="342" name="var" description="" type="\Crypt_Hash">
            <type by_reference="false">\Crypt_Hash</type>
          </tag>
          <tag line="342" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="356" namespace="global" package="main">
        <name>$mgfHLen</name>
        <default><![CDATA[]]></default>
        <docblock line="350">
          <description><![CDATA[Length of MGF hash function output]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="350" name="var" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="350" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="364" namespace="global" package="main">
        <name>$encryptionMode</name>
        <default><![CDATA[CRYPT_RSA_ENCRYPTION_OAEP]]></default>
        <docblock line="358">
          <description><![CDATA[Encryption mode]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="358" name="var" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="358" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="372" namespace="global" package="main">
        <name>$signatureMode</name>
        <default><![CDATA[CRYPT_RSA_SIGNATURE_PSS]]></default>
        <docblock line="366">
          <description><![CDATA[Signature mode]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="366" name="var" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="366" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="380" namespace="global" package="main">
        <name>$publicExponent</name>
        <default><![CDATA[false]]></default>
        <docblock line="374">
          <description><![CDATA[Public Exponent]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="374" name="var" description="" type="Mixed">
            <type by_reference="false">Mixed</type>
          </tag>
          <tag line="374" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="388" namespace="global" package="main">
        <name>$password</name>
        <default><![CDATA['']]></default>
        <docblock line="382">
          <description><![CDATA[Password]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="382" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="382" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="400" namespace="global" package="main">
        <name>$components</name>
        <default><![CDATA[array()]]></default>
        <docblock line="390">
          <description><![CDATA[Components]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="390" name="see" description="\global\Crypt_RSA::_start_element_handler()" refers="\global\Crypt_RSA::_start_element_handler()"/>
          <tag line="390" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="390" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="412" namespace="global" package="main">
        <name>$current</name>
        <default><![CDATA[]]></default>
        <docblock line="402">
          <description><![CDATA[Current String]]></description>
          <long-description><![CDATA[<p>For use with parsing XML formatted keys.</p>]]></long-description>
          <tag line="402" name="see" description="\global\Crypt_RSA::_character_handler()" refers="\global\Crypt_RSA::_character_handler()"/>
          <tag line="402" name="see" description="\global\Crypt_RSA::_stop_element_handler()" refers="\global\Crypt_RSA::_stop_element_handler()"/>
          <tag line="402" name="var" description="" type="Mixed">
            <type by_reference="false">Mixed</type>
          </tag>
          <tag line="402" name="access" description="private"/>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="424" package="Crypt\RSA">
        <name>Crypt_RSA</name>
        <full_name>Crypt_RSA</full_name>
        <docblock line="414">
          <description><![CDATA[The constructor]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="414" name="return" description="" type="\Crypt_RSA">
            <type by_reference="false">\Crypt_RSA</type>
          </tag>
          <tag line="414" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="460" package="Crypt\RSA">
        <name>createKey</name>
        <full_name>createKey</full_name>
        <docblock line="446">
          <description><![CDATA[Create public / private key pair]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="446" name="access" description="public"/>
          <tag line="446" name="param" description="Integer $bits" type="\optional" variable="$bits">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="446" name="param" description="Integer $timeout" type="\optional" variable="$timeout">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="446" name="param" description="Math_BigInteger $p" type="\optional" variable="$partial">
            <type by_reference="false">\optional</type>
          </tag>
        </docblock>
        <argument line="460">
          <name>$bits</name>
          <default><![CDATA[1024]]></default>
          <type/>
        </argument>
        <argument line="460">
          <name>$timeout</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
        <argument line="460">
          <name>$partial</name>
          <default><![CDATA[array()]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="633" package="Crypt\RSA">
        <name>_convertPrivateKey</name>
        <full_name>_convertPrivateKey</full_name>
        <docblock line="625">
          <description><![CDATA[Convert a private key to the appropriate format.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="625" name="access" description="private"/>
          <tag line="625" name="see" description="\global\setPrivateKeyFormat()" refers="\global\setPrivateKeyFormat()"/>
          <tag line="625" name="param" description="" type="String" variable="$RSAPrivateKey">
            <type by_reference="false">String</type>
          </tag>
          <tag line="625" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="633">
          <name>$n</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="633">
          <name>$e</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="633">
          <name>$d</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="633">
          <name>$primes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="633">
          <name>$exponents</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="633">
          <name>$coefficients</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="714" package="Crypt\RSA">
        <name>_convertPublicKey</name>
        <full_name>_convertPublicKey</full_name>
        <docblock line="706">
          <description><![CDATA[Convert a public key to the appropriate format]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="706" name="access" description="private"/>
          <tag line="706" name="see" description="\global\setPublicKeyFormat()" refers="\global\setPublicKeyFormat()"/>
          <tag line="706" name="param" description="" type="String" variable="$RSAPrivateKey">
            <type by_reference="false">String</type>
          </tag>
          <tag line="706" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="714">
          <name>$n</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="714">
          <name>$e</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="765" package="Crypt\RSA">
        <name>_parseKey</name>
        <full_name>_parseKey</full_name>
        <docblock line="755">
          <description><![CDATA[Break a public or private key down into its constituant components]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="755" name="access" description="private"/>
          <tag line="755" name="see" description="\global\_convertPublicKey()" refers="\global\_convertPublicKey()"/>
          <tag line="755" name="see" description="\global\_convertPrivateKey()" refers="\global\_convertPrivateKey()"/>
          <tag line="755" name="param" description="" type="String" variable="$key">
            <type by_reference="false">String</type>
          </tag>
          <tag line="755" name="param" description="" type="Integer" variable="$type">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="755" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
        </docblock>
        <argument line="765">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="765">
          <name>$type</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1078" package="Crypt\RSA">
        <name>_start_element_handler</name>
        <full_name>_start_element_handler</full_name>
        <docblock line="1068">
          <description><![CDATA[Start Element Handler]]></description>
          <long-description><![CDATA[<p>Called by xml_set_element_handler()</p>]]></long-description>
          <tag line="1068" name="access" description="private"/>
          <tag line="1068" name="param" description="" type="Resource" variable="$parser">
            <type by_reference="false">Resource</type>
          </tag>
          <tag line="1068" name="param" description="" type="String" variable="$name">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1068" name="param" description="" type="Array" variable="$attribs">
            <type by_reference="false">Array</type>
          </tag>
        </docblock>
        <argument line="1078">
          <name>$parser</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1078">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1078">
          <name>$attribs</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1121" package="Crypt\RSA">
        <name>_stop_element_handler</name>
        <full_name>_stop_element_handler</full_name>
        <docblock line="1112">
          <description><![CDATA[Stop Element Handler]]></description>
          <long-description><![CDATA[<p>Called by xml_set_element_handler()</p>]]></long-description>
          <tag line="1112" name="access" description="private"/>
          <tag line="1112" name="param" description="" type="Resource" variable="$parser">
            <type by_reference="false">Resource</type>
          </tag>
          <tag line="1112" name="param" description="" type="String" variable="$name">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1121">
          <name>$parser</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1121">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1139" package="Crypt\RSA">
        <name>_data_handler</name>
        <full_name>_data_handler</full_name>
        <docblock line="1130">
          <description><![CDATA[Data Handler]]></description>
          <long-description><![CDATA[<p>Called by xml_set_character_data_handler()</p>]]></long-description>
          <tag line="1130" name="access" description="private"/>
          <tag line="1130" name="param" description="" type="Resource" variable="$parser">
            <type by_reference="false">Resource</type>
          </tag>
          <tag line="1130" name="param" description="" type="String" variable="$data">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1139">
          <name>$parser</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1139">
          <name>$data</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1156" package="Crypt\RSA">
        <name>loadKey</name>
        <full_name>loadKey</full_name>
        <docblock line="1147">
          <description><![CDATA[Loads a public or private key]]></description>
          <long-description><![CDATA[<p>Returns true on success and false on failure (ie. an incorrect password was provided or the key was malformed)</p>]]></long-description>
          <tag line="1147" name="access" description="public"/>
          <tag line="1147" name="param" description="" type="String" variable="$key">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1147" name="param" description="optional" type="Integer" variable="$type">
            <type by_reference="false">Integer</type>
          </tag>
        </docblock>
        <argument line="1156">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1156">
          <name>$type</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1210" package="Crypt\RSA">
        <name>setPassword</name>
        <full_name>setPassword</full_name>
        <docblock line="1199">
          <description><![CDATA[Sets the password]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="1199" name="see" description="\global\createKey()" refers="\global\createKey()"/>
          <tag line="1199" name="see" description="\global\loadKey()" refers="\global\loadKey()"/>
          <tag line="1199" name="access" description="public"/>
          <tag line="1199" name="param" description="" type="String" variable="$password">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1210">
          <name>$password</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1234" package="Crypt\RSA">
        <name>setPublicKey</name>
        <full_name>setPublicKey</full_name>
        <docblock line="1215">
          <description><![CDATA[Defines the public key]]></description>
          <long-description><![CDATA[<p>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.</p>

<p>Do note that when a new key is loaded the index will be cleared.</p>

<p>Returns true on success, false on failure</p>]]></long-description>
          <tag line="1215" name="see" description="\global\getPublicKey()" refers="\global\getPublicKey()"/>
          <tag line="1215" name="access" description="public"/>
          <tag line="1215" name="param" description="" type="String" variable="$key">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1215" name="param" description="optional" type="Integer" variable="$type">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="1215" name="return" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
        </docblock>
        <argument line="1234">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1234">
          <name>$type</name>
          <default><![CDATA[CRYPT_RSA_PUBLIC_FORMAT_PKCS1]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1260" package="Crypt\RSA">
        <name>getPublicKey</name>
        <full_name>getPublicKey</full_name>
        <docblock line="1248">
          <description><![CDATA[Returns the public key]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="1248" name="see" description="\global\getPublicKey()" refers="\global\getPublicKey()"/>
          <tag line="1248" name="access" description="public"/>
          <tag line="1248" name="param" description="" type="String" variable="$key">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1248" name="param" description="optional" type="Integer" variable="$type">
            <type by_reference="false">Integer</type>
          </tag>
        </docblock>
        <argument line="1260">
          <name>$type</name>
          <default><![CDATA[CRYPT_RSA_PUBLIC_FORMAT_PKCS1]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1280" package="Crypt\RSA">
        <name>_generateMinMax</name>
        <full_name>_generateMinMax</full_name>
        <docblock line="1273">
          <description><![CDATA[Generates the smallest and largest numbers requiring $bits bits]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1273" name="access" description="private"/>
          <tag line="1273" name="param" description="" type="Integer" variable="$bits">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="1273" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
        </docblock>
        <argument line="1280">
          <name>$bits</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1309" package="Crypt\RSA">
        <name>_decodeLength</name>
        <full_name>_decodeLength</full_name>
        <docblock line="1299">
          <description><![CDATA[]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="1309">
          <name>$string</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1330" package="Crypt\RSA">
        <name>_encodeLength</name>
        <full_name>_encodeLength</full_name>
        <docblock line="1320">
          <description><![CDATA[]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="1330">
          <name>$length</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1350" package="Crypt\RSA">
        <name>_string_shift</name>
        <full_name>_string_shift</full_name>
        <docblock line="1340">
          <description><![CDATA[String Shift]]></description>
          <long-description><![CDATA[<p>Inspired by array_shift</p>]]></long-description>
          <tag line="1340" name="param" description="" type="String" variable="$string">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1340" name="param" description="Integer $index" type="\optional" variable="$index">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="1340" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1340" name="access" description="private"/>
        </docblock>
        <argument line="1350">
          <name>$string</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1350">
          <name>$index</name>
          <default><![CDATA[1]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1364" package="Crypt\RSA">
        <name>setPrivateKeyFormat</name>
        <full_name>setPrivateKeyFormat</full_name>
        <docblock line="1357">
          <description><![CDATA[Determines the private key format]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1357" name="see" description="\global\createKey()" refers="\global\createKey()"/>
          <tag line="1357" name="access" description="public"/>
          <tag line="1357" name="param" description="" type="Integer" variable="$format">
            <type by_reference="false">Integer</type>
          </tag>
        </docblock>
        <argument line="1364">
          <name>$format</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1376" package="Crypt\RSA">
        <name>setPublicKeyFormat</name>
        <full_name>setPublicKeyFormat</full_name>
        <docblock line="1369">
          <description><![CDATA[Determines the public key format]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1369" name="see" description="\global\createKey()" refers="\global\createKey()"/>
          <tag line="1369" name="access" description="public"/>
          <tag line="1369" name="param" description="" type="Integer" variable="$format">
            <type by_reference="false">Integer</type>
          </tag>
        </docblock>
        <argument line="1376">
          <name>$format</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1390" package="Crypt\RSA">
        <name>setHash</name>
        <full_name>setHash</full_name>
        <docblock line="1381">
          <description><![CDATA[Determines which hashing function should be used]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="1381" name="access" description="public"/>
          <tag line="1381" name="param" description="" type="String" variable="$hash">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1390">
          <name>$hash</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1419" package="Crypt\RSA">
        <name>setMGFHash</name>
        <full_name>setMGFHash</full_name>
        <docblock line="1410">
          <description><![CDATA[Determines which hashing function should be used for the mask generation function]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="1410" name="access" description="public"/>
          <tag line="1410" name="param" description="" type="String" variable="$hash">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1419">
          <name>$hash</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1448" package="Crypt\RSA">
        <name>setSaltLength</name>
        <full_name>setSaltLength</full_name>
        <docblock line="1437">
          <description><![CDATA[Determines the salt length]]></description>
          <long-description><![CDATA[<p>To quote from {@link http://tools.ietf.org/html/rfc3447#page-38 RFC3447#page-38}:</p>

<p>Typical salt lengths in octets are hLen (the length of the output
   of the hash function Hash) and 0.</p>]]></long-description>
          <tag line="1437" name="access" description="public"/>
          <tag line="1437" name="param" description="" type="Integer" variable="$format">
            <type by_reference="false">Integer</type>
          </tag>
        </docblock>
        <argument line="1448">
          <name>$sLen</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1461" package="Crypt\RSA">
        <name>_random</name>
        <full_name>_random</full_name>
        <docblock line="1453">
          <description><![CDATA[Generates a random string x bytes long]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1453" name="access" description="public"/>
          <tag line="1453" name="param" description="" type="Integer" variable="$bytes">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="1453" name="param" description="Integer $nonzero" type="\optional" variable="$nonzero">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="1453" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1461">
          <name>$bytes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1461">
          <name>$nonzero</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1488" package="Crypt\RSA">
        <name>_i2osp</name>
        <full_name>_i2osp</full_name>
        <docblock line="1478">
          <description><![CDATA[Integer-to-Octet-String primitive]]></description>
          <long-description><![CDATA[<p>See {@link http://tools.ietf.org/html/rfc3447#section-4.1 RFC3447#section-4.1}.</p>]]></long-description>
          <tag line="1478" name="access" description="private"/>
          <tag line="1478" name="param" description="" type="\Math_BigInteger" variable="$x">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="1478" name="param" description="" type="Integer" variable="$xLen">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="1478" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1488">
          <name>$x</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1488">
          <name>$xLen</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1507" package="Crypt\RSA">
        <name>_os2ip</name>
        <full_name>_os2ip</full_name>
        <docblock line="1498">
          <description><![CDATA[Octet-String-to-Integer primitive]]></description>
          <long-description><![CDATA[<p>See {@link http://tools.ietf.org/html/rfc3447#section-4.2 RFC3447#section-4.2}.</p>]]></long-description>
          <tag line="1498" name="access" description="private"/>
          <tag line="1498" name="param" description="" type="String" variable="$x">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1498" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
        </docblock>
        <argument line="1507">
          <name>$x</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1521" package="Crypt\RSA">
        <name>_exponentiate</name>
        <full_name>_exponentiate</full_name>
        <docblock line="1512">
          <description><![CDATA[Exponentiate with or without Chinese Remainder Theorem]]></description>
          <long-description><![CDATA[<p>See {@link http://tools.ietf.org/html/rfc3447#section-5.1.1 RFC3447#section-5.1.2}.</p>]]></long-description>
          <tag line="1512" name="access" description="private"/>
          <tag line="1512" name="param" description="" type="\Math_BigInteger" variable="$x">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="1512" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
        </docblock>
        <argument line="1521">
          <name>$x</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1602" package="Crypt\RSA">
        <name>_blind</name>
        <full_name>_blind</full_name>
        <docblock line="1590">
          <description><![CDATA[Performs RSA Blinding]]></description>
          <long-description><![CDATA[<p>Protects against timing attacks by employing RSA Blinding.
Returns $x->modPow($this->exponents[$i], $this->primes[$i])</p>]]></long-description>
          <tag line="1590" name="access" description="private"/>
          <tag line="1590" name="param" description="" type="\Math_BigInteger" variable="$x">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="1590" name="param" description="" type="\Math_BigInteger" variable="$r">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="1590" name="param" description="" type="Integer" variable="$i">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="1590" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
        </docblock>
        <argument line="1602">
          <name>$x</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1602">
          <name>$r</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1602">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1623" package="Crypt\RSA">
        <name>_rsaep</name>
        <full_name>_rsaep</full_name>
        <docblock line="1614">
          <description><![CDATA[RSAEP]]></description>
          <long-description><![CDATA[<p>See {@link http://tools.ietf.org/html/rfc3447#section-5.1.1 RFC3447#section-5.1.1}.</p>]]></long-description>
          <tag line="1614" name="access" description="private"/>
          <tag line="1614" name="param" description="" type="\Math_BigInteger" variable="$m">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="1614" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
        </docblock>
        <argument line="1623">
          <name>$m</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1641" package="Crypt\RSA">
        <name>_rsadp</name>
        <full_name>_rsadp</full_name>
        <docblock line="1632">
          <description><![CDATA[RSADP]]></description>
          <long-description><![CDATA[<p>See {@link http://tools.ietf.org/html/rfc3447#section-5.1.2 RFC3447#section-5.1.2}.</p>]]></long-description>
          <tag line="1632" name="access" description="private"/>
          <tag line="1632" name="param" description="" type="\Math_BigInteger" variable="$c">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="1632" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
        </docblock>
        <argument line="1641">
          <name>$c</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1659" package="Crypt\RSA">
        <name>_rsasp1</name>
        <full_name>_rsasp1</full_name>
        <docblock line="1650">
          <description><![CDATA[RSASP1]]></description>
          <long-description><![CDATA[<p>See {@link http://tools.ietf.org/html/rfc3447#section-5.2.1 RFC3447#section-5.2.1}.</p>]]></long-description>
          <tag line="1650" name="access" description="private"/>
          <tag line="1650" name="param" description="" type="\Math_BigInteger" variable="$m">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="1650" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
        </docblock>
        <argument line="1659">
          <name>$m</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1677" package="Crypt\RSA">
        <name>_rsavp1</name>
        <full_name>_rsavp1</full_name>
        <docblock line="1668">
          <description><![CDATA[RSAVP1]]></description>
          <long-description><![CDATA[<p>See {@link http://tools.ietf.org/html/rfc3447#section-5.2.2 RFC3447#section-5.2.2}.</p>]]></long-description>
          <tag line="1668" name="access" description="private"/>
          <tag line="1668" name="param" description="" type="\Math_BigInteger" variable="$s">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
          <tag line="1668" name="return" description="" type="\Math_BigInteger">
            <type by_reference="false">\Math_BigInteger</type>
          </tag>
        </docblock>
        <argument line="1677">
          <name>$s</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1696" package="Crypt\RSA">
        <name>_mgf1</name>
        <full_name>_mgf1</full_name>
        <docblock line="1686">
          <description><![CDATA[MGF1]]></description>
          <long-description><![CDATA[<p>See {@link http://tools.ietf.org/html/rfc3447#appendix-B.2.1 RFC3447#appendix-B.2.1}.</p>]]></long-description>
          <tag line="1686" name="access" description="private"/>
          <tag line="1686" name="param" description="" type="String" variable="$mgfSeed">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1686" name="param" description="" type="Integer" variable="$mgfLen">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="1686" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1696">
          <name>$mgfSeed</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1696">
          <name>$maskLen</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1721" package="Crypt\RSA">
        <name>_rsaes_oaep_encrypt</name>
        <full_name>_rsaes_oaep_encrypt</full_name>
        <docblock line="1710">
          <description><![CDATA[RSAES-OAEP-ENCRYPT]]></description>
          <long-description><![CDATA[<p>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}.</p>]]></long-description>
          <tag line="1710" name="access" description="private"/>
          <tag line="1710" name="param" description="" type="String" variable="$m">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1710" name="param" description="" type="String" variable="$l">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1710" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1721">
          <name>$m</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1721">
          <name>$l</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1784" package="Crypt\RSA">
        <name>_rsaes_oaep_decrypt</name>
        <full_name>_rsaes_oaep_decrypt</full_name>
        <docblock line="1758">
          <description><![CDATA[RSAES-OAEP-DECRYPT]]></description>
          <long-description><![CDATA[<p>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:</p>

<p>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].</p>

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

<p>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.</p>]]></long-description>
          <tag line="1758" name="access" description="private"/>
          <tag line="1758" name="param" description="" type="String" variable="$c">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1758" name="param" description="" type="String" variable="$l">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1758" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1784">
          <name>$c</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1784">
          <name>$l</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1842" package="Crypt\RSA">
        <name>_rsaes_pkcs1_v1_5_encrypt</name>
        <full_name>_rsaes_pkcs1_v1_5_encrypt</full_name>
        <docblock line="1833">
          <description><![CDATA[RSAES-PKCS1-V1_5-ENCRYPT]]></description>
          <long-description><![CDATA[<p>See {@link http://tools.ietf.org/html/rfc3447#section-7.2.1 RFC3447#section-7.2.1}.</p>]]></long-description>
          <tag line="1833" name="access" description="private"/>
          <tag line="1833" name="param" description="" type="String" variable="$m">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1833" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1842">
          <name>$m</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1888" package="Crypt\RSA">
        <name>_rsaes_pkcs1_v1_5_decrypt</name>
        <full_name>_rsaes_pkcs1_v1_5_decrypt</full_name>
        <docblock line="1868">
          <description><![CDATA[RSAES-PKCS1-V1_5-DECRYPT]]></description>
          <long-description><![CDATA[<p>See {@link http://tools.ietf.org/html/rfc3447#section-7.2.2 RFC3447#section-7.2.2}.</p>

<p>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.</p>

<p>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.</p>]]></long-description>
          <tag line="1868" name="access" description="private"/>
          <tag line="1868" name="param" description="" type="String" variable="$c">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1868" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1888">
          <name>$c</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1937" package="Crypt\RSA">
        <name>_emsa_pss_encode</name>
        <full_name>_emsa_pss_encode</full_name>
        <docblock line="1928">
          <description><![CDATA[EMSA-PSS-ENCODE]]></description>
          <long-description><![CDATA[<p>See {@link http://tools.ietf.org/html/rfc3447#section-9.1.1 RFC3447#section-9.1.1}.</p>]]></long-description>
          <tag line="1928" name="access" description="private"/>
          <tag line="1928" name="param" description="" type="String" variable="$m">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1928" name="param" description="" type="Integer" variable="$emBits">
            <type by_reference="false">Integer</type>
          </tag>
        </docblock>
        <argument line="1937">
          <name>$m</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1937">
          <name>$emBits</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1975" package="Crypt\RSA">
        <name>_emsa_pss_verify</name>
        <full_name>_emsa_pss_verify</full_name>
        <docblock line="1964">
          <description><![CDATA[EMSA-PSS-VERIFY]]></description>
          <long-description><![CDATA[<p>See {@link http://tools.ietf.org/html/rfc3447#section-9.1.2 RFC3447#section-9.1.2}.</p>]]></long-description>
          <tag line="1964" name="access" description="private"/>
          <tag line="1964" name="param" description="" type="String" variable="$m">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1964" name="param" description="" type="String" variable="$em">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1964" name="param" description="" type="Integer" variable="$emBits">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="1964" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1975">
          <name>$m</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1975">
          <name>$em</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1975">
          <name>$emBits</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2020" package="Crypt\RSA">
        <name>_rsassa_pss_sign</name>
        <full_name>_rsassa_pss_sign</full_name>
        <docblock line="2011">
          <description><![CDATA[RSASSA-PSS-SIGN]]></description>
          <long-description><![CDATA[<p>See {@link http://tools.ietf.org/html/rfc3447#section-8.1.1 RFC3447#section-8.1.1}.</p>]]></long-description>
          <tag line="2011" name="access" description="private"/>
          <tag line="2011" name="param" description="" type="String" variable="$m">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2011" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="2020">
          <name>$m</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2047" package="Crypt\RSA">
        <name>_rsassa_pss_verify</name>
        <full_name>_rsassa_pss_verify</full_name>
        <docblock line="2037">
          <description><![CDATA[RSASSA-PSS-VERIFY]]></description>
          <long-description><![CDATA[<p>See {@link http://tools.ietf.org/html/rfc3447#section-8.1.2 RFC3447#section-8.1.2}.</p>]]></long-description>
          <tag line="2037" name="access" description="private"/>
          <tag line="2037" name="param" description="" type="String" variable="$m">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2037" name="param" description="" type="String" variable="$s">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2037" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="2047">
          <name>$m</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2047">
          <name>$s</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2087" package="Crypt\RSA">
        <name>_emsa_pkcs1_v1_5_encode</name>
        <full_name>_emsa_pkcs1_v1_5_encode</full_name>
        <docblock line="2077">
          <description><![CDATA[EMSA-PKCS1-V1_5-ENCODE]]></description>
          <long-description><![CDATA[<p>See {@link http://tools.ietf.org/html/rfc3447#section-9.2 RFC3447#section-9.2}.</p>]]></long-description>
          <tag line="2077" name="access" description="private"/>
          <tag line="2077" name="param" description="" type="String" variable="$m">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2077" name="param" description="" type="Integer" variable="$emLen">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="2077" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="2087">
          <name>$m</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2087">
          <name>$emLen</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2138" package="Crypt\RSA">
        <name>_rsassa_pkcs1_v1_5_sign</name>
        <full_name>_rsassa_pkcs1_v1_5_sign</full_name>
        <docblock line="2129">
          <description><![CDATA[RSASSA-PKCS1-V1_5-SIGN]]></description>
          <long-description><![CDATA[<p>See {@link http://tools.ietf.org/html/rfc3447#section-8.2.1 RFC3447#section-8.2.1}.</p>]]></long-description>
          <tag line="2129" name="access" description="private"/>
          <tag line="2129" name="param" description="" type="String" variable="$m">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2129" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="2138">
          <name>$m</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2168" package="Crypt\RSA">
        <name>_rsassa_pkcs1_v1_5_verify</name>
        <full_name>_rsassa_pkcs1_v1_5_verify</full_name>
        <docblock line="2159">
          <description><![CDATA[RSASSA-PKCS1-V1_5-VERIFY]]></description>
          <long-description><![CDATA[<p>See {@link http://tools.ietf.org/html/rfc3447#section-8.2.2 RFC3447#section-8.2.2}.</p>]]></long-description>
          <tag line="2159" name="access" description="private"/>
          <tag line="2159" name="param" description="" type="String" variable="$m">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2159" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="2168">
          <name>$m</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2168">
          <name>$s</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2212" package="Crypt\RSA">
        <name>setEncryptionMode</name>
        <full_name>setEncryptionMode</full_name>
        <docblock line="2204">
          <description><![CDATA[Set Encryption Mode]]></description>
          <long-description><![CDATA[<p>Valid values include CRYPT_RSA_ENCRYPTION_OAEP and CRYPT_RSA_ENCRYPTION_PKCS1.</p>]]></long-description>
          <tag line="2204" name="access" description="public"/>
          <tag line="2204" name="param" description="" type="Integer" variable="$mode">
            <type by_reference="false">Integer</type>
          </tag>
        </docblock>
        <argument line="2212">
          <name>$mode</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2225" package="Crypt\RSA">
        <name>setSignatureMode</name>
        <full_name>setSignatureMode</full_name>
        <docblock line="2217">
          <description><![CDATA[Set Signature Mode]]></description>
          <long-description><![CDATA[<p>Valid values include CRYPT_RSA_SIGNATURE_PSS and CRYPT_RSA_SIGNATURE_PKCS1</p>]]></long-description>
          <tag line="2217" name="access" description="public"/>
          <tag line="2217" name="param" description="" type="Integer" variable="$mode">
            <type by_reference="false">Integer</type>
          </tag>
        </docblock>
        <argument line="2225">
          <name>$mode</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2242" package="Crypt\RSA">
        <name>encrypt</name>
        <full_name>encrypt</full_name>
        <docblock line="2230">
          <description><![CDATA[Encryption]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="2230" name="see" description="\global\decrypt()" refers="\global\decrypt()"/>
          <tag line="2230" name="access" description="public"/>
          <tag line="2230" name="param" description="" type="String" variable="$plaintext">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2230" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="2242">
          <name>$plaintext</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2281" package="Crypt\RSA">
        <name>decrypt</name>
        <full_name>decrypt</full_name>
        <docblock line="2273">
          <description><![CDATA[Decryption]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2273" name="see" description="\global\encrypt()" refers="\global\encrypt()"/>
          <tag line="2273" name="access" description="public"/>
          <tag line="2273" name="param" description="" type="String" variable="$plaintext">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2273" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="2281">
          <name>$ciphertext</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2318" package="Crypt\RSA">
        <name>sign</name>
        <full_name>sign</full_name>
        <docblock line="2310">
          <description><![CDATA[Create a signature]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2310" name="see" description="\global\verify()" refers="\global\verify()"/>
          <tag line="2310" name="access" description="public"/>
          <tag line="2310" name="param" description="" type="String" variable="$message">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2310" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="2318">
          <name>$message</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2342" package="Crypt\RSA">
        <name>verify</name>
        <full_name>verify</full_name>
        <docblock line="2333">
          <description><![CDATA[Verifies a signature]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2333" name="see" description="\global\sign()" refers="\global\sign()"/>
          <tag line="2333" name="access" description="public"/>
          <tag line="2333" name="param" description="" type="String" variable="$message">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2333" name="param" description="" type="String" variable="$signature">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2333" name="return" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
        </docblock>
        <argument line="2342">
          <name>$message</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2342">
          <name>$signature</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <parse_markers>
      <error line="625" code="50014">Name of argument $n does not match with the DocBlock's name $RSAPrivateKey in _convertPrivateKey()</error>
      <error line="625" code="50015">Argument $e is missing from the Docblock of _convertPrivateKey()</error>
      <error line="625" code="50015">Argument $d is missing from the Docblock of _convertPrivateKey()</error>
      <error line="625" code="50015">Argument $primes is missing from the Docblock of _convertPrivateKey()</error>
      <error line="625" code="50015">Argument $exponents is missing from the Docblock of _convertPrivateKey()</error>
      <error line="625" code="50015">Argument $coefficients is missing from the Docblock of _convertPrivateKey()</error>
      <notice line="625" code="50013">Parameter $RSAPrivateKey could not be found in _convertPrivateKey()</notice>
      <error line="706" code="50014">Name of argument $n does not match with the DocBlock's name $RSAPrivateKey in _convertPublicKey()</error>
      <error line="706" code="50015">Argument $e is missing from the Docblock of _convertPublicKey()</error>
      <notice line="706" code="50013">Parameter $RSAPrivateKey could not be found in _convertPublicKey()</notice>
      <error line="1248" code="50014">Name of argument $type does not match with the DocBlock's name $key in getPublicKey()</error>
      <notice line="1248" code="50013">Parameter $key could not be found in getPublicKey()</notice>
      <error line="1299" code="50012">No short description for method _decodeLength()</error>
      <error line="1299" code="50015">Argument $string is missing from the Docblock of _decodeLength()</error>
      <error line="1320" code="50012">No short description for method _encodeLength()</error>
      <error line="1320" code="50015">Argument $length is missing from the Docblock of _encodeLength()</error>
      <error line="1437" code="50014">Name of argument $sLen does not match with the DocBlock's name $format in setSaltLength()</error>
      <notice line="1437" code="50013">Parameter $format could not be found in setSaltLength()</notice>
      <error line="1686" code="50014">Name of argument $maskLen does not match with the DocBlock's name $mgfLen in _mgf1()</error>
      <notice line="1686" code="50013">Parameter $mgfLen could not be found in _mgf1()</notice>
      <error line="2159" code="50015">Argument $s is missing from the Docblock of _rsassa_pkcs1_v1_5_verify()</error>
      <error line="2273" code="50014">Name of argument $ciphertext does not match with the DocBlock's name $plaintext in decrypt()</error>
      <notice line="2273" code="50013">Parameter $plaintext could not be found in decrypt()</notice>
    </parse_markers>
  </file>
  <file path="lib/3rdParty/phpseclib/Crypt/Hash.php" hash="493a9129f851e698e2e72448e4118fd8" package="Crypt\Hash">
    <docblock line="4">
      <description><![CDATA[Pure-PHP implementations of keyed-hash message authentication codes (HMACs) and various cryptographic hashing functions.]]></description>
      <long-description><![CDATA[<p>Uses hash() or mhash() if available and an internal implementation, otherwise.  Currently supports the following:</p>

<p>md2, md5, md5-96, sha1, sha1-96, sha256, sha384, and sha512</p>

<p>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.</p>

<p>PHP versions 4 and 5</p>

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

<p>Here's a short example of how to use this library:</p>

<pre><code><?php
   include('Crypt/Hash.php');

   $hash = new Crypt_Hash('sha1');

   $hash->setKey('abcdefg');

   echo base64_encode($hash->hash('abcdefg'));
?>
</code></pre>

<p>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:</p>

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

<p>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.</p>]]></long-description>
      <tag line="4" name="category" description="Crypt"/>
      <tag line="4" name="package" description="Crypt_Hash"/>
      <tag line="4" name="author" description="Jim Wigginton &lt;terrafrost@php.net&gt;"/>
      <tag line="4" name="copyright" description="MMVII Jim Wigginton"/>
      <tag line="4" name="license" description="http://www.opensource.org/licenses/mit-license.html  MIT License"/>
      <tag line="4" name="version" description="$Id: Hash.php 4105 2011-05-19 18:02:11Z gruberroland $"/>
      <tag line="4" name="link" description="http://phpseclib.sourceforge.net" link="http://phpseclib.sourceforge.net"/>
    </docblock>
    <include line="562" type="Require Once" package="main">
      <name>Math/BigInteger.php</name>
    </include>
    <constant namespace="global" line="66" package="Crypt\Hash">
      <name>CRYPT_HASH_MODE_INTERNAL</name>
      <full_name>\CRYPT_HASH_MODE_INTERNAL</full_name>
      <value><![CDATA[1]]></value>
      <docblock line="63">
        <description><![CDATA[Toggles the internal implementation]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="70" package="Crypt\Hash">
      <name>CRYPT_HASH_MODE_MHASH</name>
      <full_name>\CRYPT_HASH_MODE_MHASH</full_name>
      <value><![CDATA[2]]></value>
      <docblock line="67">
        <description><![CDATA[Toggles the mhash() implementation, which has been deprecated on PHP 5.3.0+.]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="74" package="Crypt\Hash">
      <name>CRYPT_HASH_MODE_HASH</name>
      <full_name>\CRYPT_HASH_MODE_HASH</full_name>
      <value><![CDATA[3]]></value>
      <docblock line="71">
        <description><![CDATA[Toggles the hash() implementation, which works on PHP 5.1.2+.]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="158" package="Crypt\Hash">
      <name>CRYPT_HASH_MODE</name>
      <full_name>\CRYPT_HASH_MODE</full_name>
      <value><![CDATA[CRYPT_HASH_MODE_INTERNAL]]></value>
    </constant>
    <class final="false" abstract="false" namespace="global" line="85" package="Crypt\Hash">
      <extends/>
      <name>Crypt_Hash</name>
      <full_name>\Crypt_Hash</full_name>
      <docblock line="77">
        <description><![CDATA[Pure-PHP implementations of keyed-hash message authentication codes (HMACs) and various cryptographic hashing functions.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="77" name="author" description="Jim Wigginton &lt;terrafrost@php.net&gt;"/>
        <tag line="77" name="version" description="0.1.0"/>
        <tag line="77" name="access" description="public"/>
        <tag line="77" name="package" description="Crypt_Hash"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="93" namespace="global" package="main">
        <name>$b</name>
        <default><![CDATA[]]></default>
        <docblock line="86">
          <description><![CDATA[Byte-length of compression blocks / key (Internal HMAC)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="86" name="see" description="\global\Crypt_Hash::setAlgorithm()" refers="\global\Crypt_Hash::setAlgorithm()"/>
          <tag line="86" name="var" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="86" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="102" namespace="global" package="main">
        <name>$l</name>
        <default><![CDATA[false]]></default>
        <docblock line="95">
          <description><![CDATA[Byte-length of hash output (Internal HMAC)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="95" name="see" description="\global\Crypt_Hash::setHash()" refers="\global\Crypt_Hash::setHash()"/>
          <tag line="95" name="var" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="95" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="111" namespace="global" package="main">
        <name>$hash</name>
        <default><![CDATA[]]></default>
        <docblock line="104">
          <description><![CDATA[Hash Algorithm]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="104" name="see" description="\global\Crypt_Hash::setHash()" refers="\global\Crypt_Hash::setHash()"/>
          <tag line="104" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="104" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="120" namespace="global" package="main">
        <name>$key</name>
        <default><![CDATA['']]></default>
        <docblock line="113">
          <description><![CDATA[Key]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="113" name="see" description="\global\Crypt_Hash::setKey()" refers="\global\Crypt_Hash::setKey()"/>
          <tag line="113" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="113" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="129" namespace="global" package="main">
        <name>$opad</name>
        <default><![CDATA[]]></default>
        <docblock line="122">
          <description><![CDATA[Outer XOR (Internal HMAC)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="122" name="see" description="\global\Crypt_Hash::setKey()" refers="\global\Crypt_Hash::setKey()"/>
          <tag line="122" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="122" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="138" namespace="global" package="main">
        <name>$ipad</name>
        <default><![CDATA[]]></default>
        <docblock line="131">
          <description><![CDATA[Inner XOR (Internal HMAC)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="131" name="see" description="\global\Crypt_Hash::setKey()" refers="\global\Crypt_Hash::setKey()"/>
          <tag line="131" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="131" name="access" description="private"/>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="147" package="Crypt\Hash">
        <name>Crypt_Hash</name>
        <full_name>Crypt_Hash</full_name>
        <docblock line="140">
          <description><![CDATA[Default Constructor.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="140" name="param" description="String $hash" type="\optional" variable="$hash">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="140" name="return" description="" type="\Crypt_Hash">
            <type by_reference="false">\Crypt_Hash</type>
          </tag>
          <tag line="140" name="access" description="public"/>
        </docblock>
        <argument line="147">
          <name>$hash</name>
          <default><![CDATA['sha1']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="173" package="Crypt\Hash">
        <name>setKey</name>
        <full_name>setKey</full_name>
        <docblock line="165">
          <description><![CDATA[Sets the key for HMACs]]></description>
          <long-description><![CDATA[<p>Keys can be of any length.</p>]]></long-description>
          <tag line="165" name="access" description="public"/>
          <tag line="165" name="param" description="" type="String" variable="$key">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="173">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="184" package="Crypt\Hash">
        <name>setHash</name>
        <full_name>setHash</full_name>
        <docblock line="178">
          <description><![CDATA[Sets the hash function.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="178" name="access" description="public"/>
          <tag line="178" name="param" description="" type="String" variable="$hash">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="184">
          <name>$hash</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="294" package="Crypt\Hash">
        <name>hash</name>
        <full_name>hash</full_name>
        <docblock line="287">
          <description><![CDATA[Compute the HMAC.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="287" name="access" description="public"/>
          <tag line="287" name="param" description="" type="String" variable="$text">
            <type by_reference="false">String</type>
          </tag>
          <tag line="287" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="294">
          <name>$text</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="343" package="Crypt\Hash">
        <name>getLength</name>
        <full_name>getLength</full_name>
        <docblock line="337">
          <description><![CDATA[Returns the hash length (in bytes)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="337" name="access" description="public"/>
          <tag line="337" name="return" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="354" package="Crypt\Hash">
        <name>_md5</name>
        <full_name>_md5</full_name>
        <docblock line="348">
          <description><![CDATA[Wrapper for MD5]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="348" name="access" description="private"/>
          <tag line="348" name="param" description="" type="String" variable="$text">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="354">
          <name>$m</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="365" package="Crypt\Hash">
        <name>_sha1</name>
        <full_name>_sha1</full_name>
        <docblock line="359">
          <description><![CDATA[Wrapper for SHA1]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="359" name="access" description="private"/>
          <tag line="359" name="param" description="" type="String" variable="$text">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="365">
          <name>$m</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="378" package="Crypt\Hash">
        <name>_md2</name>
        <full_name>_md2</full_name>
        <docblock line="370">
          <description><![CDATA[Pure-PHP implementation of MD2]]></description>
          <long-description><![CDATA[<p>See {@link http://tools.ietf.org/html/rfc1319 RFC1319}.</p>]]></long-description>
          <tag line="370" name="access" description="private"/>
          <tag line="370" name="param" description="" type="String" variable="$text">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="378">
          <name>$m</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="454" package="Crypt\Hash">
        <name>_sha256</name>
        <full_name>_sha256</full_name>
        <docblock line="446">
          <description><![CDATA[Pure-PHP implementation of SHA256]]></description>
          <long-description><![CDATA[<p>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}.</p>]]></long-description>
          <tag line="446" name="access" description="private"/>
          <tag line="446" name="param" description="" type="String" variable="$text">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="454">
          <name>$m</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="559" package="Crypt\Hash">
        <name>_sha512</name>
        <full_name>_sha512</full_name>
        <docblock line="553">
          <description><![CDATA[Pure-PHP implementation of SHA384 and SHA512]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="553" name="access" description="private"/>
          <tag line="553" name="param" description="" type="String" variable="$text">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="559">
          <name>$m</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="745" package="Crypt\Hash">
        <name>_rightRotate</name>
        <full_name>_rightRotate</full_name>
        <docblock line="736">
          <description><![CDATA[Right Rotate]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="736" name="access" description="private"/>
          <tag line="736" name="param" description="" type="Integer" variable="$int">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="736" name="param" description="" type="Integer" variable="$amt">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="736" name="see" description="\global\_sha256()" refers="\global\_sha256()"/>
          <tag line="736" name="return" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
        </docblock>
        <argument line="745">
          <name>$int</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="745">
          <name>$amt</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="761" package="Crypt\Hash">
        <name>_rightShift</name>
        <full_name>_rightShift</full_name>
        <docblock line="752">
          <description><![CDATA[Right Shift]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="752" name="access" description="private"/>
          <tag line="752" name="param" description="" type="Integer" variable="$int">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="752" name="param" description="" type="Integer" variable="$amt">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="752" name="see" description="\global\_sha256()" refers="\global\_sha256()"/>
          <tag line="752" name="return" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
        </docblock>
        <argument line="761">
          <name>$int</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="761">
          <name>$amt</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="775" package="Crypt\Hash">
        <name>_not</name>
        <full_name>_not</full_name>
        <docblock line="767">
          <description><![CDATA[Not]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="767" name="access" description="private"/>
          <tag line="767" name="param" description="" type="Integer" variable="$int">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="767" name="see" description="\global\_sha256()" refers="\global\_sha256()"/>
          <tag line="767" name="return" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
        </docblock>
        <argument line="775">
          <name>$int</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="792" package="Crypt\Hash">
        <name>_add</name>
        <full_name>_add</full_name>
        <docblock line="780">
          <description><![CDATA[Add]]></description>
          <long-description><![CDATA[<p>_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.</p>]]></long-description>
          <tag line="780" name="param" description="" type="String" variable="$string">
            <type by_reference="false">String</type>
          </tag>
          <tag line="780" name="param" description="Integer $index" type="\optional" variable="">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="780" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="780" name="see" description="\global\_sha256()" refers="\global\_sha256()"/>
          <tag line="780" name="access" description="private"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="818" package="Crypt\Hash">
        <name>_string_shift</name>
        <full_name>_string_shift</full_name>
        <docblock line="808">
          <description><![CDATA[String Shift]]></description>
          <long-description><![CDATA[<p>Inspired by array_shift</p>]]></long-description>
          <tag line="808" name="param" description="" type="String" variable="$string">
            <type by_reference="false">String</type>
          </tag>
          <tag line="808" name="param" description="Integer $index" type="\optional" variable="$index">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="808" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="808" name="access" description="private"/>
        </docblock>
        <argument line="818">
          <name>$string</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="818">
          <name>$index</name>
          <default><![CDATA[1]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <parse_markers>
      <error line="348" code="50014">Name of argument $m does not match with the DocBlock's name $text in _md5()</error>
      <notice line="348" code="50013">Parameter $text could not be found in _md5()</notice>
      <error line="359" code="50014">Name of argument $m does not match with the DocBlock's name $text in _sha1()</error>
      <notice line="359" code="50013">Parameter $text could not be found in _sha1()</notice>
      <error line="370" code="50014">Name of argument $m does not match with the DocBlock's name $text in _md2()</error>
      <notice line="370" code="50013">Parameter $text could not be found in _md2()</notice>
      <error line="446" code="50014">Name of argument $m does not match with the DocBlock's name $text in _sha256()</error>
      <notice line="446" code="50013">Parameter $text could not be found in _sha256()</notice>
      <error line="553" code="50014">Name of argument $m does not match with the DocBlock's name $text in _sha512()</error>
      <notice line="553" code="50013">Parameter $text could not be found in _sha512()</notice>
      <notice line="780" code="50013">Parameter $string could not be found in _add()</notice>
      <notice line="780" code="50013">Parameter  could not be found in _add()</notice>
    </parse_markers>
  </file>
  <file path="lib/3rdParty/phpseclib/Crypt/TripleDES.php" hash="bb9ada71321d6710e544ded8535bc6d5" package="Crypt\TripleDES">
    <docblock line="4">
      <description><![CDATA[Pure-PHP implementation of Triple DES.]]></description>
      <long-description><![CDATA[<p>Uses mcrypt, if available, and an internal implementation, otherwise.  Operates in the EDE3 mode (encrypt-decrypt-encrypt).</p>

<p>PHP versions 4 and 5</p>

<p>Here's a short example of how to use this library:</p>

<pre><code><?php
   include('Crypt/TripleDES.php');

   $des = new Crypt_TripleDES();

   $des->setKey('abcdefghijklmnopqrstuvwx');

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

   echo $des->decrypt($des->encrypt($plaintext));
?>
</code></pre>

<p>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:</p>

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

<p>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.</p>]]></long-description>
      <tag line="4" name="category" description="Crypt"/>
      <tag line="4" name="package" description="Crypt_TripleDES"/>
      <tag line="4" name="author" description="Jim Wigginton &lt;terrafrost@php.net&gt;"/>
      <tag line="4" name="copyright" description="MMVII Jim Wigginton"/>
      <tag line="4" name="license" description="http://www.opensource.org/licenses/mit-license.html  MIT License"/>
      <tag line="4" name="version" description="$Id: TripleDES.php 4105 2011-05-19 18:02:11Z gruberroland $"/>
      <tag line="4" name="link" description="http://phpseclib.sourceforge.net" link="http://phpseclib.sourceforge.net"/>
    </docblock>
    <include line="60" type="Require Once" package="main">
      <name>DES.php</name>
      <docblock line="57">
        <description><![CDATA[Include Crypt_DES]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <constant namespace="global" line="67" package="Crypt\TripleDES">
      <name>CRYPT_DES_MODE_3CBC</name>
      <full_name>\CRYPT_DES_MODE_3CBC</full_name>
      <value><![CDATA[-2]]></value>
      <docblock line="62">
        <description><![CDATA[Encrypt / decrypt using inner chaining]]></description>
        <long-description><![CDATA[<p>Inner chaining is used by SSH-1 and is generally considered to be less secure then outer chaining (CRYPT_DES_MODE_CBC3).</p>]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="74" package="Crypt\TripleDES">
      <name>CRYPT_DES_MODE_CBC3</name>
      <full_name>\CRYPT_DES_MODE_CBC3</full_name>
      <value><![CDATA[CRYPT_DES_MODE_CBC]]></value>
      <docblock line="69">
        <description><![CDATA[Encrypt / decrypt using outer chaining]]></description>
        <long-description><![CDATA[<p>Outer chaining is used by SSH-2 and when the mode is set to CRYPT_DES_MODE_CBC.</p>]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="258" package="Crypt\TripleDES">
      <name>CRYPT_DES_MODE</name>
      <full_name>\CRYPT_DES_MODE</full_name>
      <value><![CDATA[CRYPT_DES_MODE_INTERNAL]]></value>
    </constant>
    <class final="false" abstract="false" namespace="global" line="84" package="Crypt\TerraDES">
      <extends/>
      <name>Crypt_TripleDES</name>
      <full_name>\Crypt_TripleDES</full_name>
      <docblock line="76">
        <description><![CDATA[Pure-PHP implementation of Triple DES.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="76" name="author" description="Jim Wigginton &lt;terrafrost@php.net&gt;"/>
        <tag line="76" name="version" description="0.1.0"/>
        <tag line="76" name="access" description="public"/>
        <tag line="76" name="package" description="Crypt_TerraDES"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="92" namespace="global" package="main">
        <name>$key</name>
        <default><![CDATA["\0\0\0\0\0\0\0\0"]]></default>
        <docblock line="85">
          <description><![CDATA[The Three Keys]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="85" name="see" description="\global\Crypt_TripleDES::setKey()" refers="\global\Crypt_TripleDES::setKey()"/>
          <tag line="85" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="85" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="101" namespace="global" package="main">
        <name>$mode</name>
        <default><![CDATA[CRYPT_DES_MODE_CBC]]></default>
        <docblock line="94">
          <description><![CDATA[The Encryption Mode]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="94" name="see" description="\global\Crypt_TripleDES::Crypt_TripleDES()" refers="\global\Crypt_TripleDES::Crypt_TripleDES()"/>
          <tag line="94" name="var" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="94" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="110" namespace="global" package="main">
        <name>$continuousBuffer</name>
        <default><![CDATA[false]]></default>
        <docblock line="103">
          <description><![CDATA[Continuous Buffer status]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="103" name="see" description="\global\Crypt_TripleDES::enableContinuousBuffer()" refers="\global\Crypt_TripleDES::enableContinuousBuffer()"/>
          <tag line="103" name="var" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="103" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="119" namespace="global" package="main">
        <name>$padding</name>
        <default><![CDATA[true]]></default>
        <docblock line="112">
          <description><![CDATA[Padding status]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="112" name="see" description="\global\Crypt_TripleDES::enablePadding()" refers="\global\Crypt_TripleDES::enablePadding()"/>
          <tag line="112" name="var" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="112" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="128" namespace="global" package="main">
        <name>$iv</name>
        <default><![CDATA["\0\0\0\0\0\0\0\0"]]></default>
        <docblock line="121">
          <description><![CDATA[The Initialization Vector]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="121" name="see" description="\global\Crypt_TripleDES::setIV()" refers="\global\Crypt_TripleDES::setIV()"/>
          <tag line="121" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="121" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="137" namespace="global" package="main">
        <name>$encryptIV</name>
        <default><![CDATA["\0\0\0\0\0\0\0\0"]]></default>
        <docblock line="130">
          <description><![CDATA[A "sliding" Initialization Vector]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="130" name="see" description="\global\Crypt_TripleDES::enableContinuousBuffer()" refers="\global\Crypt_TripleDES::enableContinuousBuffer()"/>
          <tag line="130" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="130" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="146" namespace="global" package="main">
        <name>$decryptIV</name>
        <default><![CDATA["\0\0\0\0\0\0\0\0"]]></default>
        <docblock line="139">
          <description><![CDATA[A "sliding" Initialization Vector]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="139" name="see" description="\global\Crypt_TripleDES::enableContinuousBuffer()" refers="\global\Crypt_TripleDES::enableContinuousBuffer()"/>
          <tag line="139" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="139" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="154" namespace="global" package="main">
        <name>$des</name>
        <default><![CDATA[]]></default>
        <docblock line="148">
          <description><![CDATA[The Crypt_DES objects]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="148" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="148" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="166" namespace="global" package="main">
        <name>$enmcrypt</name>
        <default><![CDATA[]]></default>
        <docblock line="156">
          <description><![CDATA[mcrypt resource for encryption]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="156" name="see" description="\global\Crypt_TripleDES::encrypt()" refers="\global\Crypt_TripleDES::encrypt()"/>
          <tag line="156" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="156" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="178" namespace="global" package="main">
        <name>$demcrypt</name>
        <default><![CDATA[]]></default>
        <docblock line="168">
          <description><![CDATA[mcrypt resource for decryption]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="168" name="see" description="\global\Crypt_TripleDES::decrypt()" refers="\global\Crypt_TripleDES::decrypt()"/>
          <tag line="168" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="168" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="188" namespace="global" package="main">
        <name>$enchanged</name>
        <default><![CDATA[true]]></default>
        <docblock line="180">
          <description><![CDATA[Does the enmcrypt resource need to be (re)initialized?]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="180" name="see" description="\global\Crypt_TripleDES::setKey()" refers="\global\Crypt_TripleDES::setKey()"/>
          <tag line="180" name="see" description="\global\Crypt_TripleDES::setIV()" refers="\global\Crypt_TripleDES::setIV()"/>
          <tag line="180" name="var" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="180" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="198" namespace="global" package="main">
        <name>$dechanged</name>
        <default><![CDATA[true]]></default>
        <docblock line="190">
          <description><![CDATA[Does the demcrypt resource need to be (re)initialized?]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="190" name="see" description="\global\Crypt_TripleDES::setKey()" refers="\global\Crypt_TripleDES::setKey()"/>
          <tag line="190" name="see" description="\global\Crypt_TripleDES::setIV()" refers="\global\Crypt_TripleDES::setIV()"/>
          <tag line="190" name="var" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="190" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="207" namespace="global" package="main">
        <name>$paddable</name>
        <default><![CDATA[false]]></default>
        <docblock line="200">
          <description><![CDATA[Is the mode one that is paddable?]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="200" name="see" description="\global\Crypt_TripleDES::Crypt_TripleDES()" refers="\global\Crypt_TripleDES::Crypt_TripleDES()"/>
          <tag line="200" name="var" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="200" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="216" namespace="global" package="main">
        <name>$enbuffer</name>
        <default><![CDATA['']]></default>
        <docblock line="209">
          <description><![CDATA[Encryption buffer for CTR, OFB and CFB modes]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="209" name="see" description="\global\Crypt_TripleDES::encrypt()" refers="\global\Crypt_TripleDES::encrypt()"/>
          <tag line="209" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="209" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="225" namespace="global" package="main">
        <name>$debuffer</name>
        <default><![CDATA['']]></default>
        <docblock line="218">
          <description><![CDATA[Decryption buffer for CTR, OFB and CFB modes]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="218" name="see" description="\global\Crypt_TripleDES::decrypt()" refers="\global\Crypt_TripleDES::decrypt()"/>
          <tag line="218" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="218" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="235" namespace="global" package="main">
        <name>$ecb</name>
        <default><![CDATA[]]></default>
        <docblock line="227">
          <description><![CDATA[mcrypt resource for CFB mode]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="227" name="see" description="\global\Crypt_TripleDES::encrypt()" refers="\global\Crypt_TripleDES::encrypt()"/>
          <tag line="227" name="see" description="\global\Crypt_TripleDES::decrypt()" refers="\global\Crypt_TripleDES::decrypt()"/>
          <tag line="227" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="227" name="access" description="private"/>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="247" package="Crypt\TerraDES">
        <name>Crypt_TripleDES</name>
        <full_name>Crypt_TripleDES</full_name>
        <docblock line="237">
          <description><![CDATA[Default Constructor.]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="237" name="param" description="Integer $mode" type="\optional" variable="$mode">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="237" name="return" description="" type="\Crypt_TripleDES">
            <type by_reference="false">\Crypt_TripleDES</type>
          </tag>
          <tag line="237" name="access" description="public"/>
        </docblock>
        <argument line="247">
          <name>$mode</name>
          <default><![CDATA[CRYPT_DES_MODE_CBC]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="344" package="Crypt\TerraDES">
        <name>setKey</name>
        <full_name>setKey</full_name>
        <docblock line="331">
          <description><![CDATA[Sets the key.]]></description>
          <long-description><![CDATA[<p>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.</p>

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

<p>If the key is not explicitly set, it'll be assumed to be all zero's.</p>]]></long-description>
          <tag line="331" name="access" description="public"/>
          <tag line="331" name="param" description="" type="String" variable="$key">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="344">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="375" package="Crypt\TerraDES">
        <name>setIV</name>
        <full_name>setIV</full_name>
        <docblock line="366">
          <description><![CDATA[Sets the initialization vector.]]></description>
          <long-description><![CDATA[<p>(optional)</p>

<p>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.</p>]]></long-description>
          <tag line="366" name="access" description="public"/>
          <tag line="366" name="param" description="" type="String" variable="$iv">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="375">
          <name>$iv</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="398" package="Crypt\TerraDES">
        <name>_generate_xor</name>
        <full_name>_generate_xor</full_name>
        <docblock line="386">
          <description><![CDATA[Generate CTR XOR encryption key]]></description>
          <long-description><![CDATA[<p>Encrypt the output of this and XOR it against the ciphertext / plaintext to get the
plaintext / ciphertext in CTR mode.</p>]]></long-description>
          <tag line="386" name="see" description="\global\Crypt_TripleDES::decrypt()" refers="\global\Crypt_TripleDES::decrypt()"/>
          <tag line="386" name="see" description="\global\Crypt_TripleDES::encrypt()" refers="\global\Crypt_TripleDES::encrypt()"/>
          <tag line="386" name="access" description="private"/>
          <tag line="386" name="param" description="" type="Integer" variable="$length">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="386" name="param" description="" type="String" variable="$iv">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="398">
          <name>$length</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="398">
          <name>$iv</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="430" package="Crypt\TerraDES">
        <name>encrypt</name>
        <full_name>encrypt</full_name>
        <docblock line="424">
          <description><![CDATA[Encrypts a message.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="424" name="access" description="public"/>
          <tag line="424" name="param" description="" type="String" variable="$plaintext">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="430">
          <name>$plaintext</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="637" package="Crypt\TerraDES">
        <name>decrypt</name>
        <full_name>decrypt</full_name>
        <docblock line="631">
          <description><![CDATA[Decrypts a message.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="631" name="access" description="public"/>
          <tag line="631" name="param" description="" type="String" variable="$ciphertext">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="637">
          <name>$ciphertext</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="876" package="Crypt\TerraDES">
        <name>enableContinuousBuffer</name>
        <full_name>enableContinuousBuffer</full_name>
        <docblock line="839">
          <description><![CDATA[Treat consecutive "packets" as if they are a continuous buffer.]]></description>
          <long-description><![CDATA[<p>Say you have a 16-byte plaintext $plaintext.  Using the default behavior, the two following code snippets
will yield different outputs:</p>

<pre><code>   echo $des->encrypt(substr($plaintext, 0, 8));
   echo $des->encrypt(substr($plaintext, 8, 8));
</code></pre>

<pre><code>   echo $des->encrypt($plaintext);
</code></pre>

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

<pre><code>   $des->encrypt(substr($plaintext, 0, 8));
   echo $des->decrypt($des->encrypt(substr($plaintext, 8, 8)));
</code></pre>

<pre><code>   echo $des->decrypt($des->encrypt(substr($plaintext, 8, 8)));
</code></pre>

<p>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.</p>

<p>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.</p>]]></long-description>
          <tag line="839" name="see" description="\global\Crypt_TripleDES::disableContinuousBuffer()" refers="\global\Crypt_TripleDES::disableContinuousBuffer()"/>
          <tag line="839" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="894" package="Crypt\TerraDES">
        <name>disableContinuousBuffer</name>
        <full_name>disableContinuousBuffer</full_name>
        <docblock line="886">
          <description><![CDATA[Treat consecutive packets as if they are a discontinuous buffer.]]></description>
          <long-description><![CDATA[<p>The default behavior.</p>]]></long-description>
          <tag line="886" name="see" description="\global\Crypt_TripleDES::enableContinuousBuffer()" refers="\global\Crypt_TripleDES::enableContinuousBuffer()"/>
          <tag line="886" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="921" package="Crypt\TerraDES">
        <name>enablePadding</name>
        <full_name>enablePadding</full_name>
        <docblock line="907">
          <description><![CDATA[Pad "packets".]]></description>
          <long-description><![CDATA[<p>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.</p>

<p>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)</p>]]></long-description>
          <tag line="907" name="see" description="\global\Crypt_TripleDES::disablePadding()" refers="\global\Crypt_TripleDES::disablePadding()"/>
          <tag line="907" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="932" package="Crypt\TerraDES">
        <name>disablePadding</name>
        <full_name>disablePadding</full_name>
        <docblock line="926">
          <description><![CDATA[Do not pad packets.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="926" name="see" description="\global\Crypt_TripleDES::enablePadding()" refers="\global\Crypt_TripleDES::enablePadding()"/>
          <tag line="926" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="949" package="Crypt\TerraDES">
        <name>_pad</name>
        <full_name>_pad</full_name>
        <docblock line="937">
          <description><![CDATA[Pads a string]]></description>
          <long-description><![CDATA[<p>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)</p>

<p>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.</p>]]></long-description>
          <tag line="937" name="see" description="\global\Crypt_TripleDES::_unpad()" refers="\global\Crypt_TripleDES::_unpad()"/>
          <tag line="937" name="access" description="private"/>
        </docblock>
        <argument line="949">
          <name>$text</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="975" package="Crypt\TerraDES">
        <name>_unpad</name>
        <full_name>_unpad</full_name>
        <docblock line="966">
          <description><![CDATA[Unpads a string]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="966" name="see" description="\global\Crypt_TripleDES::_pad()" refers="\global\Crypt_TripleDES::_pad()"/>
          <tag line="966" name="access" description="private"/>
        </docblock>
        <argument line="975">
          <name>$text</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1000" package="Crypt\TerraDES">
        <name>_string_shift</name>
        <full_name>_string_shift</full_name>
        <docblock line="990">
          <description><![CDATA[String Shift]]></description>
          <long-description><![CDATA[<p>Inspired by array_shift</p>]]></long-description>
          <tag line="990" name="param" description="" type="String" variable="$string">
            <type by_reference="false">String</type>
          </tag>
          <tag line="990" name="param" description="Integer $index" type="\optional" variable="$index">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="990" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="990" name="access" description="private"/>
        </docblock>
        <argument line="1000">
          <name>$string</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1000">
          <name>$index</name>
          <default><![CDATA[1]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <parse_markers>
      <error line="937" code="50015">Argument $text is missing from the Docblock of _pad()</error>
      <error line="966" code="50015">Argument $text is missing from the Docblock of _unpad()</error>
    </parse_markers>
  </file>
  <file path="lib/3rdParty/phpseclib/Crypt/AES.php" hash="f774eeb89a3bf03c3a594eea40d2538c" package="Crypt\AES">
    <docblock line="4">
      <description><![CDATA[Pure-PHP implementation of AES.]]></description>
      <long-description><![CDATA[<p>Uses mcrypt, if available, and an internal implementation, otherwise.</p>

<p>PHP versions 4 and 5</p>

<p>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.</p>

<p>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).</p>

<p>Here's a short example of how to use this library:</p>

<pre><code><?php
   include('Crypt/AES.php');

   $aes = new Crypt_AES();

   $aes->setKey('abcdefghijklmnop');

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

   echo $aes->decrypt($aes->encrypt($plaintext));
?>
</code></pre>

<p>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:</p>

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

<p>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.</p>]]></long-description>
      <tag line="4" name="category" description="Crypt"/>
      <tag line="4" name="package" description="Crypt_AES"/>
      <tag line="4" name="author" description="Jim Wigginton &lt;terrafrost@php.net&gt;"/>
      <tag line="4" name="copyright" description="MMVIII Jim Wigginton"/>
      <tag line="4" name="license" description="http://www.opensource.org/licenses/mit-license.html  MIT License"/>
      <tag line="4" name="version" description="$Id: AES.php 4105 2011-05-19 18:02:11Z gruberroland $"/>
      <tag line="4" name="link" description="http://phpseclib.sourceforge.net" link="http://phpseclib.sourceforge.net"/>
    </docblock>
    <include line="69" type="Require Once" package="main">
      <name>Rijndael.php</name>
      <docblock line="66">
        <description><![CDATA[Include Crypt_Rijndael]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <constant namespace="global" line="83" package="Crypt\AES">
      <name>CRYPT_AES_MODE_CTR</name>
      <full_name>\CRYPT_AES_MODE_CTR</full_name>
      <value><![CDATA[-1]]></value>
      <docblock line="76">
        <description><![CDATA[Encrypt / decrypt using the Counter mode.]]></description>
        <long-description><![CDATA[<p>Set to -1 since that's what Crypt/Random.php uses to index the CTR mode.</p>]]></long-description>
        <tag line="76" name="link" description="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Counter_.28CTR.29" link="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Counter_.28CTR.29"/>
      </docblock>
    </constant>
    <constant namespace="global" line="89" package="Crypt\AES">
      <name>CRYPT_AES_MODE_ECB</name>
      <full_name>\CRYPT_AES_MODE_ECB</full_name>
      <value><![CDATA[1]]></value>
      <docblock line="84">
        <description><![CDATA[Encrypt / decrypt using the Electronic Code Book mode.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="84" name="link" description="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Electronic_codebook_.28ECB.29" link="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Electronic_codebook_.28ECB.29"/>
      </docblock>
    </constant>
    <constant namespace="global" line="95" package="Crypt\AES">
      <name>CRYPT_AES_MODE_CBC</name>
      <full_name>\CRYPT_AES_MODE_CBC</full_name>
      <value><![CDATA[2]]></value>
      <docblock line="90">
        <description><![CDATA[Encrypt / decrypt using the Code Book Chaining mode.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="90" name="link" description="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Cipher-block_chaining_.28CBC.29" link="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Cipher-block_chaining_.28CBC.29"/>
      </docblock>
    </constant>
    <constant namespace="global" line="101" package="Crypt\AES">
      <name>CRYPT_AES_MODE_CFB</name>
      <full_name>\CRYPT_AES_MODE_CFB</full_name>
      <value><![CDATA[3]]></value>
      <docblock line="96">
        <description><![CDATA[Encrypt / decrypt using the Cipher Feedback mode.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="96" name="link" description="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Cipher_feedback_.28CFB.29" link="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Cipher_feedback_.28CFB.29"/>
      </docblock>
    </constant>
    <constant namespace="global" line="107" package="Crypt\AES">
      <name>CRYPT_AES_MODE_OFB</name>
      <full_name>\CRYPT_AES_MODE_OFB</full_name>
      <value><![CDATA[4]]></value>
      <docblock line="102">
        <description><![CDATA[Encrypt / decrypt using the Cipher Feedback mode.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="102" name="link" description="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Output_feedback_.28OFB.29" link="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Output_feedback_.28OFB.29"/>
      </docblock>
    </constant>
    <constant namespace="global" line="117" package="Crypt\AES">
      <name>CRYPT_AES_MODE_INTERNAL</name>
      <full_name>\CRYPT_AES_MODE_INTERNAL</full_name>
      <value><![CDATA[1]]></value>
      <docblock line="114">
        <description><![CDATA[Toggles the internal implementation]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="121" package="Crypt\AES">
      <name>CRYPT_AES_MODE_MCRYPT</name>
      <full_name>\CRYPT_AES_MODE_MCRYPT</full_name>
      <value><![CDATA[2]]></value>
      <docblock line="118">
        <description><![CDATA[Toggles the mcrypt implementation]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="188" package="Crypt\AES">
      <name>CRYPT_AES_MODE</name>
      <full_name>\CRYPT_AES_MODE</full_name>
      <value><![CDATA[CRYPT_AES_MODE_INTERNAL]]></value>
    </constant>
    <class final="false" abstract="false" namespace="global" line="132" package="Crypt\AES">
      <extends>\Crypt_Rijndael</extends>
      <name>Crypt_AES</name>
      <full_name>\Crypt_AES</full_name>
      <docblock line="124">
        <description><![CDATA[Pure-PHP implementation of AES.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="124" name="author" description="Jim Wigginton &lt;terrafrost@php.net&gt;"/>
        <tag line="124" name="version" description="0.1.0"/>
        <tag line="124" name="access" description="public"/>
        <tag line="124" name="package" description="Crypt_AES"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="143" namespace="global" package="main">
        <name>$enmcrypt</name>
        <default><![CDATA[]]></default>
        <docblock line="133">
          <description><![CDATA[mcrypt resource for encryption]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="133" name="see" description="\global\Crypt_AES::encrypt()" refers="\global\Crypt_AES::encrypt()"/>
          <tag line="133" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="133" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="155" namespace="global" package="main">
        <name>$demcrypt</name>
        <default><![CDATA[]]></default>
        <docblock line="145">
          <description><![CDATA[mcrypt resource for decryption]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="145" name="see" description="\global\Crypt_AES::decrypt()" refers="\global\Crypt_AES::decrypt()"/>
          <tag line="145" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="145" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="165" namespace="global" package="main">
        <name>$ecb</name>
        <default><![CDATA[]]></default>
        <docblock line="157">
          <description><![CDATA[mcrypt resource for CFB mode]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="157" name="see" description="\global\Crypt_AES::encrypt()" refers="\global\Crypt_AES::encrypt()"/>
          <tag line="157" name="see" description="\global\Crypt_AES::decrypt()" refers="\global\Crypt_AES::decrypt()"/>
          <tag line="157" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="157" name="access" description="private"/>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="177" package="Crypt\AES">
        <name>Crypt_AES</name>
        <full_name>Crypt_AES</full_name>
        <docblock line="167">
          <description><![CDATA[Default Constructor.]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="167" name="param" description="Integer $mode" type="\optional" variable="$mode">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="167" name="return" description="" type="\Crypt_AES">
            <type by_reference="false">\Crypt_AES</type>
          </tag>
          <tag line="167" name="access" description="public"/>
        </docblock>
        <argument line="177">
          <name>$mode</name>
          <default><![CDATA[CRYPT_AES_MODE_CBC]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="256" package="Crypt\AES">
        <name>setBlockLength</name>
        <full_name>setBlockLength</full_name>
        <docblock line="248">
          <description><![CDATA[Dummy function]]></description>
          <long-description><![CDATA[<p>Since Crypt_AES extends Crypt_Rijndael, this function is, technically, available, but it doesn't do anything.</p>]]></long-description>
          <tag line="248" name="access" description="public"/>
          <tag line="248" name="param" description="" type="Integer" variable="$length">
            <type by_reference="false">Integer</type>
          </tag>
        </docblock>
        <argument line="256">
          <name>$length</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="278" package="Crypt\AES">
        <name>encrypt</name>
        <full_name>encrypt</full_name>
        <docblock line="261">
          <description><![CDATA[Encrypts a message.]]></description>
          <long-description><![CDATA[<p>$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:</p>

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

<p>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.</p>]]></long-description>
          <tag line="261" name="see" description="\global\Crypt_AES::decrypt()" refers="\global\Crypt_AES::decrypt()"/>
          <tag line="261" name="access" description="public"/>
          <tag line="261" name="param" description="" type="String" variable="$plaintext">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="278">
          <name>$plaintext</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="356" package="Crypt\AES">
        <name>decrypt</name>
        <full_name>decrypt</full_name>
        <docblock line="347">
          <description><![CDATA[Decrypts a message.]]></description>
          <long-description><![CDATA[<p>If strlen($ciphertext) is not a multiple of 16, null bytes will be added to the end of the string until it is.</p>]]></long-description>
          <tag line="347" name="see" description="\global\Crypt_AES::encrypt()" refers="\global\Crypt_AES::encrypt()"/>
          <tag line="347" name="access" description="public"/>
          <tag line="347" name="param" description="" type="String" variable="$ciphertext">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="356">
          <name>$ciphertext</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="432" package="Crypt\AES">
        <name>_mcryptSetup</name>
        <full_name>_mcryptSetup</full_name>
        <docblock line="425">
          <description><![CDATA[Setup mcrypt]]></description>
          <long-description><![CDATA[<p>Validates all the variables.</p>]]></long-description>
          <tag line="425" name="access" description="private"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="490" package="Crypt\AES">
        <name>_encryptBlock</name>
        <full_name>_encryptBlock</full_name>
        <docblock line="480">
          <description><![CDATA[Encrypts a block]]></description>
          <long-description><![CDATA[<p>Optimized over Crypt_Rijndael's implementation by means of loop unrolling.</p>]]></long-description>
          <tag line="480" name="see" description="\global\Crypt_Rijndael::_encryptBlock()" refers="\global\Crypt_Rijndael::_encryptBlock()"/>
          <tag line="480" name="access" description="private"/>
          <tag line="480" name="param" description="" type="String" variable="$in">
            <type by_reference="false">String</type>
          </tag>
          <tag line="480" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="490">
          <name>$in</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="551" package="Crypt\AES">
        <name>_decryptBlock</name>
        <full_name>_decryptBlock</full_name>
        <docblock line="541">
          <description><![CDATA[Decrypts a block]]></description>
          <long-description><![CDATA[<p>Optimized over Crypt_Rijndael's implementation by means of loop unrolling.</p>]]></long-description>
          <tag line="541" name="see" description="\global\Crypt_Rijndael::_decryptBlock()" refers="\global\Crypt_Rijndael::_decryptBlock()"/>
          <tag line="541" name="access" description="private"/>
          <tag line="541" name="param" description="" type="String" variable="$in">
            <type by_reference="false">String</type>
          </tag>
          <tag line="541" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="551">
          <name>$in</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="lib/3rdParty/phpseclib/Crypt/RC4.php" hash="437d9bed3526e367fef644daefa5d3e4" package="Crypt\RC4">
    <docblock line="4">
      <description><![CDATA[Pure-PHP implementation of RC4.]]></description>
      <long-description><![CDATA[<p>Uses mcrypt, if available, and an internal implementation, otherwise.</p>

<p>PHP versions 4 and 5</p>

<p>Useful resources are as follows:</p>

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

<p>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.</p>

<p>Here's a short example of how to use this library:</p>

<pre><code><?php
   include('Crypt/RC4.php');

   $rc4 = new Crypt_RC4();

   $rc4->setKey('abcdefgh');

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

   echo $rc4->decrypt($rc4->encrypt($plaintext));
?>
</code></pre>

<p>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:</p>

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

<p>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.</p>]]></long-description>
      <tag line="4" name="category" description="Crypt"/>
      <tag line="4" name="package" description="Crypt_RC4"/>
      <tag line="4" name="author" description="Jim Wigginton &lt;terrafrost@php.net&gt;"/>
      <tag line="4" name="copyright" description="MMVII Jim Wigginton"/>
      <tag line="4" name="license" description="http://www.opensource.org/licenses/mit-license.html  MIT License"/>
      <tag line="4" name="version" description="$Id: RC4.php 4105 2011-05-19 18:02:11Z gruberroland $"/>
      <tag line="4" name="link" description="http://phpseclib.sourceforge.net" link="http://phpseclib.sourceforge.net"/>
    </docblock>
    <constant namespace="global" line="72" package="Crypt\RC4">
      <name>CRYPT_RC4_MODE_INTERNAL</name>
      <full_name>\CRYPT_RC4_MODE_INTERNAL</full_name>
      <value><![CDATA[1]]></value>
      <docblock line="69">
        <description><![CDATA[Toggles the internal implementation]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="76" package="Crypt\RC4">
      <name>CRYPT_RC4_MODE_MCRYPT</name>
      <full_name>\CRYPT_RC4_MODE_MCRYPT</full_name>
      <value><![CDATA[2]]></value>
      <docblock line="73">
        <description><![CDATA[Toggles the mcrypt implementation]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="83" package="Crypt\RC4">
      <name>CRYPT_RC4_ENCRYPT</name>
      <full_name>\CRYPT_RC4_ENCRYPT</full_name>
      <value><![CDATA[0]]></value>
    </constant>
    <constant namespace="global" line="84" package="Crypt\RC4">
      <name>CRYPT_RC4_DECRYPT</name>
      <full_name>\CRYPT_RC4_DECRYPT</full_name>
      <value><![CDATA[1]]></value>
    </constant>
    <constant namespace="global" line="194" package="Crypt\RC4">
      <name>CRYPT_RC4_MODE</name>
      <full_name>\CRYPT_RC4_MODE</full_name>
      <value><![CDATA[CRYPT_RC4_MODE_INTERNAL]]></value>
    </constant>
    <class final="false" abstract="false" namespace="global" line="95" package="Crypt\RC4">
      <extends/>
      <name>Crypt_RC4</name>
      <full_name>\Crypt_RC4</full_name>
      <docblock line="87">
        <description><![CDATA[Pure-PHP implementation of RC4.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="87" name="author" description="Jim Wigginton &lt;terrafrost@php.net&gt;"/>
        <tag line="87" name="version" description="0.1.0"/>
        <tag line="87" name="access" description="public"/>
        <tag line="87" name="package" description="Crypt_RC4"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="103" namespace="global" package="main">
        <name>$key</name>
        <default><![CDATA["\0"]]></default>
        <docblock line="96">
          <description><![CDATA[The Key]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="96" name="see" description="\global\Crypt_RC4::setKey()" refers="\global\Crypt_RC4::setKey()"/>
          <tag line="96" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="96" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="114" namespace="global" package="main">
        <name>$encryptStream</name>
        <default><![CDATA[false]]></default>
        <docblock line="105">
          <description><![CDATA[The Key Stream for encryption]]></description>
          <long-description><![CDATA[<p>If CRYPT_RC4_MODE == CRYPT_RC4_MODE_MCRYPT, this will be equal to the mcrypt object</p>]]></long-description>
          <tag line="105" name="see" description="\global\Crypt_RC4::setKey()" refers="\global\Crypt_RC4::setKey()"/>
          <tag line="105" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="105" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="125" namespace="global" package="main">
        <name>$decryptStream</name>
        <default><![CDATA[false]]></default>
        <docblock line="116">
          <description><![CDATA[The Key Stream for decryption]]></description>
          <long-description><![CDATA[<p>If CRYPT_RC4_MODE == CRYPT_RC4_MODE_MCRYPT, this will be equal to the mcrypt object</p>]]></long-description>
          <tag line="116" name="see" description="\global\Crypt_RC4::setKey()" refers="\global\Crypt_RC4::setKey()"/>
          <tag line="116" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="116" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="134" namespace="global" package="main">
        <name>$encryptIndex</name>
        <default><![CDATA[0]]></default>
        <docblock line="127">
          <description><![CDATA[The $i and $j indexes for encryption]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="127" name="see" description="\global\Crypt_RC4::_crypt()" refers="\global\Crypt_RC4::_crypt()"/>
          <tag line="127" name="var" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="127" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="143" namespace="global" package="main">
        <name>$decryptIndex</name>
        <default><![CDATA[0]]></default>
        <docblock line="136">
          <description><![CDATA[The $i and $j indexes for decryption]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="136" name="see" description="\global\Crypt_RC4::_crypt()" refers="\global\Crypt_RC4::_crypt()"/>
          <tag line="136" name="var" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="136" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="152" namespace="global" package="main">
        <name>$mcrypt</name>
        <default><![CDATA[array('', '')]]></default>
        <docblock line="145">
          <description><![CDATA[MCrypt parameters]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="145" name="see" description="\global\Crypt_RC4::setMCrypt()" refers="\global\Crypt_RC4::setMCrypt()"/>
          <tag line="145" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="145" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="163" namespace="global" package="main">
        <name>$mode</name>
        <default><![CDATA[]]></default>
        <docblock line="154">
          <description><![CDATA[The Encryption Algorithm]]></description>
          <long-description><![CDATA[<p>Only used if CRYPT_RC4_MODE == CRYPT_RC4_MODE_MCRYPT.  Only possible values are MCRYPT_RC4 or MCRYPT_ARCFOUR.</p>]]></long-description>
          <tag line="154" name="see" description="\global\Crypt_RC4::Crypt_RC4()" refers="\global\Crypt_RC4::Crypt_RC4()"/>
          <tag line="154" name="var" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="154" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="172" namespace="global" package="main">
        <name>$continuousBuffer</name>
        <default><![CDATA[false]]></default>
        <docblock line="165">
          <description><![CDATA[Continuous Buffer status]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="165" name="see" description="\global\Crypt_RC4::enableContinuousBuffer()" refers="\global\Crypt_RC4::enableContinuousBuffer()"/>
          <tag line="165" name="var" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="165" name="access" description="private"/>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="183" package="Crypt\RC4">
        <name>Crypt_RC4</name>
        <full_name>Crypt_RC4</full_name>
        <docblock line="174">
          <description><![CDATA[Default Constructor.]]></description>
          <long-description><![CDATA[<p>Determines whether or not the mcrypt extension should be used.</p>]]></long-description>
          <tag line="174" name="param" description="Integer $mode" type="\optional" variable="">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="174" name="return" description="" type="\Crypt_RC4">
            <type by_reference="false">\Crypt_RC4</type>
          </tag>
          <tag line="174" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="219" package="Crypt\RC4">
        <name>setKey</name>
        <full_name>setKey</full_name>
        <docblock line="210">
          <description><![CDATA[Sets the key.]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="210" name="access" description="public"/>
          <tag line="210" name="param" description="" type="String" variable="$key">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="219">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="263" package="Crypt\RC4">
        <name>setIV</name>
        <full_name>setIV</full_name>
        <docblock line="244">
          <description><![CDATA[Dummy function.]]></description>
          <long-description><![CDATA[<p>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().</p>

<p>[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:</p>

<p>{@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}</p>]]></long-description>
          <tag line="244" name="param" description="" type="String" variable="$iv">
            <type by_reference="false">String</type>
          </tag>
          <tag line="244" name="see" description="\global\Crypt_RC4::setKey()" refers="\global\Crypt_RC4::setKey()"/>
          <tag line="244" name="access" description="public"/>
        </docblock>
        <argument line="263">
          <name>$iv</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="277" package="Crypt\RC4">
        <name>setMCrypt</name>
        <full_name>setMCrypt</full_name>
        <docblock line="267">
          <description><![CDATA[Sets MCrypt parameters.]]></description>
          <long-description><![CDATA[<p>(optional)</p>

<p>If MCrypt is being used, empty strings will be used, unless otherwise specified.</p>]]></long-description>
          <tag line="267" name="link" description="http://php.net/function.mcrypt-module-open#function.mcrypt-module-open" link="http://php.net/function.mcrypt-module-open#function.mcrypt-module-open"/>
          <tag line="267" name="access" description="public"/>
          <tag line="267" name="param" description="Integer $algorithm_directory" type="\optional" variable="$algorithm_directory">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="267" name="param" description="Integer $mode_directory" type="\optional" variable="$mode_directory">
            <type by_reference="false">\optional</type>
          </tag>
        </docblock>
        <argument line="277">
          <name>$algorithm_directory</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
        <argument line="277">
          <name>$mode_directory</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="292" package="Crypt\RC4">
        <name>encrypt</name>
        <full_name>encrypt</full_name>
        <docblock line="285">
          <description><![CDATA[Encrypts a message.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="285" name="see" description="\global\Crypt_RC4::_crypt()" refers="\global\Crypt_RC4::_crypt()"/>
          <tag line="285" name="access" description="public"/>
          <tag line="285" name="param" description="" type="String" variable="$plaintext">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="292">
          <name>$plaintext</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="307" package="Crypt\RC4">
        <name>decrypt</name>
        <full_name>decrypt</full_name>
        <docblock line="297">
          <description><![CDATA[Decrypts a message.]]></description>
          <long-description><![CDATA[<p>$this->decrypt($this->encrypt($plaintext)) == $this->encrypt($this->encrypt($plaintext)).
Atleast if the continuous buffer is disabled.</p>]]></long-description>
          <tag line="297" name="see" description="\global\Crypt_RC4::_crypt()" refers="\global\Crypt_RC4::_crypt()"/>
          <tag line="297" name="access" description="public"/>
          <tag line="297" name="param" description="" type="String" variable="$ciphertext">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="307">
          <name>$ciphertext</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="321" package="Crypt\RC4">
        <name>_crypt</name>
        <full_name>_crypt</full_name>
        <docblock line="312">
          <description><![CDATA[Encrypts or decrypts a message.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="312" name="see" description="\global\Crypt_RC4::encrypt()" refers="\global\Crypt_RC4::encrypt()"/>
          <tag line="312" name="see" description="\global\Crypt_RC4::decrypt()" refers="\global\Crypt_RC4::decrypt()"/>
          <tag line="312" name="access" description="private"/>
          <tag line="312" name="param" description="" type="String" variable="$text">
            <type by_reference="false">String</type>
          </tag>
          <tag line="312" name="param" description="" type="Integer" variable="$mode">
            <type by_reference="false">Integer</type>
          </tag>
        </docblock>
        <argument line="321">
          <name>$text</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="321">
          <name>$mode</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="417" package="Crypt\RC4">
        <name>enableContinuousBuffer</name>
        <full_name>enableContinuousBuffer</full_name>
        <docblock line="380">
          <description><![CDATA[Treat consecutive "packets" as if they are a continuous buffer.]]></description>
          <long-description><![CDATA[<p>Say you have a 16-byte plaintext $plaintext.  Using the default behavior, the two following code snippets
will yield different outputs:</p>

<pre><code>   echo $rc4->encrypt(substr($plaintext, 0, 8));
   echo $rc4->encrypt(substr($plaintext, 8, 8));
</code></pre>

<pre><code>   echo $rc4->encrypt($plaintext);
</code></pre>

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

<pre><code>   $rc4->encrypt(substr($plaintext, 0, 8));
   echo $rc4->decrypt($des->encrypt(substr($plaintext, 8, 8)));
</code></pre>

<pre><code>   echo $rc4->decrypt($des->encrypt(substr($plaintext, 8, 8)));
</code></pre>

<p>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.</p>

<p>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.</p>]]></long-description>
          <tag line="380" name="see" description="\global\Crypt_RC4::disableContinuousBuffer()" refers="\global\Crypt_RC4::disableContinuousBuffer()"/>
          <tag line="380" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="430" package="Crypt\RC4">
        <name>disableContinuousBuffer</name>
        <full_name>disableContinuousBuffer</full_name>
        <docblock line="422">
          <description><![CDATA[Treat consecutive packets as if they are a discontinuous buffer.]]></description>
          <long-description><![CDATA[<p>The default behavior.</p>]]></long-description>
          <tag line="422" name="see" description="\global\Crypt_RC4::enableContinuousBuffer()" refers="\global\Crypt_RC4::enableContinuousBuffer()"/>
          <tag line="422" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="449" package="Crypt\RC4">
        <name>enablePadding</name>
        <full_name>enablePadding</full_name>
        <docblock line="440">
          <description><![CDATA[Dummy function.]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="440" name="see" description="\global\Crypt_RC4::disablePadding()" refers="\global\Crypt_RC4::disablePadding()"/>
          <tag line="440" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="459" package="Crypt\RC4">
        <name>disablePadding</name>
        <full_name>disablePadding</full_name>
        <docblock line="453">
          <description><![CDATA[Dummy function.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="453" name="see" description="\global\Crypt_RC4::enablePadding()" refers="\global\Crypt_RC4::enablePadding()"/>
          <tag line="453" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="471" package="Crypt\RC4">
        <name>__destruct</name>
        <full_name>__destruct</full_name>
        <docblock line="463">
          <description><![CDATA[Class destructor.]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="463" name="access" description="public"/>
        </docblock>
      </method>
    </class>
    <parse_markers>
      <notice line="174" code="50013">Parameter  could not be found in Crypt_RC4()</notice>
    </parse_markers>
  </file>
  <file path="lib/3rdParty/phpseclib/Crypt/DES.php" hash="a5b126545ee10145d0cd2e1a0bfde541" package="Crypt\DES">
    <docblock line="4">
      <description><![CDATA[Pure-PHP implementation of DES.]]></description>
      <long-description><![CDATA[<p>Uses mcrypt, if available, and an internal implementation, otherwise.</p>

<p>PHP versions 4 and 5</p>

<p>Useful resources are as follows:</p>

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

<p>Here's a short example of how to use this library:</p>

<pre><code><?php
   include('Crypt/DES.php');

   $des = new Crypt_DES();

   $des->setKey('abcdefgh');

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

   echo $des->decrypt($des->encrypt($plaintext));
?>
</code></pre>

<p>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:</p>

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

<p>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.</p>]]></long-description>
      <tag line="4" name="category" description="Crypt"/>
      <tag line="4" name="package" description="Crypt_DES"/>
      <tag line="4" name="author" description="Jim Wigginton &lt;terrafrost@php.net&gt;"/>
      <tag line="4" name="copyright" description="MMVII Jim Wigginton"/>
      <tag line="4" name="license" description="http://www.opensource.org/licenses/mit-license.html  MIT License"/>
      <tag line="4" name="version" description="$Id: DES.php 4105 2011-05-19 18:02:11Z gruberroland $"/>
      <tag line="4" name="link" description="http://phpseclib.sourceforge.net" link="http://phpseclib.sourceforge.net"/>
    </docblock>
    <constant namespace="global" line="71" package="Crypt\DES">
      <name>CRYPT_DES_ENCRYPT</name>
      <full_name>\CRYPT_DES_ENCRYPT</full_name>
      <value><![CDATA[0]]></value>
      <docblock line="68">
        <description><![CDATA[Contains array_reverse($keys[CRYPT_DES_DECRYPT])]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="75" package="Crypt\DES">
      <name>CRYPT_DES_DECRYPT</name>
      <full_name>\CRYPT_DES_DECRYPT</full_name>
      <value><![CDATA[1]]></value>
      <docblock line="72">
        <description><![CDATA[Contains array_reverse($keys[CRYPT_DES_ENCRYPT])]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="90" package="Crypt\DES">
      <name>CRYPT_DES_MODE_CTR</name>
      <full_name>\CRYPT_DES_MODE_CTR</full_name>
      <value><![CDATA[-1]]></value>
      <docblock line="83">
        <description><![CDATA[Encrypt / decrypt using the Counter mode.]]></description>
        <long-description><![CDATA[<p>Set to -1 since that's what Crypt/Random.php uses to index the CTR mode.</p>]]></long-description>
        <tag line="83" name="link" description="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Counter_.28CTR.29" link="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Counter_.28CTR.29"/>
      </docblock>
    </constant>
    <constant namespace="global" line="96" package="Crypt\DES">
      <name>CRYPT_DES_MODE_ECB</name>
      <full_name>\CRYPT_DES_MODE_ECB</full_name>
      <value><![CDATA[1]]></value>
      <docblock line="91">
        <description><![CDATA[Encrypt / decrypt using the Electronic Code Book mode.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="91" name="link" description="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Electronic_codebook_.28ECB.29" link="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Electronic_codebook_.28ECB.29"/>
      </docblock>
    </constant>
    <constant namespace="global" line="102" package="Crypt\DES">
      <name>CRYPT_DES_MODE_CBC</name>
      <full_name>\CRYPT_DES_MODE_CBC</full_name>
      <value><![CDATA[2]]></value>
      <docblock line="97">
        <description><![CDATA[Encrypt / decrypt using the Code Book Chaining mode.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="97" name="link" description="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Cipher-block_chaining_.28CBC.29" link="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Cipher-block_chaining_.28CBC.29"/>
      </docblock>
    </constant>
    <constant namespace="global" line="108" package="Crypt\DES">
      <name>CRYPT_DES_MODE_CFB</name>
      <full_name>\CRYPT_DES_MODE_CFB</full_name>
      <value><![CDATA[3]]></value>
      <docblock line="103">
        <description><![CDATA[Encrypt / decrypt using the Cipher Feedback mode.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="103" name="link" description="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Cipher_feedback_.28CFB.29" link="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Cipher_feedback_.28CFB.29"/>
      </docblock>
    </constant>
    <constant namespace="global" line="114" package="Crypt\DES">
      <name>CRYPT_DES_MODE_OFB</name>
      <full_name>\CRYPT_DES_MODE_OFB</full_name>
      <value><![CDATA[4]]></value>
      <docblock line="109">
        <description><![CDATA[Encrypt / decrypt using the Cipher Feedback mode.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="109" name="link" description="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Output_feedback_.28OFB.29" link="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Output_feedback_.28OFB.29"/>
      </docblock>
    </constant>
    <constant namespace="global" line="124" package="Crypt\DES">
      <name>CRYPT_DES_MODE_INTERNAL</name>
      <full_name>\CRYPT_DES_MODE_INTERNAL</full_name>
      <value><![CDATA[1]]></value>
      <docblock line="121">
        <description><![CDATA[Toggles the internal implementation]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="128" package="Crypt\DES">
      <name>CRYPT_DES_MODE_MCRYPT</name>
      <full_name>\CRYPT_DES_MODE_MCRYPT</full_name>
      <value><![CDATA[2]]></value>
      <docblock line="125">
        <description><![CDATA[Toggles the mcrypt implementation]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="305" package="Crypt\DES">
      <name>CRYPT_DES_MODE</name>
      <full_name>\CRYPT_DES_MODE</full_name>
      <value><![CDATA[CRYPT_DES_MODE_INTERNAL]]></value>
    </constant>
    <class final="false" abstract="false" namespace="global" line="139" package="Crypt\DES">
      <extends/>
      <name>Crypt_DES</name>
      <full_name>\Crypt_DES</full_name>
      <docblock line="131">
        <description><![CDATA[Pure-PHP implementation of DES.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="131" name="author" description="Jim Wigginton &lt;terrafrost@php.net&gt;"/>
        <tag line="131" name="version" description="0.1.0"/>
        <tag line="131" name="access" description="public"/>
        <tag line="131" name="package" description="Crypt_DES"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="147" namespace="global" package="main">
        <name>$keys</name>
        <default><![CDATA["\0\0\0\0\0\0\0\0"]]></default>
        <docblock line="140">
          <description><![CDATA[The Key Schedule]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="140" name="see" description="\global\Crypt_DES::setKey()" refers="\global\Crypt_DES::setKey()"/>
          <tag line="140" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="140" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="156" namespace="global" package="main">
        <name>$mode</name>
        <default><![CDATA[]]></default>
        <docblock line="149">
          <description><![CDATA[The Encryption Mode]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="149" name="see" description="\global\Crypt_DES::Crypt_DES()" refers="\global\Crypt_DES::Crypt_DES()"/>
          <tag line="149" name="var" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="149" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="165" namespace="global" package="main">
        <name>$continuousBuffer</name>
        <default><![CDATA[false]]></default>
        <docblock line="158">
          <description><![CDATA[Continuous Buffer status]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="158" name="see" description="\global\Crypt_DES::enableContinuousBuffer()" refers="\global\Crypt_DES::enableContinuousBuffer()"/>
          <tag line="158" name="var" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="158" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="174" namespace="global" package="main">
        <name>$padding</name>
        <default><![CDATA[true]]></default>
        <docblock line="167">
          <description><![CDATA[Padding status]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="167" name="see" description="\global\Crypt_DES::enablePadding()" refers="\global\Crypt_DES::enablePadding()"/>
          <tag line="167" name="var" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="167" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="183" namespace="global" package="main">
        <name>$iv</name>
        <default><![CDATA["\0\0\0\0\0\0\0\0"]]></default>
        <docblock line="176">
          <description><![CDATA[The Initialization Vector]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="176" name="see" description="\global\Crypt_DES::setIV()" refers="\global\Crypt_DES::setIV()"/>
          <tag line="176" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="176" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="192" namespace="global" package="main">
        <name>$encryptIV</name>
        <default><![CDATA["\0\0\0\0\0\0\0\0"]]></default>
        <docblock line="185">
          <description><![CDATA[A "sliding" Initialization Vector]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="185" name="see" description="\global\Crypt_DES::enableContinuousBuffer()" refers="\global\Crypt_DES::enableContinuousBuffer()"/>
          <tag line="185" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="185" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="201" namespace="global" package="main">
        <name>$decryptIV</name>
        <default><![CDATA["\0\0\0\0\0\0\0\0"]]></default>
        <docblock line="194">
          <description><![CDATA[A "sliding" Initialization Vector]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="194" name="see" description="\global\Crypt_DES::enableContinuousBuffer()" refers="\global\Crypt_DES::enableContinuousBuffer()"/>
          <tag line="194" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="194" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="213" namespace="global" package="main">
        <name>$enmcrypt</name>
        <default><![CDATA[]]></default>
        <docblock line="203">
          <description><![CDATA[mcrypt resource for encryption]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="203" name="see" description="\global\Crypt_DES::encrypt()" refers="\global\Crypt_DES::encrypt()"/>
          <tag line="203" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="203" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="225" namespace="global" package="main">
        <name>$demcrypt</name>
        <default><![CDATA[]]></default>
        <docblock line="215">
          <description><![CDATA[mcrypt resource for decryption]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="215" name="see" description="\global\Crypt_DES::decrypt()" refers="\global\Crypt_DES::decrypt()"/>
          <tag line="215" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="215" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="235" namespace="global" package="main">
        <name>$enchanged</name>
        <default><![CDATA[true]]></default>
        <docblock line="227">
          <description><![CDATA[Does the enmcrypt resource need to be (re)initialized?]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="227" name="see" description="\global\Crypt_DES::setKey()" refers="\global\Crypt_DES::setKey()"/>
          <tag line="227" name="see" description="\global\Crypt_DES::setIV()" refers="\global\Crypt_DES::setIV()"/>
          <tag line="227" name="var" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="227" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="245" namespace="global" package="main">
        <name>$dechanged</name>
        <default><![CDATA[true]]></default>
        <docblock line="237">
          <description><![CDATA[Does the demcrypt resource need to be (re)initialized?]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="237" name="see" description="\global\Crypt_DES::setKey()" refers="\global\Crypt_DES::setKey()"/>
          <tag line="237" name="see" description="\global\Crypt_DES::setIV()" refers="\global\Crypt_DES::setIV()"/>
          <tag line="237" name="var" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="237" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="254" namespace="global" package="main">
        <name>$paddable</name>
        <default><![CDATA[false]]></default>
        <docblock line="247">
          <description><![CDATA[Is the mode one that is paddable?]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="247" name="see" description="\global\Crypt_DES::Crypt_DES()" refers="\global\Crypt_DES::Crypt_DES()"/>
          <tag line="247" name="var" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="247" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="263" namespace="global" package="main">
        <name>$enbuffer</name>
        <default><![CDATA['']]></default>
        <docblock line="256">
          <description><![CDATA[Encryption buffer for CTR, OFB and CFB modes]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="256" name="see" description="\global\Crypt_DES::encrypt()" refers="\global\Crypt_DES::encrypt()"/>
          <tag line="256" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="256" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="272" namespace="global" package="main">
        <name>$debuffer</name>
        <default><![CDATA['']]></default>
        <docblock line="265">
          <description><![CDATA[Decryption buffer for CTR, OFB and CFB modes]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="265" name="see" description="\global\Crypt_DES::decrypt()" refers="\global\Crypt_DES::decrypt()"/>
          <tag line="265" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="265" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="282" namespace="global" package="main">
        <name>$ecb</name>
        <default><![CDATA[]]></default>
        <docblock line="274">
          <description><![CDATA[mcrypt resource for CFB mode]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="274" name="see" description="\global\Crypt_DES::encrypt()" refers="\global\Crypt_DES::encrypt()"/>
          <tag line="274" name="see" description="\global\Crypt_DES::decrypt()" refers="\global\Crypt_DES::decrypt()"/>
          <tag line="274" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="274" name="access" description="private"/>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="294" package="Crypt\DES">
        <name>Crypt_DES</name>
        <full_name>Crypt_DES</full_name>
        <docblock line="284">
          <description><![CDATA[Default Constructor.]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="284" name="param" description="Integer $mode" type="\optional" variable="$mode">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="284" name="return" description="" type="\Crypt_DES">
            <type by_reference="false">\Crypt_DES</type>
          </tag>
          <tag line="284" name="access" description="public"/>
        </docblock>
        <argument line="294">
          <name>$mode</name>
          <default><![CDATA[CRYPT_MODE_DES_CBC]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="366" package="Crypt\DES">
        <name>setKey</name>
        <full_name>setKey</full_name>
        <docblock line="352">
          <description><![CDATA[Sets the key.]]></description>
          <long-description><![CDATA[<p>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.</p>

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

<p>If the key is not explicitly set, it'll be assumed to be all zero's.</p>]]></long-description>
          <tag line="352" name="access" description="public"/>
          <tag line="352" name="param" description="" type="String" variable="$key">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="366">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="381" package="Crypt\DES">
        <name>setIV</name>
        <full_name>setIV</full_name>
        <docblock line="372">
          <description><![CDATA[Sets the initialization vector.]]></description>
          <long-description><![CDATA[<p>(optional)</p>

<p>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.</p>]]></long-description>
          <tag line="372" name="access" description="public"/>
          <tag line="372" name="param" description="" type="String" variable="$iv">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="381">
          <name>$iv</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="399" package="Crypt\DES">
        <name>_generate_xor</name>
        <full_name>_generate_xor</full_name>
        <docblock line="387">
          <description><![CDATA[Generate CTR XOR encryption key]]></description>
          <long-description><![CDATA[<p>Encrypt the output of this and XOR it against the ciphertext / plaintext to get the
plaintext / ciphertext in CTR mode.</p>]]></long-description>
          <tag line="387" name="see" description="\global\Crypt_DES::decrypt()" refers="\global\Crypt_DES::decrypt()"/>
          <tag line="387" name="see" description="\global\Crypt_DES::encrypt()" refers="\global\Crypt_DES::encrypt()"/>
          <tag line="387" name="access" description="public"/>
          <tag line="387" name="param" description="" type="Integer" variable="$length">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="387" name="param" description="" type="String" variable="$iv">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="399">
          <name>$length</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="399">
          <name>$iv</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="442" package="Crypt\DES">
        <name>encrypt</name>
        <full_name>encrypt</full_name>
        <docblock line="425">
          <description><![CDATA[Encrypts a message.]]></description>
          <long-description><![CDATA[<p>$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:</p>

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

<p>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.</p>]]></long-description>
          <tag line="425" name="see" description="\global\Crypt_DES::decrypt()" refers="\global\Crypt_DES::decrypt()"/>
          <tag line="425" name="access" description="public"/>
          <tag line="425" name="param" description="" type="String" variable="$plaintext">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="442">
          <name>$plaintext</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="615" package="Crypt\DES">
        <name>decrypt</name>
        <full_name>decrypt</full_name>
        <docblock line="606">
          <description><![CDATA[Decrypts a message.]]></description>
          <long-description><![CDATA[<p>If strlen($ciphertext) is not a multiple of 8, null bytes will be added to the end of the string until it is.</p>]]></long-description>
          <tag line="606" name="see" description="\global\Crypt_DES::encrypt()" refers="\global\Crypt_DES::encrypt()"/>
          <tag line="606" name="access" description="public"/>
          <tag line="606" name="param" description="" type="String" variable="$ciphertext">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="615">
          <name>$ciphertext</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="820" package="Crypt\DES">
        <name>enableContinuousBuffer</name>
        <full_name>enableContinuousBuffer</full_name>
        <docblock line="783">
          <description><![CDATA[Treat consecutive "packets" as if they are a continuous buffer.]]></description>
          <long-description><![CDATA[<p>Say you have a 16-byte plaintext $plaintext.  Using the default behavior, the two following code snippets
will yield different outputs:</p>

<pre><code>   echo $des->encrypt(substr($plaintext, 0, 8));
   echo $des->encrypt(substr($plaintext, 8, 8));
</code></pre>

<pre><code>   echo $des->encrypt($plaintext);
</code></pre>

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

<pre><code>   $des->encrypt(substr($plaintext, 0, 8));
   echo $des->decrypt($des->encrypt(substr($plaintext, 8, 8)));
</code></pre>

<pre><code>   echo $des->decrypt($des->encrypt(substr($plaintext, 8, 8)));
</code></pre>

<p>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.</p>

<p>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.</p>]]></long-description>
          <tag line="783" name="see" description="\global\Crypt_DES::disableContinuousBuffer()" refers="\global\Crypt_DES::disableContinuousBuffer()"/>
          <tag line="783" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="833" package="Crypt\DES">
        <name>disableContinuousBuffer</name>
        <full_name>disableContinuousBuffer</full_name>
        <docblock line="825">
          <description><![CDATA[Treat consecutive packets as if they are a discontinuous buffer.]]></description>
          <long-description><![CDATA[<p>The default behavior.</p>]]></long-description>
          <tag line="825" name="see" description="\global\Crypt_DES::enableContinuousBuffer()" refers="\global\Crypt_DES::enableContinuousBuffer()"/>
          <tag line="825" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="854" package="Crypt\DES">
        <name>enablePadding</name>
        <full_name>enablePadding</full_name>
        <docblock line="840">
          <description><![CDATA[Pad "packets".]]></description>
          <long-description><![CDATA[<p>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.</p>

<p>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)</p>]]></long-description>
          <tag line="840" name="see" description="\global\Crypt_DES::disablePadding()" refers="\global\Crypt_DES::disablePadding()"/>
          <tag line="840" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="865" package="Crypt\DES">
        <name>disablePadding</name>
        <full_name>disablePadding</full_name>
        <docblock line="859">
          <description><![CDATA[Do not pad packets.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="859" name="see" description="\global\Crypt_DES::enablePadding()" refers="\global\Crypt_DES::enablePadding()"/>
          <tag line="859" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="882" package="Crypt\DES">
        <name>_pad</name>
        <full_name>_pad</full_name>
        <docblock line="870">
          <description><![CDATA[Pads a string]]></description>
          <long-description><![CDATA[<p>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)</p>

<p>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.</p>]]></long-description>
          <tag line="870" name="see" description="\global\Crypt_DES::_unpad()" refers="\global\Crypt_DES::_unpad()"/>
          <tag line="870" name="access" description="private"/>
        </docblock>
        <argument line="882">
          <name>$text</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="908" package="Crypt\DES">
        <name>_unpad</name>
        <full_name>_unpad</full_name>
        <docblock line="899">
          <description><![CDATA[Unpads a string]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="899" name="see" description="\global\Crypt_DES::_pad()" refers="\global\Crypt_DES::_pad()"/>
          <tag line="899" name="access" description="private"/>
        </docblock>
        <argument line="908">
          <name>$text</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="935" package="Crypt\DES">
        <name>_processBlock</name>
        <full_name>_processBlock</full_name>
        <docblock line="923">
          <description><![CDATA[Encrypts or decrypts a 64-bit block]]></description>
          <long-description><![CDATA[<p>$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.</p>]]></long-description>
          <tag line="923" name="access" description="private"/>
          <tag line="923" name="param" description="" type="String" variable="$block">
            <type by_reference="false">String</type>
          </tag>
          <tag line="923" name="param" description="" type="Integer" variable="$mode">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="923" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="935">
          <name>$block</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="935">
          <name>$mode</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1127" package="Crypt\DES">
        <name>_prepareKey</name>
        <full_name>_prepareKey</full_name>
        <docblock line="1120">
          <description><![CDATA[Creates the key schedule.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1120" name="access" description="private"/>
          <tag line="1120" name="param" description="" type="String" variable="$key">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1120" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
        </docblock>
        <argument line="1127">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1236" package="Crypt\DES">
        <name>_string_shift</name>
        <full_name>_string_shift</full_name>
        <docblock line="1226">
          <description><![CDATA[String Shift]]></description>
          <long-description><![CDATA[<p>Inspired by array_shift</p>]]></long-description>
          <tag line="1226" name="param" description="" type="String" variable="$string">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1226" name="param" description="Integer $index" type="\optional" variable="$index">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="1226" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1226" name="access" description="private"/>
        </docblock>
        <argument line="1236">
          <name>$string</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1236">
          <name>$index</name>
          <default><![CDATA[1]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <parse_markers>
      <error line="870" code="50015">Argument $text is missing from the Docblock of _pad()</error>
      <error line="899" code="50015">Argument $text is missing from the Docblock of _unpad()</error>
    </parse_markers>
  </file>
  <file path="lib/3rdParty/phpseclib/Crypt/Random.php" hash="45a77b83219b6eaef5c0696498052cdf" package="Crypt\Random">
    <docblock line="4">
      <description><![CDATA[Random Number Generator]]></description>
      <long-description><![CDATA[<p>PHP versions 4 and 5</p>

<p>Here's a short example of how to use this library:</p>

<pre><code><?php
   include('Crypt/Random.php');

   echo crypt_random();
?>
</code></pre>

<p>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:</p>

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

<p>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.</p>]]></long-description>
      <tag line="4" name="category" description="Crypt"/>
      <tag line="4" name="package" description="Crypt_Random"/>
      <tag line="4" name="author" description="Jim Wigginton &lt;terrafrost@php.net&gt;"/>
      <tag line="4" name="copyright" description="MMVII Jim Wigginton"/>
      <tag line="4" name="license" description="http://www.opensource.org/licenses/mit-license.html  MIT License"/>
      <tag line="4" name="version" description="$Id: Random.php 4105 2011-05-19 18:02:11Z gruberroland $"/>
      <tag line="4" name="link" description="http://phpseclib.sourceforge.net" link="http://phpseclib.sourceforge.net"/>
    </docblock>
    <function namespace="global" line="60" package="Crypt\Random">
      <name>crypt_random</name>
      <full_name>\crypt_random</full_name>
      <docblock line="45">
        <description><![CDATA[Generate a random value.]]></description>
        <long-description><![CDATA[<p>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.</p>

<p>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.</p>]]></long-description>
        <tag line="45" name="param" description="Integer $min" type="\optional" variable="$min">
          <type by_reference="false">\optional</type>
        </tag>
        <tag line="45" name="param" description="Integer $max" type="\optional" variable="$max">
          <type by_reference="false">\optional</type>
        </tag>
        <tag line="45" name="return" description="" type="Integer">
          <type by_reference="false">Integer</type>
        </tag>
        <tag line="45" name="access" description="public"/>
      </docblock>
      <argument line="60">
        <name>$min</name>
        <default><![CDATA[0]]></default>
        <type/>
      </argument>
      <argument line="60">
        <name>$max</name>
        <default><![CDATA[2147483647]]></default>
        <type/>
      </argument>
    </function>
  </file>
  <file path="lib/3rdParty/phpseclib/Crypt/Rijndael.php" hash="3ab293f861f943071631b725ce1a5484" package="Crypt\Rijndael">
    <docblock line="4">
      <description><![CDATA[Pure-PHP implementation of Rijndael.]]></description>
      <long-description><![CDATA[<p>Does not use mcrypt, even when available, for reasons that are explained below.</p>

<p>PHP versions 4 and 5</p>

<p>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.</p>

<p>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.</p>

<p>{@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}.}}</p>

<p>Here's a short example of how to use this library:</p>

<pre><code><?php
   include('Crypt/Rijndael.php');

   $rijndael = new Crypt_Rijndael();

   $rijndael->setKey('abcdefghijklmnop');

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

   echo $rijndael->decrypt($rijndael->encrypt($plaintext));
?>
</code></pre>

<p>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:</p>

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

<p>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.</p>]]></long-description>
      <tag line="4" name="category" description="Crypt"/>
      <tag line="4" name="package" description="Crypt_Rijndael"/>
      <tag line="4" name="author" description="Jim Wigginton &lt;terrafrost@php.net&gt;"/>
      <tag line="4" name="copyright" description="MMVIII Jim Wigginton"/>
      <tag line="4" name="license" description="http://www.opensource.org/licenses/mit-license.html  MIT License"/>
      <tag line="4" name="version" description="$Id: Rijndael.php 4105 2011-05-19 18:02:11Z gruberroland $"/>
      <tag line="4" name="link" description="http://phpseclib.sourceforge.net" link="http://phpseclib.sourceforge.net"/>
    </docblock>
    <constant namespace="global" line="86" package="Crypt\Rijndael">
      <name>CRYPT_RIJNDAEL_MODE_CTR</name>
      <full_name>\CRYPT_RIJNDAEL_MODE_CTR</full_name>
      <value><![CDATA[-1]]></value>
      <docblock line="79">
        <description><![CDATA[Encrypt / decrypt using the Counter mode.]]></description>
        <long-description><![CDATA[<p>Set to -1 since that's what Crypt/Random.php uses to index the CTR mode.</p>]]></long-description>
        <tag line="79" name="link" description="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Counter_.28CTR.29" link="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Counter_.28CTR.29"/>
      </docblock>
    </constant>
    <constant namespace="global" line="92" package="Crypt\Rijndael">
      <name>CRYPT_RIJNDAEL_MODE_ECB</name>
      <full_name>\CRYPT_RIJNDAEL_MODE_ECB</full_name>
      <value><![CDATA[1]]></value>
      <docblock line="87">
        <description><![CDATA[Encrypt / decrypt using the Electronic Code Book mode.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="87" name="link" description="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Electronic_codebook_.28ECB.29" link="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Electronic_codebook_.28ECB.29"/>
      </docblock>
    </constant>
    <constant namespace="global" line="98" package="Crypt\Rijndael">
      <name>CRYPT_RIJNDAEL_MODE_CBC</name>
      <full_name>\CRYPT_RIJNDAEL_MODE_CBC</full_name>
      <value><![CDATA[2]]></value>
      <docblock line="93">
        <description><![CDATA[Encrypt / decrypt using the Code Book Chaining mode.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="93" name="link" description="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Cipher-block_chaining_.28CBC.29" link="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Cipher-block_chaining_.28CBC.29"/>
      </docblock>
    </constant>
    <constant namespace="global" line="104" package="Crypt\Rijndael">
      <name>CRYPT_RIJNDAEL_MODE_CFB</name>
      <full_name>\CRYPT_RIJNDAEL_MODE_CFB</full_name>
      <value><![CDATA[3]]></value>
      <docblock line="99">
        <description><![CDATA[Encrypt / decrypt using the Cipher Feedback mode.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="99" name="link" description="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Cipher_feedback_.28CFB.29" link="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Cipher_feedback_.28CFB.29"/>
      </docblock>
    </constant>
    <constant namespace="global" line="110" package="Crypt\Rijndael">
      <name>CRYPT_RIJNDAEL_MODE_OFB</name>
      <full_name>\CRYPT_RIJNDAEL_MODE_OFB</full_name>
      <value><![CDATA[4]]></value>
      <docblock line="105">
        <description><![CDATA[Encrypt / decrypt using the Cipher Feedback mode.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="105" name="link" description="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Output_feedback_.28OFB.29" link="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Output_feedback_.28OFB.29"/>
      </docblock>
    </constant>
    <constant namespace="global" line="120" package="Crypt\Rijndael">
      <name>CRYPT_RIJNDAEL_MODE_INTERNAL</name>
      <full_name>\CRYPT_RIJNDAEL_MODE_INTERNAL</full_name>
      <value><![CDATA[1]]></value>
      <docblock line="117">
        <description><![CDATA[Toggles the internal implementation]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="124" package="Crypt\Rijndael">
      <name>CRYPT_RIJNDAEL_MODE_MCRYPT</name>
      <full_name>\CRYPT_RIJNDAEL_MODE_MCRYPT</full_name>
      <value><![CDATA[2]]></value>
      <docblock line="121">
        <description><![CDATA[Toggles the mcrypt implementation]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <class final="false" abstract="false" namespace="global" line="135" package="Crypt\Rijndael">
      <extends/>
      <name>Crypt_Rijndael</name>
      <full_name>\Crypt_Rijndael</full_name>
      <docblock line="127">
        <description><![CDATA[Pure-PHP implementation of Rijndael.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="127" name="author" description="Jim Wigginton &lt;terrafrost@php.net&gt;"/>
        <tag line="127" name="version" description="0.1.0"/>
        <tag line="127" name="access" description="public"/>
        <tag line="127" name="package" description="Crypt_Rijndael"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="143" namespace="global" package="main">
        <name>$mode</name>
        <default><![CDATA[]]></default>
        <docblock line="136">
          <description><![CDATA[The Encryption Mode]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="136" name="see" description="\global\Crypt_Rijndael::Crypt_Rijndael()" refers="\global\Crypt_Rijndael::Crypt_Rijndael()"/>
          <tag line="136" name="var" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="136" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="152" namespace="global" package="main">
        <name>$key</name>
        <default><![CDATA["\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0"]]></default>
        <docblock line="145">
          <description><![CDATA[The Key]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="145" name="see" description="\global\Crypt_Rijndael::setKey()" refers="\global\Crypt_Rijndael::setKey()"/>
          <tag line="145" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="145" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="161" namespace="global" package="main">
        <name>$iv</name>
        <default><![CDATA['']]></default>
        <docblock line="154">
          <description><![CDATA[The Initialization Vector]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="154" name="see" description="\global\Crypt_Rijndael::setIV()" refers="\global\Crypt_Rijndael::setIV()"/>
          <tag line="154" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="154" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="170" namespace="global" package="main">
        <name>$encryptIV</name>
        <default><![CDATA['']]></default>
        <docblock line="163">
          <description><![CDATA[A "sliding" Initialization Vector]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="163" name="see" description="\global\Crypt_Rijndael::enableContinuousBuffer()" refers="\global\Crypt_Rijndael::enableContinuousBuffer()"/>
          <tag line="163" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="163" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="179" namespace="global" package="main">
        <name>$decryptIV</name>
        <default><![CDATA['']]></default>
        <docblock line="172">
          <description><![CDATA[A "sliding" Initialization Vector]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="172" name="see" description="\global\Crypt_Rijndael::enableContinuousBuffer()" refers="\global\Crypt_Rijndael::enableContinuousBuffer()"/>
          <tag line="172" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="172" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="188" namespace="global" package="main">
        <name>$continuousBuffer</name>
        <default><![CDATA[false]]></default>
        <docblock line="181">
          <description><![CDATA[Continuous Buffer status]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="181" name="see" description="\global\Crypt_Rijndael::enableContinuousBuffer()" refers="\global\Crypt_Rijndael::enableContinuousBuffer()"/>
          <tag line="181" name="var" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="181" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="197" namespace="global" package="main">
        <name>$padding</name>
        <default><![CDATA[true]]></default>
        <docblock line="190">
          <description><![CDATA[Padding status]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="190" name="see" description="\global\Crypt_Rijndael::enablePadding()" refers="\global\Crypt_Rijndael::enablePadding()"/>
          <tag line="190" name="var" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="190" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="208" namespace="global" package="main">
        <name>$changed</name>
        <default><![CDATA[true]]></default>
        <docblock line="199">
          <description><![CDATA[Does the key schedule need to be (re)calculated?]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="199" name="see" description="\global\setKey()" refers="\global\setKey()"/>
          <tag line="199" name="see" description="\global\setBlockLength()" refers="\global\setBlockLength()"/>
          <tag line="199" name="see" description="\global\setKeyLength()" refers="\global\setKeyLength()"/>
          <tag line="199" name="var" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="199" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="217" namespace="global" package="main">
        <name>$explicit_key_length</name>
        <default><![CDATA[false]]></default>
        <docblock line="210">
          <description><![CDATA[Has the key length explicitly been set or should it be derived from the key, itself?]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="210" name="see" description="\global\setKeyLength()" refers="\global\setKeyLength()"/>
          <tag line="210" name="var" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="210" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="226" namespace="global" package="main">
        <name>$w</name>
        <default><![CDATA[]]></default>
        <docblock line="219">
          <description><![CDATA[The Key Schedule]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="219" name="see" description="\global\_setup()" refers="\global\_setup()"/>
          <tag line="219" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="219" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="235" namespace="global" package="main">
        <name>$dw</name>
        <default><![CDATA[]]></default>
        <docblock line="228">
          <description><![CDATA[The Inverse Key Schedule]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="228" name="see" description="\global\_setup()" refers="\global\_setup()"/>
          <tag line="228" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="228" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="246" namespace="global" package="main">
        <name>$block_size</name>
        <default><![CDATA[16]]></default>
        <docblock line="237">
          <description><![CDATA[The Block Length]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="237" name="see" description="\global\setBlockLength()" refers="\global\setBlockLength()"/>
          <tag line="237" name="var" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="237" name="access" description="private"/>
          <tag line="237" name="internal" description="The max value is 32, the min value is 16.  All valid values are multiples of 4.  Exists in conjunction with&#10;$Nb because we need this value and not $Nb to pad strings appropriately."/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="260" namespace="global" package="main">
        <name>$Nb</name>
        <default><![CDATA[4]]></default>
        <docblock line="248">
          <description><![CDATA[The Block Length divided by 32]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="248" name="see" description="\global\setBlockLength()" refers="\global\setBlockLength()"/>
          <tag line="248" name="var" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="248" name="access" description="private"/>
          <tag line="248" name="internal" description="The max value is 256 / 32 = 8, the min value is 128 / 32 = 4.  Exists in conjunction with $block_size&#10;because the encryption / decryption / key schedule creation requires this number and not $block_size.  We could&#10;derive this from $block_size or vice versa, but that'd mean we'd have to do multiple shift operations, so in lieu&#10;of that, we'll just precompute it once."/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="273" namespace="global" package="main">
        <name>$key_size</name>
        <default><![CDATA[16]]></default>
        <docblock line="262">
          <description><![CDATA[The Key Length]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="262" name="see" description="\global\setKeyLength()" refers="\global\setKeyLength()"/>
          <tag line="262" name="var" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="262" name="access" description="private"/>
          <tag line="262" name="internal" description="The max value is 256 / 8 = 32, the min value is 128 / 8 = 16.  Exists in conjunction with $key_size&#10;because the encryption / decryption / key schedule creation requires this number and not $key_size.  We could&#10;derive this from $key_size or vice versa, but that'd mean we'd have to do multiple shift operations, so in lieu&#10;of that, we'll just precompute it once."/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="283" namespace="global" package="main">
        <name>$Nk</name>
        <default><![CDATA[4]]></default>
        <docblock line="275">
          <description><![CDATA[The Key Length divided by 32]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="275" name="see" description="\global\setKeyLength()" refers="\global\setKeyLength()"/>
          <tag line="275" name="var" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="275" name="access" description="private"/>
          <tag line="275" name="internal" description="The max value is 256 / 32 = 8, the min value is 128 / 32 = 4"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="292" namespace="global" package="main">
        <name>$Nr</name>
        <default><![CDATA[]]></default>
        <docblock line="285">
          <description><![CDATA[The Number of Rounds]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="285" name="var" description="" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="285" name="access" description="private"/>
          <tag line="285" name="internal" description="The max value is 14, the min value is 10."/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="300" namespace="global" package="main">
        <name>$c</name>
        <default><![CDATA[]]></default>
        <docblock line="294">
          <description><![CDATA[Shift offsets]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="294" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="294" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="309" namespace="global" package="main">
        <name>$t0</name>
        <default><![CDATA[]]></default>
        <docblock line="302">
          <description><![CDATA[Precomputed mixColumns table]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="302" name="see" description="\global\Crypt_Rijndael()" refers="\global\Crypt_Rijndael()"/>
          <tag line="302" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="302" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="318" namespace="global" package="main">
        <name>$t1</name>
        <default><![CDATA[]]></default>
        <docblock line="311">
          <description><![CDATA[Precomputed mixColumns table]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="311" name="see" description="\global\Crypt_Rijndael()" refers="\global\Crypt_Rijndael()"/>
          <tag line="311" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="311" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="327" namespace="global" package="main">
        <name>$t2</name>
        <default><![CDATA[]]></default>
        <docblock line="320">
          <description><![CDATA[Precomputed mixColumns table]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="320" name="see" description="\global\Crypt_Rijndael()" refers="\global\Crypt_Rijndael()"/>
          <tag line="320" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="320" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="336" namespace="global" package="main">
        <name>$t3</name>
        <default><![CDATA[]]></default>
        <docblock line="329">
          <description><![CDATA[Precomputed mixColumns table]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="329" name="see" description="\global\Crypt_Rijndael()" refers="\global\Crypt_Rijndael()"/>
          <tag line="329" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="329" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="345" namespace="global" package="main">
        <name>$dt0</name>
        <default><![CDATA[]]></default>
        <docblock line="338">
          <description><![CDATA[Precomputed invMixColumns table]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="338" name="see" description="\global\Crypt_Rijndael()" refers="\global\Crypt_Rijndael()"/>
          <tag line="338" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="338" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="354" namespace="global" package="main">
        <name>$dt1</name>
        <default><![CDATA[]]></default>
        <docblock line="347">
          <description><![CDATA[Precomputed invMixColumns table]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="347" name="see" description="\global\Crypt_Rijndael()" refers="\global\Crypt_Rijndael()"/>
          <tag line="347" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="347" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="363" namespace="global" package="main">
        <name>$dt2</name>
        <default><![CDATA[]]></default>
        <docblock line="356">
          <description><![CDATA[Precomputed invMixColumns table]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="356" name="see" description="\global\Crypt_Rijndael()" refers="\global\Crypt_Rijndael()"/>
          <tag line="356" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="356" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="372" namespace="global" package="main">
        <name>$dt3</name>
        <default><![CDATA[]]></default>
        <docblock line="365">
          <description><![CDATA[Precomputed invMixColumns table]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="365" name="see" description="\global\Crypt_Rijndael()" refers="\global\Crypt_Rijndael()"/>
          <tag line="365" name="var" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
          <tag line="365" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="381" namespace="global" package="main">
        <name>$paddable</name>
        <default><![CDATA[false]]></default>
        <docblock line="374">
          <description><![CDATA[Is the mode one that is paddable?]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="374" name="see" description="\global\Crypt_Rijndael::Crypt_Rijndael()" refers="\global\Crypt_Rijndael::Crypt_Rijndael()"/>
          <tag line="374" name="var" description="" type="Boolean">
            <type by_reference="false">Boolean</type>
          </tag>
          <tag line="374" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="390" namespace="global" package="main">
        <name>$enbuffer</name>
        <default><![CDATA[array('encrypted' => '', 'xor' => '')]]></default>
        <docblock line="383">
          <description><![CDATA[Encryption buffer for CTR, OFB and CFB modes]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="383" name="see" description="\global\Crypt_Rijndael::encrypt()" refers="\global\Crypt_Rijndael::encrypt()"/>
          <tag line="383" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="383" name="access" description="private"/>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="399" namespace="global" package="main">
        <name>$debuffer</name>
        <default><![CDATA[array('ciphertext' => '')]]></default>
        <docblock line="392">
          <description><![CDATA[Decryption buffer for CTR, OFB and CFB modes]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="392" name="see" description="\global\Crypt_Rijndael::decrypt()" refers="\global\Crypt_Rijndael::decrypt()"/>
          <tag line="392" name="var" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="392" name="access" description="private"/>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="411" package="Crypt\Rijndael">
        <name>Crypt_Rijndael</name>
        <full_name>Crypt_Rijndael</full_name>
        <docblock line="401">
          <description><![CDATA[Default Constructor.]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="401" name="param" description="Integer $mode" type="\optional" variable="$mode">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="401" name="return" description="" type="\Crypt_Rijndael">
            <type by_reference="false">\Crypt_Rijndael</type>
          </tag>
          <tag line="401" name="access" description="public"/>
        </docblock>
        <argument line="411">
          <name>$mode</name>
          <default><![CDATA[CRYPT_RIJNDAEL_MODE_CBC]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="536" package="Crypt\Rijndael">
        <name>setKey</name>
        <full_name>setKey</full_name>
        <docblock line="523">
          <description><![CDATA[Sets the key.]]></description>
          <long-description><![CDATA[<p>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.</p>

<p>If the key is not explicitly set, it'll be assumed to be all null bytes.</p>]]></long-description>
          <tag line="523" name="access" description="public"/>
          <tag line="523" name="param" description="" type="String" variable="$key">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="536">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="551" package="Crypt\Rijndael">
        <name>setIV</name>
        <full_name>setIV</full_name>
        <docblock line="542">
          <description><![CDATA[Sets the initialization vector.]]></description>
          <long-description><![CDATA[<p>(optional)</p>

<p>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.</p>]]></long-description>
          <tag line="542" name="access" description="public"/>
          <tag line="542" name="param" description="" type="String" variable="$iv">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="551">
          <name>$iv</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="565" package="Crypt\Rijndael">
        <name>setKeyLength</name>
        <full_name>setKeyLength</full_name>
        <docblock line="556">
          <description><![CDATA[Sets the key length]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="556" name="access" description="public"/>
          <tag line="556" name="param" description="" type="Integer" variable="$length">
            <type by_reference="false">Integer</type>
          </tag>
        </docblock>
        <argument line="565">
          <name>$length</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="589" package="Crypt\Rijndael">
        <name>setBlockLength</name>
        <full_name>setBlockLength</full_name>
        <docblock line="580">
          <description><![CDATA[Sets the block length]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="580" name="access" description="public"/>
          <tag line="580" name="param" description="" type="Integer" variable="$length">
            <type by_reference="false">Integer</type>
          </tag>
        </docblock>
        <argument line="589">
          <name>$length</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="614" package="Crypt\Rijndael">
        <name>_generate_xor</name>
        <full_name>_generate_xor</full_name>
        <docblock line="602">
          <description><![CDATA[Generate CTR XOR encryption key]]></description>
          <long-description><![CDATA[<p>Encrypt the output of this and XOR it against the ciphertext / plaintext to get the
plaintext / ciphertext in CTR mode.</p>]]></long-description>
          <tag line="602" name="see" description="\global\Crypt_Rijndael::decrypt()" refers="\global\Crypt_Rijndael::decrypt()"/>
          <tag line="602" name="see" description="\global\Crypt_Rijndael::encrypt()" refers="\global\Crypt_Rijndael::encrypt()"/>
          <tag line="602" name="access" description="public"/>
          <tag line="602" name="param" description="" type="Integer" variable="$length">
            <type by_reference="false">Integer</type>
          </tag>
          <tag line="602" name="param" description="" type="String" variable="$iv">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="614">
          <name>$length</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="614">
          <name>$iv</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="659" package="Crypt\Rijndael">
        <name>encrypt</name>
        <full_name>encrypt</full_name>
        <docblock line="641">
          <description><![CDATA[Encrypts a message.]]></description>
          <long-description><![CDATA[<p>$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:</p>

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

<p>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.</p>]]></long-description>
          <tag line="641" name="see" description="\global\Crypt_Rijndael::decrypt()" refers="\global\Crypt_Rijndael::decrypt()"/>
          <tag line="641" name="access" description="public"/>
          <tag line="641" name="param" description="" type="String" variable="$plaintext">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="659">
          <name>$plaintext</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="778" package="Crypt\Rijndael">
        <name>decrypt</name>
        <full_name>decrypt</full_name>
        <docblock line="768">
          <description><![CDATA[Decrypts a message.]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="768" name="see" description="\global\Crypt_Rijndael::encrypt()" refers="\global\Crypt_Rijndael::encrypt()"/>
          <tag line="768" name="access" description="public"/>
          <tag line="768" name="param" description="" type="String" variable="$ciphertext">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="778">
          <name>$ciphertext</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="896" package="Crypt\Rijndael">
        <name>_encryptBlock</name>
        <full_name>_encryptBlock</full_name>
        <docblock line="889">
          <description><![CDATA[Encrypts a block]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="889" name="access" description="private"/>
          <tag line="889" name="param" description="" type="String" variable="$in">
            <type by_reference="false">String</type>
          </tag>
          <tag line="889" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="896">
          <name>$in</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="983" package="Crypt\Rijndael">
        <name>_decryptBlock</name>
        <full_name>_decryptBlock</full_name>
        <docblock line="976">
          <description><![CDATA[Decrypts a block]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="976" name="access" description="private"/>
          <tag line="976" name="param" description="" type="String" variable="$in">
            <type by_reference="false">String</type>
          </tag>
          <tag line="976" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="983">
          <name>$in</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1061" package="Crypt\Rijndael">
        <name>_setup</name>
        <full_name>_setup</full_name>
        <docblock line="1053">
          <description><![CDATA[Setup Rijndael]]></description>
          <long-description><![CDATA[<p>Validates all the variables and calculates $Nr - the number of rounds that need to be performed - and $w - the key
key schedule.</p>]]></long-description>
          <tag line="1053" name="access" description="private"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1175" package="Crypt\Rijndael">
        <name>_subWord</name>
        <full_name>_subWord</full_name>
        <docblock line="1170">
          <description><![CDATA[Performs S-Box substitutions]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1170" name="access" description="private"/>
        </docblock>
        <argument line="1175">
          <name>$word</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1221" package="Crypt\Rijndael">
        <name>_invSubWord</name>
        <full_name>_invSubWord</full_name>
        <docblock line="1216">
          <description><![CDATA[Performs inverse S-Box substitutions]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1216" name="access" description="private"/>
        </docblock>
        <argument line="1221">
          <name>$word</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1277" package="Crypt\Rijndael">
        <name>enablePadding</name>
        <full_name>enablePadding</full_name>
        <docblock line="1262">
          <description><![CDATA[Pad "packets".]]></description>
          <long-description><![CDATA[<p>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.</p>

<p>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)</p>]]></long-description>
          <tag line="1262" name="see" description="\global\Crypt_Rijndael::disablePadding()" refers="\global\Crypt_Rijndael::disablePadding()"/>
          <tag line="1262" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1288" package="Crypt\Rijndael">
        <name>disablePadding</name>
        <full_name>disablePadding</full_name>
        <docblock line="1282">
          <description><![CDATA[Do not pad packets.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1282" name="see" description="\global\Crypt_Rijndael::enablePadding()" refers="\global\Crypt_Rijndael::enablePadding()"/>
          <tag line="1282" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1306" package="Crypt\Rijndael">
        <name>_pad</name>
        <full_name>_pad</full_name>
        <docblock line="1293">
          <description><![CDATA[Pads a string]]></description>
          <long-description><![CDATA[<p>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)</p>

<p>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.</p>]]></long-description>
          <tag line="1293" name="see" description="\global\Crypt_Rijndael::_unpad()" refers="\global\Crypt_Rijndael::_unpad()"/>
          <tag line="1293" name="access" description="private"/>
        </docblock>
        <argument line="1306">
          <name>$text</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1333" package="Crypt\Rijndael">
        <name>_unpad</name>
        <full_name>_unpad</full_name>
        <docblock line="1324">
          <description><![CDATA[Unpads a string.]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="1324" name="see" description="\global\Crypt_Rijndael::_pad()" refers="\global\Crypt_Rijndael::_pad()"/>
          <tag line="1324" name="access" description="private"/>
        </docblock>
        <argument line="1333">
          <name>$text</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1385" package="Crypt\Rijndael">
        <name>enableContinuousBuffer</name>
        <full_name>enableContinuousBuffer</full_name>
        <docblock line="1348">
          <description><![CDATA[Treat consecutive "packets" as if they are a continuous buffer.]]></description>
          <long-description><![CDATA[<p>Say you have a 32-byte plaintext $plaintext.  Using the default behavior, the two following code snippets
will yield different outputs:</p>

<pre><code>   echo $rijndael->encrypt(substr($plaintext,  0, 16));
   echo $rijndael->encrypt(substr($plaintext, 16, 16));
</code></pre>

<pre><code>   echo $rijndael->encrypt($plaintext);
</code></pre>

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

<pre><code>   $rijndael->encrypt(substr($plaintext, 0, 16));
   echo $rijndael->decrypt($des->encrypt(substr($plaintext, 16, 16)));
</code></pre>

<pre><code>   echo $rijndael->decrypt($des->encrypt(substr($plaintext, 16, 16)));
</code></pre>

<p>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.</p>

<p>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.</p>]]></long-description>
          <tag line="1348" name="see" description="\global\Crypt_Rijndael::disableContinuousBuffer()" refers="\global\Crypt_Rijndael::disableContinuousBuffer()"/>
          <tag line="1348" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1398" package="Crypt\Rijndael">
        <name>disableContinuousBuffer</name>
        <full_name>disableContinuousBuffer</full_name>
        <docblock line="1390">
          <description><![CDATA[Treat consecutive packets as if they are a discontinuous buffer.]]></description>
          <long-description><![CDATA[<p>The default behavior.</p>]]></long-description>
          <tag line="1390" name="see" description="\global\Crypt_Rijndael::enableContinuousBuffer()" refers="\global\Crypt_Rijndael::enableContinuousBuffer()"/>
          <tag line="1390" name="access" description="public"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1415" package="Crypt\Rijndael">
        <name>_string_shift</name>
        <full_name>_string_shift</full_name>
        <docblock line="1405">
          <description><![CDATA[String Shift]]></description>
          <long-description><![CDATA[<p>Inspired by array_shift</p>]]></long-description>
          <tag line="1405" name="param" description="" type="String" variable="$string">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1405" name="param" description="Integer $index" type="\optional" variable="$index">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="1405" name="return" description="" type="String">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1405" name="access" description="private"/>
        </docblock>
        <argument line="1415">
          <name>$string</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1415">
          <name>$index</name>
          <default><![CDATA[1]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <parse_markers>
      <error line="1170" code="50015">Argument $word is missing from the Docblock of _subWord()</error>
      <error line="1216" code="50015">Argument $word is missing from the Docblock of _invSubWord()</error>
      <error line="1293" code="50015">Argument $text is missing from the Docblock of _pad()</error>
      <error line="1324" code="50015">Argument $text is missing from the Docblock of _unpad()</error>
    </parse_markers>
  </file>
  <file path="lib/modules.inc" hash="985df084a1d469c7e693b4f1f8b041ac" package="modules">
    <docblock line="25">
      <description><![CDATA[Interface between modules and other parts of LAM.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="25" name="package" description="modules"/>
      <tag line="25" name="author" description="Tilo Lutz"/>
      <tag line="25" name="author" description="Michael Duergner"/>
      <tag line="25" name="author" description="Roland Gruber"/>
    </docblock>
    <include line="35" type="Include Once" package="main">
      <name>account.inc</name>
      <docblock line="34">
        <description><![CDATA[some helper functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="37" type="Include Once" package="main">
      <name>baseModule.inc</name>
      <docblock line="36">
        <description><![CDATA[parent class of account modules]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="39" type="Include Once" package="main">
      <name>ldap.inc</name>
      <docblock line="38">
        <description><![CDATA[access to LDAP server]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="41" type="Include Once" package="main">
      <name>lamdaemon.inc</name>
      <docblock line="40">
        <description><![CDATA[lamdaemon functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="43" type="Include Once" package="main">
      <name>security.inc</name>
      <docblock line="42">
        <description><![CDATA[security functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="45" type="Include Once" package="main">
      <name>html.inc</name>
      <docblock line="44">
        <description><![CDATA[meta HTML classes]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="55" type="Include Once" package="main">
      <name/>
    </include>
    <include line="368" type="Include" package="main">
      <name/>
    </include>
    <include line="1255" type="Include" package="main">
      <name>../main_header.php</name>
    </include>
    <include line="1269" type="Include" package="main">
      <name>../main_footer.php</name>
    </include>
    <function namespace="global" line="65" package="modules">
      <name>getModuleAlias</name>
      <full_name>\getModuleAlias</full_name>
      <docblock line="58">
        <description><![CDATA[Returns the alias name of a module]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="58" name="param" description="the module name" type="string" variable="$name">
          <type by_reference="false">string</type>
        </tag>
        <tag line="58" name="param" description="the account type (&quot;user&quot;, &quot;group&quot;, &quot;host&quot;)" type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="58" name="return" description="alias name" type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="65">
        <name>$name</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="65">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="77" package="modules">
      <name>is_base_module</name>
      <full_name>\is_base_module</full_name>
      <docblock line="70">
        <description><![CDATA[Returns true if the module is a base module]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="70" name="param" description="the module name" type="string" variable="$name">
          <type by_reference="false">string</type>
        </tag>
        <tag line="70" name="param" description="the account type (&quot;user&quot;, &quot;group&quot;, &quot;host&quot;)" type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="70" name="return" description="true if base module" type="boolean">
          <type by_reference="false">boolean</type>
        </tag>
      </docblock>
      <argument line="77">
        <name>$name</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="77">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="88" package="modules">
      <name>get_ldap_filter</name>
      <full_name>\get_ldap_filter</full_name>
      <docblock line="82">
        <description><![CDATA[Returns the LDAP filter used by the account lists]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="82" name="param" description="the account type (&quot;user&quot;, &quot;group&quot;, &quot;host&quot;)" type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="82" name="return" description="LDAP filter" type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="88">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="134" package="modules">
      <name>getRDNAttributes</name>
      <full_name>\getRDNAttributes</full_name>
      <docblock line="125">
        <description><![CDATA[Returns a list of LDAP attributes which can be used to form the RDN.]]></description>
        <long-description><![CDATA[<p>The list is already sorted by the priority given by the nodules.</p>]]></long-description>
        <tag line="125" name="param" description="account type (user, group, host)" type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="125" name="param" description="return only RDN attributes of these modules" type="array" variable="$selectedModules">
          <type by_reference="false">array</type>
        </tag>
        <tag line="125" name="return" description="list of LDAP attributes" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="134">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="134">
        <name>$selectedModules</name>
        <default><![CDATA[null]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="187" package="modules">
      <name>getModulesDependencies</name>
      <full_name>\getModulesDependencies</full_name>
      <docblock line="177">
        <description><![CDATA[Returns a hash array (module name => dependencies) of all module dependencies]]></description>
        <long-description><![CDATA[<p>"dependencies" contains an array with two sub arrays: depends, conflicts
<br>The elements of "depends" are either module names or an array of module names (OR-case).
<br>The elements of conflicts are module names.</p>]]></long-description>
        <tag line="177" name="param" description="the account type (user, group, host)" type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="177" name="return" description="dependencies" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="187">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="205" package="modules">
      <name>check_module_depends</name>
      <full_name>\check_module_depends</full_name>
      <docblock line="197">
        <description><![CDATA[Checks if there are missing dependencies between modules.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="197" name="param" description="selected module names" type="array" variable="$selected">
          <type by_reference="false">array</type>
        </tag>
        <tag line="197" name="param" description="module dependencies" type="array" variable="$deps">
          <type by_reference="false">array</type>
        </tag>
        <tag line="197" name="return" description="false if no misssing dependency was found, otherwise an array of array(selected module, depending module) if missing dependencies were found" type="mixed">
          <type by_reference="false">mixed</type>
        </tag>
      </docblock>
      <argument line="205">
        <name>$selected</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="205">
        <name>$deps</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="246" package="modules">
      <name>check_module_conflicts</name>
      <full_name>\check_module_conflicts</full_name>
      <docblock line="238">
        <description><![CDATA[Checks if there are conflicts between modules]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="238" name="param" description="selected module names" type="array" variable="$selected">
          <type by_reference="false">array</type>
        </tag>
        <tag line="238" name="param" description="module dependencies" type="array" variable="$deps">
          <type by_reference="false">array</type>
        </tag>
        <tag line="238" name="return" description="false if no conflict was found, otherwise an array of array(selected module, conflicting module) if conflicts were found" type="boolean">
          <type by_reference="false">boolean</type>
        </tag>
      </docblock>
      <argument line="246">
        <name>$selected</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="246">
        <name>$deps</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="266" package="modules">
      <name>getAvailableModules</name>
      <full_name>\getAvailableModules</full_name>
      <docblock line="259">
        <description><![CDATA[Returns an array with all available user module names]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="259" name="param" description="account type (user, group, host)" type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="259" name="param" description="module must support LAM admin interface (default: false)" type="boolean" variable="$mustSupportAdminInterface">
          <type by_reference="false">boolean</type>
        </tag>
        <tag line="259" name="return" description="list of possible modules" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="266">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="266">
        <name>$mustSupportAdminInterface</name>
        <default><![CDATA[false]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="291" package="modules">
      <name>getProfileOptions</name>
      <full_name>\getProfileOptions</full_name>
      <docblock line="285">
        <description><![CDATA[Returns the elements for the profile page.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="285" name="param" description="account type (user, group, host)" type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="285" name="return" description="profile elements" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="291">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="308" package="modules">
      <name>checkProfileOptions</name>
      <full_name>\checkProfileOptions</full_name>
      <docblock line="301">
        <description><![CDATA[Checks if the profile options are valid]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="301" name="param" description="account type (user, group, host)" type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="301" name="param" description="hash array containing all options (name =&gt; array(...))" type="array" variable="$options">
          <type by_reference="false">array</type>
        </tag>
        <tag line="301" name="return" description="list of error messages" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="308">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="308">
        <name>$options</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="325" package="modules">
      <name>getConfigOptions</name>
      <full_name>\getConfigOptions</full_name>
      <docblock line="319">
        <description><![CDATA[Returns a hash array (module name => elements) of all module options for the configuration page.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="319" name="param" description="hash array (module name =&gt; array(account types))" type="array" variable="$scopes">
          <type by_reference="false">array</type>
        </tag>
        <tag line="319" name="return" description="configuration options" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="325">
        <name>$scopes</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="342" package="modules">
      <name>checkConfigOptions</name>
      <full_name>\checkConfigOptions</full_name>
      <docblock line="335">
        <description><![CDATA[Checks if the configuration options are valid]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="335" name="param" description="hash array (module name =&gt; array(account types))" type="array" variable="$scopes">
          <type by_reference="false">array</type>
        </tag>
        <tag line="335" name="param" description="hash array containing all options (name =&gt; array(...))" type="array" variable="$options">
          <type by_reference="false">array</type>
        </tag>
        <tag line="335" name="return" description="list of error messages" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="342">
        <name>$scopes</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="342">
        <name>$options</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="363" package="modules">
      <name>getHelp</name>
      <full_name>\getHelp</full_name>
      <docblock line="355">
        <description><![CDATA[Returns a help entry from an account module.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="355" name="param" description="module name" type="string" variable="$module">
          <type by_reference="false">string</type>
        </tag>
        <tag line="355" name="param" description="help identifier" type="string" variable="$helpID">
          <type by_reference="false">string</type>
        </tag>
        <tag line="355" name="param" description="account type" type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="355" name="return" description="help entry" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="363">
        <name>$module</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="363">
        <name>$helpID</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="363">
        <name>$scope</name>
        <default><![CDATA['']]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="385" package="modules">
      <name>getAvailablePDFFields</name>
      <full_name>\getAvailablePDFFields</full_name>
      <docblock line="379">
        <description><![CDATA[Returns a list of available PDF entries.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="379" name="param" description="account type (user, group, host)" type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="379" name="return" description="PDF entries (field ID =&gt; field label)" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="385">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="424" package="modules">
      <name>getUploadColumns</name>
      <full_name>\getUploadColumns</full_name>
      <docblock line="408">
        <description><![CDATA[Returns an array containing all input columns for the file upload.]]></description>
        <long-description><![CDATA[<p>Syntax:
<br> array(
<br>  string: name,  // fixed non-translated name which is used as column name (should be of format: <module name>_<column name>)
<br>  string: description,  // short descriptive name
<br>  string: help,  // help ID
<br>  string: example,  // example value
<br>  boolean: required  // true, if user must set a value for this column
<br> )</p>]]></long-description>
        <tag line="408" name="param" description="account type" type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="408" name="param" description="selected account modules" type="array" variable="$selectedModules">
          <type by_reference="false">array</type>
        </tag>
        <tag line="408" name="return" description="column list" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="424">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="424">
        <name>$selectedModules</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="444" package="modules">
      <name>buildUploadAccounts</name>
      <full_name>\buildUploadAccounts</full_name>
      <docblock line="433">
        <description><![CDATA[This function builds the LDAP accounts for the file upload.]]></description>
        <long-description><![CDATA[<p>If there are problems status messages will be printed automatically.</p>]]></long-description>
        <tag line="433" name="param" description="account type" type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="433" name="param" description="array containing one account in each element" type="array" variable="$data">
          <type by_reference="false">array</type>
        </tag>
        <tag line="433" name="param" description="array(&lt;column_name&gt; =&gt; &lt;column number&gt;)" type="array" variable="$ids">
          <type by_reference="false">array</type>
        </tag>
        <tag line="433" name="param" description="selected account modules" type="array" variable="$selectedModules">
          <type by_reference="false">array</type>
        </tag>
        <tag line="433" name="return" description="array including accounts or false if there were errors" type="mixed">
          <type by_reference="false">mixed</type>
        </tag>
      </docblock>
      <argument line="444">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="444">
        <name>$data</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="444">
        <name>$ids</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="444">
        <name>$selectedModules</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="517" package="modules">
      <name>doUploadPreActions</name>
      <full_name>\doUploadPreActions</full_name>
      <docblock line="509">
        <description><![CDATA[Runs any actions that need to be done before an LDAP entry is created.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="509" name="param" description="account type" type="String" variable="$scope">
          <type by_reference="false">String</type>
        </tag>
        <tag line="509" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
          <type by_reference="false">array</type>
        </tag>
        <tag line="509" name="param" description="LDAP attributes of this entry (attributes are provided as reference, handle modifications of $attributes with care)" type="array" variable="$attributes">
          <type by_reference="false">array</type>
        </tag>
        <tag line="509" name="return" description="array which contains status messages. Each entry is an array containing the status message parameters." type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="517">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="517">
        <name>$selectedModules</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="517">
        <name>$attributes</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="544" package="modules">
      <name>doUploadPostActions</name>
      <full_name>\doUploadPostActions</full_name>
      <docblock line="527">
        <description><![CDATA[This function executes one post upload action.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="527" name="param" description="account type" type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="527" name="param" description="array containing one account in each element" type="array" variable="$data">
          <type by_reference="false">array</type>
        </tag>
        <tag line="527" name="param" description="array(&lt;column_name&gt; =&gt; &lt;column number&gt;)" type="array" variable="$ids">
          <type by_reference="false">array</type>
        </tag>
        <tag line="527" name="param" description="list of accounts which were not created successfully" type="array" variable="$failed">
          <type by_reference="false">array</type>
        </tag>
        <tag line="527" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
          <type by_reference="false">array</type>
        </tag>
        <tag line="527" name="param" description="list of LDAP entries" type="array" variable="$accounts">
          <type by_reference="false">array</type>
        </tag>
        <tag line="527" name="return" description="current status &lt;br&gt; array ( &lt;br&gt; 'status' =&gt; 'finished' | 'inProgress' &lt;br&gt; 'module' =&gt; &lt;name of active module&gt; &lt;br&gt; 'progress' =&gt; 0..100 &lt;br&gt; 'errors' =&gt; array (&lt;array of parameters for StatusMessage&gt;) &lt;br&gt; )" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="544">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="544">
        <name>$data</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="544">
        <name>$ids</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="544">
        <name>$failed</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="544">
        <name>$selectedModules</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="544">
        <name>$accounts</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="580" package="modules">
      <name>getRequiredExtensions</name>
      <full_name>\getRequiredExtensions</full_name>
      <docblock line="575">
        <description><![CDATA[Returns true if the module is a base module]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="575" name="return" description="required extensions" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
    </function>
    <function namespace="global" line="610" package="modules">
      <name>parseHtml</name>
      <full_name>\parseHtml</full_name>
      <docblock line="596">
        <description><![CDATA[Takes a list of meta-HTML elements and prints the equivalent HTML output.]]></description>
        <long-description><![CDATA[<p>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.</p>]]></long-description>
        <tag line="596" name="param" description="Name of account module" type="string" variable="$module">
          <type by_reference="false">string</type>
        </tag>
        <tag line="596" name="param" description="htmlElement or array of htmlElement elements" type="mixed" variable="$input">
          <type by_reference="false">mixed</type>
        </tag>
        <tag line="596" name="param" description="List of values which override the defaults in $input (name =&gt; value)" type="array" variable="$values">
          <type by_reference="false">array</type>
        </tag>
        <tag line="596" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
          <type by_reference="false">boolean</type>
        </tag>
        <tag line="596" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
          <type by_reference="false">integer</type>
        </tag>
        <tag line="596" name="param" description="Account type" type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="596" name="return" description="List of input field names and their type (name =&gt; type)" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="610">
        <name>$module</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="610">
        <name>$input</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="610">
        <name>$values</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="610">
        <name>$restricted</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="610">
        <name>$tabindex</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="610">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="632" package="modules">
      <name>lamCompareDescriptiveOptions</name>
      <full_name>\lamCompareDescriptiveOptions</full_name>
      <docblock line="624">
        <description><![CDATA[Helper function to sort descriptive options in parseHTML().]]></description>
        <long-description><![CDATA[<p>It compares the second entries of two arrays.</p>]]></long-description>
        <tag line="624" name="param" description="first array" type="array" variable="$a">
          <type by_reference="false">array</type>
        </tag>
        <tag line="624" name="param" description="second array" type="array" variable="$b">
          <type by_reference="false">array</type>
        </tag>
        <tag line="624" name="return" description="compare result" type="integer">
          <type by_reference="false">integer</type>
        </tag>
      </docblock>
      <argument line="632">
        <name>$a</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="632">
        <name>$b</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="648" package="modules">
      <name>printHelpLink</name>
      <full_name>\printHelpLink</full_name>
      <docblock line="640">
        <description><![CDATA[Prints a LAM help link.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="640" name="param" description="help entry" type="array" variable="$entry">
          <type by_reference="false">array</type>
        </tag>
        <tag line="640" name="param" description="help number" type="String" variable="$number">
          <type by_reference="false">String</type>
        </tag>
        <tag line="640" name="param" description="module name" type="String" variable="$module">
          <type by_reference="false">String</type>
        </tag>
        <tag line="640" name="param" description="account scope" type="String" variable="$scope">
          <type by_reference="false">String</type>
        </tag>
      </docblock>
      <argument line="648">
        <name>$entry</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="648">
        <name>$number</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="648">
        <name>$module</name>
        <default><![CDATA['']]></default>
        <type/>
      </argument>
      <argument line="648">
        <name>$scope</name>
        <default><![CDATA['']]></default>
        <type/>
      </argument>
    </function>
    <interface namespace="global" line="2043" package="modules">
      <name>passwordService</name>
      <full_name>\passwordService</full_name>
      <docblock line="2037">
        <description><![CDATA[This interface needs to be implemented by all account modules which manage passwords.]]></description>
        <long-description><![CDATA[<p>It allows LAM to provide central password changes.</p>]]></long-description>
        <tag line="2037" name="package" description="modules"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2052" package="modules">
        <name>managesPasswordAttributes</name>
        <full_name>managesPasswordAttributes</full_name>
        <docblock line="2045">
          <description><![CDATA[This method specifies if a module manages password attributes.]]></description>
          <long-description><![CDATA[<p>The module alias will
then appear as option in the GUI.
<br>If the module only wants to get notified about password changes then return false.</p>]]></long-description>
          <tag line="2045" name="return" description="true if this module manages password attributes" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2059" package="modules">
        <name>supportsForcePasswordChange</name>
        <full_name>supportsForcePasswordChange</full_name>
        <docblock line="2054">
          <description><![CDATA[Specifies if this module supports to force that a user must change his password on next login.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2054" name="return" description="force password change supported" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2071" package="modules">
        <name>passwordChangeRequested</name>
        <full_name>passwordChangeRequested</full_name>
        <docblock line="2061">
          <description><![CDATA[This function is called whenever the password should be changed.]]></description>
          <long-description><![CDATA[<p>Account modules
must change their password attributes only if the modules list contains their module name.</p>]]></long-description>
          <tag line="2061" name="param" description="new password" type="String" variable="$password">
            <type by_reference="false">String</type>
          </tag>
          <tag line="2061" name="param" description="list of modules for which the password should be changed" type="array" variable="$modules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="2061" name="param" description="force the user to change his password at next login" type="boolean" variable="$forcePasswordChange">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="2061" name="return" description="list of error messages if any as parameter array for StatusMessage e.g. return arrray(array('ERROR', 'Password change failed.'))" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="2071">
          <name>$password</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2071">
          <name>$modules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2071">
          <name>$forcePasswordChange</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </interface>
    <class final="false" abstract="false" namespace="global" line="674" package="modules">
      <extends/>
      <name>accountContainer</name>
      <full_name>\accountContainer</full_name>
      <docblock line="669">
        <description><![CDATA[This class includes all modules and attributes of an account.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="669" name="package" description="modules"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="703" namespace="global" package="main">
        <name>$attributes</name>
        <default><![CDATA[]]></default>
        <docblock line="699">
          <description><![CDATA[Array of all used attributes
Syntax is attribute => array ( objectClass => MUST or MAY, .]]></description>
          <long-description><![CDATA[<p>..)</p>]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="709" namespace="global" package="main">
        <name>$type</name>
        <default><![CDATA[]]></default>
        <docblock line="705">
          <description><![CDATA[This variale stores the account type.]]></description>
          <long-description><![CDATA[<p>Currently "user", "group" and "host" are supported.</p>]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="712" namespace="global" package="main">
        <name>$module</name>
        <default><![CDATA[]]></default>
        <docblock line="711">
          <description><![CDATA[This is an array with all module objects]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="715" namespace="global" package="main">
        <name>$dnSuffix</name>
        <default><![CDATA[]]></default>
        <docblock line="714">
          <description><![CDATA[DN suffix of the account]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="718" namespace="global" package="main">
        <name>$dn_orig</name>
        <default><![CDATA[]]></default>
        <docblock line="717">
          <description><![CDATA[DN of account when it was loaded]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="721" namespace="global" package="main">
        <name>$rdn</name>
        <default><![CDATA[]]></default>
        <docblock line="720">
          <description><![CDATA[RDN attribute of this account]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="724" namespace="global" package="main">
        <name>$finalDN</name>
        <default><![CDATA[]]></default>
        <docblock line="723">
          <description><![CDATA[DN of saved account]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="727" namespace="global" package="main">
        <name>$attributes_orig</name>
        <default><![CDATA[]]></default>
        <docblock line="726">
          <description><![CDATA[original LDAP attributes when account was loaded from LDAP]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="730" namespace="global" package="main">
        <name>$order</name>
        <default><![CDATA[]]></default>
        <docblock line="729">
          <description><![CDATA[Module order]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="733" namespace="global" package="main">
        <name>$base</name>
        <default><![CDATA[]]></default>
        <docblock line="732">
          <description><![CDATA[Name of accountContainer variable in session]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="736" namespace="global" package="main">
        <name>$current_page</name>
        <default><![CDATA[0]]></default>
        <docblock line="735">
          <description><![CDATA[This variable stores the page number of the currently displayed page]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="739" namespace="global" package="main">
        <name>$subpage</name>
        <default><![CDATA[]]></default>
        <docblock line="738">
          <description><![CDATA[This variable is set to the pagename of a subpage if it should be displayed]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="742" namespace="global" package="main">
        <name>$isNewAccount</name>
        <default><![CDATA[]]></default>
        <docblock line="741">
          <description><![CDATA[True if this is a newly created account]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="745" namespace="global" package="main">
        <name>$lastLoadedProfile</name>
        <default><![CDATA['']]></default>
        <docblock line="744">
          <description><![CDATA[name of last loaded account profile]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="748" namespace="global" package="main">
        <name>$cachedOUs</name>
        <default><![CDATA[null]]></default>
        <docblock line="747">
          <description><![CDATA[cache for existing OUs]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="751" namespace="global" package="main">
        <name>$titleBarTitle</name>
        <default><![CDATA[null]]></default>
        <docblock line="750">
          <description><![CDATA[main title in title bar]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="753" namespace="global" package="main">
        <name>$titleBarSubtitle</name>
        <default><![CDATA[null]]></default>
        <docblock line="752">
          <description><![CDATA[subtitle in title bar]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="755" namespace="global" package="main">
        <name>$sendPasswordViaMail</name>
        <default><![CDATA[null]]></default>
        <docblock line="754">
          <description><![CDATA[send password via mail]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="757" namespace="global" package="main">
        <name>$sendPasswordViaMailAlternateAddress</name>
        <default><![CDATA[null]]></default>
        <docblock line="756">
          <description><![CDATA[send password via mail to this alternate address]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="682" package="modules">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="676">
          <description><![CDATA[Constructor]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="676" name="param" description="account type" type="string" variable="$type">
            <type by_reference="false">string</type>
          </tag>
          <tag line="676" name="param" description="key in $_SESSION where this object is saved" type="string" variable="$base">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="682">
          <name>$type</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="682">
          <name>$base</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="765" package="modules">
        <name>getAccountModule</name>
        <full_name>getAccountModule</full_name>
        <docblock line="759">
          <description><![CDATA[Returns the account module with the given class name]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="759" name="param" description="class name (e.g. posixAccount)" type="string" variable="$name">
            <type by_reference="false">string</type>
          </tag>
          <tag line="759" name="return" description="account module" type="\baseModule">
            <type by_reference="false">\baseModule</type>
          </tag>
        </docblock>
        <argument line="765">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="779" package="modules">
        <name>getAccountModules</name>
        <full_name>getAccountModules</full_name>
        <docblock line="774">
          <description><![CDATA[Returns the included account modules.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="774" name="return" description="modules" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="788" package="modules">
        <name>get_type</name>
        <full_name>get_type</full_name>
        <docblock line="783">
          <description><![CDATA[Returns the accout type of this object (e.g.]]></description>
          <long-description><![CDATA[<p>user, group, host).</p>]]></long-description>
          <tag line="783" name="return" description="account type" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="796" package="modules">
        <name>continue_main</name>
        <full_name>continue_main</full_name>
        <docblock line="792">
          <description><![CDATA[This function is called when the user clicks on any button on the account pages.]]></description>
          <long-description><![CDATA[<p>It prints the HTML code of each account page.</p>]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="955" package="modules">
        <name>printModuleContent</name>
        <full_name>printModuleContent</full_name>
        <docblock line="949">
          <description><![CDATA[Prints the content part provided by the current module.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="949" name="param" description="list of messages" type="array" variable="$result">
            <type by_reference="false">array</type>
          </tag>
          <tag line="949" name="param" description="true if page should end after displaying the messages" type="boolean" variable="$stopProcessing">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="955">
          <name>$result</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="955">
          <name>$stopProcessing</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1034" package="modules">
        <name>printPasswordPromt</name>
        <full_name>printPasswordPromt</full_name>
        <docblock line="1031">
          <description><![CDATA[Prints the input fields of the central password service.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1097" package="modules">
        <name>setNewPassword</name>
        <full_name>setNewPassword</full_name>
        <docblock line="1092">
          <description><![CDATA[Sets the new password in all selected account modules.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1092" name="param" description="input parameters" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1097">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1179" package="modules">
        <name>printCommonControls</name>
        <full_name>printCommonControls</full_name>
        <docblock line="1174">
          <description><![CDATA[Prints common controls like the save button and the ou selection.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1174" name="param" description="tabindex for GUI elements" type="int" variable="$tabindex">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
        <argument line="1179">
          <name>$tabindex</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1242" package="modules">
        <name>showSetPasswordButton</name>
        <full_name>showSetPasswordButton</full_name>
        <docblock line="1237">
          <description><![CDATA[Returns if the page should show a button to set the password.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1237" name="return" description="show or hide button" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1254" package="modules">
        <name>printPageHeader</name>
        <full_name>printPageHeader</full_name>
        <docblock line="1251">
          <description><![CDATA[Prints the header of the account pages.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1267" package="modules">
        <name>printPageFooter</name>
        <full_name>printPageFooter</full_name>
        <docblock line="1264">
          <description><![CDATA[Prints the footer of the account pages.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1277" package="modules">
        <name>printSuccessPage</name>
        <full_name>printSuccessPage</full_name>
        <docblock line="1272">
          <description><![CDATA[Prints the HTML code to notify the user about the successful saving.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1272" name="param" description="array which contains status messages. Each entry is an array containing the status message parameters." type="array" variable="$messages">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1277">
          <name>$messages</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1340" package="modules">
        <name>loadProfileIfRequested</name>
        <full_name>loadProfileIfRequested</full_name>
        <docblock line="1335">
          <description><![CDATA[Checks if the user requested to load a profile.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1335" name="return" description="true, if profile was loaded" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1363" package="modules">
        <name>printModuleTabs</name>
        <full_name>printModuleTabs</full_name>
        <docblock line="1360">
          <description><![CDATA[Prints the HTML code of the module tabs.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1402" package="modules">
        <name>save_module_attributes</name>
        <full_name>save_module_attributes</full_name>
        <docblock line="1395">
          <description><![CDATA[This function checks which LDAP attributes have changed while the account was edited.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1395" name="param" description="list of current LDAP attributes" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1395" name="param" description="list of old attributes when account was loaded" type="array" variable="$orig">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1395" name="return" description="an array which can be passed to $this-&gt;saveAccount()" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1402">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1402">
          <name>$orig</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1483" package="modules">
        <name>load_account</name>
        <full_name>load_account</full_name>
        <docblock line="1475">
          <description><![CDATA[Loads an LDAP account with the given DN.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1475" name="param" description="the DN of the account" type="string" variable="$dn">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1475" name="param" description="list of additional informational attributes that are added to the LDAP attributes E.g. this is used to inject the clear text password in the file upload. Informational attribute names must start with &quot;INFO.&quot;." type="array" variable="$infoAttributes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1475" name="return" description="error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1483">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1483">
          <name>$infoAttributes</name>
          <default><![CDATA[array()]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1546" package="modules">
        <name>fixLDAPAttributes</name>
        <full_name>fixLDAPAttributes</full_name>
        <docblock line="1539">
          <description><![CDATA[Fixes spelling errors in the attribute names.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1539" name="param" description="LDAP attributes" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1539" name="param" description="list of active modules" type="array" variable="$modules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1539" name="return" description="fixed attributes" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1546">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1546">
          <name>$modules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1619" package="modules">
        <name>new_account</name>
        <full_name>new_account</full_name>
        <docblock line="1616">
          <description><![CDATA[This function will prepare the object for a new account.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1654" package="modules">
        <name>save_account</name>
        <full_name>save_account</full_name>
        <docblock line="1649">
          <description><![CDATA[This function will save an account to the LDAP database.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1649" name="return" description="list of status messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1881" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="1876">
          <description><![CDATA[Returns a list of possible PDF entries for this account.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1876" name="return" description="of PDF entries (array(&lt;name&gt; =&gt; &lt;PDF lines&gt;))" type="\list">
            <type by_reference="false">\list</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1898" package="modules">
        <name>sortModules</name>
        <full_name>sortModules</full_name>
        <docblock line="1895">
          <description><![CDATA[Sorts the module buttons for the account page.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1979" package="modules">
        <name>getRDN</name>
        <full_name>getRDN</full_name>
        <docblock line="1973">
          <description><![CDATA[Returns the RDN part of a given DN.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1973" name="param" description="DN" type="String" variable="$dn">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1973" name="return" description="RDN" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1979">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1991" package="modules">
        <name>getParentDN</name>
        <full_name>getParentDN</full_name>
        <docblock line="1985">
          <description><![CDATA[Returns the parent DN of a given DN.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1985" name="param" description="DN" type="String" variable="$dn">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1985" name="return" description="DN" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1991">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2002" package="modules">
        <name>getOUs</name>
        <full_name>getOUs</full_name>
        <docblock line="1997">
          <description><![CDATA[Returns a list of OUs that exist for this account type.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1997" name="return" description="OU list" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2016" package="modules">
        <name>__sleep</name>
        <full_name>__sleep</full_name>
        <docblock line="2011">
          <description><![CDATA[Encrypts sensitive data before storing in session.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2011" name="return" description="list of attributes which are serialized" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2028" package="modules">
        <name>__wakeup</name>
        <full_name>__wakeup</full_name>
        <docblock line="2025">
          <description><![CDATA[Decrypts sensitive data after accountContainer was loaded from session.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
    </class>
  </file>
  <file path="lib/createntlm.inc" hash="0bece1d66fcb7566c5aecf95c8634da8" package="modules">
    <docblock line="24">
      <description><![CDATA[This class provides functions to calculate Samba NT and LM hashes.]]></description>
      <long-description><![CDATA[<p>The code is a conversion from createntlm.pl (Benjamin Kuit) and smbdes.c/md4.c (Andrew Tridgell).</p>]]></long-description>
      <tag line="24" name="author" description="Roland Gruber"/>
      <tag line="24" name="package" description="modules"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="41" package="modules">
      <extends/>
      <name>smbHash</name>
      <full_name>\smbHash</full_name>
      <docblock line="34">
        <description><![CDATA[Calculates NT and LM hashes.]]></description>
        <long-description><![CDATA[<p>The important functions are lmhash($password) and nthash($password).</p>]]></long-description>
        <tag line="34" name="package" description="modules"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="45" namespace="global" package="main">
        <name>$perm1</name>
        <default><![CDATA[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>
      </property>
      <property final="false" static="false" visibility="private" line="54" namespace="global" package="main">
        <name>$perm2</name>
        <default><![CDATA[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>
      </property>
      <property final="false" static="false" visibility="private" line="63" namespace="global" package="main">
        <name>$perm3</name>
        <default><![CDATA[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>
      </property>
      <property final="false" static="false" visibility="private" line="72" namespace="global" package="main">
        <name>$perm4</name>
        <default><![CDATA[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>
      </property>
      <property final="false" static="false" visibility="private" line="81" namespace="global" package="main">
        <name>$perm5</name>
        <default><![CDATA[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>
      </property>
      <property final="false" static="false" visibility="private" line="90" namespace="global" package="main">
        <name>$perm6</name>
        <default><![CDATA[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>
      </property>
      <property final="false" static="false" visibility="private" line="99" namespace="global" package="main">
        <name>$sc</name>
        <default><![CDATA[array(1, 1, 2, 2, 2, 2, 2, 2, 1, 2, 2, 2, 2, 2, 2, 1)]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="103" namespace="global" package="main">
        <name>$sbox</name>
        <default><![CDATA[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>
      </property>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="139" package="modules">
        <name>x</name>
        <full_name>x</full_name>
        <docblock line="136">
          <description><![CDATA[Fixes too large numbers]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="139">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="149" package="modules">
        <name>lshift</name>
        <full_name>lshift</full_name>
        <docblock line="144">
          <description><![CDATA[]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="144" name="param" description="count" type="integer" variable="$count">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="144" name="param" description="" type="array" variable="$data">
            <type by_reference="false">array</type>
          </tag>
          <tag line="144" name="return" description="" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="149">
          <name>$count</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="149">
          <name>$data</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="162" package="modules">
        <name>permute</name>
        <full_name>permute</full_name>
        <docblock line="157">
          <description><![CDATA[]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="157" name="param" description="in input data" type="array" variable="$in">
            <type by_reference="false">array</type>
          </tag>
          <tag line="157" name="param" description="p permutation" type="array" variable="$p">
            <type by_reference="false">array</type>
          </tag>
          <tag line="157" name="return" description="" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="162">
          <name>$in</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="162">
          <name>$p</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="162">
          <name>$n</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="175" package="modules">
        <name>mxor</name>
        <full_name>mxor</full_name>
        <docblock line="170">
          <description><![CDATA[]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="170" name="param" description="" type="array" variable="$in1">
            <type by_reference="false">array</type>
          </tag>
          <tag line="170" name="param" description="" type="array" variable="$in2">
            <type by_reference="false">array</type>
          </tag>
          <tag line="170" name="return" description="" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="175">
          <name>$in1</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="175">
          <name>$in2</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="189" package="modules">
        <name>doHash</name>
        <full_name>doHash</full_name>
        <docblock line="183">
          <description><![CDATA[]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="183" name="param" description="" type="array" variable="$in">
            <type by_reference="false">array</type>
          </tag>
          <tag line="183" name="param" description="" type="array" variable="$key">
            <type by_reference="false">array</type>
          </tag>
          <tag line="183" name="param" description="" type="boolean" variable="$forw">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="183" name="return" description="" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="189">
          <name>$in</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="189">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="189">
          <name>$forw</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="261" package="modules">
        <name>str_to_key</name>
        <full_name>str_to_key</full_name>
        <docblock line="255">
          <description><![CDATA[str_to_key]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="255" name="param" description="" type="string" variable="$str">
            <type by_reference="false">string</type>
          </tag>
          <tag line="255" name="return" description="key" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="261">
          <name>$str</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="284" package="modules">
        <name>smb_hash</name>
        <full_name>smb_hash</full_name>
        <docblock line="276">
          <description><![CDATA[smb_hash]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="276" name="param" description="" type="\unknown_type" variable="$in">
            <type by_reference="false">\unknown_type</type>
          </tag>
          <tag line="276" name="param" description="" type="\unknown_type" variable="$key">
            <type by_reference="false">\unknown_type</type>
          </tag>
          <tag line="276" name="param" description="" type="\unknown_type" variable="$forw">
            <type by_reference="false">\unknown_type</type>
          </tag>
          <tag line="276" name="return" description="" type="\unknown">
            <type by_reference="false">\unknown</type>
          </tag>
        </docblock>
        <argument line="284">
          <name>$in</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="284">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="284">
          <name>$forw</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="310" package="modules">
        <name>E_P16</name>
        <full_name>E_P16</full_name>
        <docblock line="304">
          <description><![CDATA[E_P16]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="304" name="param" description="" type="\unknown_type" variable="$in">
            <type by_reference="false">\unknown_type</type>
          </tag>
          <tag line="304" name="return" description="" type="\unknown">
            <type by_reference="false">\unknown</type>
          </tag>
        </docblock>
        <argument line="310">
          <name>$in</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="334" package="modules">
        <name>lmhash</name>
        <full_name>lmhash</full_name>
        <docblock line="328">
          <description><![CDATA[Calculates the LM hash of a given password.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="328" name="param" description="password" type="string" variable="$password">
            <type by_reference="false">string</type>
          </tag>
          <tag line="328" name="return" description="hash value" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="334">
          <name>$password</name>
          <default><![CDATA[""]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="351" package="modules">
        <name>nthash</name>
        <full_name>nthash</full_name>
        <docblock line="345">
          <description><![CDATA[Calculates the NT hash of a given password.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="345" name="param" description="password" type="string" variable="$password">
            <type by_reference="false">string</type>
          </tag>
          <tag line="345" name="return" description="hash value" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="351">
          <name>$password</name>
          <default><![CDATA[""]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="360" package="modules">
        <name>unsigned_shift_r</name>
        <full_name>unsigned_shift_r</full_name>
        <docblock line="355">
          <description><![CDATA[Unsigned shift operation for 32bit values.]]></description>
          <long-description><![CDATA[<p>PHP 4 only supports signed shifts by default.</p>]]></long-description>
        </docblock>
        <argument line="360">
          <name>$a</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="360">
          <name>$b</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <parse_markers>
      <error line="45" code="50018">No DocBlock was found for property $perm1</error>
      <error line="54" code="50018">No DocBlock was found for property $perm2</error>
      <error line="63" code="50018">No DocBlock was found for property $perm3</error>
      <error line="72" code="50018">No DocBlock was found for property $perm4</error>
      <error line="81" code="50018">No DocBlock was found for property $perm5</error>
      <error line="90" code="50018">No DocBlock was found for property $perm6</error>
      <error line="99" code="50018">No DocBlock was found for property $sc</error>
      <error line="103" code="50018">No DocBlock was found for property $sbox</error>
      <error line="136" code="50015">Argument $i is missing from the Docblock of x()</error>
      <error line="144" code="50012">No short description for method lshift()</error>
      <error line="157" code="50012">No short description for method permute()</error>
      <error line="157" code="50015">Argument $n is missing from the Docblock of permute()</error>
      <error line="170" code="50012">No short description for method mxor()</error>
      <error line="183" code="50012">No short description for method doHash()</error>
      <error line="355" code="50015">Argument $a is missing from the Docblock of unsigned_shift_r()</error>
      <error line="355" code="50015">Argument $b is missing from the Docblock of unsigned_shift_r()</error>
    </parse_markers>
  </file>
  <file path="lib/security.inc" hash="e7e863524766db1ff2af425d16bfbfc8" package="lib">
    <docblock line="24">
      <description><![CDATA[This file includes functions to perform several security checks on each page load.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="package" description="lib"/>
      <tag line="24" name="author" description="Roland Gruber"/>
    </docblock>
    <include line="32" type="Include Once" package="main">
      <name>config.inc</name>
      <docblock line="31">
        <description><![CDATA[configuration options]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="34" type="Include Once" package="main">
      <name>ldap.inc</name>
      <docblock line="33">
        <description><![CDATA[ldap connection]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <function namespace="global" line="46" package="lib">
      <name>startSecureSession</name>
      <full_name>\startSecureSession</full_name>
      <docblock line="39">
        <description><![CDATA[Starts a session and checks the environment.]]></description>
        <long-description><![CDATA[<p>The script is stopped if one of the checks fail (timeout redirection may be overriden).</p>]]></long-description>
        <tag line="39" name="param" description="redirect user to login page" type="boolean" variable="$redirectToLogin">
          <type by_reference="false">boolean</type>
        </tag>
        <tag line="39" name="return" description="true if all ok, false if session expired" type="boolean">
          <type by_reference="false">boolean</type>
        </tag>
      </docblock>
      <argument line="46">
        <name>$redirectToLogin</name>
        <default><![CDATA[true]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="90" package="lib">
      <name>checkClientIP</name>
      <full_name>\checkClientIP</full_name>
      <docblock line="85">
        <description><![CDATA[Checks if the client's IP address is on the list of allowed IPs.]]></description>
        <long-description><![CDATA[<p>The script is stopped if the host is not valid.</p>]]></long-description>
      </docblock>
    </function>
    <function namespace="global" line="121" package="lib">
      <name>logoffAndBackToLoginPage</name>
      <full_name>\logoffAndBackToLoginPage</full_name>
      <docblock line="117">
        <description><![CDATA[Logs off the user and displays the login page.]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </function>
    <function namespace="global" line="184" package="lib">
      <name>logNewMessage</name>
      <full_name>\logNewMessage</full_name>
      <docblock line="178">
        <description><![CDATA[Puts a new message in the log file.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="178" name="param" description="log level (LOG_DEBUG, LOG_NOTICE, LOG_WARNING, LOG_ERR)" type="string" variable="$level">
          <type by_reference="false">string</type>
        </tag>
        <tag line="178" name="param" description="log message" type="string" variable="$message">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="184">
        <name>$level</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="184">
        <name>$message</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="221" package="lib">
      <name>checkIfWriteAccessIsAllowed</name>
      <full_name>\checkIfWriteAccessIsAllowed</full_name>
      <docblock line="216">
        <description><![CDATA[Checks if write access to LDAP is allowed.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="216" name="return" description="true, if allowed" type="boolean">
          <type by_reference="false">boolean</type>
        </tag>
      </docblock>
    </function>
    <function namespace="global" line="236" package="lib">
      <name>checkIfPasswordChangeIsAllowed</name>
      <full_name>\checkIfPasswordChangeIsAllowed</full_name>
      <docblock line="231">
        <description><![CDATA[Checks if passwords may be changed.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="231" name="return" description="true, if allowed" type="boolean">
          <type by_reference="false">boolean</type>
        </tag>
      </docblock>
    </function>
    <function namespace="global" line="253" package="lib">
      <name>checkIfNewEntriesAreAllowed</name>
      <full_name>\checkIfNewEntriesAreAllowed</full_name>
      <docblock line="246">
        <description><![CDATA[Checks if it is allowed to create new LDAP entries of the given type.]]></description>
        <long-description><![CDATA[<p>This also checks if general write access is enabled.</p>]]></long-description>
        <tag line="246" name="param" description="account type (e.g. 'user')" type="String" variable="$scope">
          <type by_reference="false">String</type>
        </tag>
        <tag line="246" name="return" description="true, if new entries are allowed" type="boolean">
          <type by_reference="false">boolean</type>
        </tag>
      </docblock>
      <argument line="253">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="273" package="lib">
      <name>checkIfDeleteEntriesIsAllowed</name>
      <full_name>\checkIfDeleteEntriesIsAllowed</full_name>
      <docblock line="267">
        <description><![CDATA[Checks if it is allowed to delete LDAP entries of the given type.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="267" name="param" description="account type (e.g. 'user')" type="String" variable="$scope">
          <type by_reference="false">String</type>
        </tag>
        <tag line="267" name="return" description="true, if entries may be deleted" type="boolean">
          <type by_reference="false">boolean</type>
        </tag>
      </docblock>
      <argument line="273">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="293" package="lib">
      <name>checkPasswordStrength</name>
      <full_name>\checkPasswordStrength</full_name>
      <docblock line="287">
        <description><![CDATA[Checks if the password fulfills the password policies.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="287" name="param" description="password" type="string" variable="$password">
          <type by_reference="false">string</type>
        </tag>
        <tag line="287" name="return" description="true if ok, string with error message if not valid" type="mixed">
          <type by_reference="false">mixed</type>
        </tag>
      </docblock>
      <argument line="293">
        <name>$password</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="364" package="lib">
      <name>checkIfToolIsActive</name>
      <full_name>\checkIfToolIsActive</full_name>
      <docblock line="358">
        <description><![CDATA[Checks if the given tool is active.]]></description>
        <long-description><![CDATA[<p>Otherwise, an error message is logged and the execution is stopped (die()).</p>]]></long-description>
        <tag line="358" name="param" description="tool class name (e.g. toolFileUpload)" type="String" variable="$tool">
          <type by_reference="false">String</type>
        </tag>
      </docblock>
      <argument line="364">
        <name>$tool</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
  </file>
  <file path="lib/baseModule.inc" hash="f5ba716d6e15503157d73332c2063501" package="modules">
    <docblock line="25">
      <description><![CDATA[This is the parent class for all account modules.]]></description>
      <long-description><![CDATA[<p>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.</p>]]></long-description>
      <tag line="25" name="package" description="modules"/>
      <tag line="25" name="author" description="Roland Gruber"/>
      <tag line="25" name="see" description="\baseModule" refers="\baseModule"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="53" package="modules">
      <extends/>
      <name>baseModule</name>
      <full_name>\baseModule</full_name>
      <docblock line="36">
        <description><![CDATA[Parent class of all account modules.]]></description>
        <long-description><![CDATA[<p>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.<br>
<br>
<b>Location and naming of modules</b><br>
All LAM modules are placed in lib/modules/ and are named "<class name>.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 _.<br>
<br>
You can avoid to override many functions by using {@link get_metaData()}.<br>
<br>
All module classes should extend the baseModule class.</p>]]></long-description>
        <tag line="36" name="package" description="modules"/>
        <tag line="36" name="author" description="Roland Gruber"/>
      </docblock>
      <property final="false" static="false" visibility="protected" line="56" namespace="global" package="main">
        <name>$meta</name>
        <default><![CDATA[]]></default>
        <docblock line="55">
          <description><![CDATA[includes all meta data provided by the sub class]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="59" namespace="global" package="main">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <docblock line="58">
          <description><![CDATA[the account type of this module (user, group, host)]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="62" namespace="global" package="main">
        <name>$moduleSettings</name>
        <default><![CDATA[]]></default>
        <docblock line="61">
          <description><![CDATA[configuration settings of all modules]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="65" namespace="global" package="main">
        <name>$selfServiceSettings</name>
        <default><![CDATA[]]></default>
        <docblock line="64">
          <description><![CDATA[self service settings of all modules]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="68" namespace="global" package="main">
        <name>$base</name>
        <default><![CDATA[]]></default>
        <docblock line="67">
          <description><![CDATA[name of parent accountContainer ($_SESSION[$base])]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="71" namespace="global" package="main">
        <name>$attributes</name>
        <default><![CDATA[]]></default>
        <docblock line="70">
          <description><![CDATA[contains all ldap attributes which should be written]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="74" namespace="global" package="main">
        <name>$orig</name>
        <default><![CDATA[]]></default>
        <docblock line="73">
          <description><![CDATA[contains all ldap attributes which are loaded from ldap]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="77" namespace="global" package="main">
        <name>$messages</name>
        <default><![CDATA[]]></default>
        <docblock line="76">
          <description><![CDATA[contains all error messages of a module]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="80" namespace="global" package="main">
        <name>$autoAddObjectClasses</name>
        <default><![CDATA[]]></default>
        <docblock line="79">
          <description><![CDATA[if true, managed object classes are added when an account is created or loaded (default: true)]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="87" package="modules">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="82">
          <description><![CDATA[Creates a new base module class]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="82" name="param" description="the account type (user, group, host)" type="string" variable="$scope">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="87">
          <name>$scope</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="103" package="modules">
        <name>load_Messages</name>
        <full_name>load_Messages</full_name>
        <docblock line="98">
          <description><![CDATA[This function fills the $messages variable with output messages from this module.]]></description>
          <long-description><![CDATA[<p>Calling this method requires the existence of an enclosing {@link accountContainer}.</p>]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="113" package="modules">
        <name>init</name>
        <full_name>init</full_name>
        <docblock line="106">
          <description><![CDATA[Initializes the module after it became part of an {@link accountContainer}]]></description>
          <long-description><![CDATA[<p>Calling this method requires the existence of an enclosing {@link accountContainer}.</p>]]></long-description>
          <tag line="106" name="param" description="the name of the {@link accountContainer} object ($_SESSION[$base])" type="string" variable="$base">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="113">
          <name>$base</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="141" package="modules">
        <name>load_attributes</name>
        <full_name>load_attributes</full_name>
        <docblock line="131">
          <description><![CDATA[This function loads the LDAP attributes when an account should be loaded.]]></description>
          <long-description><![CDATA[<p>Calling this method requires the existence of an enclosing {@link accountContainer}.<br>
<br>
By default this method loads the object classes and accounts which are specified in {@link getManagedObjectClasses()}
and {@link getManagedAttributes()}.</p>]]></long-description>
          <tag line="131" name="param" description="array like the array returned by get_ldap_attributes(dn of account) but without count indices" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="141">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="376" package="modules">
        <name>get_metaData</name>
        <full_name>get_metaData</full_name>
        <docblock line="172">
          <description><![CDATA[This function provides meta data which is interpreted by baseModule.]]></description>
          <long-description><![CDATA[<p>Only subclasses will return real data.<br>
<br>
The aim of the meta data is to reduce the number
of functions in the subclasses. All major data is centralized in one place.<br>
<br>
The returned array contains a list of key-value pairs for the different functions.<br></p>

<ul>

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

<li><b>{@link is_base_module()}</b><br>
<br>
<b>Key:</b> is_base<br>
<b>Value:</b> boolean<br>
<br>
<b>Example:</b> "is_base" => true
<br><br>
</li>

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

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

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

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

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

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

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

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

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

<li><b>{@link check_configOptions()}</b><br>
<br>
<b>Key:</b> config_checks<br>
<b>Value:</b> array('user' => array, 'host' => 'array', 'all' => array)<br>
<br>
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()}.
<br><br>
</li>

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

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

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

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

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

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

</ul>

<p><b>Example:</b> return array("is_base" => true);</p>]]></long-description>
          <tag line="172" name="return" description="meta data" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="385" package="modules">
        <name>get_scope</name>
        <full_name>get_scope</full_name>
        <docblock line="380">
          <description><![CDATA[Returns the account type of this module (user, group, host)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="380" name="return" description="account type" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="398" package="modules">
        <name>can_manage</name>
        <full_name>can_manage</full_name>
        <docblock line="389">
          <description><![CDATA[Returns true if this module can manage accounts of the current type, otherwise false.]]></description>
          <long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.</p>]]></long-description>
          <tag line="389" name="return" description="true if module fits" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="389" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="415" package="modules">
        <name>is_base_module</name>
        <full_name>is_base_module</full_name>
        <docblock line="403">
          <description><![CDATA[Returns true if your module is a base module and otherwise false.]]></description>
          <long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
<br>
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.</p>]]></long-description>
          <tag line="403" name="return" description="true if base module (defaults to false if no meta data is provided)" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="403" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="435" package="modules">
        <name>get_ldap_filter</name>
        <full_name>get_ldap_filter</full_name>
        <docblock line="420">
          <description><![CDATA[Returns an LDAP filter for the account lists]]></description>
          <long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
<br>
Returns an array('or' => '...', 'and' => '...') 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.<br>
The resulting LDAP filter will look like this: (&amp;(|(OR1)(OR2)(OR3))(AND1)(AND2)(AND3))<br>
<br>
<b>Example:</b> return array('or' => '(objectClass=posixAccount)', 'and' => '(!(uid=*$))')</p>]]></long-description>
          <tag line="420" name="return" description="LDAP filter" type="string">
            <type by_reference="false">string</type>
          </tag>
          <tag line="420" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="453" package="modules">
        <name>get_alias</name>
        <full_name>get_alias</full_name>
        <docblock line="440">
          <description><![CDATA[Returns an alias name for the module.]]></description>
          <long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
<br>
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.<br>
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 '>').
If you use different aliases dependent on the account type please make sure that there is a general alias for unknown types.</p>]]></long-description>
          <tag line="440" name="return" description="alias name" type="string">
            <type by_reference="false">string</type>
          </tag>
          <tag line="440" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="473" package="modules">
        <name>get_RDNAttributes</name>
        <full_name>get_RDNAttributes</full_name>
        <docblock line="458">
          <description><![CDATA[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><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
<br>
The returned elements have this form: <attribute> => <priority>
<br> <attribute> is the name of the LDAP attribute
<br> <priority> defines the priority of the attribute (can be "low", "normal", "high")<br>
<br>
<b>Example:</b> return array('uid' => 'normal', 'cn' => 'low')</p>]]></long-description>
          <tag line="458" name="return" description="list of attributes" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="458" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="496" package="modules">
        <name>get_dependencies</name>
        <full_name>get_dependencies</full_name>
        <docblock line="478">
          <description><![CDATA[This function returns a list with all depending and conflicting modules.]]></description>
          <long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
<br>
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.<br>
If an element of the depends array is itself an array, this means that your module
depends on one of these modules.<br>
<br>
<b>Example:</b> return array("depends" => array("posixAccount", array("qmail", "sendmail")), "conflicts" => array("exim"))</p>]]></long-description>
          <tag line="478" name="return" description="list of dependencies and conflicts" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="478" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="516" package="modules">
        <name>get_profileOptions</name>
        <full_name>get_profileOptions</full_name>
        <docblock line="501">
          <description><![CDATA[This function defines what attributes will be used in the account profiles and their appearance in the profile editor.]]></description>
          <long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
<br>
The return value is an object implementing htmlElement.<br>
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.</p>]]></long-description>
          <tag line="501" name="return" description="meta HTML object" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
          <tag line="501" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
          <tag line="501" name="see" description="\global\htmlElement" refers="\global\htmlElement"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="537" package="modules">
        <name>check_profileOptions</name>
        <full_name>check_profileOptions</full_name>
        <docblock line="521">
          <description><![CDATA[Checks input values of account profiles.]]></description>
          <long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
<br>
$options is an hash array (option name => value) that contains the user input.
The option values are all arrays containing one or more elements.<br>
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.</p>]]></long-description>
          <tag line="521" name="param" description="a hash array (name =&gt; value) containing the user input" type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="521" name="return" description="list of error messages (array(type, title, text)) to generate StatusMessages, if any" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="521" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
        <argument line="537">
          <name>$options</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="622" package="modules">
        <name>load_profile</name>
        <full_name>load_profile</full_name>
        <docblock line="613">
          <description><![CDATA[This function loads the values from an account profile to the module's internal data structures.]]></description>
          <long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.</p>]]></long-description>
          <tag line="613" name="param" description="hash array with profile values (identifier =&gt; value)" type="array" variable="$profile">
            <type by_reference="false">array</type>
          </tag>
          <tag line="613" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
        <argument line="622">
          <name>$profile</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="648" package="modules">
        <name>get_configOptions</name>
        <full_name>get_configOptions</full_name>
        <docblock line="633">
          <description><![CDATA[Returns a list of configuration options.]]></description>
          <long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
<br>
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.</p>]]></long-description>
          <tag line="633" name="param" description="account types (user, group, host)" type="array" variable="$scopes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="633" name="param" description="list of all active account modules and their scopes (module =&gt; array(scopes))" type="array" variable="$allScopes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="633" name="return" description="htmlElement or array of htmlElement" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="633" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
          <tag line="633" name="see" description="\global\htmlElement" refers="\global\htmlElement"/>
        </docblock>
        <argument line="648">
          <name>$scopes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="648">
          <name>$allScopes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="691" package="modules">
        <name>check_configOptions</name>
        <full_name>check_configOptions</full_name>
        <docblock line="677">
          <description><![CDATA[Checks input values of module settings.]]></description>
          <long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
<br>
If the input data is invalid the return value is an array that contains subarrays to build StatusMessages ('message type', 'message head', 'message text').
<br>If no errors occured the function returns an empty array.</p>]]></long-description>
          <tag line="677" name="param" description="list of account types which are used" type="array" variable="$scopes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="677" name="param" description="hash array (option name =&gt; value) that contains the input. The option values are all arrays containing one or more elements." type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="677" name="return" description="list of error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="677" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
        <argument line="691">
          <name>$scopes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="691">
          <name>$options</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="814" package="modules">
        <name>get_pdfFields</name>
        <full_name>get_pdfFields</full_name>
        <docblock line="766">
          <description><![CDATA[Returns a hashtable with all entries that may be printed out in the PDF.]]></description>
          <long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
<br>
This method must be overwritten in case that there are non static values
to be returned. The $this->meta['PDF_fields'] array may be used for static content.<br>
<br>
<b>Format of returned hashtable:</b><br>
<br>
This function uses XML formatted commands to define the PDF output. Each part in the PDF
document is surrounded by "<block>" and "</block>".<br>
Inside the <block> tags there are different ways to format the output:</p>

<ul>
<li><b>simple line with attribute name and value:</b> <block><key><b>attribute name</b></key><value><b>attribute value</b></value></block></li>
<li><b>table:</b> <block><key><b>attribute name</b></key><tr><td><b>value</b><td><td><b>value</b><td></tr></block><block><tr><td><b>value</b></td><td><b>value</b><td></tr></block></li>
</ul>

<p><b>Special commands:</b></p>

<ul>
<li><b>Alignment in <td>:</b> You can specify the alignment in <td> tags with align=(L|R|C) (e.g. <td align=\"L\">)</li>
<li><b>Cell width:</b> <td> allows an attribute "width" to set the cell width (e.g. <td width=20%> or <td width=30>).</li>
<li><b>Line breaks:</b> Line breaks can be specified by adding a <<br>> tag. The new line will start at the left border of the PDF document.</li>
</ul>

<p><br>
<b>Examples:</b><br>
<br>
<b>Simple name+value lines:</b><br><br>
In most cases you will just want to display a single line per attribute with its name and value.<br>
<br>
'myAttribute' => '<block><key>AttrName</key><value>12345</value></block>'<br>
<br>
This will give the following PDF output:<br>
<br>
<b>Attribute name:</b> 12345<br>
<br>
<br>
<b>Multiline values:</b><br><br>
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 <td> tag.<br>
<br>
This example only uses one column but you can just use more <td> tags per <block> tag to display more columns.<br>
<br>
'myAttribute' => '<block><key>AttrName</key><tr><td align=\"L\">123</td></tr></block><block><tr><td align=\"L\">456</td></tr></block><block><tr><td align=\"L\">789</td></tr></block>'</p>]]></long-description>
          <tag line="766" name="return" description="PDF entries" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="766" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="823" package="modules">
        <name>get_pdfEntries</name>
        <full_name>get_pdfEntries</full_name>
        <docblock line="818">
          <description><![CDATA[Returns the PDF entries for this module.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="818" name="return" description="list of possible PDF entries" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="836" package="modules">
        <name>addSimplePDFField</name>
        <full_name>addSimplePDFField</full_name>
        <docblock line="827">
          <description><![CDATA[Adds a simple PDF entry to the given array.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="827" name="param" description="result array (entry will be added here)" type="array" variable="$result">
            <type by_reference="false">array</type>
          </tag>
          <tag line="827" name="param" description="ID" type="String" variable="$name">
            <type by_reference="false">String</type>
          </tag>
          <tag line="827" name="param" description="label name" type="String" variable="$label">
            <type by_reference="false">String</type>
          </tag>
          <tag line="827" name="param" description="attribute name (default: =$name)" type="String" variable="$attrName">
            <type by_reference="false">String</type>
          </tag>
          <tag line="827" name="param" description="delimiter if multiple attribute values exist (default: &quot;, &quot;)" type="String" variable="$delimiter">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="836">
          <name>$result</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="836">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="836">
          <name>$label</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="836">
          <name>$attrName</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="836">
          <name>$delimiter</name>
          <default><![CDATA[', ']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="878" package="modules">
        <name>get_uploadColumns</name>
        <full_name>get_uploadColumns</full_name>
        <docblock line="854">
          <description><![CDATA[Returns an array containing all input columns for the file upload.]]></description>
          <long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
<br>
This funtion returns an array which contains subarrays which represent an upload column.
<b>Syntax of column arrays:</b>
<br>
<br> array(
<br>  string: name,  // fixed non-translated name which is used as column name (should be of format: <module name>_<column name>)
<br>  string: description,  // short descriptive name
<br>  string: help,  // help ID
<br>  string: example,  // example value
<br>  string: values, // possible input values (optional)
<br>  string: default, // default value (optional)
<br>  boolean: required  // true, if user must set a value for this column
<br>  boolean: unique // true if all values of this column must be different values (optional, default: "false")
<br> )</p>]]></long-description>
          <tag line="854" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="854" name="return" description="column list" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="854" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
        <argument line="878">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="894" package="modules">
        <name>get_uploadPreDepends</name>
        <full_name>get_uploadPreDepends</full_name>
        <docblock line="883">
          <description><![CDATA[Returns a list of module names which must be processed in building the account befor this module.]]></description>
          <long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
<br>
The named modules may not be active, LAM will check this automatically.</p>]]></long-description>
          <tag line="883" name="return" description="list of module names" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="883" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="912" package="modules">
        <name>build_uploadAccounts</name>
        <full_name>build_uploadAccounts</full_name>
        <docblock line="899">
          <description><![CDATA[In this function the LDAP accounts are built.]]></description>
          <long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
<br>
Returns an array which contains subarrays to generate StatusMessages if any errors occured.</p>]]></long-description>
          <tag line="899" name="param" description="the user input data, contains one subarray for each account." type="array" variable="$rawAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="899" name="param" description="list of IDs for column position (e.g. &quot;posixAccount_uid&quot; =&gt; 5)" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="899" name="param" description="list of hash arrays (name =&gt; value) which are later added to LDAP" type="array" variable="$partialAccounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="899" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
            <type by_reference="false">array</type>
          </tag>
          <tag line="899" name="return" description="list of error messages if any" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="912">
          <name>$rawAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="912">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="912">
          <name>$partialAccounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="912">
          <name>$selectedModules</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="942" package="modules">
        <name>get_help</name>
        <full_name>get_help</full_name>
        <docblock line="917">
          <description><![CDATA[This function returns the help entry array for a specific help id.]]></description>
          <long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
<br>
The result is an hashtable with the following keys:<br></p>

<ul>
<li><b>Headline (required)</b><br>
The headline of this help entry. Can consist of any alpha-numeric characters. No HTML/CSS elements are allowed.</li>
<li><b>Text (required)</b><br>
The text of the help entry which may contain any alpha-numeric characters.</li>
<li><b>SeeAlso (optional)</b><br>
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.</li>
</ul>

<p><br>
<b>Example:</b><br>
<br>
array('Headline' => 'This is the head line', 'Text' => 'Help content', 'SeeAlso' => array('text' => 'LAM homepage', 'link' => 'http://www.ldap-account-manager.org/'))</p>]]></long-description>
          <tag line="917" name="param" description="The id string for the help entry needed." type="string" variable="$id">
            <type by_reference="false">string</type>
          </tag>
          <tag line="917" name="return" description="The desired help entry." type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="917" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
        <argument line="942">
          <name>$id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="966" package="modules">
        <name>module_ready</name>
        <full_name>module_ready</full_name>
        <docblock line="954">
          <description><![CDATA[This function is used to check if this module page can be displayed.]]></description>
          <long-description><![CDATA[<p>Calling this method requires the existence of an enclosing {@link accountContainer}.<br>
<br>
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.<br>
This method's return value defaults to true.</p>]]></long-description>
          <tag line="954" name="return" description="true, if page can be displayed" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="982" package="modules">
        <name>module_complete</name>
        <full_name>module_complete</full_name>
        <docblock line="970">
          <description><![CDATA[This function is used to check if all settings for this module have been made.]]></description>
          <long-description><![CDATA[<p>Calling this method requires the existence of an enclosing {@link accountContainer}.<br>
<br>
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.<br>
This method's return value defaults to true.</p>]]></long-description>
          <tag line="970" name="return" description="true, if settings are complete" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1000" package="modules">
        <name>getButtonStatus</name>
        <full_name>getButtonStatus</full_name>
        <docblock line="986">
          <description><![CDATA[Controls if the module button the account page is visible and activated.]]></description>
          <long-description><![CDATA[<p>Calling this method requires the existence of an enclosing {@link accountContainer}.<br>
<br>
<b>Possible return values:</b></p>

<ul>
<li><b>enabled:</b> button is visible and active</li>
<li><b>disabled:</b> button is visible and deactivated (greyed)</li>
<li><b>hidden:</b> no button will be shown</li>
</ul>]]></long-description>
          <tag line="986" name="return" description="status (&quot;enabled&quot;, &quot;disabled&quot;, &quot;hidden&quot;)" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1010" package="modules">
        <name>doUploadPreActions</name>
        <full_name>doUploadPreActions</full_name>
        <docblock line="1004">
          <description><![CDATA[Runs any actions that need to be done before an LDAP entry is created.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1004" name="param" description="LDAP attributes of this entry (attributes are provided as reference, handle modifications of $attributes with care)" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1004" name="return" description="array which contains status messages. Each entry is an array containing the status message parameters." type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1010">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1036" package="modules">
        <name>doUploadPostActions</name>
        <full_name>doUploadPostActions</full_name>
        <docblock line="1014">
          <description><![CDATA[This function is responsible to do additional tasks after the account has been created in LDAP (e.g.]]></description>
          <long-description><![CDATA[<p>modifying group memberships, adding Quota etc..).</p>

<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
<br>
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.</p>]]></long-description>
          <tag line="1014" name="param" description="array containing one account in each element" type="array" variable="$data">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1014" name="param" description="maps the column names to keys for the sub arrays (array(&lt;column_name&gt; =&gt; &lt;column number&gt;))" type="array" variable="$ids">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1014" name="param" description="list of account numbers which could not be successfully uploaded to LDAP" type="array" variable="$failed">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1014" name="param" description="variable to store temporary data between two post actions" type="array" variable="$temp">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1014" name="param" description="list of LDAP entries" type="array" variable="$accounts">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1014" name="return" description="current status &lt;br&gt; array ( &lt;br&gt; 'status' =&gt; 'finished' | 'inProgress' // defines if all operations are complete &lt;br&gt; 'progress' =&gt; 0..100 // the progress of the operations in percent &lt;br&gt; 'errors' =&gt; array // list of arrays which are used to generate StatusMessages &lt;br&gt; )" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1036">
          <name>$data</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1036">
          <name>$ids</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1036">
          <name>$failed</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1036">
          <name>$temp</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1036">
          <name>$accounts</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1064" package="modules">
        <name>save_attributes</name>
        <full_name>save_attributes</full_name>
        <docblock line="1044">
          <description><![CDATA[Returns a list of modifications which have to be made to the LDAP account.]]></description>
          <long-description><![CDATA[<p>Calling this method requires the existence of an enclosing {@link accountContainer}.<br>
<br></p>

<p><br>This function returns an array with 3 entries:
<br>array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... )
<br>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)<br>
<br><b>"add"</b> are attributes which have to be added to the LDAP entry
<br><b>"remove"</b> are attributes which have to be removed from the LDAP entry
<br><b>"modify"</b> are attributes which have to be modified in the LDAP entry
<br><b>"notchanged"</b> are attributes which stay unchanged
<br><b>"info"</b> values with informational value (e.g. to be used later by pre/postModify actions)
<br>
<br>This builds the required comands from $this-attributes and $this->orig.</p>]]></long-description>
          <tag line="1044" name="return" description="list of modifications" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1079" package="modules">
        <name>preModifyActions</name>
        <full_name>preModifyActions</full_name>
        <docblock line="1068">
          <description><![CDATA[Allows the module to run commands before the LDAP entry is changed or created.]]></description>
          <long-description><![CDATA[<p>Calling this method requires the existence of an enclosing {@link accountContainer}.<br>
<br>
The modification is aborted if an error message is returned.</p>]]></long-description>
          <tag line="1068" name="param" description="new account" type="boolean" variable="$newAccount">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="1068" name="param" description="LDAP attributes of this entry (added/modified attributes are provided as reference, handle modifications of $attributes with care)" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1068" name="return" description="array which contains status messages. Each entry is an array containing the status message parameters." type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1079">
          <name>$newAccount</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1079">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1092" package="modules">
        <name>postModifyActions</name>
        <full_name>postModifyActions</full_name>
        <docblock line="1083">
          <description><![CDATA[Allows the module to run commands after the LDAP entry is changed or created.]]></description>
          <long-description><![CDATA[<p>Calling this method requires the existence of an enclosing {@link accountContainer}.</p>]]></long-description>
          <tag line="1083" name="param" description="new account" type="boolean" variable="$newAccount">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="1083" name="param" description="LDAP attributes of this entry" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1083" name="return" description="array which contains status messages. Each entry is an array containing the status message parameters." type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1092">
          <name>$newAccount</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1092">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1103" package="modules">
        <name>preDeleteActions</name>
        <full_name>preDeleteActions</full_name>
        <docblock line="1096">
          <description><![CDATA[Allows the module to run commands before the LDAP entry is deleted.]]></description>
          <long-description><![CDATA[<p>Calling this method requires the existence of an enclosing {@link accountContainer}.<br></p>]]></long-description>
          <tag line="1096" name="return" description="Array which contains status messages. Each entry is an array containing the status message parameters." type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1114" package="modules">
        <name>postDeleteActions</name>
        <full_name>postDeleteActions</full_name>
        <docblock line="1107">
          <description><![CDATA[Allows the module to run commands after the LDAP entry is deleted.]]></description>
          <long-description><![CDATA[<p>Calling this method requires the existence of an enclosing {@link accountContainer}.</p>]]></long-description>
          <tag line="1107" name="return" description="Array which contains status messages. Each entry is an array containing the status message parameters." type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1127" package="modules">
        <name>delete_attributes</name>
        <full_name>delete_attributes</full_name>
        <docblock line="1118">
          <description><![CDATA[This function returns an array with the same syntax as save_attributes().]]></description>
          <long-description><![CDATA[<p>Calling this method requires the existence of an enclosing {@link accountContainer}.<br>
<br>
It allows additional LDAP changes when an account is deleted.</p>]]></long-description>
          <tag line="1118" name="return" description="of LDAP operations, same as for save_attributes()" type="\List">
            <type by_reference="false">\List</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1142" package="modules">
        <name>display_html_delete</name>
        <full_name>display_html_delete</full_name>
        <docblock line="1131">
          <description><![CDATA[This function creates meta HTML code which will be displayed when an account should be deleted.]]></description>
          <long-description><![CDATA[<p>Calling this method requires the existence of an enclosing {@link accountContainer}.<br>
<br>
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.</p>]]></long-description>
          <tag line="1131" name="return" description="meta HTML object" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
          <tag line="1131" name="see" description="\global\htmlElement" refers="\global\htmlElement"/>
        </docblock>
      </method>
      <method final="false" abstract="true" static="false" visibility="public" namespace="global" line="1157" package="modules">
        <name>process_attributes</name>
        <full_name>process_attributes</full_name>
        <docblock line="1146">
          <description><![CDATA[This function processes user input.]]></description>
          <long-description><![CDATA[<p>Calling this method requires the existence of an enclosing {@link accountContainer}.<br>
<br>
It checks the user input and saves changes in the module's data structures.<br>
<br>
<b>Example:</b> return array(array('ERROR', 'Invalid input!', 'This is not allowed here.'));</p>]]></long-description>
          <tag line="1146" name="return" description="Array which contains status messages. Each entry is an array containing the status message parameters." type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="true" static="false" visibility="public" namespace="global" line="1168" package="modules">
        <name>display_html_attributes</name>
        <full_name>display_html_attributes</full_name>
        <docblock line="1159">
          <description><![CDATA[This function creates meta HTML code to display the module page.]]></description>
          <long-description><![CDATA[<p>Calling this method requires the existence of an enclosing {@link accountContainer}.</p>]]></long-description>
          <tag line="1159" name="return" description="meta HTML object" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
          <tag line="1159" name="see" description="\global\htmlElement" refers="\global\htmlElement"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1182" package="modules">
        <name>addSimpleInputTextField</name>
        <full_name>addSimpleInputTextField</full_name>
        <docblock line="1170">
          <description><![CDATA[Adds a simple text input field to the given htmlTable.]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="1170" name="param" description="parent container" type="\htmlTable" variable="$container">
            <type by_reference="false">\htmlTable</type>
          </tag>
          <tag line="1170" name="param" description="attribute name" type="String" variable="$attrName">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1170" name="param" description="label name" type="String" variable="$label">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1170" name="param" description="this is a required field (default false)" type="boolean" variable="$required">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="1170" name="param" description="field length" type="integer" variable="$length">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="1170" name="param" description="show as text area (default false)" type="boolean" variable="$isTextArea">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1182">
          <name>$container</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1182">
          <name>$attrName</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1182">
          <name>$label</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1182">
          <name>$required</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
        <argument line="1182">
          <name>$length</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="1182">
          <name>$isTextArea</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1217" package="modules">
        <name>addMultiValueInputTextField</name>
        <full_name>addMultiValueInputTextField</full_name>
        <docblock line="1204">
          <description><![CDATA[Adds a text input field that may contain multiple values to the given htmlTable.]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="1204" name="param" description="parent container" type="\htmlTable" variable="$container">
            <type by_reference="false">\htmlTable</type>
          </tag>
          <tag line="1204" name="param" description="attribute name" type="String" variable="$attrName">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1204" name="param" description="label name" type="String" variable="$label">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1204" name="param" description="this is a required field (default false)" type="boolean" variable="$required">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="1204" name="param" description="field length" type="integer" variable="$length">
            <type by_reference="false">integer</type>
          </tag>
        </docblock>
        <argument line="1217">
          <name>$container</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1217">
          <name>$attrName</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1217">
          <name>$label</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1217">
          <name>$required</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
        <argument line="1217">
          <name>$length</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1253" package="modules">
        <name>processMultiValueInputTextField</name>
        <full_name>processMultiValueInputTextField</full_name>
        <docblock line="1244">
          <description><![CDATA[Validates a multi-value text field.]]></description>
          <long-description><![CDATA[<p>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->messages['street'][0]).</p>]]></long-description>
          <tag line="1244" name="param" description="attribute name" type="String" variable="$attrName">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1244" name="param" description="errors array where to put validation errors" type="array" variable="$errors">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1244" name="param" description="validation ID for function get_preg() (default: null, null means no validation)" type="String" variable="$validationID">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1253">
          <name>$attrName</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1253">
          <name>$errors</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1253">
          <name>$validationID</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1284" package="modules">
        <name>addSimpleSelfServiceTextField</name>
        <full_name>addSimpleSelfServiceTextField</full_name>
        <docblock line="1271">
          <description><![CDATA[Adds a simple text input field for the self service.]]></description>
          <long-description><![CDATA[<p>The field name will be the same as the class name plus "_" plus attribute name (e.g. posixAccount_cn).</p>]]></long-description>
          <tag line="1271" name="param" description="array that is used as return value for getSelfServiceOptions()" type="array" variable="$container">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1271" name="param" description="attribute name (== field name)" type="String" variable="$name">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1271" name="param" description="label to display in front of input field" type="String" variable="$label">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1271" name="param" description="list of active fields" type="array" variable="$fields">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1271" name="param" description="attributes of LDAP account" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1271" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1271" name="param" description="field is required" type="boolean" variable="$required">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="1271" name="param" description="display as text area" type="boolean" variable="$isTextArea">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1284">
          <name>$container</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1284">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1284">
          <name>$label</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1284">
          <name>$fields</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1284">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1284">
          <name>$readOnlyFields</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1284">
          <name>$required</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
        <argument line="1284">
          <name>$isTextArea</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1323" package="modules">
        <name>checkSimpleSelfServiceTextField</name>
        <full_name>checkSimpleSelfServiceTextField</full_name>
        <docblock line="1311">
          <description><![CDATA[Checks the input value of a self service text field.]]></description>
          <long-description><![CDATA[<p>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->messages['street'][0]).</p>]]></long-description>
          <tag line="1311" name="param" description="return value of checkSelfServiceOptions()" type="array" variable="$container">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1311" name="param" description="attribute name" type="String" variable="$name">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1311" name="param" description="LDAP attributes" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1311" name="param" description="input fields" type="string" variable="$fields">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1311" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1311" name="param" description="validation ID for get_preg()" type="String" variable="$validationID">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1323">
          <name>$container</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1323">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1323">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1323">
          <name>$fields</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1323">
          <name>$readOnlyFields</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1323">
          <name>$validationID</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1358" package="modules">
        <name>getManagedObjectClasses</name>
        <full_name>getManagedObjectClasses</full_name>
        <docblock line="1345">
          <description><![CDATA[Returns a list of managed object classes for this module.]]></description>
          <long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
<br>
This is used to fix spelling errors in LDAP-Entries (e.g. if "posixACCOUNT" is read instead of "posixAccount" from LDAP).<br>
<br>
<b>Example:</b> return array('posixAccount')</p>]]></long-description>
          <tag line="1345" name="return" description="list of object classes" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1345" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1374" package="modules">
        <name>getLDAPAliases</name>
        <full_name>getLDAPAliases</full_name>
        <docblock line="1363">
          <description><![CDATA[Returns a list of aliases for LDAP attributes.]]></description>
          <long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
<br>
All alias attributes will be renamed to the given attribute names.</p>]]></long-description>
          <tag line="1363" name="return" description="list of aliases like array(&quot;alias name&quot; =&gt; &quot;attribute name&quot;)" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1363" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1387" package="modules">
        <name>getManagedAttributes</name>
        <full_name>getManagedAttributes</full_name>
        <docblock line="1379">
          <description><![CDATA[Returns a list of LDAP attributes which are managed by this module.]]></description>
          <long-description><![CDATA[<p>All attribute names will be renamed to match the given spelling.</p>]]></long-description>
          <tag line="1379" name="return" description="list of attributes" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1379" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1401" package="modules">
        <name>getRequiredExtensions</name>
        <full_name>getRequiredExtensions</full_name>
        <docblock line="1392">
          <description><![CDATA[This function returns a list of PHP extensions (e.g.]]></description>
          <long-description><![CDATA[<p>hash) which are needed by this module.</p>

<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.</p>]]></long-description>
          <tag line="1392" name="return" description="extensions" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1392" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1415" package="modules">
        <name>getSelfServiceSearchAttributes</name>
        <full_name>getSelfServiceSearchAttributes</full_name>
        <docblock line="1406">
          <description><![CDATA[This function returns a list of possible LDAP attributes (e.g.]]></description>
          <long-description><![CDATA[<p>uid, cn, ...) which can be used to search for LDAP objects.</p>

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

<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.</p>]]></long-description>
          <tag line="1469" name="param" description="input fields" type="string" variable="$fields">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1469" name="param" description="LDAP attributes" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1469" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="1469" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1469" name="return" description="messages and attributes (array('messages' =&gt; array(), 'add' =&gt; array('mail' =&gt; array('test@test.com')), 'del' =&gt; array(), 'mod' =&gt; array(), 'info' =&gt; array()))" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1486">
          <name>$fields</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1486">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1486">
          <name>$passwordChangeOnly</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1486">
          <name>$readOnlyFields</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1506" package="modules">
        <name>getSelfServiceSettings</name>
        <full_name>getSelfServiceSettings</full_name>
        <docblock line="1491">
          <description><![CDATA[Returns a list of self service configuration settings.]]></description>
          <long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
<br>
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.</p>]]></long-description>
          <tag line="1491" name="param" description="currently edited profile" type="\selfServiceProfile" variable="$profile">
            <type by_reference="false">\selfServiceProfile</type>
          </tag>
          <tag line="1491" name="return" description="meta HTML object" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
          <tag line="1491" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
          <tag line="1491" name="see" description="\global\htmlElement" refers="\global\htmlElement"/>
        </docblock>
        <argument line="1506">
          <name>$profile</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1528" package="modules">
        <name>checkSelfServiceSettings</name>
        <full_name>checkSelfServiceSettings</full_name>
        <docblock line="1515">
          <description><![CDATA[Checks if the self service settings are valid.]]></description>
          <long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
<br>
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.</p>]]></long-description>
          <tag line="1515" name="param" description="hash array (option name =&gt; value) that contains the input. The option values are all arrays containing one or more elements." type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1515" name="param" description="self service profile" type="\selfServiceProfile" variable="$profile">
            <type by_reference="false">\selfServiceProfile</type>
          </tag>
          <tag line="1515" name="return" description="error messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1528">
          <name>$options</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1528">
          <name>$profile</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1541" package="modules">
        <name>preModifySelfService</name>
        <full_name>preModifySelfService</full_name>
        <docblock line="1533">
          <description><![CDATA[Allows the module to run commands before the LDAP entry is changed or created.]]></description>
          <long-description><![CDATA[<p>An error message should be printed if the function returns false.</p>]]></long-description>
          <tag line="1533" name="param" description="LDAP attributes of this entry" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1533" name="return" description="true, if no problems occured" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1541">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1551" package="modules">
        <name>postModifySelfService</name>
        <full_name>postModifySelfService</full_name>
        <docblock line="1545">
          <description><![CDATA[Allows the module to run commands after the LDAP entry is changed or created.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1545" name="param" description="LDAP attributes of this entry" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1545" name="return" description="true, if no problems occured" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1551">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1564" package="modules">
        <name>getLinkToSpecialSelfServicePage</name>
        <full_name>getLinkToSpecialSelfServicePage</full_name>
        <docblock line="1555">
          <description><![CDATA[This allows modules to create a link to a module specific page
for the self service.]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="1555" name="param" description="self service settings" type="array" variable="$settings">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1555" name="return" description="link text (null if no special page used)" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="1564">
          <name>$settings</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1577" package="modules">
        <name>displaySpecialSelfServicePage</name>
        <full_name>displaySpecialSelfServicePage</full_name>
        <docblock line="1568">
          <description><![CDATA[This function creates meta HTML code to display the module specific page
for the self service.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1568" name="param" description="self service settings" type="\selfServiceProfile" variable="$profile">
            <type by_reference="false">\selfServiceProfile</type>
          </tag>
          <tag line="1568" name="return" description="meta HTML object" type="\htmlElement">
            <type by_reference="false">\htmlElement</type>
          </tag>
          <tag line="1568" name="see" description="\global\htmlElement" refers="\global\htmlElement"/>
        </docblock>
        <argument line="1577">
          <name>$profile</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1588" package="modules">
        <name>getAccountContainer</name>
        <full_name>getAccountContainer</full_name>
        <docblock line="1581">
          <description><![CDATA[Returns the {@link accountContainer} object.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1581" name="return" description="accountContainer object" type="\accountContainer">
            <type by_reference="false">\accountContainer</type>
          </tag>
          <tag line="1581" name="see" description="\global\accountContainer" refers="\global\accountContainer"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1602" package="modules">
        <name>getAttributes</name>
        <full_name>getAttributes</full_name>
        <docblock line="1597">
          <description><![CDATA[Returns the LDAP attributes which are managed in this module.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1597" name="return" description="attributes" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1611" package="modules">
        <name>getOriginalAttributes</name>
        <full_name>getOriginalAttributes</full_name>
        <docblock line="1606">
          <description><![CDATA[Returns the LDAP attributes which are managed in this module (with unchanged values).]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1606" name="return" description="attributes" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1624" package="modules">
        <name>getIcon</name>
        <full_name>getIcon</full_name>
        <docblock line="1615">
          <description><![CDATA[Returns the path to the module icon.]]></description>
          <long-description><![CDATA[<p>The path must be releative to graphics (e.g. key.png). You can also set $this->meta['icon'].
The preferred size is 32x32px.</p>]]></long-description>
          <tag line="1615" name="return" description="" type="\unknown">
            <type by_reference="false">\unknown</type>
          </tag>
          <tag line="1615" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1635" package="modules">
        <name>handleAjaxRequest</name>
        <full_name>handleAjaxRequest</full_name>
        <docblock line="1631">
          <description><![CDATA[Manages AJAX requests.]]></description>
          <long-description><![CDATA[<p>This function may be called with or without an account container.</p>]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1647" package="modules">
        <name>supportsAdminInterface</name>
        <full_name>supportsAdminInterface</full_name>
        <docblock line="1639">
          <description><![CDATA[Specifies if this module supports the LAM admin interface.]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="1639" name="return" description="support admin interface" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1662" package="modules">
        <name>isBooleanConfigOptionSet</name>
        <full_name>isBooleanConfigOptionSet</full_name>
        <docblock line="1655">
          <description><![CDATA[Returns if the given configuration option is set.]]></description>
          <long-description><![CDATA[<p>This function returns false if the configuration options cannot be read.</p>]]></long-description>
          <tag line="1655" name="param" description="name of the option" type="String" variable="$optionName">
            <type by_reference="false">String</type>
          </tag>
          <tag line="1655" name="return" description="true if option is set" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1662">
          <name>$optionName</name>
          <default><![CDATA[]]></default>
          <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>
  </file>
  <file path="lib/status.inc" hash="1f334ac451e6f05079f32908146704cf" package="lib">
    <docblock line="24">
      <description><![CDATA[LDAP Account Manager status messages.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="author" description="Michael Duergner"/>
      <tag line="24" name="package" description="lib"/>
    </docblock>
    <function namespace="global" line="53" package="lib">
      <name>StatusMessage</name>
      <full_name>\StatusMessage</full_name>
      <docblock line="31">
        <description><![CDATA[This function prints a short status message.]]></description>
        <long-description><![CDATA[<p>It can be used to print INFO,
WARN and ERROR messages at the moment.</p>

<p>The headline and text may be formated with special tags:
<br>
<br><b>{bold}, {endbold}:</b> All text between these tags is printed bold.
<br><b>{color=#123456}, {endcolor}:</b> All text between these tags is printed in the given color.
<br><b>{link=http://nodomain.org}, {endlink}:</b> A link with the given target is created. The link text is the text between the tags.</p>]]></long-description>
        <tag line="31" name="param" description="The type of the message to be printed. It must be one of the following types: 'INFO', 'WARN' or 'ERROR'. &lt;br&gt; Every other type will lead to an error message indicating an invalid message type." type="string" variable="$MessageTyp">
          <type by_reference="false">string</type>
        </tag>
        <tag line="31" name="param" description="The headline of the status message. &lt;br&gt; It may be formatted with special color/link/bold tags." type="string" variable="$MessageHeadline">
          <type by_reference="false">string</type>
        </tag>
        <tag line="31" name="param" description="The text of the status message. &lt;br&gt; It may be formatted with special color/link/bold tags. This parameter is optional." type="string" variable="$MessageText">
          <type by_reference="false">string</type>
        </tag>
        <tag line="31" name="param" description="The variables that are used to replace the spacers (%s) in the submitted text. This parameter is optional." type="array" variable="$MessageVariables">
          <type by_reference="false">array</type>
        </tag>
        <tag line="31" name="param" description="if set to true this function will return the generated HTML code instead of printing it directly (default: false)" type="boolean" variable="$returnOutput">
          <type by_reference="false">boolean</type>
        </tag>
        <tag line="31" name="return" description="HTML code if $returnOutput is set to true, otherwise null" type="String">
          <type by_reference="false">String</type>
        </tag>
      </docblock>
      <argument line="53">
        <name>$MessageTyp</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="53">
        <name>$MessageHeadline</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="53">
        <name>$MessageText</name>
        <default><![CDATA['']]></default>
        <type/>
      </argument>
      <argument line="53">
        <name>$MessageVariables</name>
        <default><![CDATA[array()]]></default>
        <type/>
      </argument>
      <argument line="53">
        <name>$returnOutput</name>
        <default><![CDATA[false]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="118" package="lib">
      <name>parseMessageString</name>
      <full_name>\parseMessageString</full_name>
      <docblock line="109">
        <description><![CDATA[Use the three replace functions on the submitted Text.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="109" name="access" description="private"/>
        <tag line="109" name="param" description="The text that is used to search for replaceable strings." type="string" variable="$MessageString">
          <type by_reference="false">string</type>
        </tag>
        <tag line="109" name="return" description="The processed text." type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="118">
        <name>$MessageString</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="132" package="lib">
      <name>boldText</name>
      <full_name>\boldText</full_name>
      <docblock line="122">
        <description><![CDATA[Replace {bold} and {endbold} with <b> and </b> HTML-Tags.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="122" name="access" description="private"/>
        <tag line="122" name="param" description="The text that is used to search for {bold} and {endbold} tags." type="string" variable="$text">
          <type by_reference="false">string</type>
        </tag>
        <tag line="122" name="return" description="The submitted text with {bold} and {endbold} replaced with the appropriate HTML tages &lt;b&gt; and &lt;/b&gt;" type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="132">
        <name>$text</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="147" package="lib">
      <name>colorText</name>
      <full_name>\colorText</full_name>
      <docblock line="138">
        <description><![CDATA[Replace {color=#[HEX-Value]} or {color=[HEX-Value]} and {endcolor} with <font color="#[HEX-Value]"> and </font> HTML-Tags.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="138" name="access" description="private"/>
        <tag line="138" name="param" description="The text that is used to search for {color} and {endcolor} tags." type="string" variable="$text">
          <type by_reference="false">string</type>
        </tag>
        <tag line="138" name="return" description="Input string with HTML-formatted color tags" type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="147">
        <name>$text</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="162" package="lib">
      <name>linkText</name>
      <full_name>\linkText</full_name>
      <docblock line="153">
        <description><![CDATA[Replace {link=[Link-Target]} and {endlink} with <a href="[Link-Target]" target="_blank"> and </a> HTML-Tags.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="153" name="access" description="private"/>
        <tag line="153" name="param" description="The text that is used to search for {link} and {endlink} tags." type="string" variable="$text">
          <type by_reference="false">string</type>
        </tag>
        <tag line="153" name="return" description="Input string with HTML-formatted link tags" type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="162">
        <name>$text</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
  </file>
  <file path="lib/lamdaemon.inc" hash="acbbdd2ecfe4312a3a0db7eace27543f" package="modules">
    <docblock line="24">
      <description><![CDATA[This file includes functions to control lamdaemon.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="author" description="Tilo Lutz"/>
      <tag line="24" name="author" description="Roland Gruber"/>
      <tag line="24" name="author" description="Thomas Manninger"/>
      <tag line="24" name="package" description="modules"/>
    </docblock>
    <include line="48" type="Include Once" package="main">
      <name>Net/SSH2.php</name>
    </include>
    <function namespace="global" line="42" package="modules">
      <name>lamdaemon</name>
      <full_name>\lamdaemon</full_name>
      <docblock line="34">
        <description><![CDATA[Sends commands to lamdaemon script.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="34" name="param" description="command to execute" type="array" variable="$command">
          <type by_reference="false">array</type>
        </tag>
        <tag line="34" name="param" description="remote server" type="string" variable="$server">
          <type by_reference="false">string</type>
        </tag>
        <tag line="34" name="return" description="Output of lamdaemon" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="42">
        <name>$command</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="42">
        <name>$server</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
  </file>
  <file path="lib/schema.inc" hash="295d59fcfa633bec6a970f3682162638" package="lib">
    <docblock line="24">
      <description><![CDATA[Classes and functions for fetching and parsing schema from an LDAP server.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="package" description="lib"/>
      <tag line="24" name="author" description="The phpLDAPadmin development team"/>
      <tag line="24" name="author" description="Roland Gruber"/>
    </docblock>
    <constant namespace="global" line="34" package="lib">
      <name>SCHEMA_SESSION_CACHE_ENABLED</name>
      <full_name>\SCHEMA_SESSION_CACHE_ENABLED</full_name>
      <value><![CDATA[1]]></value>
    </constant>
    <function namespace="global" line="1284" package="lib">
      <name>_get_schema_dn</name>
      <full_name>\_get_schema_dn</full_name>
      <docblock line="1271">
        <description><![CDATA[Helper for _get_raw_schema() which fetches the DN of the schema object
in an LDAP server based on a DN.]]></description>
        <long-description><![CDATA[<p>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.</p>]]></long-description>
        <tag line="1271" name="param" description="The DN (may be null) which houses the subschemaSubEntry attribute which this function can use to determine the schema entry's DN." type="string" variable="$dn">
          <type by_reference="false">string</type>
        </tag>
        <tag line="1271" name="param" description="Switch to true to see some nice and copious output. :)" type="bool" variable="$debug">
          <type by_reference="false">bool</type>
        </tag>
        <tag line="1271" name="return" description="The DN of the entry which houses this LDAP server's schema." type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="1284">
        <name>$dn</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="1284">
        <name>$debug</name>
        <default><![CDATA[false]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="1351" package="lib">
      <name>_get_raw_schema</name>
      <full_name>\_get_raw_schema</full_name>
      <docblock line="1328">
        <description><![CDATA[Fetches the raw schema array for the subschemaSubentry of the server.]]></description>
        <long-description><![CDATA[<p>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".</p>]]></long-description>
        <tag line="1328" name="param" description="- A string indicating which type of schema to fetch. Five valid values: 'objectclasses', 'attributetypes', 'ldapsyntaxes', 'matchingruleuse', or 'matchingrules'. Case insensitive." type="\$schema_to_fetch" variable="$schema_to_fetch">
          <type by_reference="false">\$schema_to_fetch</type>
        </tag>
        <tag line="1328" name="param" description="(optional) This paremeter is the DN of the entry whose schema you would like to fetch. Entries have the option of specifying their own subschemaSubentry that points to the DN of the system schema entry which applies to this attribute. If unspecified, this will try to retrieve the schema from the RootDSE subschemaSubentry. Failing that, we use some commonly known schema DNs. Default value is the Root DSE DN (zero-length string)" type="\$dn" variable="$dn">
          <type by_reference="false">\$dn</type>
        </tag>
        <tag line="1328" name="return" description="array of strings of this form: Array ( [0] =&gt; &quot;( 1.3.6.1.4.1.7165.1.2.2.4 NAME 'gidPool' DESC 'Pool ... [1] =&gt; &quot;( 1.3.6.1.4.1.7165.2.2.3 NAME 'sambaAccount' DESC 'Sa ... etc." type="\an">
          <type by_reference="false">\an</type>
        </tag>
      </docblock>
      <argument line="1351">
        <name>$schema_to_fetch</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="1351">
        <name>$dn</name>
        <default><![CDATA['']]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="1542" package="lib">
      <name>get_schema_objectclasses</name>
      <full_name>\get_schema_objectclasses</full_name>
      <docblock line="1529">
        <description><![CDATA[Gets an associative array of ObjectClass objects for the specified
server.]]></description>
        <long-description><![CDATA[<p>Each array entry's key is the name of the objectClass
in lower-case and the value is an ObjectClass object.</p>]]></long-description>
        <tag line="1529" name="param" description="(optional) It is easier to fetch schema if a DN is provided which defines the subschemaSubEntry attribute (all entries should)." type="string" variable="$dn">
          <type by_reference="false">string</type>
        </tag>
        <tag line="1529" name="return" description="An array of ObjectClass objects." type="array">
          <type by_reference="false">array</type>
        </tag>
        <tag line="1529" name="see" description="\global\ObjectClass" refers="\global\ObjectClass"/>
        <tag line="1529" name="see" description="\global\get_schema_objectclass" refers="\global\get_schema_objectclass"/>
      </docblock>
      <argument line="1542">
        <name>$dn</name>
        <default><![CDATA[null]]></default>
        <type/>
      </argument>
      <argument line="1542">
        <name>$use_cache</name>
        <default><![CDATA[true]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="1582" package="lib">
      <name>get_schema_objectclass</name>
      <full_name>\get_schema_objectclass</full_name>
      <docblock line="1570">
        <description><![CDATA[Gets a single ObjectClass object specified by name.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="1570" name="param" description="The name of the objectClass to fetch." type="string" variable="$oclass_name">
          <type by_reference="false">string</type>
        </tag>
        <tag line="1570" name="param" description="(optional) It is easier to fetch schema if a DN is provided which defines the subschemaSubEntry attribute (all entries should)." type="string" variable="$dn">
          <type by_reference="false">string</type>
        </tag>
        <tag line="1570" name="return" description="The specified ObjectClass object or false on error." type="\ObjectClass">
          <type by_reference="false">\ObjectClass</type>
        </tag>
        <tag line="1570" name="see" description="\global\ObjectClass" refers="\global\ObjectClass"/>
        <tag line="1570" name="see" description="\global\get_schema_objectclasses" refers="\global\get_schema_objectclasses"/>
      </docblock>
      <argument line="1582">
        <name>$oclass_name</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="1582">
        <name>$dn</name>
        <default><![CDATA[null]]></default>
        <type/>
      </argument>
      <argument line="1582">
        <name>$use_cache</name>
        <default><![CDATA[true]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="1606" package="lib">
      <name>get_schema_attribute</name>
      <full_name>\get_schema_attribute</full_name>
      <docblock line="1594">
        <description><![CDATA[Gets a single AttributeType object specified by name.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="1594" name="param" description="The name of the AttributeType to fetch." type="string" variable="$oclass_name">
          <type by_reference="false">string</type>
        </tag>
        <tag line="1594" name="param" description="(optional) It is easier to fetch schema if a DN is provided which defines the subschemaSubEntry attribute (all entries should)." type="string" variable="$dn">
          <type by_reference="false">string</type>
        </tag>
        <tag line="1594" name="return" description="The specified AttributeType object or false on error." type="\AttributeType">
          <type by_reference="false">\AttributeType</type>
        </tag>
        <tag line="1594" name="see" description="\global\AttributeType" refers="\global\AttributeType"/>
        <tag line="1594" name="see" description="\global\get_schema_attributes" refers="\global\get_schema_attributes"/>
      </docblock>
      <argument line="1606">
        <name>$attr_name</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="1606">
        <name>$dn</name>
        <default><![CDATA[null]]></default>
        <type/>
      </argument>
      <argument line="1606">
        <name>$use_cache</name>
        <default><![CDATA[true]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="1627" package="lib">
      <name>get_schema_attributes</name>
      <full_name>\get_schema_attributes</full_name>
      <docblock line="1617">
        <description><![CDATA[Gets an associative array of AttributeType objects for the specified
server.]]></description>
        <long-description><![CDATA[<p>Each array entry's key is the name of the attributeType
in lower-case and the value is an AttributeType object.</p>]]></long-description>
        <tag line="1617" name="param" description="(optional) It is easier to fetch schema if a DN is provided which defines the subschemaSubEntry attribute (all entries should)." type="string" variable="$dn">
          <type by_reference="false">string</type>
        </tag>
        <tag line="1617" name="return" description="An array of AttributeType objects." type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="1627">
        <name>$dn</name>
        <default><![CDATA[null]]></default>
        <type/>
      </argument>
      <argument line="1627">
        <name>$use_cache</name>
        <default><![CDATA[true]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="1719" package="lib">
      <name>add_aliases_to_attrs</name>
      <full_name>\add_aliases_to_attrs</full_name>
      <docblock line="1714">
        <description><![CDATA[For each attribute that has multiple names, this function adds unique entries to
the attrs array for those names.]]></description>
        <long-description><![CDATA[<p>Ie, attributeType has name 'gn' and 'givenName'.
This function will create a unique entry for 'gn' and 'givenName'.</p>]]></long-description>
      </docblock>
      <argument line="1719">
        <name>$attrs</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="1746" package="lib">
      <name>add_sup_to_attrs</name>
      <full_name>\add_sup_to_attrs</full_name>
      <docblock line="1741">
        <description><![CDATA[Adds inherited values to each attributeType specified by the SUP directive.]]></description>
        <long-description><![CDATA[<p>Supports infinite levels of inheritance.
Bug 856832: require a second paramter that has all attributes indexed by OID</p>]]></long-description>
      </docblock>
      <argument line="1746">
        <name>$attrs</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="1746">
        <name>$attrs_oid</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="1860" package="lib">
      <name>get_schema_matching_rules</name>
      <full_name>\get_schema_matching_rules</full_name>
      <docblock line="1856">
        <description><![CDATA[Returns an array of MatchingRule objects for the specified server.]]></description>
        <long-description><![CDATA[<p>The key of each entry is the OID of the matching rule.</p>]]></long-description>
      </docblock>
      <argument line="1860">
        <name>$dn</name>
        <default><![CDATA[null]]></default>
        <type/>
      </argument>
      <argument line="1860">
        <name>$use_cache</name>
        <default><![CDATA[true]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="1914" package="lib">
      <name>get_schema_syntaxes</name>
      <full_name>\get_schema_syntaxes</full_name>
      <docblock line="1910">
        <description><![CDATA[Returns an array of Syntax objects that this LDAP server uses mapped to
their descriptions.]]></description>
        <long-description><![CDATA[<p>The key of each entry is the OID of the Syntax.</p>]]></long-description>
      </docblock>
      <argument line="1914">
        <name>$dn</name>
        <default><![CDATA[null]]></default>
        <type/>
      </argument>
      <argument line="1914">
        <name>$use_cache</name>
        <default><![CDATA[true]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="1955" package="lib">
      <name>cached_schema_available</name>
      <full_name>\cached_schema_available</full_name>
      <docblock line="1945">
        <description><![CDATA[Returns true if the schema for $schema_type has been cached and
is availble.]]></description>
        <long-description><![CDATA[<p>$schema_type may be one of (lowercase) the following:
     objectclasses
     attributetypes
     ldapsyntaxes
     matchingrules
     matchingruleuse
Note that _get_raw_schema() takes a similar parameter.</p>]]></long-description>
      </docblock>
      <argument line="1955">
        <name>$schema_type</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="1992" package="lib">
      <name>get_cached_schema</name>
      <full_name>\get_cached_schema</full_name>
      <docblock line="1981">
        <description><![CDATA[Returns the cached array of schemaitem objects for the specified
$schema_type.]]></description>
        <long-description><![CDATA[<p>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).</p>

<p>Returns an array of SchemaItem objects on success or false on failure.</p>]]></long-description>
      </docblock>
      <argument line="1992">
        <name>$schema_type</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="2023" package="lib">
      <name>set_cached_schema</name>
      <full_name>\set_cached_schema</full_name>
      <docblock line="2015">
        <description><![CDATA[Caches the specified $schema_type.]]></description>
        <long-description><![CDATA[<p>$schema_items should be an array of SchemaItem instances (ie,
an array of ObjectClass, AttributeType, LDAPSyntax, MatchingRuleUse,
or MatchingRule objects.</p>

<p>Returns true on success of false on failure.</p>]]></long-description>
      </docblock>
      <argument line="2023">
        <name>$schema_type</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="2023">
        <name>$schema_items</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="2052" package="lib">
      <name>set_schema_cache_unavailable</name>
      <full_name>\set_schema_cache_unavailable</full_name>
      <docblock line="2047">
        <description><![CDATA[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><![CDATA[]]></long-description>
      </docblock>
    </function>
    <class final="false" abstract="false" namespace="global" line="45" package="lib">
      <extends/>
      <name>SchemaItem</name>
      <full_name>\SchemaItem</full_name>
      <docblock line="36">
        <description><![CDATA[Generic parent class for all schema items.]]></description>
        <long-description><![CDATA[<p>A schema item is
an ObjectClass, an AttributeBype, a MatchingRule, or a Syntax.
All schema items have at least two things in common: An OID
and a description. This class provides an implementation for
these two data.</p>]]></long-description>
        <tag line="36" name="package" description="lib"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="48" namespace="global" package="main">
        <name>$oid</name>
        <default><![CDATA[]]></default>
        <docblock line="47">
          <description><![CDATA[The OID of this schema item.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="50" namespace="global" package="main">
        <name>$description</name>
        <default><![CDATA[]]></default>
        <docblock line="49">
          <description><![CDATA[The description of this schema item.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="53" package="lib">
        <name>initVars</name>
        <full_name>initVars</full_name>
        <docblock line="52">
          <description><![CDATA[Initialize class members to default values.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="60" package="lib">
        <name>SchemaItem</name>
        <full_name>SchemaItem</full_name>
        <docblock line="59">
          <description><![CDATA[Default constructor.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="65" package="lib">
        <name>setOID</name>
        <full_name>setOID</full_name>
        <argument line="65">
          <name>$new_oid</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="70" package="lib">
        <name>setDescription</name>
        <full_name>setDescription</full_name>
        <argument line="70">
          <name>$new_desc</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="75" package="lib">
        <name>getOID</name>
        <full_name>getOID</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="80" package="lib">
        <name>getDescription</name>
        <full_name>getDescription</full_name>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="91" package="lib">
      <extends>\SchemaItem</extends>
      <name>ObjectClass</name>
      <full_name>\ObjectClass</full_name>
      <docblock line="86">
        <description><![CDATA[Represents an LDAP objectClass]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="86" name="package" description="lib"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="94" namespace="global" package="main">
        <name>$name</name>
        <default><![CDATA[]]></default>
        <docblock line="93">
          <description><![CDATA[This objectClass' name, ie "inetOrgPerson"]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="96" namespace="global" package="main">
        <name>$sup_classes</name>
        <default><![CDATA[]]></default>
        <docblock line="95">
          <description><![CDATA[array of objectClass names from which this objectClass inherits]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="98" namespace="global" package="main">
        <name>$type</name>
        <default><![CDATA[]]></default>
        <docblock line="97">
          <description><![CDATA[one of STRUCTURAL, ABSTRACT, or AUXILIARY]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="100" namespace="global" package="main">
        <name>$must_attrs</name>
        <default><![CDATA[]]></default>
        <docblock line="99">
          <description><![CDATA[arrays of attribute names that this objectClass requires]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="102" namespace="global" package="main">
        <name>$may_attrs</name>
        <default><![CDATA[]]></default>
        <docblock line="101">
          <description><![CDATA[arrays of attribute names that this objectClass allows, but does not require]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="104" namespace="global" package="main">
        <name>$is_obsolete</name>
        <default><![CDATA[]]></default>
        <docblock line="103">
          <description><![CDATA[boolean value indicating whether this objectClass is obsolete]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="106" namespace="global" package="main">
        <name>$children_objectclasses</name>
        <default><![CDATA[]]></default>
        <docblock line="105">
          <description><![CDATA[array of objectClasses which inherit from this one (must be set at runtime explicitly by the caller)]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="109" package="lib">
        <name>initVars</name>
        <full_name>initVars</full_name>
        <docblock line="108">
          <description><![CDATA[Initialize the class' member variables]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="126" package="lib">
        <name>ObjectClass</name>
        <full_name>ObjectClass</full_name>
        <docblock line="123">
          <description><![CDATA[Creates a new ObjectClass object given a raw LDAP objectClass string.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="126">
          <name>$raw_ldap_schema_string</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="286" package="lib">
        <name>getMustAttrs</name>
        <full_name>getMustAttrs</full_name>
        <docblock line="272">
          <description><![CDATA[Gets an array of AttributeType objects that entries of this ObjectClass must define.]]></description>
          <long-description><![CDATA[<p>This differs from getMustAttrNames in that it returns an array of AttributeType objects</p>]]></long-description>
          <tag line="272" name="param" description="An array of ObjectClass objects to use when traversing the inheritance tree. This presents some what of a bootstrapping problem as we must fetch all objectClasses to determine through inheritance which attributes this objectClass requires." type="array" variable="$oclasses">
            <type by_reference="false">array</type>
          </tag>
          <tag line="272" name="return" description="The array of required AttributeType objects." type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="272" name="see" description="\global\getMustAttrNames" refers="\global\getMustAttrNames"/>
          <tag line="272" name="see" description="\global\getMayAttrs" refers="\global\getMayAttrs"/>
          <tag line="272" name="see" description="\global\getMayAttrNames" refers="\global\getMayAttrNames"/>
        </docblock>
        <argument line="286">
          <name>$oclasses</name>
          <default><![CDATA[NULL]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="320" package="lib">
        <name>getMayAttrs</name>
        <full_name>getMayAttrs</full_name>
        <docblock line="305">
          <description><![CDATA[Gets an array of AttributeType objects that entries of this ObjectClass may define.]]></description>
          <long-description><![CDATA[<p>This differs from getMayAttrNames in that it returns an array of AttributeType objects</p>]]></long-description>
          <tag line="305" name="param" description="An array of ObjectClass objects to use when traversing the inheritance tree. This presents some what of a bootstrapping problem as we must fetch all objectClasses to determine through inheritance which attributes this objectClass provides." type="array" variable="$oclasses">
            <type by_reference="false">array</type>
          </tag>
          <tag line="305" name="return" description="The array of allowed AttributeType objects." type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="305" name="see" description="\global\getMustAttrNames" refers="\global\getMustAttrNames"/>
          <tag line="305" name="see" description="\global\getMustAttrs" refers="\global\getMustAttrs"/>
          <tag line="305" name="see" description="\global\getMayAttrNames" refers="\global\getMayAttrNames"/>
          <tag line="305" name="see" description="\global\AttributeType" refers="\global\AttributeType"/>
        </docblock>
        <argument line="320">
          <name>$oclasses</name>
          <default><![CDATA[NULL]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="354" package="lib">
        <name>getMustAttrNames</name>
        <full_name>getMustAttrNames</full_name>
        <docblock line="339">
          <description><![CDATA[Gets an array of attribute names (strings) that entries of this ObjectClass must define.]]></description>
          <long-description><![CDATA[<p>This differs from getMustAttrs in that it returns an array of strings rather than
array of AttributeType objects</p>]]></long-description>
          <tag line="339" name="param" description="An array of ObjectClass objects to use when traversing the inheritance tree. This presents some what of a bootstrapping problem as we must fetch all objectClasses to determine through inheritance which attributes this objectClass provides." type="array" variable="$oclasses">
            <type by_reference="false">array</type>
          </tag>
          <tag line="339" name="return" description="The array of allowed attribute names (strings)." type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="339" name="see" description="\global\getMustAttrs" refers="\global\getMustAttrs"/>
          <tag line="339" name="see" description="\global\getMayAttrs" refers="\global\getMayAttrs"/>
          <tag line="339" name="see" description="\global\getMayAttrNames" refers="\global\getMayAttrNames"/>
        </docblock>
        <argument line="354">
          <name>$oclasses</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="378" package="lib">
        <name>getMayAttrNames</name>
        <full_name>getMayAttrNames</full_name>
        <docblock line="363">
          <description><![CDATA[Gets an array of attribute names (strings) that entries of this ObjectClass must define.]]></description>
          <long-description><![CDATA[<p>This differs from getMayAttrs in that it returns an array of strings rather than
array of AttributeType objects</p>]]></long-description>
          <tag line="363" name="param" description="An array of ObjectClass objects to use when traversing the inheritance tree. This presents some what of a bootstrapping problem as we must fetch all objectClasses to determine through inheritance which attributes this objectClass provides." type="array" variable="$oclasses">
            <type by_reference="false">array</type>
          </tag>
          <tag line="363" name="return" description="The array of allowed attribute names (strings)." type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="363" name="see" description="\global\getMustAttrs" refers="\global\getMustAttrs"/>
          <tag line="363" name="see" description="\global\getMayAttrs" refers="\global\getMayAttrs"/>
          <tag line="363" name="see" description="\global\getMustAttrNames" refers="\global\getMustAttrNames"/>
        </docblock>
        <argument line="378">
          <name>$oclasses</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="393" package="lib">
        <name>addChildObjectClass</name>
        <full_name>addChildObjectClass</full_name>
        <docblock line="387">
          <description><![CDATA[Adds an objectClass to the list of objectClasses that inherit
from this objectClass.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="387" name="param" description="The name of the objectClass to add" type="String" variable="$object_class_name">
            <type by_reference="false">String</type>
          </tag>
          <tag line="387" name="return" description="Returns true on success or false on failure (objectclass already existed for example)" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="393">
          <name>$object_class_name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="409" package="lib">
        <name>getChildObjectClasses</name>
        <full_name>getChildObjectClasses</full_name>
        <docblock line="405">
          <description><![CDATA[Returns the array of objectClass names which inherit from this objectClass.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="405" name="return" description="Names of objectClasses which inherit from this objectClass." type="Array">
            <type by_reference="false">Array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="418" package="lib">
        <name>getName</name>
        <full_name>getName</full_name>
        <docblock line="414">
          <description><![CDATA[Gets the name of this objectClass (ie, "inetOrgPerson")]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="414" name="return" description="The name of the objectClass" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="428" package="lib">
        <name>getSupClasses</name>
        <full_name>getSupClasses</full_name>
        <docblock line="423">
          <description><![CDATA[Gets the objectClass names from which this objectClass inherits.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="423" name="return" description="An array of objectClass names (strings)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="436" package="lib">
        <name>getType</name>
        <full_name>getType</full_name>
        <docblock line="433">
          <description><![CDATA[Gets the type of this objectClass: STRUCTURAL, ABSTRACT, or AUXILIARY.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="444" package="lib">
        <name>getIsObsolete</name>
        <full_name>getIsObsolete</full_name>
        <docblock line="441">
          <description><![CDATA[Gets whether this objectClass is flagged as obsolete by the LDAP server.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="456" package="lib">
        <name>addMustAttrs</name>
        <full_name>addMustAttrs</full_name>
        <docblock line="449">
          <description><![CDATA[Adds the specified array of attributes to this objectClass' list of
MUST attributes.]]></description>
          <long-description><![CDATA[<p>The resulting array of must attributes will contain
unique members.</p>]]></long-description>
          <tag line="449" name="param" description="An array of attribute names (strings) to add." type="array" variable="$new_must_attrs">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="456">
          <name>$new_must_attrs</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="471" package="lib">
        <name>addMayAttrs</name>
        <full_name>addMayAttrs</full_name>
        <docblock line="465">
          <description><![CDATA[Behaves identically to addMustAttrs, but it operates on the MAY
attributes of this objectClass.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="465" name="param" description="An array of attribute names (strings) to add." type="array" variable="$new_may_attrs">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="471">
          <name>$new_may_attrs</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="493" package="lib">
      <extends/>
      <name>ObjectClassAttribute</name>
      <full_name>\ObjectClassAttribute</full_name>
      <docblock line="481">
        <description><![CDATA[A simple class for representing AttributeTypes used only by the ObjectClass class.]]></description>
        <long-description><![CDATA[<p>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.</p>]]></long-description>
        <tag line="481" name="package" description="lib"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="496" namespace="global" package="main">
        <name>$name</name>
        <default><![CDATA[]]></default>
        <docblock line="495">
          <description><![CDATA[This Attribute's name]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="498" namespace="global" package="main">
        <name>$source</name>
        <default><![CDATA[]]></default>
        <docblock line="497">
          <description><![CDATA[This Attribute's root]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="506" package="lib">
        <name>ObjectClassAttribute</name>
        <full_name>ObjectClassAttribute</full_name>
        <docblock line="500">
          <description><![CDATA[Creates a new ObjectClassAttribute with specified name and source objectClass.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="500" name="param" description="the name of the new attribute." type="string" variable="$name">
            <type by_reference="false">string</type>
          </tag>
          <tag line="500" name="param" description="the name of the ObjectClass which specifies this attribute." type="string" variable="$source">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="506">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="506">
          <name>$source</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="513" package="lib">
        <name>getName</name>
        <full_name>getName</full_name>
        <docblock line="512">
          <description><![CDATA[Gets this attribute's name]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="519" package="lib">
        <name>getSource</name>
        <full_name>getSource</full_name>
        <docblock line="518">
          <description><![CDATA[Gets the name of the ObjectClass which originally specified this attribute.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="531" package="lib">
      <extends>\SchemaItem</extends>
      <name>AttributeType</name>
      <full_name>\AttributeType</full_name>
      <docblock line="526">
        <description><![CDATA[Represents an LDAP AttributeType]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="526" name="package" description="lib"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="534" namespace="global" package="main">
        <name>$name</name>
        <default><![CDATA[]]></default>
        <docblock line="533">
          <description><![CDATA[The name of this attributeType]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="536" namespace="global" package="main">
        <name>$is_obsolete</name>
        <default><![CDATA[]]></default>
        <docblock line="535">
          <description><![CDATA[string: the description]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="538" namespace="global" package="main">
        <name>$sup_attribute</name>
        <default><![CDATA[]]></default>
        <docblock line="537">
          <description><![CDATA[The attribute from which this attribute inherits (if any)]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="540" namespace="global" package="main">
        <name>$equality</name>
        <default><![CDATA[]]></default>
        <docblock line="539">
          <description><![CDATA[The equality rule used]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="542" namespace="global" package="main">
        <name>$ordering</name>
        <default><![CDATA[]]></default>
        <docblock line="541">
          <description><![CDATA[The ordering of the attributeType]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="544" namespace="global" package="main">
        <name>$sub_str</name>
        <default><![CDATA[]]></default>
        <docblock line="543">
          <description><![CDATA[Boolean: supports substring matching?]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="546" namespace="global" package="main">
        <name>$syntax</name>
        <default><![CDATA[]]></default>
        <docblock line="545">
          <description><![CDATA[The full syntax string, ie 1.2.3.4{16}]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="548" namespace="global" package="main">
        <name>$is_single_value</name>
        <default><![CDATA[]]></default>
        <docblock line="547">
          <description><![CDATA[boolean: is single valued only?]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="550" namespace="global" package="main">
        <name>$is_collective</name>
        <default><![CDATA[]]></default>
        <docblock line="549">
          <description><![CDATA[boolean: is collective?]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="552" namespace="global" package="main">
        <name>$is_no_user_modification</name>
        <default><![CDATA[]]></default>
        <docblock line="551">
          <description><![CDATA[boolean: can use modify?]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="554" namespace="global" package="main">
        <name>$usage</name>
        <default><![CDATA[]]></default>
        <docblock line="553">
          <description><![CDATA[The usage string set by the LDAP schema]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="556" namespace="global" package="main">
        <name>$aliases</name>
        <default><![CDATA[]]></default>
        <docblock line="555">
          <description><![CDATA[An array of alias attribute names, strings]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="558" namespace="global" package="main">
        <name>$max_length</name>
        <default><![CDATA[]]></default>
        <docblock line="557">
          <description><![CDATA[The max number of characters this attribute can be]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="560" namespace="global" package="main">
        <name>$type</name>
        <default><![CDATA[]]></default>
        <docblock line="559">
          <description><![CDATA[A string description of the syntax type (taken from the LDAPSyntaxes)]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="562" namespace="global" package="main">
        <name>$used_in_object_classes</name>
        <default><![CDATA[]]></default>
        <docblock line="561">
          <description><![CDATA[An array of objectClasses which use this attributeType (must be set by caller)]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="564" namespace="global" package="main">
        <name>$required_by_object_classes</name>
        <default><![CDATA[array()]]></default>
        <docblock line="563">
          <description><![CDATA[A list of object class names that require this attribute type.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="569" package="lib">
        <name>initVars</name>
        <full_name>initVars</full_name>
        <docblock line="566">
          <description><![CDATA[Initialize the class' member variables]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="596" package="lib">
        <name>AttributeType</name>
        <full_name>AttributeType</full_name>
        <docblock line="593">
          <description><![CDATA[Creates a new AttributeType objcet from a raw LDAP AttributeType string.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="596">
          <name>$raw_ldap_attr_string</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="713" package="lib">
        <name>getName</name>
        <full_name>getName</full_name>
        <docblock line="709">
          <description><![CDATA[Gets this attribute's name]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="709" name="return" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="722" package="lib">
        <name>getIsObsolete</name>
        <full_name>getIsObsolete</full_name>
        <docblock line="718">
          <description><![CDATA[Gets whether this attribute has been flagged as obsolete by the LDAP server]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="718" name="return" description="" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="731" package="lib">
        <name>getUsage</name>
        <full_name>getUsage</full_name>
        <docblock line="727">
          <description><![CDATA[Gets this attribute's usage string as defined by the LDAP server]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="727" name="return" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="741" package="lib">
        <name>getSupAttribute</name>
        <full_name>getSupAttribute</full_name>
        <docblock line="736">
          <description><![CDATA[Gets this attribute's parent attribute (if any).]]></description>
          <long-description><![CDATA[<p>If this attribute does not
inherit from another attribute, null is returned.</p>]]></long-description>
          <tag line="736" name="return" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="750" package="lib">
        <name>getEquality</name>
        <full_name>getEquality</full_name>
        <docblock line="746">
          <description><![CDATA[Gets this attribute's equality string]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="746" name="return" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="759" package="lib">
        <name>getOrdering</name>
        <full_name>getOrdering</full_name>
        <docblock line="755">
          <description><![CDATA[Gets this attribute's ordering specification.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="755" name="return" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="768" package="lib">
        <name>getSubstr</name>
        <full_name>getSubstr</full_name>
        <docblock line="764">
          <description><![CDATA[Gets this attribute's substring matching specification]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="764" name="return" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="778" package="lib">
        <name>getAliases</name>
        <full_name>getAliases</full_name>
        <docblock line="773">
          <description><![CDATA[Gets the names of attributes that are an alias for this attribute (if any).]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="773" name="return" description="An array of names of attributes which alias this attribute or an empty array if no attribute aliases this object." type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="788" package="lib">
        <name>isAliasFor</name>
        <full_name>isAliasFor</full_name>
        <docblock line="783">
          <description><![CDATA[Returns whether the specified attribute is an alias for this one (based on this attribute's alias list).]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="783" name="param" description="The name of the attribute to check." type="string" variable="$attr_name">
            <type by_reference="false">string</type>
          </tag>
          <tag line="783" name="return" description="True if the specified attribute is an alias for this one, or false otherwise." type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="788">
          <name>$attr_name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="801" package="lib">
        <name>getSyntaxString</name>
        <full_name>getSyntaxString</full_name>
        <docblock line="797">
          <description><![CDATA[Gets this attribute's raw syntax string (ie: "1.2.3.4{16}").]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="797" name="return" description="The raw syntax string" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="813" package="lib">
        <name>getSyntaxOID</name>
        <full_name>getSyntaxOID</full_name>
        <docblock line="806">
          <description><![CDATA[Gets this attribute's syntax OID.]]></description>
          <long-description><![CDATA[<p>Differs from getSyntaxString() in that this
function only returns the actual OID with any length specification removed.
Ie, if the syntax string is "1.2.3.4{16}", this function only retruns
"1.2.3.4".</p>]]></long-description>
          <tag line="806" name="return" description="The syntax OID string." type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="822" package="lib">
        <name>getMaxLength</name>
        <full_name>getMaxLength</full_name>
        <docblock line="818">
          <description><![CDATA[Gets this attribute's the maximum length.]]></description>
          <long-description><![CDATA[<p>If no maximum is defined by the LDAP server, null is returned.</p>]]></long-description>
          <tag line="818" name="return" description="The maximum length (in characters) of this attribute or null if no maximum is specified." type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="832" package="lib">
        <name>getIsSingleValue</name>
        <full_name>getIsSingleValue</full_name>
        <docblock line="827">
          <description><![CDATA[Gets whether this attribute is single-valued.]]></description>
          <long-description><![CDATA[<p>If this attribute only supports single values, true
is returned. If this attribute supports multiple values, false is returned.</p>]]></long-description>
          <tag line="827" name="return" description="Returns true if this attribute is single-valued or false otherwise." type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="841" package="lib">
        <name>setIsSingleValue</name>
        <full_name>setIsSingleValue</full_name>
        <docblock line="837">
          <description><![CDATA[Sets whether this attribute is single-valued.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="837" name="param" description="" type="bool" variable="$is_single_value">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="841">
          <name>$is_single_value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="850" package="lib">
        <name>getIsCollective</name>
        <full_name>getIsCollective</full_name>
        <docblock line="846">
          <description><![CDATA[Gets whether this attribute is collective.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="846" name="return" description="Returns true if this attribute is collective and false otherwise." type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="859" package="lib">
        <name>getIsNoUserModification</name>
        <full_name>getIsNoUserModification</full_name>
        <docblock line="855">
          <description><![CDATA[Gets whether this attribute is not modifiable by users.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="855" name="return" description="Returns true if this attribute is not modifiable by users." type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="868" package="lib">
        <name>getType</name>
        <full_name>getType</full_name>
        <docblock line="864">
          <description><![CDATA[Gets this attribute's type]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="864" name="return" description="The attribute's type." type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="879" package="lib">
        <name>removeAlias</name>
        <full_name>removeAlias</full_name>
        <docblock line="873">
          <description><![CDATA[Removes an attribute name from this attribute's alias array.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="873" name="param" description="The name of the attribute to remove." type="string" variable="$remove_alias_name">
            <type by_reference="false">string</type>
          </tag>
          <tag line="873" name="return" description="true on success or false on failure (ie, if the specified attribute name is not found in this attribute's list of aliases)" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="879">
          <name>$remove_alias_name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="895" package="lib">
        <name>addAlias</name>
        <full_name>addAlias</full_name>
        <docblock line="891">
          <description><![CDATA[Adds an attribute name to the alias array.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="891" name="param" description="The name of a new attribute to add to this attribute's list of aliases." type="string" variable="$new_alias_name">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="895">
          <name>$new_alias_name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="904" package="lib">
        <name>setName</name>
        <full_name>setName</full_name>
        <docblock line="900">
          <description><![CDATA[Sets this attriute's name.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="900" name="param" description="The new name to give this attribute." type="string" variable="$new_name">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="904">
          <name>$new_name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="913" package="lib">
        <name>setSupAttribute</name>
        <full_name>setSupAttribute</full_name>
        <docblock line="909">
          <description><![CDATA[Sets this attriute's SUP attribute (ie, the attribute from which this attribute inherits).]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="909" name="param" description="The name of the new parent (SUP) attribute" type="string" variable="$new_sup_attr">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="913">
          <name>$new_sup_attr</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="922" package="lib">
        <name>setAliases</name>
        <full_name>setAliases</full_name>
        <docblock line="918">
          <description><![CDATA[Sets this attribute's list of aliases.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="918" name="param" description="The array of alias names (strings)" type="array" variable="$new_aliases">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="922">
          <name>$new_aliases</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="931" package="lib">
        <name>setType</name>
        <full_name>setType</full_name>
        <docblock line="927">
          <description><![CDATA[Sets this attribute's type.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="927" name="param" description="The new type." type="string" variable="$new_type">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="931">
          <name>$new_type</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="941" package="lib">
        <name>addUsedInObjectClass</name>
        <full_name>addUsedInObjectClass</full_name>
        <docblock line="936">
          <description><![CDATA[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><![CDATA[]]></long-description>
          <tag line="936" name="param" description="The name of the objectClass to add." type="string" variable="$object_class_name">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="941">
          <name>$object_class_name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="955" package="lib">
        <name>getUsedInObjectClasses</name>
        <full_name>getUsedInObjectClasses</full_name>
        <docblock line="950">
          <description><![CDATA[Gets the list of "used in" objectClasses, that is the list of objectClasses
which provide this attribute.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="950" name="return" description="An array of names of objectclasses (strings) which provide this attribute" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="965" package="lib">
        <name>addRequiredByObjectClass</name>
        <full_name>addRequiredByObjectClass</full_name>
        <docblock line="960">
          <description><![CDATA[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><![CDATA[]]></long-description>
          <tag line="960" name="param" description="The name of the objectClass to add." type="string" variable="$object_class_name">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="965">
          <name>$object_class_name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="979" package="lib">
        <name>getRequiredByObjectClasses</name>
        <full_name>getRequiredByObjectClasses</full_name>
        <docblock line="974">
          <description><![CDATA[Gets the list of "required by" objectClasses, that is the list of objectClasses
which provide must have attribute.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="974" name="return" description="An array of names of objectclasses (strings) which provide this attribute" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="990" package="lib">
      <extends>\SchemaItem</extends>
      <name>Syntax</name>
      <full_name>\Syntax</full_name>
      <docblock line="985">
        <description><![CDATA[Represents an LDAP Syntax]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="985" name="package" description="lib"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="993" package="lib">
        <name>initVars</name>
        <full_name>initVars</full_name>
        <docblock line="992">
          <description><![CDATA[Initializes the class' member variables]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1003" package="lib">
        <name>Syntax</name>
        <full_name>Syntax</full_name>
        <docblock line="1000">
          <description><![CDATA[Creates a new Syntax object from a raw LDAP syntax string.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="1003">
          <name>$raw_ldap_syntax_string</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="1036" package="lib">
      <extends>\SchemaItem</extends>
      <name>MatchingRule</name>
      <full_name>\MatchingRule</full_name>
      <docblock line="1031">
        <description><![CDATA[Represents an LDAP MatchingRule]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="1031" name="package" description="lib"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="1039" namespace="global" package="main">
        <name>$name</name>
        <default><![CDATA[]]></default>
        <docblock line="1038">
          <description><![CDATA[This rule's name]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="1041" namespace="global" package="main">
        <name>$syntax</name>
        <default><![CDATA[]]></default>
        <docblock line="1040">
          <description><![CDATA[This rule's syntax OID]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="1043" namespace="global" package="main">
        <name>$is_obsolete</name>
        <default><![CDATA[]]></default>
        <docblock line="1042">
          <description><![CDATA[Boolean value indicating whether this MatchingRule is obsolete]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="1045" namespace="global" package="main">
        <name>$used_by_attrs</name>
        <default><![CDATA[]]></default>
        <docblock line="1044">
          <description><![CDATA[An array of attribute names who use this MatchingRule]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1048" package="lib">
        <name>initVars</name>
        <full_name>initVars</full_name>
        <docblock line="1047">
          <description><![CDATA[Initialize the class' member variables]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1062" package="lib">
        <name>MatchingRule</name>
        <full_name>MatchingRule</full_name>
        <docblock line="1059">
          <description><![CDATA[Creates a new MatchingRule object from a raw LDAP MatchingRule string.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="1062">
          <name>$raw_ldap_matching_rule_string</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1123" package="lib">
        <name>setUsedByAttrs</name>
        <full_name>setUsedByAttrs</full_name>
        <docblock line="1119">
          <description><![CDATA[Sets the list of used_by_attrs to the array specified by $attrs;]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1119" name="param" description="The array of attribute names (strings) which use this MatchingRule" type="array" variable="$attrs">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1123">
          <name>$attrs</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1132" package="lib">
        <name>addUsedByAttr</name>
        <full_name>addUsedByAttr</full_name>
        <docblock line="1128">
          <description><![CDATA[Adds an attribute name to the list of attributes who use this MatchingRule]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1128" name="return" description="if the attribute was added and false otherwise (already in the list)" type="true">
            <type by_reference="false">true</type>
          </tag>
        </docblock>
        <argument line="1132">
          <name>$new_attr_name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1145" package="lib">
        <name>getName</name>
        <full_name>getName</full_name>
        <docblock line="1141">
          <description><![CDATA[Gets this MatchingRule's name.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1141" name="return" description="The name." type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1154" package="lib">
        <name>getIsObsolete</name>
        <full_name>getIsObsolete</full_name>
        <docblock line="1150">
          <description><![CDATA[Gets whether this MatchingRule is flagged as obsolete by the LDAP server.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1150" name="return" description="True if this MatchingRule is obsolete and false otherwise." type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1163" package="lib">
        <name>getUsedByAttrs</name>
        <full_name>getUsedByAttrs</full_name>
        <docblock line="1159">
          <description><![CDATA[Gets an array of attribute names (strings) which use this MatchingRule]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1159" name="return" description="The array of attribute names (strings)." type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="1174" package="lib">
      <extends>\SchemaItem</extends>
      <name>MatchingRuleUse</name>
      <full_name>\MatchingRuleUse</full_name>
      <docblock line="1169">
        <description><![CDATA[Represents an LDAP schema matchingRuleUse entry]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="1169" name="package" description="lib"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="1177" namespace="global" package="main">
        <name>$name</name>
        <default><![CDATA[]]></default>
        <docblock line="1176">
          <description><![CDATA[The name of the MathingRule this applies to]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="1180" namespace="global" package="main">
        <name>$used_by_attrs</name>
        <default><![CDATA[]]></default>
        <docblock line="1178">
          <description><![CDATA[An array of attributeType names who make use of the mathingRule
identified by $this->oid and $this->name]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1183" package="lib">
        <name>initVars</name>
        <full_name>initVars</full_name>
        <docblock line="1182">
          <description><![CDATA[Initialize the class' member variables]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1191" package="lib">
        <name>MatchingRuleUse</name>
        <full_name>MatchingRuleUse</full_name>
        <argument line="1191">
          <name>$raw_matching_rule_use_string</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1256" package="lib">
        <name>getName</name>
        <full_name>getName</full_name>
        <docblock line="1252">
          <description><![CDATA[Gets this MatchingRuleUse's name]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1252" name="return" description="The name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1265" package="lib">
        <name>getUsedByAttrs</name>
        <full_name>getUsedByAttrs</full_name>
        <docblock line="1261">
          <description><![CDATA[Gets an array of attribute names (strings) which use this MatchingRuleUse object.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1261" name="return" description="The array of attribute names (strings)." type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
    </class>
    <parse_markers>
      <error line="1529" code="50015">Argument $use_cache is missing from the Docblock of \get_schema_objectclasses()</error>
      <error line="1570" code="50015">Argument $use_cache is missing from the Docblock of \get_schema_objectclass()</error>
      <error line="1594" code="50014">Name of argument $attr_name does not match with the DocBlock's name $oclass_name in \get_schema_attribute()</error>
      <error line="1594" code="50015">Argument $use_cache is missing from the Docblock of \get_schema_attribute()</error>
      <notice line="1594" code="50013">Parameter $oclass_name could not be found in \get_schema_attribute()</notice>
      <error line="1617" code="50015">Argument $use_cache is missing from the Docblock of \get_schema_attributes()</error>
      <error line="1714" code="50015">Argument $attrs is missing from the Docblock of \add_aliases_to_attrs()</error>
      <error line="1741" code="50015">Argument $attrs is missing from the Docblock of \add_sup_to_attrs()</error>
      <error line="1741" code="50015">Argument $attrs_oid is missing from the Docblock of \add_sup_to_attrs()</error>
      <error line="1856" code="50015">Argument $dn is missing from the Docblock of \get_schema_matching_rules()</error>
      <error line="1856" code="50015">Argument $use_cache is missing from the Docblock of \get_schema_matching_rules()</error>
      <error line="1910" code="50015">Argument $dn is missing from the Docblock of \get_schema_syntaxes()</error>
      <error line="1910" code="50015">Argument $use_cache is missing from the Docblock of \get_schema_syntaxes()</error>
      <error line="1945" code="50015">Argument $schema_type is missing from the Docblock of \cached_schema_available()</error>
      <error line="1981" code="50015">Argument $schema_type is missing from the Docblock of \get_cached_schema()</error>
      <error line="2015" code="50015">Argument $schema_type is missing from the Docblock of \set_cached_schema()</error>
      <error line="2015" code="50015">Argument $schema_items is missing from the Docblock of \set_cached_schema()</error>
      <error line="65" code="50010">No DocBlock was found for method setOID()</error>
      <error line="70" code="50010">No DocBlock was found for method setDescription()</error>
      <error line="75" code="50010">No DocBlock was found for method getOID()</error>
      <error line="80" code="50010">No DocBlock was found for method getDescription()</error>
      <error line="123" code="50015">Argument $raw_ldap_schema_string is missing from the Docblock of ObjectClass()</error>
      <error line="593" code="50015">Argument $raw_ldap_attr_string is missing from the Docblock of AttributeType()</error>
      <error line="1000" code="50015">Argument $raw_ldap_syntax_string is missing from the Docblock of Syntax()</error>
      <error line="1059" code="50015">Argument $raw_ldap_matching_rule_string is missing from the Docblock of MatchingRule()</error>
      <error line="1128" code="50015">Argument $new_attr_name is missing from the Docblock of addUsedByAttr()</error>
      <error line="1191" code="50010">No DocBlock was found for method MatchingRuleUse()</error>
    </parse_markers>
  </file>
  <file path="help/help.inc" hash="e640ddd7c1c2314aa702532b6da0743e" package="Help">
    <docblock line="27">
      <description><![CDATA[LDAP Account Manager help entries.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="27" name="author" description="Michael Duergner"/>
      <tag line="27" name="author" description="Roland Gruber"/>
      <tag line="27" name="package" description="Help"/>
    </docblock>
  </file>
  <file path="templates/lib/141_jquery-validationEngine-lang.php" hash="69cebd5773de22f547d048f09bdaaab4" package="main">
    <include line="26" type="Include Once" package="main">
      <name>../../lib/config.inc</name>
      <docblock line="25">
        <description><![CDATA[access to configuration options]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <parse_markers>
      <error line="0" code="50007">No page-level DocBlock was found in file templates/lib/141_jquery-validationEngine-lang.php</error>
    </parse_markers>
  </file>
  <file path="templates/misc/ajax.php" hash="17ff1a03fa4bc1d8aafa9da3ff87d046" package="tools">
    <docblock line="24">
      <description><![CDATA[Manages all AJAX requests.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="author" description="Roland Gruber"/>
      <tag line="24" name="package" description="tools"/>
    </docblock>
    <include line="32" type="Include Once" package="main">
      <name>../../lib/security.inc</name>
      <docblock line="31">
        <description><![CDATA[security functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <class final="false" abstract="false" namespace="global" line="55" package="main">
      <extends/>
      <name>lamAjax</name>
      <full_name>\lamAjax</full_name>
      <docblock line="52">
        <description><![CDATA[Manages all AJAX requests.]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
      <method final="false" abstract="false" static="true" visibility="public" namespace="global" line="60" package="main">
        <name>handleRequest</name>
        <full_name>handleRequest</full_name>
        <docblock line="57">
          <description><![CDATA[Manages an AJAX request.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="global" line="91" package="main">
        <name>managePasswordChange</name>
        <full_name>managePasswordChange</full_name>
        <docblock line="86">
          <description><![CDATA[Manages a password change request on the edit account page.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="86" name="param" description="input parameters" type="array" variable="$input">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="91">
          <name>$input</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="templates/tree/treeViewContainer.php" hash="9af53eb878d4a5359c387a4b5d00fd5e" package="lists\tree">
    <docblock line="24">
      <description><![CDATA[Provides a container around the tree view frameset.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="author" description="Roland Gruber"/>
      <tag line="24" name="package" description="lists"/>
      <tag line="24" name="subpackage" description="tree"/>
    </docblock>
    <include line="33" type="Include Once" package="main">
      <name>../../lib/security.inc</name>
      <docblock line="32">
        <description><![CDATA[security functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="35" type="Include Once" package="main">
      <name>../../lib/config.inc</name>
      <docblock line="34">
        <description><![CDATA[access to configuration options]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="42" type="Include" package="main">
      <name>../main_header.php</name>
    </include>
    <include line="61" type="Include" package="main">
      <name>../main_footer.php</name>
    </include>
  </file>
  <file path="templates/serverInfo.php" hash="61ce935fa95bcaa8d326cd1653e37be6" package="tools">
    <docblock line="24">
      <description><![CDATA[Provides a list of LAM tests.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="author" description="Roland Gruber"/>
      <tag line="24" name="package" description="tools"/>
    </docblock>
    <include line="32" type="Include Once" package="main">
      <name>../lib/security.inc</name>
      <docblock line="31">
        <description><![CDATA[security functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="34" type="Include Once" package="main">
      <name>../lib/config.inc</name>
      <docblock line="33">
        <description><![CDATA[access to configuration options]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="97" type="Include" package="main">
      <name>main_header.php</name>
    </include>
    <include line="405" type="Include" package="main">
      <name>main_footer.php</name>
    </include>
  </file>
  <file path="templates/lists/list.php" hash="0206d500ca1a9c3e8bffea88e75e98cc" package="lists">
    <docblock line="25">
      <description><![CDATA[This file shows the list views.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="25" name="package" description="lists"/>
      <tag line="25" name="author" description="Roland Gruber"/>
    </docblock>
    <include line="33" type="Include Once" package="main">
      <name>../../lib/security.inc</name>
      <docblock line="32">
        <description><![CDATA[security functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="35" type="Include Once" package="main">
      <name>../../lib/types.inc</name>
      <docblock line="34">
        <description><![CDATA[Used to get type information.]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="37" type="Include Once" package="main">
      <name>../../lib/config.inc</name>
      <docblock line="36">
        <description><![CDATA[Access to configuration options]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/lists/userlink.php" hash="8be5e0eb89bf91ee243ba3e546785eb0" package="lists">
    <docblock line="24">
      <description><![CDATA[This page will redirect to account/edit.php if the given user is valid.]]></description>
      <long-description><![CDATA[<p>It is called from listgroups.php via the memberUID links.</p>]]></long-description>
      <tag line="24" name="package" description="lists"/>
      <tag line="24" name="author" description="Roland Gruber"/>
    </docblock>
    <include line="34" type="Include Once" package="main">
      <name>../../lib/security.inc</name>
      <docblock line="33">
        <description><![CDATA[security functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="36" type="Include Once" package="main">
      <name>../../lib/ldap.inc</name>
      <docblock line="35">
        <description><![CDATA[Needed to find DNs of users]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="38" type="Include Once" package="main">
      <name>../../lib/status.inc</name>
      <docblock line="37">
        <description><![CDATA[Used to display error messages]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="60" type="Include" package="main">
      <name>../main_header.php</name>
    </include>
    <include line="64" type="Include" package="main">
      <name>../main_footer.php</name>
    </include>
    <function namespace="global" line="74" package="lists">
      <name>search_username</name>
      <full_name>\search_username</full_name>
      <docblock line="68">
        <description><![CDATA[Searches LDAP for a specific user name (uid attribute) and returns its DN entry]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="68" name="param" description="user name" type="string" variable="$name">
          <type by_reference="false">string</type>
        </tag>
        <tag line="68" name="return" description="DN" type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="74">
        <name>$name</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
  </file>
  <file path="templates/lists/deletelink.php" hash="11eabef0ce4f36792617d0c6764f58d6" package="lists">
    <docblock line="24">
      <description><![CDATA[This page will redirect to delete.php if the given user is valid.]]></description>
      <long-description><![CDATA[<p>It is called from the list views via the delete links.</p>]]></long-description>
      <tag line="24" name="package" description="lists"/>
      <tag line="24" name="author" description="Roland Gruber"/>
    </docblock>
    <include line="34" type="Include Once" package="main">
      <name>../../lib/security.inc</name>
      <docblock line="33">
        <description><![CDATA[security functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="36" type="Include Once" package="main">
      <name>../../lib/ldap.inc</name>
      <docblock line="35">
        <description><![CDATA[Needed to find DNs of users]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="38" type="Include Once" package="main">
      <name>../../lib/status.inc</name>
      <docblock line="37">
        <description><![CDATA[Used to display error messages]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="63" type="Include" package="main">
      <name>../main_header.php</name>
    </include>
    <include line="65" type="Include" package="main">
      <name>../main_footer.php</name>
    </include>
  </file>
  <file path="templates/tests/schemaTest.php" hash="b50b31ab0289bebc9738edb5632f9b30" package="tools">
    <docblock line="24">
      <description><![CDATA[Tests the lamdaemon script.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="author" description="Roland Gruber"/>
      <tag line="24" name="package" description="tools"/>
    </docblock>
    <include line="32" type="Include Once" package="main">
      <name>../../lib/security.inc</name>
      <docblock line="31">
        <description><![CDATA[security functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="34" type="Include Once" package="main">
      <name>../../lib/config.inc</name>
      <docblock line="33">
        <description><![CDATA[access to configuration options]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="36" type="Include Once" package="main">
      <name>../../lib/modules.inc</name>
      <docblock line="35">
        <description><![CDATA[account modules]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="38" type="Include Once" package="main">
      <name>../../lib/schema.inc</name>
      <docblock line="37">
        <description><![CDATA[LDAP schema]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="50" type="Include" package="main">
      <name>../main_header.php</name>
    </include>
    <include line="92" type="Include" package="main">
      <name>../main_footer.php</name>
    </include>
    <function namespace="global" line="101" package="tools">
      <name>checkSchemaForModule</name>
      <full_name>\checkSchemaForModule</full_name>
      <docblock line="94">
        <description><![CDATA[Checks if the object classes and attributes for this module are available.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="94" name="param" description="module name" type="String" variable="$name">
          <type by_reference="false">String</type>
        </tag>
        <tag line="94" name="param" description="type (user, group, ...)" type="String" variable="$type">
          <type by_reference="false">String</type>
        </tag>
        <tag line="94" name="return" description="error message or null" type="String">
          <type by_reference="false">String</type>
        </tag>
      </docblock>
      <argument line="101">
        <name>$name</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="101">
        <name>$type</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="140" package="tools">
      <name>getRecursiveAttributesFromObjectClass</name>
      <full_name>\getRecursiveAttributesFromObjectClass</full_name>
      <docblock line="134">
        <description><![CDATA[Returns the names of all attributes which are managed by the given object class and its parents.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="134" name="param" description="object class" type="\ObjectClass" variable="$oClass">
          <type by_reference="false">\ObjectClass</type>
        </tag>
        <tag line="134" name="return" description="list of attribute names" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="140">
        <name>$oClass</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
  </file>
  <file path="templates/tests/index.php" hash="8e73213c6c079573ef5371dee38d1aef" package="tools">
    <docblock line="24">
      <description><![CDATA[Provides a list of LAM tests.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="author" description="Roland Gruber"/>
      <tag line="24" name="package" description="tools"/>
    </docblock>
    <include line="32" type="Include Once" package="main">
      <name>../../lib/security.inc</name>
      <docblock line="31">
        <description><![CDATA[security functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="34" type="Include Once" package="main">
      <name>../../lib/config.inc</name>
      <docblock line="33">
        <description><![CDATA[access to configuration options]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="46" type="Include" package="main">
      <name>../main_header.php</name>
    </include>
    <include line="66" type="Include" package="main">
      <name>../main_footer.php</name>
    </include>
  </file>
  <file path="templates/tests/lamdaemonTest.php" hash="2ce4ab3745fe051a6e79abc101a375e3" package="tools">
    <docblock line="24">
      <description><![CDATA[Tests the lamdaemon script.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="author" description="Roland Gruber"/>
      <tag line="24" name="author" description="Thomas Manninger"/>
      <tag line="24" name="package" description="tools"/>
    </docblock>
    <include line="33" type="Include Once" package="main">
      <name>../../lib/security.inc</name>
      <docblock line="32">
        <description><![CDATA[security functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="35" type="Include Once" package="main">
      <name>../../lib/config.inc</name>
      <docblock line="34">
        <description><![CDATA[access to configuration options]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="47" type="Include" package="main">
      <name>../main_header.php</name>
    </include>
    <include line="105" type="Include" package="main">
      <name>../main_footer.php</name>
    </include>
    <include line="305" type="Include Once" package="main">
      <name>Net/SSH2.php</name>
    </include>
    <function namespace="global" line="118" package="tools">
      <name>lamTestLamdaemon</name>
      <full_name>\lamTestLamdaemon</full_name>
      <docblock line="108">
        <description><![CDATA[Runs a test case of lamdaemon.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="108" name="param" description="test command" type="string" variable="$command">
          <type by_reference="false">string</type>
        </tag>
        <tag line="108" name="param" description="specifies if test should be run" type="boolean" variable="$stopTest">
          <type by_reference="false">boolean</type>
        </tag>
        <tag line="108" name="param" description="SSH connection" type="\connection" variable="$handle">
          <type by_reference="false">\connection</type>
        </tag>
        <tag line="108" name="param" description="describing text" type="string" variable="$testText">
          <type by_reference="false">string</type>
        </tag>
        <tag line="108" name="param" description="container for HTML output" type="\htmlTable" variable="$container">
          <type by_reference="false">\htmlTable</type>
        </tag>
        <tag line="108" name="return" description="true, if errors occured" type="boolean">
          <type by_reference="false">boolean</type>
        </tag>
      </docblock>
      <argument line="118">
        <name>$command</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="118">
        <name>$stopTest</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="118">
        <name>$handle</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="118">
        <name>$testText</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="118">
        <name>$container</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="172" package="tools">
      <name>lamRunLamdaemonTestSuite</name>
      <full_name>\lamRunLamdaemonTestSuite</full_name>
      <docblock line="164">
        <description><![CDATA[Runs all tests for a given server.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="164" name="param" description="server ID" type="String" variable="$serverName">
          <type by_reference="false">String</type>
        </tag>
        <tag line="164" name="param" description="server name" type="String" variable="$serverTitle">
          <type by_reference="false">String</type>
        </tag>
        <tag line="164" name="param" description="true, if Quotas should be checked" type="boolean" variable="$testQuota">
          <type by_reference="false">boolean</type>
        </tag>
        <tag line="164" name="param" description="container for HTML output" type="\htmlTable" variable="$container">
          <type by_reference="false">\htmlTable</type>
        </tag>
      </docblock>
      <argument line="172">
        <name>$serverName</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="172">
        <name>$serverTitle</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="172">
        <name>$testQuota</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="172">
        <name>$container</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="302" package="tools">
      <name>lamTestConnectSSH</name>
      <full_name>\lamTestConnectSSH</full_name>
      <docblock line="296">
        <description><![CDATA[Connects to the given SSH server.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="296" name="param" description="server name (e.g. localhost or localhost,1234)" type="String" variable="$server">
          <type by_reference="false">String</type>
        </tag>
        <tag line="296" name="return" description="handle" type="object">
          <type by_reference="false">object</type>
        </tag>
      </docblock>
      <argument line="302">
        <name>$server</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
  </file>
  <file path="templates/ou_edit.php" hash="3eadf3f8cb28f310e7ad3b26dffda3dc" package="tools">
    <docblock line="24">
      <description><![CDATA[This is an editor for organizational units.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="author" description="Roland Gruber"/>
      <tag line="24" name="package" description="tools"/>
    </docblock>
    <include line="32" type="Include Once" package="main">
      <name>../lib/security.inc</name>
      <docblock line="31">
        <description><![CDATA[security functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="34" type="Include Once" package="main">
      <name>../lib/config.inc</name>
      <docblock line="33">
        <description><![CDATA[access to configuration data]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="36" type="Include Once" package="main">
      <name>../lib/ldap.inc</name>
      <docblock line="35">
        <description><![CDATA[access LDAP server]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="38" type="Include Once" package="main">
      <name>../lib/status.inc</name>
      <docblock line="37">
        <description><![CDATA[used to print status messages]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="107" type="Include" package="main">
      <name>main_header.php</name>
    </include>
    <include line="127" type="Include" package="main">
      <name>main_footer.php</name>
    </include>
    <include line="146" type="Include" package="main">
      <name>main_header.php</name>
    </include>
    <include line="211" type="Include" package="main">
      <name>main_footer.php</name>
    </include>
    <function namespace="global" line="144" package="tools">
      <name>display_main</name>
      <full_name>\display_main</full_name>
      <docblock line="138">
        <description><![CDATA[Displays the main page of the OU editor]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="138" name="param" description="info message" type="String" variable="$message">
          <type by_reference="false">String</type>
        </tag>
        <tag line="138" name="param" description="error message" type="String" variable="$error">
          <type by_reference="false">String</type>
        </tag>
      </docblock>
      <argument line="144">
        <name>$message</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="144">
        <name>$error</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
  </file>
  <file path="templates/tools.php" hash="68eb8d4879d465fde0f0cdb52bbea9de" package="tools">
    <docblock line="24">
      <description><![CDATA[Provides a list of tools like file upload or profile editor.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="author" description="Roland Gruber"/>
      <tag line="24" name="package" description="tools"/>
    </docblock>
    <include line="32" type="Include Once" package="main">
      <name>../lib/security.inc</name>
      <docblock line="31">
        <description><![CDATA[security functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="34" type="Include Once" package="main">
      <name>../lib/config.inc</name>
      <docblock line="33">
        <description><![CDATA[access to configuration options]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="36" type="Include Once" package="main">
      <name>../lib/tools.inc</name>
      <docblock line="35">
        <description><![CDATA[tool definitions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="43" type="Include" package="main">
      <name>main_header.php</name>
    </include>
    <include line="94" type="Include" package="main">
      <name>main_footer.php</name>
    </include>
  </file>
  <file path="templates/main.php" hash="1b02c2ebe867d2a44c4e8a23ff5ebe1c" package="main">
    <docblock line="24">
      <description><![CDATA[This is the main window.]]></description>
      <long-description><![CDATA[<p>The user and group lists will be shown in this frameset.</p>]]></long-description>
      <tag line="24" name="package" description="main"/>
      <tag line="24" name="author" description="Roland Gruber"/>
    </docblock>
    <include line="32" type="Include Once" package="main">
      <name>../lib/config.inc</name>
      <docblock line="31">
        <description><![CDATA[config object]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/login.php" hash="efce3b7aadb0120e6e386c47ea997fbd" package="main">
    <docblock line="25">
      <description><![CDATA[Login form of LDAP Account Manager.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="25" name="author" description="Michael Duergner"/>
      <tag line="25" name="author" description="Roland Gruber"/>
      <tag line="25" name="package" description="main"/>
    </docblock>
    <include line="34" type="Include Once" package="main">
      <name>../lib/status.inc</name>
      <docblock line="33">
        <description><![CDATA[status messages]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="37" type="Include" package="main">
      <name>../lib/checkEnvironment.inc</name>
      <docblock line="36">
        <description><![CDATA[check environment]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="40" type="Include Once" package="main">
      <name>../lib/security.inc</name>
      <docblock line="39">
        <description><![CDATA[security functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="42" type="Include Once" package="main">
      <name>../lib/selfService.inc</name>
      <docblock line="41">
        <description><![CDATA[self service functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="44" type="Include Once" package="main">
      <name>../lib/config.inc</name>
      <docblock line="43">
        <description><![CDATA[access to configuration options]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="47" type="Include Once" package="main">
      <name>../lib/upgrade.inc</name>
      <docblock line="46">
        <description><![CDATA[Upgrade functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="515" type="Include Once" package="main">
      <name>../lib/ldap.inc</name>
    </include>
    <function namespace="global" line="120" package="main">
      <name>display_LoginPage</name>
      <full_name>\display_LoginPage</full_name>
      <docblock line="115">
        <description><![CDATA[Displays the login window.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="115" name="param" description="current active configuration" type="object" variable="$config_object">
          <type by_reference="false">object</type>
        </tag>
      </docblock>
      <argument line="120">
        <name>$config_object</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
  </file>
  <file path="templates/massDoUpload.php" hash="fe1788c160e2af0ba1be4c17ac48a2e8" package="tools">
    <docblock line="24">
      <description><![CDATA[Creates LDAP accounts for file upload.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="author" description="Roland Gruber"/>
      <tag line="24" name="package" description="tools"/>
    </docblock>
    <include line="32" type="Include Once" package="main">
      <name>../lib/security.inc</name>
      <docblock line="31">
        <description><![CDATA[security functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="34" type="Include Once" package="main">
      <name>../lib/config.inc</name>
      <docblock line="33">
        <description><![CDATA[access to configuration]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="36" type="Include Once" package="main">
      <name>../lib/ldap.inc</name>
      <docblock line="35">
        <description><![CDATA[LDAP handle]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="38" type="Include Once" package="main">
      <name>../lib/status.inc</name>
      <docblock line="37">
        <description><![CDATA[status messages]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="40" type="Include Once" package="main">
      <name>../lib/modules.inc</name>
      <docblock line="39">
        <description><![CDATA[account modules]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="42" type="Include Once" package="main">
      <name>../lib/pdf.inc</name>
      <docblock line="41">
        <description><![CDATA[PDF]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="63" type="Include" package="main">
      <name>main_header.php</name>
    </include>
    <include line="273" type="Include" package="main">
      <name>main_footer.php</name>
    </include>
  </file>
  <file path="templates/masscreate.php" hash="ff29855dc0f64f764af857aaeb8b8556" package="tools">
    <docblock line="24">
      <description><![CDATA[Start page of file upload]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="author" description="Roland Gruber"/>
      <tag line="24" name="package" description="tools"/>
    </docblock>
    <include line="32" type="Include Once" package="main">
      <name>../lib/security.inc</name>
      <docblock line="31">
        <description><![CDATA[security functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="34" type="Include Once" package="main">
      <name>../lib/config.inc</name>
      <docblock line="33">
        <description><![CDATA[access to configuration]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="36" type="Include Once" package="main">
      <name>../lib/status.inc</name>
      <docblock line="35">
        <description><![CDATA[status messages]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="38" type="Include Once" package="main">
      <name>../lib/modules.inc</name>
      <docblock line="37">
        <description><![CDATA[account modules]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="40" type="Include Once" package="main">
      <name>../lib/pdfstruct.inc</name>
      <docblock line="39">
        <description><![CDATA[Used to get PDF information.]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="77" type="Include" package="main">
      <name>main_header.php</name>
    </include>
    <include line="220" type="Include" package="main">
      <name>main_footer.php</name>
    </include>
    <include line="470" type="Include" package="main">
      <name>main_footer.php</name>
    </include>
    <function namespace="global" line="228" package="tools">
      <name>showMainPage</name>
      <full_name>\showMainPage</full_name>
      <docblock line="222">
        <description><![CDATA[Displays the acount type specific main page of the upload.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="222" name="param" description="account type" type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="222" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="228">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="228">
        <name>$selectedModules</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
  </file>
  <file path="templates/config/profmanage.php" hash="428d8310b01276be7bdbf78f11a0ece4" package="configuration">
    <docblock line="25">
      <description><![CDATA[Configuration profile management.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="25" name="package" description="configuration"/>
      <tag line="25" name="author" description="Roland Gruber"/>
    </docblock>
    <include line="34" type="Include Once" package="main">
      <name>../../lib/config.inc</name>
      <docblock line="33">
        <description><![CDATA[Access to config functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="36" type="Include Once" package="main">
      <name>../../lib/status.inc</name>
      <docblock line="35">
        <description><![CDATA[Used to print status messages]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/config/mainmanage.php" hash="598d12bc4ee6127cf189fef6c487084b" package="configuration">
    <docblock line="25">
      <description><![CDATA[Manages the main configuration options.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="25" name="package" description="configuration"/>
      <tag line="25" name="author" description="Roland Gruber"/>
    </docblock>
    <include line="34" type="Include Once" package="main">
      <name>../../lib/config.inc</name>
      <docblock line="33">
        <description><![CDATA[Access to config functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="36" type="Include Once" package="main">
      <name>../../lib/status.inc</name>
      <docblock line="35">
        <description><![CDATA[Used to print status messages]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="50" type="Require" package="main">
      <name>mainlogin.php</name>
    </include>
  </file>
  <file path="templates/config/confmodules.php" hash="35204ee6b19bdae093047b992a1b86d5" package="configuration">
    <docblock line="25">
      <description><![CDATA[confmodules lets the user select the account modules]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="25" name="package" description="configuration"/>
      <tag line="25" name="author" description="Roland Gruber"/>
    </docblock>
    <include line="34" type="Include Once" package="main">
      <name>../../lib/config.inc</name>
      <docblock line="33">
        <description><![CDATA[Access to config functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="36" type="Include Once" package="main">
      <name>../../lib/modules.inc</name>
      <docblock line="35">
        <description><![CDATA[Access to module lists]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="51" type="Require" package="main">
      <name>conflogin.php</name>
      <docblock line="50">
        <description><![CDATA[go back to login if password is invalid]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <function namespace="global" line="245" package="configuration">
      <name>config_showAccountModules</name>
      <full_name>\config_showAccountModules</full_name>
      <docblock line="238">
        <description><![CDATA[Displays the module selection boxes and checks if dependencies are fulfilled.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="238" name="param" description="account type" type="string" variable="$scope">
          <type by_reference="false">string</type>
        </tag>
        <tag line="238" name="param" description="title for module selection (e.g. &quot;User modules&quot;)" type="string" variable="$title">
          <type by_reference="false">string</type>
        </tag>
        <tag line="238" name="param" description="meta HTML container" type="\htmlTable" variable="$container">
          <type by_reference="false">\htmlTable</type>
        </tag>
      </docblock>
      <argument line="245">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="245">
        <name>$title</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="245">
        <name>$container</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="334" package="configuration">
      <name>checkInput</name>
      <full_name>\checkInput</full_name>
      <docblock line="329">
        <description><![CDATA[Checks user input and saves the entered settings.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="329" name="return" description="list of errors" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
    </function>
  </file>
  <file path="templates/config/confsave.php" hash="abd7071cf4f53ff46b64332e97767b8d" package="configuration">
    <docblock line="25">
      <description><![CDATA[End page of configuration.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="25" name="package" description="configuration"/>
      <tag line="25" name="author" description="Roland Gruber"/>
    </docblock>
    <include line="34" type="Include Once" package="main">
      <name>../../lib/config.inc</name>
      <docblock line="33">
        <description><![CDATA[Access to config functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="37" type="Include Once" package="main">
      <name>../../lib/modules.inc</name>
      <docblock line="36">
        <description><![CDATA[access to module settings]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="55" type="Require" package="main">
      <name>conflogin.php</name>
      <docblock line="54">
        <description><![CDATA[go back to login if password is empty]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="73" type="Require" package="main">
      <name>conflogin.php</name>
      <docblock line="72">
        <description><![CDATA[go back to login if password is invalid]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/config/index.php" hash="d567a2112a37ac40db0c496dfe27aa34" package="configuration">
    <docblock line="25">
      <description><![CDATA[Displays links to all configuration pages.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="25" name="package" description="configuration"/>
      <tag line="25" name="author" description="Roland Gruber"/>
    </docblock>
    <include line="34" type="Include Once" package="main">
      <name>../../lib/config.inc</name>
      <docblock line="33">
        <description><![CDATA[Access to config functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/config/confmain.php" hash="6bcbf89c56a5f08698a234a53af2eb14" package="configuration">
    <docblock line="25">
      <description><![CDATA[Main page of configuration]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="25" name="package" description="configuration"/>
      <tag line="25" name="author" description="Roland Gruber"/>
      <tag line="25" name="author" description="Thomas Manninger"/>
    </docblock>
    <include line="35" type="Include Once" package="main">
      <name>../../lib/config.inc</name>
      <docblock line="34">
        <description><![CDATA[Access to config functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="37" type="Include Once" package="main">
      <name>../../lib/modules.inc</name>
      <docblock line="36">
        <description><![CDATA[access to module settings]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="39" type="Include Once" package="main">
      <name>../../lib/tools.inc</name>
      <docblock line="38">
        <description><![CDATA[access to tools]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <function namespace="global" line="468" package="configuration">
      <name>checkInput</name>
      <full_name>\checkInput</full_name>
      <docblock line="463">
        <description><![CDATA[Checks user input and saves the entered settings.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="463" name="return" description="list of errors" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
    </function>
  </file>
  <file path="templates/config/moduleSettings.php" hash="c27ea6605e052c06af4ea164b26e3c16" package="configuration">
    <docblock line="25">
      <description><![CDATA[Here the user can edit the module settings.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="25" name="package" description="configuration"/>
      <tag line="25" name="author" description="Roland Gruber"/>
    </docblock>
    <include line="34" type="Include Once" package="main">
      <name>../../lib/config.inc</name>
      <docblock line="33">
        <description><![CDATA[Access to config functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="36" type="Include Once" package="main">
      <name>../../lib/types.inc</name>
      <docblock line="35">
        <description><![CDATA[Access to account types]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="50" type="Require" package="main">
      <name>conflogin.php</name>
      <docblock line="49">
        <description><![CDATA[go back to login if password is invalid]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <function namespace="global" line="254" package="configuration">
      <name>checkInput</name>
      <full_name>\checkInput</full_name>
      <docblock line="249">
        <description><![CDATA[Checks user input and saves the entered settings.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="249" name="return" description="list of errors" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
    </function>
  </file>
  <file path="templates/config/conftypes.php" hash="b94602b97ff49e82b99eda6d1adb338a" package="configuration">
    <docblock line="25">
      <description><![CDATA[Here the user can select the account types.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="25" name="package" description="configuration"/>
      <tag line="25" name="author" description="Roland Gruber"/>
    </docblock>
    <include line="34" type="Include Once" package="main">
      <name>../../lib/config.inc</name>
      <docblock line="33">
        <description><![CDATA[Access to config functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="36" type="Include Once" package="main">
      <name>../../lib/types.inc</name>
      <docblock line="35">
        <description><![CDATA[Access to account types]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="50" type="Require" package="main">
      <name>conflogin.php</name>
      <docblock line="49">
        <description><![CDATA[go back to login if password is invalid]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <function namespace="global" line="337" package="configuration">
      <name>checkInput</name>
      <full_name>\checkInput</full_name>
      <docblock line="332">
        <description><![CDATA[Checks user input and saves the entered settings.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="332" name="return" description="list of errors" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
    </function>
  </file>
  <file path="templates/config/conflogin.php" hash="c27e164426a760b8cba6380fcaec434a" package="configuration">
    <docblock line="25">
      <description><![CDATA[Login page to change the preferences.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="25" name="package" description="configuration"/>
      <tag line="25" name="author" description="Roland Gruber"/>
    </docblock>
    <include line="34" type="Include Once" package="main">
      <name>../../lib/config.inc</name>
      <docblock line="33">
        <description><![CDATA[Access to config functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="36" type="Include Once" package="main">
      <name>../../lib/status.inc</name>
      <docblock line="35">
        <description><![CDATA[Used to print status messages]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/config/mainlogin.php" hash="659882112cc042ee89741bd62df51992" package="configuration">
    <docblock line="25">
      <description><![CDATA[Login page to change the main preferences.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="25" name="package" description="configuration"/>
      <tag line="25" name="author" description="Roland Gruber"/>
    </docblock>
    <include line="34" type="Include Once" package="main">
      <name>../../lib/config.inc</name>
      <docblock line="33">
        <description><![CDATA[Access to config functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="36" type="Include Once" package="main">
      <name>../../lib/status.inc</name>
      <docblock line="35">
        <description><![CDATA[Used to print status messages]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/main_footer.php" hash="87f6238b4dabe640b125f217dcb7925c" package="main">
    <parse_markers>
      <error line="0" code="50007">No page-level DocBlock was found in file templates/main_footer.php</error>
    </parse_markers>
  </file>
  <file path="templates/account/edit.php" hash="e301e625697fec2a04ab68e13e7af795" package="modules">
    <docblock line="27">
      <description><![CDATA[Displays the account detail page.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="27" name="package" description="modules"/>
      <tag line="27" name="author" description="Tilo Lutz"/>
      <tag line="27" name="author" description="Roland Gruber"/>
    </docblock>
    <include line="36" type="Include Once" package="main">
      <name>../../lib/security.inc</name>
      <docblock line="35">
        <description><![CDATA[security functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="38" type="Include Once" package="main">
      <name>../../lib/config.inc</name>
      <docblock line="37">
        <description><![CDATA[configuration options]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="40" type="Include Once" package="main">
      <name>../../lib/profiles.inc</name>
      <docblock line="39">
        <description><![CDATA[functions to load and save profiles]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="42" type="Include Once" package="main">
      <name>../../lib/status.inc</name>
      <docblock line="41">
        <description><![CDATA[Return error-message]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="44" type="Include Once" package="main">
      <name>../../lib/pdf.inc</name>
      <docblock line="43">
        <description><![CDATA[Return a pdf-file]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="46" type="Include Once" package="main">
      <name>../../lib/modules.inc</name>
      <docblock line="45">
        <description><![CDATA[module functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="73" type="Include" package="main">
      <name>../main_header.php</name>
    </include>
    <include line="77" type="Include" package="main">
      <name>../main_footer.php</name>
    </include>
  </file>
  <file path="templates/main_header.php" hash="d10ae23598e3e5fec667e60af05c93b5" package="main">
    <docblock line="24">
      <description><![CDATA[Head part of page which includes links to lists etc.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="package" description="main"/>
      <tag line="24" name="author" description="Roland Gruber"/>
    </docblock>
    <include line="39" type="Include Once" package="main">
      <name/>
      <docblock line="38">
        <description><![CDATA[tool definitions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/schema/schema.php" hash="c632e61739393ffda882d1bf2c0a2de7" package="tools">
    <docblock line="25">
      <description><![CDATA[Displays the LDAP schema of the server]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="25" name="package" description="tools"/>
      <tag line="25" name="author" description="David Smith"/>
      <tag line="25" name="author" description="Roland Gruber"/>
    </docblock>
    <include line="35" type="Include Once" package="main">
      <name>../../lib/security.inc</name>
      <docblock line="34">
        <description><![CDATA[security functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="37" type="Include Once" package="main">
      <name>../../lib/ldap.inc</name>
      <docblock line="36">
        <description><![CDATA[access to LDAP server]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="39" type="Include Once" package="main">
      <name>../../lib/config.inc</name>
      <docblock line="38">
        <description><![CDATA[access to configuration options]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="41" type="Require Once" package="main">
      <name>../../lib/schema.inc</name>
      <docblock line="40">
        <description><![CDATA[schema functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="50" type="Include" package="main">
      <name>../main_header.php</name>
    </include>
    <include line="441" type="Include" package="main">
      <name>../main_footer.php</name>
    </include>
  </file>
  <file path="templates/pdfedit/pdfpage.php" hash="227e4eefb900a217010887b7b57584e1" package="PDF">
    <docblock line="27">
      <description><![CDATA[Displays the main page of the PDF editor where the user can select the displayed entries.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="27" name="author" description="Michael Duergner"/>
      <tag line="27" name="author" description="Roland Gruber"/>
      <tag line="27" name="package" description="PDF"/>
    </docblock>
    <include line="36" type="Include Once" package="main">
      <name>../../lib/security.inc</name>
      <docblock line="35">
        <description><![CDATA[security functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="38" type="Include Once" package="main">
      <name>../../lib/pdfstruct.inc</name>
      <docblock line="37">
        <description><![CDATA[access to PDF configuration files]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="40" type="Include Once" package="main">
      <name>../../lib/ldap.inc</name>
      <docblock line="39">
        <description><![CDATA[LDAP object]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="42" type="Include Once" package="main">
      <name>../../lib/config.inc</name>
      <docblock line="41">
        <description><![CDATA[LAM configuration]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="44" type="Include Once" package="main">
      <name>../../lib/modules.inc</name>
      <docblock line="43">
        <description><![CDATA[module functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="46" type="Include Once" package="main">
      <name>../../lib/xml_parser.inc</name>
      <docblock line="45">
        <description><![CDATA[XML functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="392" type="Include" package="main">
      <name>../main_header.php</name>
    </include>
    <include line="616" type="Include" package="main">
      <name>../main_footer.php</name>
    </include>
    <function namespace="global" line="625" package="PDF">
      <name>translateFieldIDToName</name>
      <full_name>\translateFieldIDToName</full_name>
      <docblock line="619">
        <description><![CDATA[Translates a given field ID (e.g.]]></description>
        <long-description><![CDATA[<p>inetOrgPerson_givenName) to its descriptive name.</p>]]></long-description>
        <tag line="619" name="param" description="field ID" type="String" variable="$id">
          <type by_reference="false">String</type>
        </tag>
        <tag line="619" name="param" description="account type" type="String" variable="$scope">
          <type by_reference="false">String</type>
        </tag>
      </docblock>
      <argument line="625">
        <name>$id</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="625">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
  </file>
  <file path="templates/pdfedit/pdfmain.php" hash="1166ac7a10fbb27cbc6df1ce7abed118" package="PDF">
    <docblock line="25">
      <description><![CDATA[This is the main window of the pdf structure editor.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="25" name="author" description="Michael Duergner"/>
      <tag line="25" name="author" description="Roland Gruber"/>
      <tag line="25" name="package" description="PDF"/>
    </docblock>
    <include line="34" type="Include Once" package="main">
      <name>../../lib/security.inc</name>
      <docblock line="33">
        <description><![CDATA[security functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="36" type="Include Once" package="main">
      <name>../../lib/pdfstruct.inc</name>
      <docblock line="35">
        <description><![CDATA[access to PDF configuration files]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="38" type="Include Once" package="main">
      <name>../../lib/ldap.inc</name>
      <docblock line="37">
        <description><![CDATA[LDAP object]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="40" type="Include Once" package="main">
      <name>../../lib/config.inc</name>
      <docblock line="39">
        <description><![CDATA[for language settings]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="42" type="Include Once" package="main">
      <name>../../lib/modules.inc</name>
      <docblock line="41">
        <description><![CDATA[module functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="149" type="Include" package="main">
      <name>../main_header.php</name>
    </include>
    <include line="321" type="Include" package="main">
      <name>../main_footer.php</name>
    </include>
  </file>
  <file path="templates/delete.php" hash="11678cacdadf2e5a1031a7cf3e502c9e" package="main">
    <docblock line="25">
      <description><![CDATA[Used to delete accounts from LDAP tree.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="25" name="author" description="Tilo Lutz"/>
      <tag line="25" name="author" description="Roland Gruber"/>
      <tag line="25" name="package" description="main"/>
    </docblock>
    <include line="35" type="Include Once" package="main">
      <name>../lib/security.inc</name>
      <docblock line="34">
        <description><![CDATA[security functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="37" type="Include Once" package="main">
      <name>../lib/account.inc</name>
      <docblock line="36">
        <description><![CDATA[account functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="39" type="Include Once" package="main">
      <name>../lib/config.inc</name>
      <docblock line="38">
        <description><![CDATA[current configuration options]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="41" type="Include Once" package="main">
      <name>../lib/status.inc</name>
      <docblock line="40">
        <description><![CDATA[message displaying]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="43" type="Include Once" package="main">
      <name>../lib/ldap.inc</name>
      <docblock line="42">
        <description><![CDATA[LDAP connection]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="45" type="Include Once" package="main">
      <name>../lib/lamdaemon.inc</name>
      <docblock line="44">
        <description><![CDATA[lamdaemon interface]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="47" type="Include Once" package="main">
      <name>../lib/modules.inc</name>
      <docblock line="46">
        <description><![CDATA[module interface]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="89" type="Include" package="main">
      <name>main_header.php</name>
    </include>
    <include line="132" type="Include" package="main">
      <name>main_footer.php</name>
    </include>
    <include line="150" type="Include" package="main">
      <name>main_header.php</name>
    </include>
    <include line="306" type="Include" package="main">
      <name>main_footer.php</name>
    </include>
    <function namespace="global" line="316" package="main">
      <name>getChildCount</name>
      <full_name>\getChildCount</full_name>
      <docblock line="310">
        <description><![CDATA[Returns the number of child entries of a DN.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="310" name="param" description="DN of parent" type="string" variable="$dn">
          <type by_reference="false">string</type>
        </tag>
        <tag line="310" name="return" description="number of childs" type="\interger">
          <type by_reference="false">\interger</type>
        </tag>
      </docblock>
      <argument line="316">
        <name>$dn</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="327" package="main">
      <name>deleteDN</name>
      <full_name>\deleteDN</full_name>
      <docblock line="321">
        <description><![CDATA[Deletes a DN and all child entries.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="321" name="param" description="DN to delete" type="string" variable="$dn">
          <type by_reference="false">string</type>
        </tag>
        <tag line="321" name="return" description="error messages" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="327">
        <name>$dn</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
  </file>
  <file path="templates/profedit/profilepage.php" hash="8def063a0dddc5cda45e984c8c46b468" package="profiles">
    <docblock line="24">
      <description><![CDATA[Manages creating/changing of profiles.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="package" description="profiles"/>
      <tag line="24" name="author" description="Roland Gruber"/>
    </docblock>
    <include line="32" type="Include Once" package="main">
      <name>../../lib/security.inc</name>
      <docblock line="31">
        <description><![CDATA[security functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="34" type="Include Once" package="main">
      <name>../../lib/profiles.inc</name>
      <docblock line="33">
        <description><![CDATA[helper functions for profiles]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="36" type="Include Once" package="main">
      <name>../../lib/ldap.inc</name>
      <docblock line="35">
        <description><![CDATA[access to LDAP server]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="38" type="Include Once" package="main">
      <name>../../lib/config.inc</name>
      <docblock line="37">
        <description><![CDATA[access to configuration options]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="40" type="Include Once" package="main">
      <name>../../lib/modules.inc</name>
      <docblock line="39">
        <description><![CDATA[access to account modules]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="42" type="Include Once" package="main">
      <name>../../lib/status.inc</name>
      <docblock line="41">
        <description><![CDATA[Used to display status messages]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="130" type="Include" package="main">
      <name>../main_header.php</name>
    </include>
    <include line="264" type="Include" package="main">
      <name>../main_footer.php</name>
    </include>
  </file>
  <file path="templates/profedit/profilemain.php" hash="bfde2f889abd853c5fa177c1b592c1e2" package="profiles">
    <docblock line="24">
      <description><![CDATA[This is the main window of the profile editor.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="package" description="profiles"/>
      <tag line="24" name="author" description="Roland Gruber"/>
    </docblock>
    <include line="32" type="Include Once" package="main">
      <name>../../lib/security.inc</name>
      <docblock line="31">
        <description><![CDATA[security functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="34" type="Include Once" package="main">
      <name>../../lib/profiles.inc</name>
      <docblock line="33">
        <description><![CDATA[helper functions for profiles]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="36" type="Include Once" package="main">
      <name>../../lib/ldap.inc</name>
      <docblock line="35">
        <description><![CDATA[access to LDAP server]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="38" type="Include Once" package="main">
      <name>../../lib/config.inc</name>
      <docblock line="37">
        <description><![CDATA[access to configuration options]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="89" type="Include" package="main">
      <name>../main_header.php</name>
    </include>
    <include line="325" type="Include" package="main">
      <name>../main_footer.php</name>
    </include>
  </file>
  <file path="templates/3rdParty/pla/lib/QueryRender.php" hash="a915a4f3a7882919375804b25cf45c0b" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="14" package="phpLDAPadmin\Templates">
      <extends>\PageRender</extends>
      <name>QueryRender</name>
      <full_name>\QueryRender</full_name>
      <docblock line="7">
        <description><![CDATA[QueryRender class]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="7" name="package" description="phpLDAPadmin"/>
        <tag line="7" name="subpackage" description="Templates"/>
        <tag line="7" name="todo" description="need to add paging"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="20" package="phpLDAPadmin\Templates">
        <name>accept</name>
        <full_name>accept</full_name>
        <docblock line="17">
          <description><![CDATA[Intialise and Render the QueryRender]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="48" package="phpLDAPadmin\Templates">
        <name>getTemplates</name>
        <full_name>getTemplates</full_name>
        <docblock line="45">
          <description><![CDATA[Get our templates applicable for this object]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="58" package="phpLDAPadmin\Templates">
        <name>haveDefaultTemplate</name>
        <full_name>haveDefaultTemplate</full_name>
        <docblock line="55">
          <description><![CDATA[Are default queries enabled?]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="70" package="phpLDAPadmin\Templates">
        <name>drawTemplateChoice</name>
        <full_name>drawTemplateChoice</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="186" package="phpLDAPadmin\Templates">
        <name>visitStart</name>
        <full_name>visitStart</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="195" package="phpLDAPadmin\Templates">
        <name>visitEnd</name>
        <full_name>visitEnd</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="411" package="phpLDAPadmin\Templates">
        <name>drawSubTitle</name>
        <full_name>drawSubTitle</full_name>
        <argument line="411">
          <name>$subtitle</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="415" package="phpLDAPadmin\Templates">
        <name>getAFattrs</name>
        <full_name>getAFattrs</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="428" package="phpLDAPadmin\Templates">
        <name>getAjaxRef</name>
        <full_name>getAjaxRef</full_name>
        <argument line="428">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="435" package="phpLDAPadmin\Templates">
        <name>drawBaseTabs</name>
        <full_name>drawBaseTabs</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="465" package="phpLDAPadmin\Templates">
        <name>drawResultsTable</name>
        <full_name>drawResultsTable</full_name>
        <argument line="465">
          <name>$base</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="465">
          <name>$results</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <parse_markers>
      <critical line="2" code="50008">No short description for file templates/3rdParty/pla/lib/QueryRender.php</critical>
      <error line="70" code="50010">No DocBlock was found for method drawTemplateChoice()</error>
      <error line="186" code="50010">No DocBlock was found for method visitStart()</error>
      <error line="195" code="50010">No DocBlock was found for method visitEnd()</error>
      <error line="411" code="50010">No DocBlock was found for method drawSubTitle()</error>
      <error line="415" code="50010">No DocBlock was found for method getAFattrs()</error>
      <error line="428" code="50010">No DocBlock was found for method getAjaxRef()</error>
      <error line="435" code="50010">No DocBlock was found for method drawBaseTabs()</error>
      <error line="465" code="50010">No DocBlock was found for method drawResultsTable()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/lib/schema_functions.php" hash="c7f0689fae16ea720416d037956671cb" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Classes and functions for fetching and parsing schema from an LDAP server.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="19" package="phpLDAPadmin\Schema">
      <extends/>
      <name>SchemaItem</name>
      <full_name>\SchemaItem</full_name>
      <docblock line="9">
        <description><![CDATA[Generic parent class for all schema items.]]></description>
        <long-description><![CDATA[<p>A schema item is
an ObjectClass, an AttributeBype, a MatchingRule, or a Syntax.
All schema items have at least two things in common: An OID
and a description. This class provides an implementation for
these two data.</p>]]></long-description>
        <tag line="9" name="package" description="phpLDAPadmin"/>
        <tag line="9" name="subpackage" description="Schema"/>
      </docblock>
      <property final="false" static="false" visibility="protected" line="21" namespace="global" package="main">
        <name>$name</name>
        <default><![CDATA[null]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="23" namespace="global" package="main">
        <name>$oid</name>
        <default><![CDATA[null]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="25" namespace="global" package="main">
        <name>$description</name>
        <default><![CDATA[null]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="27" namespace="global" package="main">
        <name>$is_obsolete</name>
        <default><![CDATA[false]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="29" package="phpLDAPadmin\Schema">
        <name>setOID</name>
        <full_name>setOID</full_name>
        <argument line="29">
          <name>$oid</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="36" package="phpLDAPadmin\Schema">
        <name>setDescription</name>
        <full_name>setDescription</full_name>
        <argument line="36">
          <name>$desc</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="43" package="phpLDAPadmin\Schema">
        <name>getOID</name>
        <full_name>getOID</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="50" package="phpLDAPadmin\Schema">
        <name>getDescription</name>
        <full_name>getDescription</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="60" package="phpLDAPadmin\Schema">
        <name>getIsObsolete</name>
        <full_name>getIsObsolete</full_name>
        <docblock line="57">
          <description><![CDATA[Gets whether this objectClass is flagged as obsolete by the LDAP server.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="73" package="phpLDAPadmin\Schema">
        <name>getName</name>
        <full_name>getName</full_name>
        <docblock line="67">
          <description><![CDATA[Return the objects name.]]></description>
          <long-description><![CDATA[<p>param boolean $lower Return the name in lower case (default)</p>]]></long-description>
          <tag line="67" name="return" description="The name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="73">
          <name>$lower</name>
          <default><![CDATA[true]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="87" package="phpLDAPadmin\Schema">
      <extends>\SchemaItem</extends>
      <name>ObjectClass</name>
      <full_name>\ObjectClass</full_name>
      <docblock line="81">
        <description><![CDATA[Represents an LDAP objectClass]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="81" name="package" description="phpLDAPadmin"/>
        <tag line="81" name="subpackage" description="Schema"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="89" namespace="global" package="main">
        <name>$server_id</name>
        <default><![CDATA[null]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="91" namespace="global" package="main">
        <name>$sup_classes</name>
        <default><![CDATA[array()]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="93" namespace="global" package="main">
        <name>$type</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="95" namespace="global" package="main">
        <name>$must_attrs</name>
        <default><![CDATA[array()]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="97" namespace="global" package="main">
        <name>$may_attrs</name>
        <default><![CDATA[array()]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="99" namespace="global" package="main">
        <name>$force_may</name>
        <default><![CDATA[array()]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="101" namespace="global" package="main">
        <name>$children_objectclasses</name>
        <default><![CDATA[array()]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="103" namespace="global" package="main">
        <name>$hierarchy</name>
        <default><![CDATA[array()]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="108" package="phpLDAPadmin\Schema">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="105">
          <description><![CDATA[Creates a new ObjectClass object given a raw LDAP objectClass string.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="108">
          <name>$class</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="108">
          <name>$server</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="281" package="phpLDAPadmin\Schema">
        <name>parseList</name>
        <full_name>parseList</full_name>
        <docblock line="278">
          <description><![CDATA[Parse an LDAP schema list]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="281">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="281">
          <name>$strings</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="281">
          <name>$attrs</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="345" package="phpLDAPadmin\Schema">
        <name>getParents</name>
        <full_name>getParents</full_name>
        <docblock line="342">
          <description><![CDATA[This will return all our parent ObjectClass Objects]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="381" package="phpLDAPadmin\Schema">
        <name>getMustAttrs</name>
        <full_name>getMustAttrs</full_name>
        <docblock line="367">
          <description><![CDATA[Gets an array of AttributeType objects that entries of this ObjectClass must define.]]></description>
          <long-description><![CDATA[<p>This differs from getMustAttrNames in that it returns an array of AttributeType objects</p>]]></long-description>
          <tag line="367" name="param" description="An array of ObjectClass objects to use when traversing the inheritance tree. This presents some what of a bootstrapping problem as we must fetch all objectClasses to determine through inheritance which attributes this objectClass requires." type="array" variable="$parents">
            <type by_reference="false">array</type>
          </tag>
          <tag line="367" name="return" description="The array of required AttributeType objects." type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="367" name="see" description="\global\getMustAttrNames" refers="\global\getMustAttrNames"/>
          <tag line="367" name="see" description="\global\getMayAttrs" refers="\global\getMayAttrs"/>
          <tag line="367" name="see" description="\global\getMayAttrNames" refers="\global\getMayAttrNames"/>
        </docblock>
        <argument line="381">
          <name>$parents</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="423" package="phpLDAPadmin\Schema">
        <name>getMayAttrs</name>
        <full_name>getMayAttrs</full_name>
        <docblock line="408">
          <description><![CDATA[Gets an array of AttributeType objects that entries of this ObjectClass may define.]]></description>
          <long-description><![CDATA[<p>This differs from getMayAttrNames in that it returns an array of AttributeType objects</p>]]></long-description>
          <tag line="408" name="param" description="An array of ObjectClass objects to use when traversing the inheritance tree. This presents some what of a bootstrapping problem as we must fetch all objectClasses to determine through inheritance which attributes this objectClass provides." type="array" variable="$parents">
            <type by_reference="false">array</type>
          </tag>
          <tag line="408" name="return" description="The array of allowed AttributeType objects." type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="408" name="see" description="\global\getMustAttrNames" refers="\global\getMustAttrNames"/>
          <tag line="408" name="see" description="\global\getMustAttrs" refers="\global\getMustAttrs"/>
          <tag line="408" name="see" description="\global\getMayAttrNames" refers="\global\getMayAttrNames"/>
          <tag line="408" name="see" description="\global\AttributeType" refers="\global\AttributeType"/>
        </docblock>
        <argument line="423">
          <name>$parents</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="450" package="phpLDAPadmin\Schema">
        <name>getForceMayAttrs</name>
        <full_name>getForceMayAttrs</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="472" package="phpLDAPadmin\Schema">
        <name>getMustAttrNames</name>
        <full_name>getMustAttrNames</full_name>
        <docblock line="457">
          <description><![CDATA[Gets an array of attribute names (strings) that entries of this ObjectClass must define.]]></description>
          <long-description><![CDATA[<p>This differs from getMustAttrs in that it returns an array of strings rather than
array of AttributeType objects</p>]]></long-description>
          <tag line="457" name="param" description="An array of ObjectClass objects to use when traversing the inheritance tree. This presents some what of a bootstrapping problem as we must fetch all objectClasses to determine through inheritance which attributes this objectClass provides." type="array" variable="$parents">
            <type by_reference="false">array</type>
          </tag>
          <tag line="457" name="return" description="The array of allowed attribute names (strings)." type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="457" name="see" description="\global\getMustAttrs" refers="\global\getMustAttrs"/>
          <tag line="457" name="see" description="\global\getMayAttrs" refers="\global\getMayAttrs"/>
          <tag line="457" name="see" description="\global\getMayAttrNames" refers="\global\getMayAttrNames"/>
        </docblock>
        <argument line="472">
          <name>$parents</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="499" package="phpLDAPadmin\Schema">
        <name>getMayAttrNames</name>
        <full_name>getMayAttrNames</full_name>
        <docblock line="484">
          <description><![CDATA[Gets an array of attribute names (strings) that entries of this ObjectClass must define.]]></description>
          <long-description><![CDATA[<p>This differs from getMayAttrs in that it returns an array of strings rather than
array of AttributeType objects</p>]]></long-description>
          <tag line="484" name="param" description="An array of ObjectClass objects to use when traversing the inheritance tree. This presents some what of a bootstrapping problem as we must fetch all objectClasses to determine through inheritance which attributes this objectClass provides." type="array" variable="$parents">
            <type by_reference="false">array</type>
          </tag>
          <tag line="484" name="return" description="The array of allowed attribute names (strings)." type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="484" name="see" description="\global\getMustAttrs" refers="\global\getMustAttrs"/>
          <tag line="484" name="see" description="\global\getMayAttrs" refers="\global\getMayAttrs"/>
          <tag line="484" name="see" description="\global\getMustAttrNames" refers="\global\getMustAttrNames"/>
        </docblock>
        <argument line="499">
          <name>$parents</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="518" package="phpLDAPadmin\Schema">
        <name>addChildObjectClass</name>
        <full_name>addChildObjectClass</full_name>
        <docblock line="511">
          <description><![CDATA[Adds an objectClass to the list of objectClasses that inherit
from this objectClass.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="511" name="param" description="The name of the objectClass to add" type="String" variable="$name">
            <type by_reference="false">String</type>
          </tag>
          <tag line="511" name="return" description="Returns true on success or false on failure (objectclass already existed for example)" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="518">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="536" package="phpLDAPadmin\Schema">
        <name>getChildObjectClasses</name>
        <full_name>getChildObjectClasses</full_name>
        <docblock line="531">
          <description><![CDATA[Returns the array of objectClass names which inherit from this objectClass.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="531" name="return" description="Names of objectClasses which inherit from this objectClass." type="Array">
            <type by_reference="false">Array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="548" package="phpLDAPadmin\Schema">
        <name>getSupClasses</name>
        <full_name>getSupClasses</full_name>
        <docblock line="543">
          <description><![CDATA[Gets the objectClass names from which this objectClass inherits.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="543" name="return" description="An array of objectClass names (strings)" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="560" package="phpLDAPadmin\Schema">
        <name>isRelated</name>
        <full_name>isRelated</full_name>
        <docblock line="555">
          <description><![CDATA[Return if this objectClass is related to $oclass]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="555" name="param" description="ObjectClasses that this attribute may be related to" type="array" variable="$oclass">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="560">
          <name>$oclass</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="583" package="phpLDAPadmin\Schema">
        <name>getType</name>
        <full_name>getType</full_name>
        <docblock line="580">
          <description><![CDATA[Gets the type of this objectClass: STRUCTURAL, ABSTRACT, or AUXILIARY.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="597" package="phpLDAPadmin\Schema">
        <name>addMustAttrs</name>
        <full_name>addMustAttrs</full_name>
        <docblock line="590">
          <description><![CDATA[Adds the specified array of attributes to this objectClass' list of
MUST attributes.]]></description>
          <long-description><![CDATA[<p>The resulting array of must attributes will contain
unique members.</p>]]></long-description>
          <tag line="590" name="param" description="An array of attribute names (strings) to add." type="array" variable="$attr">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="597">
          <name>$attr</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="613" package="phpLDAPadmin\Schema">
        <name>addMayAttrs</name>
        <full_name>addMayAttrs</full_name>
        <docblock line="607">
          <description><![CDATA[Behaves identically to addMustAttrs, but it operates on the MAY
attributes of this objectClass.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="607" name="param" description="An array of attribute names (strings) to add." type="array" variable="$attr">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="613">
          <name>$attr</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="626" package="phpLDAPadmin\Schema">
        <name>isForceMay</name>
        <full_name>isForceMay</full_name>
        <docblock line="623">
          <description><![CDATA[Determine if an array is listed in the force_may attrs]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="626">
          <name>$attr</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="637" package="phpLDAPadmin\Schema">
        <name>isStructural</name>
        <full_name>isStructural</full_name>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="661" package="phpLDAPadmin\Schema">
      <extends/>
      <name>ObjectClass_ObjectClassAttribute</name>
      <full_name>\ObjectClass_ObjectClassAttribute</full_name>
      <docblock line="648">
        <description><![CDATA[A simple class for representing AttributeTypes used only by the ObjectClass class.]]></description>
        <long-description><![CDATA[<p>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.</p>]]></long-description>
        <tag line="648" name="package" description="phpLDAPadmin"/>
        <tag line="648" name="subpackage" description="Schema"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="663" namespace="global" package="main">
        <name>$name</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="665" namespace="global" package="main">
        <name>$source</name>
        <default><![CDATA[]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="673" package="phpLDAPadmin\Schema">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="667">
          <description><![CDATA[Creates a new ObjectClass_ObjectClassAttribute with specified name and source objectClass.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="667" name="param" description="the name of the new attribute." type="string" variable="$name">
            <type by_reference="false">string</type>
          </tag>
          <tag line="667" name="param" description="the name of the ObjectClass which specifies this attribute." type="string" variable="$source">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="673">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="673">
          <name>$source</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="682" package="phpLDAPadmin\Schema">
        <name>getName</name>
        <full_name>getName</full_name>
        <argument line="682">
          <name>$lower</name>
          <default><![CDATA[true]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="690" package="phpLDAPadmin\Schema">
        <name>getSource</name>
        <full_name>getSource</full_name>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="704" package="phpLDAPadmin\Schema">
      <extends>\SchemaItem</extends>
      <name>AttributeType</name>
      <full_name>\AttributeType</full_name>
      <docblock line="698">
        <description><![CDATA[Represents an LDAP AttributeType]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="698" name="package" description="phpLDAPadmin"/>
        <tag line="698" name="subpackage" description="Schema"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="706" namespace="global" package="main">
        <name>$sup_attribute</name>
        <default><![CDATA[null]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="708" namespace="global" package="main">
        <name>$equality</name>
        <default><![CDATA[null]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="710" namespace="global" package="main">
        <name>$ordering</name>
        <default><![CDATA[null]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="712" namespace="global" package="main">
        <name>$sub_str</name>
        <default><![CDATA[null]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="714" namespace="global" package="main">
        <name>$syntax</name>
        <default><![CDATA[null]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="715" namespace="global" package="main">
        <name>$syntax_oid</name>
        <default><![CDATA[null]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="717" namespace="global" package="main">
        <name>$is_single_value</name>
        <default><![CDATA[false]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="719" namespace="global" package="main">
        <name>$is_collective</name>
        <default><![CDATA[false]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="721" namespace="global" package="main">
        <name>$is_no_user_modification</name>
        <default><![CDATA[false]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="723" namespace="global" package="main">
        <name>$usage</name>
        <default><![CDATA[null]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="725" namespace="global" package="main">
        <name>$aliases</name>
        <default><![CDATA[array()]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="727" namespace="global" package="main">
        <name>$max_length</name>
        <default><![CDATA[null]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="729" namespace="global" package="main">
        <name>$type</name>
        <default><![CDATA[null]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="731" namespace="global" package="main">
        <name>$used_in_object_classes</name>
        <default><![CDATA[array()]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="733" namespace="global" package="main">
        <name>$required_by_object_classes</name>
        <default><![CDATA[array()]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="735" namespace="global" package="main">
        <name>$forced_as_may</name>
        <default><![CDATA[false]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="740" package="phpLDAPadmin\Schema">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="737">
          <description><![CDATA[Creates a new AttributeType object from a raw LDAP AttributeType string.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="740">
          <name>$attr</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="929" package="phpLDAPadmin\Schema">
        <name>getUsage</name>
        <full_name>getUsage</full_name>
        <docblock line="924">
          <description><![CDATA[Gets this attribute's usage string as defined by the LDAP server]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="924" name="return" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="942" package="phpLDAPadmin\Schema">
        <name>getSupAttribute</name>
        <full_name>getSupAttribute</full_name>
        <docblock line="936">
          <description><![CDATA[Gets this attribute's parent attribute (if any).]]></description>
          <long-description><![CDATA[<p>If this attribute does not
inherit from another attribute, null is returned.</p>]]></long-description>
          <tag line="936" name="return" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="954" package="phpLDAPadmin\Schema">
        <name>getEquality</name>
        <full_name>getEquality</full_name>
        <docblock line="949">
          <description><![CDATA[Gets this attribute's equality string]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="949" name="return" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="966" package="phpLDAPadmin\Schema">
        <name>getOrdering</name>
        <full_name>getOrdering</full_name>
        <docblock line="961">
          <description><![CDATA[Gets this attribute's ordering specification.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="961" name="return" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="978" package="phpLDAPadmin\Schema">
        <name>getSubstr</name>
        <full_name>getSubstr</full_name>
        <docblock line="973">
          <description><![CDATA[Gets this attribute's substring matching specification]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="973" name="return" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="991" package="phpLDAPadmin\Schema">
        <name>getAliases</name>
        <full_name>getAliases</full_name>
        <docblock line="985">
          <description><![CDATA[Gets the names of attributes that are an alias for this attribute (if any).]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="985" name="return" description="An array of names of attributes which alias this attribute or an empty array if no attribute aliases this object." type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1004" package="phpLDAPadmin\Schema">
        <name>isAliasFor</name>
        <full_name>isAliasFor</full_name>
        <docblock line="998">
          <description><![CDATA[Returns whether the specified attribute is an alias for this one (based on this attribute's alias list).]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="998" name="param" description="The name of the attribute to check." type="string" variable="$attr_name">
            <type by_reference="false">string</type>
          </tag>
          <tag line="998" name="return" description="True if the specified attribute is an alias for this one, or false otherwise." type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1004">
          <name>$attr_name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1020" package="phpLDAPadmin\Schema">
        <name>getSyntaxString</name>
        <full_name>getSyntaxString</full_name>
        <docblock line="1015">
          <description><![CDATA[Gets this attribute's raw syntax string (ie: "1.2.3.4{16}").]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1015" name="return" description="The raw syntax string" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1035" package="phpLDAPadmin\Schema">
        <name>getSyntaxOID</name>
        <full_name>getSyntaxOID</full_name>
        <docblock line="1027">
          <description><![CDATA[Gets this attribute's syntax OID.]]></description>
          <long-description><![CDATA[<p>Differs from getSyntaxString() in that this
function only returns the actual OID with any length specification removed.
Ie, if the syntax string is "1.2.3.4{16}", this function only retruns
"1.2.3.4".</p>]]></long-description>
          <tag line="1027" name="return" description="The syntax OID string." type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1047" package="phpLDAPadmin\Schema">
        <name>getMaxLength</name>
        <full_name>getMaxLength</full_name>
        <docblock line="1042">
          <description><![CDATA[Gets this attribute's the maximum length.]]></description>
          <long-description><![CDATA[<p>If no maximum is defined by the LDAP server, null is returned.</p>]]></long-description>
          <tag line="1042" name="return" description="The maximum length (in characters) of this attribute or null if no maximum is specified." type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1060" package="phpLDAPadmin\Schema">
        <name>getIsSingleValue</name>
        <full_name>getIsSingleValue</full_name>
        <docblock line="1054">
          <description><![CDATA[Gets whether this attribute is single-valued.]]></description>
          <long-description><![CDATA[<p>If this attribute only supports single values, true
is returned. If this attribute supports multiple values, false is returned.</p>]]></long-description>
          <tag line="1054" name="return" description="Returns true if this attribute is single-valued or false otherwise." type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1072" package="phpLDAPadmin\Schema">
        <name>setIsSingleValue</name>
        <full_name>setIsSingleValue</full_name>
        <docblock line="1067">
          <description><![CDATA[Sets whether this attribute is single-valued.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1067" name="param" description="" type="boolean" variable="$is">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1072">
          <name>$is</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1084" package="phpLDAPadmin\Schema">
        <name>getIsCollective</name>
        <full_name>getIsCollective</full_name>
        <docblock line="1079">
          <description><![CDATA[Gets whether this attribute is collective.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1079" name="return" description="Returns true if this attribute is collective and false otherwise." type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1096" package="phpLDAPadmin\Schema">
        <name>getIsNoUserModification</name>
        <full_name>getIsNoUserModification</full_name>
        <docblock line="1091">
          <description><![CDATA[Gets whether this attribute is not modifiable by users.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1091" name="return" description="Returns true if this attribute is not modifiable by users." type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1108" package="phpLDAPadmin\Schema">
        <name>getType</name>
        <full_name>getType</full_name>
        <docblock line="1103">
          <description><![CDATA[Gets this attribute's type]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1103" name="return" description="The attribute's type." type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1122" package="phpLDAPadmin\Schema">
        <name>removeAlias</name>
        <full_name>removeAlias</full_name>
        <docblock line="1115">
          <description><![CDATA[Removes an attribute name from this attribute's alias array.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1115" name="param" description="The name of the attribute to remove." type="string" variable="$remove_alias_name">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1115" name="return" description="true on success or false on failure (ie, if the specified attribute name is not found in this attribute's list of aliases)" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1122">
          <name>$remove_alias_name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1143" package="phpLDAPadmin\Schema">
        <name>addAlias</name>
        <full_name>addAlias</full_name>
        <docblock line="1138">
          <description><![CDATA[Adds an attribute name to the alias array.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1138" name="param" description="The name of a new attribute to add to this attribute's list of aliases." type="string" variable="$alias">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="1143">
          <name>$alias</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1155" package="phpLDAPadmin\Schema">
        <name>setName</name>
        <full_name>setName</full_name>
        <docblock line="1150">
          <description><![CDATA[Sets this attriute's name.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1150" name="param" description="The new name to give this attribute." type="string" variable="$name">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="1155">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1167" package="phpLDAPadmin\Schema">
        <name>setSupAttribute</name>
        <full_name>setSupAttribute</full_name>
        <docblock line="1162">
          <description><![CDATA[Sets this attriute's SUP attribute (ie, the attribute from which this attribute inherits).]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1162" name="param" description="The name of the new parent (SUP) attribute" type="string" variable="$attr">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="1167">
          <name>$attr</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1179" package="phpLDAPadmin\Schema">
        <name>setAliases</name>
        <full_name>setAliases</full_name>
        <docblock line="1174">
          <description><![CDATA[Sets this attribute's list of aliases.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1174" name="param" description="The array of alias names (strings)" type="array" variable="$aliases">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1179">
          <name>$aliases</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1191" package="phpLDAPadmin\Schema">
        <name>setType</name>
        <full_name>setType</full_name>
        <docblock line="1186">
          <description><![CDATA[Sets this attribute's type.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1186" name="param" description="The new type." type="string" variable="$type">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="1191">
          <name>$type</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1204" package="phpLDAPadmin\Schema">
        <name>addUsedInObjectClass</name>
        <full_name>addUsedInObjectClass</full_name>
        <docblock line="1198">
          <description><![CDATA[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><![CDATA[]]></long-description>
          <tag line="1198" name="param" description="The name of the objectClass to add." type="string" variable="$name">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="1204">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1225" package="phpLDAPadmin\Schema">
        <name>getUsedInObjectClasses</name>
        <full_name>getUsedInObjectClasses</full_name>
        <docblock line="1219">
          <description><![CDATA[Gets the list of "used in" objectClasses, that is the list of objectClasses
which provide this attribute.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1219" name="return" description="An array of names of objectclasses (strings) which provide this attribute" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1238" package="phpLDAPadmin\Schema">
        <name>addRequiredByObjectClass</name>
        <full_name>addRequiredByObjectClass</full_name>
        <docblock line="1232">
          <description><![CDATA[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><![CDATA[]]></long-description>
          <tag line="1232" name="param" description="The name of the objectClass to add." type="string" variable="$name">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="1238">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1255" package="phpLDAPadmin\Schema">
        <name>getRequiredByObjectClasses</name>
        <full_name>getRequiredByObjectClasses</full_name>
        <docblock line="1249">
          <description><![CDATA[Gets the list of "required by" objectClasses, that is the list of objectClasses
which provide must have attribute.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1249" name="return" description="An array of names of objectclasses (strings) which provide this attribute" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1265" package="phpLDAPadmin\Schema">
        <name>setForceMay</name>
        <full_name>setForceMay</full_name>
        <docblock line="1262">
          <description><![CDATA[This function will mark this attribute as a forced MAY attribute]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1272" package="phpLDAPadmin\Schema">
        <name>isForceMay</name>
        <full_name>isForceMay</full_name>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="1286" package="phpLDAPadmin\Schema">
      <extends>\SchemaItem</extends>
      <name>Syntax</name>
      <full_name>\Syntax</full_name>
      <docblock line="1280">
        <description><![CDATA[Represents an LDAP Syntax]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="1280" name="package" description="phpLDAPadmin"/>
        <tag line="1280" name="subpackage" description="Schema"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1290" package="phpLDAPadmin\Schema">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="1287">
          <description><![CDATA[Creates a new Syntax object from a raw LDAP syntax string.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="1290">
          <name>$class</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="1328" package="phpLDAPadmin\Schema">
      <extends>\SchemaItem</extends>
      <name>MatchingRule</name>
      <full_name>\MatchingRule</full_name>
      <docblock line="1322">
        <description><![CDATA[Represents an LDAP MatchingRule]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="1322" name="package" description="phpLDAPadmin"/>
        <tag line="1322" name="subpackage" description="Schema"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="1330" namespace="global" package="main">
        <name>$syntax</name>
        <default><![CDATA[null]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="1332" namespace="global" package="main">
        <name>$used_by_attrs</name>
        <default><![CDATA[array()]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1337" package="phpLDAPadmin\Schema">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="1334">
          <description><![CDATA[Creates a new MatchingRule object from a raw LDAP MatchingRule string.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="1337">
          <name>$strings</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1409" package="phpLDAPadmin\Schema">
        <name>setUsedByAttrs</name>
        <full_name>setUsedByAttrs</full_name>
        <docblock line="1404">
          <description><![CDATA[Sets the list of used_by_attrs to the array specified by $attrs;]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1404" name="param" description="The array of attribute names (strings) which use this MatchingRule" type="array" variable="$attrs">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1409">
          <name>$attrs</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1421" package="phpLDAPadmin\Schema">
        <name>addUsedByAttr</name>
        <full_name>addUsedByAttr</full_name>
        <docblock line="1416">
          <description><![CDATA[Adds an attribute name to the list of attributes who use this MatchingRule]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1416" name="return" description="if the attribute was added and false otherwise (already in the list)" type="true">
            <type by_reference="false">true</type>
          </tag>
        </docblock>
        <argument line="1421">
          <name>$attr</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1439" package="phpLDAPadmin\Schema">
        <name>getUsedByAttrs</name>
        <full_name>getUsedByAttrs</full_name>
        <docblock line="1434">
          <description><![CDATA[Gets an array of attribute names (strings) which use this MatchingRule]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1434" name="return" description="The array of attribute names (strings)." type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="1453" package="phpLDAPadmin\Schema">
      <extends>\SchemaItem</extends>
      <name>MatchingRuleUse</name>
      <full_name>\MatchingRuleUse</full_name>
      <docblock line="1447">
        <description><![CDATA[Represents an LDAP schema matchingRuleUse entry]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="1447" name="package" description="phpLDAPadmin"/>
        <tag line="1447" name="subpackage" description="Schema"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="1455" namespace="global" package="main">
        <name>$used_by_attrs</name>
        <default><![CDATA[array()]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1457" package="phpLDAPadmin\Schema">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <argument line="1457">
          <name>$strings</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1532" package="phpLDAPadmin\Schema">
        <name>getUsedByAttrs</name>
        <full_name>getUsedByAttrs</full_name>
        <docblock line="1527">
          <description><![CDATA[Gets an array of attribute names (strings) which use this MatchingRuleUse object.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1527" name="return" description="The array of attribute names (strings)." type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
    </class>
    <parse_markers>
      <error line="21" code="50018">No DocBlock was found for property $name</error>
      <error line="23" code="50018">No DocBlock was found for property $oid</error>
      <error line="25" code="50018">No DocBlock was found for property $description</error>
      <error line="27" code="50018">No DocBlock was found for property $is_obsolete</error>
      <error line="29" code="50010">No DocBlock was found for method setOID()</error>
      <error line="36" code="50010">No DocBlock was found for method setDescription()</error>
      <error line="43" code="50010">No DocBlock was found for method getOID()</error>
      <error line="50" code="50010">No DocBlock was found for method getDescription()</error>
      <error line="67" code="50015">Argument $lower is missing from the Docblock of getName()</error>
      <error line="89" code="50018">No DocBlock was found for property $server_id</error>
      <error line="91" code="50018">No DocBlock was found for property $sup_classes</error>
      <error line="93" code="50018">No DocBlock was found for property $type</error>
      <error line="95" code="50018">No DocBlock was found for property $must_attrs</error>
      <error line="97" code="50018">No DocBlock was found for property $may_attrs</error>
      <error line="99" code="50018">No DocBlock was found for property $force_may</error>
      <error line="101" code="50018">No DocBlock was found for property $children_objectclasses</error>
      <error line="103" code="50018">No DocBlock was found for property $hierarchy</error>
      <error line="105" code="50015">Argument $class is missing from the Docblock of __construct()</error>
      <error line="105" code="50015">Argument $server is missing from the Docblock of __construct()</error>
      <error line="278" code="50015">Argument $i is missing from the Docblock of parseList()</error>
      <error line="278" code="50015">Argument $strings is missing from the Docblock of parseList()</error>
      <error line="278" code="50015">Argument $attrs is missing from the Docblock of parseList()</error>
      <error line="450" code="50010">No DocBlock was found for method getForceMayAttrs()</error>
      <error line="623" code="50015">Argument $attr is missing from the Docblock of isForceMay()</error>
      <error line="637" code="50010">No DocBlock was found for method isStructural()</error>
      <error line="663" code="50018">No DocBlock was found for property $name</error>
      <error line="665" code="50018">No DocBlock was found for property $source</error>
      <error line="682" code="50010">No DocBlock was found for method getName()</error>
      <error line="690" code="50010">No DocBlock was found for method getSource()</error>
      <error line="706" code="50018">No DocBlock was found for property $sup_attribute</error>
      <error line="708" code="50018">No DocBlock was found for property $equality</error>
      <error line="710" code="50018">No DocBlock was found for property $ordering</error>
      <error line="712" code="50018">No DocBlock was found for property $sub_str</error>
      <error line="714" code="50018">No DocBlock was found for property $syntax</error>
      <error line="715" code="50018">No DocBlock was found for property $syntax_oid</error>
      <error line="717" code="50018">No DocBlock was found for property $is_single_value</error>
      <error line="719" code="50018">No DocBlock was found for property $is_collective</error>
      <error line="721" code="50018">No DocBlock was found for property $is_no_user_modification</error>
      <error line="723" code="50018">No DocBlock was found for property $usage</error>
      <error line="725" code="50018">No DocBlock was found for property $aliases</error>
      <error line="727" code="50018">No DocBlock was found for property $max_length</error>
      <error line="729" code="50018">No DocBlock was found for property $type</error>
      <error line="731" code="50018">No DocBlock was found for property $used_in_object_classes</error>
      <error line="733" code="50018">No DocBlock was found for property $required_by_object_classes</error>
      <error line="735" code="50018">No DocBlock was found for property $forced_as_may</error>
      <error line="737" code="50015">Argument $attr is missing from the Docblock of __construct()</error>
      <error line="1272" code="50010">No DocBlock was found for method isForceMay()</error>
      <error line="1287" code="50015">Argument $class is missing from the Docblock of __construct()</error>
      <error line="1330" code="50018">No DocBlock was found for property $syntax</error>
      <error line="1332" code="50018">No DocBlock was found for property $used_by_attrs</error>
      <error line="1334" code="50015">Argument $strings is missing from the Docblock of __construct()</error>
      <error line="1416" code="50015">Argument $attr is missing from the Docblock of addUsedByAttr()</error>
      <error line="1455" code="50018">No DocBlock was found for property $used_by_attrs</error>
      <error line="1457" code="50010">No DocBlock was found for method __construct()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/lib/AttributeFactory.php" hash="162422f3ced3b75e79222fd08283fd5b" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Allows to create new attributes]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="15" package="phpLDAPadmin\Templates">
      <extends/>
      <name>AttributeFactory</name>
      <full_name>\AttributeFactory</full_name>
      <docblock line="9">
        <description><![CDATA[AttributeFactory Class]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="9" name="package" description="phpLDAPadmin"/>
        <tag line="9" name="subpackage" description="Templates"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="16" package="phpLDAPadmin\Templates">
        <name>newAttribute</name>
        <full_name>newAttribute</full_name>
        <argument line="16">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="16">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="16">
          <name>$server_id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="16">
          <name>$source</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="140" package="phpLDAPadmin\Templates">
        <name>newJpegAttribute</name>
        <full_name>newJpegAttribute</full_name>
        <argument line="140">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="140">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="140">
          <name>$server_id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="140">
          <name>$source</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="144" package="phpLDAPadmin\Templates">
        <name>newBinaryAttribute</name>
        <full_name>newBinaryAttribute</full_name>
        <argument line="144">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="144">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="144">
          <name>$server_id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="144">
          <name>$source</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="148" package="phpLDAPadmin\Templates">
        <name>newPasswordAttribute</name>
        <full_name>newPasswordAttribute</full_name>
        <argument line="148">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="148">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="148">
          <name>$server_id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="148">
          <name>$source</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="152" package="phpLDAPadmin\Templates">
        <name>newSambaPasswordAttribute</name>
        <full_name>newSambaPasswordAttribute</full_name>
        <argument line="152">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="152">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="152">
          <name>$server_id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="152">
          <name>$source</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="156" package="phpLDAPadmin\Templates">
        <name>newRandomPasswordAttribute</name>
        <full_name>newRandomPasswordAttribute</full_name>
        <argument line="156">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="156">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="156">
          <name>$server_id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="156">
          <name>$source</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="160" package="phpLDAPadmin\Templates">
        <name>newShadowAttribute</name>
        <full_name>newShadowAttribute</full_name>
        <argument line="160">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="160">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="160">
          <name>$server_id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="160">
          <name>$source</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="164" package="phpLDAPadmin\Templates">
        <name>newSelectionAttribute</name>
        <full_name>newSelectionAttribute</full_name>
        <argument line="164">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="164">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="164">
          <name>$server_id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="164">
          <name>$source</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="168" package="phpLDAPadmin\Templates">
        <name>newMultiLineAttribute</name>
        <full_name>newMultiLineAttribute</full_name>
        <argument line="168">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="168">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="168">
          <name>$server_id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="168">
          <name>$source</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="172" package="phpLDAPadmin\Templates">
        <name>newDateAttribute</name>
        <full_name>newDateAttribute</full_name>
        <argument line="172">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="172">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="172">
          <name>$server_id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="172">
          <name>$source</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="176" package="phpLDAPadmin\Templates">
        <name>newObjectClassAttribute</name>
        <full_name>newObjectClassAttribute</full_name>
        <argument line="176">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="176">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="176">
          <name>$server_id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="176">
          <name>$source</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="180" package="phpLDAPadmin\Templates">
        <name>newDnAttribute</name>
        <full_name>newDnAttribute</full_name>
        <argument line="180">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="180">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="180">
          <name>$server_id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="180">
          <name>$source</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="184" package="phpLDAPadmin\Templates">
        <name>newGidAttribute</name>
        <full_name>newGidAttribute</full_name>
        <argument line="184">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="184">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="184">
          <name>$server_id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="184">
          <name>$source</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <parse_markers>
      <error line="16" code="50010">No DocBlock was found for method newAttribute()</error>
      <error line="140" code="50010">No DocBlock was found for method newJpegAttribute()</error>
      <error line="144" code="50010">No DocBlock was found for method newBinaryAttribute()</error>
      <error line="148" code="50010">No DocBlock was found for method newPasswordAttribute()</error>
      <error line="152" code="50010">No DocBlock was found for method newSambaPasswordAttribute()</error>
      <error line="156" code="50010">No DocBlock was found for method newRandomPasswordAttribute()</error>
      <error line="160" code="50010">No DocBlock was found for method newShadowAttribute()</error>
      <error line="164" code="50010">No DocBlock was found for method newSelectionAttribute()</error>
      <error line="168" code="50010">No DocBlock was found for method newMultiLineAttribute()</error>
      <error line="172" code="50010">No DocBlock was found for method newDateAttribute()</error>
      <error line="176" code="50010">No DocBlock was found for method newObjectClassAttribute()</error>
      <error line="180" code="50010">No DocBlock was found for method newDnAttribute()</error>
      <error line="184" code="50010">No DocBlock was found for method newGidAttribute()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/lib/Visitor.php" hash="7bd83a1767035e2100fba12533584932" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Classes and functions for the template engines.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <constant namespace="global" line="11" package="phpLDAPadmin">
      <name>DEBUGTMP</name>
      <full_name>\DEBUGTMP</full_name>
      <value><![CDATA[0]]></value>
    </constant>
    <constant namespace="global" line="12" package="phpLDAPadmin">
      <name>DEBUGTMPSUB</name>
      <full_name>\DEBUGTMPSUB</full_name>
      <value><![CDATA[0]]></value>
    </constant>
    <class final="false" abstract="false" namespace="global" line="20" package="phpLDAPadmin\Templates">
      <extends/>
      <name>Visitor</name>
      <full_name>\Visitor</full_name>
      <docblock line="14">
        <description><![CDATA[Abstract Visitor class]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="14" name="package" description="phpLDAPadmin"/>
        <tag line="14" name="subpackage" description="Templates"/>
      </docblock>
      <property final="false" static="false" visibility="protected" line="22" namespace="global" package="main">
        <name>$server_id</name>
        <default><![CDATA[]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="24" package="phpLDAPadmin\Templates">
        <name>__call</name>
        <full_name>__call</full_name>
        <argument line="24">
          <name>$method</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="24">
          <name>$args</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="77" package="phpLDAPadmin\Templates">
        <name>getServerID</name>
        <full_name>getServerID</full_name>
        <docblock line="72">
          <description><![CDATA[Return the LDAP server ID]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="72" name="return" description="Server ID" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="92" package="phpLDAPadmin\Templates">
        <name>getServer</name>
        <full_name>getServer</full_name>
        <docblock line="87">
          <description><![CDATA[Return this LDAP Server object]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="87" name="return" description="DataStore Server" type="object">
            <type by_reference="false">object</type>
          </tag>
        </docblock>
      </method>
    </class>
    <parse_markers>
      <error line="22" code="50018">No DocBlock was found for property $server_id</error>
      <error line="24" code="50010">No DocBlock was found for method __call()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/lib/PasswordAttribute.php" hash="be1c3029de777796b93beec93417d30d" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Classes and functions for the template engine.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="15" package="phpLDAPadmin\Templates">
      <extends>\Attribute</extends>
      <name>PasswordAttribute</name>
      <full_name>\PasswordAttribute</full_name>
      <docblock line="9">
        <description><![CDATA[Represents an attribute whose values are passwords]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="9" name="package" description="phpLDAPadmin"/>
        <tag line="9" name="subpackage" description="Templates"/>
      </docblock>
    </class>
  </file>
  <file path="templates/3rdParty/pla/lib/xml2array.php" hash="531f5794f35c89be942c71479e925bd6" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Classes and functions for manipulating XML templates.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="17" package="phpLDAPadmin\XML">
      <extends/>
      <name>xml2array</name>
      <full_name>\xml2array</full_name>
      <docblock line="9">
        <description><![CDATA[XML Parser]]></description>
        <long-description><![CDATA[<p>This will read our XML file and convert it into variables for us to parse.</p>]]></long-description>
        <tag line="9" name="package" description="phpLDAPadmin"/>
        <tag line="9" name="subpackage" description="XML"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="18" namespace="global" package="main">
        <name>$stack</name>
        <default><![CDATA[array()]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="19" namespace="global" package="main">
        <name>$stack_ref</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="20" namespace="global" package="main">
        <name>$arrOutput</name>
        <default><![CDATA[array()]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="21" namespace="global" package="main">
        <name>$resParser</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="22" namespace="global" package="main">
        <name>$strXmlData</name>
        <default><![CDATA[]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="24" package="phpLDAPadmin\XML">
        <name>push_pos</name>
        <full_name>push_pos</full_name>
        <argument line="24">
          <name>$pos</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="29" package="phpLDAPadmin\XML">
        <name>pop_pos</name>
        <full_name>pop_pos</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="34" package="phpLDAPadmin\XML">
        <name>parseXML</name>
        <full_name>parseXML</full_name>
        <argument line="34">
          <name>$strInputXML</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="34">
          <name>$filename</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="61" package="phpLDAPadmin\XML">
        <name>tagOpen</name>
        <full_name>tagOpen</full_name>
        <argument line="61">
          <name>$parser</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="61">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="61">
          <name>$attrs</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="88" package="phpLDAPadmin\XML">
        <name>tagData</name>
        <full_name>tagData</full_name>
        <argument line="88">
          <name>$parser</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="88">
          <name>$tagData</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="98" package="phpLDAPadmin\XML">
        <name>tagClosed</name>
        <full_name>tagClosed</full_name>
        <argument line="98">
          <name>$parser</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="98">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="107" package="phpLDAPadmin\XML">
        <name>cleanXML</name>
        <full_name>cleanXML</full_name>
        <docblock line="102">
          <description><![CDATA[This function will parse an XML array and make a normal array.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="102" name="return" description="- Clean XML data" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="107">
          <name>$details</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <parse_markers>
      <error line="18" code="50018">No DocBlock was found for property $stack</error>
      <error line="19" code="50018">No DocBlock was found for property $stack_ref</error>
      <error line="20" code="50018">No DocBlock was found for property $arrOutput</error>
      <error line="21" code="50018">No DocBlock was found for property $resParser</error>
      <error line="22" code="50018">No DocBlock was found for property $strXmlData</error>
      <error line="24" code="50010">No DocBlock was found for method push_pos()</error>
      <error line="29" code="50010">No DocBlock was found for method pop_pos()</error>
      <error line="34" code="50010">No DocBlock was found for method parseXML()</error>
      <error line="61" code="50010">No DocBlock was found for method tagOpen()</error>
      <error line="88" code="50010">No DocBlock was found for method tagData()</error>
      <error line="98" code="50010">No DocBlock was found for method tagClosed()</error>
      <error line="102" code="50015">Argument $details is missing from the Docblock of cleanXML()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/lib/page.php" hash="697221bdddeb3a4c6e8cda1c8064467b" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Page Rendering Functions]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <constant namespace="global" line="34" package="phpLDAPadmin">
      <name>IMGDIR</name>
      <full_name>\IMGDIR</full_name>
      <value><![CDATA['images/default']]></value>
    </constant>
    <constant namespace="global" line="36" package="phpLDAPadmin">
      <name>CSSDIR</name>
      <full_name>\CSSDIR</full_name>
      <value><![CDATA['css/default']]></value>
    </constant>
    <class final="false" abstract="false" namespace="global" line="15" package="phpLDAPadmin\Page">
      <extends/>
      <name>page</name>
      <full_name>\page</full_name>
      <docblock line="9">
        <description><![CDATA[This class controls the final output to the browser.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="9" name="package" description="phpLDAPadmin"/>
        <tag line="9" name="subpackage" description="Page"/>
      </docblock>
      <property final="false" static="false" visibility="protected" line="17" namespace="global" package="main">
        <name>$_pageheader</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="20" namespace="global" package="main">
        <name>$_head</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="23" namespace="global" package="main">
        <name>$_app</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="26" namespace="global" package="main">
        <name>$_default</name>
        <default><![CDATA[]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="28" package="phpLDAPadmin\Page">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <argument line="28">
          <name>$index</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="87" package="phpLDAPadmin\Page">
        <name>head_add</name>
        <full_name>head_add</full_name>
        <argument line="87">
          <name>$html</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="95" package="phpLDAPadmin\Page">
        <name>pageheader_print</name>
        <full_name>pageheader_print</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="141" package="phpLDAPadmin\Page">
        <name>head_print</name>
        <full_name>head_print</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="177" package="phpLDAPadmin\Page">
        <name>control_print</name>
        <full_name>control_print</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="205" package="phpLDAPadmin\Page">
        <name>tree</name>
        <full_name>tree</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="234" package="phpLDAPadmin\Page">
        <name>block_add</name>
        <full_name>block_add</full_name>
        <argument line="234">
          <name>$side</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="234">
          <name>$object</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="244" package="phpLDAPadmin\Page">
        <name>block_print</name>
        <full_name>block_print</full_name>
        <argument line="244">
          <name>$side</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="257" package="phpLDAPadmin\Page">
        <name>sysmsg</name>
        <full_name>sysmsg</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="295" package="phpLDAPadmin\Page">
        <name>body</name>
        <full_name>body</full_name>
        <argument line="295">
          <name>$raw</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="319" package="phpLDAPadmin\Page">
        <name>footer_print</name>
        <full_name>footer_print</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="332" package="phpLDAPadmin\Page">
        <name>show</name>
        <full_name>show</full_name>
        <docblock line="329">
          <description><![CDATA[Only show a particular page frame - used by an AJAX call]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="332">
          <name>$frame</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="332">
          <name>$compress</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
        <argument line="332">
          <name>$raw</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="367" package="phpLDAPadmin\Page">
        <name>display</name>
        <full_name>display</full_name>
        <argument line="367">
          <name>$filter</name>
          <default><![CDATA[array()]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="445" package="phpLDAPadmin\Page">
        <name>setsysmsg</name>
        <full_name>setsysmsg</full_name>
        <argument line="445">
          <name>$data</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="469" package="phpLDAPadmin\Page">
      <extends/>
      <name>block</name>
      <full_name>\block</full_name>
      <docblock line="463">
        <description><![CDATA[This class draws a block.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="463" name="package" description="phpLDAPadmin"/>
        <tag line="463" name="subpackage" description="Page"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="470" namespace="global" package="main">
        <name>$title</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="471" namespace="global" package="main">
        <name>$body</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="472" namespace="global" package="main">
        <name>$foot</name>
        <default><![CDATA[]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="474" package="phpLDAPadmin\Page">
        <name>setTitle</name>
        <full_name>setTitle</full_name>
        <argument line="474">
          <name>$html</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="478" package="phpLDAPadmin\Page">
        <name>setBody</name>
        <full_name>setBody</full_name>
        <argument line="478">
          <name>$html</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="482" package="phpLDAPadmin\Page">
        <name>setFooter</name>
        <full_name>setFooter</full_name>
        <argument line="482">
          <name>$html</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="486" package="phpLDAPadmin\Page">
        <name>draw</name>
        <full_name>draw</full_name>
        <argument line="486">
          <name>$side</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="486">
          <name>$raw</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <parse_markers>
      <error line="17" code="50018">No DocBlock was found for property $_pageheader</error>
      <error line="20" code="50018">No DocBlock was found for property $_head</error>
      <error line="23" code="50018">No DocBlock was found for property $_app</error>
      <error line="26" code="50018">No DocBlock was found for property $_default</error>
      <error line="28" code="50010">No DocBlock was found for method __construct()</error>
      <error line="87" code="50010">No DocBlock was found for method head_add()</error>
      <error line="95" code="50010">No DocBlock was found for method pageheader_print()</error>
      <error line="141" code="50010">No DocBlock was found for method head_print()</error>
      <error line="177" code="50010">No DocBlock was found for method control_print()</error>
      <error line="205" code="50010">No DocBlock was found for method tree()</error>
      <error line="234" code="50010">No DocBlock was found for method block_add()</error>
      <error line="244" code="50010">No DocBlock was found for method block_print()</error>
      <error line="257" code="50010">No DocBlock was found for method sysmsg()</error>
      <error line="295" code="50010">No DocBlock was found for method body()</error>
      <error line="319" code="50010">No DocBlock was found for method footer_print()</error>
      <error line="329" code="50015">Argument $frame is missing from the Docblock of show()</error>
      <error line="329" code="50015">Argument $compress is missing from the Docblock of show()</error>
      <error line="329" code="50015">Argument $raw is missing from the Docblock of show()</error>
      <error line="367" code="50010">No DocBlock was found for method display()</error>
      <error line="445" code="50010">No DocBlock was found for method setsysmsg()</error>
      <error line="470" code="50018">No DocBlock was found for property $title</error>
      <error line="471" code="50018">No DocBlock was found for property $body</error>
      <error line="472" code="50018">No DocBlock was found for property $foot</error>
      <error line="474" code="50010">No DocBlock was found for method setTitle()</error>
      <error line="478" code="50010">No DocBlock was found for method setBody()</error>
      <error line="482" code="50010">No DocBlock was found for method setFooter()</error>
      <error line="486" code="50010">No DocBlock was found for method draw()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/lib/Template.php" hash="d86cc8d531fe02304118796bf9d2ac52" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Classes and functions for the template engine.]]></description>
      <long-description><![CDATA[<p>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)</p>

<p>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.</p>

<p>The template object will be invalidated if it does contain the necessary
items (objectClass, MUST attributes, etc) to make a successful LDAP update.</p>]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="31" package="phpLDAPadmin\Templates">
      <extends>\xmlTemplate</extends>
      <name>Template</name>
      <full_name>\Template</full_name>
      <docblock line="22">
        <description><![CDATA[Template Class]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="22" name="package" description="phpLDAPadmin"/>
        <tag line="22" name="subpackage" description="Templates"/>
        <tag line="22" name="todo" description="RDN attributes should be treated as MUST attributes even though the schema marks them as MAY"/>
        <tag line="22" name="todo" description="RDN attributes need to be checked that are included in the schema, otherwise mark it is invalid"/>
        <tag line="22" name="todo" description="askcontainer is no longer used?"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="33" namespace="global" package="main">
        <name>$visible</name>
        <default><![CDATA[true]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="35" namespace="global" package="main">
        <name>$invalid</name>
        <default><![CDATA[false]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="36" namespace="global" package="main">
        <name>$invalid_admin</name>
        <default><![CDATA[false]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="37" namespace="global" package="main">
        <name>$invalid_reason</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="39" namespace="global" package="main">
        <name>$structural_oclass</name>
        <default><![CDATA[array()]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="40" namespace="global" package="main">
        <name>$description</name>
        <default><![CDATA['']]></default>
      </property>
      <property final="false" static="false" visibility="private" line="42" namespace="global" package="main">
        <name>$readonly</name>
        <default><![CDATA[false]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="45" namespace="global" package="main">
        <name>$dn</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="47" namespace="global" package="main">
        <name>$container</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="49" namespace="global" package="main">
        <name>$noleaf</name>
        <default><![CDATA[false]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="51" namespace="global" package="main">
        <name>$regexp</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="53" namespace="global" package="main">
        <name>$title</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="55" namespace="global" package="main">
        <name>$icon</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="57" namespace="global" package="main">
        <name>$rdn</name>
        <default><![CDATA[]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="59" package="phpLDAPadmin\Templates">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <argument line="59">
          <name>$server_id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="59">
          <name>$name</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="59">
          <name>$filename</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="59">
          <name>$type</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="59">
          <name>$id</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="67" package="phpLDAPadmin\Templates">
        <name>__clone</name>
        <full_name>__clone</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="81" package="phpLDAPadmin\Templates">
        <name>storeTemplate</name>
        <full_name>storeTemplate</full_name>
        <docblock line="76">
          <description><![CDATA[Main processing to store the template.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="76" name="param" description="Parsed xmldata from xml2array object" type="\xmldata" variable="$xmldata">
            <type by_reference="false">\xmldata</type>
          </tag>
        </docblock>
        <argument line="81">
          <name>$xmldata</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="229" package="phpLDAPadmin\Templates">
        <name>hasDefaultTemplate</name>
        <full_name>hasDefaultTemplate</full_name>
        <docblock line="223">
          <description><![CDATA[Is default templates enabled?
This will disable the default template from the engine.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="223" name="return" description="" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="245" package="phpLDAPadmin\Templates">
        <name>readTemplates</name>
        <full_name>readTemplates</full_name>
        <docblock line="239">
          <description><![CDATA[Return the templates of type (creation/modification)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="239" name="param" description="type - creation/modification" type="\$string" variable="$type">
            <type by_reference="false">\$string</type>
          </tag>
          <tag line="239" name="return" description="- Array of templates of that type" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="245">
          <name>$type</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="261" package="phpLDAPadmin\Templates">
        <name>accept</name>
        <full_name>accept</full_name>
        <docblock line="253">
          <description><![CDATA[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><![CDATA[<p>(OLD values are IGNORED, we will have got them when we build this object from the LDAP server DN.)</p>]]></long-description>
        </docblock>
        <argument line="261">
          <name>$makeVisible</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="573" package="phpLDAPadmin\Templates">
        <name>setDN</name>
        <full_name>setDN</full_name>
        <docblock line="568">
          <description><![CDATA[Set the DN for this template, if we are editing entries]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="568" name="param" description="The DN of the entry" type="\dn" variable="$dn">
            <type by_reference="false">\dn</type>
          </tag>
        </docblock>
        <argument line="573">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="594" package="phpLDAPadmin\Templates">
        <name>setRDNAttributes</name>
        <full_name>setRDNAttributes</full_name>
        <docblock line="586">
          <description><![CDATA[Set the RDN attributes
Given an RDN, mark the attributes as RDN attributes.]]></description>
          <long-description><![CDATA[<p>If there is no defined attribute,
then the remaining RDNs will be returned.</p>]]></long-description>
          <tag line="586" name="param" description="RDN" type="" variable="$rdn"/>
          <tag line="586" name="return" description="attributes not processed" type="\RDN">
            <type by_reference="false">\RDN</type>
          </tag>
        </docblock>
        <argument line="594">
          <name>$rdn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="621" package="phpLDAPadmin\Templates">
        <name>getDN</name>
        <full_name>getDN</full_name>
        <docblock line="615">
          <description><![CDATA[Display the DN for this template entry.]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="615" name="return" description="" type="\dn">
            <type by_reference="false">\dn</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="637" package="phpLDAPadmin\Templates">
        <name>getDNEncode</name>
        <full_name>getDNEncode</full_name>
        <argument line="637">
          <name>$url</name>
          <default><![CDATA[true]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="651" package="phpLDAPadmin\Templates">
        <name>setContainer</name>
        <full_name>setContainer</full_name>
        <docblock line="645">
          <description><![CDATA[Set the container for this template, if we are creating entries]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="645" name="param" description="The DN of the container" type="\dn" variable="$container">
            <type by_reference="false">\dn</type>
          </tag>
          <tag line="645" name="todo" description="Trigger a query to the LDAP server and generate an error if the container doesnt exist"/>
        </docblock>
        <argument line="651">
          <name>$container</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="669" package="phpLDAPadmin\Templates">
        <name>getContainer</name>
        <full_name>getContainer</full_name>
        <docblock line="664">
          <description><![CDATA[Get the DN of the container for this entry]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="664" name="return" description="DN of the container" type="\dn">
            <type by_reference="false">\dn</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="676" package="phpLDAPadmin\Templates">
        <name>getContainerEncode</name>
        <full_name>getContainerEncode</full_name>
        <argument line="676">
          <name>$url</name>
          <default><![CDATA[true]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="687" package="phpLDAPadmin\Templates">
        <name>copy</name>
        <full_name>copy</full_name>
        <docblock line="684">
          <description><![CDATA[Copy a DN]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="687">
          <name>$template</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="687">
          <name>$rdn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="687">
          <name>$asnew</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="757" package="phpLDAPadmin\Templates">
        <name>getAttrbyLdapType</name>
        <full_name>getAttrbyLdapType</full_name>
        <docblock line="751">
          <description><![CDATA[Get Attributes by LDAP type
This function will return a list of attributes by LDAP type (MUST,MAY).]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="751" name="return" description="Array of attributes." type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="757">
          <name>$type</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="774" package="phpLDAPadmin\Templates">
        <name>isAttrType</name>
        <full_name>isAttrType</full_name>
        <docblock line="771">
          <description><![CDATA[Return true if this is a MUST,MAY attribute]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="774">
          <name>$attr</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="774">
          <name>$type</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="789" package="phpLDAPadmin\Templates">
        <name>getRDNObjects</name>
        <full_name>getRDNObjects</full_name>
        <docblock line="784">
          <description><![CDATA[Return the attributes that comprise the RDN.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="784" name="return" description="Array of RDN objects" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="808" package="phpLDAPadmin\Templates">
        <name>getRDNAttrs</name>
        <full_name>getRDNAttrs</full_name>
        <docblock line="803">
          <description><![CDATA[Get all the RDNs for this template, in RDN order.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="803" name="return" description="RDNs in order." type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="837" package="phpLDAPadmin\Templates">
        <name>getRDN</name>
        <full_name>getRDN</full_name>
        <docblock line="831">
          <description><![CDATA[Return the RDN for this template.]]></description>
          <long-description><![CDATA[<p>If the DN is already defined, then the RDN will be calculated from it.
If the DN is not set, then the RDN will be calcuated from the template attribute definitions</p>]]></long-description>
          <tag line="831" name="return" description="RDN for this template" type="\rdn">
            <type by_reference="false">\rdn</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="865" package="phpLDAPadmin\Templates">
        <name>getRDNAttributeName</name>
        <full_name>getRDNAttributeName</full_name>
        <docblock line="862">
          <description><![CDATA[Return the attribute name part of the RDN]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="890" package="phpLDAPadmin\Templates">
        <name>getContext</name>
        <full_name>getContext</full_name>
        <docblock line="887">
          <description><![CDATA[Determine the type of template this is]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="909" package="phpLDAPadmin\Templates">
        <name>isVisible</name>
        <full_name>isVisible</full_name>
        <docblock line="904">
          <description><![CDATA[Test if the template is visible]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="904" name="return" description="" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="916" package="phpLDAPadmin\Templates">
        <name>setVisible</name>
        <full_name>setVisible</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="920" package="phpLDAPadmin\Templates">
        <name>setInvisible</name>
        <full_name>setInvisible</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="924" package="phpLDAPadmin\Templates">
        <name>getRegExp</name>
        <full_name>getRegExp</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="934" package="phpLDAPadmin\Templates">
        <name>isReadOnly</name>
        <full_name>isReadOnly</full_name>
        <docblock line="931">
          <description><![CDATA[Test if this template has been marked as a read-only template]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="950" package="phpLDAPadmin\Templates">
        <name>getAttributes</name>
        <full_name>getAttributes</full_name>
        <docblock line="944">
          <description><![CDATA[Get the attribute entries]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="944" name="param" description="Include the optional attributes" type="boolean" variable="$optional">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="944" name="return" description="Array of attributes" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="950">
          <name>$optional</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="971" package="phpLDAPadmin\Templates">
        <name>getAttributesShown</name>
        <full_name>getAttributesShown</full_name>
        <docblock line="968">
          <description><![CDATA[Return a list of attributes that should be shown]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="987" package="phpLDAPadmin\Templates">
        <name>getAttributesInternal</name>
        <full_name>getAttributesInternal</full_name>
        <docblock line="984">
          <description><![CDATA[Return a list of the internal attributes]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1005" package="phpLDAPadmin\Templates">
        <name>getObjectClasses</name>
        <full_name>getObjectClasses</full_name>
        <docblock line="1000">
          <description><![CDATA[Return the objectclasses defined in this template]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1000" name="return" description="Array of Objects" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1019" package="phpLDAPadmin\Templates">
        <name>getIcon</name>
        <full_name>getIcon</full_name>
        <docblock line="1016">
          <description><![CDATA[Get template icon]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1031" package="phpLDAPadmin\Templates">
        <name>getDescription</name>
        <full_name>getDescription</full_name>
        <docblock line="1026">
          <description><![CDATA[Return the template description]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1026" name="return" description="Description" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1043" package="phpLDAPadmin\Templates">
        <name>setInvalid</name>
        <full_name>setInvalid</full_name>
        <docblock line="1038">
          <description><![CDATA[Set a template as invalid]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1038" name="param" description="Message indicating the reason the template has been invalidated" type="string" variable="$msg">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="1043">
          <name>$msg</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1043">
          <name>$admin</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1057" package="phpLDAPadmin\Templates">
        <name>isInValid</name>
        <full_name>isInValid</full_name>
        <docblock line="1052">
          <description><![CDATA[Get the template validity or the reason it is invalid]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1052" name="return" description="Invalid reason, or false if not invalid" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1067" package="phpLDAPadmin\Templates">
        <name>isAdminDisabled</name>
        <full_name>isAdminDisabled</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1080" package="phpLDAPadmin\Templates">
        <name>setMinValueCount</name>
        <full_name>setMinValueCount</full_name>
        <docblock line="1074">
          <description><![CDATA[Set the minimum number of values for an attribute]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1074" name="param" description="Attribute" type="object" variable="$attr">
            <type by_reference="false">object</type>
          </tag>
          <tag line="1074" name="param" description="int" type="" variable="$value"/>
        </docblock>
        <argument line="1080">
          <name>$attr</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1080">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1096" package="phpLDAPadmin\Templates">
        <name>setAttrLDAPtype</name>
        <full_name>setAttrLDAPtype</full_name>
        <docblock line="1090">
          <description><![CDATA[Set the LDAP type property for an attribute]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1090" name="param" description="Attribute" type="object" variable="$attr">
            <type by_reference="false">object</type>
          </tag>
          <tag line="1090" name="param" description="(MUST,MAY,OPTIONAL)" type="string" variable="$value">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="1096">
          <name>$attr</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1096">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1111" package="phpLDAPadmin\Templates">
        <name>OnChangeAdd</name>
        <full_name>OnChangeAdd</full_name>
        <docblock line="1108">
          <description><![CDATA[OnChangeAdd javascript processing]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="1111">
          <name>$origin</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1111">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1277" package="phpLDAPadmin\Templates">
        <name>rebuildTemplateAttrs</name>
        <full_name>rebuildTemplateAttrs</full_name>
        <docblock line="1272">
          <description><![CDATA[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><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1392" package="phpLDAPadmin\Templates">
        <name>getLDAPadd</name>
        <full_name>getLDAPadd</full_name>
        <docblock line="1388">
          <description><![CDATA[Return an array, that can be passed to ldap_add().]]></description>
          <long-description><![CDATA[<p>Attributes with empty values will be excluded.</p>]]></long-description>
        </docblock>
        <argument line="1392">
          <name>$attrsOnly</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1427" package="phpLDAPadmin\Templates">
        <name>getLDAPmodify</name>
        <full_name>getLDAPmodify</full_name>
        <docblock line="1418">
          <description><![CDATA[Return an array, that can be passed to ldap_mod_replace().]]></description>
          <long-description><![CDATA[<p>Only attributes that have changed their value will be returned.</p>

<p>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</p>]]></long-description>
          <tag line="1418" name="param" description="Return the attribute objects (useful for a confirmation process), or the modification array for ldap_modify()" type="boolean" variable="$attrsOnly">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1427">
          <name>$attrsOnly</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
        <argument line="1427">
          <name>$index</name>
          <default><![CDATA[0]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1508" package="phpLDAPadmin\Templates">
        <name>getForceDeleteAttrs</name>
        <full_name>getForceDeleteAttrs</full_name>
        <docblock line="1504">
          <description><![CDATA[Get the attributes that are marked as force delete
We'll cache this result in the event of multiple calls.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1527" package="phpLDAPadmin\Templates">
        <name>getAvailAttrs</name>
        <full_name>getAvailAttrs</full_name>
        <docblock line="1524">
          <description><![CDATA[Get available attributes]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1563" package="phpLDAPadmin\Templates">
        <name>isNoLeaf</name>
        <full_name>isNoLeaf</full_name>
      </method>
    </class>
    <parse_markers>
      <error line="33" code="50018">No DocBlock was found for property $visible</error>
      <error line="35" code="50018">No DocBlock was found for property $invalid</error>
      <error line="36" code="50018">No DocBlock was found for property $invalid_admin</error>
      <error line="37" code="50018">No DocBlock was found for property $invalid_reason</error>
      <error line="39" code="50018">No DocBlock was found for property $structural_oclass</error>
      <error line="40" code="50018">No DocBlock was found for property $description</error>
      <error line="42" code="50018">No DocBlock was found for property $readonly</error>
      <error line="45" code="50018">No DocBlock was found for property $dn</error>
      <error line="47" code="50018">No DocBlock was found for property $container</error>
      <error line="49" code="50018">No DocBlock was found for property $noleaf</error>
      <error line="51" code="50018">No DocBlock was found for property $regexp</error>
      <error line="53" code="50018">No DocBlock was found for property $title</error>
      <error line="55" code="50018">No DocBlock was found for property $icon</error>
      <error line="57" code="50018">No DocBlock was found for property $rdn</error>
      <error line="59" code="50010">No DocBlock was found for method __construct()</error>
      <error line="67" code="50010">No DocBlock was found for method __clone()</error>
      <error line="253" code="50015">Argument $makeVisible is missing from the Docblock of accept()</error>
      <error line="637" code="50010">No DocBlock was found for method getDNEncode()</error>
      <error line="676" code="50010">No DocBlock was found for method getContainerEncode()</error>
      <error line="684" code="50015">Argument $template is missing from the Docblock of copy()</error>
      <error line="684" code="50015">Argument $rdn is missing from the Docblock of copy()</error>
      <error line="684" code="50015">Argument $asnew is missing from the Docblock of copy()</error>
      <error line="751" code="50015">Argument $type is missing from the Docblock of getAttrbyLdapType()</error>
      <error line="771" code="50015">Argument $attr is missing from the Docblock of isAttrType()</error>
      <error line="771" code="50015">Argument $type is missing from the Docblock of isAttrType()</error>
      <error line="916" code="50010">No DocBlock was found for method setVisible()</error>
      <error line="920" code="50010">No DocBlock was found for method setInvisible()</error>
      <error line="924" code="50010">No DocBlock was found for method getRegExp()</error>
      <error line="1038" code="50015">Argument $admin is missing from the Docblock of setInvalid()</error>
      <error line="1067" code="50010">No DocBlock was found for method isAdminDisabled()</error>
      <error line="1108" code="50015">Argument $origin is missing from the Docblock of OnChangeAdd()</error>
      <error line="1108" code="50015">Argument $value is missing from the Docblock of OnChangeAdd()</error>
      <error line="1388" code="50015">Argument $attrsOnly is missing from the Docblock of getLDAPadd()</error>
      <error line="1418" code="50015">Argument $index is missing from the Docblock of getLDAPmodify()</error>
      <error line="1563" code="50010">No DocBlock was found for method isNoLeaf()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/lib/functions.php" hash="5086716cfe9592a7cb1a30b4deef3c1d" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[A collection of common generic functions used throughout the application.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <include line="56" type="Require Once" package="main">
      <name/>
    </include>
    <include line="58" type="Require Once" package="main">
      <name/>
    </include>
    <include line="60" type="Require Once" package="main">
      <name/>
    </include>
    <include line="199" type="Require Once" package="main">
      <name/>
    </include>
    <include line="212" type="Include" package="main">
      <name/>
    </include>
    <include line="215" type="Require" package="main">
      <name/>
    </include>
    <include line="684" type="Require Once" package="main">
      <name/>
    </include>
    <include line="739" type="Require Once" package="main">
      <name/>
    </include>
    <constant namespace="global" line="16" package="phpLDAPadmin">
      <name>HTDOCDIR</name>
      <full_name>\HTDOCDIR</full_name>
      <value><![CDATA[sprintf('%s/', realpath(LIBDIR . '../htdocs/'))]]></value>
      <docblock line="14">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="17" package="phpLDAPadmin">
      <name>LANGDIR</name>
      <full_name>\LANGDIR</full_name>
      <value><![CDATA[sprintf('%s/', realpath(LIBDIR . '../locale/'))]]></value>
    </constant>
    <constant namespace="global" line="18" package="phpLDAPadmin">
      <name>CONFDIR</name>
      <full_name>\CONFDIR</full_name>
      <value><![CDATA[sprintf('%s/', realpath(LIBDIR . '../config'))]]></value>
    </constant>
    <constant namespace="global" line="19" package="phpLDAPadmin">
      <name>QUERYDIR</name>
      <full_name>\QUERYDIR</full_name>
      <value><![CDATA[sprintf('%s/', realpath(LIBDIR . '../queries/'))]]></value>
    </constant>
    <constant namespace="global" line="20" package="phpLDAPadmin">
      <name>TMPLDIR</name>
      <full_name>\TMPLDIR</full_name>
      <value><![CDATA[sprintf('%s/', realpath(LIBDIR . '../templates/'))]]></value>
    </constant>
    <constant namespace="global" line="21" package="phpLDAPadmin">
      <name>DOCDIR</name>
      <full_name>\DOCDIR</full_name>
      <value><![CDATA[sprintf('%s/', realpath(LIBDIR . '../doc/'))]]></value>
    </constant>
    <constant namespace="global" line="22" package="phpLDAPadmin">
      <name>HOOKSDIR</name>
      <full_name>\HOOKSDIR</full_name>
      <value><![CDATA[sprintf('%s/', realpath(LIBDIR . '../hooks/'))]]></value>
    </constant>
    <constant namespace="global" line="23" package="phpLDAPadmin">
      <name>JSDIR</name>
      <full_name>\JSDIR</full_name>
      <value><![CDATA['js/']]></value>
    </constant>
    <function namespace="global" line="54" package="phpLDAPadmin">
      <name>__autoload</name>
      <full_name>\__autoload</full_name>
      <docblock line="51">
        <description><![CDATA[Loads class definition]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
      <argument line="54">
        <name>$className</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="74" package="phpLDAPadmin">
      <name>array_stripslashes</name>
      <full_name>\array_stripslashes</full_name>
      <docblock line="69">
        <description><![CDATA[Strips all slashes from the specified array in place (pass by ref).]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="69" name="param" description="The array to strip slashes from, typically one of $_GET, $_POST, or $_COOKIE." type="Array" variable="$array">
          <type by_reference="false">Array</type>
        </tag>
      </docblock>
      <argument line="74">
        <name>$array</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="96" package="phpLDAPadmin">
      <name>_</name>
      <full_name>\_</full_name>
      <argument line="96">
        <name>$msg</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="122" package="phpLDAPadmin">
      <name>app_error_handler</name>
      <full_name>\app_error_handler</full_name>
      <docblock line="105">
        <description><![CDATA[Custom error handling function.]]></description>
        <long-description><![CDATA[<p>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.</p>]]></long-description>
        <tag line="105" name="param" description="The PHP error number that occurred (ie, E_ERROR, E_WARNING, E_PARSE, etc)." type="int" variable="$errno">
          <type by_reference="false">int</type>
        </tag>
        <tag line="105" name="param" description="The PHP error string provided (ie, &quot;Warning index &quot;foo&quot; is undefined)" type="string" variable="$errstr">
          <type by_reference="false">string</type>
        </tag>
        <tag line="105" name="param" description="The file in which the PHP error ocurred." type="string" variable="$file">
          <type by_reference="false">string</type>
        </tag>
        <tag line="105" name="param" description="The line number on which the PHP error ocurred" type="int" variable="$lineno">
          <type by_reference="false">int</type>
        </tag>
        <tag line="105" name="see" description="\global\set_error_handler" refers="\global\set_error_handler"/>
      </docblock>
      <argument line="122">
        <name>$errno</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="122">
        <name>$errstr</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="122">
        <name>$file</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="122">
        <name>$lineno</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="167" package="phpLDAPadmin">
      <name>app_name</name>
      <full_name>\app_name</full_name>
      <docblock line="164">
        <description><![CDATA[Returns the application name.]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </function>
    <function namespace="global" line="177" package="phpLDAPadmin">
      <name>app_version</name>
      <full_name>\app_version</full_name>
      <docblock line="171">
        <description><![CDATA[Returns the application version currently running.]]></description>
        <long-description><![CDATA[<p>The version
is read from the file named VERSION.</p>]]></long-description>
        <tag line="171" name="return" description="The current version as read from the VERSION file." type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
    </function>
    <function namespace="global" line="186" package="phpLDAPadmin">
      <name>auto_lang</name>
      <full_name>\auto_lang</full_name>
      <docblock line="181">
        <description><![CDATA[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><![CDATA[]]></long-description>
      </docblock>
      <argument line="186">
        <name>$lang</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="197" package="phpLDAPadmin">
      <name>check_config</name>
      <full_name>\check_config</full_name>
      <docblock line="194">
        <description><![CDATA[Makes sure that the config file is properly setup.]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
      <argument line="197">
        <name>$config_file</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="286" package="phpLDAPadmin">
      <name>cmd_control_pane</name>
      <full_name>\cmd_control_pane</full_name>
      <docblock line="281">
        <description><![CDATA[Commands available in the control_panel of the page]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="281" name="return" description="" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="286">
        <name>$type</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="359" package="phpLDAPadmin">
      <name>debug_dump</name>
      <full_name>\debug_dump</full_name>
      <docblock line="353">
        <description><![CDATA[This function dumps the $variable for debugging purposes]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="353" name="param" description="Variable to dump" type="string|array" variable="$variable">
          <type by_reference="false">string</type>
          <type by_reference="false">array</type>
        </tag>
        <tag line="353" name="param" description="Whether to stop execution or not." type="boolean" variable="$die">
          <type by_reference="false">boolean</type>
        </tag>
      </docblock>
      <argument line="359">
        <name>$variable</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="359">
        <name>$die</name>
        <default><![CDATA[false]]></default>
        <type/>
      </argument>
      <argument line="359">
        <name>$onlydebugaddr</name>
        <default><![CDATA[false]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="368" package="phpLDAPadmin">
      <name>debug_dump_backtrace</name>
      <full_name>\debug_dump_backtrace</full_name>
      <docblock line="363">
        <description><![CDATA[This function generates a backtrace]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="363" name="param" description="Whether to stop execution or not." type="boolean" variable="$msg">
          <type by_reference="false">boolean</type>
        </tag>
      </docblock>
      <argument line="368">
        <name>$msg</name>
        <default><![CDATA['Calling BackTrace']]></default>
        <type/>
      </argument>
      <argument line="368">
        <name>$die</name>
        <default><![CDATA[false]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="375" package="phpLDAPadmin">
      <name>debug_sysmsg</name>
      <full_name>\debug_sysmsg</full_name>
      <docblock line="372">
        <description><![CDATA[Send a debug as a sys message]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
      <argument line="375">
        <name>$msg</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="410" package="phpLDAPadmin">
      <name>debug_log</name>
      <full_name>\debug_log</full_name>
      <docblock line="379">
        <description><![CDATA[Debug Logging]]></description>
        <long-description><![CDATA[<p>The global debug level is turned on in your configuration file by setting:</p>

<pre><code>$config->custom->debug['level'] = 255;
</code></pre>

<p>together with atleast one output direction (currently file and syslog are supported).</p>

<pre><code>$config->custom->debug['file'] = '/tmp/app_debug.log';
$config->custom->debug['syslog'] = true;
</code></pre>

<p>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.)</p>

<p>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</p>]]></long-description>
        <tag line="379" name="param" description="Message to send to syslog" type="string" variable="$msg">
          <type by_reference="false">string</type>
        </tag>
        <tag line="379" name="param" description="Log bit number for this message." type="int" variable="$level">
          <type by_reference="false">int</type>
        </tag>
        <tag line="379" name="see" description="\global\syslog.php" refers="\global\syslog.php"/>
      </docblock>
      <argument line="410">
        <name>$msg</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="410">
        <name>$level</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="410">
        <name>$indent</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="498" package="phpLDAPadmin">
      <name>error</name>
      <full_name>\error</full_name>
      <docblock line="495">
        <description><![CDATA[Display an error message in the system message panel of the page.]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
      <argument line="498">
        <name>$msg</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="498">
        <name>$type</name>
        <default><![CDATA['note']]></default>
        <type/>
      </argument>
      <argument line="498">
        <name>$redirect</name>
        <default><![CDATA[null]]></default>
        <type/>
      </argument>
      <argument line="498">
        <name>$fatal</name>
        <default><![CDATA[false]]></default>
        <type/>
      </argument>
      <argument line="498">
        <name>$backtrace</name>
        <default><![CDATA[false]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="573" package="phpLDAPadmin">
      <name>get_request</name>
      <full_name>\get_request</full_name>
      <docblock line="568">
        <description><![CDATA[Return the result of a form variable, with optional default]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="568" name="return" description="form GET/REQUEST/SESSION/POST variable value or its default" type="\The">
          <type by_reference="false">\The</type>
        </tag>
      </docblock>
      <argument line="573">
        <name>$attr</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="573">
        <name>$type</name>
        <default><![CDATA['POST']]></default>
        <type/>
      </argument>
      <argument line="573">
        <name>$die</name>
        <default><![CDATA[false]]></default>
        <type/>
      </argument>
      <argument line="573">
        <name>$default</name>
        <default><![CDATA[null]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="608" package="phpLDAPadmin">
      <name>system_message</name>
      <full_name>\system_message</full_name>
      <docblock line="604">
        <description><![CDATA[Record a system message.]]></description>
        <long-description><![CDATA[<p>This function can be used as an alternative to generate a system message, if page hasnt yet been defined.</p>]]></long-description>
      </docblock>
      <argument line="608">
        <name>$msg</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="608">
        <name>$redirect</name>
        <default><![CDATA[null]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="661" package="phpLDAPadmin">
      <name>blowfish_encrypt</name>
      <full_name>\blowfish_encrypt</full_name>
      <docblock line="653">
        <description><![CDATA[Encryption using blowfish algorithm]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="653" name="param" description="Original data" type="string" variable="$data">
          <type by_reference="false">string</type>
        </tag>
        <tag line="653" name="param" description="The secret" type="string" variable="$secret">
          <type by_reference="false">string</type>
        </tag>
        <tag line="653" name="return" description="The encrypted result" type="string">
          <type by_reference="false">string</type>
        </tag>
        <tag line="653" name="author" description="lem9 (taken from the phpMyAdmin source)"/>
      </docblock>
      <argument line="661">
        <name>$data</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="661">
        <name>$secret</name>
        <default><![CDATA[null]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="710" package="phpLDAPadmin">
      <name>blowfish_decrypt</name>
      <full_name>\blowfish_decrypt</full_name>
      <docblock line="702">
        <description><![CDATA[Decryption using blowfish algorithm]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="702" name="param" description="Encrypted data" type="string" variable="$encdata">
          <type by_reference="false">string</type>
        </tag>
        <tag line="702" name="param" description="The secret" type="string" variable="$secret">
          <type by_reference="false">string</type>
        </tag>
        <tag line="702" name="return" description="Original data" type="string">
          <type by_reference="false">string</type>
        </tag>
        <tag line="702" name="author" description="lem9 (taken from the phpMyAdmin source)"/>
      </docblock>
      <argument line="710">
        <name>$encdata</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="710">
        <name>$secret</name>
        <default><![CDATA[null]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="764" package="phpLDAPadmin">
      <name>full_str_pad</name>
      <full_name>\full_str_pad</full_name>
      <docblock line="755">
        <description><![CDATA[String padding]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="755" name="param" description="Input string" type="string" variable="$input">
          <type by_reference="false">string</type>
        </tag>
        <tag line="755" name="param" description="Length of the result" type="integer" variable="$pad_length">
          <type by_reference="false">integer</type>
        </tag>
        <tag line="755" name="param" description="The filling string" type="string" variable="$pad_string">
          <type by_reference="false">string</type>
        </tag>
        <tag line="755" name="param" description="Padding mode" type="integer" variable="$pad_type">
          <type by_reference="false">integer</type>
        </tag>
        <tag line="755" name="return" description="The padded string" type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="764">
        <name>$input</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="764">
        <name>$pad_length</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="764">
        <name>$pad_string</name>
        <default><![CDATA['']]></default>
        <type/>
      </argument>
      <argument line="764">
        <name>$pad_type</name>
        <default><![CDATA[0]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="799" package="phpLDAPadmin">
      <name>get_cached_item</name>
      <full_name>\get_cached_item</full_name>
      <docblock line="788">
        <description><![CDATA[Returns the cached array of LDAP resources.]]></description>
        <long-description><![CDATA[<p>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).</p>]]></long-description>
        <tag line="788" name="return" description="the cached attributed requested, or null if there is nothing cached.." type="\Returns">
          <type by_reference="false">\Returns</type>
        </tag>
      </docblock>
      <argument line="799">
        <name>$index</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="799">
        <name>$item</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="799">
        <name>$subitem</name>
        <default><![CDATA['null']]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="821" package="phpLDAPadmin">
      <name>set_cached_item</name>
      <full_name>\set_cached_item</full_name>
      <docblock line="816">
        <description><![CDATA[Caches the specified $item for the specified $index.]]></description>
        <long-description><![CDATA[<p>Returns true on success of false on failure.</p>]]></long-description>
      </docblock>
      <argument line="821">
        <name>$index</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="821">
        <name>$item</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="821">
        <name>$subitem</name>
        <default><![CDATA['null']]></default>
        <type/>
      </argument>
      <argument line="821">
        <name>$data</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="841" package="phpLDAPadmin">
      <name>del_cached_item</name>
      <full_name>\del_cached_item</full_name>
      <docblock line="838">
        <description><![CDATA[Deletes the cache for a specified $item for the specified $index]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
      <argument line="841">
        <name>$index</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="841">
        <name>$item</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="841">
        <name>$subitem</name>
        <default><![CDATA['null']]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="866" package="phpLDAPadmin">
      <name>set_cookie</name>
      <full_name>\set_cookie</full_name>
      <docblock line="855">
        <description><![CDATA[Utility wrapper for setting cookies, which takes into consideration
application configuration values.]]></description>
        <long-description><![CDATA[<p>On success, true is returned. On
failure, false is returned.</p>]]></long-description>
        <tag line="855" name="param" description="The name of the cookie to set." type="string" variable="$name">
          <type by_reference="false">string</type>
        </tag>
        <tag line="855" name="param" description="The value of the cookie to set." type="string" variable="$val">
          <type by_reference="false">string</type>
        </tag>
        <tag line="855" name="param" description="(optional) The duration in seconds of this cookie. If unspecified, $cookie_time is used from config.php" type="int" variable="$expire">
          <type by_reference="false">int</type>
        </tag>
        <tag line="855" name="param" description="(optional) The directory value of this cookie (see php.net/setcookie)" type="string" variable="$dir">
          <type by_reference="false">string</type>
        </tag>
        <tag line="855" name="return" description="" type="boolean">
          <type by_reference="false">boolean</type>
        </tag>
      </docblock>
      <argument line="866">
        <name>$name</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="866">
        <name>$val</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="866">
        <name>$expire</name>
        <default><![CDATA[null]]></default>
        <type/>
      </argument>
      <argument line="866">
        <name>$dir</name>
        <default><![CDATA[null]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="901" package="phpLDAPadmin">
      <name>get_custom_file</name>
      <full_name>\get_custom_file</full_name>
      <docblock line="892">
        <description><![CDATA[Get a customized file for a server
We don't need any caching, because it's done by PHP]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="892" name="param" description="The ID of the server" type="int" variable="$index">
          <type by_reference="false">int</type>
        </tag>
        <tag line="892" name="param" description="The requested filename" type="string" variable="$filename">
          <type by_reference="false">string</type>
        </tag>
        <tag line="892" name="return" description="The customized filename, if exists, or the standard one" type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="901">
        <name>$index</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="901">
        <name>$filename</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="901">
        <name>$path</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="927" package="phpLDAPadmin">
      <name>masort</name>
      <full_name>\masort</full_name>
      <docblock line="919">
        <description><![CDATA[Sort a multi dimensional array.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="919" name="param" description="Multi demension array passed by reference" type="array" variable="$data">
          <type by_reference="false">array</type>
        </tag>
        <tag line="919" name="param" description="Comma delimited string of sort keys." type="string" variable="$sortby">
          <type by_reference="false">string</type>
        </tag>
        <tag line="919" name="param" description="Whether to reverse sort." type="boolean" variable="$rev">
          <type by_reference="false">boolean</type>
        </tag>
        <tag line="919" name="return" description="Sorted multi demension array." type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="927">
        <name>$data</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="927">
        <name>$sortby</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="927">
        <name>$rev</name>
        <default><![CDATA[0]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="1017" package="phpLDAPadmin">
      <name>isCompress</name>
      <full_name>\isCompress</full_name>
      <docblock line="1014">
        <description><![CDATA[Is compression enabled for output]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </function>
    <function namespace="global" line="1044" package="phpLDAPadmin">
      <name>obfuscate_password_display</name>
      <full_name>\obfuscate_password_display</full_name>
      <docblock line="1027">
        <description><![CDATA[Fetches whether the user has configured phpLDAPadmin to obfuscate passwords
with "*********" when displaying them.]]></description>
        <long-description><![CDATA[<p>This is configured in config.php thus:</p>

<pre><code> $config->custom->appearance['obfuscate_password_display'] = true;
</code></pre>

<p>Or if it is OK to show encrypted passwords but not clear text passwords</p>

<pre><code> $config->custom->appearance['show_clear_password'] = false;
</code></pre>]]></long-description>
        <tag line="1027" name="param" description="Password encoding type" type="string" variable="$enc">
          <type by_reference="false">string</type>
        </tag>
        <tag line="1027" name="return" description="" type="boolean">
          <type by_reference="false">boolean</type>
        </tag>
      </docblock>
      <argument line="1044">
        <name>$enc</name>
        <default><![CDATA[null]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="1073" package="phpLDAPadmin">
      <name>pretty_print_dn</name>
      <full_name>\pretty_print_dn</full_name>
      <docblock line="1063">
        <description><![CDATA[Returns an HTML-beautified version of a DN.]]></description>
        <long-description><![CDATA[<p>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.</p>]]></long-description>
        <tag line="1063" name="param" description="The DN to pretty-print." type="string" variable="$dn">
          <type by_reference="false">string</type>
        </tag>
        <tag line="1063" name="return" description="" type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="1073">
        <name>$dn</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="1106" package="phpLDAPadmin">
      <name>is_dn_string</name>
      <full_name>\is_dn_string</full_name>
      <docblock line="1095">
        <description><![CDATA[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").]]></description>
        <long-description><![CDATA[<p>Returns false otherwise.
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.</p>

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

<p>The comparison is performed starting with the top-most element
of the DN. Thus, the following list:</p>

<pre><code>      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
   </code></pre>

<p>Will be sorted thus using usort( $list, "pla_compare_dns" ):</p>

<pre><code>      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
   </code></pre>]]></long-description>
        <tag line="1173" name="param" description="The first of two DNs to compare" type="string" variable="$dn1">
          <type by_reference="false">string</type>
        </tag>
        <tag line="1173" name="param" description="The second of two DNs to compare" type="string" variable="$dn2">
          <type by_reference="false">string</type>
        </tag>
        <tag line="1173" name="return" description="" type="int">
          <type by_reference="false">int</type>
        </tag>
      </docblock>
      <argument line="1204">
        <name>$dn1</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="1204">
        <name>$dn2</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="1303" package="phpLDAPadmin">
      <name>get_next_number</name>
      <full_name>\get_next_number</full_name>
      <docblock line="1268">
        <description><![CDATA[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><![CDATA[<p>This is configured in config.php by server:</p>

<pre><code>  $servers->setValue('auto_number','enable',true|false);
</code></pre>

<p>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.</p>

<p>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.</p>

<p>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.</p>

<p>See config.php.example for more notes on the two mechanisms.</p>]]></long-description>
        <tag line="1268" name="param" description="Base to start the search from" type="string" variable="$base">
          <type by_reference="false">string</type>
        </tag>
        <tag line="1268" name="param" description="Attribute to query" type="string" variable="$attr">
          <type by_reference="false">string</type>
        </tag>
        <tag line="1268" name="param" description="Increment the result (for pool searches)" type="boolean" variable="$increment">
          <type by_reference="false">boolean</type>
        </tag>
        <tag line="1268" name="param" description="LDAP filter to use (for pool searches)" type="string" variable="$filter">
          <type by_reference="false">string</type>
        </tag>
        <tag line="1268" name="return" description="" type="int">
          <type by_reference="false">int</type>
        </tag>
      </docblock>
      <argument line="1303">
        <name>$base</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="1303">
        <name>$attr</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="1303">
        <name>$increment</name>
        <default><![CDATA[false]]></default>
        <type/>
      </argument>
      <argument line="1303">
        <name>$filter</name>
        <default><![CDATA[false]]></default>
        <type/>
      </argument>
      <argument line="1303">
        <name>$startmin</name>
        <default><![CDATA[null]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="1495" package="phpLDAPadmin">
      <name>get_icon</name>
      <full_name>\get_icon</full_name>
      <docblock line="1476">
        <description><![CDATA[Given a DN and server ID, this function reads the DN's objectClasses and
determines which icon best represents the entry.]]></description>
        <long-description><![CDATA[<p>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. :)</p>

<p>This function returns a string like "country.png". All icon files are assumed
to be contained in the /images/ directory of phpLDAPadmin.</p>

<p>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.</p>]]></long-description>
        <tag line="1476" name="param" description="The DN of the entry whose icon you wish to fetch." type="string" variable="$server_id">
          <type by_reference="false">string</type>
        </tag>
        <tag line="1476" name="return" description="" type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="1495">
        <name>$server_id</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="1495">
        <name>$dn</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="1495">
        <name>$object_classes</name>
        <default><![CDATA[array()]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="1676" package="phpLDAPadmin">
      <name>expand_dn_with_base</name>
      <full_name>\expand_dn_with_base</full_name>
      <docblock line="1669">
        <description><![CDATA[Appends a servers base to a "sub" dn or returns the base.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="1669" name="param" description="The baseDN to be added if the DN is relative" type="string" variable="$base">
          <type by_reference="false">string</type>
        </tag>
        <tag line="1669" name="param" description="The DN to be made absolute" type="string" variable="$sub_dn">
          <type by_reference="false">string</type>
        </tag>
        <tag line="1669" name="return" description="Returns null if both base is null and sub_dn is null or empty" type="string|null">
          <type by_reference="false">string</type>
          <type by_reference="false">null</type>
        </tag>
      </docblock>
      <argument line="1676">
        <name>$base</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="1676">
        <name>$sub_dn</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="1702" package="phpLDAPadmin">
      <name>random_salt</name>
      <full_name>\random_salt</full_name>
      <docblock line="1693">
        <description><![CDATA[Used to generate a random salt for crypt-style passwords.]]></description>
        <long-description><![CDATA[<p>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.</p>]]></long-description>
        <tag line="1693" name="param" description="The length of the salt string to generate." type="int" variable="$length">
          <type by_reference="false">int</type>
        </tag>
        <tag line="1693" name="return" description="The generated salt string." type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="1702">
        <name>$length</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="1728" package="phpLDAPadmin">
      <name>get_rdn</name>
      <full_name>\get_rdn</full_name>
      <docblock line="1719">
        <description><![CDATA[Given a DN string, this returns the 'RDN' portion of the string.]]></description>
        <long-description><![CDATA[<p>For example. given 'cn=Manager,dc=example,dc=com', this function returns
'cn=Manager' (it is really the exact opposite of ds_ldap::getContainer()).</p>]]></long-description>
        <tag line="1719" name="param" description="The DN whose RDN to return." type="string" variable="$dn">
          <type by_reference="false">string</type>
        </tag>
        <tag line="1719" name="param" description="If true, include attributes in the RDN string. See http://php.net/ldap_explode_dn for details" type="boolean" variable="$include_attrs">
          <type by_reference="false">boolean</type>
        </tag>
        <tag line="1719" name="return" description="The RDN" type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="1728">
        <name>$dn</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="1728">
        <name>$include_attrs</name>
        <default><![CDATA[0]]></default>
        <type/>
      </argument>
      <argument line="1728">
        <name>$decode</name>
        <default><![CDATA[false]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="1750" package="phpLDAPadmin">
      <name>rdn_explode</name>
      <full_name>\rdn_explode</full_name>
      <docblock line="1747">
        <description><![CDATA[Split an RDN into its attributes]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
      <argument line="1750">
        <name>$rdn</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="1786" package="phpLDAPadmin">
      <name>pla_verbose_error</name>
      <full_name>\pla_verbose_error</full_name>
      <docblock line="1771">
        <description><![CDATA[Given an LDAP error number, returns a verbose description of the error.]]></description>
        <long-description><![CDATA[<p>This function parses ldap_error_codes.txt and looks up the specified
ldap error number, and returns the verbose message defined in that file.</p>

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

<pre><code> Array (
   [title] => All Operational Attribute
   [ref] => RFC 3673
   [desc] => An LDAP extension which clients may use to request the return of all operational attributes.
 )
</code></pre>]]></long-description>
        <tag line="1822" name="param" description="The OID number (ie, &quot;1.3.6.1.4.1.4203.1.5.1&quot;) of the OID of interest." type="string" variable="$key">
          <type by_reference="false">string</type>
        </tag>
        <tag line="1822" name="return" description="An associative array contianing the OID title and description like so:" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="1838">
        <name>$key</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="1885" package="phpLDAPadmin">
      <name>ldap_error_msg</name>
      <full_name>\ldap_error_msg</full_name>
      <docblock line="1882">
        <description><![CDATA[Print an LDAP error message]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
      <argument line="1885">
        <name>$msg</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="1885">
        <name>$errnum</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="1930" package="phpLDAPadmin">
      <name>draw_jpeg_photo</name>
      <full_name>\draw_jpeg_photo</full_name>
      <docblock line="1910">
        <description><![CDATA[Draw the jpegPhoto image(s) for an entry wrapped in HTML.]]></description>
        <long-description><![CDATA[<p>Many options are available to
specify how the images are to be displayed.</p>

<p>Usage Examples:</p>

<pre><code>  draw_jpeg_photo(0,'cn=Bob,ou=People,dc=example,dc=com',"jpegPhoto",0,true,array('img_opts'=>"border: 1px; width: 150px"));
  draw_jpeg_photo(1,'cn=Fred,ou=People,dc=example,dc=com',null,1);
 </code></pre>]]></long-description>
        <tag line="1910" name="param" description="The Server to get the image from." type="object" variable="$server">
          <type by_reference="false">object</type>
        </tag>
        <tag line="1910" name="param" description="The DN of the entry that contains the jpeg attribute you want to draw." type="string" variable="$dn">
          <type by_reference="false">string</type>
        </tag>
        <tag line="1910" name="param" description="The name of the attribute containing the jpeg data (usually 'jpegPhoto')." type="string" variable="$attr_name">
          <type by_reference="false">string</type>
        </tag>
        <tag line="1910" name="param" description="Index of the attribute to draw" type="int" variable="$index">
          <type by_reference="false">int</type>
        </tag>
        <tag line="1910" name="param" description="If true, draws a button beneath the image titled 'Delete' allowing the user to delete the jpeg attribute by calling JavaScript function deleteAttribute() provided in the default modification template." type="boolean" variable="$draw_delete_buttons">
          <type by_reference="false">boolean</type>
        </tag>
        <tag line="1910" name="param" description="Specifies optional image and CSS style attributes for the table tag. Supported keys are fixed_width, fixed_height, img_opts." type="array" variable="$options">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="1930">
        <name>$server</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="1930">
        <name>$dn</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="1930">
        <name>$attr_name</name>
        <default><![CDATA['jpegphoto']]></default>
        <type/>
      </argument>
      <argument line="1930">
        <name>$index</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="1930">
        <name>$draw_delete_buttons</name>
        <default><![CDATA[false]]></default>
        <type/>
      </argument>
      <argument line="1930">
        <name>$options</name>
        <default><![CDATA[array()]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="2022" package="phpLDAPadmin">
      <name>password_types</name>
      <full_name>\password_types</full_name>
      <docblock line="2017">
        <description><![CDATA[Return the list of available password types]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="2017" name="todo" description="Dynamically work this list out so we only present hashes that we can encrypt"/>
      </docblock>
    </function>
    <function namespace="global" line="2044" package="phpLDAPadmin">
      <name>password_hash</name>
      <full_name>\password_hash</full_name>
      <docblock line="2036">
        <description><![CDATA[Hashes a password and returns the hash based on the specified enc_type.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="2036" name="param" description="The password to hash in clear text." type="string" variable="$password_clear">
          <type by_reference="false">string</type>
        </tag>
        <tag line="2036" name="param" description="Standard LDAP encryption type which must be one of crypt, ext_des, md5crypt, blowfish, md5, sha, smd5, ssha, or clear." type="string" variable="$enc_type">
          <type by_reference="false">string</type>
        </tag>
        <tag line="2036" name="return" description="The hashed password." type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="2044">
        <name>$password_clear</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="2044">
        <name>$enc_type</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="2095" package="phpLDAPadmin">
      <name>password_check</name>
      <full_name>\password_check</full_name>
      <docblock line="2087">
        <description><![CDATA[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.]]></description>
        <long-description><![CDATA[<p>This is handy to verify a user's password
when all that is given is the hash and a "guess".</p>]]></long-description>
        <tag line="2087" name="param" description="The hash." type="String" variable="$cryptedpassword">
          <type by_reference="false">String</type>
        </tag>
        <tag line="2087" name="param" description="The password in clear text to test." type="String" variable="$plainpassword">
          <type by_reference="false">String</type>
        </tag>
        <tag line="2087" name="return" description="True if the clear password matches the hash, and false otherwise." type="Boolean">
          <type by_reference="false">Boolean</type>
        </tag>
      </docblock>
      <argument line="2095">
        <name>$cryptedpassword</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="2095">
        <name>$plainpassword</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="2095">
        <name>$attribute</name>
        <default><![CDATA['userpassword']]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="2249" package="phpLDAPadmin">
      <name>get_enc_type</name>
      <full_name>\get_enc_type</full_name>
      <docblock line="2239">
        <description><![CDATA[Detects password encryption type]]></description>
        <long-description><![CDATA[<p>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.</p>]]></long-description>
        <tag line="2239" name="param" description="Hashed password" type="string" variable="$user_password">
          <type by_reference="false">string</type>
        </tag>
        <tag line="2239" name="return" description="" type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="2249">
        <name>$user_password</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="2288" package="phpLDAPadmin">
      <name>draw_chooser_link</name>
      <full_name>\draw_chooser_link</full_name>
      <docblock line="2278">
        <description><![CDATA[Draws an HTML browse button which, when clicked, pops up a DN chooser dialog.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="2278" name="param" description="The name of the form element to which this chooser dialog will publish the user's choice. The form element must be a member of a form with the &quot;name&quot; or &quot;id&quot; attribute set in the form tag, and the element must also define &quot;name&quot; or &quot;id&quot; for JavaScript to uniquely identify it. Example $form_element values may include &quot;creation_form.container&quot; or &quot;edit_form.member_uid&quot;. See /templates/modification/default.php for example usage." type="string" variable="$form">
          <type by_reference="false">string</type>
        </tag>
        <tag line="2278" name="param" description="(optional) If true, the function draws the localized text &quot;choose&quot; to the right of the button." type="boolean" variable="$element">
          <type by_reference="false">boolean</type>
        </tag>
      </docblock>
      <argument line="2288">
        <name>$form</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="2288">
        <name>$element</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="2288">
        <name>$include_choose_text</name>
        <default><![CDATA[true]]></default>
        <type/>
      </argument>
      <argument line="2288">
        <name>$rdn</name>
        <default><![CDATA['none']]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="2319" package="phpLDAPadmin">
      <name>pla_explode_dn</name>
      <full_name>\pla_explode_dn</full_name>
      <docblock line="2301">
        <description><![CDATA[Explode a DN into an array of its RDN parts.]]></description>
        <long-description><![CDATA[<p>NOTE: When a multivalue RDN is passed to ldap_explode_dn, the results returns with 'value + value';</p>

<pre><code> Array (
   [0] => uid=ppratt
   [1] => ou=People
   [2] => dc=example
   [3] => dc=com
 )
</code></pre>]]></long-description>
        <tag line="2301" name="param" description="The DN to explode." type="string" variable="$dn">
          <type by_reference="false">string</type>
        </tag>
        <tag line="2301" name="param" description="(optional) Whether to include attribute names (see http://php.net/ldap_explode_dn for details)" type="int" variable="$with_attributes">
          <type by_reference="false">int</type>
        </tag>
        <tag line="2301" name="return" description="An array of RDN parts of this format:" type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="2319">
        <name>$dn</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="2319">
        <name>$with_attributes</name>
        <default><![CDATA[0]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="2367" package="phpLDAPadmin">
      <name>dn_escape</name>
      <full_name>\dn_escape</full_name>
      <docblock line="2364">
        <description><![CDATA[Parse a DN and escape any special characters]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
      <argument line="2367">
        <name>$dn</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="2388" package="phpLDAPadmin">
      <name>dn_unescape</name>
      <full_name>\dn_unescape</full_name>
      <docblock line="2385">
        <description><![CDATA[Parse a DN and unescape any special characters]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
      <argument line="2388">
        <name>$dn</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="2413" package="phpLDAPadmin">
      <name>get_href</name>
      <full_name>\get_href</full_name>
      <docblock line="2405">
        <description><![CDATA[Fetches the URL for the specified item.]]></description>
        <long-description><![CDATA[<p>This is a convenience function for
fetching project HREFs (like bugs)</p>]]></long-description>
        <tag line="2405" name="param" description="One of &quot;open_bugs&quot;, &quot;add_bug&quot;, &quot;donate&quot;, or &quot;add_rfe&quot; (rfe = request for enhancement)" type="string" variable="$type">
          <type by_reference="false">string</type>
        </tag>
        <tag line="2405" name="return" description="The URL to the requested item." type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="2413">
        <name>$type</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="2413">
        <name>$extra_info</name>
        <default><![CDATA['']]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="2455" package="phpLDAPadmin">
      <name>utime</name>
      <full_name>\utime</full_name>
      <docblock line="2450">
        <description><![CDATA[Returns the current time as a double (including micro-seconds).]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="2450" name="return" description="The current time in seconds since the beginning of the UNIX epoch (Midnight Jan. 1, 1970)" type="double">
          <type by_reference="false">double</type>
        </tag>
      </docblock>
    </function>
    <function namespace="global" line="2481" package="phpLDAPadmin">
      <name>array_to_query_string</name>
      <full_name>\array_to_query_string</full_name>
      <docblock line="2462">
        <description><![CDATA[Converts an array to a query-string with the option to exclude certain variables
from the returned query string.]]></description>
        <long-description><![CDATA[<p>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.</p>]]></long-description>
        <tag line="2462" name="param" description="The associate array to convert whose form is such that the keys are the names of the variables and the values are said variables' values like this: &lt;code&gt; Array ( [server_id] = 0, [dn] = &quot;dc=example,dc=com&quot;, [attr] = &quot;sn&quot; ) &lt;/code&gt; This will produce a string like this: &quot;server_id=0&amp;dn=dc=example,dc=com&amp;attr=sn&quot;" type="array" variable="$array">
          <type by_reference="false">array</type>
        </tag>
        <tag line="2462" name="param" description="(optional) An array of variables to exclude in the resulting string" type="array" variable="$exclude_vars">
          <type by_reference="false">array</type>
        </tag>
        <tag line="2462" name="return" description="The string created from the array." type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="2481">
        <name>$array</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="2481">
        <name>$exclude_vars</name>
        <default><![CDATA[array()]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="2528" package="phpLDAPadmin">
      <name>pla_reverse_dn</name>
      <full_name>\pla_reverse_dn</full_name>
      <docblock line="2510">
        <description><![CDATA[Reverses a DN such that the top-level RDN is first and the bottom-level RDN is last
For example:
<code>
  cn=Brigham,ou=People,dc=example,dc=com
</code>
Becomes:
<code>
  dc=com,dc=example,ou=People,cn=Brigham
</code>
This makes it possible to sort lists of DNs such that they are grouped by container.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="2510" name="param" description="The DN to reverse" type="string" variable="$dn">
          <type by_reference="false">string</type>
        </tag>
        <tag line="2510" name="return" description="The reversed DN" type="string">
          <type by_reference="false">string</type>
        </tag>
        <tag line="2510" name="see" description="\global\pla_compare_dns" refers="\global\pla_compare_dns"/>
        <tag line="2510" name="see" description="\global\pla_explode_dns" refers="\global\pla_explode_dns"/>
      </docblock>
      <argument line="2528">
        <name>$dn</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="2538" package="phpLDAPadmin">
      <name>sortAttrs</name>
      <full_name>\sortAttrs</full_name>
      <docblock line="2535">
        <description><![CDATA[Attribute sorting]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
      <argument line="2538">
        <name>$a</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="2538">
        <name>$b</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="2551" package="phpLDAPadmin">
      <name>arrayLower</name>
      <full_name>\arrayLower</full_name>
      <docblock line="2545">
        <description><![CDATA[Reads an array and returns the array values back in lower case]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="2545" name="param" description="The array to convert the values to lowercase." type="array" variable="$array">
          <type by_reference="false">array</type>
        </tag>
        <tag line="2545" name="returns" description="array Array with values converted to lowercase."/>
      </docblock>
      <argument line="2551">
        <name>$array</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="2568" package="phpLDAPadmin">
      <name>draw_formatted_dn</name>
      <full_name>\draw_formatted_dn</full_name>
      <docblock line="2565">
        <description><![CDATA[Gets a DN string using the user-configured tree_display_format string to format it.]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
      <argument line="2568">
        <name>$server</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="2568">
        <name>$entry</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="2626" package="phpLDAPadmin">
      <name>server_select_list</name>
      <full_name>\server_select_list</full_name>
      <docblock line="2623">
        <description><![CDATA[Server html select list]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
      <argument line="2626">
        <name>$selected</name>
        <default><![CDATA[null]]></default>
        <type/>
      </argument>
      <argument line="2626">
        <name>$logged_on</name>
        <default><![CDATA[false]]></default>
        <type/>
      </argument>
      <argument line="2626">
        <name>$name</name>
        <default><![CDATA['index']]></default>
        <type/>
      </argument>
      <argument line="2626">
        <name>$isVisible</name>
        <default><![CDATA[true]]></default>
        <type/>
      </argument>
      <argument line="2626">
        <name>$js</name>
        <default><![CDATA[null]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="2664" package="phpLDAPadmin">
      <name>littleEndian</name>
      <full_name>\littleEndian</full_name>
      <docblock line="2661">
        <description><![CDATA[Converts a little-endian hex-number to one, that 'hexdec' can convert]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
      <argument line="2664">
        <name>$hex</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="2676" package="phpLDAPadmin">
      <name>binSIDtoText</name>
      <full_name>\binSIDtoText</full_name>
      <argument line="2676">
        <name>$binsid</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="2707" package="phpLDAPadmin">
      <name>return_ldap_hash</name>
      <full_name>\return_ldap_hash</full_name>
      <docblock line="2695">
        <description><![CDATA[Query LDAP and return a hash.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="2695" name="param" description="The base DN to use." type="string" variable="$base">
          <type by_reference="false">string</type>
        </tag>
        <tag line="2695" name="param" description="LDAP Query filter." type="string" variable="$filter">
          <type by_reference="false">string</type>
        </tag>
        <tag line="2695" name="param" description="LDAP attribute to use as key." type="string" variable="$key">
          <type by_reference="false">string</type>
        </tag>
        <tag line="2695" name="param" description="Attributes to use as values." type="array" variable="$attrs">
          <type by_reference="false">array</type>
        </tag>
        <tag line="2695" name="param" description="Specify false to not sort results by DN or true to have the returned array sorted by DN (uses ksort) or an array of attribute names to sort by attribute values" type="boolean" variable="$sort">
          <type by_reference="false">boolean</type>
        </tag>
        <tag line="2695" name="return" description="Array of values keyed by $key." type="array">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="2707">
        <name>$base</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="2707">
        <name>$filter</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="2707">
        <name>$key</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="2707">
        <name>$attrs</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="2707">
        <name>$sort</name>
        <default><![CDATA[true]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="2756" package="phpLDAPadmin">
      <name>password_generate</name>
      <full_name>\password_generate</full_name>
      <docblock line="2752">
        <description><![CDATA[This function returns a string automatically generated
based on the criteria defined in the array $criteria in config.php]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </function>
    <function namespace="global" line="2838" package="phpLDAPadmin">
      <name>a_array_rand</name>
      <full_name>\a_array_rand</full_name>
      <docblock line="2830">
        <description><![CDATA[This function returns an array of $num_req values
randomly picked from the $input array]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="2830" name="param" description="Array of values" type="array" variable="$input">
          <type by_reference="false">array</type>
        </tag>
        <tag line="2830" name="param" description="Number of values in returned array" type="integer" variable="$num_req">
          <type by_reference="false">integer</type>
        </tag>
        <tag line="2830" name="return" description="The padded string" type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="2838">
        <name>$input</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="2838">
        <name>$num_req</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="2875" package="phpLDAPadmin">
      <name>random_junk</name>
      <full_name>\random_junk</full_name>
      <docblock line="2870">
        <description><![CDATA[This is for Opera.]]></description>
        <long-description><![CDATA[<p>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</p>]]></long-description>
      </docblock>
    </function>
    <function namespace="global" line="2886" package="phpLDAPadmin">
      <name>htmlid</name>
      <full_name>\htmlid</full_name>
      <docblock line="2880">
        <description><![CDATA[Returns a HTML id that can be used in the URL after the #.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="2880" name="param" description="The DN to pretty-print." type="string" variable="$sid">
          <type by_reference="false">string</type>
        </tag>
        <tag line="2880" name="return" description="" type="string">
          <type by_reference="false">string</type>
        </tag>
      </docblock>
      <argument line="2886">
        <name>$sid</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="2886">
        <name>$dn</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="2893" package="phpLDAPadmin">
      <name>isAjaxEnabled</name>
      <full_name>\isAjaxEnabled</full_name>
      <docblock line="2890">
        <description><![CDATA[Is PLA configured for AJAX display]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </function>
    <parse_markers>
      <error line="51" code="50015">Argument $className is missing from the Docblock of \__autoload()</error>
      <error line="96" code="50009">No DocBlock was found for function \_()</error>
      <error line="181" code="50015">Argument $lang is missing from the Docblock of \auto_lang()</error>
      <error line="194" code="50015">Argument $config_file is missing from the Docblock of \check_config()</error>
      <error line="281" code="50015">Argument $type is missing from the Docblock of \cmd_control_pane()</error>
      <error line="353" code="50015">Argument $onlydebugaddr is missing from the Docblock of \debug_dump()</error>
      <error line="363" code="50015">Argument $die is missing from the Docblock of \debug_dump_backtrace()</error>
      <error line="372" code="50015">Argument $msg is missing from the Docblock of \debug_sysmsg()</error>
      <error line="379" code="50015">Argument $indent is missing from the Docblock of \debug_log()</error>
      <error line="495" code="50015">Argument $msg is missing from the Docblock of \error()</error>
      <error line="495" code="50015">Argument $type is missing from the Docblock of \error()</error>
      <error line="495" code="50015">Argument $redirect is missing from the Docblock of \error()</error>
      <error line="495" code="50015">Argument $fatal is missing from the Docblock of \error()</error>
      <error line="495" code="50015">Argument $backtrace is missing from the Docblock of \error()</error>
      <error line="568" code="50015">Argument $attr is missing from the Docblock of \get_request()</error>
      <error line="568" code="50015">Argument $type is missing from the Docblock of \get_request()</error>
      <error line="568" code="50015">Argument $die is missing from the Docblock of \get_request()</error>
      <error line="568" code="50015">Argument $default is missing from the Docblock of \get_request()</error>
      <error line="604" code="50015">Argument $msg is missing from the Docblock of \system_message()</error>
      <error line="604" code="50015">Argument $redirect is missing from the Docblock of \system_message()</error>
      <error line="788" code="50015">Argument $index is missing from the Docblock of \get_cached_item()</error>
      <error line="788" code="50015">Argument $item is missing from the Docblock of \get_cached_item()</error>
      <error line="788" code="50015">Argument $subitem is missing from the Docblock of \get_cached_item()</error>
      <error line="816" code="50015">Argument $index is missing from the Docblock of \set_cached_item()</error>
      <error line="816" code="50015">Argument $item is missing from the Docblock of \set_cached_item()</error>
      <error line="816" code="50015">Argument $subitem is missing from the Docblock of \set_cached_item()</error>
      <error line="816" code="50015">Argument $data is missing from the Docblock of \set_cached_item()</error>
      <error line="838" code="50015">Argument $index is missing from the Docblock of \del_cached_item()</error>
      <error line="838" code="50015">Argument $item is missing from the Docblock of \del_cached_item()</error>
      <error line="838" code="50015">Argument $subitem is missing from the Docblock of \del_cached_item()</error>
      <error line="892" code="50015">Argument $path is missing from the Docblock of \get_custom_file()</error>
      <error line="1268" code="50015">Argument $startmin is missing from the Docblock of \get_next_number()</error>
      <error line="1476" code="50015">Argument $dn is missing from the Docblock of \get_icon()</error>
      <error line="1476" code="50015">Argument $object_classes is missing from the Docblock of \get_icon()</error>
      <error line="1719" code="50015">Argument $decode is missing from the Docblock of \get_rdn()</error>
      <error line="1747" code="50015">Argument $rdn is missing from the Docblock of \rdn_explode()</error>
      <error line="1882" code="50015">Argument $msg is missing from the Docblock of \ldap_error_msg()</error>
      <error line="1882" code="50015">Argument $errnum is missing from the Docblock of \ldap_error_msg()</error>
      <error line="2087" code="50015">Argument $attribute is missing from the Docblock of \password_check()</error>
      <error line="2278" code="50015">Argument $include_choose_text is missing from the Docblock of \draw_chooser_link()</error>
      <error line="2278" code="50015">Argument $rdn is missing from the Docblock of \draw_chooser_link()</error>
      <error line="2364" code="50015">Argument $dn is missing from the Docblock of \dn_escape()</error>
      <error line="2385" code="50015">Argument $dn is missing from the Docblock of \dn_unescape()</error>
      <error line="2405" code="50015">Argument $extra_info is missing from the Docblock of \get_href()</error>
      <error line="2535" code="50015">Argument $a is missing from the Docblock of \sortAttrs()</error>
      <error line="2535" code="50015">Argument $b is missing from the Docblock of \sortAttrs()</error>
      <error line="2565" code="50015">Argument $server is missing from the Docblock of \draw_formatted_dn()</error>
      <error line="2565" code="50015">Argument $entry is missing from the Docblock of \draw_formatted_dn()</error>
      <error line="2623" code="50015">Argument $selected is missing from the Docblock of \server_select_list()</error>
      <error line="2623" code="50015">Argument $logged_on is missing from the Docblock of \server_select_list()</error>
      <error line="2623" code="50015">Argument $name is missing from the Docblock of \server_select_list()</error>
      <error line="2623" code="50015">Argument $isVisible is missing from the Docblock of \server_select_list()</error>
      <error line="2623" code="50015">Argument $js is missing from the Docblock of \server_select_list()</error>
      <error line="2661" code="50015">Argument $hex is missing from the Docblock of \littleEndian()</error>
      <error line="2676" code="50009">No DocBlock was found for function \binSIDtoText()</error>
      <error line="2880" code="50015">Argument $dn is missing from the Docblock of \htmlid()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/lib/ShadowAttribute.php" hash="6e85ad6847eb72f72a70e1dcfad8d375" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Classes and functions for the template engine.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="15" package="phpLDAPadmin\Templates">
      <extends>\Attribute</extends>
      <name>ShadowAttribute</name>
      <full_name>\ShadowAttribute</full_name>
      <docblock line="9">
        <description><![CDATA[Represents a shadow date attribute]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="9" name="package" description="phpLDAPadmin"/>
        <tag line="9" name="subpackage" description="Templates"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="16" namespace="global" package="main">
        <name>$shadow_before_today_attrs</name>
        <default><![CDATA[array('shadowLastChange', 'shadowMin')]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="17" namespace="global" package="main">
        <name>$shadow_after_today_attrs</name>
        <default><![CDATA[array('shadowMax', 'shadowExpire', 'shadowWarning', 'shadowInactive')]]></default>
      </property>
    </class>
    <parse_markers>
      <error line="16" code="50018">No DocBlock was found for property $shadow_before_today_attrs</error>
      <error line="17" code="50018">No DocBlock was found for property $shadow_after_today_attrs</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/lib/hooks.php" hash="12fa438edce899c361d34e31ba49db1f" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Functions related to hooks management.]]></description>
      <long-description><![CDATA[<p>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.</p>

<p>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.</p>

<p>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</p>]]></long-description>
      <tag line="2" name="author" description="Benjamin Drieu &lt;benjamin.drieu@fr.alcove.com&gt; and Alc�?ve"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <include line="196" type="Require Once" package="main">
      <name/>
    </include>
    <function namespace="global" line="34" package="phpLDAPadmin">
      <name>sort_array_by_priority</name>
      <full_name>\sort_array_by_priority</full_name>
      <docblock line="24">
        <description><![CDATA[Compares two arrays by numerically comparing their 'prority'
value.]]></description>
        <long-description><![CDATA[<p>Standard `cmp-like' function.</p>]]></long-description>
        <tag line="24" name="param" description="First element to compare." type="\a" variable="$a">
          <type by_reference="false">\a</type>
        </tag>
        <tag line="24" name="param" description="Second element to compare." type="\b" variable="$b">
          <type by_reference="false">\b</type>
        </tag>
        <tag line="24" name="return" description="if priority of first element is smaller than second element priority. 1 otherwise." type="\-1">
          <type by_reference="false">\-1</type>
        </tag>
      </docblock>
      <argument line="34">
        <name>$a</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="34">
        <name>$b</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="52" package="phpLDAPadmin">
      <name>run_hook</name>
      <full_name>\run_hook</full_name>
      <docblock line="41">
        <description><![CDATA[Runs procedures attached to a hook.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="41" name="param" description="Name of hook to run." type="\hook_name" variable="$hook_name">
          <type by_reference="false">\hook_name</type>
        </tag>
        <tag line="41" name="param" description="Array of optional arguments set by phpldapadmin. It is normally in a form known by call_user_func_array() : &lt;pre&gt;[ 'server_id' =&gt; 0, 'dn' =&gt; 'uid=epoussa,ou=tech,o=corp,o=fr' ]&lt;/pre&gt;" type="\args" variable="$args">
          <type by_reference="false">\args</type>
        </tag>
        <tag line="41" name="return" description="if all procedures returned true, false otherwise." type="true">
          <type by_reference="false">true</type>
        </tag>
      </docblock>
      <argument line="52">
        <name>$hook_name</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="52">
        <name>$args</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="119" package="phpLDAPadmin">
      <name>add_hook</name>
      <full_name>\add_hook</full_name>
      <docblock line="111">
        <description><![CDATA[Adds a procedure to a hook for later execution.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="111" name="param" description="Name of the hook." type="\hook_name" variable="$hook_name">
          <type by_reference="false">\hook_name</type>
        </tag>
        <tag line="111" name="param" description="Name of the php function called upon hook trigger." type="\hook_function" variable="$hook_function">
          <type by_reference="false">\hook_function</type>
        </tag>
        <tag line="111" name="param" description="Numeric priority. Lowest means procedure will be executed before." type="\priority" variable="$priority">
          <type by_reference="false">\priority</type>
        </tag>
        <tag line="111" name="param" description="Name of the php rollback function called upon failure." type="\rollback_function" variable="$rollback_function">
          <type by_reference="false">\rollback_function</type>
        </tag>
      </docblock>
      <argument line="119">
        <name>$hook_name</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="119">
        <name>$hook_function</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="119">
        <name>$priority</name>
        <default><![CDATA[0]]></default>
        <type/>
      </argument>
      <argument line="119">
        <name>$rollback_function</name>
        <default><![CDATA[null]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="155" package="phpLDAPadmin">
      <name>remove_hook</name>
      <full_name>\remove_hook</full_name>
      <docblock line="146">
        <description><![CDATA[Removes a procedure from a hook, based on a filter.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="146" name="param" description="Name of the hook." type="\hook_name" variable="$hook_name">
          <type by_reference="false">\hook_name</type>
        </tag>
        <tag line="146" name="param" description="Numeric priority. If set, all procedures of that priority will be removed." type="\priority" variable="$hook_function">
          <type by_reference="false">\priority</type>
        </tag>
        <tag line="146" name="param" description="Name of the procedure function. If set, all procedures that call this function will be removed." type="\hook_function" variable="$priority">
          <type by_reference="false">\hook_function</type>
        </tag>
        <tag line="146" name="param" description="Name of the php rollback function called upon failure. If set, all procedures that call this function as a rollback will be removed." type="\rollback_function" variable="$rollback_function">
          <type by_reference="false">\rollback_function</type>
        </tag>
      </docblock>
      <argument line="155">
        <name>$hook_name</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="155">
        <name>$hook_function</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="155">
        <name>$priority</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="155">
        <name>$rollback_function</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="178" package="phpLDAPadmin">
      <name>clear_hooks</name>
      <full_name>\clear_hooks</full_name>
      <docblock line="173">
        <description><![CDATA[Removes all procedures from a hook.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="173" name="param" description="Name of hook to clear." type="\hook_name" variable="$hook_name">
          <type by_reference="false">\hook_name</type>
        </tag>
      </docblock>
      <argument line="178">
        <name>$hook_name</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
  </file>
  <file path="templates/3rdParty/pla/lib/syslog.php" hash="252370b42bdb909e86ff1e70f36345f5" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Functions related to syslog logging.]]></description>
      <long-description><![CDATA[<p>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.</p>

<p>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.</p>

<p>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</p>]]></long-description>
      <tag line="2" name="author" description="Benjamin Drieu &lt;benjamin.drieu@fr.alcove.com&gt; and Alcôve"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <function namespace="global" line="41" package="phpLDAPadmin">
      <name>syslog_msg</name>
      <full_name>\syslog_msg</full_name>
      <docblock line="33">
        <description><![CDATA[Verify that syslog logging is activated in the config via the
debug->syslog variable and does a call to the syslog() function is it
is true.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="33" name="param" description="Syslog emergency." type="\emergency" variable="$emergency">
          <type by_reference="false">\emergency</type>
        </tag>
        <tag line="33" name="param" description="String to log." type="\log_string" variable="$log_string">
          <type by_reference="false">\log_string</type>
        </tag>
      </docblock>
      <argument line="41">
        <name>$emergency</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="41">
        <name>$log_string</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="54" package="phpLDAPadmin">
      <name>syslog_err</name>
      <full_name>\syslog_err</full_name>
      <docblock line="48">
        <description><![CDATA[Issue an error message via syslog.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="48" name="param" description="Log message to send to syslog." type="\log_string" variable="$log_string">
          <type by_reference="false">\log_string</type>
        </tag>
        <tag line="48" name="return" description="on success." type="true">
          <type by_reference="false">true</type>
        </tag>
      </docblock>
      <argument line="54">
        <name>$log_string</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="64" package="phpLDAPadmin">
      <name>syslog_warning</name>
      <full_name>\syslog_warning</full_name>
      <docblock line="58">
        <description><![CDATA[Issue a warning message via syslog.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="58" name="param" description="Log message to send to syslog." type="\log_string" variable="$log_string">
          <type by_reference="false">\log_string</type>
        </tag>
        <tag line="58" name="return" description="on success." type="true">
          <type by_reference="false">true</type>
        </tag>
      </docblock>
      <argument line="64">
        <name>$log_string</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="74" package="phpLDAPadmin">
      <name>syslog_notice</name>
      <full_name>\syslog_notice</full_name>
      <docblock line="68">
        <description><![CDATA[Issue a notice message via syslog.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="68" name="param" description="Log message to send to syslog." type="\log_string" variable="$log_string">
          <type by_reference="false">\log_string</type>
        </tag>
        <tag line="68" name="return" description="on success." type="true">
          <type by_reference="false">true</type>
        </tag>
      </docblock>
      <argument line="74">
        <name>$log_string</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="85" package="phpLDAPadmin">
      <name>syslog_debug</name>
      <full_name>\syslog_debug</full_name>
      <docblock line="78">
        <description><![CDATA[Issue a debug message via syslog, only if $log_level is set to
'debug' from the config file.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="78" name="param" description="Log message to send to syslog." type="\log_string" variable="$log_string">
          <type by_reference="false">\log_string</type>
        </tag>
        <tag line="78" name="return" description="on success or if debug log is not activated." type="true">
          <type by_reference="false">true</type>
        </tag>
      </docblock>
      <argument line="85">
        <name>$log_string</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
  </file>
  <file path="templates/3rdParty/pla/lib/RandomPasswordAttribute.php" hash="37fea1fca0f8dc518049e80f525f75e2" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Classes and functions for the template engine.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="15" package="phpLDAPadmin\Templates">
      <extends>\PasswordAttribute</extends>
      <name>RandomPasswordAttribute</name>
      <full_name>\RandomPasswordAttribute</full_name>
      <docblock line="9">
        <description><![CDATA[Represents an attribute whose values are random passwords]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="9" name="package" description="phpLDAPadmin"/>
        <tag line="9" name="subpackage" description="Templates"/>
      </docblock>
    </class>
  </file>
  <file path="templates/3rdParty/pla/lib/JpegAttribute.php" hash="d58f92e08c97dfb8f6bc0838b0ccb593" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Classes and functions for the template engine.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="15" package="phpLDAPadmin\Templates">
      <extends>\BinaryAttribute</extends>
      <name>JpegAttribute</name>
      <full_name>\JpegAttribute</full_name>
      <docblock line="9">
        <description><![CDATA[Represents an attribute whose values are jpeg pictures]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="9" name="package" description="phpLDAPadmin"/>
        <tag line="9" name="subpackage" description="Templates"/>
      </docblock>
    </class>
  </file>
  <file path="templates/3rdParty/pla/lib/query_functions.php" hash="994b6ab1504333803d05a7818e950b64" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Classes and functions for searching the LDAP server]]></description>
      <long-description><![CDATA[<p>These classes and functions will read our XML search files, for defined
search reports.</p>]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="20" package="phpLDAPadmin\Queries">
      <extends>\xmlTemplates</extends>
      <name>Queries</name>
      <full_name>\Queries</full_name>
      <docblock line="12">
        <description><![CDATA[Query Class]]></description>
        <long-description><![CDATA[<p>This class will store all our pre-defined search definitions.</p>]]></long-description>
        <tag line="12" name="package" description="phpLDAPadmin"/>
        <tag line="12" name="subpackage" description="Queries"/>
      </docblock>
    </class>
  </file>
  <file path="templates/3rdParty/pla/lib/xmlTemplates.php" hash="3bea3a131b8bee474f64afcd1132e9f4" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Classes and functions for XML based templates.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="15" package="phpLDAPadmin\Templates">
      <extends/>
      <name>xmlTemplates</name>
      <full_name>\xmlTemplates</full_name>
      <docblock line="9">
        <description><![CDATA[XML Templates Class]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="9" name="package" description="phpLDAPadmin"/>
        <tag line="9" name="subpackage" description="Templates"/>
      </docblock>
      <property final="false" static="false" visibility="protected" line="17" namespace="global" package="main">
        <name>$server_id</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="19" namespace="global" package="main">
        <name>$templates</name>
        <default><![CDATA[array()]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="21" package="phpLDAPadmin\Templates">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <argument line="21">
          <name>$server_id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="153" package="phpLDAPadmin\Templates">
        <name>getClassVars</name>
        <full_name>getClassVars</full_name>
        <docblock line="150">
          <description><![CDATA[This will return our custom class variables, used by the parent to create objects.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="193" package="phpLDAPadmin\Templates">
        <name>getTemplates</name>
        <full_name>getTemplates</full_name>
        <docblock line="185">
          <description><![CDATA[Return a list of templates by their type
This function should return a sorted list, as the array is built sorted.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="185" name="param" description="Type of template, eg: creation, modification" type="string" variable="$type">
            <type by_reference="false">string</type>
          </tag>
          <tag line="185" name="param" description="Exclude templates purposely disabled." type="boolean" variable="$container">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="185" name="return" description="List of templates of the type" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="193">
          <name>$type</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="193">
          <name>$container</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="193">
          <name>$disabled</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="225" package="phpLDAPadmin\Templates">
        <name>getTemplate</name>
        <full_name>getTemplate</full_name>
        <docblock line="219">
          <description><![CDATA[Return a template by its ID]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="219" name="param" description="The template ID as it was when it was generated (normally used in $_REQUEST vars)." type="string" variable="$templateid">
            <type by_reference="false">string</type>
          </tag>
          <tag line="219" name="return" description="Template (or default template if the ID doesnt exist)" type="object">
            <type by_reference="false">object</type>
          </tag>
        </docblock>
        <argument line="225">
          <name>$templateid</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="244" package="phpLDAPadmin\Templates">
        <name>getTemplateFiles</name>
        <full_name>getTemplateFiles</full_name>
        <docblock line="241">
          <description><![CDATA[Get a list of template filenames.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="263" package="phpLDAPadmin\Templates">
      <extends/>
      <name>xmlTemplate</name>
      <full_name>\xmlTemplate</full_name>
      <docblock line="257">
        <description><![CDATA[XML Template Class]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="257" name="package" description="phpLDAPadmin"/>
        <tag line="257" name="subpackage" description="Templates"/>
      </docblock>
      <property final="false" static="false" visibility="protected" line="265" namespace="global" package="main">
        <name>$server_id</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="267" namespace="global" package="main">
        <name>$id</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="269" namespace="global" package="main">
        <name>$name</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="271" namespace="global" package="main">
        <name>$type</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="273" namespace="global" package="main">
        <name>$readtime</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="275" namespace="global" package="main">
        <name>$filename</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="277" namespace="global" package="main">
        <name>$attributes</name>
        <default><![CDATA[array()]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="279" package="phpLDAPadmin\Templates">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <argument line="279">
          <name>$server_id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="279">
          <name>$name</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="279">
          <name>$filename</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="279">
          <name>$type</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="279">
          <name>$id</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="306" package="phpLDAPadmin\Templates">
        <name>getAttrID</name>
        <full_name>getAttrID</full_name>
        <docblock line="300">
          <description><![CDATA[Get an attribute ID]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="300" name="param" description="The Attribute being searched." type="string" variable="$attr">
            <type by_reference="false">string</type>
          </tag>
          <tag line="300" name="return" description="Attribute ID in the array" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
        <argument line="306">
          <name>$attr</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="320" package="phpLDAPadmin\Templates">
        <name>getFileName</name>
        <full_name>getFileName</full_name>
        <docblock line="317">
          <description><![CDATA[Get the Template filename.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="330" package="phpLDAPadmin\Templates">
        <name>getID</name>
        <full_name>getID</full_name>
        <docblock line="327">
          <description><![CDATA[Return the template by ID]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="345" package="phpLDAPadmin\Templates">
        <name>getName</name>
        <full_name>getName</full_name>
        <docblock line="340">
          <description><![CDATA[Return the template name]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="340" name="param" description="Force the name to be lowercase (default)" type="boolean" variable="$lower">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="345">
          <name>$lower</name>
          <default><![CDATA[true]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="358" package="phpLDAPadmin\Templates">
        <name>getReadTime</name>
        <full_name>getReadTime</full_name>
        <docblock line="355">
          <description><![CDATA[Get the Template read time.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="370" package="phpLDAPadmin\Templates">
        <name>getServer</name>
        <full_name>getServer</full_name>
        <docblock line="365">
          <description><![CDATA[Return this LDAP Server object]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="365" name="return" description="DataStore Server" type="object">
            <type by_reference="false">object</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="382" package="phpLDAPadmin\Templates">
        <name>getServerID</name>
        <full_name>getServerID</full_name>
        <docblock line="377">
          <description><![CDATA[Return the LDAP server ID]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="377" name="return" description="Server ID" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="394" package="phpLDAPadmin\Templates">
        <name>isType</name>
        <full_name>isType</full_name>
        <docblock line="389">
          <description><![CDATA[Test if a template is of a type]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="389" name="return" description="" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="394">
          <name>$type</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="407" package="phpLDAPadmin\Templates">
        <name>getType</name>
        <full_name>getType</full_name>
        <docblock line="404">
          <description><![CDATA[Return the template type]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="417" package="phpLDAPadmin\Templates">
        <name>getTitle</name>
        <full_name>getTitle</full_name>
        <docblock line="414">
          <description><![CDATA[Get template title]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="432" package="phpLDAPadmin\Templates">
        <name>addAttribute</name>
        <full_name>addAttribute</full_name>
        <docblock line="427">
          <description><![CDATA[Add another attribute to this template]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="427" name="return" description="Attribute ID" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
        <argument line="432">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="432">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="432">
          <name>$source</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="465" package="phpLDAPadmin\Templates">
        <name>getAttributeNames</name>
        <full_name>getAttributeNames</full_name>
        <docblock line="460">
          <description><![CDATA[Get the attribute names]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="460" name="return" description="Array of attributes Names" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="483" package="phpLDAPadmin\Templates">
        <name>getAttribute</name>
        <full_name>getAttribute</full_name>
        <docblock line="477">
          <description><![CDATA[Get a specific Attribute]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="477" name="param" description="Name of attribute to retrieve" type="string" variable="$name">
            <type by_reference="false">string</type>
          </tag>
          <tag line="477" name="return" description="Attribute" type="object">
            <type by_reference="false">object</type>
          </tag>
        </docblock>
        <argument line="483">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="497" package="phpLDAPadmin\Templates">
        <name>isAdminDisabled</name>
        <full_name>isAdminDisabled</full_name>
        <docblock line="494">
          <description><![CDATA[May be overloaded in other classes]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
    </class>
    <parse_markers>
      <error line="17" code="50018">No DocBlock was found for property $server_id</error>
      <error line="19" code="50018">No DocBlock was found for property $templates</error>
      <error line="21" code="50010">No DocBlock was found for method __construct()</error>
      <error line="185" code="50015">Argument $disabled is missing from the Docblock of getTemplates()</error>
      <error line="265" code="50018">No DocBlock was found for property $server_id</error>
      <error line="267" code="50018">No DocBlock was found for property $id</error>
      <error line="269" code="50018">No DocBlock was found for property $name</error>
      <error line="271" code="50018">No DocBlock was found for property $type</error>
      <error line="273" code="50018">No DocBlock was found for property $readtime</error>
      <error line="275" code="50018">No DocBlock was found for property $filename</error>
      <error line="277" code="50018">No DocBlock was found for property $attributes</error>
      <error line="279" code="50010">No DocBlock was found for method __construct()</error>
      <error line="389" code="50015">Argument $type is missing from the Docblock of isType()</error>
      <error line="427" code="50015">Argument $name is missing from the Docblock of addAttribute()</error>
      <error line="427" code="50015">Argument $value is missing from the Docblock of addAttribute()</error>
      <error line="427" code="50015">Argument $source is missing from the Docblock of addAttribute()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/lib/ds_ldap_pla.php" hash="b5a19294940a76ccadca399941d94d95" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Classes and functions for communication of Data Stores]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="15" package="phpLDAPadmin\DataStore">
      <extends>\myldap</extends>
      <name>ldap_pla</name>
      <full_name>\ldap_pla</full_name>
      <docblock line="9">
        <description><![CDATA[This abstract class provides variables and methods for LDAP datastores for use by PLA.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="9" name="package" description="phpLDAPadmin"/>
        <tag line="9" name="subpackage" description="DataStore"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="17" namespace="global" package="main">
        <name>$force_may</name>
        <default><![CDATA[array()]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="19" package="phpLDAPadmin\DataStore">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <argument line="19">
          <name>$index</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="130" package="phpLDAPadmin\DataStore">
        <name>__get</name>
        <full_name>__get</full_name>
        <argument line="130">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="158" package="phpLDAPadmin\DataStore">
        <name>isShowCreateEnabled</name>
        <full_name>isShowCreateEnabled</full_name>
        <docblock line="143">
          <description><![CDATA[Gets whether the admin has configured phpLDAPadmin to show the "Create New" link in the tree viewer.]]></description>
          <long-description><![CDATA[<pre><code>$servers->setValue('appearance','show_create',true|false);
</code></pre>

<p>If NOT set, then default to show the Create New item.
If IS set, then return the value (it should be true or false).</p>

<p>The entry creation command must be available.</p>

<pre><code>$config->custom->commands['script'] = array('create' => true);
</code></pre>]]></long-description>
          <tag line="143" name="return" description="true if the feature is enabled and false otherwise." type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="177" package="phpLDAPadmin\DataStore">
        <name>isAnonBindAllowed</name>
        <full_name>isAnonBindAllowed</full_name>
        <docblock line="168">
          <description><![CDATA[Fetch whether the user has configured a certain server login to be non anonymous]]></description>
          <long-description><![CDATA[<pre><code>$servers->setValue('login','anon_bind',true|false);
</code></pre>]]></long-description>
          <tag line="168" name="return" description="" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="203" package="phpLDAPadmin\DataStore">
        <name>isBranchRenameEnabled</name>
        <full_name>isBranchRenameEnabled</full_name>
        <docblock line="193">
          <description><![CDATA[Returns true if the user has configured the specified server to enable branch (non-leaf) renames.]]></description>
          <long-description><![CDATA[<p>This is configured in config.php thus:</p>

<pre><code>$servers->setValue('server','branch_rename',true|false);
</code></pre>]]></long-description>
          <tag line="193" name="return" description="" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="227" package="phpLDAPadmin\DataStore">
        <name>isMultiLineAttr</name>
        <full_name>isMultiLineAttr</full_name>
        <docblock line="210">
          <description><![CDATA[Determines if an attribute's value can contain multiple lines.]]></description>
          <long-description><![CDATA[<p>Attributes that fall
in this multi-line category may be configured in config.php. Hence, this function
accesses the global variable $_SESSION[APPCONFIG]->custom->appearance['multi_line_attributes'];</p>

<p>Usage example:</p>

<pre><code>if ($ldapserver->isMultiLineAttr('postalAddress'))
    echo '<textarea name="postalAddress"></textarea>';
else
    echo '<input name="postalAddress" type="text">';
</code></pre>]]></long-description>
          <tag line="210" name="param" description="The name of the attribute of interested (case insensivite)" type="string" variable="$attr_name">
            <type by_reference="false">string</type>
          </tag>
          <tag line="210" name="param" description="(optional) The current value of the attribute (speeds up the process by searching for carriage returns already in the attribute value)" type="string" variable="$val">
            <type by_reference="false">string</type>
          </tag>
          <tag line="210" name="return" description="" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="227">
          <name>$attr_name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="227">
          <name>$val</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="277" package="phpLDAPadmin\DataStore">
        <name>isAttrTest</name>
        <full_name>isAttrTest</full_name>
        <docblock line="268">
          <description><![CDATA[Returns true if the specified attribute is configured according to
the test enabled in config.php]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="268" name="param" description="The name of the attribute to test." type="string" variable="$attr">
            <type by_reference="false">string</type>
          </tag>
          <tag line="268" name="param" description="The attributes to test against." type="array" variable="$attrs">
            <type by_reference="false">array</type>
          </tag>
          <tag line="268" name="param" description="A DN that is exempt from these tests." type="\dn" variable="$except_dn">
            <type by_reference="false">\dn</type>
          </tag>
          <tag line="268" name="return" description="" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="277">
          <name>$attr</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="277">
          <name>$attrs</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="277">
          <name>$except_dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="304" package="phpLDAPadmin\DataStore">
        <name>isAttrReadOnly</name>
        <full_name>isAttrReadOnly</full_name>
        <docblock line="293">
          <description><![CDATA[Returns true if the specified attribute is configured as read only
in config.php.]]></description>
          <long-description><![CDATA[<p>Attributes are configured as read-only in config.php thus:</p>

<pre><code>$config->custom->appearance['readonly_attrs'] = array('objectClass');
</code></pre>]]></long-description>
          <tag line="293" name="param" description="The name of the attribute to test." type="string" variable="$attr">
            <type by_reference="false">string</type>
          </tag>
          <tag line="293" name="return" description="" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="304">
          <name>$attr</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="325" package="phpLDAPadmin\DataStore">
        <name>isAttrHidden</name>
        <full_name>isAttrHidden</full_name>
        <docblock line="314">
          <description><![CDATA[Returns true if the specified attribute is configured as hidden
in config.php.]]></description>
          <long-description><![CDATA[<p>Attributes are configured as hidden in config.php thus:</p>

<pre><code>$config->custom->appearance['hide_attrs'] = array('objectClass');
</code></pre>]]></long-description>
          <tag line="314" name="param" description="The name of the attribute to test." type="string" variable="$attr">
            <type by_reference="false">string</type>
          </tag>
          <tag line="314" name="return" description="" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="325">
          <name>$attr</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="338" package="phpLDAPadmin\DataStore">
        <name>add</name>
        <full_name>add</full_name>
        <docblock line="335">
          <description><![CDATA[Add objects]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="338">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="338">
          <name>$entry_array</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="338">
          <name>$method</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="382" package="phpLDAPadmin\DataStore">
        <name>delete</name>
        <full_name>delete</full_name>
        <docblock line="379">
          <description><![CDATA[Delete objects]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="382">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="382">
          <name>$method</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="408" package="phpLDAPadmin\DataStore">
        <name>rename</name>
        <full_name>rename</full_name>
        <docblock line="405">
          <description><![CDATA[Rename objects]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="408">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="408">
          <name>$new_rdn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="408">
          <name>$container</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="408">
          <name>$deleteoldrdn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="408">
          <name>$method</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="435" package="phpLDAPadmin\DataStore">
        <name>modify</name>
        <full_name>modify</full_name>
        <docblock line="432">
          <description><![CDATA[Modify objects]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="435">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="435">
          <name>$attrs</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="435">
          <name>$method</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="548" package="phpLDAPadmin\DataStore">
        <name>isAttrUnique</name>
        <full_name>isAttrUnique</full_name>
        <docblock line="537">
          <description><![CDATA[Returns true if the specified attribute is configured as unique
in config.php.]]></description>
          <long-description><![CDATA[<p>Attributes are configured as hidden in config.php thus:</p>

<pre><code>$servers->setValue('unique','attrs',array('mail','uid','uidNumber'));
</code></pre>]]></long-description>
          <tag line="537" name="param" description="The name of the attribute to test." type="string" variable="$attr">
            <type by_reference="false">string</type>
          </tag>
          <tag line="537" name="return" description="" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="548">
          <name>$attr</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="569" package="phpLDAPadmin\DataStore">
        <name>checkUniqueAttrs</name>
        <full_name>checkUniqueAttrs</full_name>
        <docblock line="559">
          <description><![CDATA[This function will check whether the value for an attribute being changed
is already assigned to another DN.]]></description>
          <long-description><![CDATA[<p>Returns the bad value, or null if all values are OK</p>]]></long-description>
          <tag line="559" name="param" description="DN that is being changed" type="\dn" variable="$dn">
            <type by_reference="false">\dn</type>
          </tag>
          <tag line="559" name="param" description="Attribute being changed" type="string" variable="$attrs">
            <type by_reference="false">string</type>
          </tag>
          <tag line="559" name="param" description="New values for the attribute" type="string|array" variable="">
            <type by_reference="false">string</type>
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="569">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="569">
          <name>$attrs</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="633" package="phpLDAPadmin\DataStore">
        <name>isSessionValid</name>
        <full_name>isSessionValid</full_name>
        <docblock line="630">
          <description><![CDATA[Check if the session timeout has occured for this LDAP server.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
    </class>
    <parse_markers>
      <error line="17" code="50018">No DocBlock was found for property $force_may</error>
      <error line="19" code="50010">No DocBlock was found for method __construct()</error>
      <error line="130" code="50010">No DocBlock was found for method __get()</error>
      <error line="335" code="50015">Argument $dn is missing from the Docblock of add()</error>
      <error line="335" code="50015">Argument $entry_array is missing from the Docblock of add()</error>
      <error line="335" code="50015">Argument $method is missing from the Docblock of add()</error>
      <error line="379" code="50015">Argument $dn is missing from the Docblock of delete()</error>
      <error line="379" code="50015">Argument $method is missing from the Docblock of delete()</error>
      <error line="405" code="50015">Argument $dn is missing from the Docblock of rename()</error>
      <error line="405" code="50015">Argument $new_rdn is missing from the Docblock of rename()</error>
      <error line="405" code="50015">Argument $container is missing from the Docblock of rename()</error>
      <error line="405" code="50015">Argument $deleteoldrdn is missing from the Docblock of rename()</error>
      <error line="405" code="50015">Argument $method is missing from the Docblock of rename()</error>
      <error line="432" code="50015">Argument $dn is missing from the Docblock of modify()</error>
      <error line="432" code="50015">Argument $attrs is missing from the Docblock of modify()</error>
      <error line="432" code="50015">Argument $method is missing from the Docblock of modify()</error>
      <notice line="559" code="50013">Parameter  could not be found in checkUniqueAttrs()</notice>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/lib/BinaryAttribute.php" hash="cc9ce3c3d2f4495b6c7b831583a888db" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Classes and functions for the template engine.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="15" package="phpLDAPadmin\Templates">
      <extends>\Attribute</extends>
      <name>BinaryAttribute</name>
      <full_name>\BinaryAttribute</full_name>
      <docblock line="9">
        <description><![CDATA[Represents an attribute whose values are binary]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="9" name="package" description="phpLDAPadmin"/>
        <tag line="9" name="subpackage" description="Templates"/>
      </docblock>
      <property final="false" static="false" visibility="protected" line="16" namespace="global" package="main">
        <name>$filepaths</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="17" namespace="global" package="main">
        <name>$filenames</name>
        <default><![CDATA[]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="19" package="phpLDAPadmin\Templates">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <argument line="19">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="19">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="19">
          <name>$server_id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="19">
          <name>$source</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="26" package="phpLDAPadmin\Templates">
        <name>getFileNames</name>
        <full_name>getFileNames</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="30" package="phpLDAPadmin\Templates">
        <name>getFileName</name>
        <full_name>getFileName</full_name>
        <argument line="30">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="35" package="phpLDAPadmin\Templates">
        <name>addFileName</name>
        <full_name>addFileName</full_name>
        <argument line="35">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="35">
          <name>$i</name>
          <default><![CDATA[-1]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="43" package="phpLDAPadmin\Templates">
        <name>getFilePaths</name>
        <full_name>getFilePaths</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="47" package="phpLDAPadmin\Templates">
        <name>getFilePath</name>
        <full_name>getFilePath</full_name>
        <argument line="47">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="52" package="phpLDAPadmin\Templates">
        <name>addFilePath</name>
        <full_name>addFilePath</full_name>
        <argument line="52">
          <name>$path</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="52">
          <name>$i</name>
          <default><![CDATA[-1]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <parse_markers>
      <error line="16" code="50018">No DocBlock was found for property $filepaths</error>
      <error line="17" code="50018">No DocBlock was found for property $filenames</error>
      <error line="19" code="50010">No DocBlock was found for method __construct()</error>
      <error line="26" code="50010">No DocBlock was found for method getFileNames()</error>
      <error line="30" code="50010">No DocBlock was found for method getFileName()</error>
      <error line="35" code="50010">No DocBlock was found for method addFileName()</error>
      <error line="43" code="50010">No DocBlock was found for method getFilePaths()</error>
      <error line="47" code="50010">No DocBlock was found for method getFilePath()</error>
      <error line="52" code="50010">No DocBlock was found for method addFilePath()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/lib/config_default.php" hash="f00f525bec62ba9127de631ebcaffd43" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Configuration processing and defaults.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="todo" description="Add validation of set variables to enforce limits or particular values."/>
    </docblock>
    <constant namespace="global" line="11" package="phpLDAPadmin">
      <name>REQUIRED_PHP_VERSION</name>
      <full_name>\REQUIRED_PHP_VERSION</full_name>
      <value><![CDATA['5.0.0']]></value>
      <docblock line="10">
        <description><![CDATA[The minimum version of PHP required to run phpLDAPadmin.]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <class final="false" abstract="false" namespace="global" line="22" package="phpLDAPadmin\Tree">
      <extends/>
      <name>Config</name>
      <full_name>\Config</full_name>
      <docblock line="13">
        <description><![CDATA[The config class contains all our configuration settings for a session.]]></description>
        <long-description><![CDATA[<p>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.</p>]]></long-description>
        <tag line="13" name="package" description="phpLDAPadmin"/>
        <tag line="13" name="subpackage" description="Tree"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="23" namespace="global" package="main">
        <name>$custom</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="24" namespace="global" package="main">
        <name>$default</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="25" namespace="global" package="main">
        <name>$servers</name>
        <default><![CDATA[array()]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="27" namespace="global" package="main">
        <name>$hooks</name>
        <default><![CDATA[array()]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="29" package="phpLDAPadmin\Tree">
        <name>__construct</name>
        <full_name>__construct</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="577" package="phpLDAPadmin\Tree">
        <name>getConfigArray</name>
        <full_name>getConfigArray</full_name>
        <docblock line="574">
          <description><![CDATA[Access the configuration, taking into account the defaults and the customisations]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="577">
          <name>$usecache</name>
          <default><![CDATA[true]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="596" package="phpLDAPadmin\Tree">
        <name>getValue</name>
        <full_name>getValue</full_name>
        <docblock line="593">
          <description><![CDATA[Get a configuration value.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="596">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="596">
          <name>$index</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="596">
          <name>$fatal</name>
          <default><![CDATA[true]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="618" package="phpLDAPadmin\Tree">
        <name>untested</name>
        <full_name>untested</full_name>
        <docblock line="615">
          <description><![CDATA[Return the untested config items]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="632" package="phpLDAPadmin\Tree">
        <name>CheckCustom</name>
        <full_name>CheckCustom</full_name>
        <docblock line="629">
          <description><![CDATA[Function to check and warn about any unusual defined variables.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="667" package="phpLDAPadmin\Tree">
        <name>getCommandList</name>
        <full_name>getCommandList</full_name>
        <docblock line="664">
          <description><![CDATA[Get a list of available commands.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="684" package="phpLDAPadmin\Tree">
        <name>isCommandAvailable</name>
        <full_name>isCommandAvailable</full_name>
        <docblock line="681">
          <description><![CDATA[Simple ACL to see if commands can be run]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="684">
          <name>$index</name>
          <default><![CDATA['cmd']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="701" package="phpLDAPadmin\Tree">
        <name>configDefinition</name>
        <full_name>configDefinition</full_name>
        <argument line="701">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="701">
          <name>$index</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="701">
          <name>$config</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="718" package="phpLDAPadmin\Tree">
        <name>getFriendlyAttrs</name>
        <full_name>getFriendlyAttrs</full_name>
        <docblock line="715">
          <description><![CDATA[Return the friendly attributes names]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="732" package="phpLDAPadmin\Tree">
        <name>getFriendlyName</name>
        <full_name>getFriendlyName</full_name>
        <docblock line="725">
          <description><![CDATA[This function will return the friendly name of an attribute, if it exists.]]></description>
          <long-description><![CDATA[<p>If the friendly name doesnt exist, the attribute name will be returned.</p>]]></long-description>
          <tag line="725" name="param" description="attribute" type="" variable="$attr"/>
          <tag line="725" name="return" description="friendly name|attribute" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="732">
          <name>$attr</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="760" package="phpLDAPadmin\Tree">
        <name>haveFriendlyName</name>
        <full_name>haveFriendlyName</full_name>
        <docblock line="753">
          <description><![CDATA[This function will return true if a friendly name exists for an attribute.]]></description>
          <long-description><![CDATA[<p>If the friendly name doesnt exist, it will return false.</p>]]></long-description>
          <tag line="753" name="param" description="attribute" type="" variable="$attr"/>
          <tag line="753" name="return" description="true|false" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="760">
          <name>$attr</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="773" package="phpLDAPadmin\Tree">
        <name>getFriendlyHTML</name>
        <full_name>getFriendlyHTML</full_name>
        <docblock line="767">
          <description><![CDATA[This function will return the <ancronym> html for a friendly name attribute.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="767" name="param" description="attribute" type="" variable="$attr"/>
          <tag line="767" name="return" description="html for the friendly name." type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="773">
          <name>$attr</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="779" package="phpLDAPadmin\Tree">
        <name>setServers</name>
        <full_name>setServers</full_name>
        <argument line="779">
          <name>$servers</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="783" package="phpLDAPadmin\Tree">
        <name>getServer</name>
        <full_name>getServer</full_name>
        <argument line="783">
          <name>$index</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="791" package="phpLDAPadmin\Tree">
        <name>getServerList</name>
        <full_name>getServerList</full_name>
        <docblock line="787">
          <description><![CDATA[Return a list of our servers]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="787" name="param" description="- Only return visible servers" type="boolean" variable="$visible">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="791">
          <name>$visible</name>
          <default><![CDATA[true]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <parse_markers>
      <error line="23" code="50018">No DocBlock was found for property $custom</error>
      <error line="24" code="50018">No DocBlock was found for property $default</error>
      <error line="25" code="50018">No DocBlock was found for property $servers</error>
      <error line="27" code="50018">No DocBlock was found for property $hooks</error>
      <error line="29" code="50010">No DocBlock was found for method __construct()</error>
      <error line="574" code="50015">Argument $usecache is missing from the Docblock of getConfigArray()</error>
      <error line="593" code="50015">Argument $key is missing from the Docblock of getValue()</error>
      <error line="593" code="50015">Argument $index is missing from the Docblock of getValue()</error>
      <error line="593" code="50015">Argument $fatal is missing from the Docblock of getValue()</error>
      <error line="681" code="50015">Argument $index is missing from the Docblock of isCommandAvailable()</error>
      <error line="701" code="50010">No DocBlock was found for method configDefinition()</error>
      <error line="779" code="50010">No DocBlock was found for method setServers()</error>
      <error line="783" code="50010">No DocBlock was found for method getServer()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/lib/Query.php" hash="d6c2cf546bf1ab22f3c85de522ba7b0d" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Classes and functions for the query engine.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="15" package="phpLDAPadmin\Queries">
      <extends>\xmlTemplate</extends>
      <name>Query</name>
      <full_name>\Query</full_name>
      <docblock line="9">
        <description><![CDATA[Query Class]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="9" name="package" description="phpLDAPadmin"/>
        <tag line="9" name="subpackage" description="Queries"/>
      </docblock>
      <property final="false" static="false" visibility="protected" line="16" namespace="global" package="main">
        <name>$description</name>
        <default><![CDATA['']]></default>
      </property>
      <property final="false" static="false" visibility="public" line="17" namespace="global" package="main">
        <name>$results</name>
        <default><![CDATA[array()]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="24" package="phpLDAPadmin\Queries">
        <name>storeTemplate</name>
        <full_name>storeTemplate</full_name>
        <docblock line="19">
          <description><![CDATA[Main processing to store the template.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="19" name="param" description="Parsed xmldata from xml2array object" type="\xmldata" variable="$xmldata">
            <type by_reference="false">\xmldata</type>
          </tag>
        </docblock>
        <argument line="24">
          <name>$xmldata</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="123" package="phpLDAPadmin\Queries">
        <name>accept</name>
        <full_name>accept</full_name>
        <docblock line="120">
          <description><![CDATA[Accept will run the query and store the results in results()]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="181" package="phpLDAPadmin\Queries">
        <name>setDN</name>
        <full_name>setDN</full_name>
        <docblock line="178">
          <description><![CDATA[This is temporary to get around objects that use a DN for rendering, for example jpegPhoto]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="181">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="191" package="phpLDAPadmin\Queries">
        <name>getDN</name>
        <full_name>getDN</full_name>
        <docblock line="188">
          <description><![CDATA[This is temporary to get around objects that use a DN for rendering, for example jpegPhoto]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="198" package="phpLDAPadmin\Queries">
        <name>getDNEncode</name>
        <full_name>getDNEncode</full_name>
        <argument line="198">
          <name>$url</name>
          <default><![CDATA[true]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="206" package="phpLDAPadmin\Queries">
        <name>getAttrSortOrder</name>
        <full_name>getAttrSortOrder</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="228" package="phpLDAPadmin\Queries">
        <name>getAttrDisplayOrder</name>
        <full_name>getAttrDisplayOrder</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="269" package="phpLDAPadmin\Queries">
        <name>isVisible</name>
        <full_name>isVisible</full_name>
        <docblock line="264">
          <description><![CDATA[Test if the template is visible]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="264" name="return" description="" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="276" package="phpLDAPadmin\Queries">
        <name>getDescription</name>
        <full_name>getDescription</full_name>
      </method>
    </class>
    <parse_markers>
      <error line="16" code="50018">No DocBlock was found for property $description</error>
      <error line="17" code="50018">No DocBlock was found for property $results</error>
      <error line="178" code="50015">Argument $dn is missing from the Docblock of setDN()</error>
      <error line="198" code="50010">No DocBlock was found for method getDNEncode()</error>
      <error line="206" code="50010">No DocBlock was found for method getAttrSortOrder()</error>
      <error line="228" code="50010">No DocBlock was found for method getAttrDisplayOrder()</error>
      <error line="276" code="50010">No DocBlock was found for method getDescription()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/lib/blowfish.php" hash="554ccb46a8a275145bb76599e8559489" package="horde\cipher">
    <docblock line="2">
      <description><![CDATA[The Cipher_blowfish:: class implements the Cipher interface enryption data
using the Blowfish algorithm.]]></description>
      <long-description><![CDATA[<p>$Horde: horde/lib/Cipher/blowfish.php,v 1.2.2.3 2003/01/03 13:23:22 jan Exp $</p>

<p>Copyright 2002-2003 Mike Cochrane <a href="m&#97;&#105;&#108;&#116;&#111;&#58;&#109;&#105;&#x6b;&#x65;&#x40;&#x67;&#x72;&#x61;&#x66;to&#110;&#104;&#97;&#108;&#108;&#46;&#99;&#x6f;&#x2e;&#x6e;&#x7a;">&#109;&#105;&#x6b;&#x65;&#x40;&#x67;&#x72;&#x61;&#x66;to&#110;&#104;&#97;&#108;&#108;&#46;&#99;&#x6f;&#x2e;&#x6e;&#x7a;</a></p>

<p>See the enclosed file COPYING for license information (LGPL). If you
did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.</p>]]></long-description>
      <tag line="2" name="author" description="Mike Cochrane &lt;mike@graftonhall.co.nz&gt;"/>
      <tag line="2" name="version" description="$Revision: 4149 $"/>
      <tag line="2" name="since" description="Horde 2.2"/>
      <tag line="2" name="package" description="horde.cipher"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="24" package="horde\cipher">
      <extends/>
      <name>Horde_Cipher_blowfish</name>
      <full_name>\Horde_Cipher_blowfish</full_name>
      <docblock line="18">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="18" name="package" description="horde.cipher"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="27" namespace="global" package="main">
        <name>$p</name>
        <default><![CDATA[array(608135816, 2242054355, 320440878, 57701188, 2752067618, 698298832, 137296536, 3964562569, 1160258022, 953160567, 3193202383, 887688300, 3232508343, 3380367581, 1065670069, 3041331479, 2450970073, 2306472731)]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="35" namespace="global" package="main">
        <name>$s1</name>
        <default><![CDATA[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>
      </property>
      <property final="false" static="false" visibility="public" line="100" namespace="global" package="main">
        <name>$s2</name>
        <default><![CDATA[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>
      </property>
      <property final="false" static="false" visibility="public" line="165" namespace="global" package="main">
        <name>$s3</name>
        <default><![CDATA[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>
      </property>
      <property final="false" static="false" visibility="public" line="230" namespace="global" package="main">
        <name>$s4</name>
        <default><![CDATA[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>
      </property>
      <property final="false" static="false" visibility="public" line="297" namespace="global" package="main">
        <name>$_rounds</name>
        <default><![CDATA[16]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="300" package="horde\cipher">
        <name>Cipher_blowfish</name>
        <full_name>Cipher_blowfish</full_name>
        <argument line="300">
          <name>$params</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="309" package="horde\cipher">
        <name>setKey</name>
        <full_name>setKey</full_name>
        <docblock line="304">
          <description><![CDATA[Set the key to be used for en/decryption]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="304" name="param" description="The key to use" type="String" variable="$key">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="309">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="368" package="horde\cipher">
        <name>getBlockSize</name>
        <full_name>getBlockSize</full_name>
        <docblock line="363">
          <description><![CDATA[Return the size of the blocks that this cipher needs]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="363" name="return" description="The number of characters per block" type="Integer">
            <type by_reference="false">Integer</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="381" package="horde\cipher">
        <name>encryptBlock</name>
        <full_name>encryptBlock</full_name>
        <docblock line="373">
          <description><![CDATA[Encrypt a block on data.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="373" name="param" description="The data to encrypt" type="String" variable="$block">
            <type by_reference="false">String</type>
          </tag>
          <tag line="373" name="param" description="String $key The key to use" type="\optional" variable="$key">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="373" name="return" description="the encrypted output" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="381">
          <name>$block</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="381">
          <name>$key</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="400" package="horde\cipher">
        <name>_encryptBlock</name>
        <full_name>_encryptBlock</full_name>
        <docblock line="392">
          <description><![CDATA[Encrypt a block on data.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="392" name="param" description="The data to encrypt." type="String" variable="$L">
            <type by_reference="false">String</type>
          </tag>
          <tag line="392" name="param" description="The data to encrypt." type="String" variable="$R">
            <type by_reference="false">String</type>
          </tag>
          <tag line="392" name="return" description="The encrypted output." type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="400">
          <name>$L</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="400">
          <name>$R</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="432" package="horde\cipher">
        <name>decryptBlock</name>
        <full_name>decryptBlock</full_name>
        <docblock line="424">
          <description><![CDATA[Decrypt a block on data.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="424" name="param" description="The data to decrypt" type="String" variable="$block">
            <type by_reference="false">String</type>
          </tag>
          <tag line="424" name="param" description="String $key The key to use" type="\optional" variable="$key">
            <type by_reference="false">\optional</type>
          </tag>
          <tag line="424" name="return" description="the decrypted output" type="String">
            <type by_reference="false">String</type>
          </tag>
        </docblock>
        <argument line="432">
          <name>$block</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="432">
          <name>$key</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="474" package="horde\cipher">
        <name>_formatKey</name>
        <full_name>_formatKey</full_name>
        <docblock line="469">
          <description><![CDATA[Converts a text key into an array.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="469" name="return" description="The key." type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="474">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <parse_markers>
      <critical line="18" code="50005">No short description for class \Horde_Cipher_blowfish</critical>
      <error line="27" code="50018">No DocBlock was found for property $p</error>
      <error line="35" code="50018">No DocBlock was found for property $s1</error>
      <error line="100" code="50018">No DocBlock was found for property $s2</error>
      <error line="165" code="50018">No DocBlock was found for property $s3</error>
      <error line="230" code="50018">No DocBlock was found for property $s4</error>
      <error line="297" code="50018">No DocBlock was found for property $_rounds</error>
      <error line="300" code="50010">No DocBlock was found for method Cipher_blowfish()</error>
      <error line="469" code="50015">Argument $key is missing from the Docblock of _formatKey()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/lib/DateAttribute.php" hash="c75ac439a08b258c860ff7d518de13b3" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Classes and functions for the template engine.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="15" package="phpLDAPadmin\Templates">
      <extends>\Attribute</extends>
      <name>DateAttribute</name>
      <full_name>\DateAttribute</full_name>
      <docblock line="9">
        <description><![CDATA[Represents an attribute whose values are dates]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="9" name="package" description="phpLDAPadmin"/>
        <tag line="9" name="subpackage" description="Templates"/>
      </docblock>
    </class>
  </file>
  <file path="templates/3rdParty/pla/lib/ds.php" hash="2cbd15f72702d4075bbd24488d32b602" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Classes and functions for communication of Data Stores]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="15" package="phpLDAPadmin\DataStore">
      <extends/>
      <name>DS</name>
      <full_name>\DS</full_name>
      <docblock line="9">
        <description><![CDATA[This abstract class provides the basic variables and methods.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="9" name="package" description="phpLDAPadmin"/>
        <tag line="9" name="subpackage" description="DataStore"/>
      </docblock>
      <property final="false" static="false" visibility="protected" line="17" namespace="global" package="main">
        <name>$index</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="20" namespace="global" package="main">
        <name>$default</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="21" namespace="global" package="main">
        <name>$custom</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="22" namespace="global" package="main">
        <name>$type</name>
        <default><![CDATA[]]></default>
      </property>
      <method final="false" abstract="true" static="false" visibility="public" namespace="global" line="24" package="phpLDAPadmin\DataStore">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <argument line="24">
          <name>$index</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="true" static="false" visibility="protected" namespace="global" line="29" package="phpLDAPadmin\DataStore">
        <name>connect</name>
        <full_name>connect</full_name>
        <docblock line="26">
          <description><![CDATA[This will make the connection to the datasource]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="29">
          <name>$method</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="29">
          <name>$debug</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="true" static="false" visibility="public" namespace="global" line="37" package="phpLDAPadmin\DataStore">
        <name>login</name>
        <full_name>login</full_name>
        <docblock line="31">
          <description><![CDATA[Login to the datastore
 method: default = anon, connect to ds using bind_id not auth_id.]]></description>
          <long-description><![CDATA[<p>method: 'user', connect with auth_id
 method: '<freetext>', any custom extra connection to ds.</p>]]></long-description>
        </docblock>
        <argument line="37">
          <name>$user</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="37">
          <name>$pass</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="37">
          <name>$method</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="true" static="false" visibility="public" namespace="global" line="42" package="phpLDAPadmin\DataStore">
        <name>query</name>
        <full_name>query</full_name>
        <docblock line="39">
          <description><![CDATA[Query the datasource]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="42">
          <name>$query</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="42">
          <name>$method</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="42">
          <name>$index</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="42">
          <name>$debug</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="true" static="false" visibility="protected" namespace="global" line="47" package="phpLDAPadmin\DataStore">
        <name>getErrorMessage</name>
        <full_name>getErrorMessage</full_name>
        <docblock line="44">
          <description><![CDATA[Return error details from previous operation]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="true" static="false" visibility="protected" namespace="global" line="48" package="phpLDAPadmin\DataStore">
        <name>getErrorNum</name>
        <full_name>getErrorNum</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="53" package="phpLDAPadmin\DataStore">
        <name>setDefaults</name>
        <full_name>setDefaults</full_name>
        <docblock line="50">
          <description><![CDATA[Functions that set and verify object configuration details]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="53">
          <name>$defaults</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="59" package="phpLDAPadmin\DataStore">
        <name>isDefaultKey</name>
        <full_name>isDefaultKey</full_name>
        <argument line="59">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="63" package="phpLDAPadmin\DataStore">
        <name>isDefaultSetting</name>
        <full_name>isDefaultSetting</full_name>
        <argument line="63">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="63">
          <name>$setting</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="70" package="phpLDAPadmin\DataStore">
        <name>getValue</name>
        <full_name>getValue</full_name>
        <docblock line="67">
          <description><![CDATA[Return a configuration value]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="70">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="70">
          <name>$setting</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="70">
          <name>$fatal</name>
          <default><![CDATA[true]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="90" package="phpLDAPadmin\DataStore">
        <name>setValue</name>
        <full_name>setValue</full_name>
        <docblock line="87">
          <description><![CDATA[Set a configuration value]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="90">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="90">
          <name>$setting</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="90">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="104" package="phpLDAPadmin\DataStore">
        <name>untested</name>
        <full_name>untested</full_name>
        <docblock line="101">
          <description><![CDATA[Return the untested config items]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="118" package="phpLDAPadmin\DataStore">
        <name>getName</name>
        <full_name>getName</full_name>
        <docblock line="115">
          <description><![CDATA[Get the name of this datastore]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="131" package="phpLDAPadmin\DataStore">
        <name>getAuthType</name>
        <full_name>getAuthType</full_name>
        <docblock line="128">
          <description><![CDATA[Return the authentication type for this object]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="155" package="phpLDAPadmin\DataStore">
        <name>getLogin</name>
        <full_name>getLogin</full_name>
        <docblock line="150">
          <description><![CDATA[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><![CDATA[<p>If this returns '', we are logged in with anonymous</p>]]></long-description>
        </docblock>
        <argument line="155">
          <name>$method</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="205" package="phpLDAPadmin\DataStore">
        <name>setLogin</name>
        <full_name>setLogin</full_name>
        <docblock line="202">
          <description><![CDATA[Set the login details of the user logged into this datastore's connection method]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="205">
          <name>$user</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="205">
          <name>$pass</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="205">
          <name>$method</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="240" package="phpLDAPadmin\DataStore">
        <name>getPassword</name>
        <full_name>getPassword</full_name>
        <docblock line="237">
          <description><![CDATA[Get the login password of the user logged into this datastore's connection method]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="240">
          <name>$method</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="285" package="phpLDAPadmin\DataStore">
        <name>isLoggedIn</name>
        <full_name>isLoggedIn</full_name>
        <docblock line="282">
          <description><![CDATA[Return if this datastore's connection method has been logged into]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="285">
          <name>$method</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="389" package="phpLDAPadmin\DataStore">
        <name>logout</name>
        <full_name>logout</full_name>
        <docblock line="386">
          <description><![CDATA[Logout of this datastore's connection method]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="389">
          <name>$method</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="422" package="phpLDAPadmin\DataStore">
        <name>isVisible</name>
        <full_name>isVisible</full_name>
        <docblock line="419">
          <description><![CDATA[Functions that return the condition of the datasource]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="429" package="phpLDAPadmin\DataStore">
        <name>isReadOnly</name>
        <full_name>isReadOnly</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="439" package="phpLDAPadmin\DataStore">
        <name>getIndex</name>
        <full_name>getIndex</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="455" package="phpLDAPadmin\DataStore">
        <name>getMethod</name>
        <full_name>getMethod</full_name>
        <docblock line="446">
          <description><![CDATA[Work out which connection method to use.]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="446" name="param" description="Server ID" type="int" variable="$method">
            <type by_reference="false">int</type>
          </tag>
          <tag line="446" name="return" description="Connection Method" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="455">
          <name>$method</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="480" package="phpLDAPadmin\DataStore">
        <name>isSessionValid</name>
        <full_name>isSessionValid</full_name>
        <docblock line="477">
          <description><![CDATA[This method should be overridden in application specific ds files]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="491" package="phpLDAPadmin\DataStore">
        <name>inactivityTime</name>
        <full_name>inactivityTime</full_name>
        <docblock line="487">
          <description><![CDATA[Return the time left in seconds until this connection times out.]]></description>
          <long-description><![CDATA[<p>If there is not timeout,
this function will return null.</p>]]></long-description>
        </docblock>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="508" package="phpLDAPadmin\DataStore">
      <extends/>
      <name>Datastore</name>
      <full_name>\Datastore</full_name>
      <docblock line="502">
        <description><![CDATA[The list of database sources]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="502" name="package" description="phpLDAPadmin"/>
        <tag line="502" name="subpackage" description="DataStore"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="510" namespace="global" package="main">
        <name>$index</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="512" namespace="global" package="main">
        <name>$objects</name>
        <default><![CDATA[array()]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="514" namespace="global" package="main">
        <name>$default</name>
        <default><![CDATA[]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="516" package="phpLDAPadmin\DataStore">
        <name>__construct</name>
        <full_name>__construct</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="600" package="phpLDAPadmin\DataStore">
        <name>newServer</name>
        <full_name>newServer</full_name>
        <docblock line="597">
          <description><![CDATA[Create a new database object]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="600">
          <name>$type</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="616" package="phpLDAPadmin\DataStore">
        <name>setValue</name>
        <full_name>setValue</full_name>
        <docblock line="613">
          <description><![CDATA[Set values for a database object.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="616">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="616">
          <name>$setting</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="616">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="640" package="phpLDAPadmin\DataStore">
        <name>getServerList</name>
        <full_name>getServerList</full_name>
        <docblock line="634">
          <description><![CDATA[Get a list of all the configured servers.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="634" name="param" description="Only show visible servers." type="boolean" variable="$isVisible">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="634" name="return" description="list of all configured servers." type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="640">
          <name>$isVisible</name>
          <default><![CDATA[true]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="673" package="phpLDAPadmin\DataStore">
        <name>Instance</name>
        <full_name>Instance</full_name>
        <docblock line="667">
          <description><![CDATA[Return an object Instance of a configured database.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="667" name="param" description="Index" type="int" variable="$index">
            <type by_reference="false">int</type>
          </tag>
          <tag line="667" name="return" description="Datastore instance object." type="object">
            <type by_reference="false">object</type>
          </tag>
        </docblock>
        <argument line="673">
          <name>$index</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="696" package="phpLDAPadmin\DataStore">
        <name>InstanceName</name>
        <full_name>InstanceName</full_name>
        <docblock line="690">
          <description><![CDATA[Return an object Instance of a configured database.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="690" name="param" description="Name of the instance to retrieve" type="string" variable="$name">
            <type by_reference="false">string</type>
          </tag>
          <tag line="690" name="return" description="Datastore instance object." type="object">
            <type by_reference="false">object</type>
          </tag>
        </docblock>
        <argument line="696">
          <name>$name</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="714" package="phpLDAPadmin\DataStore">
        <name>InstanceId</name>
        <full_name>InstanceId</full_name>
        <docblock line="708">
          <description><![CDATA[Return an object Instance of a configured database.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="708" name="param" description="ID of the instance to retrieve" type="string" variable="$id">
            <type by_reference="false">string</type>
          </tag>
          <tag line="708" name="return" description="Datastore instance object." type="object">
            <type by_reference="false">object</type>
          </tag>
        </docblock>
        <argument line="714">
          <name>$id</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <parse_markers>
      <error line="17" code="50018">No DocBlock was found for property $index</error>
      <error line="20" code="50018">No DocBlock was found for property $default</error>
      <error line="21" code="50018">No DocBlock was found for property $custom</error>
      <error line="22" code="50018">No DocBlock was found for property $type</error>
      <error line="24" code="50010">No DocBlock was found for method __construct()</error>
      <error line="26" code="50015">Argument $method is missing from the Docblock of connect()</error>
      <error line="26" code="50015">Argument $debug is missing from the Docblock of connect()</error>
      <error line="31" code="50015">Argument $user is missing from the Docblock of login()</error>
      <error line="31" code="50015">Argument $pass is missing from the Docblock of login()</error>
      <error line="31" code="50015">Argument $method is missing from the Docblock of login()</error>
      <error line="39" code="50015">Argument $query is missing from the Docblock of query()</error>
      <error line="39" code="50015">Argument $method is missing from the Docblock of query()</error>
      <error line="39" code="50015">Argument $index is missing from the Docblock of query()</error>
      <error line="39" code="50015">Argument $debug is missing from the Docblock of query()</error>
      <error line="48" code="50010">No DocBlock was found for method getErrorNum()</error>
      <error line="50" code="50015">Argument $defaults is missing from the Docblock of setDefaults()</error>
      <error line="59" code="50010">No DocBlock was found for method isDefaultKey()</error>
      <error line="63" code="50010">No DocBlock was found for method isDefaultSetting()</error>
      <error line="67" code="50015">Argument $key is missing from the Docblock of getValue()</error>
      <error line="67" code="50015">Argument $setting is missing from the Docblock of getValue()</error>
      <error line="67" code="50015">Argument $fatal is missing from the Docblock of getValue()</error>
      <error line="87" code="50015">Argument $key is missing from the Docblock of setValue()</error>
      <error line="87" code="50015">Argument $setting is missing from the Docblock of setValue()</error>
      <error line="87" code="50015">Argument $value is missing from the Docblock of setValue()</error>
      <error line="150" code="50015">Argument $method is missing from the Docblock of getLogin()</error>
      <error line="202" code="50015">Argument $user is missing from the Docblock of setLogin()</error>
      <error line="202" code="50015">Argument $pass is missing from the Docblock of setLogin()</error>
      <error line="202" code="50015">Argument $method is missing from the Docblock of setLogin()</error>
      <error line="237" code="50015">Argument $method is missing from the Docblock of getPassword()</error>
      <error line="282" code="50015">Argument $method is missing from the Docblock of isLoggedIn()</error>
      <error line="386" code="50015">Argument $method is missing from the Docblock of logout()</error>
      <error line="429" code="50010">No DocBlock was found for method isReadOnly()</error>
      <error line="439" code="50010">No DocBlock was found for method getIndex()</error>
      <error line="510" code="50018">No DocBlock was found for property $index</error>
      <error line="512" code="50018">No DocBlock was found for property $objects</error>
      <error line="514" code="50018">No DocBlock was found for property $default</error>
      <error line="516" code="50010">No DocBlock was found for method __construct()</error>
      <error line="597" code="50015">Argument $type is missing from the Docblock of newServer()</error>
      <error line="613" code="50015">Argument $key is missing from the Docblock of setValue()</error>
      <error line="613" code="50015">Argument $setting is missing from the Docblock of setValue()</error>
      <error line="613" code="50015">Argument $value is missing from the Docblock of setValue()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/lib/ObjectClassAttribute.php" hash="59e6fc02acb4d97f9f7cae83a727c473" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Classes and functions for the template engine.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="15" package="phpLDAPadmin\Templates">
      <extends>\Attribute</extends>
      <name>ObjectClassAttribute</name>
      <full_name>\ObjectClassAttribute</full_name>
      <docblock line="9">
        <description><![CDATA[Represents an 'objectClass' attribute]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="9" name="package" description="phpLDAPadmin"/>
        <tag line="9" name="subpackage" description="Templates"/>
      </docblock>
    </class>
  </file>
  <file path="templates/3rdParty/pla/lib/createlm.php" hash="680a5100589c23a8319905e5e1990528" package="lam">
    <docblock line="24">
      <description><![CDATA[This class provides functions to calculate Samba NT and LM hashes.]]></description>
      <long-description><![CDATA[<p>The code is a conversion from createntlm.pl (Benjamin Kuit) and smbdes.c/md4.c (Andrew Tridgell).</p>]]></long-description>
      <tag line="24" name="author" description="Roland Gruber"/>
      <tag line="24" name="package" description="lam"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="40" package="lam">
      <extends/>
      <name>smbHash</name>
      <full_name>\smbHash</full_name>
      <docblock line="33">
        <description><![CDATA[Calculates NT and LM hashes.]]></description>
        <long-description><![CDATA[<p>The important functions are lmhash($password) and nthash($password).</p>]]></long-description>
        <tag line="33" name="package" description="lam"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="44" namespace="global" package="main">
        <name>$perm1</name>
        <default><![CDATA[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>
      </property>
      <property final="false" static="false" visibility="private" line="53" namespace="global" package="main">
        <name>$perm2</name>
        <default><![CDATA[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>
      </property>
      <property final="false" static="false" visibility="private" line="62" namespace="global" package="main">
        <name>$perm3</name>
        <default><![CDATA[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>
      </property>
      <property final="false" static="false" visibility="private" line="71" namespace="global" package="main">
        <name>$perm4</name>
        <default><![CDATA[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>
      </property>
      <property final="false" static="false" visibility="private" line="80" namespace="global" package="main">
        <name>$perm5</name>
        <default><![CDATA[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>
      </property>
      <property final="false" static="false" visibility="private" line="89" namespace="global" package="main">
        <name>$perm6</name>
        <default><![CDATA[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>
      </property>
      <property final="false" static="false" visibility="private" line="98" namespace="global" package="main">
        <name>$sc</name>
        <default><![CDATA[array(1, 1, 2, 2, 2, 2, 2, 2, 1, 2, 2, 2, 2, 2, 2, 1)]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="102" namespace="global" package="main">
        <name>$sbox</name>
        <default><![CDATA[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>
      </property>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="138" package="lam">
        <name>x</name>
        <full_name>x</full_name>
        <docblock line="135">
          <description><![CDATA[Fixes too large numbers]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="138">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="148" package="lam">
        <name>lshift</name>
        <full_name>lshift</full_name>
        <docblock line="143">
          <description><![CDATA[]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="143" name="param" description="count" type="integer" variable="$count">
            <type by_reference="false">integer</type>
          </tag>
          <tag line="143" name="param" description="" type="array" variable="$data">
            <type by_reference="false">array</type>
          </tag>
          <tag line="143" name="return" description="" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="148">
          <name>$count</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="148">
          <name>$data</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="161" package="lam">
        <name>permute</name>
        <full_name>permute</full_name>
        <docblock line="156">
          <description><![CDATA[]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="156" name="param" description="in input data" type="array" variable="$in">
            <type by_reference="false">array</type>
          </tag>
          <tag line="156" name="param" description="p permutation" type="array" variable="$p">
            <type by_reference="false">array</type>
          </tag>
          <tag line="156" name="return" description="" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="161">
          <name>$in</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="161">
          <name>$p</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="161">
          <name>$n</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="174" package="lam">
        <name>mxor</name>
        <full_name>mxor</full_name>
        <docblock line="169">
          <description><![CDATA[]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="169" name="param" description="" type="array" variable="$in1">
            <type by_reference="false">array</type>
          </tag>
          <tag line="169" name="param" description="" type="array" variable="$in2">
            <type by_reference="false">array</type>
          </tag>
          <tag line="169" name="return" description="" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="174">
          <name>$in1</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="174">
          <name>$in2</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="188" package="lam">
        <name>doHash</name>
        <full_name>doHash</full_name>
        <docblock line="182">
          <description><![CDATA[]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="182" name="param" description="" type="array" variable="$in">
            <type by_reference="false">array</type>
          </tag>
          <tag line="182" name="param" description="" type="array" variable="$key">
            <type by_reference="false">array</type>
          </tag>
          <tag line="182" name="param" description="" type="boolean" variable="$forw">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="182" name="return" description="" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="188">
          <name>$in</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="188">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="188">
          <name>$forw</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="260" package="lam">
        <name>str_to_key</name>
        <full_name>str_to_key</full_name>
        <docblock line="254">
          <description><![CDATA[str_to_key]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="254" name="param" description="" type="string" variable="$str">
            <type by_reference="false">string</type>
          </tag>
          <tag line="254" name="return" description="key" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="260">
          <name>$str</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="283" package="lam">
        <name>smb_hash</name>
        <full_name>smb_hash</full_name>
        <docblock line="275">
          <description><![CDATA[smb_hash]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="275" name="param" description="" type="\unknown_type" variable="$in">
            <type by_reference="false">\unknown_type</type>
          </tag>
          <tag line="275" name="param" description="" type="\unknown_type" variable="$key">
            <type by_reference="false">\unknown_type</type>
          </tag>
          <tag line="275" name="param" description="" type="\unknown_type" variable="$forw">
            <type by_reference="false">\unknown_type</type>
          </tag>
          <tag line="275" name="return" description="" type="\unknown">
            <type by_reference="false">\unknown</type>
          </tag>
        </docblock>
        <argument line="283">
          <name>$in</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="283">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="283">
          <name>$forw</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="309" package="lam">
        <name>E_P16</name>
        <full_name>E_P16</full_name>
        <docblock line="303">
          <description><![CDATA[E_P16]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="303" name="param" description="" type="\unknown_type" variable="$in">
            <type by_reference="false">\unknown_type</type>
          </tag>
          <tag line="303" name="return" description="" type="\unknown">
            <type by_reference="false">\unknown</type>
          </tag>
        </docblock>
        <argument line="309">
          <name>$in</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="333" package="lam">
        <name>lmhash</name>
        <full_name>lmhash</full_name>
        <docblock line="327">
          <description><![CDATA[Calculates the LM hash of a given password.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="327" name="param" description="password" type="string" variable="$password">
            <type by_reference="false">string</type>
          </tag>
          <tag line="327" name="return" description="hash value" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="333">
          <name>$password</name>
          <default><![CDATA[""]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="350" package="lam">
        <name>nthash</name>
        <full_name>nthash</full_name>
        <docblock line="344">
          <description><![CDATA[Calculates the NT hash of a given password.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="344" name="param" description="password" type="string" variable="$password">
            <type by_reference="false">string</type>
          </tag>
          <tag line="344" name="return" description="hash value" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="350">
          <name>$password</name>
          <default><![CDATA[""]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="359" package="lam">
        <name>unsigned_shift_r</name>
        <full_name>unsigned_shift_r</full_name>
        <docblock line="354">
          <description><![CDATA[Unsigned shift operation for 32bit values.]]></description>
          <long-description><![CDATA[<p>PHP 4 only supports signed shifts by default.</p>]]></long-description>
        </docblock>
        <argument line="359">
          <name>$a</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="359">
          <name>$b</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <parse_markers>
      <error line="44" code="50018">No DocBlock was found for property $perm1</error>
      <error line="53" code="50018">No DocBlock was found for property $perm2</error>
      <error line="62" code="50018">No DocBlock was found for property $perm3</error>
      <error line="71" code="50018">No DocBlock was found for property $perm4</error>
      <error line="80" code="50018">No DocBlock was found for property $perm5</error>
      <error line="89" code="50018">No DocBlock was found for property $perm6</error>
      <error line="98" code="50018">No DocBlock was found for property $sc</error>
      <error line="102" code="50018">No DocBlock was found for property $sbox</error>
      <error line="135" code="50015">Argument $i is missing from the Docblock of x()</error>
      <error line="143" code="50012">No short description for method lshift()</error>
      <error line="156" code="50012">No short description for method permute()</error>
      <error line="156" code="50015">Argument $n is missing from the Docblock of permute()</error>
      <error line="169" code="50012">No short description for method mxor()</error>
      <error line="182" code="50012">No short description for method doHash()</error>
      <error line="354" code="50015">Argument $a is missing from the Docblock of unsigned_shift_r()</error>
      <error line="354" code="50015">Argument $b is missing from the Docblock of unsigned_shift_r()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/lib/import_functions.php" hash="0514b6b52ce659d441215eb550135c23" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Classes and functions for importing data to LDAP]]></description>
      <long-description><![CDATA[<p>These classes provide differnet import formats.</p>]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="see" description="\import.php" refers="\import.php"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="21" package="phpLDAPadmin\Import">
      <extends/>
      <name>Importer</name>
      <full_name>\Importer</full_name>
      <docblock line="12">
        <description><![CDATA[Importer Class]]></description>
        <long-description><![CDATA[<p>This class serves as a top level importer class, which will return
the correct Import class.</p>]]></long-description>
        <tag line="12" name="package" description="phpLDAPadmin"/>
        <tag line="12" name="subpackage" description="Import"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="23" namespace="global" package="main">
        <name>$server_id</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="25" namespace="global" package="main">
        <name>$template_id</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="26" namespace="global" package="main">
        <name>$template</name>
        <default><![CDATA[]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="28" package="phpLDAPadmin\Import">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <argument line="28">
          <name>$server_id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="28">
          <name>$template_id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="global" line="35" package="phpLDAPadmin\Import">
        <name>types</name>
        <full_name>types</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="44" package="phpLDAPadmin\Import">
        <name>accept</name>
        <full_name>accept</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="57" package="phpLDAPadmin\Import">
        <name>getTemplate</name>
        <full_name>getTemplate</full_name>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="71" package="phpLDAPadmin\Import">
      <extends/>
      <name>Import</name>
      <full_name>\Import</full_name>
      <docblock line="62">
        <description><![CDATA[Import Class]]></description>
        <long-description><![CDATA[<p>This abstract classes provides all the common methods and variables for the
custom import classes.</p>]]></long-description>
        <tag line="62" name="package" description="phpLDAPadmin"/>
        <tag line="62" name="subpackage" description="Import"/>
      </docblock>
      <property final="false" static="false" visibility="protected" line="72" namespace="global" package="main">
        <name>$server_id</name>
        <default><![CDATA[null]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="73" namespace="global" package="main">
        <name>$input</name>
        <default><![CDATA[null]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="74" namespace="global" package="main">
        <name>$source</name>
        <default><![CDATA[array()]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="76" package="phpLDAPadmin\Import">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <argument line="76">
          <name>$server_id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="80" package="phpLDAPadmin\Import">
        <name>accept</name>
        <full_name>accept</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="102" package="phpLDAPadmin\Import">
        <name>getSource</name>
        <full_name>getSource</full_name>
        <argument line="102">
          <name>$attr</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="110" package="phpLDAPadmin\Import">
        <name>LDAPimport</name>
        <full_name>LDAPimport</full_name>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="142" package="phpLDAPadmin\Import">
      <extends>\Import</extends>
      <name>ImportLDIF</name>
      <full_name>\ImportLDIF</full_name>
      <docblock line="133">
        <description><![CDATA[Import entries from LDIF]]></description>
        <long-description><![CDATA[<p>The LDIF spec is described by RFC2849
http://www.ietf.org/rfc/rfc2849.txt</p>]]></long-description>
        <tag line="133" name="package" description="phpLDAPadmin"/>
        <tag line="133" name="subpackage" description="Import"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="143" namespace="global" package="main">
        <name>$_currentLineNumber</name>
        <default><![CDATA[0]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="144" namespace="global" package="main">
        <name>$_currentLine</name>
        <default><![CDATA['']]></default>
      </property>
      <property final="false" static="false" visibility="private" line="145" namespace="global" package="main">
        <name>$template</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="146" namespace="global" package="main">
        <name>$error</name>
        <default><![CDATA[array()]]></default>
      </property>
      <method final="false" abstract="false" static="true" visibility="public" namespace="global" line="148" package="phpLDAPadmin\Import">
        <name>getType</name>
        <full_name>getType</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="152" package="phpLDAPadmin\Import">
        <name>getTemplate</name>
        <full_name>getTemplate</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="156" package="phpLDAPadmin\Import">
        <name>getServer</name>
        <full_name>getServer</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="160" package="phpLDAPadmin\Import">
        <name>readEntry</name>
        <full_name>readEntry</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="246" package="phpLDAPadmin\Import">
        <name>getAttrValue</name>
        <full_name>getAttrValue</full_name>
        <docblock line="243">
          <description><![CDATA[Get the Attribute and Decoded Value]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="246">
          <name>$line</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="263" package="phpLDAPadmin\Import">
        <name>nextLines</name>
        <full_name>nextLines</full_name>
        <docblock line="258">
          <description><![CDATA[Get the lines of the next entry]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="258" name="return" description="lines (unfolded) of the next entry" type="\The">
            <type by_reference="false">\The</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="301" package="phpLDAPadmin\Import">
        <name>hasMoreEntries</name>
        <full_name>hasMoreEntries</full_name>
        <docblock line="296">
          <description><![CDATA[Private method to check if there is more entries in the input.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="296" name="return" description="true if an entry was found, false otherwise." type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="323" package="phpLDAPadmin\Import">
        <name>nextLine</name>
        <full_name>nextLine</full_name>
        <docblock line="320">
          <description><![CDATA[Helper method to switch to the next line]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="333" package="phpLDAPadmin\Import">
        <name>isCommentLine</name>
        <full_name>isCommentLine</full_name>
        <docblock line="328">
          <description><![CDATA[Check if it's a comment line.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="328" name="return" description="true if it's a comment line,false otherwise" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="342" package="phpLDAPadmin\Import">
        <name>isWrappedLine</name>
        <full_name>isWrappedLine</full_name>
        <docblock line="337">
          <description><![CDATA[Check if it's a wrapped line.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="337" name="return" description="true if it's a wrapped line,false otherwise" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="351" package="phpLDAPadmin\Import">
        <name>isBlankLine</name>
        <full_name>isBlankLine</full_name>
        <docblock line="346">
          <description><![CDATA[Check if is the current line is a blank line.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="346" name="return" description="if it is a blank line,false otherwise." type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="360" package="phpLDAPadmin\Import">
        <name>eof</name>
        <full_name>eof</full_name>
        <docblock line="355">
          <description><![CDATA[Returns true if we reached the end of the input.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="355" name="return" description="true if it's the end of file, false otherwise." type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="364" package="phpLDAPadmin\Import">
        <name>error</name>
        <full_name>error</full_name>
        <argument line="364">
          <name>$msg</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="364">
          <name>$data</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="377" package="phpLDAPadmin\Import">
        <name>getAttributeValue</name>
        <full_name>getAttributeValue</full_name>
        <docblock line="373">
          <description><![CDATA[Method to retrieve the attribute value of a ldif line,
and get the base 64 decoded value if it is encoded]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="377">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="408" package="phpLDAPadmin\Import">
        <name>getAddDetails</name>
        <full_name>getAddDetails</full_name>
        <docblock line="405">
          <description><![CDATA[Build the attributes array when the change type is add.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="408">
          <name>$lines</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="427" package="phpLDAPadmin\Import">
        <name>getModifyDetails</name>
        <full_name>getModifyDetails</full_name>
        <docblock line="424">
          <description><![CDATA[Build the attributes array for the entry when the change type is modify]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="427">
          <name>$lines</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="554" package="phpLDAPadmin\Import">
        <name>getModRDNAttributes</name>
        <full_name>getModRDNAttributes</full_name>
        <docblock line="551">
          <description><![CDATA[Build the attributes for the entry when the change type is modrdn]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="554">
          <name>$lines</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <parse_markers>
      <error line="23" code="50018">No DocBlock was found for property $server_id</error>
      <error line="25" code="50018">No DocBlock was found for property $template_id</error>
      <error line="26" code="50018">No DocBlock was found for property $template</error>
      <error line="28" code="50010">No DocBlock was found for method __construct()</error>
      <error line="35" code="50010">No DocBlock was found for method types()</error>
      <error line="44" code="50010">No DocBlock was found for method accept()</error>
      <error line="57" code="50010">No DocBlock was found for method getTemplate()</error>
      <error line="72" code="50018">No DocBlock was found for property $server_id</error>
      <error line="73" code="50018">No DocBlock was found for property $input</error>
      <error line="74" code="50018">No DocBlock was found for property $source</error>
      <error line="76" code="50010">No DocBlock was found for method __construct()</error>
      <error line="80" code="50010">No DocBlock was found for method accept()</error>
      <error line="102" code="50010">No DocBlock was found for method getSource()</error>
      <error line="110" code="50010">No DocBlock was found for method LDAPimport()</error>
      <error line="143" code="50018">No DocBlock was found for property $_currentLineNumber</error>
      <error line="144" code="50018">No DocBlock was found for property $_currentLine</error>
      <error line="145" code="50018">No DocBlock was found for property $template</error>
      <error line="146" code="50018">No DocBlock was found for property $error</error>
      <error line="148" code="50010">No DocBlock was found for method getType()</error>
      <error line="152" code="50010">No DocBlock was found for method getTemplate()</error>
      <error line="156" code="50010">No DocBlock was found for method getServer()</error>
      <error line="160" code="50010">No DocBlock was found for method readEntry()</error>
      <error line="243" code="50015">Argument $line is missing from the Docblock of getAttrValue()</error>
      <error line="364" code="50010">No DocBlock was found for method error()</error>
      <error line="373" code="50015">Argument $value is missing from the Docblock of getAttributeValue()</error>
      <error line="405" code="50015">Argument $lines is missing from the Docblock of getAddDetails()</error>
      <error line="424" code="50015">Argument $lines is missing from the Docblock of getModifyDetails()</error>
      <error line="551" code="50015">Argument $lines is missing from the Docblock of getModRDNAttributes()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/lib/Attribute.php" hash="8c5cc7f3fa1722c815e6d2a5c2c263b8" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Classes and functions for the template engine.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="15" package="phpLDAPadmin\Templates">
      <extends/>
      <name>Attribute</name>
      <full_name>\Attribute</full_name>
      <docblock line="9">
        <description><![CDATA[Represents an attribute of a template.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="9" name="package" description="phpLDAPadmin"/>
        <tag line="9" name="subpackage" description="Templates"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="17" namespace="global" package="main">
        <name>$name</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="19" namespace="global" package="main">
        <name>$source</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="22" namespace="global" package="main">
        <name>$oldvalues</name>
        <default><![CDATA[array()]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="23" namespace="global" package="main">
        <name>$values</name>
        <default><![CDATA[array()]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="26" namespace="global" package="main">
        <name>$min_value_count</name>
        <default><![CDATA[-1]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="27" namespace="global" package="main">
        <name>$max_value_count</name>
        <default><![CDATA[-1]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="30" namespace="global" package="main">
        <name>$internal</name>
        <default><![CDATA[false]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="32" namespace="global" package="main">
        <name>$modified</name>
        <default><![CDATA[false]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="34" namespace="global" package="main">
        <name>$forcedelete</name>
        <default><![CDATA[false]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="36" namespace="global" package="main">
        <name>$visible</name>
        <default><![CDATA[false]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="37" namespace="global" package="main">
        <name>$forcehide</name>
        <default><![CDATA[false]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="39" namespace="global" package="main">
        <name>$readonly</name>
        <default><![CDATA[false]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="41" namespace="global" package="main">
        <name>$ldaptype</name>
        <default><![CDATA[null]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="43" namespace="global" package="main">
        <name>$type</name>
        <default><![CDATA['']]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="45" namespace="global" package="main">
        <name>$unique</name>
        <default><![CDATA[false]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="48" namespace="global" package="main">
        <name>$display</name>
        <default><![CDATA['']]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="49" namespace="global" package="main">
        <name>$icon</name>
        <default><![CDATA['']]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="50" namespace="global" package="main">
        <name>$hint</name>
        <default><![CDATA['']]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="52" namespace="global" package="main">
        <name>$helper</name>
        <default><![CDATA[array()]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="53" namespace="global" package="main">
        <name>$helpervalue</name>
        <default><![CDATA[array()]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="55" namespace="global" package="main">
        <name>$onchange</name>
        <default><![CDATA[array()]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="57" namespace="global" package="main">
        <name>$spacer</name>
        <default><![CDATA[false]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="58" namespace="global" package="main">
        <name>$verify</name>
        <default><![CDATA[false]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="61" namespace="global" package="main">
        <name>$size</name>
        <default><![CDATA[0]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="63" namespace="global" package="main">
        <name>$maxlength</name>
        <default><![CDATA[0]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="65" namespace="global" package="main">
        <name>$cols</name>
        <default><![CDATA[0]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="66" namespace="global" package="main">
        <name>$rows</name>
        <default><![CDATA[0]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="69" namespace="global" package="main">
        <name>$page</name>
        <default><![CDATA[1]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="70" namespace="global" package="main">
        <name>$order</name>
        <default><![CDATA[255]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="71" namespace="global" package="main">
        <name>$ordersort</name>
        <default><![CDATA[255]]></default>
      </property>
      <property final="false" static="false" visibility="public" line="72" namespace="global" package="main">
        <name>$rdn</name>
        <default><![CDATA[false]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="75" namespace="global" package="main">
        <name>$aliases</name>
        <default><![CDATA[array()]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="78" namespace="global" package="main">
        <name>$autovalue</name>
        <default><![CDATA[array()]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="79" namespace="global" package="main">
        <name>$postvalue</name>
        <default><![CDATA[array()]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="81" package="phpLDAPadmin\Templates">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <argument line="81">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="81">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="81">
          <name>$server_id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="81">
          <name>$source</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="131" package="phpLDAPadmin\Templates">
        <name>getName</name>
        <full_name>getName</full_name>
        <docblock line="124">
          <description><![CDATA[Return the name of the attribute.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="124" name="param" description="- Return the attribute in normal or lower case (default lower)" type="boolean" variable="$lower">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="124" name="param" description="- Return the real attribute name (with ;binary, or just the name)" type="boolean" variable="$real">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="124" name="return" description="Attribute name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="131">
          <name>$lower</name>
          <default><![CDATA[true]]></default>
          <type/>
        </argument>
        <argument line="131">
          <name>$real</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="141" package="phpLDAPadmin\Templates">
        <name>getValues</name>
        <full_name>getValues</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="148" package="phpLDAPadmin\Templates">
        <name>getOldValues</name>
        <full_name>getOldValues</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="155" package="phpLDAPadmin\Templates">
        <name>getValueCount</name>
        <full_name>getValueCount</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="162" package="phpLDAPadmin\Templates">
        <name>getSource</name>
        <full_name>getSource</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="172" package="phpLDAPadmin\Templates">
        <name>autoValue</name>
        <full_name>autoValue</full_name>
        <docblock line="169">
          <description><![CDATA[Autovalue is called after the attribute is initialised, and thus the values from the ldap server will be set.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="172">
          <name>$new_val</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="182" package="phpLDAPadmin\Templates">
        <name>initValue</name>
        <full_name>initValue</full_name>
        <argument line="182">
          <name>$new_val</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="194" package="phpLDAPadmin\Templates">
        <name>clearValue</name>
        <full_name>clearValue</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="201" package="phpLDAPadmin\Templates">
        <name>setOldValue</name>
        <full_name>setOldValue</full_name>
        <argument line="201">
          <name>$val</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="208" package="phpLDAPadmin\Templates">
        <name>setValue</name>
        <full_name>setValue</full_name>
        <argument line="208">
          <name>$new_val</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="230" package="phpLDAPadmin\Templates">
        <name>addValue</name>
        <full_name>addValue</full_name>
        <argument line="230">
          <name>$new_val</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="230">
          <name>$i</name>
          <default><![CDATA[-1]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="244" package="phpLDAPadmin\Templates">
        <name>delValue</name>
        <full_name>delValue</full_name>
        <argument line="244">
          <name>$i</name>
          <default><![CDATA[-1]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="261" package="phpLDAPadmin\Templates">
        <name>getValue</name>
        <full_name>getValue</full_name>
        <argument line="261">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="271" package="phpLDAPadmin\Templates">
        <name>getOldValue</name>
        <full_name>getOldValue</full_name>
        <argument line="271">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="281" package="phpLDAPadmin\Templates">
        <name>getMinValueCount</name>
        <full_name>getMinValueCount</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="288" package="phpLDAPadmin\Templates">
        <name>setMinValueCount</name>
        <full_name>setMinValueCount</full_name>
        <argument line="288">
          <name>$min</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="295" package="phpLDAPadmin\Templates">
        <name>getMaxValueCount</name>
        <full_name>getMaxValueCount</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="302" package="phpLDAPadmin\Templates">
        <name>setMaxValueCount</name>
        <full_name>setMaxValueCount</full_name>
        <argument line="302">
          <name>$max</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="309" package="phpLDAPadmin\Templates">
        <name>haveMoreValues</name>
        <full_name>haveMoreValues</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="319" package="phpLDAPadmin\Templates">
        <name>justModified</name>
        <full_name>justModified</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="326" package="phpLDAPadmin\Templates">
        <name>hasBeenModified</name>
        <full_name>hasBeenModified</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="333" package="phpLDAPadmin\Templates">
        <name>isForceDelete</name>
        <full_name>isForceDelete</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="340" package="phpLDAPadmin\Templates">
        <name>setForceDelete</name>
        <full_name>setForceDelete</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="350" package="phpLDAPadmin\Templates">
        <name>isInternal</name>
        <full_name>isInternal</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="357" package="phpLDAPadmin\Templates">
        <name>setInternal</name>
        <full_name>setInternal</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="364" package="phpLDAPadmin\Templates">
        <name>isRequired</name>
        <full_name>isRequired</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="378" package="phpLDAPadmin\Templates">
        <name>isMay</name>
        <full_name>isMay</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="388" package="phpLDAPadmin\Templates">
        <name>setType</name>
        <full_name>setType</full_name>
        <argument line="388">
          <name>$type</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="395" package="phpLDAPadmin\Templates">
        <name>getType</name>
        <full_name>getType</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="402" package="phpLDAPadmin\Templates">
        <name>setLDAPtype</name>
        <full_name>setLDAPtype</full_name>
        <argument line="402">
          <name>$type</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="409" package="phpLDAPadmin\Templates">
        <name>getLDAPtype</name>
        <full_name>getLDAPtype</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="416" package="phpLDAPadmin\Templates">
        <name>setProperties</name>
        <full_name>setProperties</full_name>
        <argument line="416">
          <name>$properties</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="451" package="phpLDAPadmin\Templates">
        <name>setRequired</name>
        <full_name>setRequired</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="459" package="phpLDAPadmin\Templates">
        <name>setOptional</name>
        <full_name>setOptional</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="466" package="phpLDAPadmin\Templates">
        <name>isReadOnly</name>
        <full_name>isReadOnly</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="473" package="phpLDAPadmin\Templates">
        <name>setReadOnly</name>
        <full_name>setReadOnly</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="480" package="phpLDAPadmin\Templates">
        <name>isMultiple</name>
        <full_name>isMultiple</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="484" package="phpLDAPadmin\Templates">
        <name>isVisible</name>
        <full_name>isVisible</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="491" package="phpLDAPadmin\Templates">
        <name>hide</name>
        <full_name>hide</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="498" package="phpLDAPadmin\Templates">
        <name>show</name>
        <full_name>show</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="505" package="phpLDAPadmin\Templates">
        <name>haveFriendlyName</name>
        <full_name>haveFriendlyName</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="512" package="phpLDAPadmin\Templates">
        <name>getFriendlyName</name>
        <full_name>getFriendlyName</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="522" package="phpLDAPadmin\Templates">
        <name>setDescription</name>
        <full_name>setDescription</full_name>
        <argument line="522">
          <name>$description</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="529" package="phpLDAPadmin\Templates">
        <name>getDescription</name>
        <full_name>getDescription</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="536" package="phpLDAPadmin\Templates">
        <name>setIcon</name>
        <full_name>setIcon</full_name>
        <argument line="536">
          <name>$icon</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="543" package="phpLDAPadmin\Templates">
        <name>getIcon</name>
        <full_name>getIcon</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="550" package="phpLDAPadmin\Templates">
        <name>getHint</name>
        <full_name>getHint</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="557" package="phpLDAPadmin\Templates">
        <name>setHint</name>
        <full_name>setHint</full_name>
        <argument line="557">
          <name>$hint</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="564" package="phpLDAPadmin\Templates">
        <name>getMaxLength</name>
        <full_name>getMaxLength</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="571" package="phpLDAPadmin\Templates">
        <name>setMaxLength</name>
        <full_name>setMaxLength</full_name>
        <argument line="571">
          <name>$maxlength</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="578" package="phpLDAPadmin\Templates">
        <name>getSize</name>
        <full_name>getSize</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="585" package="phpLDAPadmin\Templates">
        <name>setSize</name>
        <full_name>setSize</full_name>
        <argument line="585">
          <name>$size</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="592" package="phpLDAPadmin\Templates">
        <name>getSpacer</name>
        <full_name>getSpacer</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="599" package="phpLDAPadmin\Templates">
        <name>getPage</name>
        <full_name>getPage</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="605" package="phpLDAPadmin\Templates">
        <name>setPage</name>
        <full_name>setPage</full_name>
        <argument line="605">
          <name>$page</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="612" package="phpLDAPadmin\Templates">
        <name>getOnChange</name>
        <full_name>getOnChange</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="619" package="phpLDAPadmin\Templates">
        <name>getHelper</name>
        <full_name>getHelper</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="626" package="phpLDAPadmin\Templates">
        <name>getHelperValue</name>
        <full_name>getHelperValue</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="633" package="phpLDAPadmin\Templates">
        <name>getVerify</name>
        <full_name>getVerify</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="640" package="phpLDAPadmin\Templates">
        <name>setRDN</name>
        <full_name>setRDN</full_name>
        <argument line="640">
          <name>$rdn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="652" package="phpLDAPadmin\Templates">
        <name>isRDN</name>
        <full_name>isRDN</full_name>
        <docblock line="647">
          <description><![CDATA[Return if this attribute is an RDN attribute]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="647" name="return" description="" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="664" package="phpLDAPadmin\Templates">
        <name>setLDAPdetails</name>
        <full_name>setLDAPdetails</full_name>
        <docblock line="659">
          <description><![CDATA[Capture all the LDAP details we are interested in]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="659" name="param" description="Schema Attribute" type="\sattr" variable="$sattr">
            <type by_reference="false">\sattr</type>
          </tag>
        </docblock>
        <argument line="664">
          <name>$sattr</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="684" package="phpLDAPadmin\Templates">
        <name>getAliases</name>
        <full_name>getAliases</full_name>
        <docblock line="680">
          <description><![CDATA[Return a list of aliases for this Attribute (as defined by the schema)
This list will be lowercase.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="691" package="phpLDAPadmin\Templates">
        <name>getAutoValue</name>
        <full_name>getAutoValue</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="698" package="phpLDAPadmin\Templates">
        <name>getPostValue</name>
        <full_name>getPostValue</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="705" package="phpLDAPadmin\Templates">
        <name>setPostValue</name>
        <full_name>setPostValue</full_name>
        <argument line="705">
          <name>$postvalue</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="712" package="phpLDAPadmin\Templates">
        <name>setXML</name>
        <full_name>setXML</full_name>
        <argument line="712">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="850" package="phpLDAPadmin\Templates">
        <name>getRemovedValues</name>
        <full_name>getRemovedValues</full_name>
        <docblock line="847">
          <description><![CDATA[Display the values removed in an attribute.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="860" package="phpLDAPadmin\Templates">
        <name>getAddedValues</name>
        <full_name>getAddedValues</full_name>
        <docblock line="857">
          <description><![CDATA[Display the values removed in an attribute.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="876" package="phpLDAPadmin\Templates">
        <name>real_attr_name</name>
        <full_name>real_attr_name</full_name>
        <docblock line="867">
          <description><![CDATA[Prunes off anything after the ";" in an attr name.]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="867" name="param" description="The name of the attribute to examine." type="string" variable="$attr_name">
            <type by_reference="false">string</type>
          </tag>
          <tag line="867" name="return" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="886" package="phpLDAPadmin\Templates">
        <name>needJS</name>
        <full_name>needJS</full_name>
        <docblock line="883">
          <description><![CDATA[Does this attribute need supporting JS]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="886">
          <name>$type</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <parse_markers>
      <error line="17" code="50018">No DocBlock was found for property $name</error>
      <error line="19" code="50018">No DocBlock was found for property $source</error>
      <error line="22" code="50018">No DocBlock was found for property $oldvalues</error>
      <error line="23" code="50018">No DocBlock was found for property $values</error>
      <error line="26" code="50018">No DocBlock was found for property $min_value_count</error>
      <error line="27" code="50018">No DocBlock was found for property $max_value_count</error>
      <error line="30" code="50018">No DocBlock was found for property $internal</error>
      <error line="32" code="50018">No DocBlock was found for property $modified</error>
      <error line="34" code="50018">No DocBlock was found for property $forcedelete</error>
      <error line="36" code="50018">No DocBlock was found for property $visible</error>
      <error line="37" code="50018">No DocBlock was found for property $forcehide</error>
      <error line="39" code="50018">No DocBlock was found for property $readonly</error>
      <error line="41" code="50018">No DocBlock was found for property $ldaptype</error>
      <error line="43" code="50018">No DocBlock was found for property $type</error>
      <error line="45" code="50018">No DocBlock was found for property $unique</error>
      <error line="48" code="50018">No DocBlock was found for property $display</error>
      <error line="49" code="50018">No DocBlock was found for property $icon</error>
      <error line="50" code="50018">No DocBlock was found for property $hint</error>
      <error line="52" code="50018">No DocBlock was found for property $helper</error>
      <error line="53" code="50018">No DocBlock was found for property $helpervalue</error>
      <error line="55" code="50018">No DocBlock was found for property $onchange</error>
      <error line="57" code="50018">No DocBlock was found for property $spacer</error>
      <error line="58" code="50018">No DocBlock was found for property $verify</error>
      <error line="61" code="50018">No DocBlock was found for property $size</error>
      <error line="63" code="50018">No DocBlock was found for property $maxlength</error>
      <error line="65" code="50018">No DocBlock was found for property $cols</error>
      <error line="66" code="50018">No DocBlock was found for property $rows</error>
      <error line="69" code="50018">No DocBlock was found for property $page</error>
      <error line="70" code="50018">No DocBlock was found for property $order</error>
      <error line="71" code="50018">No DocBlock was found for property $ordersort</error>
      <error line="72" code="50018">No DocBlock was found for property $rdn</error>
      <error line="75" code="50018">No DocBlock was found for property $aliases</error>
      <error line="78" code="50018">No DocBlock was found for property $autovalue</error>
      <error line="79" code="50018">No DocBlock was found for property $postvalue</error>
      <error line="81" code="50010">No DocBlock was found for method __construct()</error>
      <error line="141" code="50010">No DocBlock was found for method getValues()</error>
      <error line="148" code="50010">No DocBlock was found for method getOldValues()</error>
      <error line="155" code="50010">No DocBlock was found for method getValueCount()</error>
      <error line="162" code="50010">No DocBlock was found for method getSource()</error>
      <error line="169" code="50015">Argument $new_val is missing from the Docblock of autoValue()</error>
      <error line="182" code="50010">No DocBlock was found for method initValue()</error>
      <error line="194" code="50010">No DocBlock was found for method clearValue()</error>
      <error line="201" code="50010">No DocBlock was found for method setOldValue()</error>
      <error line="208" code="50010">No DocBlock was found for method setValue()</error>
      <error line="230" code="50010">No DocBlock was found for method addValue()</error>
      <error line="244" code="50010">No DocBlock was found for method delValue()</error>
      <error line="261" code="50010">No DocBlock was found for method getValue()</error>
      <error line="271" code="50010">No DocBlock was found for method getOldValue()</error>
      <error line="281" code="50010">No DocBlock was found for method getMinValueCount()</error>
      <error line="288" code="50010">No DocBlock was found for method setMinValueCount()</error>
      <error line="295" code="50010">No DocBlock was found for method getMaxValueCount()</error>
      <error line="302" code="50010">No DocBlock was found for method setMaxValueCount()</error>
      <error line="309" code="50010">No DocBlock was found for method haveMoreValues()</error>
      <error line="319" code="50010">No DocBlock was found for method justModified()</error>
      <error line="326" code="50010">No DocBlock was found for method hasBeenModified()</error>
      <error line="333" code="50010">No DocBlock was found for method isForceDelete()</error>
      <error line="340" code="50010">No DocBlock was found for method setForceDelete()</error>
      <error line="350" code="50010">No DocBlock was found for method isInternal()</error>
      <error line="357" code="50010">No DocBlock was found for method setInternal()</error>
      <error line="364" code="50010">No DocBlock was found for method isRequired()</error>
      <error line="378" code="50010">No DocBlock was found for method isMay()</error>
      <error line="388" code="50010">No DocBlock was found for method setType()</error>
      <error line="395" code="50010">No DocBlock was found for method getType()</error>
      <error line="402" code="50010">No DocBlock was found for method setLDAPtype()</error>
      <error line="409" code="50010">No DocBlock was found for method getLDAPtype()</error>
      <error line="416" code="50010">No DocBlock was found for method setProperties()</error>
      <error line="451" code="50010">No DocBlock was found for method setRequired()</error>
      <error line="459" code="50010">No DocBlock was found for method setOptional()</error>
      <error line="466" code="50010">No DocBlock was found for method isReadOnly()</error>
      <error line="473" code="50010">No DocBlock was found for method setReadOnly()</error>
      <error line="480" code="50010">No DocBlock was found for method isMultiple()</error>
      <error line="484" code="50010">No DocBlock was found for method isVisible()</error>
      <error line="491" code="50010">No DocBlock was found for method hide()</error>
      <error line="498" code="50010">No DocBlock was found for method show()</error>
      <error line="505" code="50010">No DocBlock was found for method haveFriendlyName()</error>
      <error line="512" code="50010">No DocBlock was found for method getFriendlyName()</error>
      <error line="522" code="50010">No DocBlock was found for method setDescription()</error>
      <error line="529" code="50010">No DocBlock was found for method getDescription()</error>
      <error line="536" code="50010">No DocBlock was found for method setIcon()</error>
      <error line="543" code="50010">No DocBlock was found for method getIcon()</error>
      <error line="550" code="50010">No DocBlock was found for method getHint()</error>
      <error line="557" code="50010">No DocBlock was found for method setHint()</error>
      <error line="564" code="50010">No DocBlock was found for method getMaxLength()</error>
      <error line="571" code="50010">No DocBlock was found for method setMaxLength()</error>
      <error line="578" code="50010">No DocBlock was found for method getSize()</error>
      <error line="585" code="50010">No DocBlock was found for method setSize()</error>
      <error line="592" code="50010">No DocBlock was found for method getSpacer()</error>
      <error line="599" code="50010">No DocBlock was found for method getPage()</error>
      <error line="605" code="50010">No DocBlock was found for method setPage()</error>
      <error line="612" code="50010">No DocBlock was found for method getOnChange()</error>
      <error line="619" code="50010">No DocBlock was found for method getHelper()</error>
      <error line="626" code="50010">No DocBlock was found for method getHelperValue()</error>
      <error line="633" code="50010">No DocBlock was found for method getVerify()</error>
      <error line="640" code="50010">No DocBlock was found for method setRDN()</error>
      <error line="691" code="50010">No DocBlock was found for method getAutoValue()</error>
      <error line="698" code="50010">No DocBlock was found for method getPostValue()</error>
      <error line="705" code="50010">No DocBlock was found for method setPostValue()</error>
      <error line="712" code="50010">No DocBlock was found for method setXML()</error>
      <notice line="867" code="50013">Parameter $attr_name could not be found in real_attr_name()</notice>
      <error line="883" code="50015">Argument $type is missing from the Docblock of needJS()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/lib/emuhash_functions.php" hash="81afdc7c474056fd6f6ec5b92fa7aa37" package="main">
    <constant namespace="global" line="50" package="main">
      <name>MHASH_MD5</name>
      <full_name>\MHASH_MD5</full_name>
      <value><![CDATA['md5']]></value>
    </constant>
    <constant namespace="global" line="51" package="main">
      <name>MHASH_SHA1</name>
      <full_name>\MHASH_SHA1</full_name>
      <value><![CDATA['sha1']]></value>
    </constant>
    <constant namespace="global" line="52" package="main">
      <name>MHASH_RIPEMD160</name>
      <full_name>\MHASH_RIPEMD160</full_name>
      <value><![CDATA['rmd160']]></value>
    </constant>
    <function namespace="global" line="58" package="main">
      <name>openssl_hash</name>
      <full_name>\openssl_hash</full_name>
      <argument line="58">
        <name>$openssl_hash_id</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="58">
        <name>$password_clear</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="86" package="main">
      <name>mhash</name>
      <full_name>\mhash</full_name>
      <argument line="86">
        <name>$hash_id</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="86">
        <name>$password_clear</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="107" package="main">
      <name>mhash_keygen_s2k</name>
      <full_name>\mhash_keygen_s2k</full_name>
      <argument line="107">
        <name>$hash_id</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="107">
        <name>$password_clear</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="107">
        <name>$salt</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="107">
        <name>$bytes</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <parse_markers>
      <error line="0" code="50007">No page-level DocBlock was found in file templates/3rdParty/pla/lib/emuhash_functions.php</error>
      <error line="58" code="50009">No DocBlock was found for function \openssl_hash()</error>
      <error line="86" code="50009">No DocBlock was found for function \mhash()</error>
      <error line="107" code="50009">No DocBlock was found for function \mhash_keygen_s2k()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/lib/MultiLineAttribute.php" hash="34840800799bfc876a25ecca65e726a4" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Classes and functions for the template engine.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="15" package="phpLDAPadmin\Templates">
      <extends>\Attribute</extends>
      <name>MultiLineAttribute</name>
      <full_name>\MultiLineAttribute</full_name>
      <docblock line="9">
        <description><![CDATA[Represents a attribute whose values are multiline text]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="9" name="package" description="phpLDAPadmin"/>
        <tag line="9" name="subpackage" description="Templates"/>
      </docblock>
      <property final="false" static="false" visibility="protected" line="16" namespace="global" package="main">
        <name>$rows</name>
        <default><![CDATA[0]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="17" namespace="global" package="main">
        <name>$cols</name>
        <default><![CDATA[0]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="19" package="phpLDAPadmin\Templates">
        <name>getRows</name>
        <full_name>getRows</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="23" package="phpLDAPadmin\Templates">
        <name>setRows</name>
        <full_name>setRows</full_name>
        <argument line="23">
          <name>$rows</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="27" package="phpLDAPadmin\Templates">
        <name>getCols</name>
        <full_name>getCols</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="31" package="phpLDAPadmin\Templates">
        <name>setCols</name>
        <full_name>setCols</full_name>
        <argument line="31">
          <name>$cols</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <parse_markers>
      <error line="16" code="50018">No DocBlock was found for property $rows</error>
      <error line="17" code="50018">No DocBlock was found for property $cols</error>
      <error line="19" code="50010">No DocBlock was found for method getRows()</error>
      <error line="23" code="50010">No DocBlock was found for method setRows()</error>
      <error line="27" code="50010">No DocBlock was found for method getCols()</error>
      <error line="31" code="50010">No DocBlock was found for method setCols()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/lib/Tree.php" hash="9427ea7aebad73e8e4c1e5ad24c47c1d" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Classes and functions for the LDAP tree.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="17" package="phpLDAPadmin\Tree">
      <extends/>
      <name>Tree</name>
      <full_name>\Tree</full_name>
      <docblock line="9">
        <description><![CDATA[Abstract class which represents the LDAP tree view ; the draw() method
must be implemented by subclasses]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="9" name="package" description="phpLDAPadmin"/>
        <tag line="9" name="subpackage" description="Tree"/>
        <tag line="9" name="see" description="\global\HTMLTree" refers="\global\HTMLTree"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="19" namespace="global" package="main">
        <name>$server_id</name>
        <default><![CDATA[null]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="21" namespace="global" package="main">
        <name>$entries</name>
        <default><![CDATA[array()]]></default>
      </property>
      <method final="false" abstract="true" static="false" visibility="public" namespace="global" line="26" package="phpLDAPadmin\Tree">
        <name>draw</name>
        <full_name>draw</full_name>
        <docblock line="23">
          <description><![CDATA[Displays the LDAP tree]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="28" package="phpLDAPadmin\Tree">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <argument line="28">
          <name>$server_id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="global" line="41" package="phpLDAPadmin\Tree">
        <name>getInstance</name>
        <full_name>getInstance</full_name>
        <docblock line="35">
          <description><![CDATA[Create an instance of the tree - this is used when we call this class directly
Tree::getInstance($index)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="35" name="return" description="Tree" type="object">
            <type by_reference="false">object</type>
          </tag>
        </docblock>
        <argument line="41">
          <name>$server_id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="78" package="phpLDAPadmin\Tree">
        <name>getServerID</name>
        <full_name>getServerID</full_name>
        <docblock line="73">
          <description><![CDATA[Get the Server ID for this tree]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="73" name="return" description="Server ID that this tree is for" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="90" package="phpLDAPadmin\Tree">
        <name>getServer</name>
        <full_name>getServer</full_name>
        <docblock line="85">
          <description><![CDATA[Get the server Object for this tree]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="85" name="return" description="Server Object for this tree" type="object">
            <type by_reference="false">object</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="102" package="phpLDAPadmin\Tree">
        <name>getBaseEntries</name>
        <full_name>getBaseEntries</full_name>
        <docblock line="97">
          <description><![CDATA[Get the entries that are BaseDN entries.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="97" name="return" description="Base DN entries" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="127" package="phpLDAPadmin\Tree">
        <name>indexDN</name>
        <full_name>indexDN</full_name>
        <docblock line="115">
          <description><![CDATA[This function will take the DN, convert it to lowercase and strip unnessary
commas.]]></description>
          <long-description><![CDATA[<p>This result will be used as the index for the tree object.
Any display of a DN should use the object->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.</p>]]></long-description>
          <tag line="115" name="param" description="DN to clean" type="\dn" variable="$dn">
            <type by_reference="false">\dn</type>
          </tag>
          <tag line="115" name="return" description="Lowercase clean DN" type="\dn">
            <type by_reference="false">\dn</type>
          </tag>
        </docblock>
        <argument line="127">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="145" package="phpLDAPadmin\Tree">
        <name>getEntry</name>
        <full_name>getEntry</full_name>
        <docblock line="139">
          <description><![CDATA[Get a tree entry]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="139" name="param" description="DN to retrieve" type="\dn" variable="$dn">
            <type by_reference="false">\dn</type>
          </tag>
          <tag line="139" name="return" description="Tree DN object" type="object">
            <type by_reference="false">object</type>
          </tag>
        </docblock>
        <argument line="145">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="164" package="phpLDAPadmin\Tree">
        <name>addEntry</name>
        <full_name>addEntry</full_name>
        <docblock line="157">
          <description><![CDATA[Add an entry in the tree view ; the entry is added in the
children array of its parent]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="157" name="param" description="DN to add" type="\dn" variable="$dn">
            <type by_reference="false">\dn</type>
          </tag>
          <tag line="157" name="param" description="the dn of the entry to create" type="string" variable="$dn">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="164">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="221" package="phpLDAPadmin\Tree">
        <name>delEntry</name>
        <full_name>delEntry</full_name>
        <docblock line="215">
          <description><![CDATA[Delete an entry from the tree view ; the entry is deleted from the
children array of its parent]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="215" name="param" description="DN to remote" type="\dn" variable="$dn">
            <type by_reference="false">\dn</type>
          </tag>
        </docblock>
        <argument line="221">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="245" package="phpLDAPadmin\Tree">
        <name>renameEntry</name>
        <full_name>renameEntry</full_name>
        <docblock line="239">
          <description><![CDATA[Rename an entry in the tree]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="239" name="param" description="Old DN" type="\dn" variable="$dnOLD">
            <type by_reference="false">\dn</type>
          </tag>
          <tag line="239" name="param" description="New DN" type="\dn" variable="$dnNEW">
            <type by_reference="false">\dn</type>
          </tag>
        </docblock>
        <argument line="245">
          <name>$dnOLD</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="245">
          <name>$dnNEW</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="277" package="phpLDAPadmin\Tree">
        <name>readChildren</name>
        <full_name>readChildren</full_name>
        <docblock line="271">
          <description><![CDATA[Read the children of a tree entry]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="271" name="param" description="DN of the entry" type="\dn" variable="$dn">
            <type by_reference="false">\dn</type>
          </tag>
          <tag line="271" name="param" description="LDAP Size Limit" type="boolean" variable="$nolimit">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="277">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="277">
          <name>$nolimit</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="331" package="phpLDAPadmin\Tree">
        <name>readChildrenNumber</name>
        <full_name>readChildrenNumber</full_name>
        <docblock line="325">
          <description><![CDATA[Return the number of children an entry has.]]></description>
          <long-description><![CDATA[<p>Optionally autoread the child entry.</p>]]></long-description>
          <tag line="325" name="param" description="DN of the entry" type="\dn" variable="$dn">
            <type by_reference="false">\dn</type>
          </tag>
          <tag line="325" name="param" description="LDAP Size Limit" type="boolean" variable="$nolimit">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="331">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="331">
          <name>$nolimit</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <parse_markers>
      <error line="19" code="50018">No DocBlock was found for property $server_id</error>
      <error line="21" code="50018">No DocBlock was found for property $entries</error>
      <error line="28" code="50010">No DocBlock was found for method __construct()</error>
      <error line="35" code="50015">Argument $server_id is missing from the Docblock of getInstance()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/lib/session_functions.php" hash="1b138eeffda8f89af5f160f23c1b0ea6" package="phpLDAPadmin\Session">
    <docblock line="2">
      <description><![CDATA[A collection of functions to handle sessions.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Session"/>
    </docblock>
    <include line="10" type="Include Once" package="main">
      <name>../../../../lib/security.inc</name>
    </include>
    <include line="21" type="Include Once" package="main">
      <name>../../../../lib/config.inc</name>
    </include>
    <include line="22" type="Include Once" package="main">
      <name>../../../../lib/ldap.inc</name>
    </include>
    <function namespace="global" line="19" package="phpLDAPadmin\Session">
      <name>app_session_start</name>
      <full_name>\app_session_start</full_name>
      <docblock line="12">
        <description><![CDATA[The only function which should be called by a user]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="12" name="see" description="\global\common.php" refers="\global\common.php"/>
        <tag line="12" name="see" description="\global\APP_SESSION_ID" refers="\global\APP_SESSION_ID"/>
        <tag line="12" name="return" description="Returns true if the session was started the first time" type="boolean">
          <type by_reference="false">boolean</type>
        </tag>
      </docblock>
    </function>
  </file>
  <file path="templates/3rdParty/pla/lib/TreeItem.php" hash="79493d251e823a53b29e86a1076495b3" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Classes and functions for the LDAP tree.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="15" package="phpLDAPadmin\Tree">
      <extends/>
      <name>TreeItem</name>
      <full_name>\TreeItem</full_name>
      <docblock line="9">
        <description><![CDATA[Represents an item in the tree.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="9" name="package" description="phpLDAPadmin"/>
        <tag line="9" name="subpackage" description="Tree"/>
      </docblock>
      <property final="false" static="false" visibility="protected" line="17" namespace="global" package="main">
        <name>$dn</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="19" namespace="global" package="main">
        <name>$server_id</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="21" namespace="global" package="main">
        <name>$objectclasses</name>
        <default><![CDATA[array()]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="23" namespace="global" package="main">
        <name>$base_entry</name>
        <default><![CDATA[false]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="25" namespace="global" package="main">
        <name>$children</name>
        <default><![CDATA[array()]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="27" namespace="global" package="main">
        <name>$icon</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="29" namespace="global" package="main">
        <name>$leaf</name>
        <default><![CDATA[false]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="31" namespace="global" package="main">
        <name>$open</name>
        <default><![CDATA[false]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="33" namespace="global" package="main">
        <name>$size_limited</name>
        <default><![CDATA[true]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="35" namespace="global" package="main">
        <name>$template</name>
        <default><![CDATA[null]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="37" namespace="global" package="main">
        <name>$childsort</name>
        <default><![CDATA[true]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="39" namespace="global" package="main">
        <name>$reading_children</name>
        <default><![CDATA[false]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="41" package="phpLDAPadmin\Tree">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <argument line="41">
          <name>$server_id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="41">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="54" package="phpLDAPadmin\Tree">
        <name>getDN</name>
        <full_name>getDN</full_name>
        <docblock line="49">
          <description><![CDATA[Get the DN of this tree item.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="49" name="return" description="The DN of this item." type="\DN">
            <type by_reference="false">\DN</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="61" package="phpLDAPadmin\Tree">
        <name>getDNEncode</name>
        <full_name>getDNEncode</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="70" package="phpLDAPadmin\Tree">
        <name>getRDN</name>
        <full_name>getRDN</full_name>
        <docblock line="65">
          <description><![CDATA[Get the RDN of this tree items DN.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="65" name="return" description="The RDN of this items DN." type="\RDN">
            <type by_reference="false">\RDN</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="80" package="phpLDAPadmin\Tree">
        <name>setBase</name>
        <full_name>setBase</full_name>
        <docblock line="77">
          <description><![CDATA[Set this item as a LDAP base DN item.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="90" package="phpLDAPadmin\Tree">
        <name>isBaseDN</name>
        <full_name>isBaseDN</full_name>
        <docblock line="87">
          <description><![CDATA[Return if this item is a base DN item.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="97" package="phpLDAPadmin\Tree">
        <name>setObjectClasses</name>
        <full_name>setObjectClasses</full_name>
        <argument line="97">
          <name>$oc</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="104" package="phpLDAPadmin\Tree">
        <name>getObjectClasses</name>
        <full_name>getObjectClasses</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="111" package="phpLDAPadmin\Tree">
        <name>isInLDAP</name>
        <full_name>isInLDAP</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="122" package="phpLDAPadmin\Tree">
        <name>getChildren</name>
        <full_name>getChildren</full_name>
        <docblock line="118">
          <description><![CDATA[Returns null if the children have never be defined
or an array of the dn of the children]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="134" package="phpLDAPadmin\Tree">
        <name>readingChildren</name>
        <full_name>readingChildren</full_name>
        <argument line="134">
          <name>$bool</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="141" package="phpLDAPadmin\Tree">
        <name>isChildSorted</name>
        <full_name>isChildSorted</full_name>
        <docblock line="138">
          <description><![CDATA[Do the children require resorting]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="151" package="phpLDAPadmin\Tree">
        <name>childSorted</name>
        <full_name>childSorted</full_name>
        <docblock line="148">
          <description><![CDATA[Mark the children as sorted]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="163" package="phpLDAPadmin\Tree">
        <name>addChild</name>
        <full_name>addChild</full_name>
        <docblock line="158">
          <description><![CDATA[Add a child to this DN entry.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="158" name="param" description="The DN to add." type="\DN" variable="$dn">
            <type by_reference="false">\DN</type>
          </tag>
        </docblock>
        <argument line="163">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="179" package="phpLDAPadmin\Tree">
        <name>delChild</name>
        <full_name>delChild</full_name>
        <docblock line="174">
          <description><![CDATA[Delete a child from this DN entry.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="174" name="param" description="The DN to add." type="\DN" variable="$dn">
            <type by_reference="false">\DN</type>
          </tag>
        </docblock>
        <argument line="179">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="197" package="phpLDAPadmin\Tree">
        <name>rename</name>
        <full_name>rename</full_name>
        <docblock line="192">
          <description><![CDATA[Rename this DN.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="192" name="param" description="The DN to rename to." type="\DN" variable="$dn">
            <type by_reference="false">\DN</type>
          </tag>
        </docblock>
        <argument line="197">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="207" package="phpLDAPadmin\Tree">
        <name>isOpened</name>
        <full_name>isOpened</full_name>
        <docblock line="204">
          <description><![CDATA[Return if this item has been opened.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="217" package="phpLDAPadmin\Tree">
        <name>close</name>
        <full_name>close</full_name>
        <docblock line="214">
          <description><![CDATA[Mark this node as closed.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="227" package="phpLDAPadmin\Tree">
        <name>open</name>
        <full_name>open</full_name>
        <docblock line="224">
          <description><![CDATA[Opens the node ; the children of the node must have been defined]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="237" package="phpLDAPadmin\Tree">
        <name>setLeaf</name>
        <full_name>setLeaf</full_name>
        <docblock line="234">
          <description><![CDATA[Mark this node as a leaf.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="247" package="phpLDAPadmin\Tree">
        <name>isLeaf</name>
        <full_name>isLeaf</full_name>
        <docblock line="244">
          <description><![CDATA[Return if this node is a leaf.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="258" package="phpLDAPadmin\Tree">
        <name>getIcon</name>
        <full_name>getIcon</full_name>
        <docblock line="254">
          <description><![CDATA[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><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="271" package="phpLDAPadmin\Tree">
        <name>setSizeLimited</name>
        <full_name>setSizeLimited</full_name>
        <docblock line="268">
          <description><![CDATA[Mark this node as a size limited (it wont have all its children).]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="281" package="phpLDAPadmin\Tree">
        <name>unsetSizeLimited</name>
        <full_name>unsetSizeLimited</full_name>
        <docblock line="278">
          <description><![CDATA[Clear the size limited flag.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="291" package="phpLDAPadmin\Tree">
        <name>isSizeLimited</name>
        <full_name>isSizeLimited</full_name>
        <docblock line="288">
          <description><![CDATA[Return if this node has hit an LDAP size limit (and thus doesnt have all its children).]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="298" package="phpLDAPadmin\Tree">
        <name>setTemplate</name>
        <full_name>setTemplate</full_name>
        <argument line="298">
          <name>$template</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="305" package="phpLDAPadmin\Tree">
        <name>getTemplate</name>
        <full_name>getTemplate</full_name>
      </method>
    </class>
    <parse_markers>
      <error line="17" code="50018">No DocBlock was found for property $dn</error>
      <error line="19" code="50018">No DocBlock was found for property $server_id</error>
      <error line="21" code="50018">No DocBlock was found for property $objectclasses</error>
      <error line="23" code="50018">No DocBlock was found for property $base_entry</error>
      <error line="25" code="50018">No DocBlock was found for property $children</error>
      <error line="27" code="50018">No DocBlock was found for property $icon</error>
      <error line="29" code="50018">No DocBlock was found for property $leaf</error>
      <error line="31" code="50018">No DocBlock was found for property $open</error>
      <error line="33" code="50018">No DocBlock was found for property $size_limited</error>
      <error line="35" code="50018">No DocBlock was found for property $template</error>
      <error line="37" code="50018">No DocBlock was found for property $childsort</error>
      <error line="39" code="50018">No DocBlock was found for property $reading_children</error>
      <error line="41" code="50010">No DocBlock was found for method __construct()</error>
      <error line="61" code="50010">No DocBlock was found for method getDNEncode()</error>
      <error line="97" code="50010">No DocBlock was found for method setObjectClasses()</error>
      <error line="104" code="50010">No DocBlock was found for method getObjectClasses()</error>
      <error line="111" code="50010">No DocBlock was found for method isInLDAP()</error>
      <error line="134" code="50010">No DocBlock was found for method readingChildren()</error>
      <error line="298" code="50010">No DocBlock was found for method setTemplate()</error>
      <error line="305" code="50010">No DocBlock was found for method getTemplate()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/lib/SelectionAttribute.php" hash="ebd54d780d03ab22dc6a940670f75533" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Classes and functions for the template engine.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="15" package="phpLDAPadmin\Templates">
      <extends>\Attribute</extends>
      <name>SelectionAttribute</name>
      <full_name>\SelectionAttribute</full_name>
      <docblock line="9">
        <description><![CDATA[Represents an attribute whose values are in a predefined list]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="9" name="package" description="phpLDAPadmin"/>
        <tag line="9" name="subpackage" description="Templates"/>
      </docblock>
      <property final="false" static="false" visibility="protected" line="16" namespace="global" package="main">
        <name>$selection</name>
        <default><![CDATA[array()]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="17" namespace="global" package="main">
        <name>$multiple</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="18" namespace="global" package="main">
        <name>$default</name>
        <default><![CDATA[]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="20" package="phpLDAPadmin\Templates">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <argument line="20">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="20">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="20">
          <name>$server_id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="20">
          <name>$source</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="36" package="phpLDAPadmin\Templates">
        <name>addOption</name>
        <full_name>addOption</full_name>
        <argument line="36">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="36">
          <name>$description</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="40" package="phpLDAPadmin\Templates">
        <name>addValue</name>
        <full_name>addValue</full_name>
        <argument line="40">
          <name>$new_val</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="40">
          <name>$i</name>
          <default><![CDATA[-1]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="47" package="phpLDAPadmin\Templates">
        <name>getOptionCount</name>
        <full_name>getOptionCount</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="51" package="phpLDAPadmin\Templates">
        <name>getSelection</name>
        <full_name>getSelection</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="55" package="phpLDAPadmin\Templates">
        <name>autoValue</name>
        <full_name>autoValue</full_name>
        <argument line="55">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="59" package="phpLDAPadmin\Templates">
        <name>getDefault</name>
        <full_name>getDefault</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="63" package="phpLDAPadmin\Templates">
        <name>isMultiple</name>
        <full_name>isMultiple</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="67" package="phpLDAPadmin\Templates">
        <name>setMultiple</name>
        <full_name>setMultiple</full_name>
      </method>
    </class>
    <parse_markers>
      <error line="16" code="50018">No DocBlock was found for property $selection</error>
      <error line="17" code="50018">No DocBlock was found for property $multiple</error>
      <error line="18" code="50018">No DocBlock was found for property $default</error>
      <error line="20" code="50010">No DocBlock was found for method __construct()</error>
      <error line="36" code="50010">No DocBlock was found for method addOption()</error>
      <error line="40" code="50010">No DocBlock was found for method addValue()</error>
      <error line="47" code="50010">No DocBlock was found for method getOptionCount()</error>
      <error line="51" code="50010">No DocBlock was found for method getSelection()</error>
      <error line="55" code="50010">No DocBlock was found for method autoValue()</error>
      <error line="59" code="50010">No DocBlock was found for method getDefault()</error>
      <error line="63" code="50010">No DocBlock was found for method isMultiple()</error>
      <error line="67" code="50010">No DocBlock was found for method setMultiple()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/lib/template_functions.php" hash="a928a97fbd0a270486fdda76bbaecd08" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Classes and functions for the template engine.]]></description>
      <long-description><![CDATA[<p>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.</p>]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="21" package="phpLDAPadmin\Templates">
      <extends>\xmlTemplates</extends>
      <name>Templates</name>
      <full_name>\Templates</full_name>
      <docblock line="13">
        <description><![CDATA[Templates Class]]></description>
        <long-description><![CDATA[<p>This class will store all our templates.</p>]]></long-description>
        <tag line="13" name="package" description="phpLDAPadmin"/>
        <tag line="13" name="subpackage" description="Templates"/>
      </docblock>
    </class>
  </file>
  <file path="templates/3rdParty/pla/lib/DnAttribute.php" hash="57742c3588f6b77643966bb7e84ba19c" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Classes and functions for the template engine.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="15" package="phpLDAPadmin\Templates">
      <extends>\Attribute</extends>
      <name>DnAttribute</name>
      <full_name>\DnAttribute</full_name>
      <docblock line="9">
        <description><![CDATA[Represents an attribute whose values are DNs]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="9" name="package" description="phpLDAPadmin"/>
        <tag line="9" name="subpackage" description="Templates"/>
      </docblock>
    </class>
  </file>
  <file path="templates/3rdParty/pla/lib/AJAXTree.php" hash="566b3c1aa9f49f7ea515bcec6f15ff80" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Classes and functions for the LDAP tree.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="16" package="phpLDAPadmin\Tree">
      <extends>\HTMLTree</extends>
      <name>AJAXTree</name>
      <full_name>\AJAXTree</full_name>
      <docblock line="9">
        <description><![CDATA[This class implements an AJAX based tree.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="9" name="package" description="phpLDAPadmin"/>
        <tag line="9" name="subpackage" description="Tree"/>
        <tag line="9" name="see" description="\global\HTMLTree" refers="\global\HTMLTree"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="25" package="phpLDAPadmin\Tree">
        <name>draw_item</name>
        <full_name>draw_item</full_name>
        <docblock line="17">
          <description><![CDATA[Draw a node of the tree]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="17" name="param" description="The Base DN to draw" type="\dn" variable="$item">
            <type by_reference="false">\dn</type>
          </tag>
          <tag line="17" name="param" description="a string of 0 and 1 ; $level == &quot;000101&quot; will draw &quot; | |&lt;node&gt;&quot;" type="string" variable="$level">
            <type by_reference="false">string</type>
          </tag>
          <tag line="17" name="param" description="is the first child entry, which is normally the &quot;Create New Entry&quot; option" type="boolean" variable="$first_child">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="17" name="param" description="is the last child entry, which is normally the &quot;Create New Entry&quot; option" type="boolean" variable="$last_child">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="25">
          <name>$item</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="25">
          <name>$level</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="25">
          <name>$first_child</name>
          <default><![CDATA[true]]></default>
          <type/>
        </argument>
        <argument line="25">
          <name>$last_child</name>
          <default><![CDATA[true]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="138" package="phpLDAPadmin\Tree">
        <name>draw_children</name>
        <full_name>draw_children</full_name>
        <docblock line="135">
          <description><![CDATA[Expand and draw a child entry, when it is clicked on.]]></description>
          <long-description><![CDATA[<p>This is using AJAX just to render this section of the tree.</p>]]></long-description>
        </docblock>
        <argument line="138">
          <name>$parent_entry</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="138">
          <name>$code</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="186" package="phpLDAPadmin\Tree">
        <name>get_indentation</name>
        <full_name>get_indentation</full_name>
        <docblock line="181">
          <description><![CDATA[Return the indentation before a node]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="181" name="param" description="a string of 0 and 1 ; $code == &quot;000101&quot; will return &quot; | |&quot;" type="\$code" variable="$code">
            <type by_reference="false">\$code</type>
          </tag>
        </docblock>
        <argument line="186">
          <name>$code</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="210" package="phpLDAPadmin\Tree">
        <name>draw_javascript</name>
        <full_name>draw_javascript</full_name>
        <docblock line="207">
          <description><![CDATA[Draw the javascript to support the tree.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="222" package="phpLDAPadmin\Tree">
        <name>create_before_child</name>
        <full_name>create_before_child</full_name>
        <docblock line="219">
          <description><![CDATA[Draw the "Create New Entry" item before the children.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="222">
          <name>$entry</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="222">
          <name>$level</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="242" package="phpLDAPadmin\Tree">
        <name>create_after_child</name>
        <full_name>create_after_child</full_name>
        <docblock line="239">
          <description><![CDATA[Draw the "Create New Entry" item after the children.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="242">
          <name>$entry</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="242">
          <name>$level</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="261" package="phpLDAPadmin\Tree">
        <name>draw_create_new_entry</name>
        <full_name>draw_create_new_entry</full_name>
        <docblock line="258">
          <description><![CDATA[Draw the "Create New Entry" item.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="261">
          <name>$entry</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="261">
          <name>$level</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="261">
          <name>$img</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="294" package="phpLDAPadmin\Tree">
        <name>listOpenItems</name>
        <full_name>listOpenItems</full_name>
        <docblock line="289">
          <description><![CDATA[List the items in the tree that are open]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="289" name="return" description="List of open nodes" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
    </class>
    <parse_markers>
      <error line="135" code="50015">Argument $parent_entry is missing from the Docblock of draw_children()</error>
      <error line="135" code="50015">Argument $code is missing from the Docblock of draw_children()</error>
      <error line="219" code="50015">Argument $entry is missing from the Docblock of create_before_child()</error>
      <error line="219" code="50015">Argument $level is missing from the Docblock of create_before_child()</error>
      <error line="239" code="50015">Argument $entry is missing from the Docblock of create_after_child()</error>
      <error line="239" code="50015">Argument $level is missing from the Docblock of create_after_child()</error>
      <error line="258" code="50015">Argument $entry is missing from the Docblock of draw_create_new_entry()</error>
      <error line="258" code="50015">Argument $level is missing from the Docblock of draw_create_new_entry()</error>
      <error line="258" code="50015">Argument $img is missing from the Docblock of draw_create_new_entry()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/lib/TemplateRender.php" hash="55e17c4145cd7207fcd3ed6aec577e2a" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[This class will render the creation or editing of an LDAP entry.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="15" package="phpLDAPadmin\Templates">
      <extends>\PageRender</extends>
      <name>TemplateRender</name>
      <full_name>\TemplateRender</full_name>
      <docblock line="9">
        <description><![CDATA[TemplateRender class]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="9" name="package" description="phpLDAPadmin"/>
        <tag line="9" name="subpackage" description="Templates"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="17" namespace="global" package="main">
        <name>$pagelast</name>
        <default><![CDATA[]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="24" package="phpLDAPadmin\Templates">
        <name>accept</name>
        <full_name>accept</full_name>
        <docblock line="21">
          <description><![CDATA[Initialise and Render the TemplateRender]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="24">
          <name>$norender</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="88" package="phpLDAPadmin\Templates">
        <name>getDefaultAttribute</name>
        <full_name>getDefaultAttribute</full_name>
        <argument line="88">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="88">
          <name>$container</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="88">
          <name>$type</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="434" package="phpLDAPadmin\Templates">
        <name>getMode</name>
        <full_name>getMode</full_name>
        <docblock line="430">
          <description><![CDATA[Set the mode of the TemplateRender
Applicable modes are "create" or "edit"]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="451" package="phpLDAPadmin\Templates">
        <name>getModeContainer</name>
        <full_name>getModeContainer</full_name>
        <docblock line="448">
          <description><![CDATA[Return the container for this mode]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="472" package="phpLDAPadmin\Templates">
        <name>haveDefaultTemplate</name>
        <full_name>haveDefaultTemplate</full_name>
        <docblock line="469">
          <description><![CDATA[Is the default template enabled?]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="485" package="phpLDAPadmin\Templates">
        <name>drawTemplateChoice</name>
        <full_name>drawTemplateChoice</full_name>
        <docblock line="482">
          <description><![CDATA[Present a list of available templates for creating and editing LDAP entries]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="609" package="phpLDAPadmin\Templates">
        <name>visitStart</name>
        <full_name>visitStart</full_name>
        <docblock line="605">
          <description><![CDATA[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><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="630" package="phpLDAPadmin\Templates">
        <name>visitEnd</name>
        <full_name>visitEnd</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="677" package="phpLDAPadmin\Templates">
        <name>drawHeader</name>
        <full_name>drawHeader</full_name>
        <docblock line="675">
          <description><![CDATA[PAGE DRAWING METHODS *]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="692" package="phpLDAPadmin\Templates">
        <name>drawTitle</name>
        <full_name>drawTitle</full_name>
        <argument line="692">
          <name>$title</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="712" package="phpLDAPadmin\Templates">
        <name>drawSubTitle</name>
        <full_name>drawSubTitle</full_name>
        <argument line="712">
          <name>$subtitle</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="744" package="phpLDAPadmin\Templates">
        <name>drawMenu</name>
        <full_name>drawMenu</full_name>
        <docblock line="742">
          <description><![CDATA[PAGE ENTRY MENU *]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="836" package="phpLDAPadmin\Templates">
        <name>getMenuItem</name>
        <full_name>getMenuItem</full_name>
        <docblock line="834">
          <description><![CDATA[PAGE ENTRY MENU ITEMS *]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="836">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="998" package="phpLDAPadmin\Templates">
        <name>getDeleteAttributeMessage</name>
        <full_name>getDeleteAttributeMessage</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1010" package="phpLDAPadmin\Templates">
        <name>getModifiedAttributesMessage</name>
        <full_name>getModifiedAttributesMessage</full_name>
        <argument line="1010">
          <name>$modified_attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1022" package="phpLDAPadmin\Templates">
        <name>getReadOnlyMessage</name>
        <full_name>getReadOnlyMessage</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1031" package="phpLDAPadmin\Templates">
        <name>getViewSchemaMessage</name>
        <full_name>getViewSchemaMessage</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1042" package="phpLDAPadmin\Templates">
        <name>getMenuItemRefresh</name>
        <full_name>getMenuItemRefresh</full_name>
        <docblock line="1040">
          <description><![CDATA[PAGE ENTRY MENU ITEMS DETAILS *]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1058" package="phpLDAPadmin\Templates">
        <name>getMenuItemSwitchTemplate</name>
        <full_name>getMenuItemSwitchTemplate</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1072" package="phpLDAPadmin\Templates">
        <name>getMenuItemExportBase</name>
        <full_name>getMenuItemExportBase</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1088" package="phpLDAPadmin\Templates">
        <name>getMenuItemMove</name>
        <full_name>getMenuItemMove</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1106" package="phpLDAPadmin\Templates">
        <name>getMenuItemInternalAttributes</name>
        <full_name>getMenuItemInternalAttributes</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1126" package="phpLDAPadmin\Templates">
        <name>getMenuItemDelete</name>
        <full_name>getMenuItemDelete</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1143" package="phpLDAPadmin\Templates">
        <name>getMenuItemRename</name>
        <full_name>getMenuItemRename</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1159" package="phpLDAPadmin\Templates">
        <name>getMenuItemCompare</name>
        <full_name>getMenuItemCompare</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1176" package="phpLDAPadmin\Templates">
        <name>getMenuItemCreate</name>
        <full_name>getMenuItemCreate</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1193" package="phpLDAPadmin\Templates">
        <name>getMenuItemAddAttribute</name>
        <full_name>getMenuItemAddAttribute</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1214" package="phpLDAPadmin\Templates">
        <name>getMenuItemShowChildren</name>
        <full_name>getMenuItemShowChildren</full_name>
        <argument line="1214">
          <name>$children_count</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1234" package="phpLDAPadmin\Templates">
        <name>getMenuItemExportSub</name>
        <full_name>getMenuItemExportSub</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1256" package="phpLDAPadmin\Templates">
        <name>drawRDNChooser</name>
        <full_name>drawRDNChooser</full_name>
        <docblock line="1253">
          <description><![CDATA[RDN Chooser]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1297" package="phpLDAPadmin\Templates">
        <name>drawContainerChooser</name>
        <full_name>drawContainerChooser</full_name>
        <docblock line="1294">
          <description><![CDATA[Container Chooser]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="1297">
          <name>$default_container</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1316" package="phpLDAPadmin\Templates">
        <name>drawObjectClassChooser</name>
        <full_name>drawObjectClassChooser</full_name>
        <docblock line="1313">
          <description><![CDATA[Object Class Chooser]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1349" package="phpLDAPadmin\Templates">
        <name>drawInternalAttributes</name>
        <full_name>drawInternalAttributes</full_name>
        <docblock line="1347">
          <description><![CDATA[INTERNAL ATTRIBUTES *]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1359" package="phpLDAPadmin\Templates">
        <name>drawInternalAttribute</name>
        <full_name>drawInternalAttribute</full_name>
        <argument line="1359">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1367" package="phpLDAPadmin\Templates">
        <name>drawFormStart</name>
        <full_name>drawFormStart</full_name>
        <docblock line="1365">
          <description><![CDATA[FORM METHODS *]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1378" package="phpLDAPadmin\Templates">
        <name>drawForm</name>
        <full_name>drawForm</full_name>
        <argument line="1378">
          <name>$nosubmit</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1400" package="phpLDAPadmin\Templates">
        <name>drawFormEnd</name>
        <full_name>drawFormEnd</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1434" package="phpLDAPadmin\Templates">
        <name>drawFormSubmitButton</name>
        <full_name>drawFormSubmitButton</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1445" package="phpLDAPadmin\Templates">
        <name>drawStepTitle</name>
        <full_name>drawStepTitle</full_name>
        <docblock line="1443">
          <description><![CDATA[STEP FORM METHODS *]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="1445">
          <name>$page</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1470" package="phpLDAPadmin\Templates">
        <name>drawStepFormStart</name>
        <full_name>drawStepFormStart</full_name>
        <argument line="1470">
          <name>$page</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1488" package="phpLDAPadmin\Templates">
        <name>drawStepForm</name>
        <full_name>drawStepForm</full_name>
        <argument line="1488">
          <name>$page</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1526" package="phpLDAPadmin\Templates">
        <name>drawStepFormEnd</name>
        <full_name>drawStepFormEnd</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1532" package="phpLDAPadmin\Templates">
        <name>drawStepFormSubmitButton</name>
        <full_name>drawStepFormSubmitButton</full_name>
        <argument line="1532">
          <name>$page</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1548" package="phpLDAPadmin\Templates">
        <name>drawStepFormDefaultAttributes</name>
        <full_name>drawStepFormDefaultAttributes</full_name>
        <docblock line="1545">
          <description><![CDATA[Given our known objectClass in the template, this will render the required MAY and optional MUST attributes]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1588" package="phpLDAPadmin\Templates">
        <name>drawShownAttributes</name>
        <full_name>drawShownAttributes</full_name>
        <docblock line="1586">
          <description><![CDATA[DRAW ATTRIBUTES *]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1600" package="phpLDAPadmin\Templates">
        <name>drawJavascript</name>
        <full_name>drawJavascript</full_name>
        <docblock line="1598">
          <description><![CDATA[DRAW PAGE JAVACRIPT]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1686" package="phpLDAPadmin\Templates">
        <name>drawTemplateJavascript</name>
        <full_name>drawTemplateJavascript</full_name>
        <docblock line="1683">
          <description><![CDATA[Javascript Functions]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1753" package="phpLDAPadmin\Templates">
        <name>drawTitleAttribute</name>
        <full_name>drawTitleAttribute</full_name>
        <docblock line="1751">
          <description><![CDATA[ATTRIBUTE TITLE *]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="1753">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1778" package="phpLDAPadmin\Templates">
        <name>drawStartValueLineAttribute</name>
        <full_name>drawStartValueLineAttribute</full_name>
        <docblock line="1776">
          <description><![CDATA[ATTRIBUTE LINE *]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="1778">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1790" package="phpLDAPadmin\Templates">
        <name>drawEndValueLineAttribute</name>
        <full_name>drawEndValueLineAttribute</full_name>
        <argument line="1790">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1804" package="phpLDAPadmin\Templates">
        <name>drawTemplateAttribute</name>
        <full_name>drawTemplateAttribute</full_name>
        <argument line="1804">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1811" package="phpLDAPadmin\Templates">
        <name>drawTemplateValuesAttribute</name>
        <full_name>drawTemplateValuesAttribute</full_name>
        <argument line="1811">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1841" package="phpLDAPadmin\Templates">
        <name>drawIconAttribute</name>
        <full_name>drawIconAttribute</full_name>
        <docblock line="1839">
          <description><![CDATA[DRAW ICONS FOR ATTRIBUTES VALUES *]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="1841">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1841">
          <name>$val</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1857" package="phpLDAPadmin\Templates">
        <name>drawDnValueIconAttribute</name>
        <full_name>drawDnValueIconAttribute</full_name>
        <argument line="1857">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1857">
          <name>$val</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1869" package="phpLDAPadmin\Templates">
        <name>drawMailValueIconAttribute</name>
        <full_name>drawMailValueIconAttribute</full_name>
        <argument line="1869">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1869">
          <name>$val</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1880" package="phpLDAPadmin\Templates">
        <name>drawUrlValueIconAttribute</name>
        <full_name>drawUrlValueIconAttribute</full_name>
        <argument line="1880">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1880">
          <name>$val</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1897" package="phpLDAPadmin\Templates">
        <name>drawJavascriptAttribute</name>
        <full_name>drawJavascriptAttribute</full_name>
        <docblock line="1895">
          <description><![CDATA[javacript]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="1897">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1950" package="phpLDAPadmin\Templates">
        <name>getFocusJavascriptAttribute</name>
        <full_name>getFocusJavascriptAttribute</full_name>
        <argument line="1950">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1950">
          <name>$component</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1959" package="phpLDAPadmin\Templates">
        <name>getBlurJavascriptAttribute</name>
        <full_name>getBlurJavascriptAttribute</full_name>
        <argument line="1959">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1959">
          <name>$component</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1971" package="phpLDAPadmin\Templates">
        <name>drawFocusJavascriptAttribute</name>
        <full_name>drawFocusJavascriptAttribute</full_name>
        <argument line="1971">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1971">
          <name>$component</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1975" package="phpLDAPadmin\Templates">
        <name>drawBlurJavascriptAttribute</name>
        <full_name>drawBlurJavascriptAttribute</full_name>
        <argument line="1975">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1975">
          <name>$component</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1979" package="phpLDAPadmin\Templates">
        <name>drawFillJavascriptAttribute</name>
        <full_name>drawFillJavascriptAttribute</full_name>
        <argument line="1979">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1979">
          <name>$component_id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1979">
          <name>$component_value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1984" package="phpLDAPadmin\Templates">
        <name>drawValidateJavascriptAttribute</name>
        <full_name>drawValidateJavascriptAttribute</full_name>
        <argument line="1984">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1984">
          <name>$component</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1984">
          <name>$silence</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1984">
          <name>$var_valid</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="2000" package="phpLDAPadmin\Templates">
        <name>drawMenuAttribute</name>
        <full_name>drawMenuAttribute</full_name>
        <docblock line="1998">
          <description><![CDATA[ATTRIBUTE MENU *]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="2000">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="2019" package="phpLDAPadmin\Templates">
        <name>getMenuItemAttribute</name>
        <full_name>getMenuItemAttribute</full_name>
        <argument line="2019">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2019">
          <name>$action</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="2062" package="phpLDAPadmin\Templates">
        <name>getAddValueMenuItemAttribute</name>
        <full_name>getAddValueMenuItemAttribute</full_name>
        <argument line="2062">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="2080" package="phpLDAPadmin\Templates">
        <name>getAddValueMenuItemObjectClassAttribute</name>
        <full_name>getAddValueMenuItemObjectClassAttribute</full_name>
        <argument line="2080">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="2098" package="phpLDAPadmin\Templates">
        <name>getModifyMemberMenuItemAttribute</name>
        <full_name>getModifyMemberMenuItemAttribute</full_name>
        <argument line="2098">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="2117" package="phpLDAPadmin\Templates">
        <name>getRenameMenuItemAttribute</name>
        <full_name>getRenameMenuItemAttribute</full_name>
        <argument line="2117">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="2131" package="phpLDAPadmin\Templates">
        <name>drawValueAttribute</name>
        <full_name>drawValueAttribute</full_name>
        <docblock line="2129">
          <description><![CDATA[values *]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="2131">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2131">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="2163" package="phpLDAPadmin\Templates">
        <name>drawHelperAttribute</name>
        <full_name>drawHelperAttribute</full_name>
        <argument line="2163">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2163">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="2250" package="phpLDAPadmin\Templates">
        <name>drawRequiredSymbolAttribute</name>
        <full_name>drawRequiredSymbolAttribute</full_name>
        <argument line="2250">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="2260" package="phpLDAPadmin\Templates">
        <name>drawJavascriptBinaryAttribute</name>
        <full_name>drawJavascriptBinaryAttribute</full_name>
        <argument line="2260">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="2304" package="phpLDAPadmin\Templates">
        <name>drawJavaScriptDateAttribute</name>
        <full_name>drawJavaScriptDateAttribute</full_name>
        <docblock line="2302">
          <description><![CDATA[DATE ATTRIBUTE RENDERING *]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="2304">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="2347" package="phpLDAPadmin\Templates">
        <name>drawSelectorPopupDateAttribute</name>
        <full_name>drawSelectorPopupDateAttribute</full_name>
        <docblock line="2344">
          <description><![CDATA[Draws an HTML date selector button which, when clicked, pops up a date selector dialog.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="2347">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2347">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="2354" package="phpLDAPadmin\Templates">
        <name>drawIconDnAttribute</name>
        <full_name>drawIconDnAttribute</full_name>
        <docblock line="2352">
          <description><![CDATA[DN ATTRIBUTES *]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="2354">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2354">
          <name>$val</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="2362" package="phpLDAPadmin\Templates">
        <name>drawIconObjectClassAttribute</name>
        <full_name>drawIconObjectClassAttribute</full_name>
        <docblock line="2360">
          <description><![CDATA[OBJECT CLASS ATTRIBUTE *]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="2362">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2362">
          <name>$val</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="2368" package="phpLDAPadmin\Templates">
        <name>drawJavascriptPasswordAttribute</name>
        <full_name>drawJavascriptPasswordAttribute</full_name>
        <docblock line="2366">
          <description><![CDATA[PASSWORD ATTRIBUTES *]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="2368">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="2397" package="phpLDAPadmin\Templates">
        <name>drawCheckLinkPasswordAttribute</name>
        <full_name>drawCheckLinkPasswordAttribute</full_name>
        <argument line="2397">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2397">
          <name>$component_id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="2411" package="phpLDAPadmin\Templates">
        <name>drawJavascriptRandomPasswordAttribute</name>
        <full_name>drawJavascriptRandomPasswordAttribute</full_name>
        <docblock line="2406">
          <description><![CDATA[This will draw the javascript that displays to the user the random password generated]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="2406" name="todo" description="This function doesnt work well if there are more than 1 RandomPasswordAttributes on the form for the same attribute (unlikely situation)"/>
        </docblock>
        <argument line="2411">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="2444" package="phpLDAPadmin\Templates">
        <name>drawDefaultHelperPasswordAttribute</name>
        <full_name>drawDefaultHelperPasswordAttribute</full_name>
        <argument line="2444">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2444">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="2465" package="phpLDAPadmin\Templates">
        <name>drawDefaultHelperSambaPasswordAttribute</name>
        <full_name>drawDefaultHelperSambaPasswordAttribute</full_name>
        <argument line="2465">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2465">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="2486" package="phpLDAPadmin\Templates">
        <name>drawIconSelectionAttribute</name>
        <full_name>drawIconSelectionAttribute</full_name>
        <docblock line="2484">
          <description><![CDATA[SELECTION ATTRIBUTE RENDERING *]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="2486">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2486">
          <name>$val</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="2493" package="phpLDAPadmin\Templates">
        <name>getMenuItemSelectionAttribute</name>
        <full_name>getMenuItemSelectionAttribute</full_name>
        <argument line="2493">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2493">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <parse_markers>
      <error line="17" code="50018">No DocBlock was found for property $pagelast</error>
      <error line="21" code="50015">Argument $norender is missing from the Docblock of accept()</error>
      <error line="88" code="50010">No DocBlock was found for method getDefaultAttribute()</error>
      <error line="630" code="50010">No DocBlock was found for method visitEnd()</error>
      <error line="692" code="50010">No DocBlock was found for method drawTitle()</error>
      <error line="712" code="50010">No DocBlock was found for method drawSubTitle()</error>
      <error line="834" code="50015">Argument $i is missing from the Docblock of getMenuItem()</error>
      <error line="998" code="50010">No DocBlock was found for method getDeleteAttributeMessage()</error>
      <error line="1010" code="50010">No DocBlock was found for method getModifiedAttributesMessage()</error>
      <error line="1022" code="50010">No DocBlock was found for method getReadOnlyMessage()</error>
      <error line="1031" code="50010">No DocBlock was found for method getViewSchemaMessage()</error>
      <error line="1058" code="50010">No DocBlock was found for method getMenuItemSwitchTemplate()</error>
      <error line="1072" code="50010">No DocBlock was found for method getMenuItemExportBase()</error>
      <error line="1088" code="50010">No DocBlock was found for method getMenuItemMove()</error>
      <error line="1106" code="50010">No DocBlock was found for method getMenuItemInternalAttributes()</error>
      <error line="1126" code="50010">No DocBlock was found for method getMenuItemDelete()</error>
      <error line="1143" code="50010">No DocBlock was found for method getMenuItemRename()</error>
      <error line="1159" code="50010">No DocBlock was found for method getMenuItemCompare()</error>
      <error line="1176" code="50010">No DocBlock was found for method getMenuItemCreate()</error>
      <error line="1193" code="50010">No DocBlock was found for method getMenuItemAddAttribute()</error>
      <error line="1214" code="50010">No DocBlock was found for method getMenuItemShowChildren()</error>
      <error line="1234" code="50010">No DocBlock was found for method getMenuItemExportSub()</error>
      <error line="1294" code="50015">Argument $default_container is missing from the Docblock of drawContainerChooser()</error>
      <error line="1359" code="50010">No DocBlock was found for method drawInternalAttribute()</error>
      <error line="1378" code="50010">No DocBlock was found for method drawForm()</error>
      <error line="1400" code="50010">No DocBlock was found for method drawFormEnd()</error>
      <error line="1434" code="50010">No DocBlock was found for method drawFormSubmitButton()</error>
      <error line="1443" code="50015">Argument $page is missing from the Docblock of drawStepTitle()</error>
      <error line="1470" code="50010">No DocBlock was found for method drawStepFormStart()</error>
      <error line="1488" code="50010">No DocBlock was found for method drawStepForm()</error>
      <error line="1526" code="50010">No DocBlock was found for method drawStepFormEnd()</error>
      <error line="1532" code="50010">No DocBlock was found for method drawStepFormSubmitButton()</error>
      <error line="1751" code="50015">Argument $attribute is missing from the Docblock of drawTitleAttribute()</error>
      <error line="1776" code="50015">Argument $attribute is missing from the Docblock of drawStartValueLineAttribute()</error>
      <error line="1790" code="50010">No DocBlock was found for method drawEndValueLineAttribute()</error>
      <error line="1804" code="50010">No DocBlock was found for method drawTemplateAttribute()</error>
      <error line="1811" code="50010">No DocBlock was found for method drawTemplateValuesAttribute()</error>
      <error line="1839" code="50015">Argument $attribute is missing from the Docblock of drawIconAttribute()</error>
      <error line="1839" code="50015">Argument $val is missing from the Docblock of drawIconAttribute()</error>
      <error line="1857" code="50010">No DocBlock was found for method drawDnValueIconAttribute()</error>
      <error line="1869" code="50010">No DocBlock was found for method drawMailValueIconAttribute()</error>
      <error line="1880" code="50010">No DocBlock was found for method drawUrlValueIconAttribute()</error>
      <error line="1895" code="50015">Argument $attribute is missing from the Docblock of drawJavascriptAttribute()</error>
      <error line="1950" code="50010">No DocBlock was found for method getFocusJavascriptAttribute()</error>
      <error line="1959" code="50010">No DocBlock was found for method getBlurJavascriptAttribute()</error>
      <error line="1971" code="50010">No DocBlock was found for method drawFocusJavascriptAttribute()</error>
      <error line="1975" code="50010">No DocBlock was found for method drawBlurJavascriptAttribute()</error>
      <error line="1979" code="50010">No DocBlock was found for method drawFillJavascriptAttribute()</error>
      <error line="1984" code="50010">No DocBlock was found for method drawValidateJavascriptAttribute()</error>
      <error line="1998" code="50015">Argument $attribute is missing from the Docblock of drawMenuAttribute()</error>
      <error line="2019" code="50010">No DocBlock was found for method getMenuItemAttribute()</error>
      <error line="2062" code="50010">No DocBlock was found for method getAddValueMenuItemAttribute()</error>
      <error line="2080" code="50010">No DocBlock was found for method getAddValueMenuItemObjectClassAttribute()</error>
      <error line="2098" code="50010">No DocBlock was found for method getModifyMemberMenuItemAttribute()</error>
      <error line="2117" code="50010">No DocBlock was found for method getRenameMenuItemAttribute()</error>
      <error line="2129" code="50015">Argument $attribute is missing from the Docblock of drawValueAttribute()</error>
      <error line="2129" code="50015">Argument $i is missing from the Docblock of drawValueAttribute()</error>
      <error line="2163" code="50010">No DocBlock was found for method drawHelperAttribute()</error>
      <error line="2250" code="50010">No DocBlock was found for method drawRequiredSymbolAttribute()</error>
      <error line="2260" code="50010">No DocBlock was found for method drawJavascriptBinaryAttribute()</error>
      <error line="2302" code="50015">Argument $attribute is missing from the Docblock of drawJavaScriptDateAttribute()</error>
      <error line="2344" code="50015">Argument $attribute is missing from the Docblock of drawSelectorPopupDateAttribute()</error>
      <error line="2344" code="50015">Argument $i is missing from the Docblock of drawSelectorPopupDateAttribute()</error>
      <error line="2352" code="50015">Argument $attribute is missing from the Docblock of drawIconDnAttribute()</error>
      <error line="2352" code="50015">Argument $val is missing from the Docblock of drawIconDnAttribute()</error>
      <error line="2360" code="50015">Argument $attribute is missing from the Docblock of drawIconObjectClassAttribute()</error>
      <error line="2360" code="50015">Argument $val is missing from the Docblock of drawIconObjectClassAttribute()</error>
      <error line="2366" code="50015">Argument $attribute is missing from the Docblock of drawJavascriptPasswordAttribute()</error>
      <error line="2397" code="50010">No DocBlock was found for method drawCheckLinkPasswordAttribute()</error>
      <error line="2406" code="50015">Argument $attribute is missing from the Docblock of drawJavascriptRandomPasswordAttribute()</error>
      <error line="2444" code="50010">No DocBlock was found for method drawDefaultHelperPasswordAttribute()</error>
      <error line="2465" code="50010">No DocBlock was found for method drawDefaultHelperSambaPasswordAttribute()</error>
      <error line="2484" code="50015">Argument $attribute is missing from the Docblock of drawIconSelectionAttribute()</error>
      <error line="2484" code="50015">Argument $val is missing from the Docblock of drawIconSelectionAttribute()</error>
      <error line="2493" code="50010">No DocBlock was found for method getMenuItemSelectionAttribute()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/lib/ds_myldap.php" hash="f0296bc20fd49966e46fd3b540fa3d6e" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Classes and functions for communication of Data Stores]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="15" package="phpLDAPadmin\DataStore">
      <extends>\DS</extends>
      <name>myldap</name>
      <full_name>\myldap</full_name>
      <docblock line="9">
        <description><![CDATA[This abstract class provides the basic variables and methods for LDAP datastores]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="9" name="package" description="phpLDAPadmin"/>
        <tag line="9" name="subpackage" description="DataStore"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="17" namespace="global" package="main">
        <name>$noconnect</name>
        <default><![CDATA[false]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="19" namespace="global" package="main">
        <name>$_schema_entries</name>
        <default><![CDATA[null]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="21" namespace="global" package="main">
        <name>$_schemaDN</name>
        <default><![CDATA[null]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="23" namespace="global" package="main">
        <name>$force_may</name>
        <default><![CDATA[array()]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="25" package="phpLDAPadmin\DataStore">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <argument line="25">
          <name>$index</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="129" package="phpLDAPadmin\DataStore">
        <name>connect</name>
        <full_name>connect</full_name>
        <docblock line="123">
          <description><![CDATA[Connect and Bind to the Database]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="123" name="param" description="Which connection method resource to use" type="string" variable="$method">
            <type by_reference="false">string</type>
          </tag>
          <tag line="123" name="return" description="Connection resource if successful, null if not." type="resource|null">
            <type by_reference="false">resource</type>
            <type by_reference="false">null</type>
          </tag>
        </docblock>
        <argument line="129">
          <name>$method</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="129">
          <name>$debug</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
        <argument line="129">
          <name>$new</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="247" package="phpLDAPadmin\DataStore">
        <name>login</name>
        <full_name>login</full_name>
        <docblock line="242">
          <description><![CDATA[Login to the database with the application user/password]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="242" name="return" description="true|false for successful login." type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="247">
          <name>$user</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="247">
          <name>$pass</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="247">
          <name>$method</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="247">
          <name>$new</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="311" package="phpLDAPadmin\DataStore">
        <name>query</name>
        <full_name>query</full_name>
        <docblock line="297">
          <description><![CDATA[Perform a query to the Database]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="297" name="param" description="query to perform $query['base'] $query['filter'] $query['scope'] $query['attrs'] = array(); $query['deref']" type="string" variable="$query">
            <type by_reference="false">string</type>
          </tag>
          <tag line="297" name="param" description="Which connection method resource to use" type="string" variable="$method">
            <type by_reference="false">string</type>
          </tag>
          <tag line="297" name="param" description="Index items according to this key" type="string" variable="$index">
            <type by_reference="false">string</type>
          </tag>
          <tag line="297" name="param" description="Enable debugging output" type="boolean" variable="$debug">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="297" name="return" description="Results of query." type="array|null">
            <type by_reference="false">array</type>
            <type by_reference="false">null</type>
          </tag>
        </docblock>
        <argument line="311">
          <name>$query</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="311">
          <name>$method</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="311">
          <name>$index</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="311">
          <name>$debug</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="444" package="phpLDAPadmin\DataStore">
        <name>getErrorMessage</name>
        <full_name>getErrorMessage</full_name>
        <docblock line="439">
          <description><![CDATA[Get the last error string]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="439" name="param" description="Which connection method resource to use" type="string" variable="$method">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="444">
          <name>$method</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="456" package="phpLDAPadmin\DataStore">
        <name>getErrorNum</name>
        <full_name>getErrorNum</full_name>
        <docblock line="451">
          <description><![CDATA[Get the last error number]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="451" name="param" description="Which connection method resource to use" type="string" variable="$method">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="456">
          <name>$method</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="471" package="phpLDAPadmin\DataStore">
        <name>getLoginID</name>
        <full_name>getLoginID</full_name>
        <docblock line="466">
          <description><![CDATA[Get a user ID]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="466" name="param" description="Which connection method resource to use" type="string" variable="$user">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="471">
          <name>$user</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="471">
          <name>$method</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="504" package="phpLDAPadmin\DataStore">
        <name>getLoginBaseDN</name>
        <full_name>getLoginBaseDN</full_name>
        <docblock line="500">
          <description><![CDATA[Return the login base DNs
If no login base DNs are defined, then the LDAP server Base DNs are used.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="517" package="phpLDAPadmin\DataStore">
        <name>getLoginClass</name>
        <full_name>getLoginClass</full_name>
        <docblock line="514">
          <description><![CDATA[Return the login classes that a user must have to login]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="527" package="phpLDAPadmin\DataStore">
        <name>isAnonBindAllowed</name>
        <full_name>isAnonBindAllowed</full_name>
        <docblock line="524">
          <description><![CDATA[Return if anonymous bind is allowed in the configuration]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="544" package="phpLDAPadmin\DataStore">
        <name>isTLSEnabled</name>
        <full_name>isTLSEnabled</full_name>
        <docblock line="534">
          <description><![CDATA[Fetches whether TLS has been configured for use with a certain server.]]></description>
          <long-description><![CDATA[<p>Users may configure phpLDAPadmin to use TLS in config,php thus:</p>

<pre><code>$servers->setValue('server','tls',true|false);
</code></pre>]]></long-description>
          <tag line="534" name="return" description="" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="559" package="phpLDAPadmin\DataStore">
        <name>startTLS</name>
        <full_name>startTLS</full_name>
        <docblock line="556">
          <description><![CDATA[If TLS is configured, then start it]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="559">
          <name>$resource</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="585" package="phpLDAPadmin\DataStore">
        <name>isSASLEnabled</name>
        <full_name>isSASLEnabled</full_name>
        <docblock line="575">
          <description><![CDATA[Fetches whether SASL has been configured for use with a certain server.]]></description>
          <long-description><![CDATA[<p>Users may configure phpLDAPadmin to use SASL in config,php thus:</p>

<pre><code>$servers->setValue('server','sasl',true|false);
</code></pre>]]></long-description>
          <tag line="575" name="return" description="" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="603" package="phpLDAPadmin\DataStore">
        <name>startSASL</name>
        <full_name>startSASL</full_name>
        <docblock line="597">
          <description><![CDATA[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><![CDATA[]]></long-description>
          <tag line="597" name="todo" description="This has not been tested, please let the developers know if this function works as expected."/>
        </docblock>
        <argument line="603">
          <name>$resource</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="603">
          <name>$method</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="667" package="phpLDAPadmin\DataStore">
        <name>isProxyEnabled</name>
        <full_name>isProxyEnabled</full_name>
        <docblock line="657">
          <description><![CDATA[Fetches whether PROXY AUTH has been configured for use with a certain server.]]></description>
          <long-description><![CDATA[<p>Users may configure phpLDAPadmin to use PROXY AUTH in config,php thus:</p>

<pre><code>$servers->setValue('login','auth_type','proxy');
</code></pre>]]></long-description>
          <tag line="657" name="return" description="" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="677" package="phpLDAPadmin\DataStore">
        <name>startProxy</name>
        <full_name>startProxy</full_name>
        <docblock line="674">
          <description><![CDATA[If PROXY AUTH is configured, then start it]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="677">
          <name>$resource</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="677">
          <name>$method</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="766" package="phpLDAPadmin\DataStore">
        <name>modify</name>
        <full_name>modify</full_name>
        <docblock line="763">
          <description><![CDATA[Modify attributes of a DN]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="766">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="766">
          <name>$attrs</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="766">
          <name>$method</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="789" package="phpLDAPadmin\DataStore">
        <name>getBaseDN</name>
        <full_name>getBaseDN</full_name>
        <docblock line="774">
          <description><![CDATA[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><![CDATA[<p>Tested with OpenLDAP 2.0, Netscape iPlanet, and Novell eDirectory 8.7 (nldap.com)
Please report any and all bugs!!</p>

<p>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.</p>]]></long-description>
          <tag line="774" name="param" description="Which connection method resource to use" type="string" variable="$method">
            <type by_reference="false">string</type>
          </tag>
          <tag line="774" name="return" description="dn|null The root DN of the server on success (string) or null on error." type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="774" name="todo" description="Sort the entries, so that they are in the correct DN order."/>
        </docblock>
        <argument line="789">
          <name>$method</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="839" package="phpLDAPadmin\DataStore">
        <name>dnExists</name>
        <full_name>dnExists</full_name>
        <docblock line="831">
          <description><![CDATA[Gets whether an entry exists based on its DN.]]></description>
          <long-description><![CDATA[<p>If the entry exists,
returns true. Otherwise returns false.</p>]]></long-description>
          <tag line="831" name="param" description="The DN of the entry of interest." type="string" variable="$dn">
            <type by_reference="false">string</type>
          </tag>
          <tag line="831" name="param" description="Which connection method resource to use" type="string" variable="$method">
            <type by_reference="false">string</type>
          </tag>
          <tag line="831" name="return" description="" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="839">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="839">
          <name>$method</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="857" package="phpLDAPadmin\DataStore">
        <name>getContainerTop</name>
        <full_name>getContainerTop</full_name>
        <docblock line="851">
          <description><![CDATA[Given a DN string, this returns the top container portion of the string.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="851" name="param" description="The DN whose container string to return." type="string" variable="$dn">
            <type by_reference="false">string</type>
          </tag>
          <tag line="851" name="return" description="The container" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="857">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="883" package="phpLDAPadmin\DataStore">
        <name>getContainerPath</name>
        <full_name>getContainerPath</full_name>
        <docblock line="876">
          <description><![CDATA[Given a DN string and a path like syntax, this returns the parent container portion of the string.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="876" name="param" description="The DN whose container string to return." type="string" variable="$dn">
            <type by_reference="false">string</type>
          </tag>
          <tag line="876" name="param" description="Either '/', '.' or something like '../../&lt;rdn&gt;'" type="string" variable="$path">
            <type by_reference="false">string</type>
          </tag>
          <tag line="876" name="return" description="The container" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="883">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="883">
          <name>$path</name>
          <default><![CDATA['..']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="930" package="phpLDAPadmin\DataStore">
        <name>getContainer</name>
        <full_name>getContainer</full_name>
        <docblock line="922">
          <description><![CDATA[Given a DN string, this returns the parent container portion of the string.]]></description>
          <long-description><![CDATA[<p>For example. given 'cn=Manager,dc=example,dc=com', this function returns
'dc=example,dc=com'.</p>]]></long-description>
          <tag line="922" name="param" description="The DN whose container string to return." type="string" variable="$dn">
            <type by_reference="false">string</type>
          </tag>
          <tag line="922" name="return" description="The container" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="930">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="985" package="phpLDAPadmin\DataStore">
        <name>getContainerContents</name>
        <full_name>getContainerContents</full_name>
        <docblock line="952">
          <description><![CDATA[Gets a list of child entries for an entry.]]></description>
          <long-description><![CDATA[<p>Given a DN, this function fetches the list of DNs of
child entries one level beneath the parent. For example, for the following tree:</p>

<pre><code>dc=example,dc=com
    ou=People
        cn=Dave
        cn=Fred
        cn=Joe
    ou=More People
        cn=Mark
        cn=Bob
</code></pre>

<p>Calling</p>

<pre><code>getContainerContents("ou=people,dc=example,dc=com")</code></pre>

<p>would return the following list:</p>

<pre><code>cn=Dave
cn=Fred
cn=Joe
ou=More People
</code></pre>]]></long-description>
          <tag line="952" name="param" description="The DN of the entry whose children to return." type="string" variable="$dn">
            <type by_reference="false">string</type>
          </tag>
          <tag line="952" name="param" description="Which connection method resource to use" type="string" variable="$method">
            <type by_reference="false">string</type>
          </tag>
          <tag line="952" name="param" description="(optional) The maximum number of entries to return. If unspecified, no limit is applied to the number of entries in the returned." type="int" variable="$size_limit">
            <type by_reference="false">int</type>
          </tag>
          <tag line="952" name="param" description="(optional) An LDAP filter to apply when fetching children, example: &quot;(objectClass=inetOrgPerson)&quot;" type="string" variable="$filter">
            <type by_reference="false">string</type>
          </tag>
          <tag line="952" name="param" description="(optional) The LDAP deref setting to use in the query" type="\constant" variable="$deref">
            <type by_reference="false">\constant</type>
          </tag>
          <tag line="952" name="return" description="An array of DN strings listing the immediate children of the specified entry." type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="985">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="985">
          <name>$method</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="985">
          <name>$size_limit</name>
          <default><![CDATA[0]]></default>
          <type/>
        </argument>
        <argument line="985">
          <name>$filter</name>
          <default><![CDATA['(objectClass=*)']]></default>
          <type/>
        </argument>
        <argument line="985">
          <name>$deref</name>
          <default><![CDATA[LDAP_DEREF_NEVER]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1035" package="phpLDAPadmin\DataStore">
        <name>explodeDN</name>
        <full_name>explodeDN</full_name>
        <docblock line="1016">
          <description><![CDATA[Explode a DN into an array of its RDN parts.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1016" name="param" description="The DN to explode." type="string" variable="$dn">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1016" name="param" description="(optional) Whether to include attribute names (see http://php.net/ldap_explode_dn for details)" type="int" variable="$with_attributes">
            <type by_reference="false">int</type>
          </tag>
          <tag line="1016" name="return" description="An array of RDN parts of this format: &lt;code&gt; Array ( [0] =&gt; uid=ppratt [1] =&gt; ou=People [2] =&gt; dc=example [3] =&gt; dc=com ) &lt;/code&gt; NOTE: When a multivalue RDN is passed to ldap_explode_dn, the results returns with 'value + value';" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1035">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1035">
          <name>$with_attributes</name>
          <default><![CDATA[0]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1083" package="phpLDAPadmin\DataStore">
        <name>escapeDN</name>
        <full_name>escapeDN</full_name>
        <docblock line="1080">
          <description><![CDATA[Parse a DN and escape any special characters]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="1083">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1105" package="phpLDAPadmin\DataStore">
        <name>unescapeDN</name>
        <full_name>unescapeDN</full_name>
        <docblock line="1102">
          <description><![CDATA[Parse a DN and unescape any special characters]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="1105">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1120" package="phpLDAPadmin\DataStore">
        <name>getRootDSE</name>
        <full_name>getRootDSE</full_name>
        <argument line="1120">
          <name>$method</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1148" package="phpLDAPadmin\DataStore">
        <name>getSchemaDN</name>
        <full_name>getSchemaDN</full_name>
        <docblock line="1138">
          <description><![CDATA[This function will query the ldap server and request the subSchemaSubEntry which should be the Schema DN.]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="1138" name="param" description="Which connection method resource to use" type="string" variable="$method">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1138" name="param" description="The DN to use to obtain the schema" type="\dn" variable="$dn">
            <type by_reference="false">\dn</type>
          </tag>
          <tag line="1138" name="return" description="Schema if available, null if its not or false if we cant connect." type="array|false">
            <type by_reference="false">array</type>
            <type by_reference="false">false</type>
          </tag>
        </docblock>
        <argument line="1148">
          <name>$method</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="1148">
          <name>$dn</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1252" package="phpLDAPadmin\DataStore">
        <name>getRawSchema</name>
        <full_name>getRawSchema</full_name>
        <docblock line="1225">
          <description><![CDATA[Fetches the raw schema array for the subschemaSubentry of the server.]]></description>
          <long-description><![CDATA[<p>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".</p>

<p>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.</p>]]></long-description>
          <tag line="1225" name="param" description="Which connection method resource to use" type="string" variable="$method">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1225" name="param" description="A string indicating which type of schema to fetch. Five valid values: 'objectclasses', 'attributetypes', 'ldapsyntaxes', 'matchingruleuse', or 'matchingrules'. Case insensitive." type="string" variable="$schema_to_fetch">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1225" name="param" description="(optional) This paremeter is the DN of the entry whose schema you would like to fetch. Entries have the option of specifying their own subschemaSubentry that points to the DN of the system schema entry which applies to this attribute. If unspecified, this will try to retrieve the schema from the RootDSE subschemaSubentry. Failing that, we use some commonly known schema DNs. Default value is the Root DSE DN (zero-length string)" type="\dn" variable="$dn">
            <type by_reference="false">\dn</type>
          </tag>
          <tag line="1225" name="return" description="an array of strings of this form: Array ( [0] =&gt; &quot;(1.3.6.1.4.1.7165.1.2.2.4 NAME 'gidPool' DESC 'Pool ... [1] =&gt; &quot;(1.3.6.1.4.1.7165.2.2.3 NAME 'sambaAccount' DESC 'Sa ... etc." type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1252">
          <name>$method</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1252">
          <name>$schema_to_fetch</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1252">
          <name>$dn</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1482" package="phpLDAPadmin\DataStore">
        <name>getSchemaObjectClass</name>
        <full_name>getSchemaObjectClass</full_name>
        <docblock line="1470">
          <description><![CDATA[Gets a single ObjectClass object specified by name.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1470" name="param" description="The name of the objectClass to fetch." type="string" variable="$oclass_name">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1470" name="param" description="(optional) It is easier to fetch schema if a DN is provided which defines the subschemaSubEntry attribute (all entries should)." type="string" variable="$dn">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1470" name="return" description="The specified ObjectClass object or false on error." type="\ObjectClass">
            <type by_reference="false">\ObjectClass</type>
          </tag>
          <tag line="1470" name="see" description="\global\ObjectClass" refers="\global\ObjectClass"/>
          <tag line="1470" name="see" description="\global\SchemaObjectClasses" refers="\global\SchemaObjectClasses"/>
        </docblock>
        <argument line="1482">
          <name>$oclass_name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1482">
          <name>$method</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="1482">
          <name>$dn</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1513" package="phpLDAPadmin\DataStore">
        <name>getSchemaAttribute</name>
        <full_name>getSchemaAttribute</full_name>
        <docblock line="1501">
          <description><![CDATA[Gets a single AttributeType object specified by name.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1501" name="param" description="The name of the AttributeType to fetch." type="string" variable="$oclass_name">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1501" name="param" description="(optional) It is easier to fetch schema if a DN is provided which defines the subschemaSubEntry attribute (all entries should)." type="string" variable="$dn">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1501" name="return" description="The specified AttributeType object or false on error." type="\AttributeType">
            <type by_reference="false">\AttributeType</type>
          </tag>
          <tag line="1501" name="see" description="\global\AttributeType" refers="\global\AttributeType"/>
          <tag line="1501" name="see" description="\global\SchemaAttributes" refers="\global\SchemaAttributes"/>
        </docblock>
        <argument line="1513">
          <name>$attr_name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1513">
          <name>$method</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="1513">
          <name>$dn</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1545" package="phpLDAPadmin\DataStore">
        <name>SchemaObjectClasses</name>
        <full_name>SchemaObjectClasses</full_name>
        <docblock line="1532">
          <description><![CDATA[Gets an associative array of ObjectClass objects for the specified
server.]]></description>
          <long-description><![CDATA[<p>Each array entry's key is the name of the objectClass
in lower-case and the value is an ObjectClass object.</p>]]></long-description>
          <tag line="1532" name="param" description="(optional) It is easier to fetch schema if a DN is provided which defines the subschemaSubEntry attribute (all entries should)." type="string" variable="$dn">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1532" name="return" description="An array of ObjectClass objects." type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1532" name="see" description="\global\ObjectClass" refers="\global\ObjectClass"/>
          <tag line="1532" name="see" description="\global\getSchemaObjectClass" refers="\global\getSchemaObjectClass"/>
        </docblock>
        <argument line="1545">
          <name>$method</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="1545">
          <name>$dn</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1601" package="phpLDAPadmin\DataStore">
        <name>SchemaAttributes</name>
        <full_name>SchemaAttributes</full_name>
        <docblock line="1591">
          <description><![CDATA[Gets an associative array of AttributeType objects for the specified
server.]]></description>
          <long-description><![CDATA[<p>Each array entry's key is the name of the attributeType
in lower-case and the value is an AttributeType object.</p>]]></long-description>
          <tag line="1591" name="param" description="(optional) It is easier to fetch schema if a DN is provided which defines the subschemaSubEntry attribute (all entries should)." type="string" variable="$dn">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1591" name="return" description="An array of AttributeType objects." type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="1601">
          <name>$method</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="1601">
          <name>$dn</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1780" package="phpLDAPadmin\DataStore">
        <name>MatchingRules</name>
        <full_name>MatchingRules</full_name>
        <docblock line="1776">
          <description><![CDATA[Returns an array of MatchingRule objects for the specified server.]]></description>
          <long-description><![CDATA[<p>The key of each entry is the OID of the matching rule.</p>]]></long-description>
        </docblock>
        <argument line="1780">
          <name>$method</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="1780">
          <name>$dn</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1856" package="phpLDAPadmin\DataStore">
        <name>SchemaSyntaxes</name>
        <full_name>SchemaSyntaxes</full_name>
        <docblock line="1852">
          <description><![CDATA[Returns an array of Syntax objects that this LDAP server uses mapped to
their descriptions.]]></description>
          <long-description><![CDATA[<p>The key of each entry is the OID of the Syntax.</p>]]></long-description>
        </docblock>
        <argument line="1856">
          <name>$method</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="1856">
          <name>$dn</name>
          <default><![CDATA['']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1908" package="phpLDAPadmin\DataStore">
        <name>isForceMay</name>
        <full_name>isForceMay</full_name>
        <docblock line="1901">
          <description><![CDATA[This function determines if the specified attribute is contained in the force_may list
as configured in config.php.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1901" name="return" description="True if the specified attribute is in the $force_may list and false otherwise." type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="1908">
          <name>$attr_name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1943" package="phpLDAPadmin\DataStore">
        <name>getDNAttrValue</name>
        <full_name>getDNAttrValue</full_name>
        <docblock line="1915">
          <description><![CDATA[Much like getDNAttrValues(), but only returns the values for
one attribute of an object.]]></description>
          <long-description><![CDATA[<p>Example calls:</p>

<pre><code>print_r(getDNAttrValue('cn=Bob,ou=people,dc=example,dc=com','sn'));
Array (
    [0] => Smith
)

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

<p>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.</p>

<p>Example of its usage:</p>

<pre><code>print_r(getDNAttrValues('cn=Bob,ou=pepole,dc=example,dc=com')
Array (
    [objectClass] => Array (
        [0] => person
        [1] => top
    )
    [cn] => Array (
        [0] => Bob
    )
    [sn] => Array (
        [0] => Jones
    )
    [dn] => Array (
        [0] => cn=Bob,ou=pepole,dc=example,dc=com
    )
)
</code></pre>]]></long-description>
          <tag line="1958" name="param" description="The distinguished name (DN) of the entry whose attributes/values to fetch." type="string" variable="$dn">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1958" name="param" description="Which connection method resource to use" type="string" variable="$method">
            <type by_reference="false">string</type>
          </tag>
          <tag line="1958" name="param" description="For aliases and referrals, this parameter specifies whether to follow references to the referenced DN or to fetch the attributes for the referencing DN. See http://php.net/ldap_search for the 4 valid options." type="\constant" variable="$deref">
            <type by_reference="false">\constant</type>
          </tag>
          <tag line="1958" name="return" description="" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1958" name="see" description="\global\getDNSysAttrs" refers="\global\getDNSysAttrs"/>
          <tag line="1958" name="see" description="\global\getDNAttrValue" refers="\global\getDNAttrValue"/>
        </docblock>
        <argument line="1997">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1997">
          <name>$method</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
        <argument line="1997">
          <name>$deref</name>
          <default><![CDATA[LDAP_DEREF_NEVER]]></default>
          <type/>
        </argument>
        <argument line="1997">
          <name>$attrs</name>
          <default><![CDATA[array('*', '+')]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2055" package="phpLDAPadmin\DataStore">
        <name>isDNAttr</name>
        <full_name>isDNAttr</full_name>
        <docblock line="2048">
          <description><![CDATA[Returns true if the attribute specified is required to take as input a DN.]]></description>
          <long-description><![CDATA[<p>Some examples include 'distinguishedName', 'member' and 'uniqueMember'.</p>]]></long-description>
          <tag line="2048" name="param" description="The name of the attribute of interest (case insensitive)" type="string" variable="$attr_name">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2048" name="return" description="" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="2055">
          <name>$attr_name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2055">
          <name>$method</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2096" package="phpLDAPadmin\DataStore">
        <name>isJpegPhoto</name>
        <full_name>isJpegPhoto</full_name>
        <docblock line="2087">
          <description><![CDATA[Used to determine if the specified attribute is indeed a jpegPhoto.]]></description>
          <long-description><![CDATA[<p>If the
specified attribute is one that houses jpeg data, true is returned. Otherwise
this function returns false.</p>]]></long-description>
          <tag line="2087" name="param" description="The name of the attribute to test." type="string" variable="$attr_name">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2087" name="return" description="" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="2087" name="see" description="\global\draw_jpeg_photo" refers="\global\draw_jpeg_photo"/>
        </docblock>
        <argument line="2096">
          <name>$attr_name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2127" package="phpLDAPadmin\DataStore">
        <name>isAttrBoolean</name>
        <full_name>isAttrBoolean</full_name>
        <docblock line="2118">
          <description><![CDATA[Given an attribute name and server ID number, this function returns
whether the attrbiute contains boolean data.]]></description>
          <long-description><![CDATA[<p>This is useful for
developers who wish to display the contents of a boolean attribute
with a drop-down.</p>]]></long-description>
          <tag line="2118" name="param" description="The name of the attribute to test." type="string" variable="$attr_name">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2118" name="return" description="" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="2127">
          <name>$attr_name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2153" package="phpLDAPadmin\DataStore">
        <name>isAttrBinary</name>
        <full_name>isAttrBinary</full_name>
        <docblock line="2142">
          <description><![CDATA[Given an attribute name and server ID number, this function returns
whether the attribute may contain binary data.]]></description>
          <long-description><![CDATA[<p>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.</p>]]></long-description>
          <tag line="2142" name="param" description="The name of the attribute to test." type="string" variable="$attr_name">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2142" name="return" description="" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="2142" name="see" description="\global\isJpegPhoto" refers="\global\isJpegPhoto"/>
        </docblock>
        <argument line="2153">
          <name>$attr_name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2239" package="phpLDAPadmin\DataStore">
        <name>userIsMember</name>
        <full_name>userIsMember</full_name>
        <docblock line="2231">
          <description><![CDATA[This function will test if a user is a member of a group.]]></description>
          <long-description><![CDATA[<p>Inputs:</p>]]></long-description>
          <tag line="2231" name="param" description="membership value that is being checked" type="string" variable="$user">
            <type by_reference="false">string</type>
          </tag>
          <tag line="2231" name="param" description="DN to see if user is a member" type="\dn" variable="$group">
            <type by_reference="false">\dn</type>
          </tag>
          <tag line="2231" name="return" description="true|false" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="2239">
          <name>$user</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="2239">
          <name>$group</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="2270" package="phpLDAPadmin\DataStore">
        <name>userIsAllowedLogin</name>
        <full_name>userIsAllowedLogin</full_name>
        <docblock line="2267">
          <description><![CDATA[This function will determine if the user is allowed to login based on a filter]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="2270">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <parse_markers>
      <error line="17" code="50018">No DocBlock was found for property $noconnect</error>
      <error line="19" code="50018">No DocBlock was found for property $_schema_entries</error>
      <error line="21" code="50018">No DocBlock was found for property $_schemaDN</error>
      <error line="23" code="50018">No DocBlock was found for property $force_may</error>
      <error line="25" code="50010">No DocBlock was found for method __construct()</error>
      <error line="123" code="50015">Argument $debug is missing from the Docblock of connect()</error>
      <error line="123" code="50015">Argument $new is missing from the Docblock of connect()</error>
      <error line="242" code="50015">Argument $user is missing from the Docblock of login()</error>
      <error line="242" code="50015">Argument $pass is missing from the Docblock of login()</error>
      <error line="242" code="50015">Argument $method is missing from the Docblock of login()</error>
      <error line="242" code="50015">Argument $new is missing from the Docblock of login()</error>
      <error line="466" code="50015">Argument $method is missing from the Docblock of getLoginID()</error>
      <error line="556" code="50015">Argument $resource is missing from the Docblock of startTLS()</error>
      <error line="597" code="50015">Argument $resource is missing from the Docblock of startSASL()</error>
      <error line="597" code="50015">Argument $method is missing from the Docblock of startSASL()</error>
      <error line="674" code="50015">Argument $resource is missing from the Docblock of startProxy()</error>
      <error line="674" code="50015">Argument $method is missing from the Docblock of startProxy()</error>
      <error line="763" code="50015">Argument $dn is missing from the Docblock of modify()</error>
      <error line="763" code="50015">Argument $attrs is missing from the Docblock of modify()</error>
      <error line="763" code="50015">Argument $method is missing from the Docblock of modify()</error>
      <error line="1080" code="50015">Argument $dn is missing from the Docblock of escapeDN()</error>
      <error line="1102" code="50015">Argument $dn is missing from the Docblock of unescapeDN()</error>
      <error line="1120" code="50010">No DocBlock was found for method getRootDSE()</error>
      <error line="1470" code="50014">Name of argument $method does not match with the DocBlock's name $dn in getSchemaObjectClass()</error>
      <error line="1470" code="50015">Argument $dn is missing from the Docblock of getSchemaObjectClass()</error>
      <error line="1501" code="50014">Name of argument $attr_name does not match with the DocBlock's name $oclass_name in getSchemaAttribute()</error>
      <error line="1501" code="50014">Name of argument $method does not match with the DocBlock's name $dn in getSchemaAttribute()</error>
      <error line="1501" code="50015">Argument $dn is missing from the Docblock of getSchemaAttribute()</error>
      <notice line="1501" code="50013">Parameter $oclass_name could not be found in getSchemaAttribute()</notice>
      <error line="1532" code="50014">Name of argument $method does not match with the DocBlock's name $dn in SchemaObjectClasses()</error>
      <error line="1532" code="50015">Argument $dn is missing from the Docblock of SchemaObjectClasses()</error>
      <error line="1591" code="50014">Name of argument $method does not match with the DocBlock's name $dn in SchemaAttributes()</error>
      <error line="1591" code="50015">Argument $dn is missing from the Docblock of SchemaAttributes()</error>
      <error line="1776" code="50015">Argument $method is missing from the Docblock of MatchingRules()</error>
      <error line="1776" code="50015">Argument $dn is missing from the Docblock of MatchingRules()</error>
      <error line="1852" code="50015">Argument $method is missing from the Docblock of SchemaSyntaxes()</error>
      <error line="1852" code="50015">Argument $dn is missing from the Docblock of SchemaSyntaxes()</error>
      <error line="1901" code="50015">Argument $attr_name is missing from the Docblock of isForceMay()</error>
      <error line="1958" code="50015">Argument $attrs is missing from the Docblock of getDNAttrValues()</error>
      <error line="2048" code="50015">Argument $method is missing from the Docblock of isDNAttr()</error>
      <error line="2267" code="50015">Argument $dn is missing from the Docblock of userIsAllowedLogin()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/lib/common.php" hash="567c07393a4d9b23bd6041b0fb1ae6d4" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Contains code to be executed at the top of each application page.]]></description>
      <long-description><![CDATA[<p>include this file at the top of every PHP file.</p>

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

<p>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).</p>

<p>The list of ADDITIONAL function files is now defined in functions.php.</p>]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <include line="123" type="Require Once" package="main">
      <name/>
    </include>
    <include line="149" type="Require Once" package="main">
      <name/>
    </include>
    <include line="152" type="Require Once" package="main">
      <name/>
    </include>
    <include line="175" type="Require Once" package="main">
      <name/>
    </include>
    <include line="252" type="Require" package="main">
      <name/>
    </include>
    <constant namespace="global" line="29" package="phpLDAPadmin">
      <name>APPCONFIG</name>
      <full_name>\APPCONFIG</full_name>
      <value><![CDATA['plaConfig']]></value>
    </constant>
    <constant namespace="global" line="115" package="phpLDAPadmin">
      <name>LIBDIR</name>
      <full_name>\LIBDIR</full_name>
      <value><![CDATA['../lib/']]></value>
    </constant>
    <constant namespace="global" line="119" package="phpLDAPadmin">
      <name>E_STRICT</name>
      <full_name>\E_STRICT</full_name>
      <value><![CDATA[2048]]></value>
    </constant>
    <constant namespace="global" line="170" package="phpLDAPadmin">
      <name>CSSDIR</name>
      <full_name>\CSSDIR</full_name>
      <value><![CDATA[sprintf('css/%s', $app['theme'])]]></value>
    </constant>
    <constant namespace="global" line="171" package="phpLDAPadmin">
      <name>IMGDIR</name>
      <full_name>\IMGDIR</full_name>
      <value><![CDATA[sprintf('images/%s', $app['theme'])]]></value>
    </constant>
    <constant namespace="global" line="205" package="phpLDAPadmin">
      <name>DEBUG_ENABLED</name>
      <full_name>\DEBUG_ENABLED</full_name>
      <value><![CDATA[0]]></value>
    </constant>
    <function namespace="global" line="87" package="phpLDAPadmin">
      <name>stopwatch</name>
      <full_name>\stopwatch</full_name>
    </function>
    <parse_markers>
      <error line="87" code="50009">No DocBlock was found for function \stopwatch()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/lib/MassRender.php" hash="ae2063510c5064c07f9dc6ece2a9d307" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[This class will render the editing of multiple LDAP entries.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="15" package="phpLDAPadmin\Templates">
      <extends>\TemplateRender</extends>
      <name>MassRender</name>
      <full_name>\MassRender</full_name>
      <docblock line="9">
        <description><![CDATA[TemplateRender class]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="9" name="package" description="phpLDAPadmin"/>
        <tag line="9" name="subpackage" description="Templates"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="16" package="phpLDAPadmin\Templates">
        <name>drawMassFormReadWriteValueAttribute</name>
        <full_name>drawMassFormReadWriteValueAttribute</full_name>
        <argument line="16">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="16">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="16">
          <name>$j</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="40" package="phpLDAPadmin\Templates">
        <name>drawMassFormReadWriteValueBinaryAttribute</name>
        <full_name>drawMassFormReadWriteValueBinaryAttribute</full_name>
        <argument line="40">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="40">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="40">
          <name>$j</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="44" package="phpLDAPadmin\Templates">
        <name>drawMassFormReadWriteValueJpegAttribute</name>
        <full_name>drawMassFormReadWriteValueJpegAttribute</full_name>
        <argument line="44">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="44">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="44">
          <name>$j</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <parse_markers>
      <error line="16" code="50010">No DocBlock was found for method drawMassFormReadWriteValueAttribute()</error>
      <error line="40" code="50010">No DocBlock was found for method drawMassFormReadWriteValueBinaryAttribute()</error>
      <error line="44" code="50010">No DocBlock was found for method drawMassFormReadWriteValueJpegAttribute()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/lib/GidAttribute.php" hash="637879c2395ef0a5f5b07cd6dc431f81" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Classes and functions for the template engine.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="15" package="phpLDAPadmin\Templates">
      <extends>\Attribute</extends>
      <name>GidAttribute</name>
      <full_name>\GidAttribute</full_name>
      <docblock line="9">
        <description><![CDATA[Represents a 'gidNumber' attribute]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="9" name="package" description="phpLDAPadmin"/>
        <tag line="9" name="subpackage" description="Templates"/>
      </docblock>
    </class>
  </file>
  <file path="templates/3rdParty/pla/lib/PageRender.php" hash="ac134fdaedfc937aa4ad588fd741d710" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="13" package="phpLDAPadmin\Templates">
      <extends>\Visitor</extends>
      <name>PageRender</name>
      <full_name>\PageRender</full_name>
      <docblock line="7">
        <description><![CDATA[PageRender class]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="7" name="package" description="phpLDAPadmin"/>
        <tag line="7" name="subpackage" description="Templates"/>
      </docblock>
      <property final="false" static="false" visibility="protected" line="15" namespace="global" package="main">
        <name>$template_id</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="16" namespace="global" package="main">
        <name>$template</name>
        <default><![CDATA[null]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="18" namespace="global" package="main">
        <name>$dn</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="19" namespace="global" package="main">
        <name>$container</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="21" namespace="global" package="main">
        <name>$page</name>
        <default><![CDATA[]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="23" package="phpLDAPadmin\Templates">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <argument line="23">
          <name>$server_id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="23">
          <name>$template_id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="34" package="phpLDAPadmin\Templates">
        <name>visitAttribute</name>
        <full_name>visitAttribute</full_name>
        <docblock line="31">
          <description><![CDATA[Dummy method.]]></description>
          <long-description><![CDATA[<p>..</p>]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="39" package="phpLDAPadmin\Templates">
        <name>getTemplates</name>
        <full_name>getTemplates</full_name>
        <docblock line="36">
          <description><![CDATA[Get our templates applicable for this object]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="46" package="phpLDAPadmin\Templates">
        <name>getTemplate</name>
        <full_name>getTemplate</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="53" package="phpLDAPadmin\Templates">
        <name>getTemplateID</name>
        <full_name>getTemplateID</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="63" package="phpLDAPadmin\Templates">
        <name>accept</name>
        <full_name>accept</full_name>
        <docblock line="60">
          <description><![CDATA[Initialise the PageRender]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="103" package="phpLDAPadmin\Templates">
        <name>drawTitle</name>
        <full_name>drawTitle</full_name>
        <argument line="103">
          <name>$title</name>
          <default><![CDATA['Title']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="107" package="phpLDAPadmin\Templates">
        <name>drawSubTitle</name>
        <full_name>drawSubTitle</full_name>
        <argument line="107">
          <name>$subtitle</name>
          <default><![CDATA[null]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="115" package="phpLDAPadmin\Templates">
        <name>setDN</name>
        <full_name>setDN</full_name>
        <argument line="115">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="128" package="phpLDAPadmin\Templates">
        <name>setContainer</name>
        <full_name>setContainer</full_name>
        <argument line="128">
          <name>$dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="144" package="phpLDAPadmin\Templates">
        <name>getMode</name>
        <full_name>getMode</full_name>
        <docblock line="141">
          <description><![CDATA[May be overloaded in other classes]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="145" package="phpLDAPadmin\Templates">
        <name>getModeContainer</name>
        <full_name>getModeContainer</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="150" package="phpLDAPadmin\Templates">
        <name>getPostAttribute</name>
        <full_name>getPostAttribute</full_name>
        <docblock line="147">
          <description><![CDATA[Process our <post> arguments from the templates]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="150">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="150">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="313" package="phpLDAPadmin\Templates">
        <name>getTemplateChoice</name>
        <full_name>getTemplateChoice</full_name>
        <docblock line="308">
          <description><![CDATA[This function is invoked if we dont know which template we should be using.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="308" name="return" description="Template ID to be used or null if the user was presented with a list." type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="true" abstract="false" static="false" visibility="protected" namespace="global" line="362" package="phpLDAPadmin\Templates">
        <name>drawNameAttribute</name>
        <full_name>drawNameAttribute</full_name>
        <docblock line="360">
          <description><![CDATA[DRAW ATTRIBUTE NAME *]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="362">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="383" package="phpLDAPadmin\Templates">
        <name>drawNotesAttribute</name>
        <full_name>drawNotesAttribute</full_name>
        <docblock line="381">
          <description><![CDATA[ATTRIBUTE NOTES]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="383">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="403" package="phpLDAPadmin\Templates">
        <name>getNoteAliasAttribute</name>
        <full_name>getNoteAliasAttribute</full_name>
        <argument line="403">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="408" package="phpLDAPadmin\Templates">
        <name>getNoteRequiredAttribute</name>
        <full_name>getNoteRequiredAttribute</full_name>
        <argument line="408">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="450" package="phpLDAPadmin\Templates">
        <name>getNoteRDNAttribute</name>
        <full_name>getNoteRDNAttribute</full_name>
        <argument line="450">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="463" package="phpLDAPadmin\Templates">
        <name>getNoteHintAttribute</name>
        <full_name>getNoteHintAttribute</full_name>
        <argument line="463">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="476" package="phpLDAPadmin\Templates">
        <name>getNoteROAttribute</name>
        <full_name>getNoteROAttribute</full_name>
        <argument line="476">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="true" abstract="false" static="false" visibility="public" namespace="global" line="489" package="phpLDAPadmin\Templates">
        <name>drawHiddenAttributes</name>
        <full_name>drawHiddenAttributes</full_name>
        <docblock line="486">
          <description><![CDATA[Draw all hidden attributes]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="true" abstract="false" static="false" visibility="protected" namespace="global" line="508" package="phpLDAPadmin\Templates">
        <name>drawHiddenValueAttribute</name>
        <full_name>drawHiddenValueAttribute</full_name>
        <docblock line="505">
          <description><![CDATA[Draw specific hidden attribute]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="508">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="508">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="519" package="phpLDAPadmin\Templates">
        <name>drawOldValuesAttribute</name>
        <full_name>drawOldValuesAttribute</full_name>
        <docblock line="518">
          <description><![CDATA[DRAW DISPLAYED OLD VALUES *]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="519">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="true" abstract="false" static="false" visibility="protected" namespace="global" line="526" package="phpLDAPadmin\Templates">
        <name>drawOldValueAttribute</name>
        <full_name>drawOldValueAttribute</full_name>
        <argument line="526">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="526">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="534" package="phpLDAPadmin\Templates">
        <name>drawCurrentValuesAttribute</name>
        <full_name>drawCurrentValuesAttribute</full_name>
        <docblock line="532">
          <description><![CDATA[DRAW DISPLAYED CURRENT VALUES *]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="534">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="true" abstract="false" static="false" visibility="protected" namespace="global" line="548" package="phpLDAPadmin\Templates">
        <name>drawCurrentValueAttribute</name>
        <full_name>drawCurrentValueAttribute</full_name>
        <docblock line="545">
          <description><![CDATA[Draw the current specific value of an attribute]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="548">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="548">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="558" package="phpLDAPadmin\Templates">
        <name>drawFormValueAttribute</name>
        <full_name>drawFormValueAttribute</full_name>
        <docblock line="555">
          <description><![CDATA[Draw a input value for an attribute - used in a form.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="558">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="558">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="577" package="phpLDAPadmin\Templates">
        <name>drawFormReadOnlyValueAttribute</name>
        <full_name>drawFormReadOnlyValueAttribute</full_name>
        <argument line="577">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="577">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="586" package="phpLDAPadmin\Templates">
        <name>drawFormReadWriteValueAttribute</name>
        <full_name>drawFormReadWriteValueAttribute</full_name>
        <argument line="586">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="586">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="true" abstract="false" static="false" visibility="protected" namespace="global" line="630" package="phpLDAPadmin\Templates">
        <name>drawHiddenValueBinaryAttribute</name>
        <full_name>drawHiddenValueBinaryAttribute</full_name>
        <docblock line="627">
          <description><![CDATA[Draw specific hidden binary attribute]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="630">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="630">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="true" abstract="false" static="false" visibility="protected" namespace="global" line="639" package="phpLDAPadmin\Templates">
        <name>drawOldValueBinaryAttribute</name>
        <full_name>drawOldValueBinaryAttribute</full_name>
        <argument line="639">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="639">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="true" abstract="false" static="false" visibility="protected" namespace="global" line="647" package="phpLDAPadmin\Templates">
        <name>drawCurrentValueBinaryAttribute</name>
        <full_name>drawCurrentValueBinaryAttribute</full_name>
        <argument line="647">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="647">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="654" package="phpLDAPadmin\Templates">
        <name>drawFormReadOnlyValueBinaryAttribute</name>
        <full_name>drawFormReadOnlyValueBinaryAttribute</full_name>
        <argument line="654">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="654">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="669" package="phpLDAPadmin\Templates">
        <name>drawFormReadWriteValueBinaryAttribute</name>
        <full_name>drawFormReadWriteValueBinaryAttribute</full_name>
        <argument line="669">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="669">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="690" package="phpLDAPadmin\Templates">
        <name>drawFormReadWriteValueDateAttribute</name>
        <full_name>drawFormReadWriteValueDateAttribute</full_name>
        <argument line="690">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="690">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="708" package="phpLDAPadmin\Templates">
        <name>drawFormReadWriteValueDnAttribute</name>
        <full_name>drawFormReadWriteValueDnAttribute</full_name>
        <argument line="708">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="708">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="739" package="phpLDAPadmin\Templates">
        <name>drawFormReadWriteValueGidAttribute</name>
        <full_name>drawFormReadWriteValueGidAttribute</full_name>
        <argument line="739">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="739">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="true" abstract="false" static="false" visibility="protected" namespace="global" line="792" package="phpLDAPadmin\Templates">
        <name>drawOldValueJpegAttribute</name>
        <full_name>drawOldValueJpegAttribute</full_name>
        <docblock line="789">
          <description><![CDATA[Draw a Jpeg Attribute]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="792">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="792">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="true" abstract="false" static="false" visibility="protected" namespace="global" line="806" package="phpLDAPadmin\Templates">
        <name>drawCurrentValueJpegAttribute</name>
        <full_name>drawCurrentValueJpegAttribute</full_name>
        <docblock line="803">
          <description><![CDATA[Draw a Jpeg Attribute]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="806">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="806">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="822" package="phpLDAPadmin\Templates">
        <name>drawFormReadOnlyValueJpegAttribute</name>
        <full_name>drawFormReadOnlyValueJpegAttribute</full_name>
        <argument line="822">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="822">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="829" package="phpLDAPadmin\Templates">
        <name>drawFormReadOnlyValueMultiLineAttribute</name>
        <full_name>drawFormReadOnlyValueMultiLineAttribute</full_name>
        <argument line="829">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="829">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="842" package="phpLDAPadmin\Templates">
        <name>drawFormReadWriteValueMultiLineAttribute</name>
        <full_name>drawFormReadWriteValueMultiLineAttribute</full_name>
        <argument line="842">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="842">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="857" package="phpLDAPadmin\Templates">
        <name>drawFormValueObjectClassAttribute</name>
        <full_name>drawFormValueObjectClassAttribute</full_name>
        <argument line="857">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="857">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="888" package="phpLDAPadmin\Templates">
        <name>getAutoPostPasswordAttribute</name>
        <full_name>getAutoPostPasswordAttribute</full_name>
        <argument line="888">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="888">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="897" package="phpLDAPadmin\Templates">
        <name>drawOldValuePasswordAttribute</name>
        <full_name>drawOldValuePasswordAttribute</full_name>
        <argument line="897">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="897">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="true" abstract="false" static="false" visibility="protected" namespace="global" line="909" package="phpLDAPadmin\Templates">
        <name>drawCurrentValuePasswordAttribute</name>
        <full_name>drawCurrentValuePasswordAttribute</full_name>
        <argument line="909">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="909">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="921" package="phpLDAPadmin\Templates">
        <name>drawFormReadOnlyValuePasswordAttribute</name>
        <full_name>drawFormReadOnlyValuePasswordAttribute</full_name>
        <argument line="921">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="921">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="943" package="phpLDAPadmin\Templates">
        <name>drawFormReadWriteValuePasswordAttribute</name>
        <full_name>drawFormReadWriteValuePasswordAttribute</full_name>
        <argument line="943">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="943">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="996" package="phpLDAPadmin\Templates">
        <name>drawFormReadWriteValueSelectionAttribute</name>
        <full_name>drawFormReadWriteValueSelectionAttribute</full_name>
        <argument line="996">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="996">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1128" package="phpLDAPadmin\Templates">
        <name>shadow_date</name>
        <full_name>shadow_date</full_name>
        <docblock line="1122">
          <description><![CDATA[Takes a shadow* attribute and returns the date as an integer.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="1122" name="param" description="Attribute objects" type="array" variable="$attribute">
            <type by_reference="false">array</type>
          </tag>
          <tag line="1122" name="param" description="A shadow attribute name" type="string" variable="">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="1128">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1167" package="phpLDAPadmin\Templates">
        <name>drawShadowDateShadowAttribute</name>
        <full_name>drawShadowDateShadowAttribute</full_name>
        <argument line="1167">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1195" package="phpLDAPadmin\Templates">
        <name>drawFormReadOnlyValueShadowAttribute</name>
        <full_name>drawFormReadOnlyValueShadowAttribute</full_name>
        <argument line="1195">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1195">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1202" package="phpLDAPadmin\Templates">
        <name>drawFormReadWriteValueShadowAttribute</name>
        <full_name>drawFormReadWriteValueShadowAttribute</full_name>
        <argument line="1202">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="1202">
          <name>$i</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <parse_markers>
      <critical line="2" code="50008">No short description for file templates/3rdParty/pla/lib/PageRender.php</critical>
      <error line="15" code="50018">No DocBlock was found for property $template_id</error>
      <error line="16" code="50018">No DocBlock was found for property $template</error>
      <error line="18" code="50018">No DocBlock was found for property $dn</error>
      <error line="19" code="50018">No DocBlock was found for property $container</error>
      <error line="21" code="50018">No DocBlock was found for property $page</error>
      <error line="23" code="50010">No DocBlock was found for method __construct()</error>
      <error line="46" code="50010">No DocBlock was found for method getTemplate()</error>
      <error line="53" code="50010">No DocBlock was found for method getTemplateID()</error>
      <error line="103" code="50010">No DocBlock was found for method drawTitle()</error>
      <error line="107" code="50010">No DocBlock was found for method drawSubTitle()</error>
      <error line="115" code="50010">No DocBlock was found for method setDN()</error>
      <error line="128" code="50010">No DocBlock was found for method setContainer()</error>
      <error line="145" code="50010">No DocBlock was found for method getModeContainer()</error>
      <error line="147" code="50015">Argument $attribute is missing from the Docblock of getPostAttribute()</error>
      <error line="147" code="50015">Argument $i is missing from the Docblock of getPostAttribute()</error>
      <error line="360" code="50015">Argument $attribute is missing from the Docblock of drawNameAttribute()</error>
      <error line="381" code="50015">Argument $attribute is missing from the Docblock of drawNotesAttribute()</error>
      <error line="403" code="50010">No DocBlock was found for method getNoteAliasAttribute()</error>
      <error line="408" code="50010">No DocBlock was found for method getNoteRequiredAttribute()</error>
      <error line="450" code="50010">No DocBlock was found for method getNoteRDNAttribute()</error>
      <error line="463" code="50010">No DocBlock was found for method getNoteHintAttribute()</error>
      <error line="476" code="50010">No DocBlock was found for method getNoteROAttribute()</error>
      <error line="505" code="50015">Argument $attribute is missing from the Docblock of drawHiddenValueAttribute()</error>
      <error line="505" code="50015">Argument $i is missing from the Docblock of drawHiddenValueAttribute()</error>
      <error line="518" code="50015">Argument $attribute is missing from the Docblock of drawOldValuesAttribute()</error>
      <error line="526" code="50010">No DocBlock was found for method drawOldValueAttribute()</error>
      <error line="532" code="50015">Argument $attribute is missing from the Docblock of drawCurrentValuesAttribute()</error>
      <error line="545" code="50015">Argument $attribute is missing from the Docblock of drawCurrentValueAttribute()</error>
      <error line="545" code="50015">Argument $i is missing from the Docblock of drawCurrentValueAttribute()</error>
      <error line="555" code="50015">Argument $attribute is missing from the Docblock of drawFormValueAttribute()</error>
      <error line="555" code="50015">Argument $i is missing from the Docblock of drawFormValueAttribute()</error>
      <error line="577" code="50010">No DocBlock was found for method drawFormReadOnlyValueAttribute()</error>
      <error line="586" code="50010">No DocBlock was found for method drawFormReadWriteValueAttribute()</error>
      <error line="627" code="50015">Argument $attribute is missing from the Docblock of drawHiddenValueBinaryAttribute()</error>
      <error line="627" code="50015">Argument $i is missing from the Docblock of drawHiddenValueBinaryAttribute()</error>
      <error line="639" code="50010">No DocBlock was found for method drawOldValueBinaryAttribute()</error>
      <error line="647" code="50010">No DocBlock was found for method drawCurrentValueBinaryAttribute()</error>
      <error line="654" code="50010">No DocBlock was found for method drawFormReadOnlyValueBinaryAttribute()</error>
      <error line="669" code="50010">No DocBlock was found for method drawFormReadWriteValueBinaryAttribute()</error>
      <error line="690" code="50010">No DocBlock was found for method drawFormReadWriteValueDateAttribute()</error>
      <error line="708" code="50010">No DocBlock was found for method drawFormReadWriteValueDnAttribute()</error>
      <error line="739" code="50010">No DocBlock was found for method drawFormReadWriteValueGidAttribute()</error>
      <error line="789" code="50015">Argument $attribute is missing from the Docblock of drawOldValueJpegAttribute()</error>
      <error line="789" code="50015">Argument $i is missing from the Docblock of drawOldValueJpegAttribute()</error>
      <error line="803" code="50015">Argument $attribute is missing from the Docblock of drawCurrentValueJpegAttribute()</error>
      <error line="803" code="50015">Argument $i is missing from the Docblock of drawCurrentValueJpegAttribute()</error>
      <error line="822" code="50010">No DocBlock was found for method drawFormReadOnlyValueJpegAttribute()</error>
      <error line="829" code="50010">No DocBlock was found for method drawFormReadOnlyValueMultiLineAttribute()</error>
      <error line="842" code="50010">No DocBlock was found for method drawFormReadWriteValueMultiLineAttribute()</error>
      <error line="857" code="50010">No DocBlock was found for method drawFormValueObjectClassAttribute()</error>
      <error line="888" code="50010">No DocBlock was found for method getAutoPostPasswordAttribute()</error>
      <error line="897" code="50010">No DocBlock was found for method drawOldValuePasswordAttribute()</error>
      <error line="909" code="50010">No DocBlock was found for method drawCurrentValuePasswordAttribute()</error>
      <error line="921" code="50010">No DocBlock was found for method drawFormReadOnlyValuePasswordAttribute()</error>
      <error line="943" code="50010">No DocBlock was found for method drawFormReadWriteValuePasswordAttribute()</error>
      <error line="996" code="50010">No DocBlock was found for method drawFormReadWriteValueSelectionAttribute()</error>
      <notice line="1122" code="50013">Parameter  could not be found in shadow_date()</notice>
      <error line="1167" code="50010">No DocBlock was found for method drawShadowDateShadowAttribute()</error>
      <error line="1195" code="50010">No DocBlock was found for method drawFormReadOnlyValueShadowAttribute()</error>
      <error line="1202" code="50010">No DocBlock was found for method drawFormReadWriteValueShadowAttribute()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/lib/export_functions.php" hash="f46c7864d7d296749c4bc576aebd9cf7" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Classes and functions for export data from LDAP]]></description>
      <long-description><![CDATA[<p>These classes provide differnet export formats.</p>]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="see" description="\export.php" refers="\export.php"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="21" package="phpLDAPadmin\Export">
      <extends/>
      <name>Exporter</name>
      <full_name>\Exporter</full_name>
      <docblock line="12">
        <description><![CDATA[Exporter Class]]></description>
        <long-description><![CDATA[<p>This class serves as a top level exporter class, which will return
the correct Export class.</p>]]></long-description>
        <tag line="12" name="package" description="phpLDAPadmin"/>
        <tag line="12" name="subpackage" description="Export"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="23" namespace="global" package="main">
        <name>$server_id</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="25" namespace="global" package="main">
        <name>$template_id</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="26" namespace="global" package="main">
        <name>$template</name>
        <default><![CDATA[]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="28" package="phpLDAPadmin\Export">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <argument line="28">
          <name>$server_id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="28">
          <name>$template_id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="global" line="35" package="phpLDAPadmin\Export">
        <name>types</name>
        <full_name>types</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="50" package="phpLDAPadmin\Export">
        <name>accept</name>
        <full_name>accept</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="75" package="phpLDAPadmin\Export">
        <name>getTemplate</name>
        <full_name>getTemplate</full_name>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="89" package="phpLDAPadmin\Export">
      <extends/>
      <name>Export</name>
      <full_name>\Export</full_name>
      <docblock line="80">
        <description><![CDATA[Export Class]]></description>
        <long-description><![CDATA[<p>This abstract classes provides all the common methods and variables for the
custom export classes.</p>]]></long-description>
        <tag line="80" name="package" description="phpLDAPadmin"/>
        <tag line="80" name="subpackage" description="Export"/>
      </docblock>
      <property final="false" static="false" visibility="protected" line="91" namespace="global" package="main">
        <name>$br</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="93" namespace="global" package="main">
        <name>$compress</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="95" namespace="global" package="main">
        <name>$results</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="96" namespace="global" package="main">
        <name>$resultsdata</name>
        <default><![CDATA[]]></default>
      </property>
      <property final="false" static="false" visibility="protected" line="97" namespace="global" package="main">
        <name>$items</name>
        <default><![CDATA[0]]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="104" package="phpLDAPadmin\Export">
        <name>getServer</name>
        <full_name>getServer</full_name>
        <docblock line="99">
          <description><![CDATA[Return this LDAP Server object]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="99" name="return" description="DataStore Server" type="object">
            <type by_reference="false">object</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="113" package="phpLDAPadmin\Export">
        <name>getServerID</name>
        <full_name>getServerID</full_name>
        <docblock line="108">
          <description><![CDATA[Return the LDAP server ID]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="108" name="return" description="Server ID" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="117" package="phpLDAPadmin\Export">
        <name>accept</name>
        <full_name>accept</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="190" package="phpLDAPadmin\Export">
        <name>isCompressed</name>
        <full_name>isCompressed</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="194" package="phpLDAPadmin\Export">
        <name>getHeader</name>
        <full_name>getHeader</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="218" package="phpLDAPadmin\Export">
        <name>isSafeAscii</name>
        <full_name>isSafeAscii</full_name>
        <docblock line="212">
          <description><![CDATA[Helper method to check if the attribute value should be base 64 encoded.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="212" name="param" description="string to check." type="\The" variable="$str">
            <type by_reference="false">\The</type>
          </tag>
          <tag line="212" name="return" description="true if the string is safe ascii, false otherwise." type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="218">
          <name>$str</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="233" package="phpLDAPadmin\Export">
      <extends>\Export</extends>
      <name>ExportCSV</name>
      <full_name>\ExportCSV</full_name>
      <docblock line="227">
        <description><![CDATA[Export entries to CSV]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="227" name="package" description="phpLDAPadmin"/>
        <tag line="227" name="subpackage" description="Export"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="234" namespace="global" package="main">
        <name>$separator</name>
        <default><![CDATA[',']]></default>
      </property>
      <property final="false" static="false" visibility="private" line="235" namespace="global" package="main">
        <name>$qualifier</name>
        <default><![CDATA['"']]></default>
      </property>
      <property final="false" static="false" visibility="private" line="236" namespace="global" package="main">
        <name>$multivalue_separator</name>
        <default><![CDATA[' | ']]></default>
      </property>
      <property final="false" static="false" visibility="private" line="237" namespace="global" package="main">
        <name>$escapeCode</name>
        <default><![CDATA['"']]></default>
      </property>
      <method final="false" abstract="false" static="true" visibility="public" namespace="global" line="239" package="phpLDAPadmin\Export">
        <name>getType</name>
        <full_name>getType</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="243" package="phpLDAPadmin\Export">
        <name>export</name>
        <full_name>export</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="330" package="phpLDAPadmin\Export">
        <name>LdapEscape</name>
        <full_name>LdapEscape</full_name>
        <docblock line="326">
          <description><![CDATA[Function to escape data, where the qualifier happens to also
be in the data.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="330">
          <name>$var</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="341" package="phpLDAPadmin\Export">
      <extends>\Export</extends>
      <name>ExportDSML</name>
      <full_name>\ExportDSML</full_name>
      <docblock line="335">
        <description><![CDATA[Export entries to DSML v.1]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="335" name="package" description="phpLDAPadmin"/>
        <tag line="335" name="subpackage" description="Export"/>
      </docblock>
      <method final="false" abstract="false" static="true" visibility="public" namespace="global" line="342" package="phpLDAPadmin\Export">
        <name>getType</name>
        <full_name>getType</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="349" package="phpLDAPadmin\Export">
        <name>export</name>
        <full_name>export</full_name>
        <docblock line="346">
          <description><![CDATA[Export entries to DSML format]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="437" package="phpLDAPadmin\Export">
      <extends>\Export</extends>
      <name>ExportLDIF</name>
      <full_name>\ExportLDIF</full_name>
      <docblock line="431">
        <description><![CDATA[Export from LDAP using an LDIF format]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="431" name="package" description="phpLDAPadmin"/>
        <tag line="431" name="subpackage" description="Export"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="439" namespace="global" package="main">
        <name>$line_length</name>
        <default><![CDATA[76]]></default>
      </property>
      <method final="false" abstract="false" static="true" visibility="public" namespace="global" line="441" package="phpLDAPadmin\Export">
        <name>getType</name>
        <full_name>getType</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="448" package="phpLDAPadmin\Export">
        <name>export</name>
        <full_name>export</full_name>
        <docblock line="445">
          <description><![CDATA[Export entries to LDIF format]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="global" line="513" package="phpLDAPadmin\Export">
        <name>multiLineDisplay</name>
        <full_name>multiLineDisplay</full_name>
        <docblock line="508">
          <description><![CDATA[Helper method to wrap ldif lines]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="508" name="param" description="line to be wrapped if needed." type="\The" variable="$str">
            <type by_reference="false">\The</type>
          </tag>
        </docblock>
        <argument line="513">
          <name>$str</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
    <class final="false" abstract="false" namespace="global" line="541" package="phpLDAPadmin\Export">
      <extends>\Export</extends>
      <name>ExportVCARD</name>
      <full_name>\ExportVCARD</full_name>
      <docblock line="535">
        <description><![CDATA[Export entries to VCARD v2.1]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="535" name="package" description="phpLDAPadmin"/>
        <tag line="535" name="subpackage" description="Export"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="547" namespace="global" package="main">
        <name>$mapping</name>
        <default><![CDATA[array('cn' => 'FN', 'title' => 'TITLE', 'homephone' => 'TEL;HOME', 'mobile' => 'TEL;CELL', 'mail' => 'EMAIL;Internet', 'labeleduri' => 'URL', 'o' => 'ORG', 'audio' => 'SOUND', 'facsmiletelephoneNumber' => 'TEL;WORK;HOME;VOICE;FAX', 'jpegphoto' => 'PHOTO;ENCODING=BASE64', 'businesscategory' => 'ROLE', 'description' => 'NOTE')]]></default>
      </property>
      <property final="false" static="false" visibility="private" line="562" namespace="global" package="main">
        <name>$deliveryAddress</name>
        <default><![CDATA[array('postofficebox', 'street', 'l', 'st', 'postalcode', 'c')]]></default>
      </property>
      <method final="false" abstract="false" static="true" visibility="public" namespace="global" line="542" package="phpLDAPadmin\Export">
        <name>getType</name>
        <full_name>getType</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="573" package="phpLDAPadmin\Export">
        <name>export</name>
        <full_name>export</full_name>
        <docblock line="570">
          <description><![CDATA[Export entries to VCARD format]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
    </class>
    <parse_markers>
      <error line="23" code="50018">No DocBlock was found for property $server_id</error>
      <error line="25" code="50018">No DocBlock was found for property $template_id</error>
      <error line="26" code="50018">No DocBlock was found for property $template</error>
      <error line="28" code="50010">No DocBlock was found for method __construct()</error>
      <error line="35" code="50010">No DocBlock was found for method types()</error>
      <error line="50" code="50010">No DocBlock was found for method accept()</error>
      <error line="75" code="50010">No DocBlock was found for method getTemplate()</error>
      <error line="91" code="50018">No DocBlock was found for property $br</error>
      <error line="93" code="50018">No DocBlock was found for property $compress</error>
      <error line="95" code="50018">No DocBlock was found for property $results</error>
      <error line="96" code="50018">No DocBlock was found for property $resultsdata</error>
      <error line="97" code="50018">No DocBlock was found for property $items</error>
      <error line="117" code="50010">No DocBlock was found for method accept()</error>
      <error line="190" code="50010">No DocBlock was found for method isCompressed()</error>
      <error line="194" code="50010">No DocBlock was found for method getHeader()</error>
      <error line="234" code="50018">No DocBlock was found for property $separator</error>
      <error line="235" code="50018">No DocBlock was found for property $qualifier</error>
      <error line="236" code="50018">No DocBlock was found for property $multivalue_separator</error>
      <error line="237" code="50018">No DocBlock was found for property $escapeCode</error>
      <error line="239" code="50010">No DocBlock was found for method getType()</error>
      <error line="243" code="50010">No DocBlock was found for method export()</error>
      <error line="326" code="50015">Argument $var is missing from the Docblock of LdapEscape()</error>
      <error line="342" code="50010">No DocBlock was found for method getType()</error>
      <error line="439" code="50018">No DocBlock was found for property $line_length</error>
      <error line="441" code="50010">No DocBlock was found for method getType()</error>
      <error line="547" code="50018">No DocBlock was found for property $mapping</error>
      <error line="562" code="50018">No DocBlock was found for property $deliveryAddress</error>
      <error line="542" code="50010">No DocBlock was found for method getType()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/lib/SambaPasswordAttribute.php" hash="0735f025617457725ac03ae50ba8b460" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Classes and functions for the template engine.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="15" package="phpLDAPadmin\Templates">
      <extends>\PasswordAttribute</extends>
      <name>SambaPasswordAttribute</name>
      <full_name>\SambaPasswordAttribute</full_name>
      <docblock line="9">
        <description><![CDATA[Represents an attribute whose values are SAMBA passwords]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="9" name="package" description="phpLDAPadmin"/>
        <tag line="9" name="subpackage" description="Templates"/>
      </docblock>
    </class>
  </file>
  <file path="templates/3rdParty/pla/lib/HTMLTree.php" hash="1e6911b1ccddcbb8c316364bf770a6c4" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[Classes and functions for the LDAP tree.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <class final="false" abstract="false" namespace="global" line="16" package="phpLDAPadmin\Tree">
      <extends>\Tree</extends>
      <name>HTMLTree</name>
      <full_name>\HTMLTree</full_name>
      <docblock line="9">
        <description><![CDATA[This class implements a straight HTML tree - no AJAX rendering is used.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="9" name="package" description="phpLDAPadmin"/>
        <tag line="9" name="subpackage" description="Tree"/>
        <tag line="9" name="see" description="\global\AJAXTree" refers="\global\AJAXTree"/>
      </docblock>
      <property final="false" static="false" visibility="protected" line="17" namespace="global" package="main">
        <name>$javascript</name>
        <default><![CDATA['']]></default>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="27" package="phpLDAPadmin\Tree">
        <name>draw</name>
        <full_name>draw</full_name>
        <docblock line="22">
          <description><![CDATA[Displays the tree in HTML]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="22" name="param" description="Only display the tree, or include the server name and menu items" type="boolean" variable="$onlytree">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="27">
          <name>$onlytree</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="158" package="phpLDAPadmin\Tree">
        <name>draw_server_name</name>
        <full_name>draw_server_name</full_name>
        <docblock line="155">
          <description><![CDATA[Draw the server name]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="181" package="phpLDAPadmin\Tree">
        <name>draw_menu</name>
        <full_name>draw_menu</full_name>
        <docblock line="178">
          <description><![CDATA[Draw the tree menu options]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="207" package="phpLDAPadmin\Tree">
        <name>get_menu_item</name>
        <full_name>get_menu_item</full_name>
        <docblock line="204">
          <description><![CDATA[Get the HTML for each tree menu option]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
        <argument line="207">
          <name>$item</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="325" package="phpLDAPadmin\Tree">
        <name>get_logout_menu_item</name>
        <full_name>get_logout_menu_item</full_name>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="342" package="phpLDAPadmin\Tree">
        <name>draw_logged_in_user</name>
        <full_name>draw_logged_in_user</full_name>
        <docblock line="339">
          <description><![CDATA[Draw the Logged in User]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="401" package="phpLDAPadmin\Tree">
        <name>draw_item</name>
        <full_name>draw_item</full_name>
        <docblock line="395">
          <description><![CDATA[Recursively descend on the given dn and draw the tree in html]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="395" name="param" description="Current dn." type="\dn" variable="$dn">
            <type by_reference="false">\dn</type>
          </tag>
          <tag line="395" name="param" description="Level to start drawing (start to -1)" type="int" variable="$level">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
        <argument line="401">
          <name>$item</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="401">
          <name>$level</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="478" package="phpLDAPadmin\Tree">
        <name>get_formatted_dn</name>
        <full_name>get_formatted_dn</full_name>
        <argument line="478">
          <name>$entry</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="478">
          <name>$level</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="495" package="phpLDAPadmin\Tree">
        <name>draw_create_link</name>
        <full_name>draw_create_link</full_name>
        <docblock line="488">
          <description><![CDATA[Print the HTML to show the "create new entry here".]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="488" name="param" description="" type="\dn" variable="$rdn">
            <type by_reference="false">\dn</type>
          </tag>
          <tag line="488" name="param" description="" type="int" variable="$level">
            <type by_reference="false">int</type>
          </tag>
          <tag line="488" name="param" description="" type="\dn" variable="$encoded_dn">
            <type by_reference="false">\dn</type>
          </tag>
        </docblock>
        <argument line="495">
          <name>$rdn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="495">
          <name>$level</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="495">
          <name>$encoded_dn</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="513" package="phpLDAPadmin\Tree">
        <name>draw_login_link</name>
        <full_name>draw_login_link</full_name>
        <docblock line="510">
          <description><![CDATA[Draw login link]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="542" package="phpLDAPadmin\Tree">
        <name>draw_javascript</name>
        <full_name>draw_javascript</full_name>
        <docblock line="539">
          <description><![CDATA[If there is javascript, draw it]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="557" package="phpLDAPadmin\Tree">
        <name>getDepth</name>
        <full_name>getDepth</full_name>
        <docblock line="554">
          <description><![CDATA[Work out how deep the "opened" tree is.]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </method>
    </class>
    <parse_markers>
      <error line="17" code="50018">No DocBlock was found for property $javascript</error>
      <error line="204" code="50015">Argument $item is missing from the Docblock of get_menu_item()</error>
      <error line="325" code="50010">No DocBlock was found for method get_logout_menu_item()</error>
      <error line="395" code="50014">Name of argument $item does not match with the DocBlock's name $dn in draw_item()</error>
      <notice line="395" code="50013">Parameter $dn could not be found in draw_item()</notice>
      <error line="478" code="50010">No DocBlock was found for method get_formatted_dn()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/tools/unserialize.php" hash="ae481967b63baf14a849a4a471cb36b7" package="main">
    <include line="3" type="Require" package="main">
      <name>../lib/common.php</name>
    </include>
    <parse_markers>
      <error line="0" code="50007">No page-level DocBlock was found in file templates/3rdParty/pla/tools/unserialize.php</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/config/config.php" hash="8de431d8d6880ec3444e2e2926e0881f" package="main">
    <parse_markers>
      <error line="0" code="50007">No page-level DocBlock was found in file templates/3rdParty/pla/config/config.php</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/htdocs/update.php" hash="357db7a91bf4592910602eacefbc307c" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[Updates or deletes a value from a specified attribute for a specified dn.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
      <tag line="2" name="see" description="\update_confirm.php" refers="\update_confirm.php"/>
    </docblock>
    <include line="13" type="Require" package="main">
      <name>./common.php</name>
      <docblock line="10">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/3rdParty/pla/htdocs/query_engine.php" hash="0047d74c76b1f5cc7bc9d7e44aa40c18" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[Query render engine.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
    </docblock>
    <include line="13" type="Require" package="main">
      <name>./common.php</name>
      <docblock line="10">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="14" type="Require" package="main">
      <name/>
    </include>
  </file>
  <file path="templates/3rdParty/pla/htdocs/modify_member_form.php" hash="c63bbd31d1022a4ae5181c5dbb4fd9e5" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[Displays a form to allow the user to modify group members.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
    </docblock>
    <include line="12" type="Require" package="main">
      <name>./common.php</name>
      <docblock line="9">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/3rdParty/pla/htdocs/compare.php" hash="35f1f1001df5fb5b4db110dcf6c1095d" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[Compares two DN entries side by side.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
    </docblock>
    <include line="12" type="Require" package="main">
      <name>./common.php</name>
      <docblock line="9">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/3rdParty/pla/htdocs/add_value_form.php" hash="b9f406d331905ad0e6eb72aeb9e8e28f" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[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><![CDATA[]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
    </docblock>
    <include line="13" type="Require" package="main">
      <name>./common.php</name>
      <docblock line="10">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/3rdParty/pla/htdocs/compare_form.php" hash="c7405f87250793cac8ba1cff6dcab78a" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[Compares two DN entries side by side.]]></description>
      <long-description><![CDATA[<p>This is the entry form to determine which DN to compare this DN with.</p>]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
    </docblock>
    <include line="13" type="Require" package="main">
      <name>./common.php</name>
      <docblock line="10">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/3rdParty/pla/htdocs/password_checker.php" hash="5fbabeda6f79189c68a5af000006810d" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[Check the password used by an entry.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
    </docblock>
    <include line="12" type="Require" package="main">
      <name>./common.php</name>
      <docblock line="9">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/3rdParty/pla/htdocs/add_oclass_form.php" hash="96bac18dd103565fac566d5b7a7fbb41" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[This page will allow the adding of additional ObjectClasses to an item.]]></description>
      <long-description><![CDATA[<ul>
<li>If the ObjectClass to be added requires additional MUST attributes to be
defined, then they will be prompted for.</li>
<li>If the ObjectClass doesnt need any additional MUST attributes, then it
will be silently added to the object.</li>
</ul>]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
    </docblock>
    <include line="16" type="Require" package="main">
      <name>./common.php</name>
      <docblock line="13">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/3rdParty/pla/htdocs/mass_update.php" hash="c25e3b20b5b71edfe7596ae398f63f4d" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[Main command page for phpLDAPadmin
This script will handle bulk updates.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
    </docblock>
    <include line="13" type="Require Once" package="main">
      <name>./common.php</name>
      <docblock line="10">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/3rdParty/pla/htdocs/template_engine.php" hash="bf60566a1f495dda47012f15ca0701d8" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[Template render engine.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
      <tag line="2" name="author" description="The phpLDAPadmin development team"/>
    </docblock>
    <include line="36" type="Require" package="main">
      <name>./common.php</name>
      <docblock line="10">
        <description><![CDATA[The template engine has the following responsibilities:
If we are passed a DN, then we are editing an existing entry
If we are not passed a DN, then we are passed a container (and creating a new entry in that container)]]></description>
        <long-description><![CDATA[<p>In both cases, we are optionally passed a template ID.
If we have a template ID, then we'll render the creation/editing using that template
If we are not passed a template ID, then we'll either:
Present a list of available templates,
Present the default template, because there are non available (due to hidden,regexp or non-existant)
Present the only template, if there is only one.</p>

<p>Creating and editing entries use two objects:
A template object which describes how the template should be rendered (and what values should asked for, etc)
A page object, which is responsible for actually sending out the HTML to the browser.</p>

<p>So:
we init a new TemplateRender object
we init a new Template object
set the DN or container on the template object
If setting the DN, this in turn should read the "old values" from the LDAP server
If we are not on the first page (ie: 2nd, 3rd, 4th step, etc), we should accept the post values that we have obtained thus far</p>

<p>Finally submit the update to "update_confirm", or the create to "create", when complete.</p>]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/3rdParty/pla/htdocs/update_confirm.php" hash="425a7034b99d3d9468a5128cf2207b2f" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[Takes the results of clicking "Save" in template_engine.php and determines
which attributes need to be updated (ie, which ones actually changed).]]></description>
      <long-description><![CDATA[<p>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.</p>]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
      <tag line="2" name="see" description="\update.php" refers="\update.php"/>
    </docblock>
    <include line="17" type="Require" package="main">
      <name>./common.php</name>
      <docblock line="14">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <function namespace="global" line="220" package="phpLDAPadmin\Page">
      <name>getMustAttrs</name>
      <full_name>\getMustAttrs</full_name>
      <argument line="220">
        <name>$oclasses</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <parse_markers>
      <error line="220" code="50009">No DocBlock was found for function \getMustAttrs()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/htdocs/create.php" hash="3f09fab8fd29af156e8b54cbc61693ba" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[Creates a new object in LDAP.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
    </docblock>
    <include line="12" type="Require" package="main">
      <name>./common.php</name>
      <docblock line="9">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/3rdParty/pla/htdocs/copy_form.php" hash="516e024aa7bba639915f5f34eab459cf" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[Copies a given object to create a new one.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
    </docblock>
    <include line="12" type="Require" package="main">
      <name>./common.php</name>
      <docblock line="9">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/3rdParty/pla/htdocs/delete_attr.php" hash="2659d8763ae91d4a7768f086974495b6" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[Deletes an attribute from an entry with NO confirmation.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
    </docblock>
    <include line="12" type="Require" package="main">
      <name>./common.php</name>
      <docblock line="9">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/3rdParty/pla/htdocs/refresh.php" hash="1c9d63ae488928bd537bef8eeb3d5658" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[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><![CDATA[]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
    </docblock>
    <include line="13" type="Require" package="main">
      <name>./common.php</name>
      <docblock line="10">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/3rdParty/pla/htdocs/download_binary_attr.php" hash="3f8fe2d183c5629088a4b4d7ba864a89" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[Download a binary value attribute to the user.]]></description>
      <long-description><![CDATA[<p>A server ID, DN and Attribute must be provided in the GET attributes.
Optionally an index, type and filename can be supplied.</p>]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
    </docblock>
    <include line="14" type="Require" package="main">
      <name>./common.php</name>
      <docblock line="11">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/3rdParty/pla/htdocs/view_jpeg_photo.php" hash="e7f0ae84ef4f9cb2a2776cb2a7b9e14d" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[This script will display the contents of the jpegPhoto attribute to the browser.]]></description>
      <long-description><![CDATA[<p>A server ID and DN must be provided in the GET attributes.
Optionally an attr name, index, type and filename can be supplied.</p>]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
    </docblock>
    <include line="14" type="Require" package="main">
      <name>./common.php</name>
      <docblock line="11">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/3rdParty/pla/htdocs/import.php" hash="4716a8729a9585fe33dbff9095e50606" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[Imports an LDIF file to the specified LDAP server.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
    </docblock>
    <include line="12" type="Require" package="main">
      <name>./common.php</name>
      <docblock line="9">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="13" type="Require" package="main">
      <name/>
    </include>
    <function namespace="global" line="90" package="phpLDAPadmin\Page">
      <name>display_pla_parse_error</name>
      <full_name>\display_pla_parse_error</full_name>
      <argument line="90">
        <name>$request</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <parse_markers>
      <error line="90" code="50009">No DocBlock was found for function \display_pla_parse_error()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/htdocs/copy.php" hash="130482c0be9dfe78168edec0a8eedee7" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[Copies a given object to create a new one.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
    </docblock>
    <include line="12" type="Require" package="main">
      <name>./common.php</name>
      <docblock line="9">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <function namespace="global" line="114" package="phpLDAPadmin\Page">
      <name>r_copy_dn</name>
      <full_name>\r_copy_dn</full_name>
      <argument line="114">
        <name>$serverSRC</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="114">
        <name>$serverDST</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="114">
        <name>$snapshottree</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="114">
        <name>$dnSRC</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="114">
        <name>$dnDST</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="114">
        <name>$remove</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="161" package="phpLDAPadmin\Page">
      <name>copy_dn</name>
      <full_name>\copy_dn</full_name>
      <argument line="161">
        <name>$serverSRC</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="161">
        <name>$serverDST</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="161">
        <name>$dnSRC</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="161">
        <name>$dnDST</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="161">
        <name>$remove</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <function namespace="global" line="185" package="phpLDAPadmin\Page">
      <name>build_tree</name>
      <full_name>\build_tree</full_name>
      <argument line="185">
        <name>$server</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="185">
        <name>$dn</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="185">
        <name>$buildtree</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <parse_markers>
      <error line="114" code="50009">No DocBlock was found for function \r_copy_dn()</error>
      <error line="161" code="50009">No DocBlock was found for function \copy_dn()</error>
      <error line="185" code="50009">No DocBlock was found for function \build_tree()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/htdocs/add_attr_form.php" hash="85f1a2e7247d0389dbf7c22f085cdd4f" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[Displays a form for adding an attribute/value to an LDAP entry.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
    </docblock>
    <include line="12" type="Require" package="main">
      <name>./common.php</name>
      <docblock line="9">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/3rdParty/pla/htdocs/delete_form.php" hash="a75b795da1ceeb0c4477bfa8bdf6a97e" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[Displays a last chance confirmation form to delete a DN.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
    </docblock>
    <include line="12" type="Require" package="main">
      <name>./common.php</name>
      <docblock line="9">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/3rdParty/pla/htdocs/index.php" hash="db1c0be01c73858ab1ee8971d215ad29" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[phpLDAPadmin Start Page]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
    </docblock>
    <include line="52" type="Require" package="main">
      <name/>
    </include>
    <include line="98" type="Require" package="main">
      <name/>
    </include>
    <include line="146" type="Include" package="main">
      <name>./cmd.php</name>
    </include>
    <constant namespace="global" line="27" package="phpLDAPadmin\Page">
      <name>APPCONFIG</name>
      <full_name>\APPCONFIG</full_name>
      <value><![CDATA['plaConfig']]></value>
      <docblock line="21">
        <description><![CDATA[We will perform some sanity checking here, since this file is normally loaded first when users
first access the application.]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </constant>
    <constant namespace="global" line="29" package="phpLDAPadmin\Page">
      <name>LIBDIR</name>
      <full_name>\LIBDIR</full_name>
      <value><![CDATA[sprintf('%s/', realpath('../lib/'))]]></value>
    </constant>
  </file>
  <file path="templates/3rdParty/pla/htdocs/rename_form.php" hash="6609319f4854ddcc59e9f08a5faf30f4" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[Displays a form for renaming an LDAP entry.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
    </docblock>
    <include line="12" type="Require" package="main">
      <name>./common.php</name>
      <docblock line="9">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/3rdParty/pla/htdocs/import_form.php" hash="7f75b714f9df8487a2c3c5e093f4ea7e" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[Displays a form to allow the user to upload and import
an LDIF file.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
    </docblock>
    <include line="13" type="Require" package="main">
      <name>./common.php</name>
      <docblock line="10">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/3rdParty/pla/htdocs/mass_edit.php" hash="e804b28833604ad9dc9de48f5a4f60a1" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[Main command page for phpLDAPadmin
Enable mass editing of Attribute values from a list of DNs.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
    </docblock>
    <include line="13" type="Require Once" package="main">
      <name>./common.php</name>
      <docblock line="10">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/3rdParty/pla/htdocs/collapse.php" hash="6d89804b3af8427c333c8799999a22a5" package="phpLDAPadmin\Tree">
    <docblock line="2">
      <description><![CDATA[This script alters the session variable 'tree', collapsing it
at the dn specified in the query string.]]></description>
      <long-description><![CDATA[<p>Note: this script is equal and opposite to expand.php</p>]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Tree"/>
      <tag line="2" name="see" description="\expand.php" refers="\expand.php"/>
    </docblock>
    <include line="16" type="Require" package="main">
      <name>./common.php</name>
      <docblock line="13">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/3rdParty/pla/htdocs/expand.php" hash="4e10c86f6e650a6ee2aab334982d44d5" package="phpLDAPadmin\Tree">
    <docblock line="2">
      <description><![CDATA[This script alters the session variable 'tree', expanding it
at the dn specified in the query string.]]></description>
      <long-description><![CDATA[<p>Note: this script is equal and opposite to collapse.php</p>]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Tree"/>
      <tag line="2" name="see" description="\collapse.php" refers="\collapse.php"/>
    </docblock>
    <include line="16" type="Require" package="main">
      <name>./common.php</name>
      <docblock line="13">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/3rdParty/pla/htdocs/draw_tree_node.php" hash="731378883d18512a580a000efd9a5c8c" package="phpLDAPadmin\Tree">
    <docblock line="2">
      <description><![CDATA[Draw a portion of the LDAP tree.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Tree"/>
    </docblock>
  </file>
  <file path="templates/3rdParty/pla/htdocs/delete.php" hash="05527288c70ada0385d3fcb3bf8c9e3b" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[Deletes a DN and presents a "job's done" message.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
    </docblock>
    <include line="12" type="Require" package="main">
      <name>./common.php</name>
      <docblock line="9">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/3rdParty/pla/htdocs/create_confirm.php" hash="b639676d0255d5ce5bd895bd3d9fb846" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[Creates a new object in LDAP.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
    </docblock>
    <include line="12" type="Require" package="main">
      <name>./common.php</name>
      <docblock line="9">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/3rdParty/pla/htdocs/export.php" hash="2e08bd9cd5e680d9c92ba5c330208c2e" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[Performs the export of data from the LDAP server]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
    </docblock>
    <include line="12" type="Require" package="main">
      <name>./common.php</name>
      <docblock line="9">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="13" type="Require" package="main">
      <name/>
    </include>
  </file>
  <file path="templates/3rdParty/pla/htdocs/rename.php" hash="d3e90d686fb6716df4d2d2004a9f7536" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[Renames a DN to a different name.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
    </docblock>
    <include line="12" type="Require" package="main">
      <name>./common.php</name>
      <docblock line="9">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/3rdParty/pla/htdocs/rdelete.php" hash="2aee61706df461e3c27efdeae4ab10d8" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[Recursively deletes the specified DN and all of its children]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
    </docblock>
    <include line="12" type="Require" package="main">
      <name>./common.php</name>
      <docblock line="9">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <function namespace="global" line="53" package="phpLDAPadmin\Page">
      <name>pla_rdelete</name>
      <full_name>\pla_rdelete</full_name>
      <argument line="53">
        <name>$server</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="53">
        <name>$dn</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <parse_markers>
      <error line="53" code="50009">No DocBlock was found for function \pla_rdelete()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/htdocs/mass_delete.php" hash="57f282c0c701ce9319c478384195c866" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[Displays a last chance confirmation form to delete a DN.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
    </docblock>
    <include line="12" type="Require" package="main">
      <name>./common.php</name>
      <docblock line="9">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/3rdParty/pla/htdocs/common.php" hash="140600bee54b9752789280da6a0d75d2" package="phpLDAPadmin">
    <docblock line="2">
      <description><![CDATA[This script provides a convienent method to call the proper common.php]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
    </docblock>
    <include line="13" type="Require Once" package="main">
      <name/>
    </include>
    <constant namespace="global" line="12" package="phpLDAPadmin">
      <name>LIBDIR</name>
      <full_name>\LIBDIR</full_name>
      <value><![CDATA[sprintf('%s/', realpath('../lib/'))]]></value>
    </constant>
  </file>
  <file path="templates/3rdParty/pla/htdocs/entry_chooser.php" hash="8b439c4f474240599cd1d4727418d8e7" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[Display a selection (popup window) to pick a DN.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
    </docblock>
    <include line="12" type="Include" package="main">
      <name>./common.php</name>
      <docblock line="9">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/3rdParty/pla/htdocs/export_form.php" hash="95eb226630f0d6d909ad4356be9a1750" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[Export entries from the LDAP server.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
    </docblock>
    <include line="12" type="Require" package="main">
      <name>./common.php</name>
      <docblock line="9">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="13" type="Require" package="main">
      <name/>
    </include>
    <function namespace="global" line="147" package="phpLDAPadmin\Page">
      <name>get_line_end_format</name>
      <full_name>\get_line_end_format</full_name>
      <docblock line="142">
        <description><![CDATA[Helper function for fetching the line end format.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="142" name="return" description="'win', 'unix', or 'mac' based on the user's browser.." type="String">
          <type by_reference="false">String</type>
        </tag>
      </docblock>
    </function>
    <function namespace="global" line="164" package="phpLDAPadmin\Page">
      <name>get_user_agent_string</name>
      <full_name>\get_user_agent_string</full_name>
      <docblock line="158">
        <description><![CDATA[Gets the USER_AGENT string from the $_SERVER array, all in lower case in
an E_NOTICE safe manner.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="158" name="return" description="The user agent string as reported by the browser." type="string|false">
          <type by_reference="false">string</type>
          <type by_reference="false">false</type>
        </tag>
      </docblock>
    </function>
    <function namespace="global" line="174" package="phpLDAPadmin\Page">
      <name>is_browser</name>
      <full_name>\is_browser</full_name>
      <docblock line="171">
        <description><![CDATA[Determine the OS for the browser]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
      <argument line="174">
        <name>$type</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
    <parse_markers>
      <error line="171" code="50015">Argument $type is missing from the Docblock of \is_browser()</error>
    </parse_markers>
  </file>
  <file path="templates/3rdParty/pla/htdocs/cmd.php" hash="c772b7766aff5ae15917d6cf86905260" package="phpLDAPadmin\Page">
    <docblock line="2">
      <description><![CDATA[Main command page for phpLDAPadmin
All pages are rendered through this script.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="2" name="package" description="phpLDAPadmin"/>
      <tag line="2" name="subpackage" description="Page"/>
    </docblock>
    <include line="13" type="Require Once" package="main">
      <name>./common.php</name>
      <docblock line="10">
        <description><![CDATA[]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="56" type="Include" package="main">
      <name/>
    </include>
  </file>
  <file path="templates/3rdParty/pla/index.php" hash="fe7bf1aae970c994bd71a162020f3761" package="phpLDAPadmin">
    <docblock line="4">
      <description><![CDATA[]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="4" name="package" description="phpLDAPadmin"/>
    </docblock>
    <parse_markers>
      <critical line="4" code="50008">No short description for file templates/3rdParty/pla/index.php</critical>
    </parse_markers>
  </file>
  <file path="templates/logout.php" hash="d8e24f95164494e4cc880f9fc511544a" package="main">
    <docblock line="24">
      <description><![CDATA[User is logged off from LDAP server, session is destroyed.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="package" description="main"/>
      <tag line="24" name="author" description="Roland Gruber"/>
    </docblock>
    <include line="39" type="Include Once" package="main">
      <name>../lib/security.inc</name>
      <docblock line="38">
        <description><![CDATA[security functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="41" type="Include Once" package="main">
      <name>../lib/status.inc</name>
      <docblock line="40">
        <description><![CDATA[Used to display status messages]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="43" type="Include Once" package="main">
      <name>../lib/ldap.inc</name>
      <docblock line="42">
        <description><![CDATA[LDAP settings are deleted at logout]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
  </file>
  <file path="templates/initsuff.php" hash="177999e54375ea8fa5b2f0b9d7c64223" package="main">
    <docblock line="24">
      <description><![CDATA[Creates main suffixes if they are missing.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="author" description="Roland Gruber"/>
      <tag line="24" name="package" description="main"/>
    </docblock>
    <include line="32" type="Include Once" package="main">
      <name>../lib/security.inc</name>
      <docblock line="31">
        <description><![CDATA[security functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="34" type="Include Once" package="main">
      <name>../lib/config.inc</name>
      <docblock line="33">
        <description><![CDATA[access to configuration settings]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="36" type="Include Once" package="main">
      <name>../lib/ldap.inc</name>
      <docblock line="35">
        <description><![CDATA[LDAP access]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="38" type="Include Once" package="main">
      <name>../lib/status.inc</name>
      <docblock line="37">
        <description><![CDATA[status messages]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="146" type="Include" package="main">
      <name>main_header.php</name>
    </include>
    <include line="154" type="Include" package="main">
      <name>main_footer.php</name>
    </include>
    <include line="159" type="Include" package="main">
      <name>main_footer.php</name>
    </include>
    <include line="165" type="Include" package="main">
      <name>main_footer.php</name>
    </include>
    <include line="176" type="Include" package="main">
      <name>main_header.php</name>
    </include>
    <include line="200" type="Include" package="main">
      <name>main_footer.php</name>
    </include>
  </file>
  <file path="templates/massBuildAccounts.php" hash="50f685f95393d6776bb4b9adc98a2477" package="tools">
    <docblock line="24">
      <description><![CDATA[Creates the accounts by parsing the uploaded file.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="24" name="author" description="Roland Gruber"/>
      <tag line="24" name="package" description="tools"/>
    </docblock>
    <include line="32" type="Include Once" package="main">
      <name>../lib/security.inc</name>
      <docblock line="31">
        <description><![CDATA[security functions]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="34" type="Include Once" package="main">
      <name>../lib/config.inc</name>
      <docblock line="33">
        <description><![CDATA[access to configuration]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="36" type="Include Once" package="main">
      <name>../lib/status.inc</name>
      <docblock line="35">
        <description><![CDATA[status messages]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="38" type="Include Once" package="main">
      <name>../lib/modules.inc</name>
      <docblock line="37">
        <description><![CDATA[account modules]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="92" type="Include" package="main">
      <name>main_header.php</name>
    </include>
    <include line="266" type="Include" package="main">
      <name>main_footer.php</name>
    </include>
    <function namespace="global" line="275" package="tools">
      <name>massPrintBackButton</name>
      <full_name>\massPrintBackButton</full_name>
      <docblock line="268">
        <description><![CDATA[Prints a back button to the page where the user enters a file to upload.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="268" name="param" description="account type (e.g. user)" type="String" variable="$scope">
          <type by_reference="false">String</type>
        </tag>
        <tag line="268" name="param" description="selected modules for upload" type="array" variable="$selectedModules">
          <type by_reference="false">array</type>
        </tag>
        <tag line="268" name="param" description="table container" type="\htmlTable" variable="$container">
          <type by_reference="false">\htmlTable</type>
        </tag>
      </docblock>
      <argument line="275">
        <name>$scope</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="275">
        <name>$selectedModules</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="275">
        <name>$container</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
  </file>
  <file path="templates/help.php" hash="74725a1cbb0d25028e4ea462a10ceb4a" package="Help">
    <docblock line="27">
      <description><![CDATA[LDAP Account Manager help page.]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="27" name="author" description="Michael Duergner"/>
      <tag line="27" name="author" description="Roland Gruber"/>
      <tag line="27" name="package" description="Help"/>
    </docblock>
    <include line="36" type="Include Once" package="main">
      <name>../lib/ldap.inc</name>
      <docblock line="35">
        <description><![CDATA[LDAP connection]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="39" type="Include Once" package="main">
      <name>../lib/config.inc</name>
      <docblock line="38">
        <description><![CDATA[configuration]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="47" type="Include Once" package="main">
      <name>../lib/status.inc</name>
      <docblock line="46">
        <description><![CDATA[status messages]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="52" type="Include Once" package="main">
      <name>../help/help.inc</name>
      <docblock line="51">
        <description><![CDATA[help data]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </include>
    <include line="112" type="Include Once" package="main">
      <name>../lib/modules.inc</name>
    </include>
    <function namespace="global" line="58" package="Help">
      <name>echoHTMLHead</name>
      <full_name>\echoHTMLHead</full_name>
      <docblock line="55">
        <description><![CDATA[Print HTML header of the help page.]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </function>
    <function namespace="global" line="71" package="Help">
      <name>echoHTMLFoot</name>
      <full_name>\echoHTMLFoot</full_name>
      <docblock line="68">
        <description><![CDATA[Print HTML footer of the help page.]]></description>
        <long-description><![CDATA[]]></long-description>
      </docblock>
    </function>
    <function namespace="global" line="84" package="Help">
      <name>displayHelp</name>
      <full_name>\displayHelp</full_name>
      <docblock line="78">
        <description><![CDATA[Print help site for a specific help number.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="78" name="param" description="The help entry that is to be displayed." type="array" variable="$helpEntry">
          <type by_reference="false">array</type>
        </tag>
        <tag line="78" name="param" description="The help variables that are used to replace the spacer in the help text." type="array" variable="$helpVariables">
          <type by_reference="false">array</type>
        </tag>
      </docblock>
      <argument line="84">
        <name>$helpEntry</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
      <argument line="84">
        <name>$helpVariables</name>
        <default><![CDATA[]]></default>
        <type/>
      </argument>
    </function>
  </file>
  <package name="Crypt" full_name="Crypt">
    <package name="AES" full_name="Crypt\AES"/>
    <package name="DES" full_name="Crypt\DES"/>
    <package name="Hash" full_name="Crypt\Hash"/>
    <package name="RC4" full_name="Crypt\RC4"/>
    <package name="RSA" full_name="Crypt\RSA"/>
    <package name="Random" full_name="Crypt\Random"/>
    <package name="Rijndael" full_name="Crypt\Rijndael"/>
    <package name="TerraDES" full_name="Crypt\TerraDES"/>
    <package name="TripleDES" full_name="Crypt\TripleDES"/>
  </package>
  <package name="Help" full_name="Help"/>
  <package name="LDAP" full_name="LDAP"/>
  <package name="Math" full_name="Math">
    <package name="BigInteger" full_name="Math\BigInteger"/>
  </package>
  <package name="Net" full_name="Net">
    <package name="SFTP" full_name="Net\SFTP"/>
    <package name="SSH1" full_name="Net\SSH1"/>
    <package name="SSH2" full_name="Net\SSH2"/>
  </package>
  <package name="PDF" full_name="PDF"/>
  <package name="PHP" full_name="PHP">
    <package name="Compat" full_name="PHP\Compat"/>
  </package>
  <package name="configuration" full_name="configuration"/>
  <package name="horde" full_name="horde">
    <package name="cipher" full_name="horde\cipher"/>
  </package>
  <package name="lam" full_name="lam"/>
  <package name="lib" full_name="lib"/>
  <package name="lists" full_name="lists">
    <package name="tree" full_name="lists\tree"/>
  </package>
  <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="Session" full_name="phpLDAPadmin\Session"/>
    <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"/>
  <marker count="15">todo</marker>
  <marker count="0">fixme</marker>
  <deprecated count="0"/>
</project>
