BagOStuff.php

Go to the documentation of this file.

<?php
abstract class BagOStuff {
        private $debugMode = false;

        public function setDebug( $bool ) {
                $this->debugMode = $bool;
        }

        /* *** THE GUTS OF THE OPERATION *** */
        /* Override these with functional things in subclasses */

        abstract public function get( $key );

        abstract public function set( $key, $value, $exptime = 0 );

        abstract public function delete( $key, $time = 0 );

        public function lock( $key, $timeout = 0 ) {
                /* stub */
                return true;
        }

        public function unlock( $key ) {
                /* stub */
                return true;
        }

        public function keys() {
                /* stub */
                return array();
        }

        public function deleteObjectsExpiringBefore( $date, $progressCallback = false ) {
                // stub
                return false;
        }

        /* *** Emulated functions *** */

        public function add( $key, $value, $exptime = 0 ) {
                if ( !$this->get( $key ) ) {
                        $this->set( $key, $value, $exptime );

                        return true;
                }
        }

        public function replace( $key, $value, $exptime = 0 ) {
                if ( $this->get( $key ) !== false ) {
                        $this->set( $key, $value, $exptime );
                }
        }

        public function incr( $key, $value = 1 ) {
                if ( !$this->lock( $key ) ) {
                        return null;
                }

                $value = intval( $value );

                if ( ( $n = $this->get( $key ) ) !== false ) {
                        $n += $value;
                        $this->set( $key, $n ); // exptime?
                }
                $this->unlock( $key );

                return $n;
        }

        public function decr( $key, $value = 1 ) {
                return $this->incr( $key, - $value );
        }

        public function debug( $text ) {
                if ( $this->debugMode ) {
                        $class = get_class( $this );
                        wfDebug( "$class debug: $text\n" );
                }
        }

        protected function convertExpiry( $exptime ) {
                if ( ( $exptime != 0 ) && ( $exptime < 86400 * 3650 /* 10 years */ ) ) {
                        return time() + $exptime;
                } else {
                        return $exptime;
                }
        }
}