/**
* Generic accessor
+ * @param string $key
* @return bool
*/
private function getX( $key ) {
class AtomFeed extends ChannelFeed {
/**
* @todo document
+ * @param string|int $ts
* @return string
*/
function formatTime( $ts ) {
/**
* Fork a number of worker processes.
*
+ * @param int $numProcs
* @return string
*/
protected function forkWorkers( $numProcs ) {
/* @{ */
/**
* Whether the option exists.
+ * @param string $name
* @return bool
*/
public function offsetExists( $name ) {
/**
* Retrieve an option value.
+ * @param string $name
* @return mixed
*/
public function offsetGet( $name ) {
/**
* Set an option to given value.
+ * @param string $name
+ * @param mixed $value
*/
public function offsetSet( $name, $value ) {
$this->setValue( $name, $value );
/**
* Delete the option.
+ * @param string $name
*/
public function offsetUnset( $name ) {
$this->delete( $name );
* frame parameters supplied by the Parser.
* @param array $frameParams The frame parameters
* @param string $query An optional query string to add to description page links
+ * @param Parser|null $parser
* @return array
*/
private static function getImageLinkMTOParams( $frameParams, $query = '', $parser = null ) {
* Constructor for OutputPage. This should not be called directly.
* Instead a new RequestContext should be created and it will implicitly create
* a OutputPage tied to that context.
+ * @param IContextSource|null $context
*/
function __construct( IContextSource $context = null ) {
if ( $context === null ) {
/**
* Set the URL to be used for the <link rel=canonical>. This should be used
* in preference to addLink(), to avoid duplicate link tags.
+ * @param string $url
*/
function setCanonicalUrl( $url ) {
$this->mCanonicalUrl = $url;
/**
* This is called if a write operation is possible from the generated HTML
+ * @param bool $enable
*/
function preventClickjacking( $enable = true ) {
$this->preventClickjacking = $enable;
/**
* Performs file verification, dies on error.
+ * @param array $verification
*/
protected function checkVerification( array $verification ) {
// @todo Move them to ApiBase's message map
return new $this->contentClass( '' );
}
- /** JSON is English **/
+ /**
+ * Returns the english language, because JSON is english, and should be handled as such.
+ *
+ * @param Title $title
+ * @param Content|null $content
+ *
+ * @return Language Return of wfGetLangObj( 'en' )
+ *
+ * @see ContentHandler::getPageLanguage()
+ */
public function getPageLanguage( Title $title, Content $content = null ) {
return wfGetLangObj( 'en' );
}
- /** JSON is English **/
+ /**
+ * Returns the english language, because JSON is english, and should be handled as such.
+ *
+ * @param Title $title
+ * @param Content|null $content
+ *
+ * @return Language Return of wfGetLangObj( 'en' )
+ *
+ * @see ContentHandler::getPageLanguage()
+ */
public function getPageViewLanguage( Title $title, Content $content = null ) {
return wfGetLangObj( 'en' );
}
}
/**
+ * @param array $err
* @return string
*/
private function formatError( $err ) {
/**
* Begin a transaction, committing any previously open transaction
+ * @param string $fname
*/
protected function doBegin( $fname = __METHOD__ ) {
sqlsrv_begin_transaction( $this->mConn );
/**
* End a transaction
+ * @param string $fname
*/
protected function doCommit( $fname = __METHOD__ ) {
sqlsrv_commit( $this->mConn );
/**
* Rollback a transaction.
* No-op on non-transactional databases.
+ * @param string $fname
*/
protected function doRollback( $fname = __METHOD__ ) {
sqlsrv_rollback( $this->mConn );
/**
* Return aggregated value function call
+ * @param array $valuedata
+ * @param string $valuename
+ * @return array
*/
public function aggregateValue( $valuedata, $valuename = 'value' ) {
return $valuedata;
* Clean text for indexing. Only really suitable for indexing in databases.
* If you're using a real search engine, you'll probably want to override
* this behavior and do something nicer with the original wikitext.
+ * @param string $text
*/
public static function updateText( $text ) {
global $wgContLang;
* Get a string representation of a title suitable for
* including in a search index
*
+ * @param SearchEngine $search
* @return string A stripped-down title string ready for the search index
*/
private function indexTitle( SearchEngine $search ) {
/**
* Use specified text instead of loading from the database
+ * @param Content $oldContent
+ * @param Content $newContent
* @since 1.21
*/
public function setContent( Content $oldContent, Content $newContent ) {
/**
* Set the language in which the diff text is written
* (Defaults to page content language).
+ * @param Language|string $lang
* @since 1.19
*/
public function setTextLanguage( $lang ) {
/**
* Send a header, if we haven't already sent them. We shouldn't,
* but sometimes we might in a weird case like Export
+ * @param string $header
*/
private static function header( $header ) {
if ( !headers_sent() ) {
/**
* Check if the backend medium supports a field of extra features
*
- * @return int Bitfield of FileBackend::ATTR_* flags
+ * @param int $bitfield Bitfield of FileBackend::ATTR_* flags
* @return bool
* @since 1.23
*/
* Delete files in the deleted directory if they are not referenced in the filearchive table
*
* STUB
+ * @param array $storageKeys
*/
public function cleanupDeletedBatch( array $storageKeys ) {
$this->assertWritableRepo();
/**
* Create a repo class based on an info structure
+ * @param array $info
*/
protected function newRepo( $info ) {
$class = $info['class'];
* Hook into transform() to allow migration of thumbnail files
* STUB
* Overridden by LocalFile
+ * @param string $thumbName
*/
function migrateThumbFile( $thumbName ) {
}
/**
* Load file metadata from the DB
+ * @param int $flags
*/
function loadFromDB( $flags = 0 ) {
# Polymorphic function name to distinguish foreign and local fetches
/**
* Delete cached transformed files for the current version only.
+ * @param array $options
*/
function purgeThumbnails( $options = array() ) {
global $wgUseSquid;
/**
* Add a file by ID
+ * @param int $fa_id
*/
function addId( $fa_id ) {
$this->ids[] = $fa_id;
/**
* Add a whole lot of files by ID
+ * @param int[] $ids
*/
function addIds( $ids ) {
$this->ids = array_merge( $this->ids, $ids );
/**
* Cleanup a partially moved array of triplets by deleting the target
* files. Called if something went wrong half way.
+ * @param array $triplets
*/
function cleanupTarget( $triplets ) {
// Create dest pairs from the triplets
/**
* Cleanup a fully moved array of triplets by deleting the source files.
* Called at the end of the move process if everything else went ok.
+ * @param array $triplets
*/
function cleanupSource( $triplets ) {
// Create source file names from the triplets
*
* You should not call this directly, but instead use
* ImageGalleryBase::factory().
+ * @param string $mode
*/
function __construct( $mode = 'traditional' ) {
global $wgGalleryOptions;
/**
* Set bad image flag
+ * @param bool $flag
*/
function setHideBadImages( $flag = true ) {
$this->mHideBadImages = $flag;
/**
* Do not support per-row on packed. It really doesn't work
* since the images have varying widths.
+ * @param int $num
*/
public function setPerRow( $num ) {
return;
}
/**
+ * @param string $value
+ * @return string
* @since 1.20
*/
public function getDiv( $value ) {
}
/**
+ * @param string $value
+ * @return string
* @since 1.20
*/
public function getRaw( $value ) {
}
/**
+ * @param string $value
+ * @return string
* @since 1.20
*/
public function getDiv( $value ) {
}
/**
+ * @param string $value
+ * @return string
* @since 1.20
*/
public function getRaw( $value ) {
}
/**
+ * @param string $value
+ * @return string
* @since 1.20
*/
public function getDiv( $value ) {
}
/**
+ * @param string $value
+ * @return string
* @since 1.20
*/
public function getRaw( $value ) {
/**
* Get a Redis object with a connection suitable for fetching the specified key
+ * @param string $key
* @return array (server, RedisConnRef) or (false, false)
*/
protected function getConnection( $key ) {
}
/**
+ * @param DatabaseBase $db
* @param string $exptime
* @return bool
*/
/**
* Extra key that should be present in the parser cache key.
+ * @param string $key
*/
public function addExtraKey( $key ) {
$this->mExtraKey .= '!' . $key;
/**
* Fairly generic flag setter thingy.
+ * @param string $flag
*/
public function setFlag( $flag ) {
$this->mFlags[$flag] = true;
/**
* Callback to get a formatted line for the call tree
+ * @param array $entry
* @return string
*/
protected function getCallTreeLine( $entry ) {
/**
* Dummy calls to wfProfileIn/wfProfileOut to calculate its overhead
+ * @param int $profileCount
*/
protected static function calculateOverhead( $profileCount ) {
wfProfileIn( '-overhead-total' );
/**
* @param string $term
+ * @param int $resultsShown
+ * @param int $totalNum
* @return string
*/
protected function shortDialog( $term, $resultsShown, $totalNum ) {
dépôts / lhc / web / wiklou.git / commitdiff