From d8e90514ab1a80545fad0dbe420a61480b177104 Mon Sep 17 00:00:00 2001 From: =?utf8?q?=C3=86var=20Arnfj=C3=B6r=C3=B0=20Bjarmason?= Date: Sat, 7 Jan 2006 12:48:44 +0000 Subject: [PATCH] * Documentation: @private => @access private --- includes/GlobalFunctions.php | 2 +- includes/LinksUpdate.php | 26 +++++++++++------------ includes/LoadBalancer.php | 6 +++--- includes/MagicWord.php | 4 ++-- includes/Metadata.php | 40 ++++++++++++++++++------------------ includes/MimeMagic.php | 4 ++-- includes/Namespace.php | 2 +- includes/OutputPage.php | 2 +- includes/Parser.php | 2 +- includes/SkinTemplate.php | 2 +- includes/SpecialLog.php | 26 +++++++++++------------ includes/WatchedItem.php | 2 +- includes/WebRequest.php | 8 ++++---- skins/CologneBlue.php | 2 +- 14 files changed, 64 insertions(+), 64 deletions(-) diff --git a/includes/GlobalFunctions.php b/includes/GlobalFunctions.php index 23d177701f..0ea76e5955 100644 --- a/includes/GlobalFunctions.php +++ b/includes/GlobalFunctions.php @@ -1468,7 +1468,7 @@ function &HTMLnamespaceselector($selected = '', $allnamespaces = null) { /** Global singleton instance of MimeMagic. This is initialized on demand, * please always use the wfGetMimeMagic() function to get the instance. * -* @private +* @access private */ $wgMimeMagic= NULL; diff --git a/includes/LinksUpdate.php b/includes/LinksUpdate.php index b15f684281..bfb5f19c86 100644 --- a/includes/LinksUpdate.php +++ b/includes/LinksUpdate.php @@ -161,7 +161,7 @@ class LinksUpdate { /** * Update a table by doing a delete query then an insert query - * @private + * @access private */ function incrTableUpdate( $table, $prefix, $deletions, $insertions ) { $fname = 'LinksUpdate::incrTableUpdate'; @@ -192,7 +192,7 @@ class LinksUpdate { /** * Get an array of pagelinks insertions for passing to the DB * Skips the titles specified by the 2-D array $existing - * @private + * @access private */ function getLinkInsertions( $existing = array() ) { $arr = array(); @@ -213,7 +213,7 @@ class LinksUpdate { /** * Get an array of template insertions. Like getLinkInsertions() - * @private + * @access private */ function getTemplateInsertions( $existing = array() ) { $arr = array(); @@ -233,7 +233,7 @@ class LinksUpdate { /** * Get an array of image insertions * Skips the names specified in $existing - * @private + * @access private */ function getImageInsertions( $existing = array() ) { $arr = array(); @@ -251,7 +251,7 @@ class LinksUpdate { * Get an array of category insertions * @param array $existing Array mapping existing category names to sort keys. If both * match a link in $this, the link will be omitted from the output - * @private + * @access private */ function getCategoryInsertions( $existing = array() ) { $diffs = array_diff_assoc( $this->mCategories, $existing ); @@ -269,7 +269,7 @@ class LinksUpdate { /** * Given an array of existing links, returns those links which are not in $this * and thus should be deleted. - * @private + * @access private */ function getLinkDeletions( $existing ) { $del = array(); @@ -286,7 +286,7 @@ class LinksUpdate { /** * Given an array of existing templates, returns those templates which are not in $this * and thus should be deleted. - * @private + * @access private */ function getTemplateDeletions( $existing ) { $del = array(); @@ -303,7 +303,7 @@ class LinksUpdate { /** * Given an array of existing images, returns those images which are not in $this * and thus should be deleted. - * @private + * @access private */ function getImageDeletions( $existing ) { return array_diff_key( $existing, $this->mImages ); @@ -312,7 +312,7 @@ class LinksUpdate { /** * Given an array of existing categories, returns those categories which are not in $this * and thus should be deleted. - * @private + * @access private */ function getCategoryDeletions( $existing ) { return array_diff_assoc( $existing, $this->mCategories ); @@ -320,7 +320,7 @@ class LinksUpdate { /** * Get an array of existing links, as a 2-D array - * @private + * @access private */ function getExistingLinks() { $fname = 'LinksUpdate::getExistingLinks'; @@ -338,7 +338,7 @@ class LinksUpdate { /** * Get an array of existing templates, as a 2-D array - * @private + * @access private */ function getExistingTemplates() { $fname = 'LinksUpdate::getExistingTemplates'; @@ -356,7 +356,7 @@ class LinksUpdate { /** * Get an array of existing images, image names in the keys - * @private + * @access private */ function getExistingImages() { $fname = 'LinksUpdate::getExistingImages'; @@ -371,7 +371,7 @@ class LinksUpdate { /** * Get an array of existing categories, with the name in the key and sort key in the value. - * @private + * @access private */ function getExistingCategories() { $fname = 'LinksUpdate::getExistingCategories'; diff --git a/includes/LoadBalancer.php b/includes/LoadBalancer.php index 40b461308b..13383a620c 100644 --- a/includes/LoadBalancer.php +++ b/includes/LoadBalancer.php @@ -378,7 +378,7 @@ class LoadBalancer { * Open a connection to the server given by the specified index * Index must be an actual index into the array * Returns success - * @private + * @access private */ function openConnection( $i, $fail = false ) { $fname = 'LoadBalancer::openConnection'; @@ -405,7 +405,7 @@ class LoadBalancer { /** * Test if the specified index represents an open connection - * @private + * @access private */ function isOpen( $index ) { if( !is_integer( $index ) ) { @@ -422,7 +422,7 @@ class LoadBalancer { /** * Really opens a connection - * @private + * @access private */ function reallyOpenConnection( &$server ) { if( !is_array( $server ) ) { diff --git a/includes/MagicWord.php b/includes/MagicWord.php index 603ab8c049..6af049b3ec 100644 --- a/includes/MagicWord.php +++ b/includes/MagicWord.php @@ -164,7 +164,7 @@ class MagicWord { /** * Preliminary initialisation - * @private + * @access private */ function initRegex() { #$variableClass = Title::legalChars(); @@ -356,7 +356,7 @@ class MagicWord { /** * Used in matchAndRemove() - * @private + * @access private **/ function pregRemoveAndRecord( $match ) { global $wgMagicFound; diff --git a/includes/Metadata.php b/includes/Metadata.php index 333ff9a7a5..3a939d1713 100644 --- a/includes/Metadata.php +++ b/includes/Metadata.php @@ -68,7 +68,7 @@ function wfCreativeCommonsRdf($article) { } /** - * @private + * @access private */ function rdfSetup() { global $wgOut, $_SERVER; @@ -87,7 +87,7 @@ function rdfSetup() { } /** - * @private + * @access private */ function dcPrologue($url) { global $wgOutputEncoding; @@ -104,7 +104,7 @@ function dcPrologue($url) { } /** - * @private + * @access private */ function dcEpilogue() { print " @@ -114,7 +114,7 @@ function dcEpilogue() { } /** - * @private + * @access private */ function dcBasics($article) { global $wgContLanguageCode, $wgSitename; @@ -146,7 +146,7 @@ function dcBasics($article) { } /** - * @private + * @access private */ function ccPrologue() { global $wgOutputEncoding; @@ -160,7 +160,7 @@ function ccPrologue() { } /** - * @private + * @access private */ function ccSubPrologue($type, $url) { $url = htmlspecialchars( $url ); @@ -168,14 +168,14 @@ function ccSubPrologue($type, $url) { } /** - * @private + * @access private */ function ccSubEpilogue($type) { echo " \n"; } /** - * @private + * @access private */ function ccLicense($terms) { @@ -202,21 +202,21 @@ function ccLicense($terms) { } /** - * @private + * @access private */ function ccTerm($term, $name) { print " \n"; } /** - * @private + * @access private */ function ccEpilogue() { echo "\n"; } /** - * @private + * @access private */ function dcElement($name, $value) { $value = htmlspecialchars( $value ); @@ -224,7 +224,7 @@ function dcElement($name, $value) { } /** - * @private + * @access private */ function dcDate($timestamp) { return substr($timestamp, 0, 4) . '-' @@ -233,14 +233,14 @@ function dcDate($timestamp) { } /** - * @private + * @access private */ function dcReallyFullUrl($title) { return $title->getFullURL(); } /** - * @private + * @access private */ function dcPageOrString($name, $page, $str) { $nt = Title::newFromText($page); @@ -253,14 +253,14 @@ function dcPageOrString($name, $page, $str) { } /** - * @private + * @access private */ function dcPage($name, $title) { dcUrl($name, dcReallyFullUrl($title)); } /** - * @private + * @access private */ function dcUrl($name, $url) { $url = htmlspecialchars( $url ); @@ -268,7 +268,7 @@ function dcUrl($name, $url) { } /** - * @private + * @access private */ function dcPerson($name, $id, $user_name='', $user_real_name='') { global $wgContLang; @@ -289,7 +289,7 @@ function dcPerson($name, $id, $user_name='', $user_real_name='') { /** * Takes an arg, for future enhancement with different rights for * different pages. - * @private + * @access private */ function dcRights($article) { @@ -307,7 +307,7 @@ function dcRights($article) { } /** - * @private + * @access private */ function ccGetTerms($url) { global $wgLicenseTerms; @@ -321,7 +321,7 @@ function ccGetTerms($url) { } /** - * @private + * @access private */ function getKnownLicenses() { diff --git a/includes/MimeMagic.php b/includes/MimeMagic.php index 31f57d0e7d..66b93b1fad 100644 --- a/includes/MimeMagic.php +++ b/includes/MimeMagic.php @@ -457,7 +457,7 @@ class MimeMagic { * @param bool $useExt switch for allowing to use the file extension to guess the mime type. true by default. * * @return string the mime type of $file - * @private + * @access private */ function detectMimeType( $file, $useExt=true ) { $fname = 'MimeMagic::detectMimeType'; @@ -655,7 +655,7 @@ class MimeMagic { * distinguish them from mime types. * * This funktion relies on the mapping defined by $this->mMediaTypes - * @private + * @access private */ function findMediaType($extMime) { diff --git a/includes/Namespace.php b/includes/Namespace.php index e366c0a2dd..bde2334c6c 100644 --- a/includes/Namespace.php +++ b/includes/Namespace.php @@ -8,7 +8,7 @@ if ( ! defined( 'MEDIAWIKI' ) ) /** * Definitions of the NS_ constants are in Defines.php - * @private + * @access private */ $wgCanonicalNamespaceNames = array( NS_MEDIA => 'Media', diff --git a/includes/OutputPage.php b/includes/OutputPage.php index 41c1c38f1d..e0a7df2301 100644 --- a/includes/OutputPage.php +++ b/includes/OutputPage.php @@ -888,7 +888,7 @@ class OutputPage { } /** - * @private + * @access private * @return string */ function headElement() { diff --git a/includes/Parser.php b/includes/Parser.php index e03b348ce9..74e92bab07 100644 --- a/includes/Parser.php +++ b/includes/Parser.php @@ -3895,7 +3895,7 @@ function wfNumberOfFiles() { /** * Get various statistics from the database - * @private + * @access private */ function wfLoadSiteStats() { global $wgNumberOfArticles, $wgTotalViews, $wgTotalEdits; diff --git a/includes/SkinTemplate.php b/includes/SkinTemplate.php index 850f66dcf2..3604ea5f68 100644 --- a/includes/SkinTemplate.php +++ b/includes/SkinTemplate.php @@ -862,7 +862,7 @@ class SkinTemplate extends Skin { /** * Generate strings used for xml 'id' names * @return string - * @private + * @access private */ function getNameSpaceKey () { switch ($this->mTitle->getNamespace()) { diff --git a/includes/SpecialLog.php b/includes/SpecialLog.php index 1b6c98e81f..52b388b662 100644 --- a/includes/SpecialLog.php +++ b/includes/SpecialLog.php @@ -56,7 +56,7 @@ class LogReader { /** * Basic setup and applies the limiting factors from the WebRequest object. * @param WebRequest $request - * @private + * @access private */ function setupQuery( $request ) { $page = $this->db->tableName( 'page' ); @@ -76,7 +76,7 @@ class LogReader { /** * Set the log reader to return only entries of the given type. * @param string $type A log type ('upload', 'delete', etc) - * @private + * @access private */ function limitType( $type ) { if( empty( $type ) ) { @@ -90,7 +90,7 @@ class LogReader { /** * Set the log reader to return only entries by the given user. * @param string $name (In)valid user name - * @private + * @access private */ function limitUser( $name ) { if ( $name == '' ) @@ -108,7 +108,7 @@ class LogReader { * Set the log reader to return only entries affecting the given page. * (For the block and rights logs, this is a user page.) * @param string $page Title name as text - * @private + * @access private */ function limitTitle( $page ) { $title = Title::newFromText( $page ); @@ -125,7 +125,7 @@ class LogReader { * Set the log reader to return only entries in a given time range. * @param string $time Timestamp of one endpoint * @param string $direction either ">=" or "<=" operators - * @private + * @access private */ function limitTime( $time, $direction ) { # Direction should be a comparison operator @@ -139,7 +139,7 @@ class LogReader { /** * Build an SQL query from all the set parameters. * @return string the SQL query - * @private + * @access private */ function getQuery() { $logging = $this->db->tableName( "logging" ); @@ -294,7 +294,7 @@ class LogViewer { /** * @param Object $s a single row from the result set * @return string Formatted HTML list item - * @private + * @access private */ function logLine( $s ) { global $wgLang; @@ -334,7 +334,7 @@ class LogViewer { /** * @param OutputPage &$out where to send output - * @private + * @access private */ function showHeader( &$out ) { $type = $this->reader->queryType(); @@ -346,7 +346,7 @@ class LogViewer { /** * @param OutputPage &$out where to send output - * @private + * @access private */ function showOptions( &$out ) { global $wgScript; @@ -364,7 +364,7 @@ class LogViewer { /** * @return string Formatted HTML - * @private + * @access private */ function getTypeMenu() { $out = "