phpDoc: removed inherited docs

dg · dg · commit 339a55dc3731 · 2018-03-20T22:37:52.000+01:00
diff --git a/src/Caching/Storages/DevNullStorage.php b/src/Caching/Storages/DevNullStorage.php
@@ -17,52 +17,26 @@ class DevNullStorage implements Nette\Caching\IStorage
 {
 	use Nette\SmartObject;
 
-	/**
-	 * Read from cache.
-	 * @param  string
-	 * @return mixed
-	 */
 	public function read($key)
 	{
 	}
 
 
-	/**
-	 * Prevents item reading and writing. Lock is released by write() or remove().
-	 * @param  string
-	 * @return void
-	 */
 	public function lock($key)
 	{
 	}
 
 
-	/**
-	 * Writes item into the cache.
-	 * @param  string
-	 * @param  mixed
-	 * @return void
-	 */
 	public function write($key, $data, array $dependencies)
 	{
 	}
 
 
-	/**
-	 * Removes item from the cache.
-	 * @param  string
-	 * @return void
-	 */
 	public function remove($key)
 	{
 	}
 
 
-	/**
-	 * Removes items from the cache by conditions & garbage collector.
-	 * @param  array  conditions
-	 * @return void
-	 */
 	public function clean(array $conditions)
 	{
 	}
diff --git a/src/Caching/Storages/FileStorage.php b/src/Caching/Storages/FileStorage.php
@@ -78,11 +78,6 @@ public function __construct($dir, IJournal $journal = null)
 	}
 
 
-	/**
-	 * Read from cache.
-	 * @param  string
-	 * @return mixed
-	 */
 	public function read($key)
 	{
 		$meta = $this->readMetaAndLock($this->getCacheFile($key), LOCK_SH);
@@ -135,11 +130,6 @@ private function verify(array $meta)
 	}
 
 
-	/**
-	 * Prevents item reading and writing. Lock is released by write() or remove().
-	 * @param  string
-	 * @return void
-	 */
 	public function lock($key)
 	{
 		$cacheFile = $this->getCacheFile($key);
@@ -154,12 +144,6 @@ public function lock($key)
 	}
 
 
