Skip to content

Commit

Permalink
Update
Browse files Browse the repository at this point in the history
  • Loading branch information
localzet committed Aug 16, 2023
1 parent e2fd8bd commit 104c2a9
Show file tree
Hide file tree
Showing 46 changed files with 1,702 additions and 59 deletions.
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center"><a href="https://www.localzet.com" target="_blank">
<img src="https://static.localzet.com/full-localzet2.svg" width="400">
<img src="https://static.localzet.com/media/full-localzet2.png" width="400">
</a></p>

<p align="center">
Expand All @@ -19,3 +19,29 @@
<img src="https://img.shields.io/github/license/localzet/PSR?label=%D0%9B%D0%B8%D1%86%D0%B5%D0%BD%D0%B7%D0%B8%D1%8F" alt="Лицензия">
</a>
</p>


- ~~PSR-0 (Autoloading Standard)~~ (**DEPRECATED**)
- ~~PSR-1 (Basic Coding Standard)~~ (**IMPOSSIBLE**)
- ~~PSR-2 (Coding Style Guide)~~ (**DEPRECATED**)
- **PSR-3 (Logger Interface)**
- ~~PSR-4 (Autoloading Standard)~~ (**IMPOSSIBLE**)
- ~~PSR-5 (PHPDoc Standard)~~ (**DRAFT**)
- **PSR-6 (Caching Interface)**
- **PSR-7 (HTTP Message)**
- ~~PSR-8 (PHPDoc Standard)~~ (**ABANDONED**)
- ~~PSR-9 (PHPDoc Standard)~~ (**ABANDONED**)
- ~~PSR-10 (PHPDoc Standard)~~ (**ABANDONED**)
- **PSR-11 (Container Interface)**
- ~~PSR-12 (Extended Coding Style Guide)~~ (**IMPOSSIBLE**)
- **PSR-13 (Hypermedia Links)**
- **PSR-14 (Event Dispatcher)**
- **PSR-15 (HTTP Server)**
- **PSR-16 (Simple Cache)**
- **PSR-17 (HTTP Factories)**
- **PSR-18 (HTTP Client)**
- ~~PSR-19 (PHPDoc tags)~~ (**DRAFT**)
- **PSR-20 (Clock)**
- ~~PSR-21 (Internationalization)~~ (**DRAFT**)
- ~~PSR-22 (Application Tracing)~~ (**DRAFT**)

15 changes: 15 additions & 0 deletions src/Cache/CacheException.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?php
declare(strict_types=1);

namespace localzet\PSR\Cache;

use Throwable;

/**
* Exception interface for all exceptions thrown by an Implementing Library.
*
* @package PSR-6 (Caching Interface)
*/
interface CacheException extends Throwable
{
}
111 changes: 111 additions & 0 deletions src/Cache/CacheItemInterface.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
<?php
declare(strict_types=1);

namespace localzet\PSR\Cache;

use DateInterval;
use DateTimeInterface;

/**
* CacheItemInterface defines an interface for interacting with objects inside a cache.
*
* Each Item object MUST be associated with a specific key, which can be set
* according to the implementing system and is typically passed by the
* Cache\CacheItemPoolInterface object.
*
* The Cache\CacheItemInterface object encapsulates the storage and retrieval of
* cache items. Each Cache\CacheItemInterface is generated by a
* Cache\CacheItemPoolInterface object, which is responsible for any required
* setup as well as associating the object with a unique Key.
* Cache\CacheItemInterface objects MUST be able to store and retrieve any type
* of PHP value defined in the Data section of the specification.
*
* Calling Libraries MUST NOT instantiate Item objects themselves. They may only
* be requested from a Pool object via the getItem() method. Calling Libraries
* SHOULD NOT assume that an Item created by one Implementing Library is
* compatible with a Pool from another Implementing Library.
*
* @package PSR-6 (Caching Interface)
*/
interface CacheItemInterface
{
/**
* Returns the key for the current cache item.
*
* The key is loaded by the Implementing Library, but should be available to
* the higher level callers when needed.
*
* @return string
* The key string for this cache item.
*/
public function getKey(): string;

/**
* Retrieves the value of the item from the cache associated with this object's key.
*
* The value returned must be identical to the value originally stored by set().
*
* If isHit() returns false, this method MUST return null. Note that null
* is a legitimate cached value, so the isHit() method SHOULD be used to
* differentiate between "null value was found" and "no value was found."
*
* @return mixed
* The value corresponding to this cache item's key, or null if not found.
*/
public function get(): mixed;

/**
* Confirms if the cache item lookup resulted in a cache hit.
*
* Note: This method MUST NOT have a race condition between calling isHit()
* and calling get().
*
* @return bool
* True if the request resulted in a cache hit. False otherwise.
*/
public function isHit(): bool;

/**
* Sets the value represented by this cache item.
*
* The $value argument may be any item that can be serialized by PHP,
* although the method of serialization is left up to the Implementing
* Library.
*
* @param mixed $value
* The serializable value to be stored.
*
* @return static
* The invoked object.
*/
public function set(mixed $value): static;

/**
* Sets the absolute expiration time for this cache item.
*
* @param DateTimeInterface|null $expiration
* The point in time after which the item MUST be considered expired.
* If null is passed explicitly, a default value MAY be used. If none is set,
* the value should be stored permanently or for as long as the
* implementation allows.
*
* @return static
* The called object.
*/
public function expiresAt(?DateTimeInterface $expiration): static;

/**
* Sets the relative expiration time for this cache item.
*
* @param int|DateInterval|null $time
* The period of time from the present after which the item MUST be considered
* expired. An integer parameter is understood to be the time in seconds until
* expiration. If null is passed explicitly, a default value MAY be used.
* If none is set, the value should be stored permanently or for as long as the
* implementation allows.
*
* @return static
* The called object.
*/
public function expiresAfter(int|DateInterval|null $time): static;
}
141 changes: 141 additions & 0 deletions src/Cache/CacheItemPoolInterface.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
<?php
declare(strict_types=1);

