From: <var...@us...> - 2012-08-31 11:49:30
|
Revision: 8279 http://phpwiki.svn.sourceforge.net/phpwiki/?rev=8279&view=rev Author: vargenau Date: 2012-08-31 11:49:19 +0000 (Fri, 31 Aug 2012) Log Message: ----------- phpdoc_params Modified Paths: -------------- trunk/lib/BlockParser.php trunk/lib/DbSession/ADODB.php trunk/lib/DbSession/PDO.php trunk/lib/DbSession/SQL.php trunk/lib/Google.php trunk/lib/InlineParser.php trunk/lib/PageList.php trunk/lib/PageType.php trunk/lib/WikiDB/adodb/adodb-csvlib.inc.php trunk/lib/WikiDB/adodb/adodb.inc.php trunk/lib/WikiDB/adodb/drivers/adodb-oci8.inc.php trunk/lib/WikiDB/backend.php trunk/lib/WikiDB.php trunk/lib/WikiGroup.php trunk/lib/WikiPlugin.php trunk/lib/WikiPluginCached.php trunk/lib/WikiTheme.php trunk/lib/WikiUser/OpenID.php trunk/lib/WikiUser.php trunk/lib/main.php trunk/lib/nusoap/nusoap.php trunk/lib/pear/Cache/Container/trifile.php trunk/lib/pear/Cache.php trunk/lib/pear/DB/common.php trunk/lib/pear/DB/dbase.php trunk/lib/pear/DB/fbsql.php trunk/lib/pear/DB/ibase.php trunk/lib/pear/DB/ifx.php trunk/lib/pear/DB/ldap.php trunk/lib/pear/DB/msql.php trunk/lib/pear/DB/mssql.php trunk/lib/pear/DB/mysql.php trunk/lib/pear/DB/mysqli.php trunk/lib/pear/DB/oci8.php trunk/lib/pear/DB/odbc.php trunk/lib/pear/DB/pgsql.php trunk/lib/pear/DB/sqlite.php trunk/lib/pear/DB/sybase.php trunk/lib/pear/DB.php trunk/lib/pear/PEAR.php trunk/lib/plugin/Calendar.php trunk/lib/plugin/CalendarList.php trunk/lib/plugin/PhotoAlbum.php trunk/lib/plugin/VisualWiki.php trunk/lib/prepend.php trunk/lib/stdlib.php trunk/themes/Sidebar/themeinfo.php Modified: trunk/lib/BlockParser.php =================================================================== --- trunk/lib/BlockParser.php 2012-08-31 11:43:40 UTC (rev 8278) +++ trunk/lib/BlockParser.php 2012-08-31 11:49:19 UTC (rev 8279) @@ -90,7 +90,7 @@ * * @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 @@ * $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. Modified: trunk/lib/DbSession/ADODB.php =================================================================== --- trunk/lib/DbSession/ADODB.php 2012-08-31 11:43:40 UTC (rev 8278) +++ trunk/lib/DbSession/ADODB.php 2012-08-31 11:49:19 UTC (rev 8279) @@ -76,8 +76,8 @@ * 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 @@ * 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 @@ * * Removes a session from the table. * - * @param string $id + * @param string $id * @return boolean true * @access private */ @@ -209,7 +209,7 @@ /** * 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 */ Modified: trunk/lib/DbSession/PDO.php =================================================================== --- trunk/lib/DbSession/PDO.php 2012-08-31 11:43:40 UTC (rev 8278) +++ trunk/lib/DbSession/PDO.php 2012-08-31 11:49:19 UTC (rev 8279) @@ -54,8 +54,8 @@ * 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 @@ * 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 @@ * * Removes a session from the table. * - * @param string $id + * @param string $id * @return boolean true * @access private */ @@ -199,7 +199,7 @@ /** * 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 */ Modified: trunk/lib/DbSession/SQL.php =================================================================== --- trunk/lib/DbSession/SQL.php 2012-08-31 11:43:40 UTC (rev 8278) +++ trunk/lib/DbSession/SQL.php 2012-08-31 11:49:19 UTC (rev 8279) @@ -60,8 +60,8 @@ * 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 @@ * 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 @@ * * Removes a session from the table. * - * @param string $id + * @param string $id * @return boolean true * @access private */ @@ -195,7 +195,7 @@ /** * 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 */ Modified: trunk/lib/Google.php =================================================================== --- trunk/lib/Google.php 2012-08-31 11:43:40 UTC (rev 8278) +++ trunk/lib/Google.php 2012-08-31 11:49:19 UTC (rev 8279) @@ -264,7 +264,7 @@ * 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) Modified: trunk/lib/InlineParser.php =================================================================== --- trunk/lib/InlineParser.php 2012-08-31 11:43:40 UTC (rev 8278) +++ trunk/lib/InlineParser.php 2012-08-31 11:49:19 UTC (rev 8279) @@ -95,7 +95,7 @@ * * @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, '*?'); Modified: trunk/lib/PageList.php =================================================================== --- trunk/lib/PageList.php 2012-08-31 11:43:40 UTC (rev 8278) +++ trunk/lib/PageList.php 2012-08-31 11:49:19 UTC (rev 8279) @@ -1258,7 +1258,7 @@ * 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])) Modified: trunk/lib/PageType.php =================================================================== --- trunk/lib/PageType.php 2012-08-31 11:43:40 UTC (rev 8278) +++ trunk/lib/PageType.php 2012-08-31 11:49:19 UTC (rev 8279) @@ -28,9 +28,9 @@ /** 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 @@ * * 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 @@ /** * 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 @@ /** * 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 @@ /** 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 @@ /** 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); Modified: trunk/lib/WikiDB/adodb/adodb-csvlib.inc.php =================================================================== --- trunk/lib/WikiDB/adodb/adodb-csvlib.inc.php 2012-08-31 11:43:40 UTC (rev 8278) +++ trunk/lib/WikiDB/adodb/adodb-csvlib.inc.php 2012-08-31 11:49:19 UTC (rev 8279) @@ -24,7 +24,7 @@ * * @param rs the recordset * - * @return the CSV formated data + * @return the CSV formated data */ function _rs2serialize(&$rs,$conn=false,$sql='') { Modified: trunk/lib/WikiDB/adodb/adodb.inc.php =================================================================== --- trunk/lib/WikiDB/adodb/adodb.inc.php 2012-08-31 11:43:40 UTC (rev 8278) +++ trunk/lib/WikiDB/adodb/adodb.inc.php 2012-08-31 11:49:19 UTC (rev 8279) @@ -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 <pab...@mv...> * - * @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 <pab...@mv...> * - * @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. Modified: trunk/lib/WikiDB/adodb/drivers/adodb-oci8.inc.php =================================================================== --- trunk/lib/WikiDB/adodb/drivers/adodb-oci8.inc.php 2012-08-31 11:43:40 UTC (rev 8278) +++ trunk/lib/WikiDB/adodb/drivers/adodb-oci8.inc.php 2012-08-31 11:49:19 UTC (rev 8279) @@ -938,7 +938,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) { Modified: trunk/lib/WikiDB/backend.php =================================================================== --- trunk/lib/WikiDB/backend.php 2012-08-31 11:43:40 UTC (rev 8278) +++ trunk/lib/WikiDB/backend.php 2012-08-31 11:49:19 UTC (rev 8279) @@ -388,8 +388,8 @@ * 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 Modified: trunk/lib/WikiDB.php =================================================================== --- trunk/lib/WikiDB.php 2012-08-31 11:43:40 UTC (rev 8278) +++ trunk/lib/WikiDB.php 2012-08-31 11:49:19 UTC (rev 8279) @@ -155,7 +155,7 @@ * 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 @@ * 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 @@ * @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 @@ * 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 @@ * 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 @@ * 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 @@ * @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 @@ * * @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 @@ * 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 @@ * (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 @@ * * @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 @@ * * @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 @@ * @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 @@ /** * 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. Modified: trunk/lib/WikiGroup.php =================================================================== --- trunk/lib/WikiGroup.php 2012-08-31 11:43:40 UTC (rev 8278) +++ trunk/lib/WikiGroup.php 2012-08-31 11:49:19 UTC (rev 8279) @@ -99,7 +99,7 @@ /** * 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 @@ * * 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 @@ * * 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 @@ * * 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 @@ * * 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 @@ * 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 @@ * 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 @@ * 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 @@ * 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 @@ * * 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 @@ * * 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 @@ /** * 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 @@ * 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 @@ * * 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 @@ /** * 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 @@ * 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 @@ /** * 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 @@ * 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 @@ * 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 @@ * 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 @@ * 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 @@ /** * 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 @@ * 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(); Modified: trunk/lib/WikiPlugin.php =================================================================== --- trunk/lib/WikiPlugin.php 2012-08-31 11:43:40 UTC (rev 8278) +++ trunk/lib/WikiPlugin.php 2012-08-31 11:49:19 UTC (rev 8279) @@ -52,9 +52,9 @@ * 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; Modified: trunk/lib/WikiPluginCached.php =================================================================== --- trunk/lib/WikiPluginCached.php 2012-08-31 11:43:40 UTC (rev 8278) +++ trunk/lib/WikiPluginCached.php 2012-08-31 11:49:19 UTC (rev 8279) @@ -128,7 +128,7 @@ * @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 @@ * 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 @@ * 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 @@ * 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 @@ * 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 '<?plugin '.$this->getName().' '.$this->glueArgs($argarray).'?>'; @@ -362,8 +362,8 @@ * 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 @@ * 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 @@ * 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 @@ * 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 @@ * 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 @@ * * @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 @@ * @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 @@ * * @access public static * @param doctype string 'gif', 'png', 'jpeg', 'html' - * @return void + * @return void */ function writeHeader($doctype) { static $IMAGEHEADER = array( @@ -613,7 +613,7 @@ * * @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 @@ * @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 @@ * @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 @@ * @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 @@ * 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 @@ * * @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! Modified: trunk/lib/WikiTheme.php =================================================================== --- trunk/lib/WikiTheme.php 2012-08-31 11:43:40 UTC (rev 8278) +++ trunk/lib/WikiTheme.php 2012-08-31 11:49:19 UTC (rev 8279) @@ -1148,7 +1148,7 @@ /** 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) { Modified: trunk/lib/WikiUser/OpenID.php =================================================================== --- trunk/lib/WikiUser/OpenID.php 2012-08-31 11:43:40 UTC (rev 8278) +++ trunk/lib/WikiUser/OpenID.php 2012-08-31 11:49:19 UTC (rev 8279) @@ -45,7 +45,7 @@ * @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 @@ * 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 */ Modified: trunk/lib/WikiUser.php =================================================================== --- trunk/lib/WikiUser.php 2012-08-31 11:43:40 UTC (rev 8278) +++ trunk/lib/WikiUser.php 2012-08-31 11:49:19 UTC (rev 8279) @@ -74,7 +74,7 @@ * * 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) { Modified: trunk/lib/main.php =================================================================== --- trunk/lib/main.php 2012-08-31 11:43:40 UTC (rev 8278) +++ trunk/lib/main.php 2012-08-31 11:49:19 UTC (rev 8279) @@ -334,7 +334,7 @@ * 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. */ Modified: trunk/lib/nusoap/nusoap.php =================================================================== --- trunk/lib/nusoap/nusoap.php 2012-08-31 11:43:40 UTC (rev 8278) +++ trunk/lib/nusoap/nusoap.php 2012-08-31 11:49:19 UTC (rev 8279) @@ -138,7 +138,7 @@ /** * 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 @@ /** * returns error string if present * - * @return boolean $string error string + * @return boolean $string error string * @access public */ function getError(){ @@ -161,7 +161,7 @@ /** * sets error string * - * @return boolean $string error string + * @return boolean $string error string * @access private */ function setError($str){ @@ -172,7 +172,7 @@ * 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 @@ /** * 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 @@ /** * 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 @@ /** * return serialized value * - * @return string XML data + * @return string XML data * @access private */ function serialize($use='encoded') { @@ -1263,8 +1263,8 @@ /** * 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 @@ /** * 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 @@ /** * 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 @@ /** * 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 @@ /** * set the soapaction value * - * @param string $soapaction + * @param string $soapaction * @access public */ function setSOAPAction($soapaction) { @@ -1695,7 +1695,7 @@ /** * 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 @@ /** * 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 @@ * 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 @@ /** * 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 @@ /** * 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 @@ * 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 @@ /** * 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 @@ /** * 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 @@ * 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 @@ * 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 @@ * 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 @@ * 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 @@ /** * 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 @@ /** * 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 @@ * 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 @@ /** * 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 @@ /** * constructor * - * @param string $endpoint SOAP server or WSDL URL - * @param bool $wsdl optional, set to true if using WSDL - * @param int $portN... [truncated message content] |