lists

# Element index for package lists

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ i ] [ l ] [ m ] [ n ] [ p ] [ r ] [ s ] [ t ] [ u ] [ _ ]

## _

__construct
  in file lists.inc, method lamSelectListOption::__construct()
  Creates a new selection list option.
__construct
  in file mailAlias.inc, method lamMailAliasList::__construct()
  Constructor
__construct
  in file smbDomain.inc, method lamSmbDomainList::__construct()
  Constructor
__construct
  in file user.inc, method lamUserList::__construct()
  Constructor
__construct
  in file lists.inc, method lamListTool::__construct()
  Constructor
__construct
  in file lists.inc, method lamListOption::__construct()
  Creates a new config option.
__construct
  in file host.inc, method lamHostList::__construct()
  Constructor
__construct
  in file lists.inc, method lamBooleanListOption::__construct()
  Creates a new boolean option.
__construct
  in file lists.inc, method lamList::__construct()
  Constructor
__construct
  in file group.inc, method lamGroupList::__construct()
  Constructor

top

## a

$attrArray
  in file lists.inc, variable lamList::$attrArray
  list of LDAP attributes
arrayLower
  in file tree.inc, function arrayLower()
array_stripslashes
  in file tree.inc, function array_stripslashes()
  Strips all slashes from the specified array in place (pass by ref).
add_attr.php
  procedural page add_attr.php
add_attr_form.php
  procedural page add_attr_form.php
add_oclass.php
  procedural page add_oclass.php
add_oclass_form.php
  procedural page add_oclass_form.php
add_value.php
  procedural page add_value.php
add_value_form.php
  procedural page add_value_form.php

top

## b

build_initial_tree_icons
  in file tree.inc, function build_initial_tree_icons()
  Builds the initial array that stores the icon-lookup for each server's DN in the tree browser. The returned

top

## c

cmp_array
  in file lists.inc, method lamList::cmp_array()
  Compare function used for usort-method
collapse.php
  procedural page collapse.php
create.php
  procedural page create.php
create_form.php
  procedural page create_form.php
creation_template.php
  procedural page creation_template.php
custom.php
  procedural page custom.php

top

## d

$descArray
  in file lists.inc, variable lamList::$descArray
  list of attribute descriptions
deletelink.php
  procedural page deletelink.php
dn_exists
  in file tree.inc, function dn_exists()
  Gets whether an entry exists based on its DN. If the entry exists, returns true. Otherwise returns false.
draw_create_link
  in file tree.php, function draw_create_link()
draw_formatted_dn
  in file tree.inc, function draw_formatted_dn()
  Gets a DN string using the user-configured tree_display_format string to format it.
draw_jpeg_photos
  in file tree.inc, function draw_jpeg_photos()
  Draw the jpegPhoto image(s) for an entry wrapped in HTML. Many options are available to specify how the images are to be displayed.
draw_server_tree
  in file tree.inc, function draw_server_tree()
  Prints the HTML of the tree view.
draw_tree_html
  in file tree.php, function draw_tree_html()
  Recursively descend on the given dn and draw the tree in html
delete.php
  procedural page delete.php
delete_attr.php
  procedural page delete_attr.php
delete_form.php
  procedural page delete_form.php
download_binary_attr.php
  procedural page download_binary_attr.php

top

## e

$entries
  in file lists.inc, variable lamList::$entries
  LDAP entries
edit.php
  procedural page edit.php
expand.php
  procedural page expand.php
export.php
  procedural page export.php
export_form.php
  procedural page export_form.php

top

## f

$filterText
  in file lists.inc, variable lamList::$filterText
  filter string to include in URL
fillFromPostData
  in file lists.inc, method lamSelectListOption::fillFromPostData()
  Fills the config option from POST data.
fillFromPostData
  in file lists.inc, method lamListOption::fillFromPostData()
  Fills the config option from POST data.
fillFromPostData
  in file lists.inc, method lamBooleanListOption::fillFromPostData()
  Fills the config option from POST data.

top

## g

getAdditionalTools
  in file user.inc, method lamUserList::getAdditionalTools()
  Returns a list of lamListTool objects to display next to the edit/delete buttons.
getAdditionalTools
  in file lists.inc, method lamList::getAdditionalTools()
  Returns a list of lamListTool objects to display next to the edit/delete buttons.
