phpgroupware-cvs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Phpgroupware-cvs] skel/inc hook_add_def_pref.inc.php, 1.3 class.skel.in


From: powerstat
Subject: [Phpgroupware-cvs] skel/inc hook_add_def_pref.inc.php, 1.3 class.skel.inc.php, 1.3 hook_admin.inc.php, 1.7 hook_preferences.inc.php, 1.7 hook_manual.inc.php, 1.3 functions.inc.php, 1.2 header.inc.php, 1.3 hook_skel_about.inc.php, 1.2
Date: Fri, 15 Apr 2005 12:55:00 +0200

Update of skel/inc

Modified Files:
     Branch: MAIN
            hook_add_def_pref.inc.php lines: +10 -10
            class.skel.inc.php lines: +35 -11
            hook_admin.inc.php lines: +12 -12
            hook_preferences.inc.php lines: +15 -14
            hook_manual.inc.php lines: +12 -12
            functions.inc.php lines: +19 -11
            header.inc.php lines: +9 -10
            hook_skel_about.inc.php lines: +20 -10

Log Message:
Converted to phpdoc.
Verified with phpdocumentor and php -l

====================================================
Index: skel/inc/hook_add_def_pref.inc.php
diff -u skel/inc/hook_add_def_pref.inc.php:1.2 
skel/inc/hook_add_def_pref.inc.php:1.3
--- skel/inc/hook_add_def_pref.inc.php:1.2      Fri Mar  8 04:27:05 2002
+++ skel/inc/hook_add_def_pref.inc.php  Fri Apr 15 10:55:41 2005
@@ -1,14 +1,14 @@
 <?php
-  /**************************************************************************\
-  * phpGroupWare - skel                                                      *
-  * 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$ */
+       /**
+       * Skeleton - add def pref hook
+       *
+       * This is only a skeleton to help start an phpgroupware application.
+       * @copyright Copyright (C) 2000-2002,2005 Free Software Foundation, 
Inc. http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/gpl.html GNU General Public 
License
+       * @package skeleton
+       * @subpackage hooks
+       * @version $Id$
+       */

        
$GLOBALS['pref']->change('notes','notes_font','Verdana,Arial,Helvetica,sans-serif');
        $GLOBALS['pref']->change('notes','notes_font_size','3');

====================================================
Index: skel/inc/class.skel.inc.php
diff -u skel/inc/class.skel.inc.php:1.2 skel/inc/class.skel.inc.php:1.3
--- skel/inc/class.skel.inc.php:1.2     Fri Mar  8 04:27:05 2002
+++ skel/inc/class.skel.inc.php Fri Apr 15 10:55:41 2005
@@ -1,27 +1,51 @@
 <?php
-  /**************************************************************************\
-  * phpGroupWare - skel                                                      *
-  * 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$ */
+       /**
+       * Skeleton - application
+       *
+       * This is only a skeleton to help start an phpgroupware application.
+       * @copyright Copyright (C) 2000-2002,2005 Free Software Foundation, 
Inc. http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/gpl.html GNU General Public 
License
+       * @package skeleton
+       * @version $Id$
+       */

+
+       /**
+       * Skeleton - application main class
+       *
+       * This main class will be called by the phpgroupware framework.
+       * @package skeleton
+       */
        class skel
        {
+               /**
+               * Database connection identifier
+               * @var integer Database connection identifier
+               */
                var $db;

+               /**
+               * Constructor
+               *
+               * This is the applications class constructor that will be 
called when
+               * the phpgroupware framework calls this application.
+               */
                function skel()
                {
                        // constructor
                }

-               function someotherfunc()
+               /**
+               * Some other function
+               *
+               * This is some of your functions
+               * @param string $parameter1 Parameter description goes here
+               * @return boolean Your return value
+               */
+               function someotherfunc($parameter1)
                {
                        //nothing to be added yet
+                       return(false);
                }
        }
 ?>

