PHPdoc cleanup

12 files changed, 44 insertions, 15 deletions

diff --git a/app/Core/Base.php b/app/Core/Base.php
index d4ab6c81..e53f299a 100644
--- a/app/Core/Base.php
+++ b/app/Core/Base.php
@@ -31,7 +31,6 @@ use Pimple\Container;
  * @property \Kanboard\Core\ObjectStorage\ObjectStorageInterface        $objectStorage
  * @property \Kanboard\Core\Plugin\Hook                                 $hook
  * @property \Kanboard\Core\Plugin\Loader                               $pluginLoader
- * @property \Kanboard\Core\Security\AccessMap                          $projectAccessMap
  * @property \Kanboard\Core\Security\AuthenticationManager              $authenticationManager
  * @property \Kanboard\Core\Security\AccessMap                          $applicationAccessMap
  * @property \Kanboard\Core\Security\AccessMap                          $projectAccessMap
diff --git a/app/Core/Cache/Base.php b/app/Core/Cache/Base.php
index d62b8507..2879f1f1 100644
--- a/app/Core/Cache/Base.php
+++ b/app/Core/Cache/Base.php
@@ -11,6 +11,26 @@ namespace Kanboard\Core\Cache;
 abstract class Base
 {
     /**
+     * Fetch value from cache
+     *
+     * @abstract
+     * @access public
+     * @param  string  $key
+     * @return mixed            Null when not found, cached value otherwise
+     */
+    abstract public function get($key);
+
+    /**
+     * Save a new value in the cache
+     *
+     * @abstract
+     * @access public
+     * @param  string  $key
+     * @param  mixed   $value
+     */
+    abstract public function set($key, $value);
+
+    /**
      * Proxy cache
      *
      * Note: Arguments must be scalar types
diff --git a/app/Core/Csv.php b/app/Core/Csv.php
index e45af24c..88010166 100644
--- a/app/Core/Csv.php
+++ b/app/Core/Csv.php
@@ -87,7 +87,8 @@ class Csv
      *
      * @static
      * @access public
-     * @return integer
+     * @param  mixed $value
+     * @return int
      */
     public static function getBooleanValue($value)
     {
diff --git a/app/Core/Ldap/Client.php b/app/Core/Ldap/Client.php
index 63149ae3..e35e4ea0 100644
--- a/app/Core/Ldap/Client.php
+++ b/app/Core/Ldap/Client.php
@@ -60,6 +60,7 @@ class Client
      * Establish server connection
      *
      * @access public
+     * @throws ClientException
      * @param  string   $server  LDAP server hostname or IP
      * @param  integer  $port    LDAP port
      * @param  boolean  $tls     Start TLS
@@ -98,6 +99,7 @@ class Client
      * Anonymous authentication
      *
      * @access public
+     * @throws ClientException
      * @return boolean
      */
     public function useAnonymousAuthentication()
@@ -113,6 +115,7 @@ class Client
      * Authentication with username/password
      *
      * @access public
+     * @throws ClientException
      * @param  string  $bind_rdn
      * @param  string  $bind_password
      * @return boolean
diff --git a/app/Core/Ldap/Query.php b/app/Core/Ldap/Query.php
index e03495ec..1779fa61 100644
--- a/app/Core/Ldap/Query.php
+++ b/app/Core/Ldap/Query.php
@@ -78,7 +78,7 @@ class Query
      * Get LDAP Entries
      *
      * @access public
-     * @return Entities
+     * @return Entries
      */
     public function getEntries()
     {
diff --git a/app/Core/Mail/Client.php b/app/Core/Mail/Client.php
index e1f31696..641b6abe 100644
--- a/app/Core/Mail/Client.php
+++ b/app/Core/Mail/Client.php
@@ -41,7 +41,7 @@ class Client extends Base
      * @param  string  $name
      * @param  string  $subject
      * @param  string  $html
-     * @return EmailClient
+     * @return Client
      */
     public function send($email, $name, $subject, $html)
     {
@@ -70,7 +70,7 @@ class Client extends Base
      *
      * @access public
      * @param  string  $transport
-     * @return EmailClientInterface
+     * @return ClientInterface
      */
     public function getTransport($transport)
     {
@@ -83,7 +83,7 @@ class Client extends Base
      * @access public
      * @param  string  $transport
      * @param  string  $class
-     * @return EmailClient
+     * @return Client
      */
     public function setTransport($transport, $class)
     {
diff --git a/app/Core/ObjectStorage/FileStorage.php b/app/Core/ObjectStorage/FileStorage.php
index dd049ca2..18453890 100644
--- a/app/Core/ObjectStorage/FileStorage.php
+++ b/app/Core/ObjectStorage/FileStorage.php
@@ -33,6 +33,7 @@ class FileStorage implements ObjectStorageInterface
      * Fetch object contents
      *
      * @access public
+     * @throws ObjectStorageException
      * @param  string  $key
      * @return string
      */
@@ -51,6 +52,7 @@ class FileStorage implements ObjectStorageInterface
      * Save object
      *
      * @access public
+     * @throws ObjectStorageException
      * @param  string  $key
      * @param  string  $blob
      */
@@ -67,6 +69,7 @@ class FileStorage implements ObjectStorageInterface
      * Output directly object content
      *
      * @access public
+     * @throws ObjectStorageException
      * @param  string  $key
      */
     public function output($key)
@@ -84,6 +87,7 @@ class FileStorage implements ObjectStorageInterface
      * Move local file to object storage
      *
      * @access public
+     * @throws ObjectStorageException
      * @param  string  $src_filename
      * @param  string  $key
      * @return boolean
@@ -136,6 +140,7 @@ class FileStorage implements ObjectStorageInterface
      * Create object folder
      *
      * @access private
+     * @throws ObjectStorageException
      * @param  string  $key
      */
     private function createFolder($key)
diff --git a/app/Core/Plugin/Loader.php b/app/Core/Plugin/Loader.php
index 530d9b40..ff4f2c14 100644
--- a/app/Core/Plugin/Loader.php
+++ b/app/Core/Plugin/Loader.php
@@ -55,6 +55,7 @@ class Loader extends \Kanboard\Core\Base
      * Load plugin
      *
      * @access public
+     * @throws LogicException
      * @param  string $plugin
      */
     public function load($plugin)
diff --git a/app/Core/Security/AccessMap.php b/app/Core/Security/AccessMap.php
index f34c4b00..2431a921 100644
--- a/app/Core/Security/AccessMap.php
+++ b/app/Core/Security/AccessMap.php
@@ -39,7 +39,7 @@ class AccessMap
      *
      * @access public
      * @param  string $role
-     * @return Acl
+     * @return AccessMap
      */
     public function setDefaultRole($role)
     {
@@ -53,7 +53,7 @@ class AccessMap
      * @access public
      * @param  string $role
      * @param  array  $subroles
-     * @return Acl
+     * @return AccessMap
      */
     public function setRoleHierarchy($role, array $subroles)
     {
@@ -113,7 +113,7 @@ class AccessMap
      * @param  string $controller  Controller class name
      * @param  mixed  $methods     List of method name or just one method
      * @param  string $role        Lowest role required
-     * @return Acl
+     * @return AccessMap
      */
     public function add($controller, $methods, $role)
     {
@@ -135,7 +135,7 @@ class AccessMap
      * @param  string $controller
      * @param  string $method
      * @param  string $role
-     * @return Acl
+     * @return AccessMap
      */
     private function addRule($controller, $method, $role)
     {
@@ -157,7 +157,7 @@ class AccessMap
      * @access public
      * @param  string $controller
      * @param  string $method
-     * @return boolean
+     * @return array
      */
     public function getRoles($controller, $method)
     {
diff --git a/app/Core/Security/OAuthAuthenticationProviderInterface.php b/app/Core/Security/OAuthAuthenticationProviderInterface.php
index c32339e0..3092672d 100644
--- a/app/Core/Security/OAuthAuthenticationProviderInterface.php
+++ b/app/Core/Security/OAuthAuthenticationProviderInterface.php
@@ -14,7 +14,7 @@ interface OAuthAuthenticationProviderInterface extends AuthenticationProviderInt
      * Get user object
      *
      * @access public
-     * @return UserProviderInterface
+     * @return \Kanboard\Core\User\UserProviderInterface
      */
     public function getUser();
 
@@ -31,7 +31,7 @@ interface OAuthAuthenticationProviderInterface extends AuthenticationProviderInt
      * Get configured OAuth2 service
      *
      * @access public
-     * @return Kanboard\Core\Http\OAuth2
+     * @return \Kanboard\Core\Http\OAuth2
      */
     public function getService();
 
diff --git a/app/Core/Security/PasswordAuthenticationProviderInterface.php b/app/Core/Security/PasswordAuthenticationProviderInterface.php
index 918a4aec..c2304546 100644
--- a/app/Core/Security/PasswordAuthenticationProviderInterface.php
+++ b/app/Core/Security/PasswordAuthenticationProviderInterface.php
@@ -14,7 +14,7 @@ interface PasswordAuthenticationProviderInterface extends AuthenticationProvider
      * Get user object
      *
      * @access public
-     * @return UserProviderInterface
+     * @return \Kanboard\Core\User\UserProviderInterface
      */
     public function getUser();
 
diff --git a/app/Core/Security/PreAuthenticationProviderInterface.php b/app/Core/Security/PreAuthenticationProviderInterface.php
index 391e8d0f..c13b06c5 100644
--- a/app/Core/Security/PreAuthenticationProviderInterface.php
+++ b/app/Core/Security/PreAuthenticationProviderInterface.php
@@ -14,7 +14,7 @@ interface PreAuthenticationProviderInterface extends AuthenticationProviderInter
      * Get user object
      *
      * @access public
-     * @return UserProviderInterface
+     * @return \Kanboard\Core\User\UserProviderInterface
      */
     public function getUser();
 }