* Documentation: @private => @access private
authorÆvar Arnfjörð Bjarmason <avar@users.mediawiki.org>
Sat, 7 Jan 2006 12:48:44 +0000 (12:48 +0000)
committerÆvar Arnfjörð Bjarmason <avar@users.mediawiki.org>
Sat, 7 Jan 2006 12:48:44 +0000 (12:48 +0000)
14 files changed:
includes/GlobalFunctions.php
includes/LinksUpdate.php
includes/LoadBalancer.php
includes/MagicWord.php
includes/Metadata.php
includes/MimeMagic.php
includes/Namespace.php
includes/OutputPage.php
includes/Parser.php
includes/SkinTemplate.php
includes/SpecialLog.php
includes/WatchedItem.php
includes/WebRequest.php
skins/CologneBlue.php

index 23d1777..0ea76e5 100644 (file)
@@ -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;
 
index b15f684..bfb5f19 100644 (file)
@@ -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';
index 40b4613..13383a6 100644 (file)
@@ -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 ) ) {
index 603ab8c..6af049b 100644 (file)
@@ -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;
index 333ff9a..3a939d1 100644 (file)
@@ -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 "  </cc:{$type}>\n";
 }
 
 /**
- * @private
+ * @access private
  */
 function ccLicense($terms) {
 
@@ -202,21 +202,21 @@ function ccLicense($terms) {
 }
 
 /**
- * @private
+ * @access private
  */
 function ccTerm($term, $name) {
        print "    <cc:{$term} rdf:resource=\"http://web.resource.org/cc/{$name}\" />\n";
 }
 
 /**
- * @private
+ * @access private
  */
 function ccEpilogue() {
        echo "</rdf:RDF>\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() {
 
index 31f57d0..66b93b1 100644 (file)
@@ -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) {
                
index e366c0a..bde2334 100644 (file)
@@ -8,7 +8,7 @@ if ( ! defined( 'MEDIAWIKI' ) )
 
 /**
  * Definitions of the NS_ constants are in Defines.php
- * @private
+ * @access private
  */
 $wgCanonicalNamespaceNames = array(
        NS_MEDIA            => 'Media',
index 41c1c38..e0a7df2 100644 (file)
@@ -888,7 +888,7 @@ class OutputPage {
        }
 
        /**
-        * @private
+        * @access private
         * @return string
         */
        function headElement() {
index e03b348..74e92ba 100644 (file)
@@ -3895,7 +3895,7 @@ function wfNumberOfFiles() {
 
 /**
  * Get various statistics from the database
- * @private
+ * @access private
  */
 function wfLoadSiteStats() {
        global $wgNumberOfArticles, $wgTotalViews, $wgTotalEdits;
index 850f66d..3604ea5 100644 (file)
@@ -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()) {
index 1b6c98e..52b388b 100644 (file)
@@ -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 = "<select name='type'>\n";
@@ -379,7 +379,7 @@ class LogViewer {
 
        /**
         * @return string Formatted HTML
-        * @private
+        * @access private
         */
        function getUserInput() {
                $user = htmlspecialchars( $this->reader->queryUser() );
@@ -388,7 +388,7 @@ class LogViewer {
 
        /**
         * @return string Formatted HTML
-        * @private
+        * @access private
         */
        function getTitleInput() {
                $title = htmlspecialchars( $this->reader->queryTitle() );
@@ -397,7 +397,7 @@ class LogViewer {
 
        /**
         * @param OutputPage &$out where to send output
-        * @private
+        * @access private
         */
        function showPrevNext( &$out ) {
                global $wgContLang,$wgRequest;
index a2d3414..89c0f2f 100644 (file)
@@ -14,7 +14,7 @@ class WatchedItem {
        /**
         * Create a WatchedItem object with the given user and title
         * @todo document
-        * @private
+        * @access private
         */
        function &fromUserTitle( &$user, &$title ) {
                $wl = new WatchedItem;
index cd21edc..cbb7fd2 100644 (file)
@@ -50,7 +50,7 @@ class WebRequest {
         * used for undoing the evil that is magic_quotes_gpc.
         * @param array &$arr will be modified
         * @return array the original array
-        * @private
+        * @access private
         */
        function &fix_magic_quotes( &$arr ) {
                foreach( $arr as $key => $val ) {
@@ -68,7 +68,7 @@ class WebRequest {
         * through fix_magic_quotes to strip out the stupid slashes.
         * WARNING: This should only be done once! Running a second
         * time could damage the values.
-        * @private
+        * @access private
         */
        function checkMagicQuotes() {
                if ( get_magic_quotes_gpc() ) {
@@ -85,7 +85,7 @@ class WebRequest {
         * Recursively normalizes UTF-8 strings in the given array.
         * @param array $data string or array
         * @return cleaned-up version of the given
-        * @private
+        * @access private
         */
        function normalizeUnicode( $data ) {
                if( is_array( $data ) ) {
@@ -105,7 +105,7 @@ class WebRequest {
         * @param string $name
         * @param mixed $default
         * @return mixed
-        * @private
+        * @access private
         */
        function getGPCVal( $arr, $name, $default ) {
                if( isset( $arr[$name] ) ) {
index f2d2558..f91586c 100644 (file)
@@ -172,7 +172,7 @@ class SkinCologneBlue extends Skin {
 
        /**
         * Compute the sidebar
-        * @private
+        * @access private
         */
        function quickBar()
        {