lists
[ class tree: lists ] [ index: lists ] [ all elements ]
Packages:
configuration
Help
LDAP
lib
lists
main
modules
PDF
profiles
selfService
tests
tools
types


Files:
deletelink.php
list.php
lists.inc
userlink.php

subpackage tree
add_attr.php
add_attr_form.php
add_oclass.php
add_oclass_form.php
add_value.php
add_value_form.php
collapse.php
create.php
create_form.php
creation_template.php
custom.php
delete.php
delete_attr.php
delete_form.php
download_binary_attr.php
edit.php
expand.php
export.php
export_form.php
new_ou_template.php
rdelete.php
refresh.php
templates.inc
tree.inc
tree.php
tree_view.php
update.php
update_confirm.php

Classes:
lamBooleanListOption
lamGroupList
lamHostList
lamList
lamListOption
lamListTool
lamMailAliasList
lamSelectListOption
lamSmbDomainList
lamUserList

Class: lamList

Source Location: /lib/lists.inc

Class Overview




Generates the list view.




Author(s):


    
          
  • Roland Gruber
    • 
      





    

        




Variables






Constants






Methods















Child classes:






lamGroupList

	
Generates the list view.






lamHostList

	
Generates the list view.






lamMailAliasList

	
Generates the list view.






lamSmbDomainList

	
Generates the list view.






lamUserList

	
Generates the list view.

















Class Details



[line 47]

Generates the list view.





Tags:





  

    author:  Roland Gruber
  










[ Top ]







Class Variables



	
	

	
$attrArray = array()

	
[line 56]

  list of LDAP attributes





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$descArray = array()

	
[line 59]

  list of attribute descriptions





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$entries = 

	
[line 77]

  LDAP entries





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$filterText = 

	
[line 80]

  filter string to include in URL





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$labels = 

	
[line 86]

  list of account specific labels





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$maxPageEntries =  30

	
[line 62]

  maximum count of entries per page





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$page =  1

	
[line 53]

  current page number





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$possibleSuffixes = 

	
[line 83]

  list of possible LDAP suffixes(organizational units)





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$refresh =  true

	
[line 74]

  refresh page switch





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$sortColumn = 

	
[line 65]

  sort column name





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$sortDirection =  1

	
[line 68]

  sort direction: 1 for ascending, -1 for descending





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$suffix = 

	
[line 71]

  LDAP suffix





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$type = 

	
[line 50]

  Account type





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]










Class Methods




  

	
	
constructor __construct [line 100]

	

    

    

		lamList __construct(
string
$type)
    

    


	
		Constructor





Tags:





  

    return:  list object
  

  

    access:  public
  









	
Overridden in child classes as:

		

	
lamGroupList::__construct()

		
Constructor

	

		

	
lamHostList::__construct()

		
Constructor

	

		

	
lamMailAliasList::__construct()

		
Constructor

	

		

	
lamSmbDomainList::__construct()

		
Constructor

	

		

	
lamUserList::__construct()

		
Constructor

	

	

	
        
Parameters:

    

    

          

        string  
        $type  
        account type
      

        

    


        
[ Top ]

  

  

	
	
method cmp_array [line 302]

	

    

    

		integer cmp_array(

&$a, 
&$b, array
$a, array
$b)
    

    


	
		Compare function used for usort-method

Rows are sorted with the first attribute entry of the sort column.  If objects have attributes with multiple values only the first is used for sorting.





Tags:





  

    return:  0 if both are equal, 1 if $a is greater, -1 if $b is greater
  

  

    access:  protected
  









	
        
Parameters:

    

    

          

        array  
        $a  
        first row which is compared
      

          

        array  
        $b  
        second row which is compared
      

          

          
        &$a  
        
      

          

          
        &$b  
        
      

        

    


        
[ Top ]

  

  

	
	
method getAdditionalTools [line 865]

	

    

    

		lamListTool[] getAdditionalTools(
)
    

    


	
		Returns a list of lamListTool objects to display next to the edit/delete buttons.





Tags:





  

    return:  tools
  

  

    access:  protected
  









	
Overridden in child classes as:

		

	
lamUserList::getAdditionalTools()

		
Returns a list of lamListTool objects to display next to the edit/delete buttons.

	

	

	
        
[ Top ]

  

  

	
	
method listBuildFilter [line 204]

	

    

    

		array listBuildFilter(
)
    

    


	
		Builds the regular expressions from the filter values.





Tags:





  

    return:  filter data array($attribute => array('regex' => $reg, 'original' => $orig))  $reg is the regular expression to use, $orig the user's unmodified input string
  

  

    access:  protected
  









	
        
[ Top ]

  

  

	
	
method listConfigurationChanged [line 924]

	

    

    

		void listConfigurationChanged(
)
    

    


	
		Called when the configuration options changed.





Tags:





  

    access:  protected
  









	
Overridden in child classes as:

		

	
lamGroupList::listConfigurationChanged()

		
Called when the configuration options changed.

	

		

	
lamUserList::listConfigurationChanged()

		
Called when the configuration options changed.

	

	

	
        
[ Top ]

  

  

	
	
method listDoPost [line 506]

	

    

    

		void listDoPost(
)
    

    


	
		Manages all POST actions (e.g. button pressed) for the account lists.





Tags:





  

    access:  protected
  









	
        
[ Top ]

  

  

	
	
method listDrawNavigationBar [line 321]

	

    

    

		void listDrawNavigationBar(
integer
$count)
    

    


	
		Draws a navigation bar to switch between pages





Tags:





  

    access:  protected
  









	
        
Parameters:

    

    

          

        integer  
        $count  
        number of account entries
      

        

    


        
