phpDoc: removed inherited docs

dg · dg · commit 813d98d3e307 · 2018-03-20T22:28:08.000+01:00
diff --git a/src/Caching/Storages/DevNullStorage.php b/src/Caching/Storages/DevNullStorage.php
@@ -19,42 +19,26 @@ class DevNullStorage implements Nette\Caching\IStorage
 {
 	use Nette\SmartObject;
 
-	/**
-	 * Read from cache.
-	 * @return mixed
-	 */
 	public function read(string $key)
 	{
 	}
 
 
-	/**
-	 * Prevents item reading and writing. Lock is released by write() or remove().
-	 */
 	public function lock(string $key): void
 	{
 	}
 
 
-	/**
-	 * Writes item into the cache.
-	 */
 	public function write(string $key, $data, array $dependencies): void
 	{
 	}
 
 
-	/**
-	 * Removes item from the cache.
-	 */
 	public function remove(string $key): void
 	{
 	}
 
 
-	/**
-	 * Removes items from the cache by conditions & garbage collector.
-	 */
 	public function clean(array $conditions): void
 	{
 	}
diff --git a/src/Caching/Storages/FileStorage.php b/src/Caching/Storages/FileStorage.php
@@ -78,10 +78,6 @@ public function __construct($dir, IJournal $journal = null)
 	}
 
 
-	/**
-	 * Read from cache.
-	 * @return mixed
-	 */
 	public function read(string $key)
 	{
 		$meta = $this->readMetaAndLock($this->getCacheFile($key), LOCK_SH);
@@ -132,9 +128,6 @@ private function verify(array $meta): bool
 	}
 
 
-	/**
-	 * Prevents item reading and writing. Lock is released by write() or remove().
-	 */
 	public function lock(string $key): void
 	{
 		$cacheFile = $this->getCacheFile($key);
@@ -149,9 +142,6 @@ public function lock(string $key): void
 	}
 
 
