[Phpgroupware-cvs] filemanager/inc hook_sidebox_menu.inc.php, 1.3 hook_add_def_pref.inc.php, 1.11 class.bofilemanager.inc.php, 1.24 hook_preferences.inc.php, 1.17 hook_deleteaccount.inc.php, 1.6 hook_admin.inc.php, 1.8 class.uifilemanager.inc.php, 1.32 class.uiactions.inc.php, 1.4 class.uiaction_base.inc.php, 1.7 class.uiaction_edit.inc.php, 1.11

[powerstat]

Update of filemanager/inc

Modified Files:
     Branch: MAIN
            hook_sidebox_menu.inc.php lines: +6 -11
            hook_add_def_pref.inc.php lines: +7 -1
            class.bofilemanager.inc.php lines: +10 -5
            hook_preferences.inc.php lines: +8 -7
            hook_deleteaccount.inc.php lines: +11 -13
            hook_admin.inc.php lines: +9 -11
            class.uifilemanager.inc.php lines: +19 -19
            class.uiactions.inc.php lines: +7 -2
            class.uiaction_base.inc.php lines: +6 -1
            class.uiaction_edit.inc.php lines: +10 -2

Log Message:
Added phpdocs

====================================================
Index: filemanager/inc/hook_sidebox_menu.inc.php
diff -u filemanager/inc/hook_sidebox_menu.inc.php:1.2 
filemanager/inc/hook_sidebox_menu.inc.php:1.3
--- filemanager/inc/hook_sidebox_menu.inc.php:1.2       Sun Apr 10 22:36:07 2005
+++ filemanager/inc/hook_sidebox_menu.inc.php   Thu Apr 28 20:45:53 2005
@@ -2,24 +2,19 @@
        /**
        * Filemanager - Sidebox-Menu for iDots Template
        *
+       * This hookfile is for generating an app-specific side menu used in the 
idots template set.
+       * $menu_title speaks for itself
+       * $file is the array with link to app functions
+       * display_sidebox can be called as much as you like
        * @author Bettina Gille address@hidden
        * @author Pim Snel <address@hidden>
        * @copyright Copyright (C) 2003-2005 Free Software Foundation, Inc. 
http://www.fsf.org/
        * @license http://www.gnu.org/licenses/gpl.html GNU General Public 
License
        * @package filemanager
        * @version $Id$
-       * $Source$
+       * @internal $Source$
        */

