* various row objects and XML output for filtering. Filters
* can be chained or used as callbacks.
*
- * @param $sink mixed
+ * @param DumpOutput $sink
*/
public function setOutputSink( &$sink ) {
$this->sink =& $sink;
/**
* Dumps a series of page and revision records for those pages
* in the database falling within the page_id range given.
- * @param int $start inclusive lower limit (this id is included)
+ * @param int $start Inclusive lower limit (this id is included)
* @param int $end Exclusive upper limit (this id is not included)
* If 0, no upper limit.
*/
/**
* Dumps a series of page and revision records for those pages
* in the database with revisions falling within the rev_id range given.
- * @param int $start inclusive lower limit (this id is included)
+ * @param int $start Inclusive lower limit (this id is included)
* @param int $end Exclusive upper limit (this id is not included)
* If 0, no upper limit.
*/
}
/**
- * @param $title Title
+ * @param Title $title
*/
public function pageByTitle( $title ) {
$this->dumpFrom(
}
/**
- * @param $name string
+ * @param string $name
* @throws MWException
*/
public function pageByName( $name ) {
}
/**
- * @param $names array
+ * @param array $names
*/
public function pagesByName( $names ) {
foreach ( $names as $name ) {
}
/**
- * @param $start int
- * @param $end int
+ * @param int $start
+ * @param int $end
*/
public function logsByRange( $start, $end ) {
$condition = 'log_id >= ' . intval( $start );
* Not called by default (depends on $this->list_authors)
* Can be set by Special:Export when not exporting whole history
*
- * @param $cond
+ * @param array $cond
*/
protected function do_list_authors( $cond ) {
wfProfileIn( __METHOD__ );
}
/**
- * @param $cond string
+ * @param string $cond
* @throws MWException
* @throws Exception
*/
* separate database connection not managed by LoadBalancer; some
* blob storage types will make queries to pull source data.
*
- * @param $resultset ResultWrapper
+ * @param ResultWrapper $resultset
*/
protected function outputPageStream( $resultset ) {
$last = null;
}
/**
- * @param $resultset array
+ * @param array $resultset
*/
protected function outputLogStream( $resultset ) {
foreach ( $resultset as $row ) {
* Opens a "<page>" section on the output stream, with data
* from the given database row.
*
- * @param $row object
+ * @param object $row
* @return string
*/
public function openPage( $row ) {
* Dumps a "<revision>" section on the output stream, with
* data filled in from the given database row.
*
- * @param $row object
+ * @param object $row
* @return string
* @access private
*/
* Dumps a "<logitem>" section on the output stream, with
* data filled in from the given database row.
*
- * @param $row object
+ * @param object $row
* @return string
* @access private
*/
}
/**
- * @param $timestamp string
+ * @param string $timestamp
* @param string $indent Default to six spaces
* @return string
*/
}
/**
- * @param $id
- * @param $text string
+ * @param int $id
+ * @param string $text
* @param string $indent Default to six spaces
* @return string
*/
/**
* Warning! This data is potentially inconsistent. :(
- * @param $row
- * @param $dumpContents bool
+ * @param object $row
+ * @param bool $dumpContents
* @return string
*/
function writeUploads( $row, $dumpContents = false ) {
/**
* @param File $file
- * @param $dumpContents bool
+ * @param bool $dumpContents
* @return string
*/
function writeUpload( $file, $dumpContents = false ) {
class DumpOutput {
/**
- * @param $string string
+ * @param string $string
*/
function writeOpenStream( $string ) {
$this->write( $string );
}
/**
- * @param $string string
+ * @param string $string
*/
function writeCloseStream( $string ) {
$this->write( $string );
}
/**
- * @param $page
- * @param $string string
+ * @param object $page
+ * @param string $string
*/
function writeOpenPage( $page, $string ) {
$this->write( $string );
}
/**
- * @param $string string
+ * @param string $string
*/
function writeClosePage( $string ) {
$this->write( $string );
}
/**
- * @param $rev
- * @param $string string
+ * @param object $rev
+ * @param string $string
*/
function writeRevision( $rev, $string ) {
$this->write( $string );
}
/**
- * @param $rev
- * @param $string string
+ * @param object $rev
+ * @param string $string
*/
function writeLogItem( $rev, $string ) {
$this->write( $string );
/**
* Override to write to a different stream type.
- * @param $string string
+ * @param string $string
* @return bool
*/
function write( $string ) {
* and reopen new file with the old name. Use this
* for writing out a file in multiple pieces
* at specified checkpoints (e.g. every n hours).
- * @param $newname mixed File name. May be a string or an array with one element
+ * @param string|array $newname File name. May be a string or an array with one element
*/
function closeRenameAndReopen( $newname ) {
}
* Close the old file, and move it to a specified name.
* Use this for the last piece of a file written out
* at specified checkpoints (e.g. every n hours).
- * @param $newname mixed File name. May be a string or an array with one element
+ * @param string|array $newname File name. May be a string or an array with one element
* @param bool $open If true, a new file with the old filename will be opened
* again for writing (default: false)
*/
protected $handle = false, $filename;
/**
- * @param $file
+ * @param string $file
*/
function __construct( $file ) {
$this->handle = fopen( $file, "wt" );
}
/**
- * @param $string string
+ * @param string $string
*/
function writeCloseStream( $string ) {
parent::writeCloseStream( $string );
}
/**
- * @param $string string
+ * @param string $string
*/
function write( $string ) {
fputs( $this->handle, $string );
}
/**
- * @param $newname
+ * @param string $newname
*/
function closeRenameAndReopen( $newname ) {
$this->closeAndRename( $newname, true );
}
/**
- * @param $newname
+ * @param string $newname
* @throws MWException
*/
function renameOrException( $newname ) {
}
/**
- * @param $newname array
- * @return mixed
+ * @param array $newname
+ * @return string
* @throws MWException
*/
function checkRenameArgCount( $newname ) {
}
/**
- * @param $newname mixed
- * @param $open bool
+ * @param string $newname
+ * @param bool $open
*/
function closeAndRename( $newname, $open = false ) {
$newname = $this->checkRenameArgCount( $newname );
protected $procOpenResource = false;
/**
- * @param $command
- * @param $file null
+ * @param string $command
+ * @param string $file
*/
function __construct( $command, $file = null ) {
if ( !is_null( $file ) ) {
}
/**
- * @param $string string
+ * @param string $string
*/
function writeCloseStream( $string ) {
parent::writeCloseStream( $string );
}
/**
- * @param $command
+ * @param string $command
*/
function startCommand( $command ) {
$spec = array(
}
/**
- * @param mixed $newname
+ * @param string $newname
*/
function closeRenameAndReopen( $newname ) {
$this->closeAndRename( $newname, true );
}
/**
- * @param $newname mixed
- * @param $open bool
+ * @param string $newname
+ * @param bool $open
*/
function closeAndRename( $newname, $open = false ) {
$newname = $this->checkRenameArgCount( $newname );
class DumpGZipOutput extends DumpPipeOutput {
/**
- * @param $file string
+ * @param string $file
*/
function __construct( $file ) {
parent::__construct( "gzip", $file );
class DumpBZip2Output extends DumpPipeOutput {
/**
- * @param $file string
+ * @param string $file
*/
function __construct( $file ) {
parent::__construct( "bzip2", $file );
class Dump7ZipOutput extends DumpPipeOutput {
/**
- * @param $file string
+ * @param string $file
*/
function __construct( $file ) {
$command = $this->setup7zCommand( $file );
}
/**
- * @param $file string
+ * @param string $file
* @return string
*/
function setup7zCommand( $file ) {
}
/**
- * @param $newname string
- * @param $open bool
+ * @param string $newname
+ * @param bool $open
*/
function closeAndRename( $newname, $open = false ) {
$newname = $this->checkRenameArgCount( $newname );
protected $sendingThisPage;
/**
- * @param $sink DumpOutput
+ * @param DumpOutput $sink
*/
function __construct( &$sink ) {
$this->sink =& $sink;
}
/**
- * @param $string string
+ * @param string $string
*/
function writeOpenStream( $string ) {
$this->sink->writeOpenStream( $string );
}
/**
- * @param $string string
+ * @param string $string
*/
function writeCloseStream( $string ) {
$this->sink->writeCloseStream( $string );
}
/**
- * @param $page
- * @param $string string
+ * @param object $page
+ * @param string $string
*/
function writeOpenPage( $page, $string ) {
$this->sendingThisPage = $this->pass( $page, $string );
}
/**
- * @param $string string
+ * @param string $string
*/
function writeClosePage( $string ) {
if ( $this->sendingThisPage ) {
}
/**
- * @param $rev
- * @param $string string
+ * @param object $rev
+ * @param string $string
*/
function writeRevision( $rev, $string ) {
if ( $this->sendingThisPage ) {
}
/**
- * @param $rev
- * @param $string string
+ * @param object $rev
+ * @param string $string
*/
function writeLogItem( $rev, $string ) {
$this->sink->writeRevision( $rev, $string );
}
/**
- * @param $newname string
+ * @param string $newname
*/
function closeRenameAndReopen( $newname ) {
$this->sink->closeRenameAndReopen( $newname );
}
/**
- * @param $newname string
- * @param $open bool
+ * @param string $newname
+ * @param bool $open
*/
function closeAndRename( $newname, $open = false ) {
$this->sink->closeAndRename( $newname, $open );
/**
* Override for page-based filter types.
- * @param $page
+ * @param object $page
* @return bool
*/
function pass( $page ) {
class DumpNotalkFilter extends DumpFilter {
/**
- * @param $page
+ * @param object $page
* @return bool
*/
function pass( $page ) {
var $namespaces = array();
/**
- * @param $sink DumpOutput
- * @param $param
+ * @param DumpOutput $sink
+ * @param array $param
* @throws MWException
*/
function __construct( &$sink, $param ) {
}
/**
- * @param $page
+ * @param object $page
* @return bool
*/
function pass( $page ) {
var $page, $pageString, $rev, $revString;
/**
- * @param $page
- * @param $string string
+ * @param object $page
+ * @param string $string
*/
function writeOpenPage( $page, $string ) {
$this->page = $page;
}
/**
- * @param $string string
+ * @param string $string
*/
function writeClosePage( $string ) {
if ( $this->rev ) {
}
/**
- * @param $rev
- * @param $string string
+ * @param object $rev
+ * @param string $string
*/
function writeRevision( $rev, $string ) {
if ( $rev->rev_id == $this->page->page_latest ) {
class DumpMultiWriter {
/**
- * @param $sinks
+ * @param array $sinks
*/
function __construct( $sinks ) {
$this->sinks = $sinks;
}
/**
- * @param $string string
+ * @param string $string
*/
function writeOpenStream( $string ) {
for ( $i = 0; $i < $this->count; $i++ ) {
}
/**
- * @param $string string
+ * @param string $string
*/
function writeCloseStream( $string ) {
for ( $i = 0; $i < $this->count; $i++ ) {
}
/**
- * @param $page
- * @param $string string
+ * @param object $page
+ * @param string $string
*/
function writeOpenPage( $page, $string ) {
for ( $i = 0; $i < $this->count; $i++ ) {
}
/**
- * @param $string
+ * @param string $string
*/
function writeClosePage( $string ) {
for ( $i = 0; $i < $this->count; $i++ ) {
}
/**
- * @param $rev
- * @param $string
+ * @param object $rev
+ * @param string $string
*/
function writeRevision( $rev, $string ) {
for ( $i = 0; $i < $this->count; $i++ ) {
}
/**
- * @param $newnames
+ * @param array $newnames
*/
function closeRenameAndReopen( $newnames ) {
$this->closeAndRename( $newnames, true );
}
/**
- * @param $newnames array
+ * @param array $newnames
* @param bool $open
*/
function closeAndRename( $newnames, $open = false ) {
}
/**
- * @param $string string
+ * @param string $string
* @return string
*/
function xmlsafe( $string ) {
/**
* Creates an ImportXMLReader drawing from the source provided
- * @param $source
+ * @param string $source
*/
function __construct( $source ) {
$this->reader = new XMLReader();
/**
* Set debug mode...
- * @param $debug bool
+ * @param bool $debug
*/
function setDebug( $debug ) {
$this->mDebug = $debug;
/**
* Set 'no updates' mode. In this mode, the link tables will not be updated by the importer
- * @param $noupdates bool
+ * @param bool $noupdates
*/
function setNoUpdates( $noupdates ) {
$this->mNoUpdates = $noupdates;
/**
* Set a target namespace to override the defaults
- * @param $namespace
+ * @param null|int $namespace
* @return bool
*/
public function setTargetNamespace( $namespace ) {
/**
* Set a target root page under which all pages are imported
- * @param $rootpage
- * @return status object
+ * @param null|string $rootpage
+ * @return Status
*/
public function setTargetRootPage( $rootpage ) {
$status = Status::newGood();
}
/**
- * @param $dir
+ * @param string $dir
*/
public function setImageBasePath( $dir ) {
$this->mImageBasePath = $dir;
}
/**
- * @param $import
+ * @param bool $import
*/
public function setImportUploads( $import ) {
$this->mImportUploads = $import;
/**
* Default per-revision callback, performs the import.
- * @param $revision WikiRevision
+ * @param WikiRevision $revision
* @return bool
*/
public function importRevision( $revision ) {
/**
* Default per-revision callback, performs the import.
- * @param $rev WikiRevision
+ * @param WikiRevision $rev
* @return bool
*/
public function importLogItem( $rev ) {
/**
* Dummy for now...
- * @param $revision
+ * @param WikiRevision $revision
* @return bool
*/
public function importUpload( $revision ) {
/**
* Mostly for hook use
- * @param $title
- * @param $origTitle
- * @param $revCount
- * @param $sRevCount
- * @param $pageInfo
+ * @param Title $title
+ * @param string $origTitle
+ * @param int $revCount
+ * @param int $sRevCount
+ * @param array $pageInfo
* @return
*/
public function finishImportPage( $title, $origTitle, $revCount, $sRevCount, $pageInfo ) {
/**
* Alternate per-revision callback, for debugging.
- * @param $revision WikiRevision
+ * @param WikiRevision $revision
*/
public function debugRevisionHandler( &$revision ) {
$this->debug( "Got revision:" );
/**
* Notify the callback function when a new "<page>" is reached.
- * @param $title Title
+ * @param Title $title
*/
function pageCallback( $title ) {
if ( isset( $this->mPageCallback ) ) {
/**
* Notify the callback function when a "</page>" is closed.
- * @param $title Title
- * @param $origTitle Title
- * @param $revCount Integer
- * @param int $sucCount number of revisions for which callback returned true
- * @param array $pageInfo associative array of page information
+ * @param Title $title
+ * @param Title $origTitle
+ * @param int $revCount
+ * @param int $sucCount Number of revisions for which callback returned true
+ * @param array $pageInfo Associative array of page information
*/
private function pageOutCallback( $title, $origTitle, $revCount, $sucCount, $pageInfo ) {
if ( isset( $this->mPageOutCallback ) ) {
/**
* Notify the callback function of a revision
- * @param $revision WikiRevision object
+ * @param WikiRevision $revision
* @return bool|mixed
*/
private function revisionCallback( $revision ) {
/**
* Notify the callback function of a new log item
- * @param $revision WikiRevision object
+ * @param WikiRevision $revision
* @return bool|mixed
*/
private function logItemCallback( $revision ) {
}
/**
- * @param $logInfo
+ * @param array $logInfo
* @return bool|mixed
*/
private function processLogItem( $logInfo ) {
}
/**
- * @param $pageInfo array
+ * @param array $pageInfo
*/
private function handleRevision( &$pageInfo ) {
$this->debug( "Enter revision handler" );
}
/**
- * @param $pageInfo
- * @param $revisionInfo
+ * @param array $pageInfo
+ * @param array $revisionInfo
* @return bool|mixed
*/
private function processRevision( $pageInfo, $revisionInfo ) {
}
/**
- * @param $pageInfo
+ * @param array $pageInfo
* @return mixed
*/
private function handleUpload( &$pageInfo ) {
}
/**
- * @param $contents
+ * @param string $contents
* @return string
*/
private function dumpTemp( $contents ) {
}
/**
- * @param $pageInfo
- * @param $uploadInfo
+ * @param array $pageInfo
+ * @param array $uploadInfo
* @return mixed
*/
private function processUpload( $pageInfo, $uploadInfo ) {
}
/**
- * @param $text string
- * @return Array or false
+ * @param string $text
+ * @return array|bool
*/
private function processTitle( $text ) {
global $wgCommandLineMode;
private $mPosition;
/**
- * @param $source
+ * @param string $source
* @return string
*/
static function registerSource( $source ) {
}
/**
- * @param $path
- * @param $mode
- * @param $options
- * @param $opened_path
+ * @param string $path
+ * @param string $mode
+ * @param array $options
+ * @param string $opened_path
* @return bool
*/
function stream_open( $path, $mode, $options, &$opened_path ) {
}
/**
- * @param $count
+ * @param int $count
* @return string
*/
function stream_read( $count ) {
}
/**
- * @param $data
+ * @param string $data
* @return bool
*/
function stream_write( $data ) {
private $mNoUpdates = false;
/**
- * @param $title
+ * @param Title $title
* @throws MWException
*/
function setTitle( $title ) {
}
/**
- * @param $id
+ * @param int $id
*/
function setID( $id ) {
$this->id = $id;
}
/**
- * @param $ts
+ * @param string $ts
*/
function setTimestamp( $ts ) {
# 2003-08-05T18:30:02Z
}
/**
- * @param $user
+ * @param string $user
*/
function setUsername( $user ) {
$this->user_text = $user;
}
/**
- * @param $ip
+ * @param string $ip
*/
function setUserIP( $ip ) {
$this->user_text = $ip;
}
/**
- * @param $model
+ * @param string $model
*/
function setModel( $model ) {
$this->model = $model;
}
/**
- * @param $format
+ * @param string $format
*/
function setFormat( $format ) {
$this->format = $format;
}
/**
- * @param $text
+ * @param string $text
*/
function setText( $text ) {
$this->text = $text;
}
/**
- * @param $text
+ * @param string $text
*/
function setComment( $text ) {
$this->comment = $text;
}
/**
- * @param $minor
+ * @param bool $minor
*/
function setMinor( $minor ) {
$this->minor = (bool)$minor;
}
/**
- * @param $src
+ * @param mixed $src
*/
function setSrc( $src ) {
$this->src = $src;
}
/**
- * @param $src
- * @param $isTemp
+ * @param string $src
+ * @param bool $isTemp
*/
function setFileSrc( $src, $isTemp ) {
$this->fileSrc = $src;
}
/**
- * @param $sha1base36
+ * @param string $sha1base36
*/
function setSha1Base36( $sha1base36 ) {
$this->sha1base36 = $sha1base36;
}
/**
- * @param $filename
+ * @param string $filename
*/
function setFilename( $filename ) {
$this->filename = $filename;
}
/**
- * @param $archiveName
+ * @param string $archiveName
*/
function setArchiveName( $archiveName ) {
$this->archiveName = $archiveName;
}
/**
- * @param $size
+ * @param int $size
*/
function setSize( $size ) {
$this->size = intval( $size );
}
/**
- * @param $type
+ * @param string $type
*/
function setType( $type ) {
$this->type = $type;
}
/**
- * @param $action
+ * @param string $action
*/
function setAction( $action ) {
$this->action = $action;
}
/**
- * @param $params
+ * @param array $params
*/
function setParams( $params ) {
$this->params = $params;
}
/**
- * @param $noupdates
+ * @param bool $noupdates
*/
public function setNoUpdates( $noupdates ) {
$this->mNoUpdates = $noupdates;
}
/**
- * @return String
+ * @return string
*/
function getModel() {
if ( is_null( $this->model ) ) {
}
/**
- * @return String
+ * @return string
*/
function getFormat() {
if ( is_null( $this->model ) ) {
}
/**
- * @return bool|String
+ * @return bool|string
*/
function getSha1() {
if ( $this->sha1base36 ) {
}
/**
- * @param $filename string
+ * @param string $filename
* @return Status
*/
static function newFromFile( $filename ) {
}
/**
- * @param $fieldname string
+ * @param string $fieldname
* @return Status
*/
static function newFromUpload( $fieldname = "xmlimport" ) {
}
/**
- * @param $url
- * @param $method string
+ * @param string $url
+ * @param string $method
* @return Status
*/
static function newFromURL( $url, $method = 'GET' ) {
}
/**
- * @param $interwiki
- * @param $page
- * @param $history bool
- * @param $templates bool
- * @param $pageLinkDepth int
+ * @param string $interwiki
+ * @param string $page
+ * @param bool $history
+ * @param bool $templates
+ * @param int $pageLinkDepth
* @return Status
*/
public static function newFromInterwiki( $interwiki, $page, $history = false, $templates = false, $pageLinkDepth = 0 ) {
dépôts / lhc / web / wiklou.git / commitdiff