[ Top ]

  

  

	
	
method listFilterAccounts [line 248]

	

    

    

		array listFilterAccounts(
)
    

    


	
		Removes all entries which do not fit to the filter.





Tags:





  

    return:  filtered list of accounts
  

  

    access:  protected
  









	
        
[ Top ]

  

  

	
	
method listGetAllConfigOptions [line 874]

	

    

    

		array listGetAllConfigOptions(
)
    

    


	
		Returns a list of possible configuration options.





Tags:





  

    return:  list of lamListOption objects
  

  

    access:  protected
  









	
Overridden in child classes as:

		

	
lamGroupList::listGetAllConfigOptions()

		
Returns a list of possible configuration options.

	

		

	
lamUserList::listGetAllConfigOptions()

		
Returns a list of possible configuration options.

	

	

	
        
[ Top ]

  

  

	
	
method listGetConfigOptionByID [line 912]

	

    

    

		void listGetConfigOptionByID(
String
$ID)
    

    


	
		Returns the configuration option with the given ID.





Tags:





  

    access:  protected
  









	
        
Parameters:

    

    

          

        String  
        $ID  
        ID
      

        

    


        
[ Top ]

  

  

	
	
method listGetParams [line 791]

	

    

    

		void listGetParams(
)
    

    


	
		Sets some internal parameters.





Tags:





  

    access:  protected
  









	
Overridden in child classes as:

		

	
lamGroupList::listGetParams()

		
Sets some internal parameters.

	

		

	
lamUserList::listGetParams()

		
Sets some internal parameters.

	

	

	
        
[ Top ]

  

  

	
	
method listPrintButtons [line 707]

	

    

    

		void listPrintButtons(
boolean
$createOnly)
    

    


	
		Prints the create and delete buttons.





Tags:





  

    access:  protected
  









	
        
Parameters:

    

    

          

        boolean  
        $createOnly  
        true if only the create button should be displayed
      

        

    


        
[ Top ]

  

  

	
	
method listPrintConfigurationPage [line 882]

	

    

    

		void listPrintConfigurationPage(
)
    

    


	
		Prints the list configuration page.





Tags:





  

    access:  protected
  









	
        
[ Top ]

  

  

	
	
method listPrintFooter [line 746]

	

    

    

		void listPrintFooter(
)
    

    


	
		Prints the HTML footer.





Tags:





  

    access:  protected
  









	
        
[ Top ]

  

  

	
	
method listPrintHeader [line 734]

	

    

    

		void listPrintHeader(
)
    

    


	
		Prints the HTML header.





Tags:





  

    access:  protected
  









	
        
[ Top ]

  

  

	
	
method listPrintTableBody [line 412]

	

    

    

		void listPrintTableBody(

&$info, array
$info)
    

    


	
		Prints the entry list





Tags:





  

    access:  protected
  









	
        
Parameters:

    

    

          

        array  
        $info  
        entries
      

          

          
        &$info  
        
      

        

    


        
[ Top ]

  

  

	
	
method listPrintTableCellContent [line 487]

	

    

    

		void listPrintTableCellContent(

&$entry, 
&$attribute, array
$entry, string
$attribute)
    

    


	
		Prints the content of a cell in the account list for a given LDAP entry and attribute.





Tags:





  

    access:  protected
  









	
Overridden in child classes as:

		

	
lamGroupList::listPrintTableCellContent()

		
Prints the content of a cell in the account list for a given LDAP entry and attribute.

	

		

	
lamUserList::listPrintTableCellContent()

		
Prints the content of a cell in the account list for a given LDAP entry and attribute.

	

	

	
        
Parameters:

    

    

          

        array  
        $entry  
        LDAP attributes
      

          

        string  
        $attribute  
        attribute name
      

          

          
        &$entry  
        
      

          

          
        &$attribute  
        
      

        

    


        
[ Top ]

  

  

	
	
method listPrintTableHeader [line 360]

	

    

    

		void listPrintTableHeader(
)
    

    


	
		Prints the attribute and filter row at the account table head





Tags:





  

    access:  protected
  









	
        
[ Top ]

  

  

	
	
method listRefreshData [line 830]

	

    

    

		void listRefreshData(
)
    

    


	
		Rereads the entries from LDAP.





Tags:





  

    access:  protected
  









	
Overridden in child classes as:

		

	
lamGroupList::listRefreshData()

		
Rereads the entries from LDAP.

	

		

	
lamUserList::listRefreshData()

		
Rereads the entries from LDAP.

	

	

	
        
[ Top ]

  

  

	
	
method listShowOUSelection [line 687]

	

    

    

		void listShowOUSelection(
)
    

    


	
		Prints a combobox with possible sub-DNs.





Tags:





  

    access:  protected
  









	
        
[ Top ]

  

  

	
	
method listSort [line 283]

	

    

    

		array listSort(

&$info, array
$info)
    

    


	
		Sorts an account list by a given attribute





Tags:





  

    return:  sorted account list
  

  

    access:  protected
  









	
        
Parameters:

    

    

          

        array  
        $info  
        the account list
      

          

          
        &$info  
        
      

        

    


        
[ Top ]

  

  

	
	
method showPage [line 142]

	

    

    

		void showPage(
)
    

    


	
		Prints the HTML code to display the list view.





Tags:





  

    access:  public
  









	
        
[ Top ]

  









Class Constants



	
	

	
LIST_SIZE_OPTION_NAME =  "L_SIZE"

	
[line 92]

  ID for list size config option


  

	
[ Top ]






        

		    

		    Documentation generated on Thu, 07 Feb 2008 20:26:39 +0100 by phpDocumentor 1.4.0