====================================================
Index: skel/inc/hook_admin.inc.php
diff -u skel/inc/hook_admin.inc.php:1.6 skel/inc/hook_admin.inc.php:1.7
--- skel/inc/hook_admin.inc.php:1.6     Sat Apr 19 23:29:34 2003
+++ skel/inc/hook_admin.inc.php Fri Apr 15 10:55:41 2005
@@ -1,21 +1,21 @@
 <?php
-       
/**************************************************************************\
-       * phpGroupWare - skel                                                   
   *
-       * 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$ */
+       /**
+       * Skeleton - admin hook
+       *
+       * This is only a skeleton to help start an phpgroupware application.
+       * @copyright Copyright (C) 2000-2002,2005 Free Software Foundation, 
Inc. http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/gpl.html GNU General Public 
License
+       * @package skeleton
+       * @subpackage hooks
+       * @version $Id$
+       */

        {
                $file = Array
                (
-//                     'Administer' => 
$GLOBALS['phpgw']->link('/index.php','menuaction=skel.uiskel.admin'),
+               // 'Administer' => 
$GLOBALS['phpgw']->link('/index.php','menuaction=skel.uiskel.admin'),
                );
-//Do not modify below this line
+               // Do not modify below this line
                $GLOBALS['phpgw']->common->display_mainscreen($appname,$file);
        }
 ?>

====================================================
Index: skel/inc/hook_preferences.inc.php
diff -u skel/inc/hook_preferences.inc.php:1.6 
skel/inc/hook_preferences.inc.php:1.7
--- skel/inc/hook_preferences.inc.php:1.6       Sat Jan 12 15:46:47 2002
+++ skel/inc/hook_preferences.inc.php   Fri Apr 15 10:55:41 2005
@@ -1,23 +1,24 @@
 <?php
-  /**************************************************************************\
-  * phpGroupWare - skel                                                      *
-  * 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.                                              *
-  \**************************************************************************/
+       /**
+       * Skeleton - preferences hook
+       *
+       * This is only a skeleton to help start an phpgroupware application.
+       * @copyright Copyright (C) 2000-2002,2005 Free Software Foundation, 
Inc. http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/gpl.html GNU General Public 
License
+       * @package skeleton
+       * @subpackage hooks
+       * @version $Id$
+       */

 {
-// Only Modify the $file and $title variables.....
+       // Only Modify the $file and $title variables.....
        $title = $appname;
        $file = Array(
-//             'Preferences'     => 
$GLOBALS['phpgw']->link('/skel/preferences.php'),
-//             'Grant Access'    => 
$GLOBALS['phpgw']->link('/index.php','menuaction=preferences.uiaclprefs.index&acl_app='.$appname),
-//             'Edit categories' => 
$GLOBALS['phpgw']->link('/index.php','menuaction=preferences.uicategories.index&cats_app='
 . $appname . '&cats_level=True&global_cats=True')
+       // 'Preferences'     => 
$GLOBALS['phpgw']->link('/skel/preferences.php'),
+       // 'Grant Access'    => 
$GLOBALS['phpgw']->link('/index.php','menuaction=preferences.uiaclprefs.index&acl_app='.$appname),
+       // 'Edit categories' => 
$GLOBALS['phpgw']->link('/index.php','menuaction=preferences.uicategories.index&cats_app='
 . $appname . '&cats_level=True&global_cats=True')
        );
-//Do not modify below this line
+       // Do not modify below this line
        display_section($appname,$title,$file);
 }
 ?>

====================================================
Index: skel/inc/hook_manual.inc.php
diff -u skel/inc/hook_manual.inc.php:1.2 skel/inc/hook_manual.inc.php:1.3
--- skel/inc/hook_manual.inc.php:1.2    Fri Mar  8 04:27:05 2002
+++ skel/inc/hook_manual.inc.php        Fri Apr 15 10:55:41 2005
@@ -1,18 +1,18 @@
 <?php
