diff --git a/src/Pattern/AbstractPattern.php b/src/Pattern/AbstractPattern.php index 347638242..35470e160 100644 --- a/src/Pattern/AbstractPattern.php +++ b/src/Pattern/AbstractPattern.php @@ -22,7 +22,7 @@ abstract class AbstractPattern implements PatternInterface * Set pattern options * * @param PatternOptions $options - * @return AbstractPattern + * @return AbstractPattern Provides a fluent interface * @throws Exception\InvalidArgumentException */ public function setOptions(PatternOptions $options) diff --git a/src/Pattern/CallbackCache.php b/src/Pattern/CallbackCache.php index 0f5b3ccdc..6c1d6de23 100644 --- a/src/Pattern/CallbackCache.php +++ b/src/Pattern/CallbackCache.php @@ -18,7 +18,7 @@ class CallbackCache extends AbstractPattern * Set options * * @param PatternOptions $options - * @return CallbackCache + * @return CallbackCache Provides a fluent interface * @throws Exception\InvalidArgumentException if missing storage option */ public function setOptions(PatternOptions $options) diff --git a/src/Pattern/ClassCache.php b/src/Pattern/ClassCache.php index 7a4041b2a..0add72170 100644 --- a/src/Pattern/ClassCache.php +++ b/src/Pattern/ClassCache.php @@ -18,7 +18,7 @@ class ClassCache extends CallbackCache * Set options * * @param PatternOptions $options - * @return ClassCache + * @return ClassCache Provides a fluent interface * @throws Exception\InvalidArgumentException if missing 'class' or 'storage' options */ public function setOptions(PatternOptions $options) diff --git a/src/Pattern/OutputCache.php b/src/Pattern/OutputCache.php index fc0578748..e876f1fbb 100644 --- a/src/Pattern/OutputCache.php +++ b/src/Pattern/OutputCache.php @@ -24,7 +24,7 @@ class OutputCache extends AbstractPattern * Set options * * @param PatternOptions $options - * @return OutputCache + * @return OutputCache Provides a fluent interface * @throws Exception\InvalidArgumentException */ public function setOptions(PatternOptions $options) diff --git a/src/Pattern/PatternOptions.php b/src/Pattern/PatternOptions.php index ce7989b79..116227ce0 100644 --- a/src/Pattern/PatternOptions.php +++ b/src/Pattern/PatternOptions.php @@ -168,7 +168,7 @@ public function __construct($options = null) * - ObjectCache * * @param bool $cacheByDefault - * @return PatternOptions + * @return PatternOptions Provides a fluent interface */ public function setCacheByDefault($cacheByDefault) { @@ -199,7 +199,7 @@ public function getCacheByDefault() * - ObjectCache * * @param bool $cacheOutput - * @return PatternOptions + * @return PatternOptions Provides a fluent interface */ public function setCacheOutput($cacheOutput) { @@ -230,7 +230,7 @@ public function getCacheOutput() * * @param string $class * @throws Exception\InvalidArgumentException - * @return PatternOptions + * @return PatternOptions Provides a fluent interface */ public function setClass($class) { @@ -261,7 +261,7 @@ public function getClass() * - ClassCache * * @param array $classCacheMethods - * @return PatternOptions + * @return PatternOptions Provides a fluent interface */ public function setClassCacheMethods(array $classCacheMethods) { @@ -289,7 +289,7 @@ public function getClassCacheMethods() * - ClassCache * * @param array $classNonCacheMethods - * @return PatternOptions + * @return PatternOptions Provides a fluent interface */ public function setClassNonCacheMethods(array $classNonCacheMethods) { @@ -315,7 +315,7 @@ public function getClassNonCacheMethods() * * @param false|int $dirPermission * @throws Exception\InvalidArgumentException - * @return PatternOptions + * @return PatternOptions Provides a fluent interface */ public function setDirPermission($dirPermission) { @@ -356,7 +356,7 @@ public function getDirPermission() * * @param false|int $umask * @throws Exception\InvalidArgumentException - * @return PatternOptions + * @return PatternOptions Provides a fluent interface */ public function setUmask($umask) { @@ -402,7 +402,7 @@ public function getUmask() * - CaptureCache * * @param bool $fileLocking - * @return PatternOptions + * @return PatternOptions Provides a fluent interface */ public function setFileLocking($fileLocking) { @@ -428,7 +428,7 @@ public function getFileLocking() * * @param false|int $filePermission * @throws Exception\InvalidArgumentException - * @return PatternOptions + * @return PatternOptions Provides a fluent interface */ public function setFilePermission($filePermission) { @@ -469,7 +469,7 @@ public function getFilePermission() * Set value for index filename * * @param string $indexFilename - * @return PatternOptions + * @return PatternOptions Provides a fluent interface */ public function setIndexFilename($indexFilename) { @@ -492,7 +492,7 @@ public function getIndexFilename() * * @param mixed $object * @throws Exception\InvalidArgumentException - * @return PatternOptions + * @return PatternOptions Provides a fluent interface */ public function setObject($object) { @@ -522,7 +522,7 @@ public function getObject() * - ObjectCache * * @param bool $objectCacheMagicProperties - * @return PatternOptions + * @return PatternOptions Provides a fluent interface */ public function setObjectCacheMagicProperties($objectCacheMagicProperties) { @@ -547,7 +547,7 @@ public function getObjectCacheMagicProperties() * Set list of object methods for which to cache return values * * @param array $objectCacheMethods - * @return PatternOptions + * @return PatternOptions Provides a fluent interface * @throws Exception\InvalidArgumentException */ public function setObjectCacheMethods(array $objectCacheMethods) @@ -575,7 +575,7 @@ public function getObjectCacheMethods() * - ObjectCache * * @param null|string $objectKey The object key or NULL to use the objects class name - * @return PatternOptions + * @return PatternOptions Provides a fluent interface */ public function setObjectKey($objectKey) { @@ -607,7 +607,7 @@ public function getObjectKey() * Set list of object methods for which NOT to cache return values * * @param array $objectNonCacheMethods - * @return PatternOptions + * @return PatternOptions Provides a fluent interface * @throws Exception\InvalidArgumentException */ public function setObjectNonCacheMethods(array $objectNonCacheMethods) @@ -634,7 +634,7 @@ public function getObjectNonCacheMethods() * * @param string $publicDir * @throws Exception\InvalidArgumentException - * @return PatternOptions + * @return PatternOptions Provides a fluent interface */ public function setPublicDir($publicDir) { @@ -681,7 +681,7 @@ public function getPublicDir() * - OutputCache * * @param string|array|Storage $storage - * @return PatternOptions + * @return PatternOptions Provides a fluent interface */ public function setStorage($storage) { diff --git a/src/Storage/Adapter/AbstractAdapter.php b/src/Storage/Adapter/AbstractAdapter.php index 449f09dc7..0f72bb6f7 100644 --- a/src/Storage/Adapter/AbstractAdapter.php +++ b/src/Storage/Adapter/AbstractAdapter.php @@ -108,7 +108,7 @@ public function __destruct() * Set options. * * @param array|Traversable|AdapterOptions $options - * @return AbstractAdapter + * @return AbstractAdapter Provides a fluent interface * @see getOptions() */ public function setOptions($options) @@ -153,7 +153,7 @@ public function getOptions() * @see setWritable() * @see setReadable() * @param bool $flag - * @return AbstractAdapter + * @return AbstractAdapter Provides a fluent interface */ public function setCaching($flag) { @@ -268,8 +268,8 @@ public function hasPlugin(Plugin\PluginInterface $plugin) * Register a plugin * * @param Plugin\PluginInterface $plugin - * @param int $priority - * @return AbstractAdapter Fluent interface + * @param int $priority + * @return AbstractAdapter Provides a fluent interface * @throws Exception\LogicException */ public function addPlugin(Plugin\PluginInterface $plugin, $priority = 1) @@ -292,7 +292,7 @@ public function addPlugin(Plugin\PluginInterface $plugin, $priority = 1) * Unregister an already registered plugin * * @param Plugin\PluginInterface $plugin - * @return AbstractAdapter Fluent interface + * @return AbstractAdapter Provides a fluent interface * @throws Exception\LogicException */ public function removePlugin(Plugin\PluginInterface $plugin) diff --git a/src/Storage/Adapter/AdapterOptions.php b/src/Storage/Adapter/AdapterOptions.php index 93ce44ce0..6ec826d34 100644 --- a/src/Storage/Adapter/AdapterOptions.php +++ b/src/Storage/Adapter/AdapterOptions.php @@ -76,7 +76,7 @@ class AdapterOptions extends AbstractOptions * Adapter using this instance * * @param StorageInterface|null $adapter - * @return AdapterOptions + * @return AdapterOptions Provides a fluent interface */ public function setAdapter(StorageInterface $adapter = null) { @@ -89,7 +89,7 @@ public function setAdapter(StorageInterface $adapter = null) * * @param string $keyPattern * @throws Exception\InvalidArgumentException - * @return AdapterOptions + * @return AdapterOptions Provides a fluent interface */ public function setKeyPattern($keyPattern) { @@ -130,7 +130,7 @@ public function getKeyPattern() * Set namespace. * * @param string $namespace - * @return AdapterOptions + * @return AdapterOptions Provides a fluent interface */ public function setNamespace($namespace) { @@ -157,7 +157,7 @@ public function getNamespace() * Enable/Disable reading data from cache. * * @param bool $readable - * @return AbstractAdapter + * @return AdapterOptions Provides a fluent interface */ public function setReadable($readable) { @@ -183,7 +183,7 @@ public function getReadable() * Set time to live. * * @param int|float $ttl - * @return AdapterOptions + * @return AdapterOptions Provides a fluent interface */ public function setTtl($ttl) { @@ -209,7 +209,7 @@ public function getTtl() * Enable/Disable writing data to cache. * * @param bool $writable - * @return AdapterOptions + * @return AdapterOptions Provides a fluent interface */ public function setWritable($writable) { diff --git a/src/Storage/Adapter/ApcIterator.php b/src/Storage/Adapter/ApcIterator.php index ce8f2b62e..086a9920e 100644 --- a/src/Storage/Adapter/ApcIterator.php +++ b/src/Storage/Adapter/ApcIterator.php @@ -80,7 +80,7 @@ public function getMode() * Set iterator mode * * @param int $mode - * @return ApcIterator Fluent interface + * @return ApcIterator Provides a fluent interface */ public function setMode($mode) { diff --git a/src/Storage/Adapter/ApcOptions.php b/src/Storage/Adapter/ApcOptions.php index 1fade95fe..837e4c76b 100644 --- a/src/Storage/Adapter/ApcOptions.php +++ b/src/Storage/Adapter/ApcOptions.php @@ -25,7 +25,7 @@ class ApcOptions extends AdapterOptions * Set namespace separator * * @param string $namespaceSeparator - * @return ApcOptions + * @return ApcOptions Provides a fluent interface */ public function setNamespaceSeparator($namespaceSeparator) { diff --git a/src/Storage/Adapter/ApcuIterator.php b/src/Storage/Adapter/ApcuIterator.php index 3b397ec07..0eb2881ff 100644 --- a/src/Storage/Adapter/ApcuIterator.php +++ b/src/Storage/Adapter/ApcuIterator.php @@ -80,7 +80,7 @@ public function getMode() * Set iterator mode * * @param int $mode - * @return ApcuIterator Fluent interface + * @return ApcuIterator Provides a fluent interface */ public function setMode($mode) { diff --git a/src/Storage/Adapter/ApcuOptions.php b/src/Storage/Adapter/ApcuOptions.php index b4297dddb..5dbc60ac3 100644 --- a/src/Storage/Adapter/ApcuOptions.php +++ b/src/Storage/Adapter/ApcuOptions.php @@ -25,7 +25,7 @@ class ApcuOptions extends AdapterOptions * Set namespace separator * * @param string $namespaceSeparator - * @return ApcuOptions + * @return ApcuOptions Provides a fluent interface */ public function setNamespaceSeparator($namespaceSeparator) { diff --git a/src/Storage/Adapter/BlackHole.php b/src/Storage/Adapter/BlackHole.php index 655bc2037..cb23cef95 100644 --- a/src/Storage/Adapter/BlackHole.php +++ b/src/Storage/Adapter/BlackHole.php @@ -71,7 +71,7 @@ public function __construct($options = null) * Set options. * * @param array|\Traversable|AdapterOptions $options - * @return StorageInterface Fluent interface + * @return BlackHole Provides a fluent interface */ public function setOptions($options) { diff --git a/src/Storage/Adapter/DbaIterator.php b/src/Storage/Adapter/DbaIterator.php index ab3926d55..abad29fe2 100644 --- a/src/Storage/Adapter/DbaIterator.php +++ b/src/Storage/Adapter/DbaIterator.php @@ -89,7 +89,7 @@ public function getMode() * Set iterator mode * * @param int $mode - * @return ApcIterator Fluent interface + * @return DbaIterator Provides a fluent interface */ public function setMode($mode) { diff --git a/src/Storage/Adapter/DbaOptions.php b/src/Storage/Adapter/DbaOptions.php index d03f88372..b13c3d3bb 100644 --- a/src/Storage/Adapter/DbaOptions.php +++ b/src/Storage/Adapter/DbaOptions.php @@ -48,7 +48,7 @@ class DbaOptions extends AdapterOptions * Set namespace separator * * @param string $namespaceSeparator - * @return DbaOptions + * @return DbaOptions Provides a fluent interface */ public function setNamespaceSeparator($namespaceSeparator) { @@ -72,7 +72,7 @@ public function getNamespaceSeparator() * Set pathname to database file * * @param string $pathname - * @return DbaOptions + * @return DbaOptions Provides a fluent interface */ public function setPathname($pathname) { @@ -95,7 +95,7 @@ public function getPathname() * * * @param string $mode - * @return \Zend\Cache\Storage\Adapter\DbaOptions + * @return DbaOptions Provides a fluent interface */ public function setMode($mode) { @@ -109,6 +109,12 @@ public function getMode() return $this->mode; } + /** + * + * + * @param string $handler + * @return DbaOptions Provides a fluent interface + */ public function setHandler($handler) { $handler = (string) $handler; diff --git a/src/Storage/Adapter/FilesystemIterator.php b/src/Storage/Adapter/FilesystemIterator.php index 38f9a331c..01feb1a03 100644 --- a/src/Storage/Adapter/FilesystemIterator.php +++ b/src/Storage/Adapter/FilesystemIterator.php @@ -88,7 +88,7 @@ public function getMode() * Set iterator mode * * @param int $mode - * @return FilesystemIterator Fluent interface + * @return FilesystemIterator Provides a fluent interface */ public function setMode($mode) { diff --git a/src/Storage/Adapter/FilesystemOptions.php b/src/Storage/Adapter/FilesystemOptions.php index 3448ad57d..84c636a40 100644 --- a/src/Storage/Adapter/FilesystemOptions.php +++ b/src/Storage/Adapter/FilesystemOptions.php @@ -119,7 +119,7 @@ public function __construct($options = null) * Set cache dir * * @param string $cacheDir - * @return FilesystemOptions + * @return FilesystemOptions Provides a fluent interface * @throws Exception\InvalidArgumentException */ public function setCacheDir($cacheDir) @@ -167,7 +167,7 @@ public function getCacheDir() * Set clear stat cache * * @param bool $clearStatCache - * @return FilesystemOptions + * @return FilesystemOptions Provides a fluent interface */ public function setClearStatCache($clearStatCache) { @@ -191,7 +191,7 @@ public function getClearStatCache() * Set dir level * * @param int $dirLevel - * @return FilesystemOptions + * @return FilesystemOptions Provides a fluent interface * @throws Exception\InvalidArgumentException */ public function setDirLevel($dirLevel) @@ -221,7 +221,7 @@ public function getDirLevel() * Set permission to create directories on unix systems * * @param false|string|int $dirPermission FALSE to disable explicit permission or an octal number - * @return FilesystemOptions + * @return FilesystemOptions Provides a fluent interface * @see setUmask * @see setFilePermission * @link http://php.net/manual/function.chmod.php @@ -265,7 +265,7 @@ public function getDirPermission() * Set file locking * * @param bool $fileLocking - * @return FilesystemOptions + * @return FilesystemOptions Provides a fluent interface */ public function setFileLocking($fileLocking) { @@ -289,7 +289,7 @@ public function getFileLocking() * Set permission to create files on unix systems * * @param false|string|int $filePermission FALSE to disable explicit permission or an octal number - * @return FilesystemOptions + * @return FilesystemOptions Provides a fluent interface * @see setUmask * @see setDirPermission * @link http://php.net/manual/function.chmod.php @@ -337,7 +337,7 @@ public function getFilePermission() * Set namespace separator * * @param string $namespaceSeparator - * @return FilesystemOptions + * @return FilesystemOptions Provides a fluent interface */ public function setNamespaceSeparator($namespaceSeparator) { @@ -361,7 +361,7 @@ public function getNamespaceSeparator() * Set no atime * * @param bool $noAtime - * @return FilesystemOptions + * @return FilesystemOptions Provides a fluent interface */ public function setNoAtime($noAtime) { diff --git a/src/Storage/Adapter/KeyListIterator.php b/src/Storage/Adapter/KeyListIterator.php index 0f9ac9703..5d10245e8 100644 --- a/src/Storage/Adapter/KeyListIterator.php +++ b/src/Storage/Adapter/KeyListIterator.php @@ -87,7 +87,7 @@ public function getMode() * Set iterator mode * * @param int $mode - * @return KeyListIterator Fluent interface + * @return KeyListIterator Provides a fluent interface */ public function setMode($mode) { diff --git a/src/Storage/Adapter/MemcacheResourceManager.php b/src/Storage/Adapter/MemcacheResourceManager.php index be5b17d68..c96722218 100644 --- a/src/Storage/Adapter/MemcacheResourceManager.php +++ b/src/Storage/Adapter/MemcacheResourceManager.php @@ -97,7 +97,7 @@ public function getResource($id) * @param array|Traversable|MemcacheResource $resource * @param callable $failureCallback * @param array|Traversable $serverDefaults - * @return MemcacheResourceManager + * @return MemcacheResourceManager Provides a fluent interface */ public function setResource($id, $resource, $failureCallback = null, $serverDefaults = []) { @@ -153,7 +153,7 @@ public function setResource($id, $resource, $failureCallback = null, $serverDefa * Remove a resource * * @param string $id - * @return MemcacheResourceManager + * @return MemcacheResourceManager Provides a fluent interface */ public function removeResource($id) { @@ -228,7 +228,7 @@ public function getAutoCompressThreshold($id) * @param string $id * @param int|string|array|ArrayAccess|null $threshold * @param float|string|bool $minSavings - * @return MemcacheResourceManager + * @return MemcacheResourceManager Provides a fluent interface */ public function setAutoCompressThreshold($id, $threshold, $minSavings = false) { @@ -278,7 +278,7 @@ public function getAutoCompressMinSavings($id) * * @param string $id * @param float|string|null $minSavings - * @return MemcacheResourceManager + * @return MemcacheResourceManager Provides a fluent interface * @throws \Zend\Cache\Exception\RuntimeException */ public function setAutoCompressMinSavings($id, $minSavings) @@ -310,7 +310,7 @@ public function setAutoCompressMinSavings($id, $minSavings) * ) * @param string $id * @param array $serverDefaults - * @return MemcacheResourceManager + * @return MemcacheResourceManager Provides a fluent interface */ public function setServerDefaults($id, array $serverDefaults) { @@ -383,7 +383,7 @@ protected function normalizeServerDefaults(& $serverDefaults) * * @param string $id * @param callable|null $failureCallback - * @return MemcacheResourceManager + * @return MemcacheResourceManager Provides a fluent interface */ public function setFailureCallback($id, $failureCallback) { @@ -435,7 +435,7 @@ public function getServers($id) * * @param string $id * @param string|array $servers - * @return MemcacheResourceManager + * @return MemcacheResourceManager Provides a fluent interface */ public function addServers($id, $servers) { diff --git a/src/Storage/Adapter/MemcachedOptions.php b/src/Storage/Adapter/MemcachedOptions.php index b2eb7e29a..df1185a2a 100644 --- a/src/Storage/Adapter/MemcachedOptions.php +++ b/src/Storage/Adapter/MemcachedOptions.php @@ -72,7 +72,7 @@ public function setNamespace($namespace) * Set namespace separator * * @param string $namespaceSeparator - * @return MemcachedOptions + * @return MemcachedOptions Provides a fluent interface */ public function setNamespaceSeparator($namespaceSeparator) { @@ -98,7 +98,7 @@ public function getNamespaceSeparator() * A memcached resource to share * * @param null|MemcachedResource $memcachedResource - * @return MemcachedOptions + * @return MemcachedOptions Provides a fluent interface * @deprecated Please use the resource manager instead */ public function setMemcachedResource(MemcachedResource $memcachedResource = null) @@ -139,7 +139,7 @@ public function getMemcachedResource() * Set the memcached resource manager to use * * @param null|MemcachedResourceManager $resourceManager - * @return MemcachedOptions + * @return MemcachedOptions Provides a fluent interface */ public function setResourceManager(MemcachedResourceManager $resourceManager = null) { @@ -177,7 +177,7 @@ public function getResourceId() * Set the memcached resource id * * @param string $resourceId - * @return MemcachedOptions + * @return MemcachedOptions Provides a fluent interface */ public function setResourceId($resourceId) { @@ -203,7 +203,7 @@ public function getPersistentId() * Set the persistent id * * @param string $persistentId - * @return MemcachedOptions + * @return MemcachedOptions Provides a fluent interface */ public function setPersistentId($persistentId) { @@ -218,7 +218,7 @@ public function setPersistentId($persistentId) * @param string $host * @param int $port * @param int $weight - * @return MemcachedOptions + * @return MemcachedOptions Provides a fluent interface * @deprecated Please use the resource manager instead */ public function addServer($host, $port = 11211, $weight = 0) @@ -242,7 +242,7 @@ public function addServer($host, $port = 11211, $weight = 0) * Set a list of memcached servers to add on initialize * * @param string|array $servers list of servers - * @return MemcachedOptions + * @return MemcachedOptions Provides a fluent interface * @throws Exception\InvalidArgumentException */ public function setServers($servers) @@ -265,7 +265,7 @@ public function getServers() * Set libmemcached options * * @param array $libOptions - * @return MemcachedOptions + * @return MemcachedOptions Provides a fluent interface * @link http://php.net/manual/memcached.constants.php */ public function setLibOptions(array $libOptions) @@ -279,7 +279,7 @@ public function setLibOptions(array $libOptions) * * @param string|int $key * @param mixed $value - * @return MemcachedOptions + * @return MemcachedOptions Provides a fluent interface * @link http://php.net/manual/memcached.constants.php * @deprecated Please use lib_options or the resource manager instead */ diff --git a/src/Storage/Adapter/MemcachedResourceManager.php b/src/Storage/Adapter/MemcachedResourceManager.php index 7c8fd91ed..a4d382730 100644 --- a/src/Storage/Adapter/MemcachedResourceManager.php +++ b/src/Storage/Adapter/MemcachedResourceManager.php @@ -173,7 +173,7 @@ public function getResource($id) * * @param string $id * @param array|Traversable|MemcachedResource $resource - * @return MemcachedResourceManager Fluent interface + * @return MemcachedResourceManager Provides a fluent interface */ public function setResource($id, $resource) { @@ -208,7 +208,7 @@ public function setResource($id, $resource) * Remove a resource * * @param string $id - * @return MemcachedResourceManager Fluent interface + * @return MemcachedResourceManager Provides a fluent interface */ public function removeResource($id) { @@ -221,7 +221,7 @@ public function removeResource($id) * * @param string $id * @param string $persistentId - * @return MemcachedResourceManager Fluent interface + * @return MemcachedResourceManager Provides a fluent interface * @throws Exception\RuntimeException */ public function setPersistentId($id, $persistentId) @@ -284,7 +284,7 @@ protected function normalizePersistentId(& $persistentId) * * @param string $id * @param array $libOptions - * @return MemcachedResourceManager Fluent interface + * @return MemcachedResourceManager Provides a fluent interface */ public function setLibOptions($id, array $libOptions) { @@ -432,7 +432,7 @@ protected function normalizeLibOptionKey(& $key) * * @param string $id * @param string|array $servers - * @return MemcachedResourceManager + * @return MemcachedResourceManager Provides a fluent interface */ public function setServers($id, $servers) { @@ -463,7 +463,7 @@ public function setServers($id, $servers) * * @param string $id * @param string|array $servers - * @return MemcachedResourceManager + * @return MemcachedResourceManager Provides a fluent interface */ public function addServers($id, $servers) { diff --git a/src/Storage/Adapter/MemoryOptions.php b/src/Storage/Adapter/MemoryOptions.php index 58f98cb96..d2d424122 100644 --- a/src/Storage/Adapter/MemoryOptions.php +++ b/src/Storage/Adapter/MemoryOptions.php @@ -33,7 +33,7 @@ class MemoryOptions extends AdapterOptions * * @link http://php.net/manual/faq.using.php#faq.using.shorthandbytes * @param string|int $memoryLimit - * @return MemoryOptions + * @return MemoryOptions Provides a fluent interface */ public function setMemoryLimit($memoryLimit) { diff --git a/src/Storage/Adapter/MongoDbOptions.php b/src/Storage/Adapter/MongoDbOptions.php index 41d8fee9d..8c52151e5 100644 --- a/src/Storage/Adapter/MongoDbOptions.php +++ b/src/Storage/Adapter/MongoDbOptions.php @@ -45,7 +45,7 @@ class MongoDbOptions extends AdapterOptions * * @param string $namespaceSeparator * - * @return self + * @return MongoDbOptions Provides a fluent interface */ public function setNamespaceSeparator($namespaceSeparator) { @@ -75,7 +75,7 @@ public function getNamespaceSeparator() * * @param null|MongoDbResourceManager $resourceManager * - * @return self + * @return MongoDbOptions Provides a fluent interface */ public function setResourceManager(MongoDbResourceManager $resourceManager = null) { @@ -113,7 +113,7 @@ public function getResourceId() * * @param string $resourceId * - * @return self + * @return MongoDbOptions Provides a fluent interface */ public function setResourceId($resourceId) { @@ -132,7 +132,8 @@ public function setResourceId($resourceId) * Set the mongo DB server * * @param string $server - * @return self + * + * @return MongoDbOptions Provides a fluent interface */ public function setServer($server) { @@ -140,24 +141,52 @@ public function setServer($server) return $this; } + /** + * + * + * @param array $connectionOptions + * + * @return MongoDbOptions Provides a fluent interface + */ public function setConnectionOptions(array $connectionOptions) { $this->getResourceManager()->setConnectionOptions($this->getResourceId(), $connectionOptions); return $this; } + /** + * + * + * @param array $driverOptions + MongoDbOptions + * @return MongoDbOptions Provides a fluent interface + */ public function setDriverOptions(array $driverOptions) { $this->getResourceManager()->setDriverOptions($this->getResourceId(), $driverOptions); return $this; } + /** + * + * + * @param string $database + * + * @return MongoDbOptions Provides a fluent interface + */ public function setDatabase($database) { $this->getResourceManager()->setDatabase($this->getResourceId(), $database); return $this; } + /** + * + * + * @param string $collection + * + * @return MongoDbOptions Provides a fluent interface + */ public function setCollection($collection) { $this->getResourceManager()->setCollection($this->getResourceId(), $collection); diff --git a/src/Storage/Adapter/MongoDbResourceManager.php b/src/Storage/Adapter/MongoDbResourceManager.php index 84350a965..6bc9729b2 100644 --- a/src/Storage/Adapter/MongoDbResourceManager.php +++ b/src/Storage/Adapter/MongoDbResourceManager.php @@ -40,7 +40,7 @@ public function hasResource($id) * @param string $id * @param array|MongoCollection $resource * - * @return self + * @return MongoDbResourceManager Provides a fluent interface * * @throws Exception\RuntimeException */ diff --git a/src/Storage/Adapter/RedisOptions.php b/src/Storage/Adapter/RedisOptions.php index 3dd7ff802..ffb515fc8 100644 --- a/src/Storage/Adapter/RedisOptions.php +++ b/src/Storage/Adapter/RedisOptions.php @@ -71,7 +71,7 @@ public function setNamespace($namespace) * Set namespace separator * * @param string $namespaceSeparator - * @return RedisOptions + * @return RedisOptions Provides a fluent interface */ public function setNamespaceSeparator($namespaceSeparator) { @@ -97,7 +97,7 @@ public function getNamespaceSeparator() * Set the redis resource manager to use * * @param null|RedisResourceManager $resourceManager - * @return RedisOptions + * @return RedisOptions Provides a fluent interface */ public function setResourceManager(RedisResourceManager $resourceManager = null) { @@ -135,7 +135,7 @@ public function getResourceId() * Set the redis resource id * * @param string $resourceId - * @return RedisOptions + * @return RedisOptions Provides a fluent interface */ public function setResourceId($resourceId) { @@ -161,7 +161,7 @@ public function getPersistentId() * Set the persistent id * * @param string $persistentId - * @return RedisOptions + * @return RedisOptions Provides a fluent interface */ public function setPersistentId($persistentId) { @@ -174,7 +174,7 @@ public function setPersistentId($persistentId) * Set redis options * * @param array $libOptions - * @return RedisOptions + * @return RedisOptions Provides a fluent interface * @link http://github.com/nicolasff/phpredis#setoption */ public function setLibOptions(array $libOptions) @@ -205,7 +205,7 @@ public function getLibOptions() * * @param string|array $server * - * @return RedisOptions + * @return RedisOptions Provides a fluent interface */ public function setServer($server) { @@ -228,7 +228,7 @@ public function getServer() * * @param int $database Database number * - * @return RedisOptions + * @return RedisOptions Provides a fluent interface */ public function setDatabase($database) { @@ -251,7 +251,7 @@ public function getDatabase() * * @param string $password Password * - * @return RedisOptions + * @return RedisOptions Provides a fluent interface */ public function setPassword($password) { diff --git a/src/Storage/Adapter/SessionOptions.php b/src/Storage/Adapter/SessionOptions.php index 856e0cee7..c7fc69bde 100644 --- a/src/Storage/Adapter/SessionOptions.php +++ b/src/Storage/Adapter/SessionOptions.php @@ -27,7 +27,7 @@ class SessionOptions extends AdapterOptions * Set the session container * * @param null|SessionContainer $sessionContainer - * @return SessionOptions + * @return SessionOptions Provides a fluent interface */ public function setSessionContainer(SessionContainer $sessionContainer = null) { diff --git a/src/Storage/Adapter/XCacheOptions.php b/src/Storage/Adapter/XCacheOptions.php index 0bb4745b1..b30d12216 100644 --- a/src/Storage/Adapter/XCacheOptions.php +++ b/src/Storage/Adapter/XCacheOptions.php @@ -46,7 +46,7 @@ class XCacheOptions extends AdapterOptions * Set namespace separator * * @param string $namespaceSeparator - * @return XCacheOptions + * @return XCacheOptions Provides a fluent interface */ public function setNamespaceSeparator($namespaceSeparator) { @@ -70,7 +70,7 @@ public function getNamespaceSeparator() * Set username to call admin functions * * @param null|string $adminUser - * @return XCacheOptions + * @return XCacheOptions Provides a fluent interface */ public function setAdminUser($adminUser) { @@ -96,7 +96,7 @@ public function getAdminUser() * Enable/Disable admin authentication handling * * @param bool $adminAuth - * @return XCacheOptions + * @return XCacheOptions Provides a fluent interface */ public function setAdminAuth($adminAuth) { @@ -122,7 +122,7 @@ public function getAdminAuth() * Set password to call admin functions * * @param null|string $adminPass - * @return XCacheOptions + * @return XCacheOptions Provides a fluent interface */ public function setAdminPass($adminPass) { diff --git a/src/Storage/Plugin/AbstractPlugin.php b/src/Storage/Plugin/AbstractPlugin.php index 5ce3f7267..9d4d579e9 100644 --- a/src/Storage/Plugin/AbstractPlugin.php +++ b/src/Storage/Plugin/AbstractPlugin.php @@ -22,7 +22,7 @@ abstract class AbstractPlugin extends AbstractListenerAggregate implements Plugi * Set pattern options * * @param PluginOptions $options - * @return AbstractPlugin + * @return AbstractPlugin Provides a fluent interface */ public function setOptions(PluginOptions $options) { diff --git a/src/Storage/Plugin/PluginOptions.php b/src/Storage/Plugin/PluginOptions.php index 21955fd25..ac3f2848b 100644 --- a/src/Storage/Plugin/PluginOptions.php +++ b/src/Storage/Plugin/PluginOptions.php @@ -72,7 +72,7 @@ class PluginOptions extends AbstractOptions * - ClearExpiredByFactor * * @param int $clearingFactor - * @return PluginOptions + * @return PluginOptions Provides a fluent interface */ public function setClearingFactor($clearingFactor) { @@ -101,7 +101,7 @@ public function getClearingFactor() * * @param null|callable $exceptionCallback * @throws Exception\InvalidArgumentException - * @return PluginOptions + * @return PluginOptions Provides a fluent interface */ public function setExceptionCallback($exceptionCallback) { @@ -129,7 +129,7 @@ public function getExceptionCallback() * Exit if connection aborted and ignore_user_abort is disabled. * * @param bool $exitOnAbort - * @return PluginOptions + * @return PluginOptions Provides a fluent interface */ public function setExitOnAbort($exitOnAbort) { @@ -154,7 +154,7 @@ public function getExitOnAbort() * - OptimizeByFactor * * @param int $optimizingFactor - * @return PluginOptions + * @return PluginOptions Provides a fluent interface */ public function setOptimizingFactor($optimizingFactor) { @@ -183,7 +183,7 @@ public function getOptimizingFactor() * * @param string|SerializerAdapter $serializer * @throws Exception\InvalidArgumentException - * @return self + * @return PluginOptions Provides a fluent interface */ public function setSerializer($serializer) { @@ -229,7 +229,7 @@ public function getSerializer() * - Serializer * * @param mixed $serializerOptions - * @return PluginOptions + * @return PluginOptions Provides a fluent interface */ public function setSerializerOptions($serializerOptions) { @@ -257,7 +257,7 @@ public function getSerializerOptions() * - ExceptionHandler * * @param bool $throwExceptions - * @return PluginOptions + * @return PluginOptions Provides a fluent interface */ public function setThrowExceptions($throwExceptions) {