getID
  in file lists.inc, method lamListOption::getID()
  Returns the option ID.
getImage
  in file lists.inc, method lamListTool::getImage()
  Returns the name of the tool image.
getLinkTarget
  in file lists.inc, method lamListTool::getLinkTarget()
  Returns the PHP file (relative to 'templates/lists') which will be the target for this tool.
getMetaHTML
  in file lists.inc, method lamListOption::getMetaHTML()
  Returns the meta HTML data to display this option.
getMetaHTML
  in file lists.inc, method lamSelectListOption::getMetaHTML()
  Returns the meta HTML data to display this option.
getMetaHTML
  in file lists.inc, method lamBooleanListOption::getMetaHTML()
  Returns the meta HTML data to display this option.
getName
  in file lists.inc, method lamListTool::getName()
  Returns the tool name.
getValue
  in file lists.inc, method lamListOption::getValue()
  Returns the option value. The value must not contain "=" and ";".
groupRefreshPrimary
  in file group.inc, method lamGroupList::groupRefreshPrimary()
  Refreshes the primary group members list.
get_attr_select_html
  in file custom.php, function get_attr_select_html()
  Returns option values.
get_binary_attr_select_html
  in file custom.php, function get_binary_attr_select_html()
  Returns option values.
get_container
  in file tree.inc, function get_container()
  Given a DN string, this returns the parent container portion of the string.
get_container_contents
  in file tree.inc, function get_container_contents()
  Gets a list of child entries for an entry. Given a DN, this function fetches the list of DNs of child entries one level beneath the parent. For example, for the following tree:
get_enc_type
  in file tree.inc, function get_enc_type()
get_entry_system_attrs
  in file tree.inc, function get_entry_system_attrs()
  Gets the operational attributes for an entry. Given a DN, this function fetches that entry's
get_icon
  in file tree.inc, function get_icon()
  Given a DN and server ID, this function reads the DN's objectClasses and
get_line_end_format
  in file export_form.php, function get_line_end_format()
  Helper functoin for fetching the line end format.
get_object_attr
  in file tree.inc, function get_object_attr()
  Much like get_object_attrs(), but only returns the values for one attribute of an object. Example calls:
get_object_attrs
  in file tree.inc, function get_object_attrs()
  Gets the attributes/values of an entry. Returns an associative array whose
get_rdn
  in file tree.inc, function get_rdn()
  Given a DN string, this returns the 'RDN' portion of the string.

top

## i

isSelected
  in file lists.inc, method lamBooleanListOption::isSelected()
  Returns if this option is selected.
initialize_session_tree
  in file tree.inc, function initialize_session_tree()
  Checks and fixes an initial session's tree cache if needed.
is_attr_binary
  in file tree.inc, function is_attr_binary()
  Given an attribute name and server ID number, this function returns whether the attrbiute may contain binary data. This is useful for developers who wish to display the contents of an arbitrary attribute but don't want to dump binary data on the page.
is_attr_boolean
  in file tree.inc, function is_attr_boolean()
  Given an attribute name and server ID number, this function returns whether the attrbiute contains boolean data. This is useful for developers who wish to display the contents of a boolean attribute with a drop-down.
is_binary_option_required
  in file add_attr.php, function is_binary_option_required()
is_dn_attr
  in file tree.inc, function is_dn_attr()
  Returns true if the attribute specified is required to take as input a DN.
is_jpeg_photo
  in file tree.inc, function is_jpeg_photo()
  Used to determine if the specified attribute is indeed a jpegPhoto. If the specified attribute is one that houses jpeg data, true is returned. Otherwise this function returns false.
is_mail_string
  in file tree.inc, function is_mail_string()
  Get whether a string looks like an email address (user@example.com).
is_multi_line_attr
  in file tree.inc, function is_multi_line_attr()
  Determines if an attribute's value can contain multiple lines. Attributes that fall in this multi-line category may be configured in config.php. Hence, this function accesses the global variable $multi_line_attributes;