-	/**
-	 * Writes item into the cache.
-	 * @param  string
-	 * @param  mixed
-	 * @return void
-	 */
 	public function write($key, $data, array $dp)
 	{
 		$meta = [
@@ -239,23 +223,13 @@ public function write($key, $data, array $dp)
 	}
 
 
-	/**
-	 * Removes item from the cache.
-	 * @param  string
-	 * @return void
-	 */
 	public function remove($key)
 	{
 		unset($this->locks[$key]);
 		$this->delete($this->getCacheFile($key));
 	}
 
 
-	/**
-	 * Removes items from the cache by conditions & garbage collector.
-	 * @param  array  conditions
-	 * @return void
-	 */
 	public function clean(array $conditions)
 	{
 		$all = !empty($conditions[Cache::ALL]);
diff --git a/src/Caching/Storages/MemcachedStorage.php b/src/Caching/Storages/MemcachedStorage.php
@@ -76,11 +76,6 @@ public function getConnection()
 	}
 
 
-	/**
-	 * Read from cache.
-	 * @param  string
-	 * @return mixed
-	 */
 	public function read($key)
 	{
 		$key = urlencode($this->prefix . $key);
@@ -110,22 +105,11 @@ public function read($key)
 	}
 
 
-	/**
-	 * Prevents item reading and writing. Lock is released by write() or remove().
-	 * @param  string
-	 * @return void
-	 */
 	public function lock($key)
 	{
 	}
 
 
-	/**
-	 * Writes item into the cache.
-	 * @param  string
-	 * @param  mixed
-	 * @return void
-	 */
 	public function write($key, $data, array $dp)
 	{
 		if (isset($dp[Cache::ITEMS])) {
@@ -160,22 +144,12 @@ public function write($key, $data, array $dp)
 	}
 
 
-	/**
-	 * Removes item from the cache.
-	 * @param  string
-	 * @return void
-	 */
 	public function remove($key)
 	{
 		$this->memcache->delete(urlencode($this->prefix . $key), 0);
 	}
 
 
-	/**
-	 * Removes items from the cache by conditions & garbage collector.
-	 * @param  array  conditions
-	 * @return void
-	 */
 	public function clean(array $conditions)
 	{
 		if (!empty($conditions[Cache::ALL])) {
diff --git a/src/Caching/Storages/MemoryStorage.php b/src/Caching/Storages/MemoryStorage.php
@@ -21,55 +21,29 @@ class MemoryStorage implements Nette\Caching\IStorage
 	private $data = [];
 
 
-	/**
-	 * Read from cache.
-	 * @param  string
-	 * @return mixed
-	 */
 	public function read($key)
 	{
 		return isset($this->data[$key]) ? $this->data[$key] : null;
 	}
 
 
-	/**
-	 * Prevents item reading and writing. Lock is released by write() or remove().
-	 * @param  string
-	 * @return void
-	 */
 	public function lock($key)
 	{
 	}
 
 
-	/**
-	 * Writes item into the cache.
-	 * @param  string
-	 * @param  mixed
-	 * @return void
-	 */
 	public function write($key, $data, array $dependencies)
 	{
 		$this->data[$key] = $data;
 	}
 
 
-	/**
-	 * Removes item from the cache.
-	 * @param  string
-	 * @return void
-	 */
 	public function remove($key)
 	{
 		unset($this->data[$key]);
 	}
 
 
-	/**
-	 * Removes items from the cache by conditions & garbage collector.
-	 * @param  array  conditions
-	 * @return void
-	 */
 	public function clean(array $conditions)
 	{
 		if (!empty($conditions[Nette\Caching\Cache::ALL])) {
diff --git a/src/Caching/Storages/NewMemcachedStorage.php b/src/Caching/Storages/NewMemcachedStorage.php
@@ -76,11 +76,6 @@ public function getConnection()
 	}
 
 
-	/**
-	 * Read from cache.
-	 * @param  string
-	 * @return mixed
-	 */
 	public function read($key)
 	{
 		$key = urlencode($this->prefix . $key);
@@ -110,11 +105,6 @@ public function read($key)
 	}
 
 
-	/**
-	 * Reads from cache in bulk.
-	 * @param  string
-	 * @return array key => value pairs, missing items are omitted
-	 */
 	public function bulkRead(array $keys)
 	{
 		$prefixedKeys = array_map(function ($key) {
@@ -143,22 +133,11 @@ public function bulkRead(array $keys)
 	}
 
 
-	/**
-	 * Prevents item reading and writing. Lock is released by write() or remove().
-	 * @param  string
-	 * @return void
-	 */
 	public function lock($key)
 	{
 	}
 
 
-	/**
-	 * Writes item into the cache.
-	 * @param  string
-	 * @param  mixed
-	 * @return void
-	 */
 	public function write($key, $data, array $dp)
 	{
 		if (isset($dp[Cache::ITEMS])) {
@@ -193,22 +172,12 @@ public function write($key, $data, array $dp)
 	}
 
 
-	/**
-	 * Removes item from the cache.
-	 * @param  string
-	 * @return void
-	 */
 	public function remove($key)
 	{
 		$this->memcached->delete(urlencode($this->prefix . $key), 0);
 	}
 
 
-	/**
-	 * Removes items from the cache by conditions & garbage collector.
-	 * @param  array  conditions
-	 * @return void
-	 */
 	public function clean(array $conditions)
 	{
 		if (!empty($conditions[Cache::ALL])) {
diff --git a/src/Caching/Storages/SQLiteJournal.php b/src/Caching/Storages/SQLiteJournal.php
@@ -64,12 +64,6 @@ private function open()
 	}
 
 
-	/**
-	 * Writes entry information into the journal.
-	 * @param  string
-	 * @param  array
-	 * @return void
-	 */
 	public function write($key, array $dependencies)
 	{
 		if (!$this->pdo) {
@@ -97,11 +91,6 @@ public function write($key, array $dependencies)
 	}
 
 
-	/**
-	 * Cleans entries from journal.
-	 * @param  array
-	 * @return array|null  removed items or null when performing a full cleanup
-	 */
 	public function clean(array $conditions)
 	{
 		if (!$this->pdo) {
diff --git a/src/Caching/Storages/SQLiteStorage.php b/src/Caching/Storages/SQLiteStorage.php
@@ -50,11 +50,6 @@ public function __construct($path)
 	}
 
 
-	/**
-	 * Read from cache.
-	 * @param  string
-	 * @return mixed
-	 */
 	public function read($key)
 	{
 		$stmt = $this->pdo->prepare('SELECT data, slide FROM cache WHERE key=? AND (expire IS NULL OR expire >= ?)');
@@ -68,11 +63,6 @@ public function read($key)
 	}
 
 
-	/**
-	 * Reads from cache in bulk.
-	 * @param  string
-	 * @return array key => value pairs, missing items are omitted
-	 */
 	public function bulkRead(array $keys)
 	{
 		$stmt = $this->pdo->prepare('SELECT key, data, slide FROM cache WHERE key IN (?' . str_repeat(',?', count($keys) - 1) . ') AND (expire IS NULL OR expire >= ?)');
@@ -93,22 +83,11 @@ public function bulkRead(array $keys)
 	}
 
 
-	/**
-	 * Prevents item reading and writing. Lock is released by write() or remove().
-	 * @param  string
-	 * @return void
-	 */
 	public function lock($key)
 	{
 	}
 
 
-	/**
-	 * Writes item into the cache.
-	 * @param  string
-	 * @param  mixed
-	 * @return void
-	 */
 	public function write($key, $data, array $dependencies)
 	{
 		$expire = isset($dependencies[Cache::EXPIRATION]) ? $dependencies[Cache::EXPIRATION] + time() : null;
@@ -130,23 +109,13 @@ public function write($key, $data, array $dependencies)
 	}
 
 
-	/**
-	 * Removes item from the cache.
-	 * @param  string
-	 * @return void
-	 */
 	public function remove($key)
 	{
 		$this->pdo->prepare('DELETE FROM cache WHERE key=?')
 			->execute([$key]);
 	}
 
 
-	/**
-	 * Removes items from the cache by conditions & garbage collector.
-	 * @param  array  conditions
-	 * @return void
-	 */
 	public function clean(array $conditions)
 	{
 		if (!empty($conditions[Cache::ALL])) {

Original file line number	Diff line number	Diff line change
`@@ -17,52 +17,26 @@ class DevNullStorage implements Nette\Caching\IStorage`
`17`	`17`	`{`
`18`	`18`	`use Nette\SmartObject;`
`19`	`19`
`20`		`- /**`
`21`		`- * Read from cache.`
`22`		`- * @param string`
`23`		`- * @return mixed`
`24`		`- */`
`25`	`20`	`public function read($key)`
`26`	`21`	`{`
`27`	`22`	`}`
`28`	`23`
`29`	`24`
`30`		`- /**`
`31`		`- * Prevents item reading and writing. Lock is released by write() or remove().`
`32`		`- * @param string`
`33`		`- * @return void`
`34`		`- */`
`35`	`25`	`public function lock($key)`
`36`	`26`	`{`
`37`	`27`	`}`
`38`	`28`
`39`	`29`
`40`		`- /**`
`41`		`- * Writes item into the cache.`
`42`		`- * @param string`
`43`		`- * @param mixed`
`44`		`- * @return void`
`45`		`- */`
`46`	`30`	`public function write($key, $data, array $dependencies)`
`47`	`31`	`{`
`48`	`32`	`}`
`49`	`33`
`50`	`34`
`51`		`- /**`
`52`		`- * Removes item from the cache.`
`53`		`- * @param string`
`54`		`- * @return void`
`55`		`- */`
`56`	`35`	`public function remove($key)`
`57`	`36`	`{`
`58`	`37`	`}`
`59`	`38`
`60`	`39`
`61`		`- /**`
`62`		`- * Removes items from the cache by conditions & garbage collector.`
`63`		`- * @param array conditions`
`64`		`- * @return void`
`65`		`- */`
`66`	`40`	`public function clean(array $conditions)`
`67`	`41`	`{`
`68`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -78,11 +78,6 @@ public function __construct($dir, IJournal $journal = null)`
`78`	`78`	`}`
`79`	`79`
`80`	`80`
`81`		`- /**`
`82`		`- * Read from cache.`
`83`		`- * @param string`
`84`		`- * @return mixed`
`85`		`- */`
`86`	`81`	`public function read($key)`
`87`	`82`	`{`
`88`	`83`	`$meta = $this->readMetaAndLock($this->getCacheFile($key), LOCK_SH);`
`@@ -135,11 +130,6 @@ private function verify(array $meta)`
`135`	`130`	`}`
`136`	`131`
`137`	`132`
`138`		`- /**`
`139`		`- * Prevents item reading and writing. Lock is released by write() or remove().`
`140`		`- * @param string`
`141`		`- * @return void`
`142`		`- */`
`143`	`133`	`public function lock($key)`
`144`	`134`	`{`
`145`	`135`	`$cacheFile = $this->getCacheFile($key);`
`@@ -154,12 +144,6 @@ public function lock($key)`
`154`	`144`	`}`
`155`	`145`
`156`	`146`
`157`		`- /**`
`158`		`- * Writes item into the cache.`
`159`		`- * @param string`
`160`		`- * @param mixed`
`161`		`- * @return void`
`162`		`- */`
`163`	`147`	`public function write($key, $data, array $dp)`
`164`	`148`	`{`
`165`	`149`	`$meta = [`
`@@ -239,23 +223,13 @@ public function write($key, $data, array $dp)`
`239`	`223`	`}`
`240`	`224`
`241`	`225`
`242`		`- /**`
`243`		`- * Removes item from the cache.`
`244`		`- * @param string`
`245`		`- * @return void`
`246`		`- */`
`247`	`226`	`public function remove($key)`
`248`	`227`	`{`
`249`	`228`	`unset($this->locks[$key]);`
`250`	`229`	`$this->delete($this->getCacheFile($key));`
`251`	`230`	`}`
`252`	`231`
`253`	`232`
`254`		`- /**`
`255`		`- * Removes items from the cache by conditions & garbage collector.`
`256`		`- * @param array conditions`
`257`		`- * @return void`
`258`		`- */`
`259`	`233`	`public function clean(array $conditions)`
`260`	`234`	`{`
`261`	`235`	`$all = !empty($conditions[Cache::ALL]);`
Original file line number	Diff line number	Diff line change
`@@ -76,11 +76,6 @@ public function getConnection()`
`76`	`76`	`}`
`77`	`77`
`78`	`78`
`79`		`- /**`
`80`		`- * Read from cache.`
`81`		`- * @param string`
`82`		`- * @return mixed`
`83`		`- */`
`84`	`79`	`public function read($key)`
`85`	`80`	`{`
`86`	`81`	`$key = urlencode($this->prefix . $key);`
`@@ -110,22 +105,11 @@ public function read($key)`
`110`	`105`	`}`
`111`	`106`
`112`	`107`
`113`		`- /**`
`114`		`- * Prevents item reading and writing. Lock is released by write() or remove().`
`115`		`- * @param string`
`116`		`- * @return void`
`117`		`- */`
`118`	`108`	`public function lock($key)`
`119`	`109`	`{`
`120`	`110`	`}`
`121`	`111`
`122`	`112`
`123`		`- /**`
`124`		`- * Writes item into the cache.`
`125`		`- * @param string`
`126`		`- * @param mixed`
`127`		`- * @return void`
`128`		`- */`
`129`	`113`	`public function write($key, $data, array $dp)`
`130`	`114`	`{`
`131`	`115`	`if (isset($dp[Cache::ITEMS])) {`
`@@ -160,22 +144,12 @@ public function write($key, $data, array $dp)`
`160`	`144`	`}`
`161`	`145`
`162`	`146`
`163`		`- /**`
`164`		`- * Removes item from the cache.`
`165`		`- * @param string`
`166`		`- * @return void`
`167`		`- */`
`168`	`147`	`public function remove($key)`
`169`	`148`	`{`
`170`	`149`	`$this->memcache->delete(urlencode($this->prefix . $key), 0);`
`171`	`150`	`}`
`172`	`151`
`173`	`152`
`174`		`- /**`
`175`		`- * Removes items from the cache by conditions & garbage collector.`
`176`		`- * @param array conditions`
`177`		`- * @return void`
`178`		`- */`
`179`	`153`	`public function clean(array $conditions)`
`180`	`154`	`{`
`181`	`155`	`if (!empty($conditions[Cache::ALL])) {`
Original file line number	Diff line number	Diff line change
`@@ -21,55 +21,29 @@ class MemoryStorage implements Nette\Caching\IStorage`
`21`	`21`	`private $data = [];`
`22`	`22`
`23`	`23`
`24`		`- /**`
`25`		`- * Read from cache.`
`26`		`- * @param string`
`27`		`- * @return mixed`
`28`		`- */`
`29`	`24`	`public function read($key)`
`30`	`25`	`{`
`31`	`26`	`return isset($this->data[$key]) ? $this->data[$key] : null;`
`32`	`27`	`}`
`33`	`28`
`34`	`29`
`35`		`- /**`
`36`		`- * Prevents item reading and writing. Lock is released by write() or remove().`
`37`		`- * @param string`
`38`		`- * @return void`
`39`		`- */`
`40`	`30`	`public function lock($key)`
`41`	`31`	`{`
`42`	`32`	`}`
`43`	`33`
`44`	`34`
`45`		`- /**`
`46`		`- * Writes item into the cache.`
`47`		`- * @param string`
`48`		`- * @param mixed`
`49`		`- * @return void`
`50`		`- */`
`51`	`35`	`public function write($key, $data, array $dependencies)`
`52`	`36`	`{`
`53`	`37`	`$this->data[$key] = $data;`
`54`	`38`	`}`
`55`	`39`
`56`	`40`
`57`		`- /**`
`58`		`- * Removes item from the cache.`
`59`		`- * @param string`
`60`		`- * @return void`
`61`		`- */`
`62`	`41`	`public function remove($key)`
`63`	`42`	`{`
`64`	`43`	`unset($this->data[$key]);`
`65`	`44`	`}`
`66`	`45`
`67`	`46`
`68`		`- /**`
`69`		`- * Removes items from the cache by conditions & garbage collector.`
`70`		`- * @param array conditions`
`71`		`- * @return void`
`72`		`- */`
`73`	`47`	`public function clean(array $conditions)`
`74`	`48`	`{`
`75`	`49`	`if (!empty($conditions[Nette\Caching\Cache::ALL])) {`
Original file line number	Diff line number	Diff line change
`@@ -64,12 +64,6 @@ private function open()`
`64`	`64`	`}`
`65`	`65`
`66`	`66`
`67`		`- /**`
`68`		`- * Writes entry information into the journal.`
`69`		`- * @param string`
`70`		`- * @param array`
`71`		`- * @return void`
`72`		`- */`
`73`	`67`	`public function write($key, array $dependencies)`
`74`	`68`	`{`
`75`	`69`	`if (!$this->pdo) {`
`@@ -97,11 +91,6 @@ public function write($key, array $dependencies)`
`97`	`91`	`}`
`98`	`92`
`99`	`93`
`100`		`- /**`
`101`		`- * Cleans entries from journal.`
`102`		`- * @param array`
`103`		`- * @return array\|null removed items or null when performing a full cleanup`
`104`		`- */`
`105`	`94`	`public function clean(array $conditions)`
`106`	`95`	`{`
`107`	`96`	`if (!$this->pdo) {`
Original file line number	Diff line number	Diff line change
`@@ -50,11 +50,6 @@ public function __construct($path)`
`50`	`50`	`}`
`51`	`51`
`52`	`52`
`53`		`- /**`
`54`		`- * Read from cache.`
`55`		`- * @param string`
`56`		`- * @return mixed`
`57`		`- */`
`58`	`53`	`public function read($key)`
`59`	`54`	`{`
`60`	`55`	`$stmt = $this->pdo->prepare('SELECT data, slide FROM cache WHERE key=? AND (expire IS NULL OR expire >= ?)');`
`@@ -68,11 +63,6 @@ public function read($key)`
`68`	`63`	`}`
`69`	`64`
`70`	`65`
`71`		`- /**`
`72`		`- * Reads from cache in bulk.`
`73`		`- * @param string`
`74`		`- * @return array key => value pairs, missing items are omitted`
`75`		`- */`
`76`	`66`	`public function bulkRead(array $keys)`
`77`	`67`	`{`
`78`	`68`	`$stmt = $this->pdo->prepare('SELECT key, data, slide FROM cache WHERE key IN (?' . str_repeat(',?', count($keys) - 1) . ') AND (expire IS NULL OR expire >= ?)');`
`@@ -93,22 +83,11 @@ public function bulkRead(array $keys)`
`93`	`83`	`}`
`94`	`84`
`95`	`85`
`96`		`- /**`
`97`		`- * Prevents item reading and writing. Lock is released by write() or remove().`
`98`		`- * @param string`
`99`		`- * @return void`
`100`		`- */`
`101`	`86`	`public function lock($key)`
`102`	`87`	`{`
`103`	`88`	`}`
`104`	`89`
`105`	`90`
`106`		`- /**`
`107`		`- * Writes item into the cache.`
`108`		`- * @param string`
`109`		`- * @param mixed`
`110`		`- * @return void`
`111`		`- */`
`112`	`91`	`public function write($key, $data, array $dependencies)`
`113`	`92`	`{`
`114`	`93`	`$expire = isset($dependencies[Cache::EXPIRATION]) ? $dependencies[Cache::EXPIRATION] + time() : null;`
`@@ -130,23 +109,13 @@ public function write($key, $data, array $dependencies)`
`130`	`109`	`}`
`131`	`110`
`132`	`111`
`133`		`- /**`
`134`		`- * Removes item from the cache.`
`135`		`- * @param string`
`136`		`- * @return void`
`137`		`- */`
`138`	`112`	`public function remove($key)`
`139`	`113`	`{`
`140`	`114`	`$this->pdo->prepare('DELETE FROM cache WHERE key=?')`
`141`	`115`	`->execute([$key]);`
`142`	`116`	`}`
`143`	`117`
`144`	`118`
`145`		`- /**`
`146`		`- * Removes items from the cache by conditions & garbage collector.`
`147`		`- * @param array conditions`
`148`		`- * @return void`
`149`		`- */`
`150`	`119`	`public function clean(array $conditions)`
`151`	`120`	`{`
`152`	`121`	`if (!empty($conditions[Cache::ALL])) {`