Mirrors/shlink
1
0
Fork 0
mirror of https://github.com/shlinkio/shlink.git synced 2026-03-12 01:54:41 +08:00
Code Issues Packages Projects Releases Wiki Activity

Migrated from standard datetime objects to chronos objects

Browse Source
This commit is contained in:
Alejandro Celaya
2018-09-29 12:52:32 +02:00
parent 9a2ca35e6e
commit 0183c8a4b7
31 changed files with 271 additions and 198 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
module/Rest/src/Service/ApiKeyService.php
View File

@@ -3,6 +3,7 @@ declare(strict_types=1);
namespace Shlinkio\Shlink\Rest\Service;
use Cake\Chronos\Chronos;
use Doctrine\ORM\EntityManagerInterface;
use Shlinkio\Shlink\Common\Exception\InvalidArgumentException;
use Shlinkio\Shlink\Rest\Entity\ApiKey;
@@ -20,13 +21,7 @@ class ApiKeyService implements ApiKeyServiceInterface
$this->em = $em;
}
/**
* Creates a new ApiKey with provided expiration date
*
* @param \DateTime $expirationDate
* @return ApiKey
*/
public function create(\DateTime $expirationDate = null): ApiKey
public function create(?Chronos $expirationDate = null): ApiKey
{
$key = new ApiKey();
if ($expirationDate !== null) {
@@ -39,12 +34,6 @@ class ApiKeyService implements ApiKeyServiceInterface
return $key;
}
/**
* Checks if provided key is a valid api key
*
* @param string $key
* @return bool
*/
public function check(string $key): bool
{
/** @var ApiKey|null $apiKey */
@@ -53,10 +42,6 @@ class ApiKeyService implements ApiKeyServiceInterface
}
/**
* Disables provided api key
*
* @param string $key
* @return ApiKey
* @throws InvalidArgumentException
*/
public function disable(string $key): ApiKey
@@ -72,12 +57,6 @@ class ApiKeyService implements ApiKeyServiceInterface
return $apiKey;
}
/**
* Lists all existing api keys
*
* @param bool $enabledOnly Tells if only enabled keys should be returned
* @return ApiKey[]
*/
public function listKeys(bool $enabledOnly = false): array
{
$conditions = $enabledOnly ? ['enabled' => true] : [];
@@ -86,12 +65,6 @@ class ApiKeyService implements ApiKeyServiceInterface
return $apiKeys;
}
/**
* Tries to find one API key by its key string
*
* @param string $key
* @return ApiKey|null
*/
public function getByKey(string $key): ?ApiKey
{
/** @var ApiKey|null $apiKey */

31
module/Rest/src/Service/ApiKeyServiceInterface.php
View File

@@ -3,49 +3,22 @@ declare(strict_types=1);
namespace Shlinkio\Shlink\Rest\Service;
use Cake\Chronos\Chronos;
use Shlinkio\Shlink\Common\Exception\InvalidArgumentException;
use Shlinkio\Shlink\Rest\Entity\ApiKey;
interface ApiKeyServiceInterface
{
/**
* Creates a new ApiKey with provided expiration date
*
* @param \DateTime $expirationDate
* @return ApiKey
*/
public function create(\DateTime $expirationDate = null): ApiKey;
public function create(?Chronos $expirationDate = null): ApiKey;
/**
* Checks if provided key is a valid api key
*
* @param string $key
* @return bool
*/
public function check(string $key): bool;
/**
* Disables provided api key
*
* @param string $key
* @return ApiKey
* @throws InvalidArgumentException
*/
public function disable(string $key): ApiKey;
/**
* Lists all existing api keys
*
* @param bool $enabledOnly Tells if only enabled keys should be returned
* @return ApiKey[]
*/
public function listKeys(bool $enabledOnly = false): array;
/**
* Tries to find one API key by its key string
*
* @param string $key
* @return ApiKey|null
*/
public function getByKey(string $key): ?ApiKey;
}