From 4b0582f1d01080866e8a2f4212176b792cbc8cee Mon Sep 17 00:00:00 2001 From: vargenau Date: Fri, 31 Aug 2012 11:49:19 +0000 Subject: [PATCH] phpdoc_params git-svn-id: svn://svn.code.sf.net/p/phpwiki/code/trunk@8279 96ab9672-09ca-45d6-a79d-3d69d39ca109 --- lib/BlockParser.php | 4 +- lib/DbSession/ADODB.php | 12 +- lib/DbSession/PDO.php | 12 +- lib/DbSession/SQL.php | 12 +- lib/Google.php | 2 +- lib/InlineParser.php | 2 +- lib/PageList.php | 2 +- lib/PageType.php | 26 ++-- lib/WikiDB.php | 38 +++--- lib/WikiDB/adodb/adodb-csvlib.inc.php | 2 +- lib/WikiDB/adodb/adodb.inc.php | 28 ++-- lib/WikiDB/adodb/drivers/adodb-oci8.inc.php | 2 +- lib/WikiDB/backend.php | 4 +- lib/WikiGroup.php | 80 ++++++------ lib/WikiPlugin.php | 6 +- lib/WikiPluginCached.php | 40 +++--- lib/WikiTheme.php | 2 +- lib/WikiUser.php | 2 +- lib/WikiUser/OpenID.php | 14 +- lib/main.php | 2 +- lib/nusoap/nusoap.php | 138 ++++++++++---------- lib/pear/Cache.php | 2 +- lib/pear/Cache/Container/trifile.php | 22 ++-- lib/pear/DB.php | 30 ++--- lib/pear/DB/common.php | 126 +++++++++--------- lib/pear/DB/dbase.php | 10 +- lib/pear/DB/fbsql.php | 36 ++--- lib/pear/DB/ibase.php | 44 +++---- lib/pear/DB/ifx.php | 24 ++-- lib/pear/DB/ldap.php | 110 ++++++++-------- lib/pear/DB/msql.php | 8 +- lib/pear/DB/mssql.php | 44 +++---- lib/pear/DB/mysql.php | 46 +++---- lib/pear/DB/mysqli.php | 62 ++++----- lib/pear/DB/oci8.php | 48 +++---- lib/pear/DB/odbc.php | 30 ++--- lib/pear/DB/pgsql.php | 46 +++---- lib/pear/DB/sqlite.php | 42 +++--- lib/pear/DB/sybase.php | 52 ++++---- lib/pear/PEAR.php | 32 ++--- lib/plugin/Calendar.php | 6 +- lib/plugin/CalendarList.php | 6 +- lib/plugin/PhotoAlbum.php | 8 +- lib/plugin/VisualWiki.php | 6 +- lib/prepend.php | 4 +- lib/stdlib.php | 6 +- themes/Sidebar/themeinfo.php | 4 +- 47 files changed, 642 insertions(+), 642 deletions(-) diff --git a/lib/BlockParser.php b/lib/BlockParser.php index 86a59ba6f..8fe81cacc 100644 --- a/lib/BlockParser.php +++ b/lib/BlockParser.php @@ -90,7 +90,7 @@ class AnchoredRegexpSet * * @param $text string The text to search. * - * @return object A RegexpSet_match object, or false if no match. + * @return object A RegexpSet_match object, or false if no match. */ function match ($text) { if (!is_string($text)) return false; @@ -122,7 +122,7 @@ class AnchoredRegexpSet * $prevMatch should be a match object obtained by a previous * match upon the same value of $text. * - * @return object A RegexpSet_match object, or false if no match. + * @return object A RegexpSet_match object, or false if no match. */ function nextMatch ($text, $prevMatch) { // Try to find match at same position. diff --git a/lib/DbSession/ADODB.php b/lib/DbSession/ADODB.php index 8cbcd08d9..29e28b24f 100644 --- a/lib/DbSession/ADODB.php +++ b/lib/DbSession/ADODB.php @@ -76,8 +76,8 @@ extends DbSession * Opens a session. * * Actually this function is a fake for session_set_save_handle. - * @param string $save_path a path to stored files - * @param string $session_name a name of the concrete file + * @param string $save_path a path to stored files + * @param string $session_name a name of the concrete file * @return boolean true just a variable to notify PHP that everything * is good. * @access private @@ -140,8 +140,8 @@ extends DbSession * is necessary, it is suggested that the debug output be * written to a file instead. * - * @param string $id - * @param string $sess_data + * @param string $id + * @param string $sess_data * @return boolean true if data saved successfully and false * otherwise. * @access private @@ -191,7 +191,7 @@ extends DbSession * * Removes a session from the table. * - * @param string $id + * @param string $id * @return boolean true * @access private */ @@ -209,7 +209,7 @@ extends DbSession /** * Cleans out all expired sessions. * - * @param int $maxlifetime session's time to live. + * @param int $maxlifetime session's time to live. * @return boolean true * @access private */ diff --git a/lib/DbSession/PDO.php b/lib/DbSession/PDO.php index 289d7d758..16e646f52 100644 --- a/lib/DbSession/PDO.php +++ b/lib/DbSession/PDO.php @@ -54,8 +54,8 @@ extends DbSession * Opens a session. * * Actually this function is a fake for session_set_save_handle. - * @param string $save_path a path to stored files - * @param string $session_name a name of the concrete file + * @param string $save_path a path to stored files + * @param string $session_name a name of the concrete file * @return boolean true just a variable to notify PHP that everything * is good. * @access private @@ -117,8 +117,8 @@ extends DbSession * is necessary, it is suggested that the debug output be * written to a file instead. * - * @param string $id - * @param string $sess_data + * @param string $id + * @param string $sess_data * @return boolean true if data saved successfully and false * otherwise. * @access private @@ -182,7 +182,7 @@ extends DbSession * * Removes a session from the table. * - * @param string $id + * @param string $id * @return boolean true * @access private */ @@ -199,7 +199,7 @@ extends DbSession /** * Cleans out all expired sessions. * - * @param int $maxlifetime session's time to live. + * @param int $maxlifetime session's time to live. * @return boolean true * @access private */ diff --git a/lib/DbSession/SQL.php b/lib/DbSession/SQL.php index 4abd78a80..18495596d 100644 --- a/lib/DbSession/SQL.php +++ b/lib/DbSession/SQL.php @@ -60,8 +60,8 @@ extends DbSession * Opens a session. * * Actually this function is a fake for session_set_save_handle. - * @param string $save_path a path to stored files - * @param string $session_name a name of the concrete file + * @param string $save_path a path to stored files + * @param string $session_name a name of the concrete file * @return boolean true just a variable to notify PHP that everything * is good. * @access private @@ -125,8 +125,8 @@ extends DbSession * is necessary, it is suggested that the debug output be * written to a file instead. * - * @param string $id - * @param string $sess_data + * @param string $id + * @param string $sess_data * @return boolean true if data saved successfully and false * otherwise. * @access private @@ -177,7 +177,7 @@ extends DbSession * * Removes a session from the table. * - * @param string $id + * @param string $id * @return boolean true * @access private */ @@ -195,7 +195,7 @@ extends DbSession /** * Cleans out all expired sessions. * - * @param int $maxlifetime session's time to live. + * @param int $maxlifetime session's time to live. * @return boolean true * @access private */ diff --git a/lib/Google.php b/lib/Google.php index e87b0f2f2..25bd77357 100644 --- a/lib/Google.php +++ b/lib/Google.php @@ -264,7 +264,7 @@ class Google { * Get spelling suggestions from Google * * @param string phrase word or phrase to spell-check - * @return string text of any suggested replacement, or None + * @return string text of any suggested replacement, or None */ function doSpellingSuggestion($phrase) { if (!$this->license_key) diff --git a/lib/InlineParser.php b/lib/InlineParser.php index e7954ce23..1e47a6bed 100644 --- a/lib/InlineParser.php +++ b/lib/InlineParser.php @@ -95,7 +95,7 @@ class RegexpSet * * @param string $text The text to search. * - * @return RegexpSet_match A RegexpSet_match object, or false if no match. + * @return RegexpSet_match A RegexpSet_match object, or false if no match. */ function match ($text) { return $this->_match($text, $this->_regexps, '*?'); diff --git a/lib/PageList.php b/lib/PageList.php index b54627070..8c33669c2 100644 --- a/lib/PageList.php +++ b/lib/PageList.php @@ -1258,7 +1258,7 @@ class PageList { * If you wish to add multiple columns of the same type, use addColumnObject(). * * @param column name - * @return true if column is added, false otherwise + * @return true if column is added, false otherwise */ function _addColumn ($column) { if (isset($this->_columns_seen[$column])) diff --git a/lib/PageType.php b/lib/PageType.php index 7226862a7..9d6859c50 100644 --- a/lib/PageType.php +++ b/lib/PageType.php @@ -28,9 +28,9 @@ class TransformedText extends CacheableMarkup { /** Constructor. * * @param WikiDB_Page $page - * @param string $text The packed page revision content. - * @param hash $meta The version meta-data. - * @param string $type_override For markup of page using a different + * @param string $text The packed page revision content. + * @param hash $meta The version meta-data. + * @param string $type_override For markup of page using a different * pagetype than that specified in its version meta-data. */ function TransformedText($page, $text, $meta, $type_override=false) { @@ -70,8 +70,8 @@ class PageType { * * This is a static member function. * - * @param string $pagetype Name of the page type. - * @return PageType An object which is a subclass of PageType. + * @param string $pagetype Name of the page type. + * @return PageType An object which is a subclass of PageType. */ function GetPageType ($name=false) { if (!$name) @@ -87,7 +87,7 @@ class PageType { /** * Get the name of this page type. * - * @return string Page type name. + * @return string Page type name. */ function getName() { if (!preg_match('/^PageType_(.+)$/i', get_class($this), $m)) @@ -98,10 +98,10 @@ class PageType { /** * Transform page text. * - * @param WikiDB_Page $page - * @param string $text - * @param hash $meta Version meta-data - * @return XmlContent The transformed page text. + * @param WikiDB_Page $page + * @param string $text + * @param hash $meta Version meta-data + * @return XmlContent The transformed page text. */ function transform(&$page, &$text, $meta) { $fmt_class = 'PageFormatter_' . $this->getName(); @@ -327,7 +327,7 @@ class PageFormatter { /** Constructor. * * @param WikiDB_Page $page - * @param hash $meta Version meta-data. + * @param hash $meta Version meta-data. */ function PageFormatter(&$page, $meta) { $this->_page = $page; @@ -347,8 +347,8 @@ class PageFormatter { /** Transform the page text. * - * @param string $text The raw page content (e.g. wiki-text). - * @return XmlContent Transformed content. + * @param string $text The raw page content (e.g. wiki-text). + * @return XmlContent Transformed content. */ function format($text) { trigger_error("pure virtual", E_USER_ERROR); diff --git a/lib/WikiDB.php b/lib/WikiDB.php index 888d26dda..72c299d81 100644 --- a/lib/WikiDB.php +++ b/lib/WikiDB.php @@ -155,7 +155,7 @@ class WikiDB { * therefore this method never fails. * * @access public - * @param string $pagename Which page to get. + * @param string $pagename Which page to get. * @return WikiDB_Page The requested WikiDB_Page. */ function getPage($pagename) { @@ -192,7 +192,7 @@ class WikiDB { * manner in certain back-ends. * * @access public - * @param string $pagename string Which page to check. + * @param string $pagename string Which page to check. * @return boolean True if the page actually exists with * non-default contents in the WikiDataBase. */ @@ -288,7 +288,7 @@ class WikiDB { * @access public * * @param boolean $include_empty If true include also empty pages - * @param string $exclude: comma-seperated list of pagenames. + * @param string $exclude: comma-seperated list of pagenames. * TBD: array of pagenames * @return integer * @@ -322,7 +322,7 @@ class WikiDB { * If false the result is faster in natural order. * @param string or false $limit Optional. Encoded as "$offset,$count". * $offset defaults to 0. - * @param string $exclude: Optional comma-seperated list of pagenames. + * @param string $exclude: Optional comma-seperated list of pagenames. * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching pages. * @see TextSearchQuery */ @@ -352,7 +352,7 @@ class WikiDB { * If false the result is faster in natural order. * @param string or false $limit Optional. Encoded as "$offset,$count". * $offset defaults to 0. - * @param string $exclude: Optional comma-seperated list of pagenames. + * @param string $exclude: Optional comma-seperated list of pagenames. * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching pages. * @see TextSearchQuery */ @@ -501,10 +501,10 @@ class WikiDB { * Call the appropriate backend method. * * @access public - * @param string $from Page to rename - * @param string $to New name - * @param boolean $updateWikiLinks If the text in all pages should be replaced. - * @return boolean true or false + * @param string $from Page to rename + * @param string $to New name + * @param boolean $updateWikiLinks If the text in all pages should be replaced. + * @return boolean true or false */ function renamePage($from, $to, $updateWikiLinks = false) { if (!empty($this->readonly)) { trigger_error("readonly database", E_USER_WARNING); return; } @@ -649,8 +649,8 @@ class WikiDB { * @see get * @access public * - * @param string $key Meta-data key to set. - * @param string $newval New value. + * @param string $key Meta-data key to set. + * @param string $newval New value. */ function set($key, $newval) { if (!empty($this->readonly)) { trigger_error("readonly database", E_USER_WARNING); return; } @@ -891,7 +891,7 @@ class WikiDB_Page * * @param hash $links List of linkto=>pagename, relation=>pagename which this page links to. * - * @return WikiDB_PageRevision Returns the new WikiDB_PageRevision object. If + * @return WikiDB_PageRevision Returns the new WikiDB_PageRevision object. If * $version was incorrect, returns false */ function createRevision($version, &$content, $metadata, $links) { @@ -963,7 +963,7 @@ class WikiDB_Page * This takes care of computing the links, and storing * a cached version of the transformed wiki-text. * - * @param string $wikitext The page content. + * @param string $wikitext The page content. * * @param int $version Version number for new revision. * To ensure proper serialization of edits, $version must be @@ -971,7 +971,7 @@ class WikiDB_Page * (You can defeat this check by setting $version to * {@link WIKIDB_FORCE_CREATE} --- not usually recommended.) * - * @param hash $meta Meta-data for new revision. + * @param hash $meta Meta-data for new revision. */ function save($wikitext, $version, $meta, $formatted = null) { if ($this->_wikidb->readonly) { trigger_error("readonly database", E_USER_WARNING); return; } @@ -1067,7 +1067,7 @@ class WikiDB_Page * * @access public * - * @param integer $version Which revision to get. + * @param integer $version Which revision to get. * * @return WikiDB_PageRevision The requested WikiDB_PageRevision object, or * false if the requested revision does not exist in the {@link WikiDB}. @@ -1098,7 +1098,7 @@ class WikiDB_Page * * @access public * - * @param integer $version Find most recent revision before this version. + * @param integer $version Find most recent revision before this version. * You can also use a WikiDB_PageRevision object to specify the $version. * * @return WikiDB_PageRevision The requested WikiDB_PageRevision object, or false if the @@ -1295,8 +1295,8 @@ class WikiDB_Page * @see get * @access public * - * @param string $key Meta-data key to set. - * @param string $newval New value. + * @param string $key Meta-data key to set. + * @param string $newval New value. */ function set($key, $newval) { $cache = &$this->_wikidb->_cache; @@ -1561,7 +1561,7 @@ class WikiDB_PageRevision /** * Get the transformed content of a page. * - * @param string $pagetype Override the page-type of the revision. + * @param string $pagetype Override the page-type of the revision. * * @return object An XmlContent-like object containing the page transformed * contents. diff --git a/lib/WikiDB/adodb/adodb-csvlib.inc.php b/lib/WikiDB/adodb/adodb-csvlib.inc.php index a65b6585d..5b8a17def 100644 --- a/lib/WikiDB/adodb/adodb-csvlib.inc.php +++ b/lib/WikiDB/adodb/adodb-csvlib.inc.php @@ -24,7 +24,7 @@ $ADODB_INCLUDED_CSV = 1; * * @param rs the recordset * - * @return the CSV formated data + * @return the CSV formated data */ function _rs2serialize(&$rs,$conn=false,$sql='') { diff --git a/lib/WikiDB/adodb/adodb.inc.php b/lib/WikiDB/adodb/adodb.inc.php index 5c35e2fa1..e2f59d1b5 100644 --- a/lib/WikiDB/adodb/adodb.inc.php +++ b/lib/WikiDB/adodb/adodb.inc.php @@ -738,7 +738,7 @@ * * @param sql SQL statement to execute, or possibly an array holding prepared statement ($sql[0] will hold sql text) * @param [inputarr] holds the input data to bind to. Null elements will be set to null. - * @return RecordSet or false + * @return RecordSet or false */ function &Execute($sql,$inputarr=false) { @@ -904,7 +904,7 @@ * * @param seqname name of sequence to use * @param startID if sequence does not exist, start at this ID - * @return 0 if not supported, otherwise a sequence id + * @return 0 if not supported, otherwise a sequence id */ function GenID($seqname='adodbseq',$startID=1) { @@ -930,7 +930,7 @@ } /** - * @return the last inserted ID. Not all databases support this. + * @return the last inserted ID. Not all databases support this. */ function Insert_ID() { @@ -947,7 +947,7 @@ /** * Portable Insert ID. Pablo Roca * - * @return the last inserted ID. All databases support this. But aware possible + * @return the last inserted ID. All databases support this. But aware possible * problems in multiuser environments. Heavy test this before deploying. */ function PO_Insert_ID($table="", $id="") @@ -978,7 +978,7 @@ /** - * @return the last error message + * @return the last error message */ function ErrorMsg() { @@ -1038,7 +1038,7 @@ * Choose a database to connect to. Many databases do not support this. * * @param dbName is the name of the database to select - * @return true or false + * @return true or false */ function SelectDB($dbName) {return false;} @@ -1509,7 +1509,7 @@ * This is an optional parameter. * @param sql SQL statement to execute * @param [inputarr] holds the input data to bind to - * @return RecordSet or false + * @return RecordSet or false */ function &CacheExecute($secs2cache,$sql=false,$inputarr=false) { @@ -1858,7 +1858,7 @@ * @param showSchema returns the schema/user with the table name, eg. USER.TABLE * @param mask is the input mask - only supported by oci8 and postgresql * - * @return array of tables for current database. + * @return array of tables for current database. */ function &MetaTables($ttype=false,$showSchema=false,$mask=false) { @@ -1918,7 +1918,7 @@ * @param upper uppercase table name (required by some databases) * @schema is optional database schema to use - not supported by all databases. * - * @return array of ADOFieldObjects for current table. + * @return array of ADOFieldObjects for current table. */ function &MetaColumns($table,$upper=true) { @@ -1975,7 +1975,7 @@ * List columns names in a table as an array. * @param table table name to query * - * @return array of column names for current table. + * @return array of column names for current table. */ function &MetaColumnNames($table) { @@ -2011,7 +2011,7 @@ * * @param d a date in Unix date time format. * - * @return date string in database date format + * @return date string in database date format */ function DBDate($d) { @@ -2032,7 +2032,7 @@ * * @param ts a timestamp in Unix date time format. * - * @return timestamp string in database timestamp format + * @return timestamp string in database timestamp format */ function DBTimeStamp($ts) { @@ -2162,7 +2162,7 @@ * @param [magic_quotes] if $s is GET/POST var, set to get_magic_quotes_gpc(). * This undoes the stupidity of magic quotes for GPC. * - * @return quoted string to be sent back to database + * @return quoted string to be sent back to database */ function qstr($s,$magic_quotes=false) { @@ -2874,7 +2874,7 @@ /** * Portable RecordCount. Pablo Roca * - * @return the number of records from a previous SELECT. All databases support this. + * @return the number of records from a previous SELECT. All databases support this. * * But aware possible problems in multiuser environments. For better speed the table * must be indexed by the condition. Heavy test this before deploying. diff --git a/lib/WikiDB/adodb/drivers/adodb-oci8.inc.php b/lib/WikiDB/adodb/drivers/adodb-oci8.inc.php index 619109f9a..e74d62564 100644 --- a/lib/WikiDB/adodb/drivers/adodb-oci8.inc.php +++ b/lib/WikiDB/adodb/drivers/adodb-oci8.inc.php @@ -938,7 +938,7 @@ SELECT /*+ RULE */ distinct b.column_name * @param [magic_quotes] if $s is GET/POST var, set to get_magic_quotes_gpc(). * This undoes the stupidity of magic quotes for GPC. * - * @return quoted string to be sent back to database + * @return quoted string to be sent back to database */ function qstr($s,$magic_quotes=false) { diff --git a/lib/WikiDB/backend.php b/lib/WikiDB/backend.php index f2af23862..260cfe7f6 100644 --- a/lib/WikiDB/backend.php +++ b/lib/WikiDB/backend.php @@ -388,8 +388,8 @@ class WikiDB_backend * be returned in reverse order by hit count. * * @access protected - * @param integer $limit No more than this many pages - * @return object A WikiDB_backend_iterator. + * @param integer $limit No more than this many pages + * @return object A WikiDB_backend_iterator. */ function most_popular($limit, $sortby='-hits') { // This is method fetches all pages, then diff --git a/lib/WikiGroup.php b/lib/WikiGroup.php index 0266ebc49..fad1694fb 100644 --- a/lib/WikiGroup.php +++ b/lib/WikiGroup.php @@ -99,7 +99,7 @@ class WikiGroup{ /** * Static method to return the WikiGroup subclass used in this wiki. Controlled * by the constant GROUP_METHOD. - * @param object $request The global WikiRequest object. + * @param object $request The global WikiRequest object. * @return object Subclass of WikiGroup selected via GROUP_METHOD. */ function getGroup($not_current = false){ @@ -173,7 +173,7 @@ class WikiGroup{ * * This method is an abstraction. The group is ignored, an error is sent, and * false (not a member of the group) is returned. - * @param string $group Name of the group to check for membership (ignored). + * @param string $group Name of the group to check for membership (ignored). * @return boolean True if user is a member, else false (always false). */ function isMember($group){ @@ -304,8 +304,8 @@ class WikiGroup{ * * This method is an abstraction. The group is ignored, an error is sent, * and an empty array is returned - * @param string $group Name of the group to get the full membership list of. - * @return array Array of usernames that have joined the group (always empty). + * @param string $group Name of the group to get the full membership list of. + * @return array Array of usernames that have joined the group (always empty). */ function getMembersOf($group){ if ($this->specialGroup($group)) { @@ -365,9 +365,9 @@ class WikiGroup{ * * This method is an abstraction. The group and user are ignored, an error * is sent, and false (not added) is always returned. - * @param string $group User added to this group. - * @param string $user Username to add to the group (default = current user). - * @return bool On true user was added, false if not. + * @param string $group User added to this group. + * @param string $user Username to add to the group (default = current user). + * @return bool On true user was added, false if not. */ function setMemberOf($group, $user = false){ trigger_error(__sprintf("Method '%s' not implemented in this GROUP_METHOD %s", @@ -381,9 +381,9 @@ class WikiGroup{ * * This method is an abstraction. The group and user are ignored, and error * is sent, and false (not removed) is always returned. - * @param string $group User removed from this group. - * @param string $user Username to remove from the group (default = current user). - * @return bool On true user was removed, false if not. + * @param string $group User removed from this group. + * @param string $user Username to remove from the group (default = current user). + * @return bool On true user was removed, false if not. */ function removeMemberOf($group, $user = false){ trigger_error(__sprintf("Method '%s' not implemented in this GROUP_METHOD %s", @@ -417,7 +417,7 @@ class GroupNone extends WikiGroup{ * Determines if the current user is a member of a group. * * The group is ignored and false (not a member of the group) is returned. - * @param string $group Name of the group to check for membership (ignored). + * @param string $group Name of the group to check for membership (ignored). * @return boolean True if user is a member, else false (always false). */ function isMember($group){ @@ -432,8 +432,8 @@ class GroupNone extends WikiGroup{ * Determines all of the groups of which the current user is a member. * * The group is ignored and an empty array (a member of no groups) is returned. - * @param string $group Name of the group to check for membership (ignored). - * @return array Array of groups to which the user belongs (always empty). + * @param string $group Name of the group to check for membership (ignored). + * @return array Array of groups to which the user belongs (always empty). */ function getAllGroupsIn(){ return array(); @@ -443,8 +443,8 @@ class GroupNone extends WikiGroup{ * Determines all of the members of a particular group. * * The group is ignored and an empty array (a member of no groups) is returned. - * @param string $group Name of the group to check for membership (ignored). - * @return array Array of groups user belongs to (always empty). + * @param string $group Name of the group to check for membership (ignored). + * @return array Array of groups user belongs to (always empty). */ function getMembersOf($group){ return array(); @@ -482,7 +482,7 @@ class GroupWikiPage extends WikiGroup{ * superclass instance variable $membership to see if membership has * already been determined. If not, then the group page is parsed to * determine membership. - * @param string $group Name of the group to check for membership. + * @param string $group Name of the group to check for membership. * @return boolean True if user is a member, else false. */ function isMember($group){ @@ -533,8 +533,8 @@ class GroupWikiPage extends WikiGroup{ * * Checks the root Group page ('CategoryGroup') for the list of all groups, * then checks each group to see if the current user is a member. - * @param string $group Name of the group to check for membership. - * @return array Array of groups to which the user belongs. + * @param string $group Name of the group to check for membership. + * @return array Array of groups to which the user belongs. */ function getAllGroupsIn(){ $membership = array(); @@ -563,8 +563,8 @@ class GroupWikiPage extends WikiGroup{ * * Checks a group's page to return all the current members. Currently this * method is disabled and triggers an error and returns an empty array. - * @param string $group Name of the group to get the full membership list of. - * @return array Array of usernames that have joined the group (always empty). + * @param string $group Name of the group to get the full membership list of. + * @return array Array of usernames that have joined the group (always empty). */ function getMembersOf($group){ if ($this->specialGroup($group)) @@ -649,7 +649,7 @@ class GroupDb_PearDB extends GroupDb { /** * Determines if the current user is a member of a database group. * - * @param string $group Name of the group to check for membership. + * @param string $group Name of the group to check for membership. * @return boolean True if user is a member, else false. */ function isMember($group) { @@ -675,8 +675,8 @@ class GroupDb_PearDB extends GroupDb { * Determines all of the groups of which the current user is a member. * * then checks each group to see if the current user is a member. - * @param string $group Name of the group to check for membership. - * @return array Array of groups to which the user belongs. + * @param string $group Name of the group to check for membership. + * @return array Array of groups to which the user belongs. */ function getAllGroupsIn(){ $membership = array(); @@ -704,8 +704,8 @@ class GroupDb_PearDB extends GroupDb { * * Checks a group's page to return all the current members. Currently this * method is disabled and triggers an error and returns an empty array. - * @param string $group Name of the group to get the full membership list of. - * @return array Array of usernames that have joined the group. + * @param string $group Name of the group to get the full membership list of. + * @return array Array of usernames that have joined the group. */ function getMembersOf($group){ @@ -734,7 +734,7 @@ class GroupDb_ADODB extends GroupDb { /** * Determines if the current user is a member of a database group. * - * @param string $group Name of the group to check for membership. + * @param string $group Name of the group to check for membership. * @return boolean True if user is a member, else false. */ function isMember($group) { @@ -764,8 +764,8 @@ class GroupDb_ADODB extends GroupDb { * Determines all of the groups of which the current user is a member. * then checks each group to see if the current user is a member. * - * @param string $group Name of the group to check for membership. - * @return array Array of groups to which the user belongs. + * @param string $group Name of the group to check for membership. + * @return array Array of groups to which the user belongs. */ function getAllGroupsIn(){ $membership = array(); @@ -794,8 +794,8 @@ class GroupDb_ADODB extends GroupDb { /** * Determines all of the members of a particular group. * - * @param string $group Name of the group to get the full membership list of. - * @return array Array of usernames that have joined the group. + * @param string $group Name of the group to get the full membership list of. + * @return array Array of usernames that have joined the group. */ function getMembersOf($group){ $members = array(); @@ -855,7 +855,7 @@ class GroupFile extends WikiGroup { * superclass instance variable $membership to see if membership has * already been determined. If not, then the group file is parsed to * determine membership. - * @param string $group Name of the group to check for membership. + * @param string $group Name of the group to check for membership. * @return boolean True if user is a member, else false. */ function isMember($group) { @@ -884,8 +884,8 @@ class GroupFile extends WikiGroup { * Determines all of the groups of which the current user is a member. * * then checks each group to see if the current user is a member. - * @param string $group Name of the group to check for membership. - * @return array Array of groups to which the user belongs. + * @param string $group Name of the group to check for membership. + * @return array Array of groups to which the user belongs. */ function getAllGroupsIn(){ //$username = $this->_getUserName(); @@ -915,8 +915,8 @@ class GroupFile extends WikiGroup { * Determines all of the members of a particular group. * * Return all the current members. - * @param string $group Name of the group to get the full membership list of. - * @return array Array of usernames that have joined the group. + * @param string $group Name of the group to get the full membership list of. + * @return array Array of usernames that have joined the group. */ function getMembersOf($group){ $members = array(); @@ -982,7 +982,7 @@ class GroupLdap extends WikiGroup { * Determines if the current user is a member of a group. * Not ready yet! * - * @param string $group Name of the group to check for membership. + * @param string $group Name of the group to check for membership. * @return boolean True if user is a member, else false. */ function isMember($group) { @@ -1001,8 +1001,8 @@ class GroupLdap extends WikiGroup { /** * Determines all of the groups of which the current user is a member. * - * @param string $group Name of the group to check for membership. - * @return array Array of groups to which the user belongs. + * @param string $group Name of the group to check for membership. + * @return array Array of groups to which the user belongs. */ function getAllGroupsIn(){ //$request = &$this->request; @@ -1060,8 +1060,8 @@ class GroupLdap extends WikiGroup { * Determines all of the members of a particular group. * * Return all the members of the given group. LDAP just returns the gid of each user - * @param string $group Name of the group to get the full membership list of. - * @return array Array of usernames that have joined the group. + * @param string $group Name of the group to get the full membership list of. + * @return array Array of usernames that have joined the group. */ function getMembersOf($group){ $members = array(); diff --git a/lib/WikiPlugin.php b/lib/WikiPlugin.php index 7bce5755d..07e25830a 100644 --- a/lib/WikiPlugin.php +++ b/lib/WikiPlugin.php @@ -52,9 +52,9 @@ class WikiPlugin * args, not the rest of the wikidb state or any request query args) * will work correctly here. * - * @param string $argstr The plugin argument string. - * @param string $basepage The pagename the plugin is invoked from. - * @return array List of pagenames linked to (or false). + * @param string $argstr The plugin argument string. + * @param string $basepage The pagename the plugin is invoked from. + * @return array List of pagenames linked to (or false). */ function getWikiPageLinks ($argstr, $basepage) { return false; diff --git a/lib/WikiPluginCached.php b/lib/WikiPluginCached.php index b38fc0a7f..5166a675c 100644 --- a/lib/WikiPluginCached.php +++ b/lib/WikiPluginCached.php @@ -128,7 +128,7 @@ class WikiPluginCached extends WikiPlugin * @param argstr string plugin arguments in the call from PhpWiki * @param request Request ??? * @param string basepage Pagename to use to interpret links [/relative] page names. - * @return string HTML output to be printed to browser + * @return string HTML output to be printed to browser * * @see #getHtml * @see #getImage @@ -286,7 +286,7 @@ class WikiPluginCached extends WikiPlugin * image. It is not necessary to call * WikiPlugin->getArgs anymore. * @param request Request ??? - * @return imagehandle image handle if successful + * @return imagehandle image handle if successful * false if an error occured */ function getImage($dbi,$argarray,$request) { @@ -309,7 +309,7 @@ class WikiPluginCached extends WikiPlugin * not necessary to call * WikiPlugin->getArgs anymore. * @param request Request ??? - * @return string format: '+seconds' + * @return string format: '+seconds' * '0' never expires */ function getExpire($dbi,$argarray,$request) { @@ -326,7 +326,7 @@ class WikiPluginCached extends WikiPlugin * not necessary to call * WikiPlugin->getArgs anymore. * @param request Request ??? - * @return string 'png', 'jpeg' or 'gif' + * @return string 'png', 'jpeg' or 'gif' */ function getImageType(&$dbi, $argarray, &$request) { if (in_array($argarray['imgtype'], preg_split('/\s*:\s*/', PLUGIN_CACHED_IMGTYPES))) @@ -345,7 +345,7 @@ class WikiPluginCached extends WikiPlugin * not necessary to call * WikiPlugin->getArgs anymore. * @param request Request ??? - * @return string "alt" description of the image + * @return string "alt" description of the image */ function getAlt($dbi,$argarray,$request) { return 'getName().' '.$this->glueArgs($argarray).'?>'; @@ -362,8 +362,8 @@ class WikiPluginCached extends WikiPlugin * image. It is not necessary to call * WikiPlugin->getArgs anymore. * @param request Request ??? - * @param string $basepage Pagename to use to interpret links [/relative] page names. - * @return string html to be printed in place of the plugin command + * @param string $basepage Pagename to use to interpret links [/relative] page names. + * @return string html to be printed in place of the plugin command * false if an error occured */ function getHtml($dbi, $argarray, $request, $basepage) { @@ -382,7 +382,7 @@ class WikiPluginCached extends WikiPlugin * image. It is not necessary to call * WikiPlugin->getArgs anymore. * @param request Request ??? - * @return array(html,handle) html for the map interior (to be specific, + * @return array(html,handle) html for the map interior (to be specific, * only <area;> tags defining hot spots) * handle is an imagehandle to the corresponding * image. @@ -409,7 +409,7 @@ class WikiPluginCached extends WikiPlugin * image. It is not necessary to call * WikiPlugin->getArgs anymore. * @param request Request ??? - * @return string html output + * @return string html output */ function embedMap($id,$url,$map,&$dbi,$argarray,&$request) { // id is not unique if the same map is produced twice @@ -436,7 +436,7 @@ class WikiPluginCached extends WikiPlugin * image. It is not necessary to call * WikiPlugin->getArgs anymore. * @param request Request ??? - * @return string html output + * @return string html output */ function embedImg($url, $dbi, $argarray, $request) { return HTML::img( array( @@ -479,7 +479,7 @@ class WikiPluginCached extends WikiPlugin * FIXME: There should be references returned * * @access static protected - * @return Cache copy of the cache object + * @return Cache copy of the cache object */ function newCache() { static $staticcache; @@ -516,7 +516,7 @@ class WikiPluginCached extends WikiPlugin * * @access public static * @param wish string one of 'png', 'gif', 'jpeg', 'jpg' - * @return string the image type to be used ('png', 'gif', 'jpeg') + * @return string the image type to be used ('png', 'gif', 'jpeg') * 'html' in case of an error */ @@ -567,7 +567,7 @@ class WikiPluginCached extends WikiPlugin * @param imgtype string 'png', 'gif' or 'jpeg' * @param imghandle string image handle containing the image * @param imgfile string file name of the image to be produced - * @return void + * @return void * @see decideImageType */ function writeImage($imgtype, $imghandle, $imgfile=false) { @@ -588,7 +588,7 @@ class WikiPluginCached extends WikiPlugin * * @access public static * @param doctype string 'gif', 'png', 'jpeg', 'html' - * @return void + * @return void */ function writeHeader($doctype) { static $IMAGEHEADER = array( @@ -613,7 +613,7 @@ class WikiPluginCached extends WikiPlugin * * @access public static * @param argarray array contains all arguments to be converted - * @return string concated arguments + * @return string concated arguments */ function glueArgs($argarray) { if (!empty($argarray)) { @@ -643,7 +643,7 @@ class WikiPluginCached extends WikiPlugin * @param request Request ??? * @param errorformat string format which should be used to * output errors ('html', 'png', 'gif', 'jpeg') - * @return boolean false if an error occurs, true otherwise. + * @return boolean false if an error occurs, true otherwise. * Param id and param plugincall are * also return values. */ @@ -673,7 +673,7 @@ class WikiPluginCached extends WikiPlugin * @param plugincall string reference to serialized array containing both * name and parameters of the plugin call * @param request Request ??? - * @return boolean false if an error occurs, true otherwise. + * @return boolean false if an error occurs, true otherwise. * */ function checkCall2(&$plugincall, $request) { @@ -705,7 +705,7 @@ class WikiPluginCached extends WikiPlugin * @param argarray array Contains all arguments needed by plugin * @param request Request ???? * @param errorformat string outputs errors in 'png', 'gif', 'jpg' or 'html' - * @return boolean error status; true=ok; false=error + * @return boolean error status; true=ok; false=error */ function produceImage(&$content, $plugin, $dbi, $argarray, $request, $errorformat) { $plugin->resetError(); @@ -955,7 +955,7 @@ class WikiPluginCached extends WikiPlugin * I recommend font 2 for errors and 4 for help texts. * @param textcol array text color as a list of the rgb components; array(red,green,blue) * @param bgcol array background color; array(red,green,blue) - * @return string image handle for gd routines + * @return string image handle for gd routines */ function text2img($txt,$fontnr,$textcol,$bgcol) { // basic (!) output for error handling @@ -1080,7 +1080,7 @@ class WikiPluginCached extends WikiPlugin * * @param cmd string command to be invoked * @param until string expected output filename - * @return boolean error status; true=ok; false=error + * @return boolean error status; true=ok; false=error */ function execute($cmd, $until = false) { // cmd must redirect stderr to stdout though! diff --git a/lib/WikiTheme.php b/lib/WikiTheme.php index ac88431ec..0330ed754 100644 --- a/lib/WikiTheme.php +++ b/lib/WikiTheme.php @@ -1148,7 +1148,7 @@ class WikiTheme { /** Set alternate CSS source for this theme. * - * @param string $title Name of style. + * @param string $title Name of style. * @param string $css_files Name of CSS file. */ function addAlternateCSS ($title, $css_files) { diff --git a/lib/WikiUser.php b/lib/WikiUser.php index 204bb2263..2f16bf9ec 100644 --- a/lib/WikiUser.php +++ b/lib/WikiUser.php @@ -74,7 +74,7 @@ class WikiUser { * * Populates the instance variables and calls $this->_ok() * to ensure that the parameters are valid. - * @param mixed $userid String of username or WikiUser object. + * @param mixed $userid String of username or WikiUser object. * @param integer $authlevel Authorization level. */ function WikiUser (&$request, $userid = false, $authlevel = false) { diff --git a/lib/WikiUser/OpenID.php b/lib/WikiUser/OpenID.php index b0dabfe00..3e57d8cce 100644 --- a/lib/WikiUser/OpenID.php +++ b/lib/WikiUser/OpenID.php @@ -45,7 +45,7 @@ extends _PassUser * @param array $params HTTP query data from OpenID server * @param string &$identity this argument is set to end-user's claimed * identifier or OpenID provider local identifier. - * @param mixed $extensions extension object or array of extensions objects + * @param mixed $extensions extension object or array of extensions objects * @return bool */ function verify($params, &$identity = "", $extensions = null) { @@ -106,12 +106,12 @@ extends _PassUser * On success the function does not return (it does HTTP redirection to * server and exits). On failure it returns false. * - * @param bool $immediate enables or disables interaction with user - * @param string $id OpenID identity - * @param string $returnTo HTTP URL to redirect response from server to - * @param string $root HTTP URL to identify consumer on server - * @param mixed $extensions extension object or array of extensions objects - * @param Zend_Controller_Response_Abstract $response an optional response + * @param bool $immediate enables or disables interaction with user + * @param string $id OpenID identity + * @param string $returnTo HTTP URL to redirect response from server to + * @param string $root HTTP URL to identify consumer on server + * @param mixed $extensions extension object or array of extensions objects + * @param Zend_Controller_Response_Abstract $response an optional response * object to perform HTTP or HTML form redirection * @return bool */ diff --git a/lib/main.php b/lib/main.php index 405f7ab9f..c9f7a78ee 100644 --- a/lib/main.php +++ b/lib/main.php @@ -334,7 +334,7 @@ class WikiRequest extends Request { * By default it will grab the page requested via the URL * * This is a convenience function. - * @param string $pagename Name of page to get. + * @param string $pagename Name of page to get. * @return WikiDB_Page Object with methods to pull data from * database for the page requested. */ diff --git a/lib/nusoap/nusoap.php b/lib/nusoap/nusoap.php index 68d096a3b..8912ac413 100644 --- a/lib/nusoap/nusoap.php +++ b/lib/nusoap/nusoap.php @@ -138,7 +138,7 @@ class nusoap_base { /** * adds debug data to the class level debug string * - * @param string $string debug data + * @param string $string debug data * @access private */ function debug($string){ @@ -148,7 +148,7 @@ class nusoap_base { /** * returns error string if present * - * @return boolean $string error string + * @return boolean $string error string * @access public */ function getError(){ @@ -161,7 +161,7 @@ class nusoap_base { /** * sets error string * - * @return boolean $string error string + * @return boolean $string error string * @access private */ function setError($str){ @@ -172,7 +172,7 @@ class nusoap_base { * serializes PHP values in accordance w/ section 5. Type information is * not serialized if $use == 'literal'. * - * @return string + * @return string * @access public */ function serialize_val($val,$name=false,$type=false,$name_ns=false, @@ -516,8 +516,8 @@ class soap_fault extends nusoap_base { /** * constructor * - * @param string $faultcode (client | server) - * @param string $faultactor only used when msg routed between multiple actors + * @param string $faultcode (client | server) + * @param string $faultactor only used when msg routed between multiple actors * @param string $faultstring human readable error message * @param string $faultdetail */ @@ -1233,12 +1233,12 @@ class soapval extends nusoap_base { /** * constructor * - * @param string $name optional name - * @param string $type optional type name - * @param mixed $value optional value - * @param string $namespace optional namespace of value - * @param string $type_namespace optional namespace of type - * @param array $attributes associative array of attributes to add to element serialization + * @param string $name optional name + * @param string $type optional type name + * @param mixed $value optional value + * @param string $namespace optional namespace of value + * @param string $type_namespace optional namespace of type + * @param array $attributes associative array of attributes to add to element serialization * @access public */ function soapval($name='soapval',$type=false,$value=-1,$element_ns=false,$type_ns=false,$attributes=false) { @@ -1253,7 +1253,7 @@ class soapval extends nusoap_base { /** * return serialized value * - * @return string XML data + * @return string XML data * @access private */ function serialize($use='encoded') { @@ -1263,8 +1263,8 @@ class soapval extends nusoap_base { /** * decodes a soapval object into a PHP native type * - * @param object $soapval optional SOAPx4 soapval object, else uses self - * @return mixed + * @param object $soapval optional SOAPx4 soapval object, else uses self + * @return mixed * @access public */ function decode(){ @@ -1354,9 +1354,9 @@ class soap_transport_http extends nusoap_base { /** * send the SOAP message via HTTP * - * @param string $data message data - * @param integer $timeout set timeout in seconds - * @return string data + * @param string $data message data + * @param integer $timeout set timeout in seconds + * @return string data * @access public */ function send($data, $timeout=0) { @@ -1509,9 +1509,9 @@ class soap_transport_http extends nusoap_base { /** * send the SOAP message via HTTPS 1.0 using CURL * - * @param string $msg message data - * @param integer $timeout set timeout in seconds - * @return string data + * @param string $msg message data + * @param integer $timeout set timeout in seconds + * @return string data * @access public */ function sendHTTPS($data, $timeout=0) { @@ -1673,8 +1673,8 @@ class soap_transport_http extends nusoap_base { /** * if authenticating, set user credentials here * - * @param string $user - * @param string $pass + * @param string $user + * @param string $pass * @access public */ function setCredentials($username, $password) { @@ -1685,7 +1685,7 @@ class soap_transport_http extends nusoap_base { /** * set the soapaction value * - * @param string $soapaction + * @param string $soapaction * @access public */ function setSOAPAction($soapaction) { @@ -1695,7 +1695,7 @@ class soap_transport_http extends nusoap_base { /** * use http encoding * - * @param string $enc encoding style. supported values: gzip, deflate, or both + * @param string $enc encoding style. supported values: gzip, deflate, or both * @access public */ function setEncoding($enc='gzip, deflate'){ @@ -1706,8 +1706,8 @@ class soap_transport_http extends nusoap_base { /** * set proxy info here * - * @param string $proxyhost - * @param string $proxyport + * @param string $proxyhost + * @param string $proxyport * @access public */ function setProxy($proxyhost, $proxyport) { @@ -1719,7 +1719,7 @@ class soap_transport_http extends nusoap_base { * decode a string that is encoded w/ "chunked' transfer encoding * as defined in RFC2068 19.4.6 * - * @param string $buffer + * @param string $buffer * @returns string * @access public */ @@ -1828,7 +1828,7 @@ class soap_server extends nusoap_base { /** * processes request and returns response * - * @param string $data usually is the value of $HTTP_RAW_POST_DATA + * @param string $data usually is the value of $HTTP_RAW_POST_DATA * @access public */ function service($data){ @@ -1889,8 +1889,8 @@ class soap_server extends nusoap_base { /** * parses request and posts response * - * @param string $data XML string - * @return string XML response msg + * @param string $data XML string + * @return string XML response msg * @access private */ function parse_request($data='') { @@ -2048,7 +2048,7 @@ class soap_server extends nusoap_base { * and compares to the method's signature, if available. * * @param mixed - * @return boolean + * @return boolean * @access private */ function verify_method($operation,$request){ @@ -2065,9 +2065,9 @@ class soap_server extends nusoap_base { /** * add a method to the dispatch map * - * @param string $methodname - * @param string $in array of input values - * @param string $out array of output values + * @param string $methodname + * @param string $in array of input values + * @param string $out array of output values * @access public */ function add_to_map($methodname,$in,$out){ @@ -2077,12 +2077,12 @@ class soap_server extends nusoap_base { /** * register a service with the server * - * @param string $methodname - * @param string $in assoc array of input values: key = param name, value = param type - * @param string $out assoc array of output values: key = param name, value = param type - * @param string $namespace - * @param string $soapaction - * @param string $style (rpc|literal) + * @param string $methodname + * @param string $in assoc array of input values: key = param name, value = param type + * @param string $out assoc array of output values: key = param name, value = param type + * @param string $namespace + * @param string $soapaction + * @param string $style (rpc|literal) * @access public */ function register($name,$in=false,$out=false,$namespace=false,$soapaction=false,$style=false,$use=false){ @@ -2525,8 +2525,8 @@ class wsdl extends XMLSchema { * start-element handler * * @param string $parser XML parser object - * @param string $name element name - * @param string $attrs associative array of attributes + * @param string $name element name + * @param string $attrs associative array of attributes * @access private */ function start_element($parser, $name, $attrs) @@ -2719,7 +2719,7 @@ class wsdl extends XMLSchema { * end-element handler * * @param string $parser XML parser object - * @param string $name element name + * @param string $name element name * @access private */ function end_element($parser, $name){ @@ -2744,7 +2744,7 @@ class wsdl extends XMLSchema { * element content handler * * @param string $parser XML parser object - * @param string $data element content + * @param string $data element content * @access private */ function character_data($parser, $data) @@ -2770,7 +2770,7 @@ class wsdl extends XMLSchema { * NOTE: currently only supports multiple services of differing binding types * This method needs some work * - * @param string $bindingType eg: soap, smtp, dime (only soap is currently supported) + * @param string $bindingType eg: soap, smtp, dime (only soap is currently supported) * @return array * @access public */ @@ -2793,8 +2793,8 @@ class wsdl extends XMLSchema { /** * returns an associative array of data necessary for calling an operation * - * @param string $operation , name of operation - * @param string $bindingType , type of binding eg: soap + * @param string $operation , name of operation + * @param string $bindingType , type of binding eg: soap * @return array * @access public */ @@ -2972,10 +2972,10 @@ class wsdl extends XMLSchema { /** * serializes a PHP value according a given type definition * - * @param string $name , name of type (part) - * @param string $type , type of type, heh (type or element) - * @param mixed $value , a native PHP value (parameter value) - * @param string $use , use for part (encoded|literal) + * @param string $name , name of type (part) + * @param string $type , type of type, heh (type or element) + * @param mixed $value , a native PHP value (parameter value) + * @param string $use , use for part (encoded|literal) * @return string serialization * @access public */ @@ -3115,11 +3115,11 @@ class wsdl extends XMLSchema { * register a service with the server * * @param string $methodname - * @param string $in assoc array of input values: key = param name, value = param type - * @param string $out assoc array of output values: key = param name, value = param type + * @param string $in assoc array of input values: key = param name, value = param type + * @param string $out assoc array of output values: key = param name, value = param type * @param string $namespace * @param string $soapaction - * @param string $style (rpc|literal) + * @param string $style (rpc|literal) * @access public */ function addOperation($name, $in = false, $out = false, $namespace = false, $soapaction = false, $style = 'rpc', $use = 'encoded', $documentation = '') @@ -3224,8 +3224,8 @@ class soap_parser extends nusoap_base { /** * constructor * - * @param string $xml SOAP message - * @param string $encoding character encoding scheme of message + * @param string $xml SOAP message + * @param string $encoding character encoding scheme of message * @access public */ function soap_parser($xml,$encoding='UTF-8',$method=''){ @@ -3663,9 +3663,9 @@ class pwsoapclient extends nusoap_base { /** * constructor * - * @param string $endpoint SOAP server or WSDL URL - * @param bool $wsdl optional, set to true if using WSDL - * @param int $portName optional portName in WSDL document + * @param string $endpoint SOAP server or WSDL URL + * @param bool $wsdl optional, set to true if using WSDL + * @param int $portName optional portName in WSDL document * @access public */ function soapclient($endpoint,$wsdl = false){ @@ -3697,14 +3697,14 @@ class pwsoapclient extends nusoap_base { /** * calls method, returns PHP native type * - * @param string $method SOAP server URL or path - * @param array $params array of parameters, can be associative or not - * @param string $namespace optional method namespace - * @param string $soapAction optional SOAPAction value - * @param boolean $headers optional array of soapval objects for headers - * @param boolean $rpcParams optional treat params as RPC for use="literal" + * @param string $method SOAP server URL or path + * @param array $params array of parameters, can be associative or not + * @param string $namespace optional method namespace + * @param string $soapAction optional SOAPAction value + * @param boolean $headers optional array of soapval objects for headers + * @param boolean $rpcParams optional treat params as RPC for use="literal" * This can be used on a per-call basis to overrider defaultRpcParams. - * @return mixed + * @return mixed * @access public */ function call($operation,$params=array(),$namespace='',$soapAction='',$headers=false,$rpcParams=null){ @@ -3948,7 +3948,7 @@ class pwsoapclient extends nusoap_base { /** * set the SOAP headers * - * @param $headers string XML + * @param $headers string XML * @access public */ function setHeaders($headers){ @@ -3958,7 +3958,7 @@ class pwsoapclient extends nusoap_base { /** * get the response headers * - * @return mixed object SOAPx4 soapval object or empty if no headers + * @return mixed object SOAPx4 soapval object or empty if no headers * @access public */ function getHeaders(){ diff --git a/lib/pear/Cache.php b/lib/pear/Cache.php index a8d49dbb5..058f41c33 100644 --- a/lib/pear/Cache.php +++ b/lib/pear/Cache.php @@ -145,7 +145,7 @@ class Cache extends PEAR { /** * Returns the current caching state. * - * @return boolean The current caching state. + * @return boolean The current caching state. * @access public */ function getCaching() diff --git a/lib/pear/Cache/Container/trifile.php b/lib/pear/Cache/Container/trifile.php index 06193934e..0ab1e0716 100644 --- a/lib/pear/Cache/Container/trifile.php +++ b/lib/pear/Cache/Container/trifile.php @@ -37,9 +37,9 @@ class Cache_Container_trifile extends Cache_Container_file { /** * Fetch cached file. * - * @param string $id Cache ID to fetch - * @param string $group Group to fetch from - * @return array 1-dimensional array in the format: expiration,data,userdata + * @param string $id Cache ID to fetch + * @param string $group Group to fetch from + * @return array 1-dimensional array in the format: expiration,data,userdata */ function fetch($id, $group) { @@ -92,11 +92,11 @@ class Cache_Container_trifile extends Cache_Container_file { /** * Cache file * - * @param string $id Cache ID - * @param mixed $cachedata Data to cache - * @param mixed $expires When the data expires - * @param string $group Cache group to store data in - * @param mixed $userdata Additional data to store + * @param string $id Cache ID + * @param mixed $cachedata Data to cache + * @param mixed $expires When the data expires + * @param string $group Cache group to store data in + * @param mixed $userdata Additional data to store * @return boolean true on success, false otherwise */ function save($id, $cachedata, $expires, $group, $userdata) @@ -120,9 +120,9 @@ class Cache_Container_trifile extends Cache_Container_file { /** * Save data in a file * - * @param string $file File to save data in - * @param string $data Data to save - * @return mixed true on success, Cache_Error otherwise + * @param string $file File to save data in + * @param string $data Data to save + * @return mixed true on success, Cache_Error otherwise */ function _saveData($file, $data) { // Save data diff --git a/lib/pear/DB.php b/lib/pear/DB.php index 14b015d45..7ed2ed088 100644 --- a/lib/pear/DB.php +++ b/lib/pear/DB.php @@ -280,7 +280,7 @@ class DB * @param string $type database type, for example "mysql" * @param array $options associative array of option names and values * - * @return object a new DB object. On error, an error object. + * @return object a new DB object. On error, an error object. * * @see DB_common::setOption() * @access public @@ -341,13 +341,13 @@ class DB * } * ?> * - * @param mixed $dsn string "data source name" or an array in the + * @param mixed $dsn string "data source name" or an array in the * format returned by DB::parseDSN() * - * @param array $options an associative array of option names and + * @param array $options an associative array of option names and * their values * - * @return object a newly created DB connection object, or a DB + * @return object a newly created DB connection object, or a DB * error object on error * * @see DB::parseDSN(), DB_common::setOption(), DB::isError() @@ -732,10 +732,10 @@ class DB_Error extends PEAR_Error /** * DB_Error constructor. * - * @param mixed $code DB error code, or string with error message. - * @param integer $mode what "error mode" to operate in - * @param integer $level what error level to use for $mode & PEAR_ERROR_TRIGGER - * @param mixed $debuginfo additional debug info, such as the last query + * @param mixed $code DB error code, or string with error message. + * @param integer $mode what "error mode" to operate in + * @param integer $level what error level to use for $mode & PEAR_ERROR_TRIGGER + * @param mixed $debuginfo additional debug info, such as the last query * * @access public * @@ -837,10 +837,10 @@ class DB_result * + DB_PORTABILITY_RTRIM * right trim the data * - * @param int $fetchmode how the resulting array should be indexed - * @param int $rownum the row number to fetch + * @param int $fetchmode how the resulting array should be indexed + * @param int $rownum the row number to fetch * - * @return array a row of data, null on no more rows or PEAR_Error + * @return array a row of data, null on no more rows or PEAR_Error * object on error * * @see DB_common::setOption(), DB_common::setFetchMode() @@ -921,10 +921,10 @@ class DB_result * * @param array &$arr (reference) array where data from the row * should be placed - * @param int $fetchmode how the resulting array should be indexed - * @param int $rownum the row number to fetch + * @param int $fetchmode how the resulting array should be indexed + * @param int $rownum the row number to fetch * - * @return mixed DB_OK on success, null on no more rows or + * @return mixed DB_OK on success, null on no more rows or * a DB_Error object on error * * @see DB_common::setOption(), DB_common::setFetchMode() @@ -1032,7 +1032,7 @@ class DB_result /** * Frees the resources allocated for this result set. - * @return int error code + * @return int error code * * @access public */ diff --git a/lib/pear/DB/common.php b/lib/pear/DB/common.php index f136ac094..c56a16756 100644 --- a/lib/pear/DB/common.php +++ b/lib/pear/DB/common.php @@ -226,9 +226,9 @@ class DB_common extends PEAR * InterBase doesn't seem to be able to use delimited identifiers * via PHP 4. They work fine under PHP 5. * - * @param string $str identifier name to be quoted + * @param string $str identifier name to be quoted * - * @return string quoted identifier string + * @return string quoted identifier string * * @since 1.6.0 * @access public @@ -247,9 +247,9 @@ class DB_common extends PEAR * The output depends on the PHP data type of input and the database * type being used. * - * @param mixed $in data to be quoted + * @param mixed $in data to be quoted * - * @return mixed the format of the results depends on the input's + * @return mixed the format of the results depends on the input's * PHP type: * *
    @@ -368,9 +368,9 @@ class DB_common extends PEAR * containing binary data. See the * {@link http://php.net/sqlite_escape_string PHP manual} for more info. * - * @param string $str the string to be escaped + * @param string $str the string to be escaped * - * @return string the escaped string + * @return string the escaped string * * @since 1.6.0 * @see DB_common::quoteSmart() @@ -387,8 +387,8 @@ class DB_common extends PEAR * Tell whether a DB implementation or its backend extension * supports a given feature * - * @param array $feature name of the feature (see the DB class doc) - * @return bool whether this DB implementation supports $feature + * @param array $feature name of the feature (see the DB class doc) + * @return bool whether this DB implementation supports $feature * @access public */ function provides($feature) @@ -405,7 +405,7 @@ class DB_common extends PEAR * Requires that the DB implementation's constructor fills * in the $errorcode_map property. * - * @param mixed $nativecode the native error code, as returned by the + * @param mixed $nativecode the native error code, as returned by the * backend database extension (string or integer) * * @return int a portable DB error code, or DB_ERROR if this DB @@ -468,7 +468,7 @@ class DB_common extends PEAR * @param mixed Native error code, integer or string depending the * backend. * - * @return object a PEAR error object + * @return object a PEAR error object * * @access public * @see PEAR_Error @@ -670,9 +670,9 @@ class DB_common extends PEAR * ?> * * @param string $option option name - * @param mixed $value value for the option + * @param mixed $value value for the option * - * @return int DB_OK on success. DB_Error object on failure. + * @return int DB_OK on success. DB_Error object on failure. * * @see DB_common::$options */ @@ -815,10 +815,10 @@ class DB_common extends PEAR /** * Automaticaly generate an insert or update query and pass it to prepare() * - * @param string $table name of the table - * @param array $table_fields ordered array containing the fields names - * @param int $mode type of query to make (DB_AUTOQUERY_INSERT or DB_AUTOQUERY_UPDATE) - * @param string $where in case of update queries, this string will be put after the sql WHERE statement + * @param string $table name of the table + * @param array $table_fields ordered array containing the fields names + * @param int $mode type of query to make (DB_AUTOQUERY_INSERT or DB_AUTOQUERY_UPDATE) + * @param string $where in case of update queries, this string will be put after the sql WHERE statement * @return resource handle for the query * @see DB_common::prepare(), DB_common::buildManipSQL() * @access public @@ -836,10 +836,10 @@ class DB_common extends PEAR * Automaticaly generate an insert or update query and call prepare() * and execute() with it * - * @param string $table name of the table - * @param array $fields_values assoc ($key=>$value) where $key is a field name and $value its value - * @param int $mode type of query to make (DB_AUTOQUERY_INSERT or DB_AUTOQUERY_UPDATE) - * @param string $where in case of update queries, this string will be put after the sql WHERE statement + * @param string $table name of the table + * @param array $fields_values assoc ($key=>$value) where $key is a field name and $value its value + * @param int $mode type of query to make (DB_AUTOQUERY_INSERT or DB_AUTOQUERY_UPDATE) + * @param string $where in case of update queries, this string will be put after the sql WHERE statement * @return mixed a new DB_Result or a DB_Error when fail * @see DB_common::autoPrepare(), DB_common::buildManipSQL() * @access public @@ -865,10 +865,10 @@ class DB_common extends PEAR * - Be carefull ! If you don't give a $where param with an UPDATE query, all * the records of the table will be updated ! * - * @param string $table name of the table - * @param array $table_fields ordered array containing the fields names - * @param int $mode type of query to make (DB_AUTOQUERY_INSERT or DB_AUTOQUERY_UPDATE) - * @param string $where in case of update queries, this string will be put after the sql WHERE statement + * @param string $table name of the table + * @param array $table_fields ordered array containing the fields names + * @param int $mode type of query to make (DB_AUTOQUERY_INSERT or DB_AUTOQUERY_UPDATE) + * @param string $where in case of update queries, this string will be put after the sql WHERE statement * @return string sql query for prepare() * @access public */ @@ -930,14 +930,14 @@ class DB_common extends PEAR * $res =& $dbh->execute($sth, $data); * ?> * - * @param resource $stmt a DB statement resource returned from prepare() - * @param mixed $data array, string or numeric data to be used in + * @param resource $stmt a DB statement resource returned from prepare() + * @param mixed $data array, string or numeric data to be used in * execution of the statement. Quantity of items * passed must match quantity of placeholders in * query: meaning 1 placeholder for non-array * parameters or 1 placeholder per array element. * - * @return object a new DB_Result or a DB_Error when fail + * @return object a new DB_Result or a DB_Error when fail * * {@internal ibase and oci8 have their own execute() methods.}} * @@ -966,8 +966,8 @@ class DB_common extends PEAR /** * Emulates the execute statement, when not supported * - * @param resource $stmt a DB statement resource returned from execute() - * @param mixed $data array, string or numeric data to be used in + * @param resource $stmt a DB statement resource returned from execute() + * @param mixed $data array, string or numeric data to be used in * execution of the statement. Quantity of items * passed must match quantity of placeholders in * query: meaning 1 placeholder for non-array @@ -1077,7 +1077,7 @@ class DB_common extends PEAR * It is defined here to assure that all implementations * have this method defined. * - * @param string $query query to modify + * @param string $query query to modify * * @return the new (modified) query * @@ -1124,7 +1124,7 @@ class DB_common extends PEAR * query: meaning 1 placeholder for non-array * parameters or 1 placeholder per array element. * - * @return mixed a DB_result object or DB_OK on success, a DB + * @return mixed a DB_result object or DB_OK on success, a DB * error on failure * * @see DB_result, DB_common::prepare(), DB_common::execute() @@ -1157,9 +1157,9 @@ class DB_common extends PEAR /** * Generates a limited query * - * @param string $query query - * @param integer $from the row to start to fetching - * @param integer $count the numbers of rows to fetch + * @param string $query query + * @param integer $from the row to start to fetching + * @param integer $count the numbers of rows to fetch * @param array $params required for a statement * * @return mixed a DB_Result object, DB_OK or a DB_Error @@ -1196,7 +1196,7 @@ class DB_common extends PEAR * query: meaning 1 placeholder for non-array * parameters or 1 placeholder per array element. * - * @return mixed the returned value of the query. DB_Error on failure. + * @return mixed the returned value of the query. DB_Error on failure. * * @access public */ @@ -1241,7 +1241,7 @@ class DB_common extends PEAR * Quantity of array elements must match quantity * of placeholders in query. This function does * NOT support scalars. - * @param int $fetchmode the fetch mode to use + * @param int $fetchmode the fetch mode to use * * @return array the first row of results as an array indexed from * 0, or a DB error code. @@ -1302,16 +1302,16 @@ class DB_common extends PEAR * Fetch a single column from a result set and return it as an * indexed array * - * @param string $query the SQL query - * @param mixed $col which column to return (integer [column number, + * @param string $query the SQL query + * @param mixed $col which column to return (integer [column number, * starting at 0] or string [column name]) - * @param mixed $params array, string or numeric data to be used in + * @param mixed $params array, string or numeric data to be used in * execution of the statement. Quantity of items * passed must match quantity of placeholders in * query: meaning 1 placeholder for non-array * parameters or 1 placeholder per array element. * - * @return array an indexed array with the data from the first + * @return array an indexed array with the data from the first * row at index 0, or a DB error code * * @see DB_common::query() @@ -1418,24 +1418,24 @@ class DB_common extends PEAR * Keep in mind that database functions in PHP usually return string * values for results regardless of the database's internal type. * - * @param string $query the SQL query - * @param boolean $force_array used only when the query returns + * @param string $query the SQL query + * @param boolean $force_array used only when the query returns * exactly two columns. If true, the values * of the returned array will be one-element * arrays instead of scalars. - * @param mixed $params array, string or numeric data to be used in + * @param mixed $params array, string or numeric data to be used in * execution of the statement. Quantity of items * passed must match quantity of placeholders in * query: meaning 1 placeholder for non-array * parameters or 1 placeholder per array element. - * @param boolean $group if true, the values of the returned array + * @param boolean $group if true, the values of the returned array * is wrapped in another array. If the same * key value (in the first column) repeats * itself, the values will be appended to * this array instead of overwriting the * existing values. * - * @return array associative array with results from the query. + * @return array associative array with results from the query. * DB Error on failure. * * @access public @@ -1541,9 +1541,9 @@ class DB_common extends PEAR * Quantity of array elements must match quantity * of placeholders in query. This function does * NOT support scalars. - * @param int $fetchmode the fetch mode to use + * @param int $fetchmode the fetch mode to use * - * @return array an nested array. DB error on failure. + * @return array an nested array. DB error on failure. * * @access public */ @@ -1611,8 +1611,8 @@ class DB_common extends PEAR /** * enable automatic Commit * - * @param boolean $onoff - * @return mixed DB_Error + * @param boolean $onoff + * @return mixed DB_Error * * @access public */ @@ -1707,9 +1707,9 @@ class DB_common extends PEAR * The createSequence() docblock contains notes about storing sequence * names. * - * @param string $sqn the sequence's public name + * @param string $sqn the sequence's public name * - * @return string the sequence's name in the backend + * @return string the sequence's name in the backend * * @see DB_common::createSequence(), DB_common::dropSequence(), * DB_common::nextID(), DB_common::setOption() @@ -1727,11 +1727,11 @@ class DB_common extends PEAR /** * Returns the next free id in a sequence * - * @param string $seq_name name of the sequence - * @param boolean $ondemand when true, the seqence is automatically + * @param string $seq_name name of the sequence + * @param boolean $ondemand when true, the seqence is automatically * created if it does not exist * - * @return int the next id number in the sequence. DB_Error if problem. + * @return int the next id number in the sequence. DB_Error if problem. * * @see DB_common::createSequence(), DB_common::dropSequence(), * DB_common::getSequenceName() @@ -1755,9 +1755,9 @@ class DB_common extends PEAR * * seqname_format is set via setOption(). * - * @param string $seq_name name of the new sequence + * @param string $seq_name name of the new sequence * - * @return int DB_OK on success. A DB_Error object is returned if + * @return int DB_OK on success. A DB_Error object is returned if * problems arise. * * @see DB_common::dropSequence(), DB_common::getSequenceName(), @@ -1775,9 +1775,9 @@ class DB_common extends PEAR /** * Deletes a sequence * - * @param string $seq_name name of the sequence to be deleted + * @param string $seq_name name of the sequence to be deleted * - * @return int DB_OK on success. DB_Error if problems. + * @return int DB_OK on success. DB_Error if problems. * * @see DB_common::createSequence(), DB_common::getSequenceName(), * DB_common::nextID() @@ -1894,18 +1894,18 @@ class DB_common extends PEAR * If the 'portability' option has DB_PORTABILITY_LOWERCASE * turned on, the names of tables and fields will be lowercased. * - * @param object|string $result DB_result object from a query or a + * @param object|string $result DB_result object from a query or a * string containing the name of a table. * While this also accepts a query result * resource identifier, this behavior is * deprecated. - * @param int $mode either unused or one of the tableInfo modes: + * @param int $mode either unused or one of the tableInfo modes: * DB_TABLEINFO_ORDERTABLE, * DB_TABLEINFO_ORDER or * DB_TABLEINFO_FULL (which does both). * These are bitwise, so the first two can be * combined using |. - * @return array an associative array with the information requested. + * @return array an associative array with the information requested. * If something goes wrong an error object is returned. * * @see DB_common::setOption() @@ -1982,7 +1982,7 @@ class DB_common extends PEAR /** * Right trim all strings in an array * - * @param array $array the array to be trimmed (passed by reference) + * @param array $array the array to be trimmed (passed by reference) * @return void * @access private */ @@ -2001,7 +2001,7 @@ class DB_common extends PEAR /** * Convert all null values in an array to empty strings * - * @param array $array the array to be de-nullified (passed by reference) + * @param array $array the array to be de-nullified (passed by reference) * @return void * @access private */ diff --git a/lib/pear/DB/dbase.php b/lib/pear/DB/dbase.php index 4b715053c..7072fa8e5 100644 --- a/lib/pear/DB/dbase.php +++ b/lib/pear/DB/dbase.php @@ -119,11 +119,11 @@ class DB_dbase extends DB_common * Formating of the array and the data therein are configurable. * See DB_result::fetchInto() for more information. * - * @param resource $result query result identifier - * @param array $arr (reference) array where data from the row + * @param resource $result query result identifier + * @param array $arr (reference) array where data from the row * should be placed - * @param int $fetchmode how the resulting array should be indexed - * @param int $rownum the row number to fetch + * @param int $fetchmode how the resulting array should be indexed + * @param int $rownum the row number to fetch * * @return mixed DB_OK on success, null when end of result set is * reached or on failure @@ -178,7 +178,7 @@ class DB_dbase extends DB_common /** * Format input so it can be safely used in a query * - * @param mixed $in data to be quoted + * @param mixed $in data to be quoted * * @return mixed Submitted variable's type = returned value: * + null = the string NULL diff --git a/lib/pear/DB/fbsql.php b/lib/pear/DB/fbsql.php index 4e0a8c83b..92d581f52 100644 --- a/lib/pear/DB/fbsql.php +++ b/lib/pear/DB/fbsql.php @@ -221,11 +221,11 @@ class DB_fbsql extends DB_common * Formating of the array and the data therein are configurable. * See DB_result::fetchInto() for more information. * - * @param resource $result query result identifier - * @param array $arr (reference) array where data from the row + * @param resource $result query result identifier + * @param array $arr (reference) array where data from the row * should be placed - * @param int $fetchmode how the resulting array should be indexed - * @param int $rownum the row number to fetch + * @param int $fetchmode how the resulting array should be indexed + * @param int $rownum the row number to fetch * * @return mixed DB_OK on success, null when end of result set is * reached or on failure @@ -394,11 +394,11 @@ class DB_fbsql extends DB_common /** * Returns the next free id in a sequence * - * @param string $seq_name name of the sequence - * @param boolean $ondemand when true, the seqence is automatically + * @param string $seq_name name of the sequence + * @param boolean $ondemand when true, the seqence is automatically * created if it does not exist * - * @return int the next id number in the sequence. DB_Error if problem. + * @return int the next id number in the sequence. DB_Error if problem. * * @internal * @see DB_common::nextID() @@ -430,9 +430,9 @@ class DB_fbsql extends DB_common /** * Creates a new sequence * - * @param string $seq_name name of the new sequence + * @param string $seq_name name of the new sequence * - * @return int DB_OK on success. A DB_Error object is returned if + * @return int DB_OK on success. A DB_Error object is returned if * problems arise. * * @internal @@ -453,9 +453,9 @@ class DB_fbsql extends DB_common /** * Deletes a sequence * - * @param string $seq_name name of the sequence to be deleted + * @param string $seq_name name of the sequence to be deleted * - * @return int DB_OK on success. DB_Error if problems. + * @return int DB_OK on success. DB_Error if problems. * * @internal * @see DB_common::dropSequence() @@ -489,7 +489,7 @@ class DB_fbsql extends DB_common /** * Format input so it can be safely used in a query * - * @param mixed $in data to be quoted + * @param mixed $in data to be quoted * * @return mixed Submitted variable's type = returned value: * + null = the string NULL @@ -521,9 +521,9 @@ class DB_fbsql extends DB_common * Gather information about an error, then use that info to create a * DB error object and finally return that object. * - * @param integer $errno PEAR error number (usually a DB constant) if + * @param integer $errno PEAR error number (usually a DB constant) if * manually raising an error - * @return object DB error object + * @return object DB error object * @see DB_common::errorCode() * @see DB_common::raiseError() */ @@ -542,10 +542,10 @@ class DB_fbsql extends DB_common /** * Returns information about a table or a result set. * - * @param object|string $result DB_result object from a query or a + * @param object|string $result DB_result object from a query or a * string containing the name of a table - * @param int $mode a valid tableInfo mode - * @return array an associative array with the information requested + * @param int $mode a valid tableInfo mode + * @return array an associative array with the information requested * or an error object if something is wrong * @access public * @internal @@ -629,7 +629,7 @@ class DB_fbsql extends DB_common /** * Returns the query needed to get some backend info - * @param string $type What kind of info you want to retrieve + * @param string $type What kind of info you want to retrieve * @return string The SQL query string */ function getSpecialQuery($type) diff --git a/lib/pear/DB/ibase.php b/lib/pear/DB/ibase.php index 8b96687d7..1224f36cc 100644 --- a/lib/pear/DB/ibase.php +++ b/lib/pear/DB/ibase.php @@ -207,11 +207,11 @@ class DB_ibase extends DB_common * Formating of the array and the data therein are configurable. * See DB_result::fetchInto() for more information. * - * @param resource $result query result identifier - * @param array $arr (reference) array where data from the row + * @param resource $result query result identifier + * @param array $arr (reference) array where data from the row * should be placed - * @param int $fetchmode how the resulting array should be indexed - * @param int $rownum the row number to fetch + * @param int $fetchmode how the resulting array should be indexed + * @param int $rownum the row number to fetch * * @return mixed DB_OK on success, null when end of result set is * reached or on failure @@ -303,8 +303,8 @@ class DB_ibase extends DB_common * "UPDATE foo SET col=? WHERE col='over \& under'" * * - * @param string $query query to be prepared - * @return mixed DB statement resource on success. DB_Error on failure. + * @param string $query query to be prepared + * @return mixed DB statement resource on success. DB_Error on failure. */ function prepare($query) { @@ -346,13 +346,13 @@ class DB_ibase extends DB_common /** * Executes a DB statement prepared with prepare(). * - * @param resource $stmt a DB statement resource returned from prepare() - * @param mixed $data array, string or numeric data to be used in + * @param resource $stmt a DB statement resource returned from prepare() + * @param mixed $data array, string or numeric data to be used in * execution of the statement. Quantity of items * passed must match quantity of placeholders in * query: meaning 1 for non-array items or the * quantity of elements in the array. - * @return object a new DB_Result or a DB_Error when fail + * @return object a new DB_Result or a DB_Error when fail * @see DB_ibase::prepare() * @access public */ @@ -469,11 +469,11 @@ class DB_ibase extends DB_common /** * Returns the next free id in a sequence * - * @param string $seq_name name of the sequence - * @param boolean $ondemand when true, the seqence is automatically + * @param string $seq_name name of the sequence + * @param boolean $ondemand when true, the seqence is automatically * created if it does not exist * - * @return int the next id number in the sequence. DB_Error if problem. + * @return int the next id number in the sequence. DB_Error if problem. * * @internal * @see DB_common::nextID() @@ -513,8 +513,8 @@ class DB_ibase extends DB_common /** * Create the sequence * - * @param string $seq_name the name of the sequence - * @return mixed DB_OK on success or DB error on error + * @param string $seq_name the name of the sequence + * @return mixed DB_OK on success or DB error on error * @access public */ function createSequence($seq_name) @@ -533,8 +533,8 @@ class DB_ibase extends DB_common /** * Drop a sequence * - * @param string $seq_name the name of the sequence - * @return mixed DB_OK on success or DB error on error + * @param string $seq_name the name of the sequence + * @return mixed DB_OK on success or DB error on error * @access public */ function dropSequence($seq_name) @@ -622,10 +622,10 @@ class DB_ibase extends DB_common * NOTE: only supports 'table' and 'flags' if $result * is a table name. * - * @param object|string $result DB_result object from a query or a + * @param object|string $result DB_result object from a query or a * string containing the name of a table - * @param int $mode a valid tableInfo mode - * @return array an associative array with the information requested + * @param int $mode a valid tableInfo mode + * @return array an associative array with the information requested * or an error object if something is wrong * @access public * @internal @@ -714,10 +714,10 @@ class DB_ibase extends DB_common * Gather information about an error, then use that info to create a * DB error object and finally return that object. * - * @param integer $db_errno PEAR error number (usually a DB constant) if + * @param integer $db_errno PEAR error number (usually a DB constant) if * manually raising an error - * @param string $native_errmsg text of error message if known - * @return object DB error object + * @param string $native_errmsg text of error message if known + * @return object DB error object * @see DB_common::errorCode() * @see DB_common::raiseError() */ diff --git a/lib/pear/DB/ifx.php b/lib/pear/DB/ifx.php index 5be280d9f..a2bce713e 100644 --- a/lib/pear/DB/ifx.php +++ b/lib/pear/DB/ifx.php @@ -235,11 +235,11 @@ class DB_ifx extends DB_common * Formating of the array and the data therein are configurable. * See DB_result::fetchInto() for more information. * - * @param resource $result query result identifier - * @param array $arr (reference) array where data from the row + * @param resource $result query result identifier + * @param array $arr (reference) array where data from the row * should be placed - * @param int $fetchmode how the resulting array should be indexed - * @param int $rownum the row number to fetch + * @param int $fetchmode how the resulting array should be indexed + * @param int $rownum the row number to fetch * * @return mixed DB_OK on success, null when end of result set is * reached or on failure @@ -384,9 +384,9 @@ class DB_ifx extends DB_common * Gather information about an error, then use that info to create a * DB error object and finally return that object. * - * @param integer $errno PEAR error number (usually a DB constant) if + * @param integer $errno PEAR error number (usually a DB constant) if * manually raising an error - * @return object DB error object + * @return object DB error object * @see errorNative() * @see errorCode() * @see DB_common::raiseError() @@ -410,8 +410,8 @@ class DB_ifx extends DB_common * Requires that the DB implementation's constructor fills * in the $errorcode_map property. * - * @param string $nativecode error code returned by the database - * @return int a portable DB error code, or DB_ERROR if this DB + * @param string $nativecode error code returned by the database + * @return int a portable DB error code, or DB_ERROR if this DB * implementation has no mapping for the given error code. */ function errorCode($nativecode) @@ -444,7 +444,7 @@ class DB_ifx extends DB_common /** * Returns the query needed to get some backend info - * @param string $type What kind of info you want to retrieve + * @param string $type What kind of info you want to retrieve * @return string The SQL query string */ function getSpecialQuery($type) @@ -469,10 +469,10 @@ class DB_ifx extends DB_common * an error will be raised saying * can't distinguish duplicate field names. * - * @param object|string $result DB_result object from a query or a + * @param object|string $result DB_result object from a query or a * string containing the name of a table - * @param int $mode a valid tableInfo mode - * @return array an associative array with the information requested + * @param int $mode a valid tableInfo mode + * @return array an associative array with the information requested * or an error object if something is wrong * @access public * @internal diff --git a/lib/pear/DB/ldap.php b/lib/pear/DB/ldap.php index f4eeb8f4e..f6a5ef330 100644 --- a/lib/pear/DB/ldap.php +++ b/lib/pear/DB/ldap.php @@ -71,7 +71,7 @@ class LDAP_result extends DB_result /** * class constructor, calls DB_result constructor - * @param ref $dbh reference to the db instance + * @param ref $dbh reference to the db instance * @param resource $result ldap command result */ function LDAP_result(&$dbh, $result) @@ -84,8 +84,8 @@ class LDAP_result extends DB_result * * called once as soon as something needs to be returned * @access private - * @param resource $result ldap command result - * @return boolean true + * @param resource $result ldap command result + * @return boolean true */ function getRows() { if ($this->_recordset === null) { @@ -146,10 +146,10 @@ class LDAP_result extends DB_result /** * Fetch and return a row of data (it uses driver->fetchInto for that) - * @param int $fetchmode format of fetched row - * @param int $rownum the row number to fetch + * @param int $fetchmode format of fetched row + * @param int $rownum the row number to fetch * - * @return array a row of data, NULL on no more rows or PEAR_Error on error + * @return array a row of data, NULL on no more rows or PEAR_Error on error * * @access public */ @@ -167,11 +167,11 @@ class LDAP_result extends DB_result /** * Fetch a row of data into an existing variable. * - * @param mixed $arr reference to data containing the row - * @param integer $fetchmode format of fetched row - * @param integer $rownum the row number to fetch + * @param mixed $arr reference to data containing the row + * @param integer $fetchmode format of fetched row + * @param integer $rownum the row number to fetch * - * @return mixed DB_OK on success, NULL on no more rows or + * @return mixed DB_OK on success, NULL on no more rows or * a DB_Error object on error * * @access public @@ -194,10 +194,10 @@ class LDAP_result extends DB_result * * returns a hash of all records, basically returning * a copy of $this->_recordset - * @param integer $fetchmode format of fetched row - * @param integer $rownum the row number to fetch (not used, here for interface compatibility) + * @param integer $fetchmode format of fetched row + * @param integer $rownum the row number to fetch (not used, here for interface compatibility) * - * @return mixed DB_OK on success, NULL on no more rows or + * @return mixed DB_OK on success, NULL on no more rows or * a DB_Error object on error * * @access public @@ -253,7 +253,7 @@ class LDAP_result extends DB_result /** * Frees the resources allocated for this result set. - * @return int error code + * @return int error code * * @access public */ @@ -357,9 +357,9 @@ class DB_ldap extends DB_common /** * Connect and bind to LDAP server with either anonymous or authenticated bind depending on dsn info * - * @param array $dsninfo dsn info as passed by DB::connect() - * @param boolean $persistent kept for interface compatibility - * @return DB_OK if successfully connected. A DB error code is returned on failure. + * @param array $dsninfo dsn info as passed by DB::connect() + * @param boolean $persistent kept for interface compatibility + * @return DB_OK if successfully connected. A DB error code is returned on failure. */ function connect($dsninfo, $persistent = false) { @@ -412,9 +412,9 @@ class DB_ldap extends DB_common * depend on two additional parameters, added in respect to the * DB_common interface. * - * @param string $filter text of the request to send to the LDAP server - * @param string $action type of request to perform, defaults to search (ldap_search()) - * @param array $params array of additional parameters to pass to the PHP ldap function requested + * @param string $filter text of the request to send to the LDAP server + * @param string $action type of request to perform, defaults to search (ldap_search()) + * @param array $params array of additional parameters to pass to the PHP ldap function requested * @return result from ldap function or DB Error object if no result */ function simpleQuery($filter, $action = null, $params = null) @@ -499,10 +499,10 @@ class DB_ldap extends DB_common /** * Executes a query performing variables substitution in the query text * - * @param string $stmt text of the request to send to the LDAP server - * @param array $data query variables values to substitute - * @param string $action type of request to perform, defaults to search (ldap_search()) - * @param array $params array of additional parameters to pass to the PHP ldap function requested + * @param string $stmt text of the request to send to the LDAP server + * @param array $data query variables values to substitute + * @param string $action type of request to perform, defaults to search (ldap_search()) + * @param array $params array of additional parameters to pass to the PHP ldap function requested * @return LDAP_result object or DB Error object if no result * @see DB_common::executeEmulateQuery $this->simpleQuery() */ @@ -525,10 +525,10 @@ class DB_ldap extends DB_common /** * Executes multiple queries performing variables substitution for each query * - * @param string $stmt text of the request to send to the LDAP server - * @param array $data query variables values to substitute - * @param string $action type of request to perform, defaults to search (ldap_search()) - * @param array $params array of additional parameters to pass to the PHP ldap function requested + * @param string $stmt text of the request to send to the LDAP server + * @param array $data query variables values to substitute + * @param string $action type of request to perform, defaults to search (ldap_search()) + * @param array $params array of additional parameters to pass to the PHP ldap function requested * @return LDAP_result object or DB Error object if no result * @see DB_common::executeMultiple */ @@ -542,10 +542,10 @@ class DB_ldap extends DB_common /** * Executes a query substituting variables if any are present * - * @param string $query text of the request to send to the LDAP server - * @param array $data query variables values to substitute - * @param string $action type of request to perform, defaults to search (ldap_search()) - * @param array $params array of additional parameters to pass to the PHP ldap function requested + * @param string $query text of the request to send to the LDAP server + * @param array $data query variables values to substitute + * @param string $action type of request to perform, defaults to search (ldap_search()) + * @param array $params array of additional parameters to pass to the PHP ldap function requested * @return LDAP_result object or DB Error object if no result * @see DB_common::prepare() $this->execute()$this->simpleQuery() */ @@ -571,9 +571,9 @@ class DB_ldap extends DB_common /** * Modifies a query to return only a set of rows, stores $from and $count for LDAP_result * - * @param string $query text of the request to send to the LDAP server - * @param int $from record position from which to start returning data - * @param int $count number of records to return + * @param string $query text of the request to send to the LDAP server + * @param int $from record position from which to start returning data + * @param int $count number of records to return * @return modified query text (no modifications are made, see above) */ function modifyLimitQuery($query, $from, $count) @@ -589,11 +589,11 @@ class DB_ldap extends DB_common * This method only saves the $from and $count parameters for LDAP_result * where the actual records processing takes place * - * @param string $query text of the request to send to the LDAP server - * @param int $from record position from which to start returning data - * @param int $count number of records to return - * @param string $action type of request to perform, defaults to search (ldap_search()) - * @param array $params array of additional parameters to pass to the PHP ldap function requested + * @param string $query text of the request to send to the LDAP server + * @param int $from record position from which to start returning data + * @param int $count number of records to return + * @param string $action type of request to perform, defaults to search (ldap_search()) + * @param array $params array of additional parameters to pass to the PHP ldap function requested * @return LDAP_result object or DB Error object if no result */ function limitQuery($query, $from, $count, $action = 'search', $params = array()) @@ -612,8 +612,8 @@ class DB_ldap extends DB_common * @param $query the SQL query * @param $data if supplied, prepare/execute will be used * with this array as execute parameters - * @param string $action type of request to perform, defaults to search (ldap_search()) - * @param array $params array of additional parameters to pass to the PHP ldap function requested + * @param string $action type of request to perform, defaults to search (ldap_search()) + * @param array $params array of additional parameters to pass to the PHP ldap function requested * @return array * @see DB_common::getOne() * @access public @@ -634,7 +634,7 @@ class DB_ldap extends DB_common * @param $data array if supplied, prepare/execute will be used * with this array as execute parameters * @param string $action type of request to perform, defaults to search (ldap_search()) - * @param array $params array of additional parameters to pass to the PHP ldap function requested + * @param array $params array of additional parameters to pass to the PHP ldap function requested * @access public * @return array the first row of results as an array indexed from * 0, or a DB error code. @@ -661,7 +661,7 @@ class DB_ldap extends DB_common * @param $data array if supplied, prepare/execute will be used * with this array as execute parameters * @param string $action type of request to perform, defaults to search (ldap_search()) - * @param array $params array of additional parameters to pass to the PHP ldap function requested + * @param array $params array of additional parameters to pass to the PHP ldap function requested * @access public * @return array an indexed array with the data from the first * row at index 0, or a DB error code. @@ -686,9 +686,9 @@ class DB_ldap extends DB_common * @param array $data if supplied, prepare/execute will be used * with this array as execute parameters * @param $fetchmode the fetch mode to use - * @param boolean $group see DB_Common::getAssoc() - * @param string $action type of request to perform, defaults to search (ldap_search()) - * @param array $params array of additional parameters to pass to the PHP ldap function requested + * @param boolean $group see DB_Common::getAssoc() + * @param string $action type of request to perform, defaults to search (ldap_search()) + * @param array $params array of additional parameters to pass to the PHP ldap function requested * @access public * @return array an indexed array with the data from the first * row at index 0, or a DB error code. @@ -712,7 +712,7 @@ class DB_ldap extends DB_common * with this array as execute parameters * @param $fetchmode the fetch mode to use * @param string $action type of request to perform, defaults to search (ldap_search()) - * @param array $params array of additional parameters to pass to the PHP ldap function requested + * @param array $params array of additional parameters to pass to the PHP ldap function requested * @access public * @return array an nested array, or a DB error * @see DB_common::getAll() @@ -778,9 +778,9 @@ class DB_ldap extends DB_common * The name of sequence is LDAP DN of entry. * * @access public - * @param string $seq_name the DN of the sequence - * @param bool $ondemand whether to create the sequence on demand - * @return a sequence integer, or a DB error + * @param string $seq_name the DN of the sequence + * @param bool $ondemand whether to create the sequence on demand + * @return a sequence integer, or a DB error */ function nextId($seq_name, $ondemand = true) { @@ -859,8 +859,8 @@ class DB_ldap extends DB_common * cn: $seq_value * uid: $seq_uniq * - * @param string $seq_name the DN of the sequence - * @return mixed DB_OK on success or DB error on error + * @param string $seq_name the DN of the sequence + * @return mixed DB_OK on success or DB error on error * @access public */ function createSequence($seq_name) @@ -888,8 +888,8 @@ class DB_ldap extends DB_common /** * Drop a sequence * - * @param string $seq_name the DN of the sequence - * @return mixed DB_OK on success or DB error on error + * @param string $seq_name the DN of the sequence + * @return mixed DB_OK on success or DB error on error * @access public */ function dropSequence($seq_name) diff --git a/lib/pear/DB/msql.php b/lib/pear/DB/msql.php index c135b3274..40cd7bb0f 100644 --- a/lib/pear/DB/msql.php +++ b/lib/pear/DB/msql.php @@ -140,11 +140,11 @@ class DB_msql extends DB_common * Formating of the array and the data therein are configurable. * See DB_result::fetchInto() for more information. * - * @param resource $result query result identifier - * @param array $arr (reference) array where data from the row + * @param resource $result query result identifier + * @param array $arr (reference) array where data from the row * should be placed - * @param int $fetchmode how the resulting array should be indexed - * @param int $rownum the row number to fetch + * @param int $fetchmode how the resulting array should be indexed + * @param int $rownum the row number to fetch * * @return mixed DB_OK on success, null when end of result set is * reached or on failure diff --git a/lib/pear/DB/mssql.php b/lib/pear/DB/mssql.php index acf20436b..4f0e3f825 100644 --- a/lib/pear/DB/mssql.php +++ b/lib/pear/DB/mssql.php @@ -175,11 +175,11 @@ class DB_mssql extends DB_common * Formating of the array and the data therein are configurable. * See DB_result::fetchInto() for more information. * - * @param resource $result query result identifier - * @param array $arr (reference) array where data from the row + * @param resource $result query result identifier + * @param array $arr (reference) array where data from the row * should be placed - * @param int $fetchmode how the resulting array should be indexed - * @param int $rownum the row number to fetch + * @param int $fetchmode how the resulting array should be indexed + * @param int $rownum the row number to fetch * * @return mixed DB_OK on success, null when end of result set is * reached or on failure @@ -343,11 +343,11 @@ class DB_mssql extends DB_common /** * Returns the next free id in a sequence * - * @param string $seq_name name of the sequence - * @param boolean $ondemand when true, the seqence is automatically + * @param string $seq_name name of the sequence + * @param boolean $ondemand when true, the seqence is automatically * created if it does not exist * - * @return int the next id number in the sequence. DB_Error if problem. + * @return int the next id number in the sequence. DB_Error if problem. * * @internal * @see DB_common::nextID() @@ -389,9 +389,9 @@ class DB_mssql extends DB_common /** * Creates a new sequence * - * @param string $seq_name name of the new sequence + * @param string $seq_name name of the new sequence * - * @return int DB_OK on success. A DB_Error object is returned if + * @return int DB_OK on success. A DB_Error object is returned if * problems arise. * * @internal @@ -412,9 +412,9 @@ class DB_mssql extends DB_common /** * Deletes a sequence * - * @param string $seq_name name of the sequence to be deleted + * @param string $seq_name name of the sequence to be deleted * - * @return int DB_OK on success. DB_Error if problems. + * @return int DB_OK on success. DB_Error if problems. * * @internal * @see DB_common::dropSequence() @@ -432,7 +432,7 @@ class DB_mssql extends DB_common /** * Determine MS SQL Server error code by querying @@ERROR. * - * @return mixed mssql's native error code or DB_ERROR if unknown. + * @return mixed mssql's native error code or DB_ERROR if unknown. */ function errorNative() { @@ -452,8 +452,8 @@ class DB_mssql extends DB_common * * If $nativecode isn't known yet, it will be looked up. * - * @param mixed $nativecode mssql error code, if known - * @return integer an error number from a DB error constant + * @param mixed $nativecode mssql error code, if known + * @return integer an error number from a DB error constant * @see errorNative() */ function errorCode($nativecode = null) @@ -475,9 +475,9 @@ class DB_mssql extends DB_common * Gather information about an error, then use that info to create a * DB error object and finally return that object. * - * @param integer $code PEAR error number (usually a DB constant) if + * @param integer $code PEAR error number (usually a DB constant) if * manually raising an error - * @return object DB error object + * @return object DB error object * @see errorCode() * @see errorNative() * @see DB_common::raiseError() @@ -501,10 +501,10 @@ class DB_mssql extends DB_common * NOTE: only supports 'table' and 'flags' if $result * is a table name. * - * @param object|string $result DB_result object from a query or a + * @param object|string $result DB_result object from a query or a * string containing the name of a table - * @param int $mode a valid tableInfo mode - * @return array an associative array with the information requested + * @param int $mode a valid tableInfo mode + * @return array an associative array with the information requested * or an error object if something is wrong * @access public * @internal @@ -595,7 +595,7 @@ class DB_mssql extends DB_common /** * Returns the query needed to get some backend info - * @param string $type What kind of info you want to retrieve + * @param string $type What kind of info you want to retrieve * @return string The SQL query string */ function getSpecialQuery($type) @@ -713,9 +713,9 @@ class DB_mssql extends DB_common * * Quoting style depends on which database driver is being used. * - * @param string $str identifier name to be quoted + * @param string $str identifier name to be quoted * - * @return string quoted identifier string + * @return string quoted identifier string * * @since 1.6.0 * @access public diff --git a/lib/pear/DB/mysql.php b/lib/pear/DB/mysql.php index c1b08c464..e61091ba3 100644 --- a/lib/pear/DB/mysql.php +++ b/lib/pear/DB/mysql.php @@ -265,11 +265,11 @@ class DB_mysql extends DB_common * Formating of the array and the data therein are configurable. * See DB_result::fetchInto() for more information. * - * @param resource $result query result identifier - * @param array $arr (reference) array where data from the row + * @param resource $result query result identifier + * @param array $arr (reference) array where data from the row * should be placed - * @param int $fetchmode how the resulting array should be indexed - * @param int $rownum the row number to fetch + * @param int $fetchmode how the resulting array should be indexed + * @param int $rownum the row number to fetch * * @return mixed DB_OK on success, null when end of result set is * reached or on failure @@ -482,11 +482,11 @@ class DB_mysql extends DB_common /** * Returns the next free id in a sequence * - * @param string $seq_name name of the sequence - * @param boolean $ondemand when true, the seqence is automatically + * @param string $seq_name name of the sequence + * @param boolean $ondemand when true, the seqence is automatically * created if it does not exist * - * @return int the next id number in the sequence. DB_Error if problem. + * @return int the next id number in the sequence. DB_Error if problem. * * @internal * @see DB_common::nextID() @@ -566,9 +566,9 @@ class DB_mysql extends DB_common /** * Creates a new sequence * - * @param string $seq_name name of the new sequence + * @param string $seq_name name of the new sequence * - * @return int DB_OK on success. A DB_Error object is returned if + * @return int DB_OK on success. A DB_Error object is returned if * problems arise. * * @internal @@ -599,9 +599,9 @@ class DB_mysql extends DB_common /** * Deletes a sequence * - * @param string $seq_name name of the sequence to be deleted + * @param string $seq_name name of the sequence to be deleted * - * @return int DB_OK on success. DB_Error if problems. + * @return int DB_OK on success. DB_Error if problems. * * @internal * @see DB_common::dropSequence() @@ -619,8 +619,8 @@ class DB_mysql extends DB_common * Backwards compatibility with old sequence emulation implementation * (clean up the dupes) * - * @param string $seqname The sequence name to clean up - * @return mixed DB_Error or true + * @param string $seqname The sequence name to clean up + * @return mixed DB_Error or true */ function _BCsequence($seqname) { @@ -670,9 +670,9 @@ class DB_mysql extends DB_common * MySQL can't handle the backtick character (`) in * table or column names. * - * @param string $str identifier name to be quoted + * @param string $str identifier name to be quoted * - * @return string quoted identifier string + * @return string quoted identifier string * * @since 1.6.0 * @access public @@ -700,9 +700,9 @@ class DB_mysql extends DB_common /** * Escape a string according to the current DBMS's standards * - * @param string $str the string to be escaped + * @param string $str the string to be escaped * - * @return string the escaped string + * @return string the escaped string * * @internal */ @@ -749,9 +749,9 @@ class DB_mysql extends DB_common * Gather information about an error, then use that info to create a * DB error object and finally return that object. * - * @param integer $errno PEAR error number (usually a DB constant) if + * @param integer $errno PEAR error number (usually a DB constant) if * manually raising an error - * @return object DB error object + * @return object DB error object * @see DB_common::errorCode() * @see DB_common::raiseError() */ @@ -781,10 +781,10 @@ class DB_mysql extends DB_common /** * Returns information about a table or a result set. * - * @param object|string $result DB_result object from a query or a + * @param object|string $result DB_result object from a query or a * string containing the name of a table - * @param int $mode a valid tableInfo mode - * @return array an associative array with the information requested + * @param int $mode a valid tableInfo mode + * @return array an associative array with the information requested * or an error object if something is wrong * @access public * @internal @@ -868,7 +868,7 @@ class DB_mysql extends DB_common /** * Returns the query needed to get some backend info - * @param string $type What kind of info you want to retrieve + * @param string $type What kind of info you want to retrieve * @return string The SQL query string */ function getSpecialQuery($type) diff --git a/lib/pear/DB/mysqli.php b/lib/pear/DB/mysqli.php index b39f55399..3e4295c4f 100644 --- a/lib/pear/DB/mysqli.php +++ b/lib/pear/DB/mysqli.php @@ -102,7 +102,7 @@ class DB_mysqli extends DB_common /** * Connect to a database and log in as the specified user. * - * @param string $dsn the data source name (see DB::parseDSN for syntax) + * @param string $dsn the data source name (see DB::parseDSN for syntax) * @param boolean $persistent (optional) whether the connection should * be persistent * @return mixed DB_OK on success, a DB error on failure @@ -200,8 +200,8 @@ class DB_mysqli extends DB_common * Send a query to MySQL and return the results as a MySQL resource * identifier. * - * @param string $query the SQL query - * @return mixed a valid MySQL result for successful SELECT + * @param string $query the SQL query + * @return mixed a valid MySQL result for successful SELECT * queries, DB_OK for other successful queries. * A DB error is returned on failure. * @access public @@ -249,7 +249,7 @@ class DB_mysqli extends DB_common * * This method has not been implemented yet. * - * @param resource $result a valid sql result resource + * @param resource $result a valid sql result resource * @return false * @access public */ @@ -267,11 +267,11 @@ class DB_mysqli extends DB_common * Formating of the array and the data therein are configurable. * See DB_result::fetchInto() for more information. * - * @param resource $result query result identifier - * @param array $arr (reference) array where data from the row + * @param resource $result query result identifier + * @param array $arr (reference) array where data from the row * should be placed - * @param int $fetchmode how the resulting array should be indexed - * @param int $rownum the row number to fetch + * @param int $fetchmode how the resulting array should be indexed + * @param int $rownum the row number to fetch * * @return mixed DB_OK on success, null when end of result set is * reached or on failure @@ -321,8 +321,8 @@ class DB_mysqli extends DB_common /** * Free the internal resources associated with $result. * - * @param resource $result MySQL result identifier - * @return bool true on success, false if $result is invalid + * @param resource $result MySQL result identifier + * @return bool true on success, false if $result is invalid * @access public */ function freeResult($result) @@ -360,8 +360,8 @@ class DB_mysqli extends DB_common /** * Get the number of rows in a result set. * - * @param resource $result MySQL result identifier - * @return int the number of rows in $result + * @param resource $result MySQL result identifier + * @return int the number of rows in $result * @access public */ function numRows($result) @@ -474,11 +474,11 @@ class DB_mysqli extends DB_common /** * Returns the next free id in a sequence * - * @param string $seq_name name of the sequence - * @param boolean $ondemand when true, the seqence is automatically + * @param string $seq_name name of the sequence + * @param boolean $ondemand when true, the seqence is automatically * created if it does not exist * - * @return int the next id number in the sequence. DB_Error if problem. + * @return int the next id number in the sequence. DB_Error if problem. * * @internal * @see DB_common::nextID() @@ -558,9 +558,9 @@ class DB_mysqli extends DB_common /** * Creates a new sequence * - * @param string $seq_name name of the new sequence + * @param string $seq_name name of the new sequence * - * @return int DB_OK on success. A DB_Error object is returned if + * @return int DB_OK on success. A DB_Error object is returned if * problems arise. * * @internal @@ -586,9 +586,9 @@ class DB_mysqli extends DB_common /** * Deletes a sequence * - * @param string $seq_name name of the sequence to be deleted + * @param string $seq_name name of the sequence to be deleted * - * @return int DB_OK on success. DB_Error if problems. + * @return int DB_OK on success. DB_Error if problems. * * @internal * @see DB_common::dropSequence() @@ -606,8 +606,8 @@ class DB_mysqli extends DB_common * Backwards compatibility with old sequence emulation implementation * (clean up the dupes). * - * @param string $seqname The sequence name to clean up - * @return mixed DB_Error or true + * @param string $seqname The sequence name to clean up + * @return mixed DB_Error or true */ function _BCsequence($seqname) { @@ -657,9 +657,9 @@ class DB_mysqli extends DB_common * MySQL can't handle the backtick character (`) in * table or column names. * - * @param string $str identifier name to be quoted + * @param string $str identifier name to be quoted * - * @return string quoted identifier string + * @return string quoted identifier string * * @since 1.6.0 * @access public @@ -676,9 +676,9 @@ class DB_mysqli extends DB_common /** * Escape a string according to the current DBMS's standards * - * @param string $str the string to be escaped + * @param string $str the string to be escaped * - * @return string the escaped string + * @return string the escaped string * * @internal */ @@ -721,9 +721,9 @@ class DB_mysqli extends DB_common * Gather information about an error, then use that info to create a * DB error object and finally return that object. * - * @param integer $errno PEAR error number (usually a DB constant) if + * @param integer $errno PEAR error number (usually a DB constant) if * manually raising an error - * @return object DB error object + * @return object DB error object * @see DB_common::errorCode() * @see DB_common::raiseError() */ @@ -756,10 +756,10 @@ class DB_mysqli extends DB_common * WARNING: this method will probably not work because the mysqli_*() * functions it relies upon may not exist. * - * @param object|string $result DB_result object from a query or a + * @param object|string $result DB_result object from a query or a * string containing the name of a table - * @param int $mode a valid tableInfo mode - * @return array an associative array with the information requested + * @param int $mode a valid tableInfo mode + * @return array an associative array with the information requested * or an error object if something is wrong * @access public * @internal @@ -844,7 +844,7 @@ class DB_mysqli extends DB_common /** * Returns the query needed to get some backend info. * - * @param string $type What kind of info you want to retrieve + * @param string $type What kind of info you want to retrieve * @return string The SQL query string */ function getSpecialQuery($type) diff --git a/lib/pear/DB/oci8.php b/lib/pear/DB/oci8.php index 8cfdf3be1..8003608f9 100644 --- a/lib/pear/DB/oci8.php +++ b/lib/pear/DB/oci8.php @@ -212,11 +212,11 @@ class DB_oci8 extends DB_common * Formating of the array and the data therein are configurable. * See DB_result::fetchInto() for more information. * - * @param resource $result query result identifier - * @param array $arr (reference) array where data from the row + * @param resource $result query result identifier + * @param array $arr (reference) array where data from the row * should be placed - * @param int $fetchmode how the resulting array should be indexed - * @param int $rownum the row number to fetch + * @param int $fetchmode how the resulting array should be indexed + * @param int $rownum the row number to fetch * * @return mixed DB_OK on success, null when end of result set is * reached or on failure @@ -383,8 +383,8 @@ class DB_oci8 extends DB_common * "UPDATE foo SET col=? WHERE col='over \& under'" * * - * @param string $query query to be prepared - * @return mixed DB statement resource on success. DB_Error on failure. + * @param string $query query to be prepared + * @return mixed DB statement resource on success. DB_Error on failure. */ function prepare($query) { @@ -435,8 +435,8 @@ class DB_oci8 extends DB_common /** * Executes a DB statement prepared with prepare(). * - * @param resource $stmt a DB statement resource returned from prepare() - * @param mixed $data array, string or numeric data to be used in + * @param resource $stmt a DB statement resource returned from prepare() + * @param mixed $data array, string or numeric data to be used in * execution of the statement. Quantity of items * passed must match quantity of placeholders in * query: meaning 1 for non-array items or the @@ -593,9 +593,9 @@ class DB_oci8 extends DB_common /** * Emulate the row limit support altering the query * - * @param string $query The query to treat - * @param int $from The row to start to fetch from - * @param int $count The offset + * @param string $query The query to treat + * @param int $from The row to start to fetch from + * @param int $count The offset * @return string The modified query * * @author Tomas V.V.Cox @@ -643,11 +643,11 @@ class DB_oci8 extends DB_common /** * Returns the next free id in a sequence * - * @param string $seq_name name of the sequence - * @param boolean $ondemand when true, the seqence is automatically + * @param string $seq_name name of the sequence + * @param boolean $ondemand when true, the seqence is automatically * created if it does not exist * - * @return int the next id number in the sequence. DB_Error if problem. + * @return int the next id number in the sequence. DB_Error if problem. * * @internal * @see DB_common::nextID() @@ -682,9 +682,9 @@ class DB_oci8 extends DB_common /** * Creates a new sequence * - * @param string $seq_name name of the new sequence + * @param string $seq_name name of the new sequence * - * @return int DB_OK on success. A DB_Error object is returned if + * @return int DB_OK on success. A DB_Error object is returned if * problems arise. * * @internal @@ -703,9 +703,9 @@ class DB_oci8 extends DB_common /** * Deletes a sequence * - * @param string $seq_name name of the sequence to be deleted + * @param string $seq_name name of the sequence to be deleted * - * @return int DB_OK on success. DB_Error if problems. + * @return int DB_OK on success. DB_Error if problems. * * @internal * @see DB_common::dropSequence() @@ -724,9 +724,9 @@ class DB_oci8 extends DB_common * Gather information about an error, then use that info to create a * DB error object and finally return that object. * - * @param integer $errno PEAR error number (usually a DB constant) if + * @param integer $errno PEAR error number (usually a DB constant) if * manually raising an error - * @return object DB error object + * @return object DB error object * @see DB_common::errorCode() * @see DB_common::raiseError() */ @@ -749,7 +749,7 @@ class DB_oci8 extends DB_common /** * Returns the query needed to get some backend info - * @param string $type What kind of info you want to retrieve + * @param string $type What kind of info you want to retrieve * @return string The SQL query string */ function getSpecialQuery($type) @@ -773,10 +773,10 @@ class DB_oci8 extends DB_common * * NOTE: flags won't contain index information. * - * @param object|string $result DB_result object from a query or a + * @param object|string $result DB_result object from a query or a * string containing the name of a table - * @param int $mode a valid tableInfo mode - * @return array an associative array with the information requested + * @param int $mode a valid tableInfo mode + * @return array an associative array with the information requested * or an error object if something is wrong * @access public * @internal diff --git a/lib/pear/DB/odbc.php b/lib/pear/DB/odbc.php index 38074acaa..99825d018 100644 --- a/lib/pear/DB/odbc.php +++ b/lib/pear/DB/odbc.php @@ -224,11 +224,11 @@ class DB_odbc extends DB_common * Formating of the array and the data therein are configurable. * See DB_result::fetchInto() for more information. * - * @param resource $result query result identifier - * @param array $arr (reference) array where data from the row + * @param resource $result query result identifier + * @param array $arr (reference) array where data from the row * should be placed - * @param int $fetchmode how the resulting array should be indexed - * @param int $rownum the row number to fetch + * @param int $fetchmode how the resulting array should be indexed + * @param int $rownum the row number to fetch * * @return mixed DB_OK on success, null when end of result set is * reached or on failure @@ -349,9 +349,9 @@ class DB_odbc extends DB_common * Use 'mssql' as the dbsyntax in the DB DSN only if you've unchecked * "Use ANSI quoted identifiers" when setting up the ODBC data source. * - * @param string $str identifier name to be quoted + * @param string $str identifier name to be quoted * - * @return string quoted identifier string + * @return string quoted identifier string * * @since 1.6.0 * @access public @@ -408,11 +408,11 @@ class DB_odbc extends DB_common /** * Returns the next free id in a sequence * - * @param string $seq_name name of the sequence - * @param boolean $ondemand when true, the seqence is automatically + * @param string $seq_name name of the sequence + * @param boolean $ondemand when true, the seqence is automatically * created if it does not exist * - * @return int the next id number in the sequence. DB_Error if problem. + * @return int the next id number in the sequence. DB_Error if problem. * * @internal * @see DB_common::nextID() @@ -461,9 +461,9 @@ class DB_odbc extends DB_common /** * Creates a new sequence * - * @param string $seq_name name of the new sequence + * @param string $seq_name name of the new sequence * - * @return int DB_OK on success. A DB_Error object is returned if + * @return int DB_OK on success. A DB_Error object is returned if * problems arise. * * @internal @@ -484,9 +484,9 @@ class DB_odbc extends DB_common /** * Deletes a sequence * - * @param string $seq_name name of the sequence to be deleted + * @param string $seq_name name of the sequence to be deleted * - * @return int DB_OK on success. DB_Error if problems. + * @return int DB_OK on success. DB_Error if problems. * * @internal * @see DB_common::dropSequence() @@ -538,9 +538,9 @@ class DB_odbc extends DB_common * Gather information about an error, then use that info to create a * DB error object and finally return that object. * - * @param integer $errno PEAR error number (usually a DB constant) if + * @param integer $errno PEAR error number (usually a DB constant) if * manually raising an error - * @return object DB error object + * @return object DB error object * @see errorNative() * @see DB_common::errorCode() * @see DB_common::raiseError() diff --git a/lib/pear/DB/pgsql.php b/lib/pear/DB/pgsql.php index 4b4e78b06..6db9eaf67 100644 --- a/lib/pear/DB/pgsql.php +++ b/lib/pear/DB/pgsql.php @@ -228,8 +228,8 @@ class DB_pgsql extends DB_common /** * Determine PEAR::DB error code from the database's text error message. * - * @param string $errormsg error message returned from the database - * @return integer an error number from a DB error constant + * @param string $errormsg error message returned from the database + * @return integer an error number from a DB error constant */ function errorCode($errormsg) { @@ -268,11 +268,11 @@ class DB_pgsql extends DB_common * Formating of the array and the data therein are configurable. * See DB_result::fetchInto() for more information. * - * @param resource $result query result identifier - * @param array $arr (reference) array where data from the row + * @param resource $result query result identifier + * @param array $arr (reference) array where data from the row * should be placed - * @param int $fetchmode how the resulting array should be indexed - * @param int $rownum the row number to fetch + * @param int $fetchmode how the resulting array should be indexed + * @param int $rownum the row number to fetch * * @return mixed DB_OK on success, null when end of result set is * reached or on failure @@ -349,7 +349,7 @@ class DB_pgsql extends DB_common /** * Format input so it can be safely used in a query * - * @param mixed $in data to be quoted + * @param mixed $in data to be quoted * * @return mixed Submitted variable's type = returned value: * + null = the string NULL @@ -383,9 +383,9 @@ class DB_pgsql extends DB_common * {@internal PostgreSQL treats a backslash as an escape character, * so they are escaped as well. * - * @param string $str the string to be escaped + * @param string $str the string to be escaped * - * @return string the escaped string + * @return string the escaped string * * @see DB_common::quoteSmart() * @since Method available since Release 1.6.0 @@ -533,11 +533,11 @@ class DB_pgsql extends DB_common /** * Returns the next free id in a sequence * - * @param string $seq_name name of the sequence - * @param boolean $ondemand when true, the seqence is automatically + * @param string $seq_name name of the sequence + * @param boolean $ondemand when true, the seqence is automatically * created if it does not exist * - * @return int the next id number in the sequence. DB_Error if problem. + * @return int the next id number in the sequence. DB_Error if problem. * * @internal * @see DB_common::nextID() @@ -578,8 +578,8 @@ class DB_pgsql extends DB_common /** * Create the sequence * - * @param string $seq_name the name of the sequence - * @return mixed DB_OK on success or DB error on error + * @param string $seq_name the name of the sequence + * @return mixed DB_OK on success or DB error on error * @access public */ function createSequence($seq_name) @@ -595,8 +595,8 @@ class DB_pgsql extends DB_common /** * Drop a sequence * - * @param string $seq_name the name of the sequence - * @return mixed DB_OK on success or DB error on error + * @param string $seq_name the name of the sequence + * @return mixed DB_OK on success or DB error on error * @access public */ function dropSequence($seq_name) @@ -621,9 +621,9 @@ class DB_pgsql extends DB_common * Gather information about an error, then use that info to create a * DB error object and finally return that object. * - * @param integer $errno PEAR error number (usually a DB constant) if + * @param integer $errno PEAR error number (usually a DB constant) if * manually raising an error - * @return object DB error object + * @return object DB error object * @see errorNative() * @see errorCode() * @see DB_common::raiseError() @@ -645,7 +645,7 @@ class DB_pgsql extends DB_common /** * Flags of a Field * - * @param int $resource PostgreSQL result identifier + * @param int $resource PostgreSQL result identifier * @param int $num_field the field number * * @return string The flags of the field ("not_null", "default_value", @@ -714,10 +714,10 @@ class DB_pgsql extends DB_common * NOTE: only supports 'table' and 'flags' if $result * is a table name. * - * @param object|string $result DB_result object from a query or a + * @param object|string $result DB_result object from a query or a * string containing the name of a table - * @param int $mode a valid tableInfo mode - * @return array an associative array with the information requested + * @param int $mode a valid tableInfo mode + * @return array an associative array with the information requested * or an error object if something is wrong * @access public * @internal @@ -803,7 +803,7 @@ class DB_pgsql extends DB_common /** * Returns the query needed to get some backend info - * @param string $type What kind of info you want to retrieve + * @param string $type What kind of info you want to retrieve * @return string The SQL query string */ function getSpecialQuery($type) diff --git a/lib/pear/DB/sqlite.php b/lib/pear/DB/sqlite.php index 440e23554..a6c34d016 100644 --- a/lib/pear/DB/sqlite.php +++ b/lib/pear/DB/sqlite.php @@ -232,11 +232,11 @@ class DB_sqlite extends DB_common * Formating of the array and the data therein are configurable. * See DB_result::fetchInto() for more information. * - * @param resource $result query result identifier - * @param array $arr (reference) array where data from the row + * @param resource $result query result identifier + * @param array $arr (reference) array where data from the row * should be placed - * @param int $fetchmode how the resulting array should be indexed - * @param int $rownum the row number to fetch + * @param int $fetchmode how the resulting array should be indexed + * @param int $rownum the row number to fetch * * @return mixed DB_OK on success, null when end of result set is * reached or on failure @@ -367,8 +367,8 @@ class DB_sqlite extends DB_common /** * Determine PEAR::DB error code from the database's text error message. * - * @param string $errormsg error message returned from the database - * @return integer an error number from a DB error constant + * @param string $errormsg error message returned from the database + * @return integer an error number from a DB error constant */ function errorCode($errormsg) { @@ -400,9 +400,9 @@ class DB_sqlite extends DB_common /** * Deletes a sequence * - * @param string $seq_name name of the sequence to be deleted + * @param string $seq_name name of the sequence to be deleted * - * @return int DB_OK on success. DB_Error if problems. + * @return int DB_OK on success. DB_Error if problems. * * @internal * @see DB_common::dropSequence() @@ -417,9 +417,9 @@ class DB_sqlite extends DB_common /** * Creates a new sequence * - * @param string $seq_name name of the new sequence + * @param string $seq_name name of the new sequence * - * @return int DB_OK on success. A DB_Error object is returned if + * @return int DB_OK on success. A DB_Error object is returned if * problems arise. * * @internal @@ -451,11 +451,11 @@ class DB_sqlite extends DB_common /** * Returns the next free id in a sequence * - * @param string $seq_name name of the sequence - * @param boolean $ondemand when true, the seqence is automatically + * @param string $seq_name name of the sequence + * @param boolean $ondemand when true, the seqence is automatically * created if it does not exist * - * @return int the next id number in the sequence. DB_Error if problem. + * @return int the next id number in the sequence. DB_Error if problem. * * @internal * @see DB_common::nextID() @@ -498,7 +498,7 @@ class DB_sqlite extends DB_common * * Refer to the online manual at http://sqlite.org/sqlite.html. * - * @param string $type What kind of info you want to retrieve + * @param string $type What kind of info you want to retrieve * @return string The SQL query string */ function getSpecialQuery($type, $args=array()) @@ -576,8 +576,8 @@ class DB_sqlite extends DB_common * atime, mtime, ctime, blksize, blocks or a numeric key between * 0 and 12. * - * @param string $arg Array key for stats() - * @return mixed array on an unspecified key, integer on a passed arg and + * @param string $arg Array key for stats() + * @return mixed array on an unspecified key, integer on a passed arg and * false at a stats error. */ function getDbFileStats($arg = '') @@ -611,9 +611,9 @@ class DB_sqlite extends DB_common * containing binary data. See the * {@link http://php.net/sqlite_escape_string PHP manual} for more info. * - * @param string $str the string to be escaped + * @param string $str the string to be escaped * - * @return string the escaped string + * @return string the escaped string * * @since 1.6.1 * @see DB_common::escapeSimple() @@ -640,7 +640,7 @@ class DB_sqlite extends DB_common * * This little hack lets you know how many rows were deleted. * - * @param string $query The SQL query string + * @param string $query The SQL query string * @return string The SQL query string */ function _modifyQuery($query) @@ -661,9 +661,9 @@ class DB_sqlite extends DB_common * Gather information about an error, then use that info to create a * DB error object and finally return that object. * - * @param integer $errno PEAR error number (usually a DB constant) if + * @param integer $errno PEAR error number (usually a DB constant) if * manually raising an error - * @return object DB error object + * @return object DB error object * @see errorNative() * @see errorCode() * @see DB_common::raiseError() diff --git a/lib/pear/DB/sybase.php b/lib/pear/DB/sybase.php index c4d1f1f81..8416103a0 100644 --- a/lib/pear/DB/sybase.php +++ b/lib/pear/DB/sybase.php @@ -163,8 +163,8 @@ class DB_sybase extends DB_common /** * Determine PEAR::DB error code from the database's text error message. * - * @param string $errormsg error message returned from the database - * @return integer an error number from a DB error constant + * @param string $errormsg error message returned from the database + * @return integer an error number from a DB error constant */ function errorCode($errormsg) { @@ -213,9 +213,9 @@ class DB_sybase extends DB_common * Gather information about an error, then use that info to create a * DB error object and finally return that object. * - * @param integer $errno PEAR error number (usually a DB constant) if + * @param integer $errno PEAR error number (usually a DB constant) if * manually raising an error - * @return object DB error object + * @return object DB error object * @see errorNative() * @see errorCode() * @see DB_common::raiseError() @@ -304,11 +304,11 @@ class DB_sybase extends DB_common * Formating of the array and the data therein are configurable. * See DB_result::fetchInto() for more information. * - * @param resource $result query result identifier - * @param array $arr (reference) array where data from the row + * @param resource $result query result identifier + * @param array $arr (reference) array where data from the row * should be placed - * @param int $fetchmode how the resulting array should be indexed - * @param int $rownum the row number to fetch + * @param int $fetchmode how the resulting array should be indexed + * @param int $rownum the row number to fetch * * @return mixed DB_OK on success, null when end of result set is * reached or on failure @@ -444,11 +444,11 @@ class DB_sybase extends DB_common /** * Returns the next free id in a sequence * - * @param string $seq_name name of the sequence - * @param boolean $ondemand when true, the seqence is automatically + * @param string $seq_name name of the sequence + * @param boolean $ondemand when true, the seqence is automatically * created if it does not exist * - * @return int the next id number in the sequence. DB_Error if problem. + * @return int the next id number in the sequence. DB_Error if problem. * * @internal * @see DB_common::nextID() @@ -490,9 +490,9 @@ class DB_sybase extends DB_common /** * Creates a new sequence * - * @param string $seq_name name of the new sequence + * @param string $seq_name name of the new sequence * - * @return int DB_OK on success. A DB_Error object is returned if + * @return int DB_OK on success. A DB_Error object is returned if * problems arise. * * @internal @@ -513,9 +513,9 @@ class DB_sybase extends DB_common /** * Deletes a sequence * - * @param string $seq_name name of the sequence to be deleted + * @param string $seq_name name of the sequence to be deleted * - * @return int DB_OK on success. DB_Error if problems. + * @return int DB_OK on success. DB_Error if problems. * * @internal * @see DB_common::dropSequence() @@ -532,7 +532,7 @@ class DB_sybase extends DB_common /** * Returns the query needed to get some backend info - * @param string $type What kind of info you want to retrieve + * @param string $type What kind of info you want to retrieve * @return string The SQL query string */ function getSpecialQuery($type) @@ -612,10 +612,10 @@ class DB_sybase extends DB_common * NOTE: only supports 'table' and 'flags' if $result * is a table name. * - * @param object|string $result DB_result object from a query or a + * @param object|string $result DB_result object from a query or a * string containing the name of a table - * @param int $mode a valid tableInfo mode - * @return array an associative array with the information requested + * @param int $mode a valid tableInfo mode + * @return array an associative array with the information requested * or an error object if something is wrong * @access public * @internal @@ -737,9 +737,9 @@ class DB_sybase extends DB_common * + unique_key (unique index, unique check or primary_key) * + multiple_key (multi-key index) * - * @param string $table table name - * @param string $column field name - * @return string space delimited string of flags. Empty string if none. + * @param string $table table name + * @param string $column field name + * @return string space delimited string of flags. Empty string if none. * @access private */ function _sybase_field_flags($table, $column) @@ -790,8 +790,8 @@ class DB_sybase extends DB_common * Adds a string to the flags array if the flag is not yet in there * - if there is no flag present the array is created. * - * @param array $array reference of flags array to add a value to - * @param mixed $value value to add to the flag array + * @param array $array reference of flags array to add a value to + * @param mixed $value value to add to the flag array * @access private */ function _add_flag(&$array, $value) @@ -811,9 +811,9 @@ class DB_sybase extends DB_common * * Quoting style depends on which database driver is being used. * - * @param string $str identifier name to be quoted + * @param string $str identifier name to be quoted * - * @return string quoted identifier string + * @return string quoted identifier string * * @since 1.6.0 * @access public diff --git a/lib/pear/PEAR.php b/lib/pear/PEAR.php index a48e4b7a0..6f80117be 100644 --- a/lib/pear/PEAR.php +++ b/lib/pear/PEAR.php @@ -133,7 +133,7 @@ class PEAR * $_PEAR_destructor_object_list for destructor emulation if a * destructor object exists. * - * @param string $error_class (optional) which class to use for + * @param string $error_class (optional) which class to use for * error objects, defaults to PEAR_Error. * @access public * @return void @@ -223,11 +223,11 @@ class PEAR /** * Tell whether a value is a PEAR error. * - * @param mixed $data the value to test - * @param int $code if $data is an error object, return true + * @param mixed $data the value to test + * @param int $code if $data is an error object, return true * only if $obj->getCode() == $code * @access public - * @return bool true if parameter is an error + * @return bool true if parameter is an error */ function isError($data, $code = null) { @@ -339,7 +339,7 @@ class PEAR * * @param mixed $code a single error code or an array of error codes to expect * - * @return int the new depth of the "expected errors" stack + * @return int the new depth of the "expected errors" stack * @access public */ function expectError($code = '*') @@ -359,7 +359,7 @@ class PEAR * This method pops one element off the expected error codes * stack. * - * @return array the list of error codes that were popped + * @return array the list of error codes that were popped */ function popExpect() { @@ -447,10 +447,10 @@ class PEAR * * @param mixed $message a text error message or a PEAR error object * - * @param int $code a numeric error code (it is up to your class + * @param int $code a numeric error code (it is up to your class * to define these if you want to use codes) * - * @param int $mode One of PEAR_ERROR_RETURN, PEAR_ERROR_PRINT, + * @param int $mode One of PEAR_ERROR_RETURN, PEAR_ERROR_PRINT, * PEAR_ERROR_TRIGGER, PEAR_ERROR_DIE, * PEAR_ERROR_CALLBACK, PEAR_ERROR_EXCEPTION. * @@ -472,7 +472,7 @@ class PEAR * the error message parameter will be dropped. * * @access public - * @return object a PEAR error object + * @return object a PEAR error object * @see PEAR::setErrorHandling * @since PHP 4.0.5 */ @@ -555,7 +555,7 @@ class PEAR * you can easily override the actual error handler for some code and restore * it later with popErrorHandling. * - * @param mixed $mode (same as setErrorHandling) + * @param mixed $mode (same as setErrorHandling) * @param mixed $options (same as setErrorHandling) * * @return bool Always true @@ -693,15 +693,15 @@ class PEAR_Error /** * PEAR_Error constructor * - * @param string $message message + * @param string $message message * - * @param int $code (optional) error code + * @param int $code (optional) error code * - * @param int $mode (optional) error mode, one of: PEAR_ERROR_RETURN, + * @param int $mode (optional) error mode, one of: PEAR_ERROR_RETURN, * PEAR_ERROR_PRINT, PEAR_ERROR_DIE, PEAR_ERROR_TRIGGER, * PEAR_ERROR_CALLBACK or PEAR_ERROR_EXCEPTION * - * @param mixed $options (optional) error level, _OR_ in the case of + * @param mixed $options (optional) error level, _OR_ in the case of * PEAR_ERROR_CALLBACK, the callback function or object/method * tuple. * @@ -805,7 +805,7 @@ class PEAR_Error /** * Get the error message from an error object. * - * @return string full error message + * @return string full error message * @access public */ function getMessage() @@ -877,7 +877,7 @@ class PEAR_Error * Get the call backtrace from where the error was generated. * Supported with PHP 4.3.0 or newer. * - * @param int $frame (optional) what frame to fetch + * @param int $frame (optional) what frame to fetch * @return array Backtrace, or NULL if not available. * @access public */ diff --git a/lib/plugin/Calendar.php b/lib/plugin/Calendar.php index f851c067b..4090c9921 100644 --- a/lib/plugin/Calendar.php +++ b/lib/plugin/Calendar.php @@ -60,9 +60,9 @@ extends WikiPlugin /** * return links (static only as of action=edit) * - * @param string $argstr The plugin argument string. - * @param string $basepage The pagename the plugin is invoked from. - * @return array List of pagenames linked to (or false). + * @param string $argstr The plugin argument string. + * @param string $basepage The pagename the plugin is invoked from. + * @return array List of pagenames linked to (or false). */ function getWikiPageLinks ($argstr, $basepage) { if (isset($this->_links)) diff --git a/lib/plugin/CalendarList.php b/lib/plugin/CalendarList.php index 334782e81..39dce7acc 100644 --- a/lib/plugin/CalendarList.php +++ b/lib/plugin/CalendarList.php @@ -80,9 +80,9 @@ extends WikiPlugin /** * return links (static only as of action=edit) * - * @param string $argstr The plugin argument string. - * @param string $basepage The pagename the plugin is invoked from. - * @return array List of pagenames linked to (or false). + * @param string $argstr The plugin argument string. + * @param string $basepage The pagename the plugin is invoked from. + * @return array List of pagenames linked to (or false). */ function getWikiPageLinks ($argstr, $basepage) { if (isset($this->_links)) diff --git a/lib/plugin/PhotoAlbum.php b/lib/plugin/PhotoAlbum.php index 609451e94..d97d8390b 100644 --- a/lib/plugin/PhotoAlbum.php +++ b/lib/plugin/PhotoAlbum.php @@ -509,8 +509,8 @@ display_slides();")); * Calculate the new size in pixels when the original size * with a value is given. * - * @param integer $oldSize Absolute no. of pixels - * @param mixed $value Either absolute no. or HTML percentage e.g. '50%' + * @param integer $oldSize Absolute no. of pixels + * @param mixed $value Either absolute no. or HTML percentage e.g. '50%' * @return integer New size in pixels */ function newSize($oldSize, $value) { @@ -545,8 +545,8 @@ display_slides();")); * fromFile - read pictures & descriptions (separated by ;) * from $src and return it in array $photos * - * @param string $src path to dir or textfile (local or remote) - * @param array $photos + * @param string $src path to dir or textfile (local or remote) + * @param array $photos * @return string Error when bad url or file couldn't be opened */ function fromFile($src, &$photos, $webpath='') { diff --git a/lib/plugin/VisualWiki.php b/lib/plugin/VisualWiki.php index 495908b45..47acba7ef 100644 --- a/lib/plugin/VisualWiki.php +++ b/lib/plugin/VisualWiki.php @@ -216,7 +216,7 @@ extends WikiPlugin_GraphViz * @param category string attribute of the pages which is used * to compare them * @param minimum boolean true finds smallest, false finds biggest - * @return array list of page names found to be the best + * @return array list of page names found to be the best */ function findbest($number, $category, $minimum ) { // select the $number best in the category '$category' @@ -414,7 +414,7 @@ extends WikiPlugin_GraphViz * @param shape string node shape; 'ellipse', 'box', 'circle', 'point' * @param label string 'name': label by name, * 'number': label by unique number - * @return boolean error status; true=ok; false=error + * @return boolean error status; true=ok; false=error */ function createDotFile($filename, $argarray) { extract($argarray); @@ -530,7 +530,7 @@ extends WikiPlugin_GraphViz * image. It is not necessary to call * WikiPlugin->getArgs anymore. * @param request Request ??? - * @return string html output + * @return string html output */ function embedImg($url,&$dbi,$argarray,&$request) { if (!VISUALWIKI_ALLOWOPTIONS) diff --git a/lib/prepend.php b/lib/prepend.php index 46c1d3e2a..c3cfd85f8 100644 --- a/lib/prepend.php +++ b/lib/prepend.php @@ -83,8 +83,8 @@ class DebugTimer { } /** - * @param string $which One of 'real', 'utime', 'stime', 'cutime', 'sutime' - * @return float Seconds. + * @param string $which One of 'real', 'utime', 'stime', 'cutime', 'sutime' + * @return float Seconds. */ function getTime($which='real', $now=false) { if ($which == 'real') diff --git a/lib/stdlib.php b/lib/stdlib.php index d11cf0f8e..96cbb98ac 100644 --- a/lib/stdlib.php +++ b/lib/stdlib.php @@ -1910,9 +1910,9 @@ class Alert { /** Constructor * * @param object $request - * @param mixed $head Header ("title") for alert box. - * @param mixed $body The text in the alert box. - * @param hash $buttons An array mapping button labels to URLs. + * @param mixed $head Header ("title") for alert box. + * @param mixed $body The text in the alert box. + * @param hash $buttons An array mapping button labels to URLs. * The default is a single "Okay" button pointing to $request->getURLtoSelf(). */ function Alert($head, $body, $buttons=false) { diff --git a/themes/Sidebar/themeinfo.php b/themes/Sidebar/themeinfo.php index f59f84bea..3bb1da45c 100644 --- a/themes/Sidebar/themeinfo.php +++ b/themes/Sidebar/themeinfo.php @@ -71,8 +71,8 @@ class WikiTheme_Sidebar extends WikiTheme_MonoBook { /** CbUpload (&$request, $pathname) => true or false * Callback when a file is uploaded. virusscan, ... - * @param string $str - * @return bool true for success, false to abort gracefully. + * @param string $str + * @return bool true for success, false to abort gracefully. * In case of false, the file is deleted by the caller, but the callback must * inform the user why the file was deleted. * Src: -- 2.45.0