-       /*
-               This hookfile is for generating an app-specific side menu used 
in the idots
-               template set.
-
-               $menu_title speaks for itself
-               $file is the array with link to app functions
-
-               display_sidebox can be called as much as you like
-       */

        {
                $appname = 'filemanager';

====================================================
Index: filemanager/inc/hook_add_def_pref.inc.php
diff -u filemanager/inc/hook_add_def_pref.inc.php:1.10 
filemanager/inc/hook_add_def_pref.inc.php:1.11
--- filemanager/inc/hook_add_def_pref.inc.php:1.10      Thu Feb 10 16:38:14 2005
+++ filemanager/inc/hook_add_def_pref.inc.php   Thu Apr 28 20:45:53 2005
@@ -1,4 +1,11 @@
 <?php
+       /***
+       * Filemanager add def preferences hook
+       * @copyright Copyright (C) 2000-2005 Free Software Foundation, Inc 
http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/gpl.html GNU General Public 
License
+       * @package filemanager
+       * @version $Id$
+       */

        $GLOBALS['pref']->change ('filemanager','name','name');
        $GLOBALS['pref']->change ('filemanager','size','size');
@@ -9,5 +16,4 @@
        $GLOBALS['pref']->change 
('filemanager','viewtextplain','viewtextplain');
        $GLOBALS['pref']->change ('filemanager','show_help','show_help');
        $GLOBALS['pref']->change ('filemanager','show_upload_boxes','5');
-
 ?>

====================================================
Index: filemanager/inc/class.bofilemanager.inc.php
diff -u filemanager/inc/class.bofilemanager.inc.php:1.23 
filemanager/inc/class.bofilemanager.inc.php:1.24
--- filemanager/inc/class.bofilemanager.inc.php:1.23    Sat Apr  9 21:56:02 2005
+++ filemanager/inc/class.bofilemanager.inc.php Thu Apr 28 20:45:53 2005
@@ -1,17 +1,22 @@
 <?php
        /***
-       * phpGroupWare Filemanager
-       * based on phpWebhosting, written by Jason Wies (Zone)
+       * Filemanager
        * @author Jason Wies (Zone)
-       * @author Mark A Peters (skeeter) <address@hidden>
+       * @author Mark A Peters <address@hidden>
        * @author Jonathon Sim <address@hidden>
-       * @author Bettina Gille (ceb) <address@hidden>
+       * @author Bettina Gille <address@hidden>
        * @copyright Copyright (C) 2000-2005 Free Software Foundation, Inc 
http://www.fsf.org/
        * @license http://www.gnu.org/licenses/gpl.html GNU General Public 
License
        * @package filemanager
        * @version $Id$
+       * @internal Based on phpWebhosting
        */

+       /**
+        * Filemanager business object class
+        *
+        * @package filemanager
+        */
        class bofilemanager
        {
                var $access_add = False;

====================================================
Index: filemanager/inc/hook_preferences.inc.php
diff -u filemanager/inc/hook_preferences.inc.php:1.16 
filemanager/inc/hook_preferences.inc.php:1.17
--- filemanager/inc/hook_preferences.inc.php:1.16       Thu Jan 27 01:55:40 2005
+++ filemanager/inc/hook_preferences.inc.php    Thu Apr 28 20:45:53 2005
@@ -1,11 +1,12 @@
 <?php
-       
/*************************************************************************\
-       * 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.                                            
  *
-       
\*************************************************************************/
-       /* $Id$ */
+       /***
+       * Filemanager preferencest hook
+       * @author Bettina Gille <address@hidden>
+       * @copyright Copyright (C) 2000-2005 Free Software Foundation, Inc 
http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/gpl.html GNU General Public 
License
+       * @package filemanager
+       * @version $Id$
+       */

        {
                $file = array('Preferences'     => 
$GLOBALS['phpgw']->link('/index.php','menuaction=filemanager.uifilemanager.preferences'));

====================================================
Index: filemanager/inc/hook_deleteaccount.inc.php
diff -u filemanager/inc/hook_deleteaccount.inc.php:1.5 
filemanager/inc/hook_deleteaccount.inc.php:1.6
--- filemanager/inc/hook_deleteaccount.inc.php:1.5      Thu Feb 10 16:38:14 2005
+++ filemanager/inc/hook_deleteaccount.inc.php  Thu Apr 28 20:45:53 2005
@@ -1,18 +1,16 @@
 <?php
-       
/**************************************************************************\
-       * phpGroupWare                                                          
   *
-       * http://www.phpgroupware.org                                           
   *
-       * --------------------------------------------                          
   *
-       *  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.                                           
   *
-       
\**************************************************************************/
-       /* $Id$ */
+       /***
+       * Filemanager delete account hook
+       * @author Bettina Gille <address@hidden>
+       * @copyright Copyright (C) 2000-2005 Free Software Foundation, Inc 
http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/gpl.html GNU General Public 
License
+       * @package filemanager
+       * @version $Id$
+       */

-       /* NOTE: This is untested */
-       /* WIP: it should get all files owned by $account_id, not just in 
/home/account_id */
-       /* Should also be capable of transfering files to another user */
+       // NOTE: This is untested
+       // WIP: it should get all files owned by $account_id, not just in 
/home/account_id
+       // Should also be capable of transfering files to another user

        /*
        $phpgw->vfs->working_id = $account_id;

====================================================
Index: filemanager/inc/hook_admin.inc.php
diff -u filemanager/inc/hook_admin.inc.php:1.7 
filemanager/inc/hook_admin.inc.php:1.8
--- filemanager/inc/hook_admin.inc.php:1.7      Sat Apr  9 21:56:02 2005
+++ filemanager/inc/hook_admin.inc.php  Thu Apr 28 20:45:53 2005
@@ -1,14 +1,12 @@
 <?php
-       
/**************************************************************************\
-       * phpGroupWare - filemanager administration                             
   *
-       * http://www.phpgroupware.org                                           
   *
-       * --------------------------------------------                          
   *
-       *  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.                                           
   *
-       
\**************************************************************************/
-       /* $Id$ */
+       /***
+       * Filemanager admin hook
+       * @author Bettina Gille <address@hidden>
+       * @copyright Copyright (C) 2000-2005 Free Software Foundation, Inc 
http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/gpl.html GNU General Public 
License
+       * @package filemanager
+       * @version $Id$
+       */

        {
 // Only Modify the $file and $title variables.....
@@ -17,7 +15,7 @@
                        'site configuration'            => 
$GLOBALS['phpgw']->link('/index.php','menuaction=filemanager.uifilemanager.admin'),
                        'edit user menu actions'        => 
$GLOBALS['phpgw']->link('/index.php','menuaction=filemanager.uifilemanager.edit_actions')
                );
-//Do not modify below this line
+// Do not modify below this line
                display_section($appname,$appname,$file);
        }
 ?>

====================================================
Index: filemanager/inc/class.uifilemanager.inc.php
diff -u filemanager/inc/class.uifilemanager.inc.php:1.31 
filemanager/inc/class.uifilemanager.inc.php:1.32
--- filemanager/inc/class.uifilemanager.inc.php:1.31    Sat Apr  9 21:56:02 2005
+++ filemanager/inc/class.uifilemanager.inc.php Thu Apr 28 20:45:53 2005
@@ -1,19 +1,27 @@
 <?php
        /***
        * phpGroupWare Filemanager
-       * based on phpWebhosting, written by Jason Wies (Zone)
        * @author Jason Wies (Zone)
-       * @author Mark A Peters (skeeter) <address@hidden>
+       * @author Mark A Peters <address@hidden>
        * @author Jonathon Sim <address@hidden>
        * @author Bettina Gille <address@hidden>
        * @copyright Copyright (C) 2000-2005 Free Software Foundation, Inc 
http://www.fsf.org/
        * @license http://www.gnu.org/licenses/gpl.html GNU General Public 
License
        * @package filemanager
        * @version $Id$
+       * @internal Based on phpWebhosting
        */

+       /**
+        * Define UI_DEBUG
+        */
        define('UI_DEBUG',0);

+       /**
+        * Filemanager GUI
+        *
+        * @package filemanager
+        */
        class uifilemanager
        {
                var $public_functions = array
@@ -93,10 +101,8 @@
                        $this->bofilemanager->userinfo['working_id'] = 
$GLOBALS['phpgw']->vfs->working_id;
                        $this->bofilemanager->userinfo['working_lid'] = 
$GLOBALS['phpgw']->accounts->id2name($this->bofilemanager->userinfo['working_id']);

-                       ###
-                       # Verify path is real
-                       ###
-
+
+                       // Verify path is real
                        if($this->bofilemanager->debug)
                        {
                                echo 'DEBUG: ui.verify_path: PATH = 
'.$this->bofilemanager->path.'<br>'."\n";
@@ -353,9 +359,8 @@
                                                'caption' => lang('Choose 
Directory -->')
                                        );

-                                       ###
-                                       # First we get the directories in their 
home directory
-                                       ###
+
+                                       // First we get the directories in 
their home directory

                                        $dirs[] = Array
                                        (
@@ -376,9 +381,8 @@
                                                $dirs[] = $dir;
                                        }

-                                       ###
-                                       # Then we get the directories in their 
membership's home directories
-                                       ###
+
+                                       // Then we get the directories in their 
membership's home directories

                                        
reset($this->bofilemanager->memberships);
                                        while(list($num,$group_array) = 
each($this->bofilemanager->memberships))
@@ -411,18 +415,14 @@
                                                        continue;
                                                }

-                                               ###
-                                               # So we don't display //
-                                               ###
+                                               // So we don't display //

                                                if($dir['directory'] != '/')
                                                {
                                                        $dir['directory'] .= 
SEP;
                                                }

-                                               ###
-                                               # No point in displaying the 
current directory, or a directory that doesn't exist
-                                               ###
+                                               // No point in displaying the 
current directory, or a directory that doesn't exist

                                                
if(($dir['directory'].$dir['name']) != $this->bofilemanager->path && 
$GLOBALS['phpgw']->vfs->file_exists(array(
                                                        'string' => 
$dir['directory'].$dir['name'],

====================================================
Index: filemanager/inc/class.uiactions.inc.php
diff -u filemanager/inc/class.uiactions.inc.php:1.3 
filemanager/inc/class.uiactions.inc.php:1.4
--- filemanager/inc/class.uiactions.inc.php:1.3 Sun Apr 10 22:36:06 2005
+++ filemanager/inc/class.uiactions.inc.php     Thu Apr 28 20:45:53 2005
@@ -8,9 +8,14 @@
        * @license http://www.gnu.org/licenses/gpl.html GNU General Public 
License
        * @package filemanager
        * @version $Id$
-       * $Source$
+       * @internal $Source$
        */

+       /**
+        * Filemanager GUI action class
+        *
+        * @package filemanager
+        */
        class uiactions
        {
                var $public_functions = array

====================================================
Index: filemanager/inc/class.uiaction_base.inc.php
diff -u filemanager/inc/class.uiaction_base.inc.php:1.6 
filemanager/inc/class.uiaction_base.inc.php:1.7
--- filemanager/inc/class.uiaction_base.inc.php:1.6     Fri Jan 28 00:32:39 2005
+++ filemanager/inc/class.uiaction_base.inc.php Thu Apr 28 20:45:53 2005
@@ -9,6 +9,11 @@
        * @version $Id$
        */

+       /**
+        * Filemanager GUI action base class
+        *
+        * @package filemanager
+        */
        class uiaction_base
        {
                var $public_functions = array

====================================================
Index: filemanager/inc/class.uiaction_edit.inc.php
diff -u filemanager/inc/class.uiaction_edit.inc.php:1.10 
filemanager/inc/class.uiaction_edit.inc.php:1.11
--- filemanager/inc/class.uiaction_edit.inc.php:1.10    Sat Feb 12 00:36:23 2005
+++ filemanager/inc/class.uiaction_edit.inc.php Thu Apr 28 20:45:53 2005
@@ -9,11 +9,19 @@
        * @version $Id$
        */

+       /**
+        * Define UIEDIT_DEBUG
+        */
        define('UIEDIT_DEBUG',0);

+       /**
+        * Filemanager GUI edit action class
+        *
+        * @package filemanager
+        */
        class uiaction_edit
        {
-               //Lists the suported actions (human readable) indexed by their 
function name
+               // Lists the suported actions (human readable) indexed by their 
function name
                var $public_functions = array
                (
                        'edit' => True