is_url_string
  in file tree.inc, function is_url_string()
  Get whether a string looks like a web URL (http://www.example.com/)

top

## l

$labels
  in file lists.inc, variable lamList::$labels
  list of account specific labels
lamBooleanListOption
  in file lists.inc, class lamBooleanListOption
  Boolean option for list configuration.
lamGroupList
  in file group.inc, class lamGroupList
  Generates the list view.
lamHostList
  in file host.inc, class lamHostList
  Generates the list view.
lamList
  in file lists.inc, class lamList
  Generates the list view.
lamListOption
  in file lists.inc, class lamListOption
  Represents a list configuration option.
lamListTool
  in file lists.inc, class lamListTool
  Represents a tool which can be included in the account lists.
lamMailAliasList
  in file mailAlias.inc, class lamMailAliasList
  Generates the list view.
lamSelectListOption
  in file lists.inc, class lamSelectListOption
  Boolean option for list configuration.
lamSmbDomainList
  in file smbDomain.inc, class lamSmbDomainList
  Generates the list view.
lamUserList
  in file user.inc, class lamUserList
  Generates the list view.
lists.inc
  procedural page lists.inc
listBuildFilter
  in file lists.inc, method lamList::listBuildFilter()
  Builds the regular expressions from the filter values.
listConfigurationChanged
  in file lists.inc, method lamList::listConfigurationChanged()
  Called when the configuration options changed.
listConfigurationChanged
  in file group.inc, method lamGroupList::listConfigurationChanged()
  Called when the configuration options changed.
listConfigurationChanged
  in file user.inc, method lamUserList::listConfigurationChanged()
  Called when the configuration options changed.
listDoPost
  in file lists.inc, method lamList::listDoPost()
  Manages all POST actions (e.g. button pressed) for the account lists.
listDrawNavigationBar
  in file lists.inc, method lamList::listDrawNavigationBar()
  Draws a navigation bar to switch between pages
listFilterAccounts
  in file lists.inc, method lamList::listFilterAccounts()
  Removes all entries which do not fit to the filter.
listGetAllConfigOptions
  in file user.inc, method lamUserList::listGetAllConfigOptions()
  Returns a list of possible configuration options.
listGetAllConfigOptions
  in file lists.inc, method lamList::listGetAllConfigOptions()
  Returns a list of possible configuration options.
listGetAllConfigOptions
  in file group.inc, method lamGroupList::listGetAllConfigOptions()
  Returns a list of possible configuration options.
listGetConfigOptionByID
  in file lists.inc, method lamList::listGetConfigOptionByID()
  Returns the configuration option with the given ID.
listGetParams
  in file lists.inc, method lamList::listGetParams()
  Sets some internal parameters.
listGetParams
  in file user.inc, method lamUserList::listGetParams()
  Sets some internal parameters.
listGetParams
  in file group.inc, method lamGroupList::listGetParams()
  Sets some internal parameters.
listPrintButtons
  in file lists.inc, method lamList::listPrintButtons()
  Prints the create and delete buttons.
listPrintConfigurationPage
  in file lists.inc, method lamList::listPrintConfigurationPage()
  Prints the list configuration page.
listPrintFooter
  in file lists.inc, method lamList::listPrintFooter()
  Prints the HTML footer.
listPrintHeader
  in file lists.inc, method lamList::listPrintHeader()
  Prints the HTML header.
listPrintTableBody
  in file lists.inc, method lamList::listPrintTableBody()
  Prints the entry list
listPrintTableCellContent
  in file group.inc, method lamGroupList::listPrintTableCellContent()
  Prints the content of a cell in the account list for a given LDAP entry and attribute.
listPrintTableCellContent
  in file lists.inc, method lamList::listPrintTableCellContent()
  Prints the content of a cell in the account list for a given LDAP entry and attribute.
listPrintTableCellContent
  in file user.inc, method lamUserList::listPrintTableCellContent()
  Prints the content of a cell in the account list for a given LDAP entry and attribute.
listPrintTableHeader
  in file lists.inc, method lamList::listPrintTableHeader()
  Prints the attribute and filter row at the account table head
listRefreshData
  in file group.inc, method lamGroupList::listRefreshData()
  Rereads the entries from LDAP.
listRefreshData
  in file lists.inc, method lamList::listRefreshData()
  Rereads the entries from LDAP.
listRefreshData
  in file user.inc, method lamUserList::listRefreshData()
  Rereads the entries from LDAP.
listShowOUSelection
  in file lists.inc, method lamList::listShowOUSelection()
  Prints a combobox with possible sub-DNs.
listSort
  in file lists.inc, method lamList::listSort()
  Sorts an account list by a given attribute
LIST_SIZE_OPTION_NAME
  in file lists.inc, class constant lamList::LIST_SIZE_OPTION_NAME
  ID for list size config option
list.php
  procedural page list.php

top

## m

$maxPageEntries
  in file lists.inc, variable lamList::$maxPageEntries
  maximum count of entries per page

top

## n

not_an_attr
  in file add_attr_form.php, function not_an_attr()
  Given an attribute $x, this returns true if it is NOT already specified in the current entry, returns false otherwise.
new_ou_template.php
  procedural page new_ou_template.php

top

## p

$page
  in file lists.inc, variable lamList::$page
  current page number
$possibleSuffixes
  in file lists.inc, variable lamList::$possibleSuffixes
  list of possible LDAP suffixes(organizational units)
pla_compare_dns
  in file tree.inc, function pla_compare_dns()
  Compares 2 DNs. If they are equivelant, returns 0, otherwise, returns their sorting order (similar to strcmp()): Returns < 0 if dn1 is less than dn2.
pla_explode_dn
  in file tree.inc, function pla_explode_dn()
  Explode a DN into an array of its RDN parts. This function is UTF-8 safe and replaces the buggy PHP ldap_explode_dn() which does not properly handle UTF-8 DNs and also causes segmentation faults with some inputs.
pla_ldap_search
  in file tree.inc, function pla_ldap_search()
  A handy ldap searching function very similar to PHP's ldap_search() with the following exceptions: Callers may specify a search scope and the return value is an array containing the search results rather than an LDAP result resource.
pla_rdelete
  in file rdelete.php, function pla_rdelete()
pla_reverse_dn
  in file tree.inc, function pla_reverse_dn()
  Reverses a DN such that the top-level RDN is first and the bottom-level RDN is last
pretty_print_dn
  in file tree.inc, function pretty_print_dn()
  Returns an HTML-beautified version of a DN.

top

## r

$refresh
  in file lists.inc, variable lamList::$refresh
  refresh page switch
refreshPrimaryGroupTranslation
  in file user.inc, method lamUserList::refreshPrimaryGroupTranslation()
  Refreshes the GID to group name cache.
real_attr_name
  in file tree.inc, function real_attr_name()
  Prunes off anything after the ";" in an attr name. This is useful for attributes that may have ";binary" appended to their names. With real_attr_name(), you can more easily fetch these attributes' schema with their "real" attribute name.
remove_aliases
  in file custom.php, function remove_aliases()
  Removes attributes from the array that are aliases for eachother
rdelete.php
  procedural page rdelete.php
refresh.php
  procedural page refresh.php

top

## s

$sortColumn
  in file lists.inc, variable lamList::$sortColumn
  sort column name
$sortDirection
  in file lists.inc, variable lamList::$sortDirection
  sort direction: 1 for ascending, -1 for descending
$suffix
  in file lists.inc, variable lamList::$suffix
  LDAP suffix
search_username
  in file userlink.php, function search_username()
  Searches LDAP for a specific user name (uid attribute) and returns its DN entry
setHelpID
  in file lists.inc, method lamSelectListOption::setHelpID()
  Sets the help ID.
setValue
  in file lists.inc, method lamListOption::setValue()
  Sets the config option value. The value must not contain "=" and ";".
showPage
  in file lists.inc, method lamList::showPage()
  Prints the HTML code to display the list view.
sortAttrs
  in file tree.inc, function sortAttrs()

top

## t

$type
  in file lists.inc, variable lamList::$type
  Account type
TRANS_PRIMARY_OPTION_NAME
  in file user.inc, class constant lamUserList::TRANS_PRIMARY_OPTION_NAME
  ID for config option
TRANS_PRIMARY_OPTION_NAME
  in file group.inc, class constant lamGroupList::TRANS_PRIMARY_OPTION_NAME
  ID for config option
tree.inc
  procedural page tree.inc
templates.inc
  procedural page templates.inc
tree.php
  procedural page tree.php
tree_view.php
  procedural page tree_view.php

top

## u

userlink.php
  procedural page userlink.php
update.php
  procedural page update.php
update_confirm.php
  procedural page update_confirm.php

top

Documentation generated on Mon, 28 Apr 2008 20:16:51 +0200 by phpDocumentor 1.4.0