[Phpgroupware-cvs] folders/doc HOOKS,1.1,1.2

[Philipp Kamps <address@hidden>]

Update of /cvsroot/phpgroupware/folders/doc
In directory subversions:/tmp/cvs-serv28581/doc

Modified Files:
        HOOKS 
Log Message:
documentation enhanced

Index: HOOKS
===================================================================
RCS file: /cvsroot/phpgroupware/folders/doc/HOOKS,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** HOOKS       17 Nov 2003 17:26:34 -0000      1.1
--- HOOKS       24 Nov 2003 16:47:52 -0000      1.2
***************
*** 4,12 ****
  
  The folder application uses the hook technique. The application
! may display any kind of information/data in form of a tree.  A hook
! 'getFolderContent' is proceed to get these information and data.
  
  The folder application itselfs provide a hook to deliver all available
! categories for the actual user.
  
  A hook of the 'email' module provides all IMAP-Accounts with
--- 4,13 ----
  
  The folder application uses the hook technique. The application
! can display any kind of information/data in form of a tree. To
! retrieve those information a hook 'getFolderContent' is proceed.
  
  The folder application itselfs provide a hook to deliver all available
! categories for the actual user (use user who actually is logged to
! the phpgroupware).
  
  A hook of the 'email' module provides all IMAP-Accounts with
***************
*** 20,35 ****
  parsed to a tree view.
  
! In the phpGroupware to hook mechnisme are possible:
  
! - An old hook style just includes some php-code. This method is not
  supported by the folders module.
  
! - A new hook style allows to call a certain function and allows to get
  a return value of this function. This hook style is used by the folders
  application. The method is called 'getFolderContent'.
  
  
! The folders module expect a return array in a certain form. See the
! next example for more details:
  
  Array
--- 21,36 ----
  parsed to a tree view.
  
! In the phpGroupware two hook mechanisms are possible:
  
! 1. An old hook style just includes some php-code. This method is not
  supported by the folders module.
  
! 2. A new hook style allows to call a certain function and allows to get
  a return value of this function. This hook style is used by the folders
  application. The method is called 'getFolderContent'.
  
  
! The folders module expect an array in a certain form as return value.
! See the next example for more details:
  
  Array
***************
*** 97,102 ****
          
  The most important elements of this array are:
! - array key which is the id of each tree element
! - the parent_id key which contains the reference to a parent element
  
  The value '0' (0 as a string) as a parent key determines that the element
--- 98,103 ----
          
  The most important elements of this array are:
! - array key which is the ID of each tree element
! - the parent_id key which contains the reference to a parent element (the ID)
  
  The value '0' (0 as a string) as a parent key determines that the element