namespace localzet\PSR\Cache;

/**
* CacheItemPoolInterface generates CacheItemInterface objects.
*
* The primary purpose of Cache\CacheItemPoolInterface is to accept a key from
* the Calling Library and return the associated Cache\CacheItemInterface object.
* It is also the primary point of interaction with the entire cache collection.
* All configuration and initialization of the Pool is left up to an
* Implementing Library.
*
* @package PSR-6 (Caching Interface)
*/
interface CacheItemPoolInterface
{
/**
* Returns a Cache Item representing the specified key.
*
* This method must always return a CacheItemInterface object, even in case of
* a cache miss. It MUST NOT return null.
*
* @param string $key
* The key for which to return the corresponding Cache Item.
*
* @return CacheItemInterface
* The corresponding Cache Item.
* @throws InvalidArgumentException
* If the $key string is not a legal value a \localzet\PSR\Cache\InvalidArgumentException
* MUST be thrown.
*
*/
public function getItem(string $key): CacheItemInterface;

/**
* Returns a traversable set of cache items.
*
* @param string[] $keys
* An indexed array of keys of items to retrieve.
*
* @return iterable
* An iterable collection of Cache Items keyed by the cache keys of
* each item. A Cache item will be returned for each key, even if that
* key is not found. However, if no keys are specified then an empty
* traversable MUST be returned instead.
* @throws InvalidArgumentException
* If any of the keys in $keys are not a legal value a \localzet\PSR\Cache\InvalidArgumentException
* MUST be thrown.
*
*/
public function getItems(array $keys = []): iterable;

/**
* Confirms if the cache contains specified cache item.
*
* Note: This method MAY avoid retrieving the cached value for performance reasons.
* This could result in a race condition with CacheItemInterface::get(). To avoid
* such situation use CacheItemInterface::isHit() instead.
*
* @param string $key
* The key for which to check existence.
*
* @return bool
* True if item exists in the cache, false otherwise.
* @throws InvalidArgumentException
* If the $key string is not a legal value a \localzet\PSR\Cache\InvalidArgumentException
* MUST be thrown.
*
*/
public function hasItem(string $key): bool;

/**
* Deletes all items in the pool.
*
* @return bool
* True if the pool was successfully cleared. False if there was an error.
*/
public function clear(): bool;

/**
* Removes the item from the pool.
*
* @param string $key
* The key to delete.
*
* @return bool
* True if the item was successfully removed. False if there was an error.
* @throws InvalidArgumentException
* If the $key string is not a legal value a \localzet\PSR\Cache\InvalidArgumentException
* MUST be thrown.
*
*/
public function deleteItem(string $key): bool;

/**
* Removes multiple items from the pool.
*
* @param string[] $keys
* An array of keys that should be removed from the pool.
*
* @return bool
* True if the items were successfully removed. False if there was an error.
* @throws InvalidArgumentException
* If any of the keys in $keys are not a legal value a \localzet\PSR\Cache\InvalidArgumentException
* MUST be thrown.
*
*/
public function deleteItems(array $keys): bool;

/**
* Persists a cache item immediately.
*
* @param CacheItemInterface $item
* The cache item to save.
*
* @return bool
* True if the item was successfully persisted. False if there was an error.
*/
public function save(CacheItemInterface $item): bool;

/**
* Sets a cache item to be persisted later.
*
* @param CacheItemInterface $item
* The cache item to save.
*
* @return bool
* False if the item could not be queued or if a commit was attempted and failed. True otherwise.
*/
public function saveDeferred(CacheItemInterface $item): bool;

/**
* Persists any deferred cache items.
*
* @return bool
* True if all not-yet-saved items were successfully saved or there were none. False otherwise.
*/
public function commit(): bool;
}
16 changes: 16 additions & 0 deletions src/Cache/InvalidArgumentException.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<?php
declare(strict_types=1);

namespace localzet\PSR\Cache;

/**
* Exception interface for invalid cache arguments.
*
* Any time an invalid argument is passed into a method it must throw an
* exception class which implements localzet\PSR\Cache\InvalidArgumentException.
*
* @package PSR-6 (Caching Interface)
*/
interface InvalidArgumentException extends CacheException
{
}
17 changes: 17 additions & 0 deletions src/Clock/ClockInterface.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?php
declare(strict_types=1);

namespace localzet\PSR\Clock;

use DateTimeImmutable;

/**
* @package PSR-20 (Clock)
*/
interface ClockInterface
{
/**
* Returns the current time as a DateTimeImmutable Object
*/
public function now(): DateTimeImmutable;
}
15 changes: 15 additions & 0 deletions src/Container/ContainerExceptionInterface.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?php
declare(strict_types=1);

namespace localzet\PSR\Container;

use Throwable;

/**
* Base interface representing a generic exception in a container.
*
* @package PSR-11 (Container Interface)
*/
interface ContainerExceptionInterface extends Throwable
{
}
Loading

0 comments on commit 104c2a9

Please sign in to comment.