[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Phpgroupware-cvs] phpgwapi/inc class.nextmatchs_xslt.inc.php, 1.2 class
|
From: |
powerstat |
|
Subject: |
[Phpgroupware-cvs] phpgwapi/inc class.nextmatchs_xslt.inc.php, 1.2 class.http_dav_client.inc.php, 1.12 class.gdbutton.inc.php, 1.5 class.xmltool.inc.php, 1.11 class.gdgraph.inc.php, 1.20 class.gdimage.inc.php, 1.11 class.xslttemplates.inc.php, 1.20 class.nextmatchs.inc.php, 1.73 |
|
Date: |
Tue, 26 Apr 2005 11:43:00 +0200 |
Update of phpgwapi/inc
Modified Files:
Branch: MAIN
class.nextmatchs_xslt.inc.php lines: +6 -4
class.http_dav_client.inc.php lines: +171 -202
class.gdbutton.inc.php lines: +21 -32
class.xmltool.inc.php lines: +42 -25
class.gdgraph.inc.php lines: +18 -32
class.gdimage.inc.php lines: +18 -31
class.xslttemplates.inc.php lines: +24 -6
class.nextmatchs.inc.php lines: +6 -1
Log Message:
phpdoc fixes
====================================================
Index: phpgwapi/inc/class.nextmatchs_xslt.inc.php
diff -u phpgwapi/inc/class.nextmatchs_xslt.inc.php:1.1
phpgwapi/inc/class.nextmatchs_xslt.inc.php:1.2
--- phpgwapi/inc/class.nextmatchs_xslt.inc.php:1.1 Tue Jan 18 01:51:20 2005
+++ phpgwapi/inc/class.nextmatchs_xslt.inc.php Tue Apr 26 09:43:08 2005
@@ -9,9 +9,11 @@
* @version $Id$
*/
- /*!
- @class nextmatchs_xslt
- @abstract
+ /**
+ * XSLT nextmatch
+ *
+ * @package phpgwapi
+ * @subpackage gui
*/
class nextmatchs_xslt
{
====================================================
Index: phpgwapi/inc/class.http_dav_client.inc.php
diff -u phpgwapi/inc/class.http_dav_client.inc.php:1.11
phpgwapi/inc/class.http_dav_client.inc.php:1.12
--- phpgwapi/inc/class.http_dav_client.inc.php:1.11 Tue Apr 26 07:50:36 2005
+++ phpgwapi/inc/class.http_dav_client.inc.php Tue Apr 26 09:43:08 2005
@@ -208,9 +208,9 @@
$this->tree = array();
}
- //So, we fake the DAV: uri into a more acceptable one
+ // So, we fake the DAV: uri into a more acceptable one
$xml_string =
preg_replace('/"DAV:"/','"http://webdav.org/dav/";',$this->xml);
- //Build it
+ // Build it
$domobj = domxml_open_mem($xml_string);
// $time1 = getmicrotime();
$this->tree = dav_parser::davtree($domobj);
@@ -221,6 +221,7 @@
}
+
/**
* DAV client
*
@@ -243,8 +244,8 @@
$this->set_debug(0);
}
- //TODO: Get rid of this
- //A quick, temporary debug output function
+ // TODO: Get rid of this
+ // A quick, temporary debug output function
function debug($info) {
if (DEBUG_DAV_CLIENT)
@@ -262,11 +263,11 @@
}
}
- /*!
- @function glue_url
- @abstract glues a parsed url (ie parsed using PHP's parse_url)
back
- together
- @param $url The parsed url (its an array)
+ /**
+ * Glues a parsed url (ie parsed using PHP's parse_url) back
together
+ *
+ * @param array $url The parsed url
+ * @return boolean|string URI string or false
*/
function glue_url ($url)
{
@@ -304,13 +305,12 @@
return $uri;
}
- /*!
- @function encodeurl
- @abstract encodes a url from its "display name" to something
the dav server will accept
- @param uri The unencoded uri
- @discussion
- Deals with "url"s which may contain spaces and other
unsavoury characters,
- by using appropriate %20s
+ /**
+ * Encodes a url from its "display name" to something the dav
server will accept
+ *
+ * @param string $uri The unencoded URI
+ * @return string Encoded URI
+ * @internal Deals with "url"s which may contain spaces and
other unsavoury characters, by using appropriate %20s
*/
function encodeurl($uri)
{
@@ -342,13 +342,12 @@
}
- /*!
- @function decodeurl
- @abstract decodes a url to its "display name"
- @param uri The encoded uri
- @discussion
- Deals with "url"s which may contain spaces and other
unsavoury characters,
- by using appropriate %20s
+ /**
+ * Decodes a url to its "display name"
+ *
+ * @param string $uri Encoded URI
+ * @return string Decoded URI
+ * @internal Deals with "url"s which may contain spaces and
other unsavoury characters, by using appropriate %20s
*/
function decodeurl($uri)
{
@@ -380,15 +379,11 @@
}
- /*!
- @function set_attributes
- @abstract Sets the "attribute map"
- @param attributes Attributes to extract "as-is" from the DAV
properties
- @param dav_map A mapping of dav_property_name => attribute_name
for attributes
- with different names in DAV and the desired name space.
- @discussion
- This is mainly for use by VFS, where the VFS attributes
(eg size) differ
- from the corresponding DAV ones ("getcontentlength")
+ /**
+ * Sets the "attribute map"
+ * @param array $attributes Attributes to extract "as-is" from
the DAV properties
+ * @param array $dav_map A mapping of dav_property_name =>
attribute_name for attributes with different names in DAV and the desired name
space.
+ * @internal This is mainly for use by VFS, where the VFS
attributes (eg size) differ from the corresponding DAV ones ("getcontentlength")
*/
function set_attributes($attributes, $dav_map)
{
@@ -396,27 +391,24 @@
$this->attributes = $attributes;
}
- /*!
- @function set_credentials
- @abstract Sets authentication credentials for HTTP AUTH
- @param username The username to connect with
- @param password The password to connect with
- @discussion
- The only supported authentication type is "basic"
+ /**
+ * Sets authentication credentials for HTTP AUTH
+ *
+ * @param string $username The username to connect with
+ * @param string $password The password to connect with
+ * @internal The only supported authentication type is "basic"
*/
function set_credentials( $username, $password )
{
$this->http_client->setCredentials($username, $password
);
}
- /*!
- @function connect
- @abstract connects to the server
- @param dav_host The host to connect to
- @param dav_port The port to connect to
- @discussion
- If the server requires authentication you will need to
set credentials
- with set_credentials first
+ /**
+ * Connects to the server
+ *
+ * @param string $dav_host The host to connect to
+ * @param integer $dav_port The port to connect to
+ * @internal If the server requires authentication you will need
to set credentials with set_credentials first
*/
function connect($dav_host,$dav_port,$ssl=False)
{
@@ -443,13 +435,10 @@
$this->http_client->setDebug($debug);
}
- /*!
- @function disconnect
- @abstract disconnect from the server
- @discussion
- When doing HTTP 1.1 we frequently close/reopen the
connection
- anyway, so this function needs to be called after any
other DAV calls
- (since if they find the connection closed, they just
reopen it)
+ /**
+ * Disconnect from the server
+ *
+ * @internal When doing HTTP 1.1 we frequently close/reopen the
connection anyway, so this function needs to be called after any other DAV
calls (since if they find the connection closed, they just reopen it)
*/
function disconnect()
{
@@ -457,18 +446,16 @@
$this->http_client->Disconnect();
}
- /*!
- @function get_properties
- @abstract a high-level method of getting DAV properties
- @param url The URL to get properties for
- @param scope the 'depth' to recuse subdirectories (default 1)
- @param sorted whether we should sort the rsulting array
(default True)
- @result array of file->property arra
- @discussion
- This function performs all the necessary XML parsing
etc to convert DAV properties (ie XML nodes)
- into associative arrays of properties - including doing
mappings
- from DAV property names to any desired property name
format (eg the VFS one)
- This is controlled by the attribute arrays set in the
set_attributes function.
+ /**
+ * A high-level method of getting DAV properties
+ *
+ * @param array $props
+ * @param string $url The URL to get properties for
+ * @param integer $scope the 'depth' to recuse subdirectories
(default 1)
+ * @param boolean $is_dir
+ * @param boolean $sorted Whether we should sort the rsulting
array (default True)
+ * @return array of file->property arra
+ * @internal This function performs all the necessary XML
parsing etc to convert DAV properties (ie XML nodes) into associative arrays of
properties - including doing mappings from DAV property names to any desired
property name format (eg the VFS one) This is controlled by the attribute
arrays set in the set_attributes function.
*/
function get_properties(&$props, $url, $scope=1, $is_dir
=False, $sorted=true){
$request_id = $url.'//'.$scope.'//'.$sorted; //A unique
id for this request (for caching)
@@ -578,36 +565,35 @@
return $this->http_client->Get($uri);
}
- /*!
- @function get_body
- @abstract return the response body
- @result string body content
- @discussion
- invoke it after a Get() call for instance, to retrieve
the response
+ /**
+ * Get body content
+ *
+ * @return string
+ * @internal Invoke it after a Get() call for instance, to
retrieve the response
*/
function get_body()
{
return $this->http_client->getBody();
}
- /*!
- @function get_headers
- @abstract return the response headers
- @result array headers received from server in the form
headername => value
- @discussion
- to be called after a Get() or Head() call
+ /**
+ * Return the response headers
+ *
+ * @return array Headers received from server in the form
headername => value
+ * @internal To be called after a Get() or Head() call
*/
function get_headers()
{
return $this->http_client->getHeaders();
}
- /*!
- @function put
- @abstract PUT is the method to sending a file on the server.
- @param uri the location of the file on the server. dont forget
the heading "/"
- @param data the content of the file. binary content accepted
- @result string response status code 201 (Created) if ok
+ /**
+ * Put is the method to sending a file on the server.
+ *
+ * @param string $uri The location of the file on the server.
dont forget the heading "/"
+ * @param string $data The content of the file. Binary content
accepted
+ * @param string $token
+ * @return string Response status code 201 (Created) if ok
*/
function put($uri, $data, $token='')
{
@@ -626,15 +612,16 @@
return $result;
}
- /*!
- @function copy
- @abstract Copy a file -allready on the server- into a new
location
- @param srcUri the current file location on the server. dont
forget the heading "/"
- @param destUri the destination location on the server. this is
*not* a full URL
- @param overwrite boolean - true to overwrite an existing
destination - overwrite by default
- @result Returns the HTTP status code
- @discussion
- returns response status code 204 (Unchanged) if ok
+ /**
+ * Copy a file -allready on the server- into a new location
+ *
+ * @param string $srcUri the current file location on the
server. dont forget the heading "/"
+ * @param string $destUri the destination location on the
server. this is *not* a full URL
+ * @param boolean $overwrite boolean - true to overwrite an
existing destination - overwrite by default
+ * @param integer $scope
+ * @param string $token
+ * @return Returns the HTTP status code
+ * @internal Returns response status code 204 (Unchanged) if ok
*/
function copy( $srcUri, $destUri, $overwrite=true, $scope=0,
$token='')
{
@@ -659,15 +646,15 @@
return $result;
}
- /*!
- @function move
- @abstract Moves a WEBDAV resource on the server
- @param srcUri the current file location on the server. dont
forget the heading "/"
- @param destUri the destination location on the server. this is
*not* a full URL
- @param overwrite boolean - true to overwrite an existing
destination (default is yes)
- @result Returns the HTTP status code
- @discussion
- returns response status code 204 (Unchanged) if ok
+ /**
+ * Moves a WEBDAV resource on the server
+ *
+ * @param string $srcUri The current file location on the
server. Dont forget the heading "/"
+ * @param string $destUri The destination location on the
server. This is *not* a full URL
+ * @param boolean $overwrite True to overwrite an existing
destination (default is yes)
+ * @param integer $scope
+ * @param string $token
+ * @return string HTTP status code - Response status code 204
(Unchanged) if ok
*/
function move( $srcUri, $destUri, $overwrite=true, $scope=0,
$token='' )
{
@@ -687,13 +674,13 @@
return $result;
}
- /*!
- @function delete
- @abstract Deletes a WEBDAV resource
- @param uri The URI we are deleting
- @result Returns the HTTP status code
- @discussion
- returns response status code 204 (Unchanged) if ok
+ /**
+ * Deletes a WEBDAV resource
+ *
+ * @param string $uri The URI we are deleting
+ * @param integer $scope
+ * @param string $token
+ * @return string HTTP status code - response status code 204
(Unchanged) if ok
*/
function delete( $uri, $scope=0, $token='')
{
@@ -712,11 +699,12 @@
return $result;
}
- /*!
- @function mkcol
- @abstract Creates a WEBDAV collection (AKA a directory)
- @param uri The URI to create
- @result Returns the HTTP status code
+ /**
+ * Creates a WEBDAV collection (AKA a directory)
+ *
+ * @param string $uri The URI to create
+ * @param string $token
+ * @return HTTP status code
*/
function mkcol( $uri, $token='' )
{
@@ -738,14 +726,14 @@
return $ret;
}
- /*!
- @function propfind
- @abstract Queries WEBDAV properties
- @param uri uri of resource whose properties we are changing
- @param scope Specifies how "deep" to search (0=just this
file/dir 1=subfiles/dirs etc)
- @result Returns the HTTP status code
- @discussion
- to get the result XML call get_body()
+ /**
+ * Queries WEBDAV properties
+ *
+ * @param string $uri URI of resource whose properties we are
changing
+ * @param integer $scope Specifies how "deep" to search (0=just
this file/dir 1=subfiles/dirs etc)
+ * @param boolean $is_dir
+ * @return Returns the HTTP status code
+ * @internal To get the result XML call get_body()
*/
function propfind( $uri, $scope=0, $id_dir = False )
{
@@ -790,17 +778,16 @@
}
}
- /*!
- @function proppatch
- @abstract Sets DAV properties
- @param uri uri of resource whose properties we are changing
- @param attributes An array of attributes and values.
- @param namespaces Extra namespace definitions that apply to the
properties
- @result Returns the HTTP status code
- @discussion
- To make DAV properties useful it helps to use a well
established XML dialect
- such as the "Dublin Core"
-
+ /**
+ * Sets DAV properties
+ *
+ * @param string $uri URI of resource whose properties we are
changing
+ * @param array $attributes Attribute,value pairs
+ * @param string $namespaces Extra namespace definitions that
apply to the properties
+ * @param string $token
+ * @param boolean $is_dir
+ * @return string HTTP status code
+ * @internal To make DAV properties useful it helps to use a
well established XML dialect such as the "Dublin Core"
*/
function proppatch($uri, $attributes, $namespaces='',
$token='',$is_dir = False)
{
@@ -816,7 +803,7 @@
//XXX if $uri is without an ending / and is a
directory ... what to do ???
$this->http_client->addHeader('If',
'<'.$uri.'>'.' (<'.$token.'>)');
}
- //Begin evil nastiness
+ // Begin evil nastiness
$davxml = '<?xml version="1.0" encoding="utf-8" ?>
<D:propertyupdate xmlns:D="DAV:"';
@@ -874,17 +861,14 @@
return $this->http_client->reply;
}
- /*!
- @function unlock
- @abstract unlocks a locked resource on the DAV server
- @param uri uri of the resource we are unlocking
- @param a 'token' for the lock (to get the token, do a propfind)
- @result true if successfull
- @discussion
- Not all DAV servers support locking (its in the RFC,
but many common
- DAV servers only implement "DAV class 1" (no locking)
- */
-
+ /**
+ * Unlocks a locked resource on the DAV server
+ *
+ * @param string $uri URI of the resource we are unlocking
+ * @param string $token A 'token' for the lock (to get the
token, do a propfind)
+ * @return boolean True if successful
+ * @internal Not all DAV servers support locking (its in the
RFC, but many common. DAV servers only implement "DAV class 1" (no locking)
+ */
function unlock($uri, $token)
{
if ( empty($token) )
@@ -934,16 +918,15 @@
}
}
- /*!
- @function lock
- @abstract locks a resource on the DAV server
- @param uri uri of the resource we are locking
- @param owner the 'owner' information for the lock (purely
informative)
- @param depth the depth to which we lock collections
- @result true if successfull
- @discussion
- Not all DAV servers support locking (its in the RFC,
but many common
- DAV servers only implement "DAV class 1" (no locking)
+ /**
+ * Locks a resource on the DAV server
+ *
+ * @param string $uri URI of the resource we are locking
+ * @param string $owner The 'owner' information for the lock
(purely informative)
+ * @param integer $depth The depth to which we lock collections
+ * @param string $timeout
+ * @return true If successfull
+ * @internal Not all DAV servers support locking (its in the
RFC, but many common DAV servers only implement "DAV class 1" (no locking)
*/
function lock($uri, $owner, $depth=0, $timeout='Infinite')
{
@@ -1002,15 +985,12 @@
}
}
- /*!
- @function options
- @abstract determines the optional HTTP features supported by a
server
- @param uri uri of the resource we are seeking options for (or *
for the whole server)
- @result Returns an array of option values
- @discussion
- Interesting options include "ACCESS" (whether you can
read a file) and
- DAV (DAV features)
-
+ /**
+ * Ddetermines the optional HTTP features supported by a server
+ *
+ * @param string $uri URI of the resource we are seeking options
for (or * for the whole server)
+ * @return array|boolean Option values or false
+ * @internal Interesting options include "ACCESS" (whether you
can read a file) and DAV (DAV features)
*/
function options($uri)
{
@@ -1027,16 +1007,12 @@
}
}
- /*!
- @function dav_features
- @abstract determines the features of a DAV server
- @param uri uri of resource whose properties we are changing
- @result Returns an array of option values
- @discussion
- Likely return codes include NULL (this isnt a dav
server!), 1
- (This is a dav server, supporting all standard DAV
features except locking)
- 2, (additionally supports locking (should also return
1)) and
- 'version-control' (this server supports versioning
extensions for this resource)
+ /**
+ * Determines the features of a DAV server
+ *
+ * @param string $uri URI of resource whose properties we are
changing
+ * @return array Option values or NULL
+ * @internal Likely return codes include NULL (this isnt a dav
server!), 1 (This is a dav server, supporting all standard DAV features except
locking) 2, (additionally supports locking (should also return 1)) and
'version-control' (this server supports versioning extensions for this resource)
*/
function dav_features($uri)
{
@@ -1053,26 +1029,20 @@
}
return $features;
}
-/**************************************************************
- RFC 3253 DeltaV versioning extensions
- **************************************************************
- These are 100% untested, and almost certainly dont work yet...
- eventually they will be made to work with subversion...
- */
+/* RFC 3253 DeltaV versioning extensions
+ These are 100% untested, and almost certainly dont work yet...
+ eventually they will be made to work with subversion...
+*/
- /*!
- @function report
- @abstract Report is a kind of extended PROPFIND - it queries
properties accros versions etc
- @param uri uri of resource whose properties we are changing
- @param report the type of report desired eg DAV:version-tree,
DAV:expand-property etc (see
http://greenbytes.de/tech/webdav/rfc3253.html#METHOD_REPORT)
- @param namespace any extra XML namespaces needed for the
specified properties
- @result Returns an array of option values
- @discussion
- From the relevent RFC:
- "A REPORT request is an extensible mechanism for
obtaining information about
- a resource. Unlike a resource property, which has a
single value, the value
- of a report can depend on additional information
specified in the REPORT
- request body and in the REPORT request headers."
+ /**
+ * Report is a kind of extended PROPFIND - it queries properties
accros versions etc.
+ *
+ * @param string $uri URI of resource whose properties we are
changing
+ * @param string $report The type of report desired eg
DAV:version-tree, DAV:expand-property etc (see
http://greenbytes.de/tech/webdav/rfc3253.html#METHOD_REPORT)
+ * @param array $properties
+ * @param string $namespaces Any extra XML namespaces needed for
the specified properties
+ * @return array Option values
+ * @internal From the relevent RFC: "A REPORT request is an
extensible mechanism for obtaining information about a resource. Unlike a
resource property, which has a single value, the value of a report can depend
on additional information specified in the REPORT request body and in the
REPORT request headers."
*/
function report($uri, $report, $properties, $namespaces='')
{
@@ -1105,20 +1075,18 @@
return $this->http_client->reply;
}
- /*
- * @function locks_save_session
- * @discussion : save the override_locks array in session file
+ /**
+ * Save the override_locks array in session file
*/
function propfind_save_session()
{
- //Save the overrided locks in the session
+ // Save the overrided locks in the session
$app = 'phpgwapi' ;
//$GLOBALS['phpgw_info']['flags']['currentapp'];
$this->session = $GLOBALS['phpgw']->session->appsession
('dav_props',$app, base64_encode(serialize($this->cached_propfind)));
}
/*
- * @function locks_restore_session
- * @discussion: restore the override_locks array from session,
use only in vfs_shared
+ * Restore the override_locks array from session, use only in
vfs_shared
*/
function propfind_restore_session()
{
@@ -1136,8 +1104,9 @@
}
/**
- * @function delete_uri_in_cache
- * @discusion Internal function for some cache deletion
+ * Some cache deletion
+ *
+ * @private
*/
function delete_uri_in_cache($uri)
{
====================================================
Index: phpgwapi/inc/class.gdbutton.inc.php
diff -u phpgwapi/inc/class.gdbutton.inc.php:1.4
phpgwapi/inc/class.gdbutton.inc.php:1.5
--- phpgwapi/inc/class.gdbutton.inc.php:1.4 Thu Jan 13 11:36:43 2005
+++ phpgwapi/inc/class.gdbutton.inc.php Tue Apr 26 09:43:08 2005
@@ -1,34 +1,22 @@
<?php
- /*******************************************************************\
- * phpGroupWare - GD Button *
- * http://www.phpgroupware.org *
- * *
- * Written by by Bettina Gille address@hidden *
- * *
- * Creates graphical buttons by using GD and TTF fonts *
- * Copyright (C) 2002 Bettina Gille *
- * ----------------------------------------------------------------- *
- * Some methods based on former class.graphics *
- * Copyright (C) 2001 Lars Kneschke *
- * ----------------------------------------------------------------- *
- * This library is part of the phpGroupWare API *
- * ----------------------------------------------------------------- *
- * This library 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. *
- * *
- * This program is distributed in the hope that it will be useful, *
- * but WITHOUT ANY WARRANTY; without even the implied warranty of *
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
- * General Public License for more details. *
- * *
- * You should have received a copy of the GNU General Public License *
- * along with this program; if not, write to the Free Software *
- * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. *
- \*******************************************************************/
- /* $Id$ */
-
+ /**
+ * Creates graphical buttons by using GD and TTF fonts
+ * @author Bettina Gille address@hidden
+ * @copyright Copyright (C) 2002-2005 Free Software Foundation, Inc.
http://www.fsf.org/
+ * @license http://www.gnu.org/licenses/gpl.html GNU General Public
License
+ * @package phpgwapi
+ * @subpackage gui
+ * @version $Id$
+ * @internal Some methods based on former class.graphics 2001 Lars
Kneschke
+ */
+
+
+ /**
+ * Creates graphical buttons by using GD and TTF fonts
+ *
+ * @package phpgwapi
+ * @subpackage gui
+ */
class gdbutton
{
var $ttf_font;
@@ -184,8 +172,9 @@
}
}
- // this function checks, if there is a variable $aaa_x and
$aaa_y
- // if so, it will create a new variable $aaa
+ /**
+ * This function checks, if there is a variable $aaa_x and
$aaa_y if so, it will create a new variable $aaa
+ */
function parseHTTPPostVars()
{
// execute only if libgd support is enabled
====================================================
Index: phpgwapi/inc/class.xmltool.inc.php
diff -u phpgwapi/inc/class.xmltool.inc.php:1.10
phpgwapi/inc/class.xmltool.inc.php:1.11
--- phpgwapi/inc/class.xmltool.inc.php:1.10 Thu Dec 30 06:47:31 2004
+++ phpgwapi/inc/class.xmltool.inc.php Tue Apr 26 09:43:08 2005
@@ -1,35 +1,38 @@
<?php
- /*******************************************************************\
- * phpGroupWare API - XML tools *
- * Written by Dan Kuykendall <address@hidden> *
- * and Bettina Gille address@hidden *
- * and Ralf Becker <address@hidden> *
- * Copyright (C) 2002 Dan Kuykendall, Bettina Gille, Ralf Becker *
- * ----------------------------------------------------------------- *
- * This library is part of the phpGroupWare API *
- * ----------------------------------------------------------------- *
- * This library 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. *
- * *
- * This program is distributed in the hope that it will be useful, *
- * but WITHOUT ANY WARRANTY; without even the implied warranty of *
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
- * General Public License for more details. *
- * *
- * You should have received a copy of the GNU General Public License *
- * along with this program; if not, write to the Free Software *
- * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. *
- \*******************************************************************/
- /* $Id$ */
-
+ /**
+ * XML tools
+ * @author Bettina Gille address@hidden
+ * @author Dan Kuykendall <address@hidden>
+ * @author Ralf Becker <address@hidden>
+ * @copyright Copyright (C) 2002-2005 Free Software Foundation, Inc.
http://www.fsf.org/
+ * @license http://www.gnu.org/licenses/gpl.html GNU General Public
License
+ * @package phpgwapi
+ * @subpackage xml
+ * @version $Id$
+ * @internal This class based on boGraph.php3 - Double Choco Latte -
Source Configuration Management System Copyright (C) 1999 Michael L. Dean &
Tim R. Norman
+ */
+
+
+ /**
+ * Convert variable to XML
+ *
+ * @param string $name
+ * @param string $data
+ * @return string XML string
+ */
function var2xml($name, $data)
{
$doc = new xmltool('root','','');
return $doc->import_var($name,$data,True,True);
}
+
+ /**
+ * XML tools
+ *
+ * @package phpgwapi
+ * @subpackage xml
+ */
class xmltool
{
/* for root nodes */
@@ -594,6 +597,13 @@
}
}
+
+ /**
+ * XML node
+ *
+ * @package phpgwapi
+ * @subpackage xml
+ */
class xmlnode extends xmltool
{
function xmlnode($name)
@@ -602,6 +612,13 @@
}
}
+
+ /**
+ * XML doc
+ *
+ * @package phpgwapi
+ * @subpackage xml
+ */
class xmldoc extends xmltool
{
function xmldoc($version = '1.0')
====================================================
Index: phpgwapi/inc/class.gdgraph.inc.php
diff -u phpgwapi/inc/class.gdgraph.inc.php:1.19
phpgwapi/inc/class.gdgraph.inc.php:1.20
--- phpgwapi/inc/class.gdgraph.inc.php:1.19 Thu Jan 13 11:36:43 2005
+++ phpgwapi/inc/class.gdgraph.inc.php Tue Apr 26 09:43:08 2005
@@ -1,36 +1,22 @@
<?php
- /*******************************************************************\
- * phpGroupWare - GD Graph *
- * http://www.phpgroupware.org *
- * This program is part of the GNU project, see http://www.gnu.org/
*
- * *
- * Written by Bettina Gille address@hidden *
- * *
- * Creates graphical statistics using GD graphics library *
- * Copyright (C) 2003,2004 Free Software Foundation, Inc. *
- * ----------------------------------------------------------------- *
- * This class based on boGraph.php3 *
- * Double Choco Latte - Source Configuration Management System *
- * Copyright (C) 1999 Michael L. Dean & Tim R. Norman *
- * ----------------------------------------------------------------- *
- * This library is part of the phpGroupWare API *
- * ----------------------------------------------------------------- *
- * This library 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. *
- * *
- * This program is distributed in the hope that it will be useful, *
- * but WITHOUT ANY WARRANTY; without even the implied warranty of *
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
- * General Public License for more details. *
- * *
- * You should have received a copy of the GNU General Public License *
- * along with this program; if not, write to the Free Software *
- * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. *
- \*******************************************************************/
- /* $Id$ */
-
+ /**
+ * Creates graphical statistics using GD graphics library
+ * @author Bettina Gille 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 phpgwapi
+ * @subpackage gui
+ * @version $Id$
+ * @internal This class based on boGraph.php3 - Double Choco Latte -
Source Configuration Management System Copyright (C) 1999 Michael L. Dean &
Tim R. Norman
+ */
+
+
+ /**
+ * Creates graphical statistics using GD graphics library
+ *
+ * @package phpgwapi
+ * @subpackage gui
+ */
class gdgraph
{
var $debug;
====================================================
Index: phpgwapi/inc/class.gdimage.inc.php
diff -u phpgwapi/inc/class.gdimage.inc.php:1.10
phpgwapi/inc/class.gdimage.inc.php:1.11
--- phpgwapi/inc/class.gdimage.inc.php:1.10 Thu Jan 13 11:36:43 2005
+++ phpgwapi/inc/class.gdimage.inc.php Tue Apr 26 09:43:08 2005
@@ -1,35 +1,22 @@
<?php
- /*******************************************************************\
- * phpGroupWare - GD Image *
- * http://www.phpgroupware.org *
- * *
- * Written by by Bettina Gille address@hidden *
- * *
- * Creates images using GD graphics library *
- * Copyright (C) 2003,2004 Free Software Foundation, Inc. *
- * ----------------------------------------------------------------- *
- * This class based on htmlGD.php3 *
- * Double Choco Latte - Source Configuration Management System *
- * Copyright (C) 1999 Michael L. Dean & Tim R. Norman *
- * ----------------------------------------------------------------- *
- * This library is part of the phpGroupWare API *
- * ----------------------------------------------------------------- *
- * This library 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. *
- * *
- * This program is distributed in the hope that it will be useful, *
- * but WITHOUT ANY WARRANTY; without even the implied warranty of *
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
- * General Public License for more details. *
- * *
- * You should have received a copy of the GNU General Public License *
- * along with this program; if not, write to the Free Software *
- * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. *
- \*******************************************************************/
- /* $Id$ */
-
+ /**
+ * Creates images using GD graphics library
+ * @author Bettina Gille 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 phpgwapi
+ * @subpackage gui
+ * @version $Id$
+ * @internal This class based on htmlGD.php3 - Double Choco Latte -
Source Configuration Management System - Copyright (C) 1999 Michael L. Dean &
Tim R. Norman
+ */
+
+
+ /**
+ * Creates images using GD graphics library
+ *
+ * @package phpgwapi
+ * @subpackage gui
+ */
class gdimage
{
var $filename;
====================================================
Index: phpgwapi/inc/class.xslttemplates.inc.php
diff -u phpgwapi/inc/class.xslttemplates.inc.php:1.19
phpgwapi/inc/class.xslttemplates.inc.php:1.20
--- phpgwapi/inc/class.xslttemplates.inc.php:1.19 Sat Apr 23 21:47:31 2005
+++ phpgwapi/inc/class.xslttemplates.inc.php Tue Apr 26 09:43:08 2005
@@ -13,7 +13,7 @@
if(!extension_loaded('xslt'))
{
- /* phpgroupware anyway would not work properly with
save_mode=on */
+ // phpgroupware anyway would not work properly with save_mode=on
if(ini_get('safe_mode'))
{
echo 'PHP CONFIGURATION - SAVE_MODE = ON. Unable to
load the xslt-extension. Please contact the system administrator.';
@@ -31,20 +31,38 @@
}
}
}
+
+
+ /**
+ * Include xml tool
+ */
require_once('class.xmltool.inc.php');
+
+ /**
+ * XSLT template engine
+ *
+ * @package phpgwapi
+ * @subpackage gui
+ */
class xslttemplates
{
var $rootdir = '';
var $prev_rootdir = '';
- /* The xslfiles will be loaded up and merged into $xsldata */
+ /**
+ * The xslfiles will be loaded up and merged into $xsldata
+ * @var array XSL files to load
+ */
var $xslfiles = Array();
var $xsldata = '';
- /* Users can set $vars which will be converted into xmldata
before xsl processing */
- /* Or they can generate their own XML data and set it directly
when they have */
- /* need for a more robust schema */
+ /**
+ * Users can set $vars which will be converted into xmldata
before xsl processing.
+ * Or they can generate their own XML data and set it directly
when they have
+ * need for a more robust schema.
+ * @var array Variables to convert into xml-data
+ */
var $vars = Array();
var $xmlvars = Array();
var $xmldata = '';
====================================================
Index: phpgwapi/inc/class.nextmatchs.inc.php
diff -u phpgwapi/inc/class.nextmatchs.inc.php:1.72
phpgwapi/inc/class.nextmatchs.inc.php:1.73
--- phpgwapi/inc/class.nextmatchs.inc.php:1.72 Wed Mar 30 15:34:00 2005
+++ phpgwapi/inc/class.nextmatchs.inc.php Tue Apr 26 09:43:07 2005
@@ -10,8 +10,13 @@
* @version $Id$
*/
+
+ /**
+ * Include nextmatchs XSLT
+ */
include_once(PHPGW_API_INC . '/class.nextmatchs_xslt.inc.php');
+
/**
* Handles limiting number of rows displayed
*
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Phpgroupware-cvs] phpgwapi/inc class.nextmatchs_xslt.inc.php, 1.2 class.http_dav_client.inc.php, 1.12 class.gdbutton.inc.php, 1.5 class.xmltool.inc.php, 1.11 class.gdgraph.inc.php, 1.20 class.gdimage.inc.php, 1.11 class.xslttemplates.inc.php, 1.20 class.nextmatchs.inc.php, 1.73,
powerstat <=
- Prev by Date:
[Phpgroupware-cvs] phpgwapi/inc class.http_dav_client.inc.php,1.11
- Next by Date:
[Phpgroupware-cvs] phpgwapi/inc class.translation_sql.inc.php, 1.20 class.sql_oracle.inc.php, 1.3 class.sql_entity.inc.php, 1.3 class.sql_pgsql.inc.php, 1.3 class.Template_experimental.inc.php, 1.5 class.sessions_php4.inc.php, 1.23 class.service_notes.inc.php, 1.6 class.service_schedule.inc.php, 1.5 class.sql_mssql.inc.php, 1.3 class.sql_sapdb.inc.php, 1.3 class.vfs_sql.inc.php, 1.32
- Previous by thread:
[Phpgroupware-cvs] phpgwapi/inc class.http_dav_client.inc.php,1.11
- Next by thread:
[Phpgroupware-cvs] phpgwapi/inc class.translation_sql.inc.php, 1.20 class.sql_oracle.inc.php, 1.3 class.sql_entity.inc.php, 1.3 class.sql_pgsql.inc.php, 1.3 class.Template_experimental.inc.php, 1.5 class.sessions_php4.inc.php, 1.23 class.service_notes.inc.php, 1.6 class.service_schedule.inc.php, 1.5 class.sql_mssql.inc.php, 1.3 class.sql_sapdb.inc.php, 1.3 class.vfs_sql.inc.php, 1.32
- Index(es):