phpgroupware-cvs
[Top][All Lists]
Advanced

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

[Phpgroupware-cvs] phpgwapi/inc class.Mail_mimeDecode.inc.php clas...


From: Dave Hall
Subject: [Phpgroupware-cvs] phpgwapi/inc class.Mail_mimeDecode.inc.php clas...
Date: Sun, 03 Sep 2006 04:07:01 +0000

CVSROOT:        /cvsroot/phpgwapi
Module name:    phpgwapi
Changes by:     Dave Hall <skwashd>     06/09/03 04:07:01

Modified files:
        inc            : class.Mail_mimeDecode.inc.php 
                         class.Services_JSON.inc.php class.excel.inc.php 
                         class.pdf.inc.php class.mailer_smtp.inc.php 
                         class.data_cleaner.inc.php 

Log message:
        docs cleanup

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/phpgwapi/inc/class.Mail_mimeDecode.inc.php?cvsroot=phpgwapi&r1=1.1&r2=1.2
http://cvs.savannah.gnu.org/viewcvs/phpgwapi/inc/class.Services_JSON.inc.php?cvsroot=phpgwapi&r1=1.1&r2=1.2
http://cvs.savannah.gnu.org/viewcvs/phpgwapi/inc/class.excel.inc.php?cvsroot=phpgwapi&r1=1.1&r2=1.2
http://cvs.savannah.gnu.org/viewcvs/phpgwapi/inc/class.pdf.inc.php?cvsroot=phpgwapi&r1=1.4&r2=1.5
http://cvs.savannah.gnu.org/viewcvs/phpgwapi/inc/class.mailer_smtp.inc.php?cvsroot=phpgwapi&r1=1.3&r2=1.4
http://cvs.savannah.gnu.org/viewcvs/phpgwapi/inc/class.data_cleaner.inc.php?cvsroot=phpgwapi&r1=1.2&r2=1.3

Patches:
Index: class.Mail_mimeDecode.inc.php
===================================================================
RCS file: /cvsroot/phpgwapi/phpgwapi/inc/class.Mail_mimeDecode.inc.php,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- class.Mail_mimeDecode.inc.php       24 Feb 2006 00:50:04 -0000      1.1
+++ class.Mail_mimeDecode.inc.php       3 Sep 2006 04:07:00 -0000       1.2
@@ -62,8 +62,9 @@
 *    perhaps even message/partial.
 *
 * @author  Richard Heyes <address@hidden>
-* @version $Revision: 1.1 $
-* @package Mail
+* @version $Revision: 1.2 $
+* @package phpgwapi
+* @subpackage communication
 */
 
 class Mail_mimeDecode

Index: class.Services_JSON.inc.php
===================================================================
RCS file: /cvsroot/phpgwapi/phpgwapi/inc/class.Services_JSON.inc.php,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- class.Services_JSON.inc.php 19 Feb 2006 13:07:55 -0000      1.1
+++ class.Services_JSON.inc.php 3 Sep 2006 04:07:00 -0000       1.2
@@ -46,7 +46,8 @@
  * DAMAGE.
  * 
  * @category   
- * @package     Services_JSON
+ * @package     phpgwapi
+ * @subpackage  Services_JSON
  * @author      Michal Migurski <address@hidden>
  * @author      Matt Knapp <mdknapp[at]gmail[dot]com>
  * @author      Brett Stimmerman <brettstimmerman[at]gmail[dot]com>

Index: class.excel.inc.php
===================================================================
RCS file: /cvsroot/phpgwapi/phpgwapi/inc/class.excel.inc.php,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- class.excel.inc.php 16 Mar 2006 19:16:35 -0000      1.1
+++ class.excel.inc.php 3 Sep 2006 04:07:00 -0000       1.2
@@ -6,29 +6,40 @@
        * @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
        * @internal Development of this application was funded by 
