Add more scalar type checks and return types

cundd · Jan 26, 2019 · 1dab787 · 1dab787
1 parent a4da600
commit 1dab787
Show file tree

Hide file tree

Showing 51 changed files with 374 additions and 567 deletions.
diff --git a/.phpstorm.meta.php/ObjectManager.php b/.phpstorm.meta.php/ObjectManager.php
@@ -6,4 +6,19 @@
         \TYPO3\CMS\Extbase\Object\ObjectManagerInterface::get(0),
         map([])
     );
+
+    override(
+        \TYPO3\CMS\Extbase\Object\ObjectManager::get(0),
+        map([])
+    );
+
+    override(
+        \Cundd\Rest\ObjectManagerInterface::get(0),
+        map([])
+    );
+
+    override(
+        \Cundd\Rest\ObjectManager::get(0),
+        map([])
+    );
 }
diff --git a/Classes/Access/AbstractAccessController.php b/Classes/Access/AbstractAccessController.php
@@ -32,7 +32,7 @@ public function __construct(ObjectManager $objectManager)
      * @return Access
      * @throws \Exception
      */
-    protected function checkAuthentication(RestRequestInterface $request)
+    protected function checkAuthentication(RestRequestInterface $request): Access
     {
         try {
             $isAuthenticated = $this->objectManager->getAuthenticationProvider()->authenticate($request);

diff --git a/Classes/Access/AccessControllerInterface.php b/Classes/Access/AccessControllerInterface.php
@@ -14,14 +14,13 @@ interface AccessControllerInterface
      * @param RestRequestInterface $request
      * @return Access
      */
-    public function getAccess(RestRequestInterface $request);
+    public function getAccess(RestRequestInterface $request): Access;
 
     /**
      * Returns if the given request needs authentication
      *
      * @param RestRequestInterface $request
      * @return bool
      */
-    public function requestNeedsAuthentication(RestRequestInterface $request);
-
+    public function requestNeedsAuthentication(RestRequestInterface $request): bool;
 }
diff --git a/Classes/Access/ConfigurationBasedAccessController.php b/Classes/Access/ConfigurationBasedAccessController.php
@@ -42,7 +42,7 @@ public function __construct(ConfigurationProviderInterface $configurationProvide
      * @return Access
      * @throws \Exception
      */
-    public function getAccess(RestRequestInterface $request)
+    public function getAccess(RestRequestInterface $request): Access
     {
         $access = $this->getAccessConfiguration($request);
         if ($access->isRequireLogin()) {
@@ -70,7 +70,7 @@ public function getConfigurationForResourceType(ResourceType $resourceType)
      * @return bool
      * @throws Exception\InvalidConfigurationException
      */
-    public function requestNeedsAuthentication(RestRequestInterface $request)
+    public function requestNeedsAuthentication(RestRequestInterface $request): bool
     {
         return $this->getAccessConfiguration($request)->isRequireLogin();
     }
@@ -81,7 +81,7 @@ public function requestNeedsAuthentication(RestRequestInterface $request)
      * @param RestRequestInterface $request
      * @return bool
      */
-    protected function requiresAuthorization($request)
+    protected function requiresAuthorization($request): bool
     {
         return !in_array(strtoupper($request->getMethod()), self::ACCESS_NOT_REQUIRED);
     }
@@ -90,7 +90,7 @@ protected function requiresAuthorization($request)
      * @param RestRequestInterface $request
      * @return Access
      */
-    protected function getAccessConfiguration(RestRequestInterface $request)
+    protected function getAccessConfiguration(RestRequestInterface $request): Access
     {
         if (!$this->requiresAuthorization($request)) {
             return Access::allowed();

diff --git a/Classes/Authentication/AbstractAuthenticationProvider.php b/Classes/Authentication/AbstractAuthenticationProvider.php
@@ -13,7 +13,7 @@ abstract class AbstractAuthenticationProvider implements AuthenticationProviderI
      * @param RestRequestInterface $request
      * @return bool Returns if the authentication was successful
      */
-    public function authenticate(RestRequestInterface $request)
+    public function authenticate(RestRequestInterface $request): bool
     {
         return false;
     }

diff --git a/Classes/Authentication/AuthenticationProviderCollection.php b/Classes/Authentication/AuthenticationProviderCollection.php
@@ -40,7 +40,7 @@ public function __construct($providers)
      * @param RestRequestInterface $request
      * @return bool Returns if the authentication was successful
      */
-    public function authenticate(RestRequestInterface $request)
+    public function authenticate(RestRequestInterface $request): bool
     {
         /** @var AuthenticationProviderInterface $authenticationProvider */
         foreach ($this->providers as $authenticationProvider) {

diff --git a/Classes/Authentication/AuthenticationProviderInterface.php b/Classes/Authentication/AuthenticationProviderInterface.php
@@ -13,5 +13,5 @@ interface AuthenticationProviderInterface
      * @param RestRequestInterface $request
      * @return bool Returns if the authentication was successful
      */
-    public function authenticate(RestRequestInterface $request);
+    public function authenticate(RestRequestInterface $request): bool;
 }
diff --git a/Classes/Authentication/BasicAuthenticationProvider.php b/Classes/Authentication/BasicAuthenticationProvider.php
@@ -24,7 +24,7 @@ class BasicAuthenticationProvider extends AbstractAuthenticationProvider
      * @param RestRequestInterface $request
      * @return bool Returns if the authentication was successful
      */
-    public function authenticate(RestRequestInterface $request)
+    public function authenticate(RestRequestInterface $request): bool
     {
         $username = null;
         $password = null;
@@ -40,6 +40,10 @@ public function authenticate(RestRequestInterface $request)
             list($username, $password) = $tuple;
         }
 
+        if (!is_string($username) || !is_string($password)) {
+            return false;
+        }
+
         return $this->userProvider->checkCredentials($username, $password);
     }
 

diff --git a/Classes/Authentication/CredentialsAuthenticationProvider.php b/Classes/Authentication/CredentialsAuthenticationProvider.php
@@ -23,7 +23,7 @@ class CredentialsAuthenticationProvider extends AbstractAuthenticationProvider
      * @param RestRequestInterface $request
      * @return bool Returns if the authentication was successful
      */
-    public function authenticate(RestRequestInterface $request)
+    public function authenticate(RestRequestInterface $request): bool
     {
         return $this->sessionManager->valueForKey('loginStatus') === AuthHandler::STATUS_LOGGED_IN;
     }

diff --git a/Classes/Authentication/RequestAuthenticationProvider.php b/Classes/Authentication/RequestAuthenticationProvider.php
@@ -18,7 +18,7 @@ class RequestAuthenticationProvider extends AbstractAuthenticationProvider
      * @param RestRequestInterface $request
      * @return bool Returns if the authentication was successful
      */
-    public function authenticate(RestRequestInterface $request)
+    public function authenticate(RestRequestInterface $request): bool
     {
         return !!($GLOBALS['TSFE']->fe_user->user);
     }

diff --git a/Classes/Authentication/UserProvider/FeUserProvider.php b/Classes/Authentication/UserProvider/FeUserProvider.php
@@ -25,9 +25,9 @@ class FeUserProvider implements UserProviderInterface
      * @param string $password
      * @return boolean
      */
-    public function checkCredentials($username, $password)
+    public function checkCredentials(string $username, string $password): bool
     {
-        if (!is_string($password) || '' === $password) {
+        if ('' === $username || '' === $password) {
             return false;
         }
 

diff --git a/Classes/Authentication/UserProviderInterface.php b/Classes/Authentication/UserProviderInterface.php
@@ -12,5 +12,5 @@ interface UserProviderInterface
      * @param string $password
      * @return boolean
      */
-    public function checkCredentials($username, $password);
+    public function checkCredentials(string $username, string $password): bool;
 }
diff --git a/Classes/Cache/Cache.php b/Classes/Cache/Cache.php
@@ -30,14 +30,14 @@ class Cache implements CacheInterface
      *
      * @var integer
      */
-    private $cacheLifeTime;
+    private $cacheLifeTime = 0;
 
     /**
      * Life time defined in the expires header
      *
      * @var integer
      */
-    private $expiresHeaderLifeTime;
+    private $expiresHeaderLifeTime = 0;
 
     /**
      * @var ResponseFactory
@@ -54,7 +54,7 @@ public function __construct(ResponseFactoryInterface $responseFactory)
         $this->responseFactory = $responseFactory;
     }
 
-    public function getCachedValueForRequest(RestRequestInterface $request)
+    public function getCachedValueForRequest(RestRequestInterface $request): ?ResponseInterface
     {
         $cacheLifeTime = $this->getCacheLifeTime();
 
@@ -133,7 +133,7 @@ public function setCachedValueForRequest(
      * @param RestRequestInterface $request
      * @return string
      */
-    public function getCacheKeyForRequest(RestRequestInterface $request)
+    public function getCacheKeyForRequest(RestRequestInterface $request): string
     {
         $cacheKey = sha1($request->getUri() . '_' . $request->getFormat() . '_' . $request->getMethod());
         $params = $request->getQueryParams();
@@ -150,7 +150,7 @@ public function getCacheKeyForRequest(RestRequestInterface $request)
      * @param int $cacheLifeTime
      * @return $this
      */
-    public function setCacheLifeTime($cacheLifeTime)
+    public function setCacheLifeTime(int $cacheLifeTime): CacheInterface
     {
         $this->cacheLifeTime = $cacheLifeTime;
 
@@ -162,7 +162,7 @@ public function setCacheLifeTime($cacheLifeTime)
      *
      * @return int
      */
-    public function getCacheLifeTime()
+    public function getCacheLifeTime(): int
     {
         return $this->cacheLifeTime;
     }
@@ -173,7 +173,7 @@ public function getCacheLifeTime()
      * @param int $expiresHeaderLifeTime
      * @return $this
      */
-    public function setExpiresHeaderLifeTime($expiresHeaderLifeTime)
+    public function setExpiresHeaderLifeTime(int $expiresHeaderLifeTime): CacheInterface
     {
         $this->expiresHeaderLifeTime = $expiresHeaderLifeTime;
 
@@ -185,7 +185,7 @@ public function setExpiresHeaderLifeTime($expiresHeaderLifeTime)
      *
      * @return int
      */
-    public function getExpiresHeaderLifeTime()
+    public function getExpiresHeaderLifeTime(): int
     {
         return $this->expiresHeaderLifeTime;
     }

diff --git a/Classes/Cache/CacheFactory.php b/Classes/Cache/CacheFactory.php
@@ -13,8 +13,10 @@ class CacheFactory
      * @param ObjectManager                  $objectManager
      * @return CacheInterface
      */
-    public function buildCache(ConfigurationProviderInterface $configurationProvider, ObjectManager $objectManager)
-    {
+    public function buildCache(
+        ConfigurationProviderInterface $configurationProvider,
+        ObjectManager $objectManager
+    ): CacheInterface {
         $cacheInstance = $this->getCacheInstance($configurationProvider, $objectManager);
 
         if ($cacheInstance instanceof CacheInterface) {
@@ -46,22 +48,21 @@ private function getCacheInstance(
      * @param ConfigurationProviderInterface $configurationProvider
      * @return int|mixed
      */
-    private function getCacheLifeTime(ConfigurationProviderInterface $configurationProvider)
+    private function getCacheLifeTime(ConfigurationProviderInterface $configurationProvider): int
     {
         $readCacheLifeTime = $configurationProvider->getSetting('cacheLifeTime');
         if ($readCacheLifeTime === null) {
             $readCacheLifeTime = -1;
         }
-        $readCacheLifeTime = intval($readCacheLifeTime);
 
-        return $readCacheLifeTime;
+        return (int)$readCacheLifeTime;
     }
 
     /**
      * @param ConfigurationProviderInterface $configurationProvider
      * @return int|mixed
      */
-    private function getExpiresHeaderLifeTime(ConfigurationProviderInterface $configurationProvider)
+    private function getExpiresHeaderLifeTime(ConfigurationProviderInterface $configurationProvider): int
     {
         $expiresHeaderLifeTime = $configurationProvider->getSetting('expiresHeaderLifeTime');
 

diff --git a/Classes/Cache/CacheInterface.php b/Classes/Cache/CacheInterface.php
@@ -19,7 +19,7 @@ interface CacheInterface
      * @param RestRequestInterface $request
      * @return ResponseInterface|null
      */
-    public function getCachedValueForRequest(RestRequestInterface $request);
+    public function getCachedValueForRequest(RestRequestInterface $request): ?ResponseInterface;
 
     /**
      * Sets the cache value for the given request
@@ -41,35 +41,35 @@ public function setCachedValueForRequest(
      * @param RestRequestInterface $request
      * @return string
      */
-    public function getCacheKeyForRequest(RestRequestInterface $request);
+    public function getCacheKeyForRequest(RestRequestInterface $request): string;
 
     /**
      * Sets the cache life time
      *
      * @param int $cacheLifeTime
      * @return $this
      */
-    public function setCacheLifeTime($cacheLifeTime);
+    public function setCacheLifeTime(int $cacheLifeTime): self;
 
     /**
      * Returns the cache life time
      *
      * @return int
      */
-    public function getCacheLifeTime();
+    public function getCacheLifeTime(): int;
 
     /**
      * Sets the life time defined in the expires header
      *
      * @param int $expiresHeaderLifeTime
      * @return $this
      */
-    public function setExpiresHeaderLifeTime($expiresHeaderLifeTime);
+    public function setExpiresHeaderLifeTime(int $expiresHeaderLifeTime): self;
 
     /**
      * Returns the life time defined in the expires header
      *
      * @return int
      */
-    public function getExpiresHeaderLifeTime();
+    public function getExpiresHeaderLifeTime(): int;
 }
diff --git a/Classes/Configuration/AbstractConfigurationProvider.php b/Classes/Configuration/AbstractConfigurationProvider.php
@@ -28,7 +28,7 @@ abstract class AbstractConfigurationProvider implements SingletonInterface, Conf
      * @param mixed  $defaultValue
      * @return mixed
      */
-    public function getSetting($keyPath, $defaultValue = null)
+    public function getSetting(string $keyPath, $defaultValue = null)
     {
         $matchingSetting = $this->getSettings();
 
@@ -58,7 +58,7 @@ public function getSetting($keyPath, $defaultValue = null)
      *
      * @return array
      */
-    public function getSettings()
+    public function getSettings(): array
     {
         if ($this->settings === null) {
             throw new InvalidConfigurationException('No settings provided');
@@ -84,7 +84,7 @@ public function setSettings($settings)
      * @param ResourceType $resourceType
      * @return ResourceConfiguration
      */
-    public function getResourceConfiguration(ResourceType $resourceType)
+    public function getResourceConfiguration(ResourceType $resourceType): ?ResourceConfiguration
     {
         $configuredPaths = $this->getConfiguredResources();
         $matchingConfiguration = null;
@@ -122,7 +122,7 @@ public function getResourceConfiguration(ResourceType $resourceType)
      *
      * @return ResourceConfiguration[]
      */
-    public function getConfiguredResources()
+    public function getConfiguredResources(): array
     {
         $configurationCollection = [];
         foreach ($this->getRawConfiguredResourceTypes() as $path => $configuration) {

diff --git a/Classes/Configuration/ConfigurationProviderInterface.php b/Classes/Configuration/ConfigurationProviderInterface.php
@@ -26,27 +26,27 @@ interface ConfigurationProviderInterface
      * @param mixed  $defaultValue
      * @return mixed
      */
-    public function getSetting($keyPath, $defaultValue = null);
+    public function getSetting(string $keyPath, $defaultValue = null);
 
     /**
      * Returns the settings read from the TypoScript
      *
      * @return array
      */
-    public function getSettings();
+    public function getSettings(): array;
 
     /**
      * Returns the paths configured in the settings
      *
      * @return ResourceConfiguration[]
      */
-    public function getConfiguredResources();
+    public function getConfiguredResources(): array;
 
     /**
      * Returns the configuration matching the given resource type
      *
      * @param ResourceType $resourceType
      * @return ResourceConfiguration|null
      */
-    public function getResourceConfiguration(ResourceType $resourceType);
+    public function getResourceConfiguration(ResourceType $resourceType): ?\Cundd\Rest\Configuration\ResourceConfiguration;
 }