-	/**
-	 * Writes item into the cache.
-	 */
 	public function write(string $key, $data, array $dp): void
 	{
 		$meta = [
@@ -231,19 +221,13 @@ public function write(string $key, $data, array $dp): void
 	}
 
 
-	/**
-	 * Removes item from the cache.
-	 */
 	public function remove(string $key): void
 	{
 		unset($this->locks[$key]);
 		$this->delete($this->getCacheFile($key));
 	}
 
 
-	/**
-	 * Removes items from the cache by conditions & garbage collector.
-	 */
 	public function clean(array $conditions): void
 	{
 		$all = !empty($conditions[Cache::ALL]);
diff --git a/src/Caching/Storages/MemcachedStorage.php b/src/Caching/Storages/MemcachedStorage.php
@@ -75,10 +75,6 @@ public function getConnection(): \Memcached
 	}
 
 
-	/**
-	 * Read from cache.
-	 * @return mixed
-	 */
 	public function read(string $key)
 	{
 		$key = urlencode($this->prefix . $key);
@@ -108,10 +104,6 @@ public function read(string $key)
 	}
 
 
-	/**
-	 * Reads from cache in bulk.
-	 * @return array key => value pairs, missing items are omitted
-	 */
 	public function bulkRead(array $keys): array
 	{
 		$prefixedKeys = array_map(function ($key) {
@@ -140,17 +132,11 @@ public function bulkRead(array $keys): array
 	}
 
 
-	/**
-	 * Prevents item reading and writing. Lock is released by write() or remove().
-	 */
 	public function lock(string $key): void
 	{
 	}
 
 
-	/**
-	 * Writes item into the cache.
-	 */
 	public function write(string $key, $data, array $dp): void
 	{
 		if (isset($dp[Cache::ITEMS])) {
@@ -185,18 +171,12 @@ public function write(string $key, $data, array $dp): void
 	}
 
 
-	/**
-	 * Removes item from the cache.
-	 */
 	public function remove(string $key): void
 	{
 		$this->memcached->delete(urlencode($this->prefix . $key), 0);
 	}
 
 
-	/**
-	 * Removes items from the cache by conditions & garbage collector.
-	 */
 	public function clean(array $conditions): void
 	{
 		if (!empty($conditions[Cache::ALL])) {
diff --git a/src/Caching/Storages/MemoryStorage.php b/src/Caching/Storages/MemoryStorage.php
@@ -23,45 +23,29 @@ class MemoryStorage implements Nette\Caching\IStorage
 	private $data = [];
 
 
-	/**
-	 * Read from cache.
-	 * @return mixed
-	 */
 	public function read(string $key)
 	{
 		return $this->data[$key] ?? null;
 	}
 
 
-	/**
-	 * Prevents item reading and writing. Lock is released by write() or remove().
-	 */
 	public function lock(string $key): void
 	{
 	}
 
 
-	/**
-	 * Writes item into the cache.
-	 */
 	public function write(string $key, $data, array $dependencies): void
 	{
 		$this->data[$key] = $data;
 	}
 
 
-	/**
-	 * Removes item from the cache.
-	 */
 	public function remove(string $key): void
 	{
 		unset($this->data[$key]);
 	}
 
 
-	/**
-	 * Removes items from the cache by conditions & garbage collector.
-	 */
 	public function clean(array $conditions): void
 	{
 		if (!empty($conditions[Nette\Caching\Cache::ALL])) {
diff --git a/src/Caching/Storages/SQLiteJournal.php b/src/Caching/Storages/SQLiteJournal.php
@@ -63,9 +63,6 @@ private function open(): void
 	}
 
 
-	/**
-	 * Writes entry information into the journal.
-	 */
 	public function write(string $key, array $dependencies): void
 	{
 		if (!$this->pdo) {
@@ -93,10 +90,6 @@ public function write(string $key, array $dependencies): void
 	}
 
 
-	/**
-	 * Cleans entries from journal.
-	 * @return array|null  removed items or null when performing a full cleanup
-	 */
 	public function clean(array $conditions): ?array
 	{
 		if (!$this->pdo) {
diff --git a/src/Caching/Storages/SQLiteStorage.php b/src/Caching/Storages/SQLiteStorage.php
@@ -52,10 +52,6 @@ public function __construct($path)
 	}
 
 
-	/**
-	 * Read from cache.
-	 * @return mixed
-	 */
 	public function read(string $key)
 	{
 		$stmt = $this->pdo->prepare('SELECT data, slide FROM cache WHERE key=? AND (expire IS NULL OR expire >= ?)');
@@ -69,10 +65,6 @@ public function read(string $key)
 	}
 
 
-	/**
-	 * Reads from cache in bulk.
-	 * @return array key => value pairs, missing items are omitted
-	 */
 	public function bulkRead(array $keys): array
 	{
 		$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,17 +85,11 @@ public function bulkRead(array $keys): array
 	}
 
 
-	/**
-	 * Prevents item reading and writing. Lock is released by write() or remove().
-	 */
 	public function lock(string $key): void
 	{
 	}
 
 
-	/**
-	 * Writes item into the cache.
-	 */
 	public function write(string $key, $data, array $dependencies): void
 	{
 		$expire = isset($dependencies[Cache::EXPIRATION]) ? $dependencies[Cache::EXPIRATION] + time() : null;
@@ -125,19 +111,13 @@ public function write(string $key, $data, array $dependencies): void
 	}
 
 
-	/**
-	 * Removes item from the cache.
-	 */
 	public function remove(string $key): void
 	{
 		$this->pdo->prepare('DELETE FROM cache WHERE key=?')
 			->execute([$key]);
 	}
 
 
-	/**
-	 * Removes items from the cache by conditions & garbage collector.
-	 */
 	public function clean(array $conditions): void
 	{
 		if (!empty($conditions[Cache::ALL])) {

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