http://www.bergen.kommune.no/bbb_/ekstern/
-       * @package Excel
-       * @version $Id: class.excel.inc.php,v 1.1 2006/03/16 19:16:35 sigurdne 
Exp $
+       * @package phpgwapi
+       * @subpackage utilities
+       * @version $Id: class.excel.inc.php,v 1.2 2006/09/03 04:07:00 skwashd 
Exp $
+       *
+       * Example
+       * <code>
+       *
+       *       $GLOBALS['phpgw_info']['flags'] = array
+       *       (
+       *               'noheader'      => true,
+       *               'nofooter'      => true,
+       *               'xslt_app'      => false
+       *       );
+       *
+       *       $filename= $GLOBALS['phpgw_info']['user']['account_lid'].'.xls';
+       *
+       *       $workbook       = CreateObject('phpgwapi.excel',"-");
+       *       $browser = CreateObject('phpgwapi.browser');
+       *       $browser->content_header($filename,'application/vnd.ms-excel');
+       *
+       *       $worksheet1 =& $workbook->add_worksheet('First One');
+       *       // have a look at phpgwapi/inc/excel/test.php on input
+       *       $workbook->close();
+       * </code>
        */
        
-       /* Example
-               $GLOBALS['phpgw_info']['flags'][noheader] = True;
-               $GLOBALS['phpgw_info']['flags'][nofooter] = True;
-               $GLOBALS['phpgw_info']['flags']['xslt_app'] = False;
 
-               $filename= $GLOBALS['phpgw_info']['user']['account_lid'].'.xls';
-
-               $workbook       = CreateObject('phpgwapi.excel',"-");
-               $browser = CreateObject('phpgwapi.browser');
-               $browser->content_header($filename,'application/vnd.ms-excel');
-
-               $worksheet1 =& $workbook->add_worksheet('First One');
-               
-               // have a look at phpgwapi/inc/excel/test.php on input
-
-               $workbook->close();
+       /**
+       * @see worksheet
        */
-
-       
        require_once(PHPGW_API_INC . '/excel/Worksheet.php');
+
+       /**
+       * @see workbook
+       */
        require_once(PHPGW_API_INC . '/excel/Workbook.php');
 ?>

Index: class.pdf.inc.php
===================================================================
RCS file: /cvsroot/phpgwapi/phpgwapi/inc/class.pdf.inc.php,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -b -r1.4 -r1.5
--- class.pdf.inc.php   13 Jul 2006 11:40:45 -0000      1.4
+++ class.pdf.inc.php   3 Sep 2006 04:07:00 -0000       1.5
@@ -6,28 +6,43 @@
        * @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
        * @internal Development of this application was funded by 
http://www.bergen.kommune.no/bbb_/ekstern/
-       * @package Cpdf
-       * @version $Id: class.pdf.inc.php,v 1.4 2006/07/13 11:40:45 sigurdne 
Exp $
+       * @package phpgwapi
+       * @subpackage utilities
+       * @version $Id: class.pdf.inc.php,v 1.5 2006/09/03 04:07:00 skwashd Exp 
$
+       *
+       * Example
+       * <code>
+       *       $GLOBALS['phpgw_info']['flags'] = array
+       *       (
+       *               'noheader'      => true,
+       *               'nofooter'      => true,
+       *               'xslt_app'      => false
+       *       );
+       *
+       *       $pdf    = CreateObject('phpgwapi.pdf');
+       *
+       *       @set_time_limit(1800); //allows for generation of complex 
documents
+       *       $pdf -> ezSetMargins(50,70,50,50);
+       *       $pdf->selectFont(PHPGW_API_INC . '/pdf/fonts/Helvetica.afm');
+       *       
+       *       //have a look at the function tender in 
/property/inc/class.uiwo_hour.inc.php for usage.
+       *       
+       *       $document= $pdf->ezOutput();
+       *       $pdf->print_pdf($document,'document_name');
+       * </code>
        */
 
-       /* Example
-               $GLOBALS['phpgw_info']['flags'][noheader] = True;
-               $GLOBALS['phpgw_info']['flags'][nofooter] = True;
-               $GLOBALS['phpgw_info']['flags']['xslt_app'] = False;
-               $pdf    = CreateObject('phpgwapi.pdf');
-
-               set_time_limit(1800);
-               $pdf -> ezSetMargins(50,70,50,50);
-               $pdf->selectFont(PHPGW_API_INC . '/pdf/fonts/Helvetica.afm');
-               
-               //have a look at the function tender in 
/property/inc/class.uiwo_hour.inc.php for usage.
-               
-               $document= $pdf->ezOutput();
-               $pdf->print_pdf($document,'document_name');
+       /**
+       * Docuemnt me!
        */
