$imgsNoGallery;
/**
- * @var
+ * @var Array
*/
var $nextPage;
$this->getLanguage()->time( $rc->mAttribs['rc_timestamp'], true, true ) . ' . . ';
}
- /** Insert links to user page, user talk page and eventually a blocking link
+ /**
+ * Insert links to user page, user talk page and eventually a blocking link
*
- * @param $rc RecentChange
+ * @param &$s String HTML to update
+ * @param &$rc RecentChange
*/
public function insertUserRelatedLinks( &$s, &$rc ) {
if( $this->isDeleted( $rc, Revision::DELETED_USER ) ) {
}
/**
- * insert a formatted action
+ * Insert a formatted action
*
* @param $rc RecentChange
*/
* and converted to a space-separated string. In addition to a numerical
* array, the attribute value may also be an associative array. See the
* example below for how that works.
- * @example Numerical array
- * <code>
+ *
+ * @par Numerical array
+ * @code
* Html::element( 'em', array(
* 'class' => array( 'foo', 'bar' )
* ) );
* // gives '<em class="foo bar"></em>'
- * </code>
- * @example Associative array
- * <code>
+ * @endcode
+ *
+ * @par Associative array
+ * @code
* Html::element( 'em', array(
* 'class' => array( 'foo', 'bar', 'foo' => false, 'quux' => true )
* ) );
* // gives '<em class="bar quux"></em>'
- * </code>
+ * @endcode
*
* @param $attribs array Associative array of attributes, e.g., array(
* 'href' => 'http://www.mediawiki.org/' ). Values will be HTML-escaped.
* Returns the Url used to link to a Title
*
* @param $target Title
+ * @param $query Array: query parameters
+ * @param $options Array
*/
private static function linkUrl( $target, $query, $options ) {
wfProfileIn( __METHOD__ );
/**
* This class encapsulates "magic words" such as #redirect, __NOTOC__, etc.
- * Usage:
- * if (MagicWord::get( 'redirect' )->match( $text ) )
+ *
+ * @par Usage:
+ * @code
+ * if (MagicWord::get( 'redirect' )->match( $text ) ) {
+ * // some code
+ * }
+ * @endcode
*
* Possible future improvements:
* * Simultaneous searching for a number of magic words
* To add magic words in an extension, use $magicWords in a file listed in
* $wgExtensionMessagesFiles[].
*
- * Example:
- *
+ * @par Example:
+ * @code
* $magicWords = array();
*
* $magicWords['en'] = array(
* 'magicwordkey' => array( 0, 'case_insensitive_magic_word' ),
* 'magicwordkey2' => array( 1, 'CASE_sensitive_magic_word2' ),
* );
+ * @endcode
*
* For magic words which are also Parser variables, add a MagicWordwgVariableIDs
* hook. Use string keys.
*
* Calling this function kills execution immediately.
*
- * @param $entryPoint String Which entry point we're protecting. One of:
+ * @param $type String Which entry point we are protecting. One of:
* - index.php
* - load.php
* - api.php
}
echo( "$finalOutput\n" );
die( 1 );
-}
\ No newline at end of file
+}
/**
* Creates a single string from an associative array
*
- * @param $header Associative Array: keys are header field names,
- * values are ... values.
+ * @param $headers Associative Array: keys are header field names,
+ * values are ... values.
* @param $endl String: The end of line character. Defaults to "\n"
* @return String
*/
}
/**
+ * @todo document. It just ignore optional parameters.
+ *
* @param $name String: name of cookie
* @param $value String: value to give cookie
- * @param $expire Int: number of seconds til cookie expires
+ * @param $expire Int: number of seconds til cookie expires (Default: 0)
+ * @param $prefix TODO DOCUMENT (Default: null)
+ * @param $domain TODO DOCUMENT (Default: null)
+ *
*/
public function setcookie( $name, $value, $expire = 0, $prefix = null, $domain = null ) {
$this->cookies[$name] = $value;
* Revision::DELETED_RESTRICTED
* @param $id int article ID
* @param $commit boolean defaults to true, triggers transaction end
- * @param &$errors Array of errors to append to
+ * @param &$error Array of errors to append to
* @param $user User The relevant user
* @return boolean true if successful
*/
/**
* Get a link to action=credits of $article page
- * @param $article Article object
- * @return String: html
+ * @return String: HTML link
*/
protected function othersLink() {
return Linker::linkKnown(
* Get token to watch (or unwatch) a page for a user
*
* @param Title $title Title object of page to watch
- * @param User $title User for whom the action is going to be performed
+ * @param User $user User for whom the action is going to be performed
* @param string $action Optionally override the action to 'unwatch'
* @return string Token
* @since 1.18
* Get token to unwatch (or watch) a page for a user
*
* @param Title $title Title object of page to unwatch
- * @param User $title User for whom the action is going to be performed
+ * @param User $user User for whom the action is going to be performed
* @param string $action Optionally override the action to 'watch'
* @return string Token
* @since 1.18
*
* @file
* @defgroup Config Config
- * @ingroup Config
*/
abstract class Conf {
/**
*
* @param $table string|array Table name
* @param $vars string|array Field names
- * @param $conds|array Conditions
+ * @param $conds array Conditions
* @param $fname string Caller function name
* @param $options string|array Query options
* @param $join_conds array|string Join conditions
* Handle reserved keyword replacement in table names
*
* @param $name Object
- * @param $name Boolean
+ * @param $format String Ignored parameter Default 'quoted'Boolean
* @return String
*/
public function tableName( $name, $format = 'quoted' ) {
}
/**
- * Get an array or iterator of file objects for files that have a given
+ * Get an array or iterator of file objects for files that have a given
* SHA-1 content hash.
*
- * @param string
+ * @param $hash String a sha1 hash to look for
* @return Array
*/
function findBySha1( $hash ) {
* http://www.gnu.org/copyleft/gpl.html
*
* @file
- * @defgroup PHPBugTests
- * @ingroup PHPBugTests
+ * @defgroup PHPBugTests PHP known bugs tests
*/
/**
/**
* Returns log page selector.
- * @param $default string The default selection
* @return XmlSelect
* @since 1.19
*/
* Basically what used to be in BitmapHandler::getMetadata().
* Just calls stuff in the Exif class.
*
+ * Parameters are passed to the Exif class.
+ *
* @param $filename string
+ * @param $byteOrder string
*/
function getExif ( $filename, $byteOrder ) {
global $wgShowEXIF;
/**
* Cache a document tree for the DjVu XML metadata
* @param $image File
+ * @param $gettext Boolean: DOCUMENT (Default: false)
*/
function getMetaTree( $image , $gettext = false ) {
if ( isset( $image->dejaMetaTree ) ) {
* Constructor
*
* @param $file String: filename.
+ * @param $byteOrder String Type of byte ordering either 'BE' (Big Endian) or 'LE' (Little Endian). Default ''.
* @todo FIXME: The following are broke:
* SubjectArea. Need to test the more obscure tags.
*
* Format a coordinate value, convert numbers from floating point
* into degree minute second representation.
*
- * @param $coords Array: degrees, minutes and seconds
+ * @param $coord Array: degrees, minutes and seconds
* @param $type String: latitude or longitude (for if its a NWS or E)
* @return mixed A floating point number or whatever we were fed
*/
* @param &$array Array An array containing elements for each type of visibility
* and each of those elements being an array of metadata items. This function adds
* a value to that array.
- * @param $visbility string ('visible' or 'collapsed') if this value is hidden
+ * @param $visibility string ('visible' or 'collapsed') if this value is hidden
* by default.
* @param $type String type of metadata tag (currently always 'exif')
* @param $id String the name of the metadata tag (like 'artist' for example).
* Also catches any errors during processing, writes them to
* debug log, blanks result array and returns false.
*
- * @param String: $content XMP data
- * @param Boolean: $allOfIt If this is all the data (true) or if its split up (false). Default true
- * @param Boolean: $reset - does xml parser need to be reset. Default false
+ * @param $content String: XMP data
+ * @param $allOfIt Boolean: If this is all the data (true) or if its split up (false). Default true
+ * @param $reset Boolean: does xml parser need to be reset. Default false
* @return Boolean success.
*/
public function parse( $content, $allOfIt = true, $reset = false ) {
* to the link cache, so the local cache here should be unnecessary, but
* in fact calling getLength() repeatedly for the same $page does seem to
* run one query for each call?
+ * @todo Document parameters
+ *
* @param $parser Parser
+ * @param $page String TODO DOCUMENT (Default: empty string)
+ * @param $raw TODO DOCUMENT (Default: null)
*/
static function pagesize( $parser, $page = '', $raw = null ) {
static $cache = array();
* It would be preferable to have this code in get()
* instead of having Article looking in our internals.
*
+ * @todo Document parameter $useOutdated
+ *
* @param $article Article
* @param $popts ParserOptions
*/
* Register a file dependency for this output
* @param $name string Title dbKey
* @param $timestamp string MW timestamp of file creation (or false if non-existing)
- * @param $sha string base 36 SHA-1 of file (or false if non-existing)
+ * @param $sha1 string base 36 SHA-1 of file (or false if non-existing)
* @return void
*/
function addImage( $name, $timestamp = null, $sha1 = null ) {
* become part of a WHERE clause
*
* @param $filteredText string
- * @param $fullText string
+ * @param $fulltext string
*
* @return string
*/
/**
* Get the base part of the search query.
*
+ * @param &$query Search query array
* @param $filteredTerm String
* @param $fulltext Boolean
* @since 1.18 (changed)
* Format a link to a group description page
*
* @param $group String: group name
+ * @param $username String Username
* @return string
*/
protected static function buildGroupLink( $group, $username ) {
* Fetch revision text link if it's available to all users
*
* @param $rev Revision
+ * @param $titleObj Title
+ * @param $ts Timestamp
* @return string
*/
function getPageLink( $rev, $titleObj, $ts ) {
* Fetch image view link if it's available to all users
*
* @param $file File
+ * @param $titleObj Title
+ * @param $ts A timestamp
+ * @param $key String: a storage key
+ *
* @return String: HTML fragment
*/
function getFileLink( $file, $titleObj, $ts, $key ) {
/**
* Loader
- *
- * @param $request WebRequest object
*/
function load() {
global $wgAuth, $wgHiddenPrefs, $wgEnableEmail, $wgRedirectOnLogin;
/**
* Adds a table with checkboxes where you can select what groups to add/remove
*
+ * @todo Just pass the username string?
* @param $usergroups Array: groups the user belongs to
+ * @param $user User a user object
* @return string XHTML table element with checkboxes
*/
private function groupCheckboxes( $usergroups, $user ) {
*
* Based on a PHP-Nuke block by Sharjeel which is released under GNU/GPL license
*
- * @link http://phpnuke.org/modules.php?name=News&file=article&sid=8234&mode=thread&order=0&thold=0
+ * @see http://phpnuke.org/modules.php?name=News&file=article&sid=8234&mode=thread&order=0&thold=0
*
* @param $ts string
*
* @ingroup Language
*
* @author Ævar Arnfjörð Bjarmason <avarab@gmail.com>
- * @link http://be.wikipedia.org/wiki/Talk:LanguageBe.php
+ * @see http://be.wikipedia.org/wiki/Talk:LanguageBe.php
* @license http://www.gnu.org/copyleft/gpl.html GNU General Public License
* @license http://www.gnu.org/copyleft/fdl.html GNU Free Documentation License
*/
* @ingroup Language
*
* @author Ævar Arnfjörð Bjarmason <avarab@gmail.com>
- * @link http://be-x-old.wikipedia.org/wiki/Project_talk:LanguageBe_tarask.php
+ * @see http://be-x-old.wikipedia.org/wiki/Project_talk:LanguageBe_tarask.php
* @license http://www.gnu.org/copyleft/gpl.html GNU General Public License
* @license http://www.gnu.org/copyleft/fdl.html GNU Free Documentation License
*/
/**
* Get all databases that have a pending job
- * @param $type String Job type
* @return array
*/
private function getPendingDbs() {
}
/**
- * @param string $text Wikitext to parse
+ * @param string $wikitext Wikitext to parse
* @return ParserOutput
*/
protected function parse( $wikitext ) {
* @group Database
* @param string $source
* @param string $target
- * @param array|string|true $requiredErrors
+ * @param array|string|true $expected Required error
* @dataProvider dataTestIsValidMoveOperation
*/
function testIsValidMoveOperation( $source, $target, $expected ) {
* request, without actually requesting a "real" edit token
* @param $params: key-value API params
* @param $session: session array
+ * @param $user String|null A User object for the context
*/
protected function doApiRequestWithToken( $params, $session, $user = null ) {
if ( $session['wsToken'] ) {
* @dataProvider provideSearchOptionsTests
* @param $requested Array Request parameters. For example array( 'ns5' => true, 'ns6' => true). NULL to use default options.
* @param $userOptions Array User options to test with. For example array('searchNs5' => 1 );. NULL to use default options.
+ * @param $expectedProfile An expected search profile name
+ * @param $expectedNs Array Expected namespaces
*/
function testProfileAndNamespaceLoading(
$requested, $userOptions, $expectedProfile, $expectedNS,
- $message = 'Profile name andnamespaces mismatches!'
+ $message = 'Profile name and namespaces mismatches!'
) {
$context = new RequestContext;
$context->setUser(
/**
* See @bug 28040
- * Credits to #wikipedia-tr users berm, []LuCkY[] and Emperyan
+ * Credits to irc://irc.freenode.net/wikipedia-tr users:
+ * - berm
+ * - []LuCkY[]
+ * - Emperyan
* @see http://en.wikipedia.org/wiki/Dotted_and_dotless_I
* @dataProvider provideDottedAndDotlessI
*/
dépôts / lhc / web / wiklou.git / commitdiff