/**
* Format a line using the old system (aka without any javascript).
*
- * @param $rc RecentChange
+ * @param $rc RecentChange, passed by reference
+ * @param $watched Bool (default false)
+ * @param $linenumber Int (default null)
* @return string
*/
public function recentChangesLine( &$rc, $watched = false, $linenumber = null ) {
* @param $dir String: one of '', 'd', 'l', 'r'
* @param $alt String: text
* @param $title String: text
- * @return String: HTML <img> tag
+ * @return String: HTML "<img>" tag
*/
protected function arrow( $dir, $alt='', $title='' ) {
global $wgStylePath;
/**
* Generate HTML for a right- or left-facing arrow,
* depending on language direction.
- * @return String: HTML <img> tag
+ * @return String: HTML "<img>" tag
*/
protected function sideArrow() {
$dir = $this->getLanguage()->isRTL() ? 'l' : 'r';
/**
* Generate HTML for a down-facing arrow
* depending on language direction.
- * @return String: HTML <img> tag
+ * @return String: HTML "<img>" tag
*/
protected function downArrow() {
return $this->arrow( 'd', '-', $this->msg( 'rc-enhanced-hide' )->text() );
/**
* Generate HTML for a spacer image
- * @return String: HTML <img> tag
+ * @return String: HTML "<img>" tag
*/
protected function spacerArrow() {
return $this->arrow( '', codepointToUtf8( 0xa0 ) ); // non-breaking space
* @private
* @todo document
*
- * @parma $editText string
+ * @param $editText string
*
* @return bool
*/
/**
* Check given input text against $wgSpamRegex, and return the text of the first match.
*
- * @parma $text string
+ * @param $text string
*
* @return string|bool matching string or false
*/
/**
* @param $timestamp string
+ * @param $indent string Default to six spaces
* @return string
*/
function writeTimestamp( $timestamp, $indent = " " ) {
/**
* @param $id
* @param $text string
+ * @param $indent string Default to six spaces
* @return string
*/
function writeContributor( $id, $text, $indent = " " ) {
* despite $query not being used.
*
* @param $nt Title
+ * @param $html String [optional]
+ * @param $query String [optional]
+ * @param $trail String [optional]
+ * @param $prefix String [optional]
+ *
*
* @return string
*/
* Creates a (show/hide) link for deleting revisions/log entries
*
* @param $query Array: query parameters to be passed to link()
- * @param $restricted Boolean: set to true to use a <strong> instead of a <span>
+ * @param $restricted Boolean: set to true to use a "<strong>" instead of a "<span>"
* @param $delete Boolean: set to true to use (show/hide) rather than (show)
*
- * @return String: HTML <a> link to Special:Revisiondelete, wrapped in a
+ * @return String: HTML "<a>" link to Special:Revisiondelete, wrapped in a
* span to allow for customization of appearance with CSS
*/
public static function revDeleteLink( $query = array(), $restricted = false, $delete = true ) {
/**
* Constructor
*
- * @param $title Title of the page we're updating
- * @param $parserOutput ParserOutput: output from a full parse of this page
- * @param $recursive Boolean: queue jobs for recursive updates?
+ * @param $page WikiPage Page we are updating
*/
function __construct( WikiPage $page ) {
parent::__construct( );
/**
* Set $mRedirectedFrom, the Title of the page which redirected us to the current page.
*
- * param @t Title
+ * @param $t Title
*/
public function setRedirectedFrom( $t ) {
$this->mRedirectedFrom = $t;
/**
* Add one or more variables to be set in mw.config in JavaScript.
*
- * @param $key {String|Array} Key or array of key/value pars.
+ * @param $keys {String|Array} Key or array of key/value pairs.
* @param $value {Mixed} [optional] Value of the configuration variable.
*/
public function addJsConfigVars( $keys, $value = null ) {
}
/**
- * @return bool|\Title
+ * @return bool|Title
*/
public function getMovedToTitle() {
if( $this->mMovedToTitle === false ) {
* Returns an Iterator
* @param $separator
* @param $subject
- * @return ArrayIterator|\ExplodeIterator
+ * @return ArrayIterator|ExplodeIterator
*/
static function explode( $separator, $subject ) {
if ( substr_count( $subject, $separator ) > 1000 ) {
* @param $row
* @param Title $title
* @param Array $paramArray
- * @param $comment
+ * @param String $comment Passed by reference
* @return String
*/
private function logActionLinks( $row, $title, $paramArray, &$comment ) {
*
* @param $rc Mixed: change identifier or RecentChange object
* @param $auto Boolean: was this patrol event automatic?
- * @param $performer User: user performing the action or null to use $wgUser
+ * @param $user User: user performing the action or null to use $wgUser
*
* @return bool
*/
* Returns false if unknown or if the document is not multi-page.
*
* @param $image File
+ * @param $page Unused, left for backcompatibility?
* @return array
*/
function getPageDimensions( $image, $page ) {
/**
* @param $key string
* @param $value int
+ * @param $exptime int (default 0)
* @return Mixed
*/
public function add( $key, $value, $exptime = 0 ) {
* article length checks (for stub links) to be bundled into a single query.
*
* @param $nt Title
+ * @param $text String
+ * @param $query Array [optional]
+ * @param $trail String [optional]
+ * @param $prefix String [optional]
* @return string
*/
function makeHolder( $nt, $text = '', $query = array(), $trail = '', $prefix = '' ) {
* Static function to get a template
* Can be overridden via ParserOptions::setTemplateCallback().
*
- * @parma $title Title
+ * @param $title Title
* @param $parser Parser
*
* @return array
* Triple brace replacement -- used for template arguments
* @private
*
- * @param $peice array
+ * @param $piece array
* @param $frame PPFrame
*
* @return array
*
* @todo Document parameter $useOutdated
*
- * @param $article Article
- * @param $popts ParserOptions
+ * @param $article Article
+ * @param $popts ParserOptions
+ * @param $useOutdated Boolean (default true)
* @return bool|mixed|string
*/
public function getKey( $article, $popts, $useOutdated = true ) {
* Retrieve the ParserOutput from ParserCache.
* false if not found or outdated.
*
- * @param $article Article
- * @param $popts ParserOptions
- * @param $useOutdated
+ * @param $article Article
+ * @param $popts ParserOptions
+ * @param $useOutdated Boolean (default false)
*
* @return ParserOutput|bool False on failure
*/
/**
* Callback function to output a restriction
- * @param $row object Protected title
+ * @param Title $row Protected title
* @return string Formatted <li> element
*/
public function formatRow( $row ) {
/**
* Do the write operations. Simple wrapper for RevDel_*List::setVisibility().
+ * @param $bitfield
+ * @param $reason
+ * @param $title
* @return
*/
protected function save( $bitfield, $reason, $title ) {
/**
* Output HTTP response of raw content
* Side effect: writes HTTP response to STDOUT.
- * @param String $content: content
- * @param String $mimeType: mime type
+ * @param $content String content
+ * @param $contentType String mime type
* @return bool
*/
private function outputContents( $content, $contentType ) {
/**
* Default action when we don't have a subpage -- just show links to the uploads we have,
* Also show a button to clear stashed files
- * @param Status : $status - the result of processRequest
+ * @param $status [optional] Status: the result of processRequest
* @return bool
*/
private function showUploads( $status = null ) {
/**
* @private
- * @return bool|\User
+ * @return bool|User
*/
function addNewAccountInternal() {
global $wgAuth, $wgMemc, $wgAccountCreationThrottle,
* Really perform the upload. Stores the file in the local repo, watches
* if necessary and runs the UploadComplete hook.
*
+ * @param $comment
+ * @param $pageText
+ * @param $watch
* @param $user User
*
* @return Status indicating the whether the upload succeeded.
/**
* Represents a temporary filestore, with metadata in the database.
- * Designed to be compatible with the session stashing code in UploadBase (should replace it eventually)
+ * Designed to be compatible with the session stashing code in UploadBase
+ * (should replace it eventually).
*
* @param $repo FileRepo
+ * @param $user User (default null)
*/
public function __construct( FileRepo $repo, $user = null ) {
// this might change based on wiki's configuration.
* Helper function: do the actual database query to fetch file metadata.
*
* @param $key String: key
+ * @param $readFromDB: constant (default: DB_SLAVE)
* @return boolean
*/
protected function fetchFileMetadata( $key, $readFromDB = DB_SLAVE ) {
/**
* Helper function: Initialize the UploadStashFile for a given file.
*
- * @param $path String: path to file
* @param $key String: key under which to store the object
* @throws UploadStashZeroLengthFileException
* @return bool
/**
* Helper function -- given a 'subpage', return the local URL e.g. /wiki/Special:UploadStash/subpage
- * @param {String} $subPage
- * @return {String} local URL for this subpage in the Special:UploadStash space.
+ * @param $subPage String
+ * @return String: local URL for this subpage in the Special:UploadStash space.
*/
private function getSpecialUrl( $subPage ) {
return SpecialPage::getTitleFor( 'UploadStash', $subPage )->getLocalURL();
dépôts / lhc / web / wiklou.git / commitdiff