From b119fc09569ff2de271fef4af38d5a8cea9c14d3 Mon Sep 17 00:00:00 2001 From: Fran Rogers Date: Mon, 11 Aug 2008 04:39:00 +0000 Subject: [PATCH] Updated Doxygen docs for Title.php --- includes/Title.php | 482 +++++++++++++++++++++++-------------------- maintenance/Doxyfile | 3 +- 2 files changed, 258 insertions(+), 227 deletions(-) diff --git a/includes/Title.php b/includes/Title.php index ed28f8b6e4..349bce77e7 100644 --- a/includes/Title.php +++ b/includes/Title.php @@ -23,53 +23,50 @@ define( 'MW_TITLECACHE_MAX', 1000 ); define( 'CASCADE', 1 ); /** - * Title class - * - Represents a title, which may contain an interwiki designation or namespace - * - Can fetch various kinds of data from the database, albeit inefficiently. - * + * Represents a title within MediaWiki. + * Optionally may contain an interwiki designation or namespace. + * @note This class can fetch various kinds of data from the database; + * however, it does so inefficiently. */ class Title { - /** - * Static cache variables - */ + /** @name Static cache variables */ + //@{ static private $titleCache=array(); static private $interwikiCache=array(); - + //@} /** - * All member variables should be considered private - * Please use the accessor functions - */ - - /**#@+ + * @name Private member variables + * Please use the accessor functions instead. * @private */ - - var $mTextform = ''; # Text form (spaces not underscores) of the main part - var $mUrlform = ''; # URL-encoded form of the main part - var $mDbkeyform = ''; # Main part with underscores - var $mUserCaseDBKey; # DB key with the initial letter in the case specified by the user - var $mNamespace = NS_MAIN; # Namespace index, i.e. one of the NS_xxxx constants - var $mInterwiki = ''; # Interwiki prefix (or null string) - var $mFragment; # Title fragment (i.e. the bit after the #) - var $mArticleID = -1; # Article ID, fetched from the link cache on demand - var $mLatestID = false; # ID of most recent revision - var $mRestrictions = array(); # Array of groups allowed to edit this article + //@{ + + var $mTextform = ''; ///< Text form (spaces not underscores) of the main part + var $mUrlform = ''; ///< URL-encoded form of the main part + var $mDbkeyform = ''; ///< Main part with underscores + var $mUserCaseDBKey; ///< DB key with the initial letter in the case specified by the user + var $mNamespace = NS_MAIN; ///< Namespace index, i.e. one of the NS_xxxx constants + var $mInterwiki = ''; ///< Interwiki prefix (or null string) + var $mFragment; ///< Title fragment (i.e. the bit after the #) + var $mArticleID = -1; ///< Article ID, fetched from the link cache on demand + var $mLatestID = false; ///< ID of most recent revision + var $mRestrictions = array(); ///< Array of groups allowed to edit this article var $mOldRestrictions = false; - var $mCascadeRestriction; # Cascade restrictions on this page to included templates and images? - var $mRestrictionsExpiry; # When do the restrictions on this page expire? - var $mHasCascadingRestrictions; # Are cascading restrictions in effect on this page? - var $mCascadeRestrictionSources; # Where are the cascading restrictions coming from on this page? - var $mRestrictionsLoaded = false; # Boolean for initialisation on demand - var $mPrefixedText; # Text form including namespace/interwiki, initialised on demand + var $mCascadeRestriction; ///< Cascade restrictions on this page to included templates and images? + var $mRestrictionsExpiry; ///< When do the restrictions on this page expire? + var $mHasCascadingRestrictions; ///< Are cascading restrictions in effect on this page? + var $mCascadeRestrictionSources; ///< Where are the cascading restrictions coming from on this page? + var $mRestrictionsLoaded = false; ///< Boolean for initialisation on demand + var $mPrefixedText; ///< Text form including namespace/interwiki, initialised on demand # Don't change the following default, NS_MAIN is hardcoded in several # places. See bug 696. - var $mDefaultNamespace = NS_MAIN; # Namespace index when there is no namespace - # Zero except in {{transclusion}} tags - var $mWatched = null; # Is $wgUser watching this page? null if unfilled, accessed through userIsWatching() - var $mLength = -1; # The page length, 0 for special pages - var $mRedirect = null; # Is the article at this title a redirect? - /**#@-*/ + var $mDefaultNamespace = NS_MAIN; ///< Namespace index when there is no namespace + # Zero except in {{transclusion}} tags + var $mWatched = null; ///< Is $wgUser watching this page? null if unfilled, accessed through userIsWatching() + var $mLength = -1; ///< The page length, 0 for special pages + var $mRedirect = null; ///< Is the article at this title a redirect? + //@} /** @@ -80,10 +77,10 @@ class Title { /** * Create a new Title from a prefixed DB key - * @param string $key The database key, which has underscores + * @param $key \type{\string} The database key, which has underscores * instead of spaces, possibly including namespace and * interwiki prefixes - * @return Title the new object, or NULL on an error + * @return \type{Title} the new object, or NULL on an error */ public static function newFromDBkey( $key ) { $t = new Title(); @@ -98,12 +95,12 @@ class Title { * Create a new Title from text, such as what one would * find in a link. Decodes any HTML entities in the text. * - * @param string $text the link text; spaces, prefixes, + * @param $text \type{\string} the link text; spaces, prefixes, * and an initial ':' indicating the main namespace * are accepted - * @param int $defaultNamespace the namespace to use if + * @param $defaultNamespace \type{\int} the namespace to use if * none is specified by a prefix - * @return Title the new object, or NULL on an error + * @return \type{Title} the new object, or NULL on an error */ public static function newFromText( $text, $defaultNamespace = NS_MAIN ) { if( is_object( $text ) ) { @@ -152,8 +149,8 @@ class Title { /** * Create a new Title from URL-encoded text. Ensures that * the given title's length does not exceed the maximum. - * @param string $url the title, as might be taken from a URL - * @return Title the new object, or NULL on an error + * @param $url \type{\string} the title, as might be taken from a URL + * @return \type{Title} the new object, or NULL on an error */ public static function newFromURL( $url ) { global $wgLegalTitleChars; @@ -180,9 +177,9 @@ class Title { * @todo This is inefficiently implemented, the page row is requested * but not used for anything else * - * @param int $id the page_id corresponding to the Title to create - * @param int $flags, use GAID_FOR_UPDATE to use master - * @return Title the new object, or NULL on an error + * @param $id \type{\int} the page_id corresponding to the Title to create + * @param $flags \type{\int} use GAID_FOR_UPDATE to use master + * @return \type{Title} the new object, or NULL on an error */ public static function newFromID( $id, $flags = 0 ) { $fname = 'Title::newFromID'; @@ -199,6 +196,8 @@ class Title { /** * Make an array of titles from an array of IDs + * @param $ids \arrayof{\int} Array of IDs + * @return \arrayof{Title} Array of Titles */ public static function newFromIDs( $ids ) { if ( !count( $ids ) ) { @@ -217,7 +216,8 @@ class Title { /** * Make a Title object from a DB row - * @param Row $row (needs at least page_title,page_namespace) + * @param $row \type{Row} (needs at least page_title,page_namespace) + * @return \type{Title} corresponding Title */ public static function newFromRow( $row ) { $t = self::makeTitle( $row->page_namespace, $row->page_title ); @@ -237,10 +237,10 @@ class Title { * For convenience, spaces are converted to underscores so that * eg user_text fields can be used directly. * - * @param int $ns the namespace of the article - * @param string $title the unprefixed database key form - * @param string $fragment The link fragment (after the "#") - * @return Title the new object + * @param $ns \type{\int} the namespace of the article + * @param $title \type{\string} the unprefixed database key form + * @param $fragment \type{\string} The link fragment (after the "#") + * @return \type{Title} the new object */ public static function &makeTitle( $ns, $title, $fragment = '' ) { $t = new Title(); @@ -259,10 +259,10 @@ class Title { * The parameters will be checked for validity, which is a bit slower * than makeTitle() but safer for user-provided data. * - * @param int $ns the namespace of the article - * @param string $title the database key form - * @param string $fragment The link fragment (after the "#") - * @return Title the new object, or NULL on an error + * @param $ns \type{\int} the namespace of the article + * @param $title \type{\string} the database key form + * @param $fragment \type{\string} The link fragment (after the "#") + * @return \type{Title} the new object, or NULL on an error */ public static function makeTitleSafe( $ns, $title, $fragment = '' ) { $t = new Title(); @@ -276,7 +276,7 @@ class Title { /** * Create a new Title for the Main Page - * @return Title the new object + * @return \type{Title} the new object */ public static function newMainPage() { $title = Title::newFromText( wfMsgForContent( 'mainpage' ) ); @@ -291,8 +291,8 @@ class Title { * Extract a redirect destination from a string and return the * Title, or null if the text doesn't contain a valid redirect * - * @param string $text Text with possible redirect - * @return Title + * @param $text \type{String} Text with possible redirect + * @return \type{Title} The corresponding Title */ public static function newFromRedirect( $text ) { $redir = MagicWord::get( 'redirect' ); @@ -326,8 +326,8 @@ class Title { /** * Get the prefixed DB key associated with an ID - * @param int $id the page_id of the article - * @return Title an object representing the article, or NULL + * @param $id \type{\int} the page_id of the article + * @return \type{Title} an object representing the article, or NULL * if no such article was found */ public static function nameOf( $id ) { @@ -342,7 +342,7 @@ class Title { /** * Get a regex character class describing the legal characters in a link - * @return string the list of characters, not delimited + * @return \type{\string} the list of characters, not delimited */ public static function legalChars() { global $wgLegalTitleChars; @@ -353,9 +353,9 @@ class Title { * Get a string representation of a title suitable for * including in a search index * - * @param int $ns a namespace index - * @param string $title text-form main part - * @return string a stripped-down title string ready for the + * @param $ns \type{\int} a namespace index + * @param $title \type{\string} text-form main part + * @return \type{\string} a stripped-down title string ready for the * search index */ public static function indexTitle( $ns, $title ) { @@ -380,10 +380,10 @@ class Title { /* * Make a prefixed DB key from a DB key and a namespace index - * @param int $ns numerical representation of the namespace - * @param string $title the DB key form the title - * @param string $fragment The link fragment (after the "#") - * @return string the prefixed form of the title + * @param $ns \type{\int} numerical representation of the namespace + * @param $title \type{\string} the DB key form the title + * @param $fragment \type{\string} The link fragment (after the "#") + * @return \type{\string} the prefixed form of the title */ public static function makeName( $ns, $title, $fragment = '' ) { global $wgContLang; @@ -398,9 +398,9 @@ class Title { /** * Returns the URL associated with an interwiki prefix - * @param string $key the interwiki prefix (e.g. "MeatBall") - * @return the associated URL, containing "$1", which should be - * replaced by an article title + * @param $key \type{\string} the interwiki prefix (e.g. "MeatBall") + * @return \type{\string} the associated URL, containing "$1", + * which should be replaced by an article title * @static (arguably) */ public function getInterwikiLink( $key ) { @@ -449,11 +449,12 @@ class Title { } /** - * Fetch interwiki prefix data from local cache in constant database + * Fetch interwiki prefix data from local cache in constant database. * - * More logic is explained in DefaultSettings + * @note More logic is explained in DefaultSettings. * - * @return string URL of interwiki site + * @param $key \type{\string} Database key + * @return \type{\string} URL of interwiki site */ public static function getInterwikiCached( $key ) { global $wgInterwikiCache, $wgInterwikiScopes, $wgInterwikiFallbackSite; @@ -490,11 +491,12 @@ class Title { Title::$interwikiCache[wfMemcKey( 'interwiki', $key )] = $s; return $s->iw_url; } + /** * Determine whether the object refers to a page within * this project. * - * @return bool TRUE if this is an in-project interwiki link + * @return \type{\bool} TRUE if this is an in-project interwiki link * or a wikilink, FALSE otherwise */ public function isLocal() { @@ -512,7 +514,7 @@ class Title { * Determine whether the object refers to a page within * this project and is transcludable. * - * @return bool TRUE if this is transcludable + * @return \type{\bool} TRUE if this is transcludable */ public function isTrans() { if ($this->mInterwiki == '') @@ -543,27 +545,27 @@ class Title { /** Simple accessors */ /** * Get the text form (spaces not underscores) of the main part - * @return string + * @return \type{\string} Main part of the title */ public function getText() { return $this->mTextform; } /** * Get the URL-encoded form of the main part - * @return string + * @return \type{\string} Main part of the title, URL-encoded */ public function getPartialURL() { return $this->mUrlform; } /** * Get the main part with underscores - * @return string + * @return \type{\string} Main part of the title, with underscores */ public function getDBkey() { return $this->mDbkeyform; } /** - * Get the namespace index, i.e. one of the NS_xxxx constants - * @return int + * Get the namespace index, i.e.\ one of the NS_xxxx constants. + * @return \type{\int} Namespace index */ public function getNamespace() { return $this->mNamespace; } /** * Get the namespace text - * @return string + * @return \type{\string} Namespace text */ public function getNsText() { global $wgContLang, $wgCanonicalNamespaceNames; @@ -583,49 +585,47 @@ class Title { } /** * Get the DB key with the initial letter case as specified by the user + * @return \type{\string} DB key */ function getUserCaseDBKey() { return $this->mUserCaseDBKey; } /** * Get the namespace text of the subject (rather than talk) page - * @return string + * @return \type{\string} Namespace text */ public function getSubjectNsText() { global $wgContLang; return $wgContLang->getNsText( MWNamespace::getSubject( $this->mNamespace ) ); } - /** * Get the namespace text of the talk page - * @return string + * @return \type{\string} Namespace text */ public function getTalkNsText() { global $wgContLang; return( $wgContLang->getNsText( MWNamespace::getTalk( $this->mNamespace ) ) ); } - /** * Could this title have a corresponding talk page? - * @return bool + * @return \type{\bool} TRUE or FALSE */ public function canTalk() { return( MWNamespace::canTalk( $this->mNamespace ) ); } - /** * Get the interwiki prefix (or null string) - * @return string + * @return \type{\string} Interwiki prefix */ public function getInterwiki() { return $this->mInterwiki; } /** - * Get the Title fragment (i.e. the bit after the #) in text form - * @return string + * Get the Title fragment (i.e.\ the bit after the #) in text form + * @return \type{\string} Title fragment */ public function getFragment() { return $this->mFragment; } /** * Get the fragment in URL form, including the "#" character if there is one - * @return string + * @return \type{\string} Fragment in URL form */ public function getFragmentForURL() { if ( $this->mFragment == '' ) { @@ -636,13 +636,13 @@ class Title { } /** * Get the default namespace index, for when there is no namespace - * @return int + * @return \type{\int} Default namespace index */ public function getDefaultNamespace() { return $this->mDefaultNamespace; } /** * Get title for search index - * @return string a stripped-down title string ready for the + * @return \type{\string} a stripped-down title string ready for the * search index */ public function getIndexTitle() { @@ -651,7 +651,7 @@ class Title { /** * Get the prefixed database key form - * @return string the prefixed title, with underscores and + * @return \type{\string} the prefixed title, with underscores and * any interwiki and namespace prefixes */ public function getPrefixedDBkey() { @@ -663,7 +663,7 @@ class Title { /** * Get the prefixed title with spaces. * This is the form usually used for display - * @return string the prefixed title, with spaces + * @return \type{\string} the prefixed title, with spaces */ public function getPrefixedText() { if ( empty( $this->mPrefixedText ) ) { // FIXME: bad usage of empty() ? @@ -677,7 +677,7 @@ class Title { /** * Get the prefixed title with spaces, plus any fragment * (part beginning with '#') - * @return string the prefixed title, with spaces and + * @return \type{\string} the prefixed title, with spaces and * the fragment, including '#' */ public function getFullText() { @@ -690,7 +690,7 @@ class Title { /** * Get the base name, i.e. the leftmost parts before the / - * @return string Base name + * @return \type{\string} Base name */ public function getBaseText() { if( !MWNamespace::hasSubpages( $this->mNamespace ) ) { @@ -706,7 +706,7 @@ class Title { /** * Get the lowest-level subpage name, i.e. the rightmost part after / - * @return string Subpage name + * @return \type{\string} Subpage name */ public function getSubpageText() { if( !MWNamespace::hasSubpages( $this->mNamespace ) ) { @@ -718,7 +718,7 @@ class Title { /** * Get a URL-encoded form of the subpage text - * @return string URL-encoded subpage name + * @return \type{\string} URL-encoded subpage name */ public function getSubpageUrlForm() { $text = $this->getSubpageText(); @@ -729,7 +729,7 @@ class Title { /** * Get a URL-encoded title (not an actual URL) including interwiki - * @return string the URL-encoded form + * @return \type{\string} the URL-encoded form */ public function getPrefixedURL() { $s = $this->prefix( $this->mDbkeyform ); @@ -748,11 +748,11 @@ class Title { * Get a real URL referring to this title, with interwiki link and * fragment * - * @param array $query an optional query string, not used for interwiki + * @param $query \twotypes{\string,\array} an optional query string, not used for interwiki * links. Can be specified as an associative array as well, e.g., * array( 'action' => 'edit' ) (keys and values will be URL-escaped). - * @param string $variant language variant of url (for sr, zh..) - * @return string the URL + * @param $variant \type{\string} language variant of url (for sr, zh..) + * @return \type{\string} the URL */ public function getFullURL( $query = '', $variant = false ) { global $wgContLang, $wgServer, $wgRequest; @@ -796,8 +796,8 @@ class Title { * $wgArticlePath will be used. Can be specified as an associative array * as well, e.g., array( 'action' => 'edit' ) (keys and values will be * URL-escaped). - * @param string $variant language variant of url (for sr, zh..) - * @return string the URL + * @param $variant \type{\string} language variant of url (for sr, zh..) + * @return \type{\string} the URL */ public function getLocalURL( $query = '', $variant = false ) { global $wgArticlePath, $wgScript, $wgServer, $wgRequest; @@ -877,12 +877,12 @@ class Title { * there's a fragment but the prefixed text is empty, we just return a link * to the fragment. * - * @param array $query An associative array of key => value pairs for the + * @param $query \arrayof{\string} An associative array of key => value pairs for the * query string. Keys and values will be escaped. - * @param string $variant Language variant of URL (for sr, zh..). Ignored + * @param $variant \type{\string} Language variant of URL (for sr, zh..). Ignored * for external links. Default is "false" (same variant as current page, * for anonymous users). - * @return string the URL + * @return \type{\string} the URL */ public function getLinkUrl( $query = array(), $variant = false ) { if( !is_array( $query ) ) { @@ -903,8 +903,8 @@ class Title { /** * Get an HTML-escaped version of the URL form, suitable for * using in a link, without a server name or fragment - * @param string $query an optional query string - * @return string the URL + * @param $query \type{\string} an optional query string + * @return \type{\string} the URL */ public function escapeLocalURL( $query = '' ) { return htmlspecialchars( $this->getLocalURL( $query ) ); @@ -914,8 +914,8 @@ class Title { * Get an HTML-escaped version of the URL form, suitable for * using in a link, including the server name and fragment * - * @return string the URL - * @param string $query an optional query string + * @param $query \type{\string} an optional query string + * @return \type{\string} the URL */ public function escapeFullURL( $query = '' ) { return htmlspecialchars( $this->getFullURL( $query ) ); @@ -926,9 +926,9 @@ class Title { * - Used in various Squid-related code, in case we have a different * internal hostname for the server from the exposed one. * - * @param string $query an optional query string - * @param string $variant language variant of url (for sr, zh..) - * @return string the URL + * @param $query \type{\string} an optional query string + * @param $variant \type{\string} language variant of url (for sr, zh..) + * @return \type{\string} the URL */ public function getInternalURL( $query = '', $variant = false ) { global $wgInternalServer; @@ -939,7 +939,7 @@ class Title { /** * Get the edit URL for this Title - * @return string the URL, or a null string if this is an + * @return \type{\string} the URL, or a null string if this is an * interwiki link */ public function getEditURL() { @@ -952,7 +952,7 @@ class Title { /** * Get the HTML-escaped displayable text form. * Used for the title field in tags. - * @return string the text, including any prefixes + * @return \type{\string} the text, including any prefixes */ public function getEscapedText() { return htmlspecialchars( $this->getPrefixedText() ); @@ -960,15 +960,15 @@ class Title { /** * Is this Title interwiki? - * @return boolean + * @return \type{\bool} */ public function isExternal() { return ( '' != $this->mInterwiki ); } /** * Is this page "semi-protected" - the *only* protection is autoconfirm? * - * @param string Action to check (default: edit) - * @return bool + * @param @action \type{\string} Action to check (default: edit) + * @return \type{\bool} */ public function isSemiProtected( $action = 'edit' ) { if( $this->exists() ) { @@ -991,9 +991,9 @@ class Title { /** * Does the title correspond to a protected article? - * @param string $what the action the page is protected from, + * @param $what \type{\string} the action the page is protected from, * by default checks move and edit - * @return boolean + * @return \type{\bool} */ public function isProtected( $action = '' ) { global $wgRestrictionLevels, $wgRestrictionTypes; @@ -1019,7 +1019,7 @@ class Title { /** * Is $wgUser watching this page? - * @return boolean + * @return \type{\bool} */ public function userIsWatching() { global $wgUser; @@ -1043,8 +1043,8 @@ class Title { * * May provide false positives, but should never provide a false negative. * - * @param string $action action that permission needs to be checked for - * @return boolean + * @param $action \type{\string} action that permission needs to be checked for + * @return \type{\bool} */ public function quickUserCan( $action ) { return $this->userCan( $action, false ); @@ -1054,7 +1054,7 @@ class Title { * Determines if $wgUser is unable to edit this page because it has been protected * by $wgNamespaceProtection. * - * @return boolean + * @return \type{\bool} */ public function isNamespaceProtected() { global $wgNamespaceProtection, $wgUser; @@ -1069,9 +1069,9 @@ class Title { /** * Can $wgUser perform $action on this page? - * @param string $action action that permission needs to be checked for - * @param bool $doExpensiveQueries Set this to false to avoid doing unnecessary queries. - * @return boolean + * @param \type{\string} $action action that permission needs to be checked for + * @param $doExpensiveQueries \type{\bool} Set this to false to avoid doing unnecessary queries. + * @return \type{\bool} */ public function userCan( $action, $doExpensiveQueries = true ) { global $wgUser; @@ -1083,11 +1083,11 @@ class Title { * * FIXME: This *does not* check throttles (User::pingLimiter()). * - * @param string $action action that permission needs to be checked for - * @param User $user user to check - * @param bool $doExpensiveQueries Set this to false to avoid doing unnecessary queries. - * @param array $ignoreErrors Set this to a list of message keys whose corresponding errors may be ignored. - * @return array Array of arrays of the arguments to wfMsg to explain permissions problems. + * @param $action \type{\string}action that permission needs to be checked for + * @param $user \type{User} user to check + * @param $doExpensiveQueries \type{\bool} Set this to false to avoid doing unnecessary queries. + * @param $ignoreErrors \arrayof{\string} Set this to a list of message keys whose corresponding errors may be ignored. + * @return \type{\array} Array of arrays of the arguments to wfMsg to explain permissions problems. */ public function getUserPermissionsErrors( $action, $user, $doExpensiveQueries = true, $ignoreErrors = array() ) { if( !StubObject::isRealObject( $user ) ) { @@ -1173,10 +1173,10 @@ class Title { * which checks ONLY that previously checked by userCan (i.e. it leaves out * checks on wfReadOnly() and blocks) * - * @param string $action action that permission needs to be checked for - * @param User $user user to check - * @param bool $doExpensiveQueries Set this to false to avoid doing unnecessary queries. - * @return array Array of arrays of the arguments to wfMsg to explain permissions problems. + * @param $action \type{\string} action that permission needs to be checked for + * @param $user \type{User} user to check + * @param $doExpensiveQueries \type{\bool} Set this to false to avoid doing unnecessary queries. + * @return \type{\array} Array of arrays of the arguments to wfMsg to explain permissions problems. */ private function getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries = true ) { wfProfileIn( __METHOD__ ); @@ -1330,7 +1330,7 @@ class Title { /** * Is this title subject to title protection? - * @return mixed An associative array representing any existent title + * @return \type{\mixed} An associative array representing any existent title * protection, or false if there's none. */ private function getTitleProtection() { @@ -1350,6 +1350,12 @@ class Title { } } + /** + * Update the title protection status + * @param $create_perm \type{\string} Permission required for creation + * @param $reason \type{\string} Reason for protection + * @param $expiry \type{\string} Expiry timestamp + */ public function updateTitleProtection( $create_perm, $reason, $expiry ) { global $wgUser,$wgContLang; @@ -1395,7 +1401,7 @@ class Title { } /** - * Remove any title protection (due to page existing + * Remove any title protection due to page existing */ public function deleteTitleProtection() { $dbw = wfGetDB( DB_MASTER ); @@ -1406,7 +1412,7 @@ class Title { /** * Can $wgUser edit this page? - * @return boolean + * @return \type{\bool} TRUE or FALSE * @deprecated use userCan('edit') */ public function userCanEdit( $doExpensiveQueries = true ) { @@ -1415,7 +1421,7 @@ class Title { /** * Can $wgUser create this page? - * @return boolean + * @return \type{\bool} TRUE or FALSE * @deprecated use userCan('create') */ public function userCanCreate( $doExpensiveQueries = true ) { @@ -1424,7 +1430,7 @@ class Title { /** * Can $wgUser move this page? - * @return boolean + * @return \type{\bool} TRUE or FALSE * @deprecated use userCan('move') */ public function userCanMove( $doExpensiveQueries = true ) { @@ -1435,7 +1441,7 @@ class Title { * Would anybody with sufficient privileges be able to move this page? * Some pages just aren't movable. * - * @return boolean + * @return \type{\bool} TRUE or FALSE */ public function isMovable() { return MWNamespace::isMovable( $this->getNamespace() ) @@ -1444,7 +1450,7 @@ class Title { /** * Can $wgUser read this page? - * @return boolean + * @return \type{\bool} TRUE or FALSE * @todo fold these checks into userCan() */ public function userCanRead() { @@ -1521,7 +1527,7 @@ class Title { /** * Is this a talk page of some sort? - * @return bool + * @return \type{\bool} TRUE or FALSE */ public function isTalkPage() { return MWNamespace::isTalk( $this->getNamespace() ); @@ -1529,7 +1535,7 @@ class Title { /** * Is this a subpage? - * @return bool + * @return \type{\bool} TRUE or FALSE */ public function isSubpage() { return MWNamespace::hasSubpages( $this->mNamespace ) @@ -1539,7 +1545,7 @@ class Title { /** * Does this have subpages? (Warning, usually requires an extra DB query.) - * @return bool + * @return \type{\bool} TRUE or FALSE */ public function hasSubpages() { if( !MWNamespace::hasSubpages( $this->mNamespace ) ) { @@ -1567,7 +1573,7 @@ class Title { * Could this page contain custom CSS or JavaScript, based * on the title? * - * @return bool + * @return \type{\bool} TRUE or FALSE */ public function isCssOrJsPage() { return $this->mNamespace == NS_MEDIAWIKI @@ -1576,7 +1582,7 @@ class Title { /** * Is this a .css or .js subpage of a user page? - * @return bool + * @return \type{\bool} TRUE or FALSE */ public function isCssJsSubpage() { return ( NS_USER == $this->mNamespace and preg_match("/\\/.*\\.(?:css|js)$/", $this->mTextform ) ); @@ -1584,6 +1590,7 @@ class Title { /** * Is this a *valid* .css or .js subpage of a user page? * Check that the corresponding skin exists + * @return \type{\bool} TRUE or FALSE */ public function isValidCssJsSubpage() { if ( $this->isCssJsSubpage() ) { @@ -1603,14 +1610,14 @@ class Title { } /** * Is this a .css subpage of a user page? - * @return bool + * @return \type{\bool} TRUE or FALSE */ public function isCssSubpage() { return ( NS_USER == $this->mNamespace && preg_match("/\\/.*\\.css$/", $this->mTextform ) ); } /** * Is this a .js subpage of a user page? - * @return bool + * @return \type{\bool} TRUE or FALSE */ public function isJsSubpage() { return ( NS_USER == $this->mNamespace && preg_match("/\\/.*\\.js$/", $this->mTextform ) ); @@ -1619,7 +1626,7 @@ class Title { * Protect css/js subpages of user pages: can $wgUser edit * this page? * - * @return boolean + * @return \type{\bool} TRUE or FALSE * @todo XXX: this might be better using restrictions */ public function userCanEditCssJsSubpage() { @@ -1630,7 +1637,7 @@ class Title { /** * Cascading protection: Return true if cascading restrictions apply to this page, false if not. * - * @return bool If the page is subject to cascading restrictions. + * @return \type{\bool} If the page is subject to cascading restrictions. */ public function isCascadeProtected() { list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false ); @@ -1640,10 +1647,10 @@ class Title { /** * Cascading protection: Get the source of any cascading restrictions on this page. * - * @param $get_pages bool Whether or not to retrieve the actual pages that the restrictions have come from. - * @return array( mixed title array, restriction array) - * Array of the Title objects of the pages from which cascading restrictions have come, false for none, or true if such restrictions exist, but $get_pages was not set. - * The restriction array is an array of each type, each of which contains an array of unique groups + * @param $get_pages \type{\bool} Whether or not to retrieve the actual pages that the restrictions have come from. + * @return \arrayof{mixed title array, restriction array} Array of the Title objects of the pages from + * which cascading restrictions have come, false for none, or true if such restrictions exist, but $get_pages was not set. + * The restriction array is an array of each type, each of which contains an array of unique groups. */ public function getCascadeProtectionSources( $get_pages = true ) { global $wgRestrictionTypes; @@ -1739,7 +1746,7 @@ class Title { /** * Loads a string into mRestrictions array - * @param resource $res restrictions as an SQL result. + * @param $res \type{Resource} restrictions as an SQL result. */ private function loadRestrictionsFromRow( $res, $oldFashionedRestrictions = NULL ) { global $wgRestrictionTypes; @@ -1812,6 +1819,9 @@ class Title { $this->mRestrictionsLoaded = true; } + /** + * Load restrictions from the page_restrictions table + */ public function loadRestrictions( $oldFashionedRestrictions = NULL ) { if( !$this->mRestrictionsLoaded ) { if ($this->exists()) { @@ -1862,8 +1872,8 @@ class Title { /** * Accessor/initialisation for mRestrictions * - * @param string $action action that permission needs to be checked for - * @return array the array of groups allowed to edit this article + * @param $action \type{\string} action that permission needs to be checked for + * @return \arrayof{\string} the array of groups allowed to edit this article */ public function getRestrictions( $action ) { if( !$this->mRestrictionsLoaded ) { @@ -1876,7 +1886,7 @@ class Title { /** * Is there a version of this page in the deletion archive? - * @return int the number of archived revisions + * @return \type{\int} the number of archived revisions */ public function isDeleted() { $fname = 'Title::isDeleted'; @@ -1897,9 +1907,9 @@ class Title { /** * Get the article ID for this Title from the link cache, * adding it if necessary - * @param int $flags a bit field; may be GAID_FOR_UPDATE to select + * @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select * for update - * @return int the ID + * @return \type{\int} the ID */ public function getArticleID( $flags = 0 ) { $linkCache = LinkCache::singleton(); @@ -1918,8 +1928,8 @@ class Title { /** * Is this an article that is a redirect page? * Uses link cache, adding it if necessary - * @param int $flags a bit field; may be GAID_FOR_UPDATE to select for update - * @return bool + * @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select for update + * @return \type{\bool} */ public function isRedirect( $flags = 0 ) { if( !is_null($this->mRedirect) ) @@ -1938,8 +1948,8 @@ class Title { /** * What is the length of this page? * Uses link cache, adding it if necessary - * @param int $flags a bit field; may be GAID_FOR_UPDATE to select for update - * @return bool + * @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select for update + * @return \type{\bool} */ public function getLength( $flags = 0 ) { if( $this->mLength != -1 ) @@ -1957,8 +1967,8 @@ class Title { /** * What is the page_latest field for this page? - * @param int $flags a bit field; may be GAID_FOR_UPDATE to select for update - * @return int + * @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select for update + * @return \type{\int} */ public function getLatestRevID( $flags = 0 ) { if ($this->mLatestID !== false) @@ -1979,7 +1989,7 @@ class Title { * loading of the new page_id. It's also called from * Article::doDeleteArticle() * - * @param int $newid the new Article ID + * @param $newid \type{\int} the new Article ID */ public function resetArticleID( $newid ) { $linkCache = LinkCache::singleton(); @@ -1993,7 +2003,7 @@ class Title { /** * Updates page_touched for this page; called from LinksUpdate.php - * @return bool true if the update succeded + * @return \type{\bool} true if the update succeded */ public function invalidateCache() { global $wgUseFileCache; @@ -2024,8 +2034,8 @@ class Title { * Prefix some arbitrary text with the namespace or interwiki prefix * of this object * - * @param string $name the text - * @return string the prefixed text + * @param $name \type{\string} the text + * @return \type{\string} the prefixed text * @private */ /* private */ function prefix( $name ) { @@ -2047,7 +2057,7 @@ class Title { * removes illegal characters, splits off the interwiki and * namespace prefixes, sets the other forms, and canonicalizes * everything. - * @return bool true on success + * @return \type{\bool} true on success */ private function secureAndSplit() { global $wgContLang, $wgLocalInterwiki, $wgCapitalLinks; @@ -2258,7 +2268,7 @@ class Title { * are immutable. The reason this is here is because it's better than setting the * members directly, which is what Linker::formatComment was doing previously. * - * @param string $fragment text + * @param $fragment \type{\string} text * @todo clarify whether access is supposed to be public (was marked as "kind of public") */ public function setFragment( $fragment ) { @@ -2267,7 +2277,7 @@ class Title { /** * Get a Title object associated with the talk page of this article - * @return Title the object for the talk page + * @return \type{Title} the object for the talk page */ public function getTalkPage() { return Title::makeTitle( MWNamespace::getTalk( $this->getNamespace() ), $this->getDBkey() ); @@ -2277,7 +2287,7 @@ class Title { * Get a title object associated with the subject page of this * talk page * - * @return Title the object for the subject page + * @return \type{Title} the object for the subject page */ public function getSubjectPage() { return Title::makeTitle( MWNamespace::getSubject( $this->getNamespace() ), $this->getDBkey() ); @@ -2290,8 +2300,8 @@ class Title { * WARNING: do not use this function on arbitrary user-supplied titles! * On heavily-used templates it will max out the memory. * - * @param string $options may be FOR UPDATE - * @return array the Title objects linking here + * @param $options \type{\string} may be FOR UPDATE + * @return \arrayof{Title} the Title objects linking here */ public function getLinksTo( $options = '', $table = 'pagelinks', $prefix = 'pl' ) { $linkCache = LinkCache::singleton(); @@ -2331,8 +2341,8 @@ class Title { * WARNING: do not use this function on arbitrary user-supplied titles! * On heavily-used templates it will max out the memory. * - * @param string $options may be FOR UPDATE - * @return array the Title objects linking here + * @param $options \type{\string} may be FOR UPDATE + * @return \arrayof{Title} the Title objects linking here */ public function getTemplateLinksTo( $options = '' ) { return $this->getLinksTo( $options, 'templatelinks', 'tl' ); @@ -2342,8 +2352,8 @@ class Title { * Get an array of Title objects referring to non-existent articles linked from this page * * @todo check if needed (used only in SpecialBrokenRedirects.php, and should use redirect table in this case) - * @param string $options may be FOR UPDATE - * @return array the Title objects + * @param $options \type{\string} may be FOR UPDATE + * @return \arrayof{Title} the Title objects */ public function getBrokenLinksFrom( $options = '' ) { if ( $this->getArticleId() == 0 ) { @@ -2386,7 +2396,7 @@ class Title { * Get a list of URLs to purge from the Squid cache when this * page changes * - * @return array the URLs + * @return \arrayof{\string} the URLs */ public function getSquidURLs() { global $wgContLang; @@ -2408,6 +2418,9 @@ class Title { return $urls; } + /** + * Purge all applicable Squid URLs + */ public function purgeSquid() { global $wgUseSquid; if ( $wgUseSquid ) { @@ -2419,7 +2432,7 @@ class Title { /** * Move this page without authentication - * @param Title &$nt the new page Title + * @param &$nt \type{Title} the new page Title */ public function moveNoAuth( &$nt ) { return $this->moveTo( $nt, false ); @@ -2428,11 +2441,11 @@ class Title { /** * Check whether a given move operation would be valid. * Returns true if ok, or a getUserPermissionsErrors()-like array otherwise - * @param Title &$nt the new title - * @param bool $auth indicates whether $wgUser's permissions + * @param &$nt \type{Title} the new title + * @param $auth \type{\bool} indicates whether $wgUser's permissions * should be checked - * @param string $reason is the log summary of the move, used for spam checking - * @return mixed True on success, getUserPermissionsErrors()-like array on failure + * @param $reason \type{\string} is the log summary of the move, used for spam checking + * @return \type{\mixed} True on success, getUserPermissionsErrors()-like array on failure */ public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) { $errors = array(); @@ -2513,13 +2526,13 @@ class Title { /** * Move a title to a new location - * @param Title &$nt the new title - * @param bool $auth indicates whether $wgUser's permissions + * @param &$nt \type{Title} the new title + * @param $auth \type{\bool} indicates whether $wgUser's permissions * should be checked - * @param string $reason The reason for the move - * @param bool $createRedirect Whether to create a redirect from the old title to the new title. + * @param $reason \type{\string} The reason for the move + * @param $createRedirect \type{\bool} Whether to create a redirect from the old title to the new title. * Ignored if the user doesn't have the suppressredirect right. - * @return mixed true on success, getUserPermissionsErrors()-like array on failure + * @return \type{\mixed} true on success, getUserPermissionsErrors()-like array on failure */ public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true ) { $err = $this->isValidMoveOperation( $nt, $auth, $reason ); @@ -2615,10 +2628,10 @@ class Title { * Move page to a title which is at present a redirect to the * source page * - * @param Title &$nt the page to move to, which should currently + * @param &$nt \type{Title} the page to move to, which should currently * be a redirect - * @param string $reason The reason for the move - * @param bool $createRedirect Whether to leave a redirect at the old title. + * @param $reason \type{\string} The reason for the move + * @param $createRedirect \type{\bool} Whether to leave a redirect at the old title. * Ignored if the user doesn't have the suppressredirect right */ private function moveOverExistingRedirect( &$nt, $reason = '', $createRedirect = true ) { @@ -2733,9 +2746,9 @@ class Title { /** * Move page to non-existing title. - * @param Title &$nt the new Title - * @param string $reason The reason for the move - * @param bool $createRedirect Whether to create a redirect from the old title to the new title + * @param &$nt \type{Title} the new Title + * @param $reason \type{\string} The reason for the move + * @param $createRedirect \type{\bool} Whether to create a redirect from the old title to the new title * Ignored if the user doesn't have the suppressredirect right */ private function moveToNewTitle( &$nt, $reason = '', $createRedirect = true ) { @@ -2830,7 +2843,8 @@ class Title { * Checks if $this can be moved to a given Title * - Selects for update, so don't call it unless you mean business * - * @param Title &$nt the new title to check + * @param &$nt \type{Title} the new title to check + * @return \type{\bool} TRUE or FALSE */ public function isValidMoveTarget( $nt ) { @@ -2893,7 +2907,7 @@ class Title { /** * Can this title be added to a user's watchlist? * - * @return bool + * @return \type{\bool} TRUE or FALSE */ public function isWatchable() { return !$this->isExternal() @@ -2904,7 +2918,7 @@ class Title { * Get categories to which this Title belongs and return an array of * categories' names. * - * @return array an array of parents in the form: + * @return \type{\array} array an array of parents in the form: * $parent => $currentarticle */ public function getParentCategories() { @@ -2935,8 +2949,8 @@ class Title { /** * Get a tree of parent categories - * @param array $children an array with the children in the keys, to check for circular refs - * @return array + * @param $children \type{\array} an array with the children in the keys, to check for circular refs + * @return \type{\array} Tree of parent categories */ public function getParentCategoryTree( $children = array() ) { $stack = array(); @@ -2965,7 +2979,7 @@ class Title { * Get an associative array for selecting this title from * the "page" table * - * @return array + * @return \type{\array} Selection array */ public function pageCond() { return array( 'page_namespace' => $this->mNamespace, 'page_title' => $this->mDbkeyform ); @@ -2974,9 +2988,9 @@ class Title { /** * Get the revision ID of the previous revision * - * @param integer $revId Revision ID. Get the revision that was before this one. - * @param integer $flags, GAID_FOR_UPDATE - * @return integer $oldrevision|false + * @param $revId \type{\int} Revision ID. Get the revision that was before this one. + * @param $flags \type{\int} GAID_FOR_UPDATE + * @return \twotypes{\int,\bool} Old revision ID, or FALSE if none exists */ public function getPreviousRevisionID( $revId, $flags=0 ) { $db = ($flags & GAID_FOR_UPDATE) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE ); @@ -2993,9 +3007,9 @@ class Title { /** * Get the revision ID of the next revision * - * @param integer $revId Revision ID. Get the revision that was after this one. - * @param integer $flags, GAID_FOR_UPDATE - * @return integer $oldrevision|false + * @param $revId \type{\int} Revision ID. Get the revision that was after this one. + * @param $flags \type{\int} GAID_FOR_UPDATE + * @return \twotypes{\int,\bool} Next revision ID, or FALSE if none exists */ public function getNextRevisionID( $revId, $flags=0 ) { $db = ($flags & GAID_FOR_UPDATE) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE ); @@ -3013,9 +3027,9 @@ class Title { * Get the number of revisions between the given revision IDs. * Used for diffs and other things that really need it. * - * @param integer $old Revision ID. - * @param integer $new Revision ID. - * @return integer Number of revisions between these IDs. + * @param $old \type{\int} Revision ID. + * @param $new \type{\int} Revision ID. + * @return \type{\int} Number of revisions between these IDs. */ public function countRevisionsBetween( $old, $new ) { $dbr = wfGetDB( DB_SLAVE ); @@ -3030,8 +3044,8 @@ class Title { /** * Compare with another title. * - * @param Title $title - * @return bool + * @param \type{Title} $title + * @return \type{\bool} TRUE or FALSE */ public function equals( Title $title ) { // Note: === is necessary for proper matching of number-like titles. @@ -3054,7 +3068,7 @@ class Title { /** * Return a string representation of this title * - * @return string + * @return \type{\string} String representation of this title */ public function __toString() { return $this->getPrefixedText(); @@ -3062,7 +3076,7 @@ class Title { /** * Check if page exists - * @return bool + * @return \type{\bool} TRUE or FALSE */ public function exists() { return $this->getArticleId() != 0; @@ -3072,7 +3086,7 @@ class Title { * Do we know that this title definitely exists, or should we otherwise * consider that it exists? * - * @return bool + * @return \type{\bool} TRUE or FALSE */ public function isAlwaysKnown() { // If the page is form Mediawiki:message/lang, calling wfMsgWeirdKey causes @@ -3103,6 +3117,7 @@ class Title { /** * Get the last touched timestamp + * @return \type{\string} Last touched timestamp */ public function getTouched() { $dbr = wfGetDB( DB_SLAVE ); @@ -3115,6 +3130,10 @@ class Title { return $touched; } + /** + * Get the trackback URL for this page + * @return \type{\string} Trackback URL + */ public function trackbackURL() { global $wgTitle, $wgScriptPath, $wgServer; @@ -3122,6 +3141,10 @@ class Title { . htmlspecialchars(urlencode($wgTitle->getPrefixedDBkey())); } + /** + * Get the trackback RDF for this page + * @return \type{\string} Trackback RDF + */ public function trackbackRDF() { $url = htmlspecialchars($this->getFullURL()); $title = htmlspecialchars($this->getText()); @@ -3147,7 +3170,7 @@ class Title { /** * Generate strings used for xml 'id' names in monobook tabs - * @return string + * @return \type{\string} XML 'id' name */ public function getNamespaceKey() { global $wgContLang; @@ -3187,7 +3210,7 @@ class Title { /** * Returns true if this title resolves to the named special page - * @param string $name The special page name + * @param $name \type{\string} The special page name */ public function isSpecial( $name ) { if ( $this->getNamespace() == NS_SPECIAL ) { @@ -3201,7 +3224,7 @@ class Title { /** * If the Title refers to a special page alias which is not the local default, - * returns a new Title which points to the local default. Otherwise, returns $this. + * @return \type{Title} A new Title which points to the local default. Otherwise, returns $this. */ public function fixSpecialName() { if ( $this->getNamespace() == NS_SPECIAL ) { @@ -3221,12 +3244,19 @@ class Title { * In other words, is this a content page, for the purposes of calculating * statistics, etc? * - * @return bool + * @return \type{\bool} TRUE or FALSE */ public function isContentPage() { return MWNamespace::isContent( $this->getNamespace() ); } + /** + * Get all extant redirects to this Title + * + * @param $ns \twotypes{\int,\null} Single namespace to consider; + * NULL to consider all namespaces + * @return \arrayof{Title} Redirects to this title + */ public function getRedirectsHere( $ns = null ) { $redirs = array(); diff --git a/maintenance/Doxyfile b/maintenance/Doxyfile index e1df2bee8d..ebff014942 100644 --- a/maintenance/Doxyfile +++ b/maintenance/Doxyfile @@ -16,7 +16,7 @@ PROJECT_NAME = MediaWiki PROJECT_NUMBER = {{CURRENT_VERSION}} OUTPUT_DIRECTORY = {{OUTPUT_DIRECTORY}} -CREATE_SUBDIRS = YES +CREATE_SUBDIRS = NO OUTPUT_LANGUAGE = English BRIEF_MEMBER_DESC = YES REPEAT_BRIEF = YES @@ -290,4 +290,5 @@ ALIASES = "type{1}=\1:" \ "int=\integer" \ "string=String" \ "str=\string" \ + "array=Array" \ "mixed=Mixed" -- 2.20.1