wiki.techinc.nl/includes/objectcache/EmptyBagOStuff.php
Tyler Anthony Romeo 4dcc7961df Fixed @param tags to conform with Doxygen format.
Doxygen expects parameter types to come before the
parameter name in @param tags. Used a quick regex
to switch everything around where possible. This
only fixes cases where a primitve variable (or a
primitive followed by other types) is the variable
type. Other cases will need to be fixed manually.

Change-Id: Ic59fd20856eb0489d70f3469a56ebce0efb3db13
2013-03-11 13:15:01 -04:00

87 lines
2.1 KiB
PHP

<?php
/**
* Dummy object caching.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Cache
*/
/**
* A BagOStuff object with no objects in it. Used to provide a no-op object to calling code.
*
* @ingroup Cache
*/
class EmptyBagOStuff extends BagOStuff {
/**
* @param $key string
* @param $casToken[optional] mixed
* @return bool
*/
function get( $key, &$casToken = null ) {
return false;
}
/**
* @param $key string
* @param $value mixed
* @param $exp int
* @return bool
*/
function set( $key, $value, $exp = 0 ) {
return true;
}
/**
* @param $casToken mixed
* @param $key string
* @param $value mixed
* @param $exp int
* @return bool
*/
function cas( $casToken, $key, $value, $exp = 0 ) {
return true;
}
/**
* @param $key string
* @param $time int
* @return bool
*/
function delete( $key, $time = 0 ) {
return true;
}
/**
* @param $key string
* @param $callback closure Callback method to be executed
* @param int $exptime Either an interval in seconds or a unix timestamp for expiry
* @param int $attempts The amount of times to attempt a merge in case of failure
* @return bool success
*/
public function merge( $key, closure $callback, $exptime = 0, $attempts = 10 ) {
return true;
}
}
/**
* Backwards compatibility alias for EmptyBagOStuff
* @deprecated since 1.18
*/
class FakeMemCachedClient extends EmptyBagOStuff {
}