-    
/**************************************************************************\
-    * phpGroupWare - Manual                                                    
*
-    * http://www.phpgroupware.org                                              
*
-    * Written by Mark Peters <address@hidden>                        *
-    * --------------------------------------------                             
*
-    *  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$ */
+       /**
+       * Skeleton - manual hook
+       *
+       * This is only a skeleton to help start an phpgroupware application.
+       * @author Mark Peters <address@hidden>
+       * @copyright Copyright (C) 2000-2002,2005 Free Software Foundation, 
Inc. http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/gpl.html GNU General Public 
License
+       * @package skeleton
+       * @subpackage hooks
+       * @version $Id$
+       */

        // Only Modify the $file variable.....
        $file = Array();
-//Do not modify below this line
+       // Do not modify below this line
        display_manual_section($appname,$file);
 ?>

====================================================
Index: skel/inc/functions.inc.php
diff -u skel/inc/functions.inc.php:1.1 skel/inc/functions.inc.php:1.2
--- skel/inc/functions.inc.php:1.1      Sun May 20 07:40:32 2001
+++ skel/inc/functions.inc.php  Fri Apr 15 10:55:41 2005
@@ -1,17 +1,25 @@
 <?php
-  /**************************************************************************\
-  * phpGroupWare - skel                                                      *
-  * 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$ */
+       /**
+       * Skeleton - functions
+       *
+       * This is only a skeleton to help start an phpgroupware application.
+       * @copyright Copyright (C) 2000-2001,2005 Free Software Foundation, 
Inc. http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/gpl.html GNU General Public 
License
+       * @package skeleton
+       * @version $Id$
+       */

-       function somefunction()
+
+       /**
+       * Some other function
+       *
+       * This is some of your functions
+       * @param string $parameter1 Parameter description goes here
+       * @return boolean Your return value
+       */
+       function somefunction($parameter1)
        {
                // nothing needed for this app
+               return(false);
        }
 ?>

====================================================
Index: skel/inc/header.inc.php
diff -u skel/inc/header.inc.php:1.2 skel/inc/header.inc.php:1.3
--- skel/inc/header.inc.php:1.2 Fri Mar  8 04:27:05 2002
+++ skel/inc/header.inc.php     Fri Apr 15 10:55:41 2005
@@ -1,14 +1,13 @@
 <?php
-  /**************************************************************************\
-  * phpGroupWare - skel                                                      *
-  * 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$ */
+       /**
+       * Skeleton - header
+       *
+       * This is only a skeleton to help start an phpgroupware application.
+       * @copyright Copyright (C) 2000-2002,2005 Free Software Foundation, 
Inc. http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/gpl.html GNU General Public 
License
+       * @package skeleton
+       * @version $Id$
+       */

        $t = CreateObject('phpgwapi.Template',PHPGW_APP_TPL);
        $t->set_file(array('skel_header' => 'header.tpl'));

====================================================
Index: skel/inc/hook_skel_about.inc.php
diff -u skel/inc/hook_skel_about.inc.php:1.1 
skel/inc/hook_skel_about.inc.php:1.2
--- skel/inc/hook_skel_about.inc.php:1.1        Sun May 20 07:40:32 2001
+++ skel/inc/hook_skel_about.inc.php    Fri Apr 15 10:55:41 2005
@@ -1,15 +1,25 @@
 <?php
-  /**************************************************************************\
-  * phpGroupWare - skel                                                      *
-  * 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$ */
+       /**
+       * Skeleton - skeleton about hook
+       *
+       * This is only a skeleton to help start an phpgroupware application.
+       * @copyright Copyright (C) 2000-2001,2005 Free Software Foundation, 
Inc. http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/gpl.html GNU General Public 
License
+       * @package skeleton
+       * @subpackage hooks
+       * @version $Id$
+       */

+
+       /**
+       * About this application
+       *
+       * This function will create the string to display when the about this
+       * application function will be called.
+       * @param string $tpl Unknown
+       * @param string $handle Unknown
+       * @return string Text which describes this application.
+       */
        function about_app($tpl,$handle)
        {
                $s = '<b>' . lang('Skeleton') . '</b><p>' . lang('written by:') 
. ' Dan Kuykendall (Seek3r)';






reply via email to

[Prev in Thread] Current Thread [Next in Thread]