From: <var...@us...> - 2025-02-09 18:37:41
|
Revision: 11085 http://sourceforge.net/p/phpwiki/code/11085 Author: vargenau Date: 2025-02-09 18:37:38 +0000 (Sun, 09 Feb 2025) Log Message: ----------- Upgrade PEAR Modified Paths: -------------- trunk/lib/pear/Cache/Application.php trunk/lib/pear/Cache/Cache.php trunk/lib/pear/Cache/Container/db.php trunk/lib/pear/Cache/Container/dbx.php trunk/lib/pear/Cache/Container/file.php trunk/lib/pear/Cache/Container/imgfile.php trunk/lib/pear/Cache/Container/mdb.php trunk/lib/pear/Cache/Container/msession.php trunk/lib/pear/Cache/Container/phplib.php trunk/lib/pear/Cache/Container/shm.php trunk/lib/pear/Cache/Container/trifile.php trunk/lib/pear/Cache/Container.php trunk/lib/pear/Cache/Error.php trunk/lib/pear/Cache/Function.php trunk/lib/pear/Cache/Graphics.php trunk/lib/pear/Cache/HTTP_Request.php trunk/lib/pear/Cache/Output.php trunk/lib/pear/Cache/OutputCompression.php trunk/lib/pear/Cache.php trunk/lib/pear/DB/common.php trunk/lib/pear/DB/dbase.php trunk/lib/pear/DB/fbsql.php trunk/lib/pear/DB/ibase.php trunk/lib/pear/DB/ifx.php trunk/lib/pear/DB/msql.php trunk/lib/pear/DB/mssql.php trunk/lib/pear/DB/mysql.php trunk/lib/pear/DB/mysqli.php trunk/lib/pear/DB/oci8.php trunk/lib/pear/DB/odbc.php trunk/lib/pear/DB/pgsql.php trunk/lib/pear/DB/sqlite.php trunk/lib/pear/DB/sqlite3.php trunk/lib/pear/DB/storage.php trunk/lib/pear/DB/sybase.php trunk/lib/pear/DB.php trunk/lib/pear/JSON.php trunk/lib/pear/PEAR.php Modified: trunk/lib/pear/Cache/Application.php =================================================================== --- trunk/lib/pear/Cache/Application.php 2024-04-16 08:11:34 UTC (rev 11084) +++ trunk/lib/pear/Cache/Application.php 2025-02-09 18:37:38 UTC (rev 11085) @@ -15,8 +15,6 @@ // +----------------------------------------------------------------------+ // | Authors: Richard Heyes <ri...@ph...> | // +----------------------------------------------------------------------+ -// -// $Id: Application.php 178289 2005-01-26 09:47:28Z dufuz $ require_once 'lib/pear/Cache.php'; @@ -23,7 +21,7 @@ // Application level variables // // Purpose -// Variables that are persisent across all user sessions, +// Variables that are persistent across all user sessions, // not just a specific user ala normal sessions. // // Usage: @@ -78,8 +76,8 @@ var $registered_vars; /** - * @param string Name of container class - * @param array Array with container class options + * @param string $container Name of container class + * @param array $container_options Array with container class options */ function __construct($container = 'file', $container_options = array('cache_dir' => '/tmp/', 'filename_prefix' => 'cache_'), $id = 'application_var', $group = 'application_cache') { @@ -124,8 +122,8 @@ * * Registers a variable to be stored. * - * @param string Name of variable to register - * @param mixed Optional data to store + * @param string $varname Name of variable to register + * @param mixed $data Optional data to store */ function register($varname, $data = null) { @@ -141,7 +139,7 @@ * * Unregisters a variable from being stored. * - * @param string Name of variable to unregister + * @param string $varname Name of variable to unregister */ function unregister($varname) { Modified: trunk/lib/pear/Cache/Cache.php =================================================================== --- trunk/lib/pear/Cache/Cache.php 2024-04-16 08:11:34 UTC (rev 11084) +++ trunk/lib/pear/Cache/Cache.php 2025-02-09 18:37:38 UTC (rev 11085) @@ -15,8 +15,6 @@ // | Authors: Ulf Wendel <ulf...@ph...> | // | Sebastian Bergmann <sb...@se...> | // +----------------------------------------------------------------------+ -// -// $Id: Cache.php 267047 2008-10-07 08:58:46Z dufuz $ require_once 'lib/pear/PEAR.php'; require_once 'lib/pear/Cache/Error.php'; @@ -28,7 +26,7 @@ * cache script runs. The idea behind the cache is quite simple. If you have * the same input parameters for whatever tasks/algorithm you use you'll * usually get the same output. So why not caching templates, functions calls, -* graphic generation etc. Caching certain actions e.g. XSLT tranformations +* graphic generation etc. Caching certain actions e.g. XSLT transformations * saves you lots of time. * * The design of the cache reminds of PHPLibs session implementation. A @@ -59,7 +57,6 @@ * bad circumstances (especially with the file container) * * @author Ulf Wendel <ulf...@ph...> -* @version $Id: Cache.php 267047 2008-10-07 08:58:46Z dufuz $ * @package Cache * @access public */ @@ -123,8 +120,8 @@ /** * - * @param string Name of container class - * @param array Array with container class options + * @param string $container Name of container class + * @param array $container_options Array with container class options */ function __construct($container, $container_options = '') { @@ -157,7 +154,7 @@ /** * Enables or disables caching. * - * @param boolean The new caching state. + * @param boolean $state The new caching state. * @access public */ function setCaching($state) @@ -168,8 +165,8 @@ /** * Returns the requested dataset it if exists and is not expired * - * @param string dataset ID - * @param string cache group + * @param string $id dataset ID + * @param string $group cache group * @return mixed cached data or null on failure * @access public */ @@ -188,10 +185,10 @@ /** * Stores the given data in the cache. * - * @param string dataset ID used as cache identifier - * @param mixed data to cache - * @param integer lifetime of the cached data in seconds - 0 for endless - * @param string cache group + * @param string $id dataset ID used as cache identifier + * @param mixed $data data to cache + * @param integer $expires lifetime of the cached data in seconds - 0 for endless + * @param string $group cache group * @return boolean * @access public */ @@ -206,11 +203,11 @@ /** * Stores a dataset with additional userdefined data. * - * @param string dataset ID - * @param mixed data to store - * @param string additional userdefined data - * @param mixed userdefined expire date - * @param string cache group + * @param string $id dataset ID + * @param mixed $cachedata data to store + * @param string $userdata additional userdefined data + * @param mixed $expires userdefined expire date + * @param string $group cache group * @return boolean * @throws Cache_Error * @access public @@ -227,8 +224,8 @@ /** * Loads the given ID from the cache. * - * @param string dataset ID - * @param string cache group + * @param string $id dataset ID + * @param string $group cache group * @return mixed cached data or null on failure * @access public */ @@ -243,8 +240,8 @@ /** * Returns the userdata field of a cached data set. * - * @param string dataset ID - * @param string cache group + * @param string $id dataset ID + * @param string $group cache group * @return string userdata * @access public * @see extSave() @@ -260,8 +257,8 @@ /** * Removes the specified dataset from the cache. * - * @param string dataset ID - * @param string cache group + * @param string $id dataset ID + * @param string $group cache group * @return boolean * @access public */ @@ -276,7 +273,7 @@ /** * Flushes the cache - removes all data from it * - * @param string cache group, if empty all groups will be flashed + * @param string $group cache group, if empty all groups will be flashed * @return integer number of removed datasets */ function flush($group = 'default') @@ -292,8 +289,8 @@ * * Note: this does not say that the cached data is not expired! * - * @param string dataset ID - * @param string cache group + * @param string $id dataset ID + * @param string $group cache group * @return boolean * @access public */ @@ -308,9 +305,9 @@ /** * Checks if a dataset is expired * - * @param string dataset ID - * @param string cache group - * @param integer maximum age for the cached data in seconds - 0 for endless + * @param string $id dataset ID + * @param string $group cache group + * @param integer $max_age maximum age for the cached data in seconds - 0 for endless * If the cached data is older but the given lifetime it will * be removed from the cache. You don't have to provide this * argument if you call isExpired(). Every dataset knows @@ -333,7 +330,7 @@ * This is a quick but dirty hack to get a "unique" ID for a any kind of variable. * ID clashes might occur from time to time although they are extreme unlikely! * - * @param mixed variable to generate a ID for + * @param mixed $variable variable to generate a ID for * @return string "unique" ID * @access public */ @@ -346,7 +343,7 @@ /** * Calls the garbage collector of the storage object with a certain probability * - * @param boolean Force a garbage collection run? + * @param boolean $force Force a garbage collection run? * @see $gc_probability, $gc_time */ function garbageCollection($force = false) Modified: trunk/lib/pear/Cache/Container/db.php =================================================================== --- trunk/lib/pear/Cache/Container/db.php 2024-04-16 08:11:34 UTC (rev 11084) +++ trunk/lib/pear/Cache/Container/db.php 2025-02-09 18:37:38 UTC (rev 11085) @@ -16,8 +16,6 @@ // | Sebastian Bergmann <sb...@se...> | // | Chuck Hagenbuch <ch...@ho...> | // +----------------------------------------------------------------------+ -// -// $Id: db.php 178288 2005-01-26 09:42:30Z dufuz $ require_once 'lib/pear/DB.php'; require_once 'lib/pear/Cache/Container.php'; @@ -29,7 +27,7 @@ * the tables shown. As far as I know there's no large binary * type in SQL-92 or SQL-99. Postgres seems to lack any * BLOB or TEXT type, for MS-SQL you could use IMAGE, don't know -* about other databases. Please add sugestions for other databases to +* about other databases. Please add suggestions for other databases to * the inline docs. * * The field 'changed' has no meaning for the Cache itself. It's just there @@ -52,7 +50,6 @@ * ) * * @author Sebastian Bergmann <sb...@se...> -* @version $Id: db.php 178288 2005-01-26 09:42:30Z dufuz $ * @package Cache */ class Cache_Container_db extends Cache_Container Modified: trunk/lib/pear/Cache/Container/dbx.php =================================================================== --- trunk/lib/pear/Cache/Container/dbx.php 2024-04-16 08:11:34 UTC (rev 11084) +++ trunk/lib/pear/Cache/Container/dbx.php 2025-02-09 18:37:38 UTC (rev 11085) @@ -14,10 +14,7 @@ // +----------------------------------------------------------------------+ // | Authors: Christian Stocker <ch...@ph...> | // +----------------------------------------------------------------------+ -// -// $Id: dbx.php 268860 2008-11-12 14:56:26Z clockwerx $ - require_once 'lib/pear/Cache/Container.php'; /** @@ -27,7 +24,7 @@ * the tables shown. As far as I know there's no large binary * type in SQL-92 or SQL-99. Postgres seems to lack any * BLOB or TEXT type, for MS-SQL you could use IMAGE, don't know -* about other databases. Please add sugestions for other databases to +* about other databases. Please add suggestions for other databases to * the inline docs. * * The field 'changed' has no meaning for the Cache itself. It's just there @@ -50,7 +47,6 @@ * ) * * @author Christian Stocker <ch...@ph...> -* @version $Id: dbx.php 268860 2008-11-12 14:56:26Z clockwerx $ * @package Cache */ class Cache_Container_dbx extends Cache_Container Modified: trunk/lib/pear/Cache/Container/file.php =================================================================== --- trunk/lib/pear/Cache/Container/file.php 2024-04-16 08:11:34 UTC (rev 11084) +++ trunk/lib/pear/Cache/Container/file.php 2025-02-09 18:37:38 UTC (rev 11085) @@ -15,8 +15,6 @@ // | Authors: Ulf Wendel <ulf...@ph...> | // | Sebastian Bergmann <sb...@se...> | // +----------------------------------------------------------------------+ -// -// $Id: file.php 293864 2010-01-23 03:49:21Z clockwerx $ require_once 'lib/pear/Cache/Container.php'; @@ -24,7 +22,6 @@ * Stores cache contents in a file. * * @author Ulf Wendel <ulf...@ph...> -* @version $Id: file.php 293864 2010-01-23 03:49:21Z clockwerx $ */ class Cache_Container_file extends Cache_Container { @@ -52,14 +49,14 @@ * Filename prefix for cache files. * * You can use the filename prefix to implement a "domain" based cache or just - * to give the files a more descriptive name. The word "domain" is borroed from - * a user authentification system. One user id (cached dataset with the ID x) - * may exists in different domains (different filename prefix). You might want + * to give the files a more descriptive name. The word "domain" is borrowed from + * a user authentication system. One user id (cached dataset with the ID x) + * may exist in different domains (different filename prefix). You might want * to use this to have different cache values for a production, development and * quality assurance system. If you want the production cache not to be influenced * by the quality assurance activities, use different filename prefixes for them. * - * I personally don't think that you'll never need this, but 640kb happend to be + * I personally don't think that you'll never need this, but 640kb happened to be * not enough, so... you know what I mean. If you find a useful application of the * feature please update this inline doc. * @@ -96,9 +93,9 @@ var $max_userdata_linelength = 257; /** - * Creates the cache directory if neccessary + * Creates the cache directory if necessary * - * @param array Config options: ["cache_dir" => ..., "filename_prefix" => ...] + * @param array $options Config options: ["cache_dir" => ..., "filename_prefix" => ...] */ function __construct($options = '') { @@ -122,7 +119,7 @@ $this->entries = array(); $this->group_dirs = array(); - } // end func contructor + } // end func constructor function fetch($id, $group) { @@ -134,7 +131,7 @@ if (!file_exists($file)) { return array(null, null, null); } - // retrive the content + // retrieve the content if (!($fh = @fopen($file, 'rb'))) { return new Cache_Error("Can't access cache file '$file'. Check access rights and path.", __FILE__, __LINE__); } @@ -255,11 +252,11 @@ * Garbage collection for files is a rather "expensive", "long time" * operation. All files in the cache directory have to be examined which * means that they must be opened for reading, the expiration date has to be - * read from them and if neccessary they have to be unlinked (removed). + * read from them and if necessary they have to be unlinked (removed). * If you have a user comment for a good default gc probability please add it to * to the inline docs. * - * @param integer Maximum lifetime in seconds of an no longer used/touched entry + * @param integer $maxlifetime Maximum lifetime in seconds of an no longer used/touched entry * @throws Cache_Error */ function garbageCollection($maxlifetime) @@ -295,8 +292,8 @@ /** * Does the recursive gc procedure, protected. * - * @param integer Maximum lifetime in seconds of an no longer used/touched entry - * @param string directory to examine - don't sets this parameter, it's used for a + * @param integer $maxlifetime Maximum lifetime in seconds of an no longer used/touched entry + * @param string $dir directory to examine - don't sets this parameter, it's used for a * recursive function call! * @throws Cache_Error */ @@ -345,8 +342,8 @@ /** * Returns the filename for the specified id. * - * @param string dataset ID - * @param string cache group + * @param string $id dataset ID + * @param string $group cache group * @return string full filename with the path * @access public */ @@ -373,7 +370,7 @@ /** * Deletes a directory and all files in it. * - * @param string directory + * @param string $dir directory * @return integer number of removed files * @throws Cache_Error */ Modified: trunk/lib/pear/Cache/Container/imgfile.php =================================================================== --- trunk/lib/pear/Cache/Container/imgfile.php 2024-04-16 08:11:34 UTC (rev 11084) +++ trunk/lib/pear/Cache/Container/imgfile.php 2025-02-09 18:37:38 UTC (rev 11085) @@ -22,7 +22,6 @@ * Stores cache contents in a file. * * @author Ulf Wendel <ulf...@ph...> -* @version */ class Cache_Container_file extends Cache_Container { @@ -69,7 +68,7 @@ /** * Creates the cache directory if neccessary * - * @param array Config options: ["cache_dir" => ..., "filename_prefix" => ...] + * @param array $options Config options: ["cache_dir" => ..., "filename_prefix" => ...] */ function __construct($options = '') { if (is_array($options)) @@ -219,7 +218,7 @@ * If you have a user comment for a good default gc probability please add it to * to the inline docs. * - * @param integer Maximum lifetime in seconds of an no longer used/touched entry + * @param integer $maxlifetime Maximum lifetime in seconds of an no longer used/touched entry * @throws Cache_Error */ function garbageCollection($maxlifetime) { @@ -253,8 +252,8 @@ /** * Does the recursive gc procedure, protected. * - * @param integer Maximum lifetime in seconds of an no longer used/touched entry - * @param string directory to examine - don't sets this parameter, it's used for a + * @param integer $maxlifetime Maximum lifetime in seconds of an no longer used/touched entry + * @param string $dir directory to examine - don't sets this parameter, it's used for a * recursive function call! * @throws Cache_Error */ @@ -315,8 +314,8 @@ /** * Returns the filename for the specified id. * - * @param string dataset ID - * @param string cache group + * @param string $id dataset ID + * @param string $group cache group * @return string full filename with the path * @access public */ @@ -339,7 +338,7 @@ /** * Deletes a directory and all files in it. * - * @param string directory + * @param string $dir directory * @return integer number of removed files * @throws Cache_Error */ Modified: trunk/lib/pear/Cache/Container/mdb.php =================================================================== --- trunk/lib/pear/Cache/Container/mdb.php 2024-04-16 08:11:34 UTC (rev 11084) +++ trunk/lib/pear/Cache/Container/mdb.php 2025-02-09 18:37:38 UTC (rev 11085) @@ -17,8 +17,6 @@ // +----------------------------------------------------------------------+ // | Author: Lorenzo Alberton <l.alberton at quipo.it> | // +----------------------------------------------------------------------+ -// -// $Id: mdb.php 174777 2004-12-15 09:09:33Z dufuz $ require_once 'lib/pear/MDB.php'; require_once 'lib/pear/Cache/Container.php'; @@ -61,7 +59,6 @@ * ------------------------------------------ * * @author Lorenzo Alberton <l.alberton at quipo.it> -* @version $Id: mdb.php 174777 2004-12-15 09:09:33Z dufuz $ * @package Cache */ class Cache_Container_mdb extends Cache_Container @@ -84,7 +81,7 @@ /** * Constructor * - * @param mixed Array with connection info or dsn string + * @param mixed $options Array with connection info or dsn string */ function __construct($options) { @@ -102,8 +99,8 @@ /** * Fetch in the db the data that matches input parameters * - * @param string dataset ID - * @param string cache group + * @param string $id dataset ID + * @param string $group cache group * @return mixed dataset value or null/Cache_Error on failure * @access public */ @@ -182,11 +179,11 @@ * If dataset_ID already exists, overwrite it with new data, * else insert data in a new record. * - * @param string dataset ID - * @param mixed data to be cached - * @param integer expiration time - * @param string cache group - * @param string userdata + * @param string $id dataset ID + * @param mixed $data data to be cached + * @param integer $expires expiration time + * @param string $group cache group + * @param string $userdata userdata * @access public */ function save($id, $data, $expires, $group, $userdata) @@ -256,8 +253,8 @@ /** * Removes a dataset from the database * - * @param string dataset ID - * @param string cache group + * @param string $id dataset ID + * @param string $group cache group */ function remove($id, $group) { @@ -278,7 +275,7 @@ * Remove all cached data for a certain group, or empty * the cache table if no group is specified. * - * @param string cache group + * @param string $group cache group */ function flush($group = '') { @@ -301,8 +298,8 @@ /** * Check if a dataset ID/group exists. * - * @param string dataset ID - * @param string cache group + * @param string $id dataset ID + * @param string $group cache group * @return boolean */ function idExists($id, $group) @@ -327,7 +324,7 @@ /** * Garbage collector. * - * @param int maxlifetime + * @param int $maxlifetime maxlifetime */ function garbageCollection($maxlifetime) { Modified: trunk/lib/pear/Cache/Container/msession.php =================================================================== --- trunk/lib/pear/Cache/Container/msession.php 2024-04-16 08:11:34 UTC (rev 11084) +++ trunk/lib/pear/Cache/Container/msession.php 2025-02-09 18:37:38 UTC (rev 11085) @@ -14,8 +14,6 @@ // +----------------------------------------------------------------------+ // | Authors: Ulf Wendel <ulf...@ph...> | // +----------------------------------------------------------------------+ -// -// $Id: msession.php 178289 2005-01-26 09:47:28Z dufuz $ require_once 'lib/pear/Cache/Container.php'; @@ -25,7 +23,6 @@ * WARNING: experimental, untested * * @author Ulf Wendel <ulf...@ph...> -* @version $Id: msession.php 178289 2005-01-26 09:47:28Z dufuz $ */ class Cache_Container_msession extends Cache_Container { @@ -199,7 +196,7 @@ * * Note: garbage collection should cause lot's of network traffic. * - * @param integer Maximum lifetime in seconds of an no longer used/touched entry + * @param integer $maxlifetime Maximum lifetime in seconds of an no longer used/touched entry * @throws Cache_Error */ function garbageCollection($maxlifetime) Modified: trunk/lib/pear/Cache/Container/phplib.php =================================================================== --- trunk/lib/pear/Cache/Container/phplib.php 2024-04-16 08:11:34 UTC (rev 11084) +++ trunk/lib/pear/Cache/Container/phplib.php 2025-02-09 18:37:38 UTC (rev 11085) @@ -15,8 +15,6 @@ // | Authors: Ulf Wendel <ulf...@ph...> | // | Sebastian Bergmann <sb...@se...> | // +----------------------------------------------------------------------+ -// -// $Id: phplib.php 174777 2004-12-15 09:09:33Z dufuz $ require_once 'lib/pear/Cache/Container.php'; @@ -27,7 +25,7 @@ * the tables shown. As far as I know there's no large binary * type in SQL-92 or SQL-99. Postgres seems to lack any * BLOB or TEXT type, for MS-SQL you could use IMAGE, don't know -* about other databases. Please add sugestions for other databases to +* about other databases. Please add suggestions for other databases to * the inline docs. * * The field 'changed' is used by the garbage collection. Depending on @@ -50,7 +48,6 @@ * * * @author Ulf Wendel <ulf...@ph...>, Sebastian Bergmann <sb...@se...> -* @version $Id: phplib.php 174777 2004-12-15 09:09:33Z dufuz $ * @package Cache * @see save() */ @@ -104,7 +101,7 @@ /** * Creates an instance of a phplib db class to use it for storage. * - * @param mixed If empty the object tries to used the + * @param mixed $options If empty the object tries to used the * preconfigured class variables. If given it * must be an array with: * db_class => name of the DB class to use Modified: trunk/lib/pear/Cache/Container/shm.php =================================================================== --- trunk/lib/pear/Cache/Container/shm.php 2024-04-16 08:11:34 UTC (rev 11084) +++ trunk/lib/pear/Cache/Container/shm.php 2025-02-09 18:37:38 UTC (rev 11085) @@ -15,8 +15,6 @@ // | Authors: Ulf Wendel <ulf...@ph...> | // | Sebastian Bergmann <sb...@se...> | // +----------------------------------------------------------------------+ -// -// $Id: shm.php 186977 2005-05-25 10:00:41Z dufuz $ require_once 'lib/pear/Cache/Container.php'; @@ -29,7 +27,6 @@ * caching algorithm using PHP. * * @author Ulf Wendel <ulf...@ph...> -* @version $Id: shm.php 186977 2005-05-25 10:00:41Z dufuz $ * @package Cache */ class Cache_Container_shm extends Cache_Container @@ -104,7 +101,7 @@ /** * Creates a shared memory container * - * @param array shm_key, sem_key, shm_size, sem_perm, shm_perm + * @param array $options shm_key, sem_key, shm_size, sem_perm, shm_perm */ function __construct($options = '') { Modified: trunk/lib/pear/Cache/Container/trifile.php =================================================================== --- trunk/lib/pear/Cache/Container/trifile.php 2024-04-16 08:11:34 UTC (rev 11084) +++ trunk/lib/pear/Cache/Container/trifile.php 2025-02-09 18:37:38 UTC (rev 11085) @@ -16,8 +16,6 @@ // | Sebastian Bergmann <sb...@se...> | // | Ian Eure <ie...@ph...> | // +----------------------------------------------------------------------+ -// -// $Id: trifile.php 184642 2005-04-18 19:05:01Z dufuz $ require_once 'lib/pear/Cache/Container/file.php'; Modified: trunk/lib/pear/Cache/Container.php =================================================================== --- trunk/lib/pear/Cache/Container.php 2024-04-16 08:11:34 UTC (rev 11084) +++ trunk/lib/pear/Cache/Container.php 2025-02-09 18:37:38 UTC (rev 11085) @@ -16,8 +16,6 @@ // | Sebastian Bergmann <sb...@se...> | // | Christian Stocker <ch...@ph...> | // +----------------------------------------------------------------------+ -// -// $Id: Container.php 293863 2010-01-23 03:46:52Z clockwerx $ require_once 'lib/pear/Cache/Error.php'; @@ -39,7 +37,6 @@ * not recommended! * * @author Ulf Wendel <ulf...@ph...> -* @version $Id: Container.php 293863 2010-01-23 03:46:52Z clockwerx $ * @package Cache * @access public * @abstract @@ -48,7 +45,7 @@ { /** - * Flag indicating wheter to preload datasets. + * Flag indicating whether to preload datasets. * * See the class description for more details. * @@ -129,7 +126,7 @@ /** - * Options that can be set in every derived class using it's constructor. + * Options that can be set in every derived class using its constructor. * * @var array */ @@ -139,8 +136,8 @@ /** * Loads a dataset from the cache. * - * @param string dataset ID - * @param string cache group + * @param string $id dataset ID + * @param string $group cache group * @return mixed dataset value or null on failure * @access public */ @@ -165,8 +162,8 @@ /** * Returns the userdata field of a cached data set. * - * @param string dataset ID - * @param string cache group + * @param string $id dataset ID + * @param string $group cache group * @return string userdata * @access public */ @@ -191,9 +188,9 @@ /** * Checks if a dataset is expired. * - * @param string dataset ID - * @param string cache group - * @param integer maximum age timestamp + * @param string $id dataset ID + * @param string $group cache group + * @param integer $max_age maximum age timestamp * @return boolean * @access public */ @@ -236,8 +233,8 @@ /** * Checks if a dataset is cached. * - * @param string dataset ID - * @param string cache group + * @param string $id dataset ID + * @param string $group cache group * @return boolean */ function isCached($id, $group) @@ -258,8 +255,8 @@ /** * Fetches a dataset from the storage medium. * - * @param string dataset ID - * @param string cache group + * @param string $id dataset ID + * @param string $group cache group * @return array format: [expire date, cached data, user data] * @throws Cache_Error * @abstract @@ -272,11 +269,11 @@ /** * Stores a dataset. * - * @param string dataset ID - * @param mixed data to store - * @param mixed userdefined expire date - * @param string cache group - * @param string additional userdefined data + * @param string $id dataset ID + * @param mixed $data data to store + * @param mixed $expire userdefined expire date + * @param string $group cache group + * @param string $userdata additional userdefined data * @return boolean * @throws Cache_Error * @access public @@ -293,8 +290,8 @@ /** * Removes a dataset. * - * @param string dataset ID - * @param string cache group + * @param string $id dataset ID + * @param string $group cache group * @return boolean * @access public * @abstract @@ -308,7 +305,7 @@ /** * Flushes the cache - removes all caches datasets from the cache. * - * @param string If a cache group is given only the group will be flushed + * @param string $group If a cache group is given only the group will be flushed * @return integer Number of removed datasets, -1 on failure * @access public * @abstract @@ -322,8 +319,8 @@ /** * Checks if a dataset exists. * - * @param string dataset ID - * @param string cache group + * @param string $id dataset ID + * @param string $group cache group * @return boolean * @access public * @abstract @@ -350,8 +347,8 @@ /** * Does a speculative preload of a dataset * - * @param string dataset ID - * @param string cache group + * @param string $id dataset ID + * @param string $group cache group * @return boolean */ function preload($id, $group) @@ -381,13 +378,13 @@ * Flushes the internal preload buffer. * * save(), remove() and flush() must call this method - * to preevent differences between the preloaded values and + * to prevent differences between the preloaded values and * the real cache contents. * - * @param string dataset ID, if left out the preloaded values will be flushed. + * @param string $id dataset ID, if left out the preloaded values will be flushed. * If given the preloaded values will only be flushed if they are * equal to the given id and group - * @param string cache group + * @param string $group cache group * @see preload() */ function flushPreload($id = '', $group = 'default') @@ -406,8 +403,8 @@ /** * Imports the requested datafields as object variables if allowed * - * @param array List of fields to be imported as object variables - * @param array List of allowed datafields + * @param array $requested List of fields to be imported as object variables + * @param array $allowed List of allowed datafields */ function setOptions($requested, $allowed) { @@ -421,7 +418,7 @@ /** * Encodes the data for the storage container. * - * @var mixed data to encode + * @return mixed data to encode */ function encode($data) { @@ -436,7 +433,7 @@ /** * Decodes the data from the storage container. * - * @var mixed + * @return mixed */ function decode($data) { @@ -451,7 +448,7 @@ /** * Translates human readable/relative times in unixtime * - * @param mixed can be in the following formats: + * @param mixed $expires can be in the following formats: * human readable : yyyymmddhhmm[ss]] eg: 20010308095100 * relative in seconds (1) : +xx eg: +10 * relative in seconds (2) : x < 946681200 eg: 10 @@ -471,10 +468,10 @@ } elseif ($expires < 100000000000) { //if integer is < 100000000000 (= in 3140 years), // it must be an absolut unixtime - // (since the "human readable" definition asks for a higher number) + // (since the "human-readable" definition asks for a higher number) return $expires; } else { - // else it's "human readable"; + // else it's "human-readable"; $year = substr($expires, 0, 4); $month = substr($expires, 4, 2); $day = substr($expires, 6, 2); Modified: trunk/lib/pear/Cache/Error.php =================================================================== --- trunk/lib/pear/Cache/Error.php 2024-04-16 08:11:34 UTC (rev 11084) +++ trunk/lib/pear/Cache/Error.php 2025-02-09 18:37:38 UTC (rev 11085) @@ -14,8 +14,6 @@ // +----------------------------------------------------------------------+ // | Authors: Ulf Wendel <ulf...@ph...> | // +----------------------------------------------------------------------+ -// -// $Id: Error.php 174777 2004-12-15 09:09:33Z dufuz $ require_once 'lib/pear/PEAR.php'; @@ -38,9 +36,9 @@ /** * Creates an cache error object. * - * @param string error message - * @param string file where the error occured - * @param string linenumber where the error occured + * @param string $msg error message + * @param string $file file where the error occurred + * @param string $line line number where the error occurred */ function __construct($msg, $file = __FILE__, $line = __LINE__) { Modified: trunk/lib/pear/Cache/Function.php =================================================================== --- trunk/lib/pear/Cache/Function.php 2024-04-16 08:11:34 UTC (rev 11084) +++ trunk/lib/pear/Cache/Function.php 2025-02-09 18:37:38 UTC (rev 11085) @@ -14,8 +14,6 @@ // +----------------------------------------------------------------------+ // | Authors: Sebastian Bergmann <sb...@se...> | // +----------------------------------------------------------------------+ -// -// $Id: Function.php 174777 2004-12-15 09:09:33Z dufuz $ require_once 'lib/pear/Cache.php'; @@ -65,7 +63,6 @@ * @module Function_Cache * @modulegroup Function_Cache * @package Cache -* @version $Revision: 174777 $ * @access public */ class Cache_Function extends Cache @@ -75,9 +72,9 @@ /** * Constructor * - * @param string Name of container class - * @param array Array with container class options - * @param integer Number of seconds for which to cache + * @param string $container Name of container class + * @param array $container_options Array with container class options + * @param integer $expires Number of seconds for which to cache */ function __construct($container = 'file', $container_options = array('cache_dir' => '.', Modified: trunk/lib/pear/Cache/Graphics.php =================================================================== --- trunk/lib/pear/Cache/Graphics.php 2024-04-16 08:11:34 UTC (rev 11084) +++ trunk/lib/pear/Cache/Graphics.php 2025-02-09 18:37:38 UTC (rev 11085) @@ -14,8 +14,6 @@ // +----------------------------------------------------------------------+ // | Authors: Ulf Wendel <ulf...@ph...> | // +----------------------------------------------------------------------+ -// -// $Id: Graphics.php 178289 2005-01-26 09:47:28Z dufuz $ require_once 'lib/pear/Cache.php'; @@ -66,7 +64,6 @@ * the output buffer. Modify it if required! * * @author Ulf Wendel <ulf...@ph...> -* @version $Id: Graphics.php 178289 2005-01-26 09:47:28Z dufuz $ * @package Cache */ class Cache_Graphics extends Cache @@ -117,7 +114,7 @@ /** * Mapping from supported image type to a ImageType() constant. * - * Referr to the PHP manual for more informations on ImageType() + * Refer to the PHP manual for more information on ImageType() * * @var array * @link http://www.php.net/ImageType @@ -142,13 +139,13 @@ * Returns the content of a cached image file. * * This function can be used to send the image directly to the browser. - * Make sure that you send a correspondending header before sending the image itself. + * Make sure that you send a correspondding header before sending the image itself. * * Always try to get the image from the cache before you compute it. See * the class docs for an example. * - * @param string Image-ID - * @param string Image type: gif, jpg, png, wbmp + * @param string $id Image-ID + * @param string $format Image type: gif, jpg, png, wbmp * @return string Image file contents if a cached file exists otherwise an empty string * @see cacheImage() */ @@ -165,8 +162,8 @@ * Always try to get the image from the cache before you compute it. See * the class docs for an example. * - * @param string Image-ID - * @param string Image type: gif, jpg, png, wbmp + * @param string $id Image-ID + * @param string $format Image type: gif, jpg, png, wbmp * @return array [ full path to the image file, image url ] * @throw Cache_Error * @see cacheImageLink() @@ -186,18 +183,18 @@ /** * Create an image from the given image handler, cache it and return the file content. * - * Always try to retrive the image from the cache before you compute it. + * Always try to retrieve the image from the cache before you compute it. * * Warning: this function uses the output buffer. If you expect collisions * modify the code. * - * @param string Image-ID. Used as a part of the cache filename. + * @param string $id Image-ID. Used as a part of the cache filename. * Use md5() to generate a "unique" ID for your image * based on characteristic values such as the color, size etc. - * @param string Image handler to create the image from. - * @param string Image type: gif, jpg, png, wbmp. Also used as filename suffix. + * @param string $img Image handler to create the image from. + * @param string $format Image type: gif, jpg, png, wbmp. Also used as filename suffix. * If an unsupported type is requested the functions tries to - * fallback to a supported type before throwing an exeption. + * fall back to a supported type before throwing an exception. * @return string Image content returned by ImageGIF/... * @throws Cache_Error * @access public @@ -256,15 +253,15 @@ /** * Create an image from the given image handler, cache it and return a url and the file path of the image. * - * Always try to retrive the image from the cache before you compute it. + * Always try to retrieve the image from the cache before you compute it. * - * @param string Image-ID. Used as a part of the cache filename. + * @param string $id Image-ID. Used as a part of the cache filename. * Use md5() to generate a "unique" ID for your image * based on characteristic values such as the color, size etc. - * @param string Image handler to create the image from. - * @param string Image type: gif, jpg, png, wbmp. Also used as filename suffix. + * @param string $img Image handler to create the image from. + * @param string $format Image type: gif, jpg, png, wbmp. Also used as filename suffix. * If an unsupported type is requested the functions tries to - * fallback to a supported type before throwing an exeption. + * fall back to a supported type before throwing an exception. * @return array [ full path to the image file, image url ] * @throws Cache_Error * @access public @@ -316,8 +313,8 @@ * Make sure that the URL matches the cache directory, * otherwise you'll get broken links. * - * @param string - * @access public + * @param string $cache_url + * @access public * @see setCacheDir() */ function setCacheURL($cache_url) @@ -333,8 +330,8 @@ /** * Sets the directory where to cache generated Images * - * @param string - * @access public + * @param string $cache_dir + * @access public * @see setCacheURL() */ function setCacheDir($cache_dir) Modified: trunk/lib/pear/Cache/HTTP_Request.php =================================================================== --- trunk/lib/pear/Cache/HTTP_Request.php 2024-04-16 08:11:34 UTC (rev 11084) +++ trunk/lib/pear/Cache/HTTP_Request.php 2025-02-09 18:37:38 UTC (rev 11085) @@ -14,8 +14,6 @@ // +----------------------------------------------------------------------+ // | Authors: Fabien MARTY <fab...@fr...> | // +----------------------------------------------------------------------+ -// -// $Id: HTTP_Request.php 174777 2004-12-15 09:09:33Z dufuz $ require_once 'lib/pear/Cache.php'; require_once 'lib/pear/HTTP/Request.php'; @@ -34,9 +32,9 @@ * You want to get news from another site through RSS remote files. But you * don't want to access to to the remote site at every time you display * its news on your site. Because, if the remote site is down or slow... -* So you you need a class which makes a local cache copy of the remote file. +* So you need a class which makes a local cache copy of the remote file. * Every x hours, the cache is updated. But if the remote site is down, the -* local cache copy is keeped (you can also get error messages if you want). +* local cache copy is kept (you can also get error messages if you want). * * So you need this class! * @@ -56,7 +54,6 @@ * ?> * * @author Fabien MARTY <fab...@fr...> -* @version $Id: HTTP_Request.php 174777 2004-12-15 09:09:33Z dufuz $ * @package Cache */ Modified: trunk/lib/pear/Cache/Output.php =================================================================== --- trunk/lib/pear/Cache/Output.php 2024-04-16 08:11:34 UTC (rev 11084) +++ trunk/lib/pear/Cache/Output.php 2025-02-09 18:37:38 UTC (rev 11085) @@ -16,8 +16,6 @@ // | Christian Stocker <ch...@ph...> | // | Vinai Kopp <ko...@ne...> | // +----------------------------------------------------------------------+ -// -// $Id: Output.php 178289 2005-01-26 09:47:28Z dufuz $ require_once 'lib/pear/Cache.php'; @@ -28,9 +26,9 @@ * output can increase the overall speed dramatically, especially if you use * a Shared Memory storage container. * -* As you can see in the example the usage is extemely simple. To cache a script +* As you can see in the example the usage is extremely simple. To cache a script * simple put some few lines of code in front of your script and some at the end. -* A preferrable place for this are the auto_prepend and auto_append files (=> php.ini). +* A preferable place for this are the auto_prepend and auto_append files (=> php.ini). * * Usage example: * @@ -90,7 +88,6 @@ * Have fun! * * @authors Ulf Wendel <ulf...@ph...> -* @version $ID: $ * @package Cache * @access public */ @@ -125,8 +122,8 @@ /** * starts the output buffering and returns an empty string or returns the cached output from the cache. * - * @param string dataset ID - * @param string cache group + * @param string $id dataset ID + * @param string $group cache group * @return string * @access public */ @@ -186,8 +183,8 @@ * Sends the data to the user. * This is for compatibility with OutputCompression * - * @param string - * @access public + * @param string $content + * @access public */ function printContent($content = '') { Modified: trunk/lib/pear/Cache/OutputCompression.php =================================================================== --- trunk/lib/pear/Cache/OutputCompression.php 2024-04-16 08:11:34 UTC (rev 11084) +++ trunk/lib/pear/Cache/OutputCompression.php 2025-02-09 18:37:38 UTC (rev 11085) @@ -19,7 +19,7 @@ require_once 'lib/pear/Cache/Output.php'; /** -* Cache using Output Buffering and contnet (gz) compression. +* Cache using Output Buffering and content (gz) compression. ** Usage example: * * // place this somewhere in a central config file @@ -50,7 +50,6 @@ * * Based upon a case study from Christian Stocker and inspired by jpcache. * -* @version $Id: OutputCompression.php 178289 2005-01-26 09:47:28Z dufuz $ * @author Ulf Wendel <ulf...@ph...>, Christian Stocker <ch...@ph...> * @access public * @package Cache @@ -81,9 +80,9 @@ /** * Sets the storage details and the content encoding used (if not autodetection) * - * @param string Name of container class - * @param array Array with container class options - * @param string content encoding mode - auto => test which encoding the user accepts + * @param string $container Name of container class + * @param array $container_options Array with container class options + * @param string $encoding content encoding mode - auto => test which encoding the user accepts */ function __construct($container, $container_options = '', $encoding = 'auto') { @@ -174,8 +173,8 @@ /** * Sends the compressed data to the user. * - * @param string - * @access public + * @param string $content + * @access public */ function printContent($content = '') { @@ -219,7 +218,7 @@ /** * Sets the encoding to be used. * - * @param string "auto" means autodetect for every client + * @param string $encoding "auto" means autodetect for every client * @access public * @see $encoding */ @@ -260,7 +259,7 @@ * Import variables from special namespaces. * * @access private - * @param string Type of variable (server, session, post) + * @param string $variable Type of variable (server, session, post) * @return array */ function &_importGlobalVariable($variable) Modified: trunk/lib/pear/Cache.php =================================================================== --- trunk/lib/pear/Cache.php 2024-04-16 08:11:34 UTC (rev 11084) +++ trunk/lib/pear/Cache.php 2025-02-09 18:37:38 UTC (rev 11085) @@ -27,7 +27,7 @@ * cache script runs. The idea behind the cache is quite simple. If you have * the same input parameters for whatever tasks/algorithm you use you'll * usually get the same output. So why not caching templates, functions calls, -* graphic generation etc. Caching certain actions e.g. XSLT tranformations +* graphic generation etc. Caching certain actions e.g. XSLT transformations * saves you lots of time. * * The design of the cache reminds of PHPLibs session implementation. A @@ -121,8 +121,8 @@ /** * - * @param string Name of container class - * @param array Array with container class options + * @param string $container Name of container class + * @param array $container_options Array with container class options */ function __construct($container, $container_options = '') { @@ -155,7 +155,7 @@ /** * Enables or disables caching. * - * @param boolean The new caching state. + * @param boolean $state The new caching state. * @access public */ function setCaching($state) @@ -166,8 +166,8 @@ /** * Returns the requested dataset it if exists and is not expired * - * @param string dataset ID - * @param string cache group + * @param string $id dataset ID + * @param string $group cache group * @return mixed cached data or NULL on failure * @access public */ @@ -184,10 +184,10 @@ /** * Stores the given data in the cache. * - * @param string dataset ID used as cache identifier - * @param mixed data to cache - * @param integer lifetime of the cached data in seconds - 0 for endless - * @param string cache group + * @param string $id dataset ID used as cache identifier + * @param mixed $data data to cache + * @param integer $expires lifetime of the cached data in seconds - 0 for endless + * @param string $group cache group * @return boolean * @access public */ @@ -201,11 +201,11 @@ /** * Stores a dataset without additional userdefined data. * - * @param string dataset ID - * @param mixed data to store - * @param string additional userdefined data - * @param mixed userdefined expire date - * @param string cache group + * @param string $id dataset ID + * @param mixed $cachedata data to store + * @param string $userdata additional userdefined data + * @param mixed $expires userdefined expire date + * @param string $group cache group * @return boolean * @throws Cache_Error * @access public @@ -221,8 +221,8 @@ /** * Loads the given ID from the cache. * - * @param string dataset ID - * @param string cache group + * @param string $id dataset ID + * @param string $group cache group * @return mixed cached data or NULL on failure * @access public */ @@ -236,8 +236,8 @@ /** * Returns the userdata field of a cached data set. * - * @param string dataset ID - * @param string cache group + * @param string $id dataset ID + * @param string $group cache group * @return string userdata * @access public * @see extSave() @@ -252,8 +252,8 @@ /** * Removes the specified dataset from the cache. * - * @param string dataset ID - * @param string cache group + * @param string $id dataset ID + * @param string $group cache group * @return boolean * @access public */ @@ -267,7 +267,7 @@ /** * Flushes the cache - removes all data from it * - * @param string cache group, if empty all groups will be flashed + * @param string $group cache group, if empty all groups will be flashed * @return integer number of removed datasets */ function flush($group = 'default') { @@ -282,8 +282,8 @@ * * Note: this does not say that the cached data is not expired! * - * @param string dataset ID - * @param string cache group + * @param string $id dataset ID + * @param string $group cache group * @return boolean * @access public */ @@ -297,9 +297,9 @@ /** * Checks if a dataset is expired * - * @param string dataset ID - * @param string cache group - * @param integer maximum age for the cached data in seconds - 0 for endless + * @param string $id dataset ID + * @param string $group cache group + * @param integer $max_age maximum age for the cached data in seconds - 0 for endless * If the cached data is older but the given lifetime it will * be removed from the cache. You don't have to provide this * argument if you call isExpired(). Every dataset knows @@ -321,7 +321,7 @@ * This is a quick but dirty hack to get a "unique" ID for a any kind of variable. * ID clashes might occur from time to time although they are extreme unlikely! * - * @param mixed variable to generate a ID for + * @param mixed $variable variable to generate a ID for * @return string "unique" ID * @access public */ @@ -333,7 +333,7 @@ /** * Calls the garbage collector of the storage object with a certain probability * - * @param boolean Force a garbage collection run? + * @param boolean $force Force a garbage collection run? * @see $gc_probability, $gc_time */ function garbageCollection($force = false) { Modified: trunk/lib/pear/DB/common.php =================================================================== --- trunk/lib/pear/DB/common.php 2024-04-16 08:11:34 UTC (rev 11084) +++ trunk/lib/pear/DB/common.php 2025-02-09 18:37:38 UTC (rev 11085) @@ -430,8 +430,8 @@ * </li> * <li> * other (including strings and numeric strings) -> - * the data with single quotes escaped by preceeding - * single quotes, backslashes are escaped by preceeding + * the data with single quotes escaped by preceding + * single quotes, backslashes are escaped by preceding * backslashes, then the whole string is encapsulated * between single quotes * </li> @@ -467,7 +467,7 @@ * Formats a boolean value for use within a query in a locale-independent * manner. * - * @param boolean the boolean value to be quoted. + * @param boolean $boolean the boolean value to be quoted. * @return string the quoted string. * @see DB_common::quoteSmart() * @since Method available since release 1.7.8. @@ -483,7 +483,7 @@ * Formats a float value for use within a query in a locale-independent * manner. * - * @param float the float value to be quoted. + * @param float $float the float value to be quoted. * @return string the quoted string. * @see DB_common::quoteSmart() * @since Method available since release 1.7.8. @@ -543,7 +543,7 @@ * DB_FETCHMODE_OBJECT mode is selected. * If no class is specified by default a cast * to object from the assoc array row will be - * done. There is also the posibility to use + * done. There is also the possibility to use * and extend the 'DB_row' class. * * @see DB_FETCHMODE_ORDERED, DB_FETCHMODE_ASSOC, DB_FETCHMODE_OBJECT @@ -842,7 +842,7 @@ // {{{ autoPrepare() /** - * Automaticaly generates an insert or update query and pass it to prepare() + * Automatically generates an insert or update query and pass it to prepare() * * @param string $table the table name * @param array $table_fields the array of field names @@ -870,7 +870,7 @@ // {{{ autoExecute() /** - * Automaticaly generates an insert or update query and call prepare() + * Automatically generates an insert or update query and call prepare() * and execute() with it * * @param string $table the table name @@ -883,7 +883,7 @@ * include the "WHERE" keyword. * * @return mixed a new DB_result object for successful SELECT queries - * or DB_OK for successul data manipulation queries. + * or DB_OK for successful data manipulation queries. * A DB_Error object on failure. * * @uses DB_common::autoPrepare(), DB_common::execute() @@ -925,7 +925,7 @@ * NOTES: * - This belongs more to a SQL Builder class, but this is a simple * facility. - * - Be carefull! If you don't give a $where param with an UPDATE + * - Be careful! If you don't give a $where param with an UPDATE * query, all the records of the table will be updated! * * @param string $table the table name @@ -1004,7 +1004,7 @@ * parameters or 1 placeholder per array element. * * @return mixed a new DB_result object for successful SELECT queries - * or DB_OK for successul data manipulation queries. + * or DB_OK for successful data manipulation queries. * A DB_Error object on failure. * * {@internal ibase and oci8 have their own execute() methods.}} @@ -1204,7 +1204,7 @@ * parameters or 1 placeholder per array element. * * @return mixed a new DB_result object for successful SELECT queries - * or DB_OK for successul data manipulation queries. + * or DB_OK for successful data manipulation queries. * A DB_Error object on failure. * * @see DB_result, DB_common::prepare(), DB_common::execute() @@ -1239,7 +1239,7 @@ * Generates and executes a LIMIT query * * @param string $query the query - * @param intr $from the row to start to fetching (0 = the first row) + * @param int $from the row to start to fetching (0 = the first row) * @param int $count the numbers of rows to fetch * @param mixed $params array, string or numeric data to be used in * execution of the statement. Quantity of items @@ -1248,7 +1248,7 @@ * parameters or 1 placeholder per array element. * * @return mixed a new DB_result object for successful SELECT queries - * or DB_OK for successul data manipulation queries. + * or DB_OK for successful data manipulation quer... [truncated message content] |