MediaWiki 1.17.0

[autoinstallsdev/mediawiki.git] / includes / CacheDependency.php

diff --git a/includes/CacheDependency.php b/includes/CacheDependency.php
index b050c46d95cdfa145539002bf587c4afb9eda269..74ca2864e27d561b83b05b69b8d0809b23616e05 100644 (file)
--- a/includes/CacheDependency.php
+++ b/includes/CacheDependency.php
@@ -1,26 +1,28 @@
 <?php
-
 /**
  * This class stores an arbitrary value along with its dependencies.
- * Users should typically only use DependencyWrapper::getFromCache(), rather
- * than instantiating one of these objects directly.
+ * Users should typically only use DependencyWrapper::getValueFromCache(),
+ * rather than instantiating one of these objects directly.
  * @ingroup Cache
  */
+
 class DependencyWrapper {
        var $value;
        var $deps;
 
        /**
         * Create an instance.
-        * @param mixed $value The user-supplied value
-        * @param mixed $deps A dependency or dependency array. All dependencies
+        * @param $value Mixed: the user-supplied value
+        * @param $deps Mixed: a dependency or dependency array. All dependencies
         *        must be objects implementing CacheDependency.
         */
        function __construct( $value = false, $deps = array() ) {
                $this->value = $value;
+
                if ( !is_array( $deps ) ) {
                        $deps = array( $deps );
                }
+
                $this->deps = $deps;
        }
 
@@ -33,6 +35,7 @@ class DependencyWrapper {
                                return true;
                        }
                }
+
                return false;
        }
 
@@ -66,12 +69,12 @@ class DependencyWrapper {
         * it will be generated with the callback function (if present), and the newly
         * calculated value will be stored to the cache in a wrapper.
         *
-        * @param object $cache A cache object such as $wgMemc
-        * @param string $key The cache key
-        * @param integer $expiry The expiry timestamp or interval in seconds
-        * @param mixed $callback The callback for generating the value, or false
-        * @param array $callbackParams The function parameters for the callback
-        * @param array $deps The dependencies to store on a cache miss. Note: these
+        * @param $cache Object: a cache object such as $wgMemc
+        * @param $key String: the cache key
+        * @param $expiry Integer: the expiry timestamp or interval in seconds
+        * @param $callback Mixed: the callback for generating the value, or false
+        * @param $callbackParams Array: the function parameters for the callback
+        * @param $deps Array: the dependencies to store on a cache miss. Note: these
         *    are not the dependencies used on a cache hit! Cache hits use the stored
         *    dependency array.
         *
@@ -82,6 +85,7 @@ class DependencyWrapper {
                $callbackParams = array(), $deps = array() )
        {
                $obj = $cache->get( $key );
+
                if ( is_object( $obj ) && $obj instanceof DependencyWrapper && !$obj->isExpired() ) {
                        $value = $obj->value;
                } elseif ( $callback ) {
@@ -92,6 +96,7 @@ class DependencyWrapper {
                } else {
                        $value = null;
                }
+
                return $value;
        }
 }
@@ -108,7 +113,7 @@ abstract class CacheDependency {
        /**
         * Hook to perform any expensive pre-serialize loading of dependency values.
         */
-       function loadDependencyValues() {}
+       function loadDependencyValues() { }
 }
 
 /**
@@ -120,8 +125,8 @@ class FileDependency extends CacheDependency {
        /**
         * Create a file dependency
         *
-        * @param string $filename The name of the file, preferably fully qualified
-        * @param mixed $timestamp The unix last modified timestamp, or false if the
+        * @param $filename String: the name of the file, preferably fully qualified
+        * @param $timestamp Mixed: the unix last modified timestamp, or false if the
         *        file does not exist. If omitted, the timestamp will be loaded from
         *        the file.
         *
@@ -134,6 +139,11 @@ class FileDependency extends CacheDependency {
                $this->timestamp = $timestamp;
        }
 
+       function __sleep() {
+               $this->loadDependencyValues();
+               return array( 'filename', 'timestamp' );
+       }
+
        function loadDependencyValues() {
                if ( is_null( $this->timestamp ) ) {
                        if ( !file_exists( $this->filename ) ) {
@@ -180,7 +190,7 @@ class TitleDependency extends CacheDependency {
 
        /**
         * Construct a title dependency
-        * @param Title $title
+        * @param $title Title
         */
        function __construct( Title $title ) {
                $this->titleObj = $title;
@@ -203,11 +213,13 @@ class TitleDependency extends CacheDependency {
                if ( !isset( $this->titleObj ) ) {
                        $this->titleObj = Title::makeTitle( $this->ns, $this->dbk );
                }
+
                return $this->titleObj;
        }
 
        function isExpired() {
                $touched = $this->getTitle()->getTouched();
+
                if ( $this->touched === false ) {
                        if ( $touched === false ) {
                                # Still missing
@@ -246,9 +258,11 @@ class TitleListDependency extends CacheDependency {
        function calculateTimestamps() {
                # Initialise values to false
                $timestamps = array();
+
                foreach ( $this->getLinkBatch()->data as $ns => $dbks ) {
                        if ( count( $dbks ) > 0 ) {
                                $timestamps[$ns] = array();
+
                                foreach ( $dbks as $dbk => $value ) {
                                        $timestamps[$ns][$dbk] = false;
                                }
@@ -259,13 +273,18 @@ class TitleListDependency extends CacheDependency {
                if ( count( $timestamps ) ) {
                        $dbr = wfGetDB( DB_SLAVE );
                        $where = $this->getLinkBatch()->constructSet( 'page', $dbr );
-                       $res = $dbr->select( 'page',
+                       $res = $dbr->select(
+                               'page',
                                array( 'page_namespace', 'page_title', 'page_touched' ),
-                               $where, __METHOD__ );
-                       while ( $row = $dbr->fetchObject( $res ) ) {
+                               $where,
+                               __METHOD__
+                       );
+
+                       foreach ( $res as $row ) {
                                $timestamps[$row->page_namespace][$row->page_title] = $row->page_touched;
                        }
                }
+
                return $timestamps;
        }
 
@@ -278,7 +297,7 @@ class TitleListDependency extends CacheDependency {
        }
 
        function getLinkBatch() {
-               if ( !isset( $this->linkBatch ) ){
+               if ( !isset( $this->linkBatch ) ) {
                        $this->linkBatch = new LinkBatch;
                        $this->linkBatch->setArray( $this->timestamps );
                }
@@ -287,9 +306,11 @@ class TitleListDependency extends CacheDependency {
 
        function isExpired() {
                $newTimestamps = $this->calculateTimestamps();
+
                foreach ( $this->timestamps as $ns => $dbks ) {
                        foreach ( $dbks as $dbk => $oldTimestamp ) {
                                $newTimestamp = $newTimestamps[$ns][$dbk];
+
                                if ( $oldTimestamp === false ) {
                                        if ( $newTimestamp === false ) {
                                                # Still missing
@@ -308,6 +329,7 @@ class TitleListDependency extends CacheDependency {
                                }
                        }
                }
+
                return false;
        }
 }