-
        class pdf__
        {
+               /**
+               * Output a pdf
+               *
+               * @param string $document the pdf document as a string
+               * @param string $document_name the name to save the document as
+               */
                function print_pdf($document = '',$document_name = 'document')
                {       
                        $browser = CreateObject('phpgwapi.browser');
@@ -58,6 +73,7 @@
                                fwrite($fp,$document);
                                fclose($fp);
 
+                               //TODO consider using phpgw::redirect_link() ?
                                $fname = 'phpgwapi/inc/pdf/pdf_files/'. 
basename($fname);
                                echo '<html>
                                <head>
@@ -92,7 +108,15 @@
                }
        }
 
-
+       /**
+       * Include the pdf class
+       * @see pdf_
+       */
        include (PHPGW_API_INC . '/pdf/class.pdf.php');
+
+       /**
+       * Include the ezpdf class
+       * @see @pdf
+       */
        include (PHPGW_API_INC . '/pdf/class.ezpdf.php');
 ?>

Index: class.mailer_smtp.inc.php
===================================================================
RCS file: /cvsroot/phpgwapi/phpgwapi/inc/class.mailer_smtp.inc.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -b -r1.3 -r1.4
--- class.mailer_smtp.inc.php   20 Aug 2006 10:35:55 -0000      1.3
+++ class.mailer_smtp.inc.php   3 Sep 2006 04:07:00 -0000       1.4
@@ -4,8 +4,9 @@
        * @author Dave Hall - skwashd at phpgroupware.org
        * @copyright Copyright (C) 2005 Free Software Foundation, Inc. 
http://www.fsf.org/
        * @license http://www.gnu.org/licenses/gpl.html GNU General Public 
License
-       * @package email
-       * @version $Id: class.mailer_smtp.inc.php,v 1.3 2006/08/20 10:35:55 
skwashd Exp $
+       * @package phpgwapi
+       * @subpackage communication
+       * @version $Id: class.mailer_smtp.inc.php,v 1.4 2006/09/03 04:07:00 
skwashd Exp $
        */
 
        /**
@@ -14,15 +15,12 @@
        include_once(PHPGW_INCLUDE_ROOT . 
'/phpgwapi/inc/phpmailer/class.phpmailer.php');
        
        /**
-       * class smtp
-       *
-       * bo class for assembling messages for sending via class send
-       * @internal server side attachment storage technique borrowed from 
Squirrelmail
+       * Send email messages via SMTP
        */
        class mailer_smtp extends PHPMailer
        {
                /**
-               * @constructor
+               * Constructor
                */
                function mailer_smtp()
                {

Index: class.data_cleaner.inc.php
===================================================================
RCS file: /cvsroot/phpgwapi/phpgwapi/inc/class.data_cleaner.inc.php,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -b -r1.2 -r1.3
--- class.data_cleaner.inc.php  15 May 2006 07:22:18 -0000      1.2
+++ class.data_cleaner.inc.php  3 Sep 2006 04:07:00 -0000       1.3
@@ -1,7 +1,7 @@
 <?php
 /**
  * HTML Sanitizer, attemtpts to make variables safe for users.
- * $Id: class.data_cleaner.inc.php,v 1.2 2006/05/15 07:22:18 skwashd Exp $
+ * $Id: class.data_cleaner.inc.php,v 1.3 2006/09/03 04:07:00 skwashd Exp $
  *
  * Taken from the horde project by Dave Hall for use in phpGroupWare
  *
@@ -18,7 +18,8 @@
  * @author  Michael Slusarz <address@hidden>
  * @author  Dave Hall skwashd at phpgroupware.org
  * @since   phpGroupWare 0.9.16.007
- * @package API
+ * @package phpgwapi
+ * @subpackage utilities
  */
 class data_cleaner
 {




reply via email to

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