PHPdoc cleanup

2016-03-04 21:11:12 -05:00
parent 3808209690
commit a7f3e3bec5
42 changed files with 97 additions and 51 deletions
--- 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
--- a/app/Core/Cache/Base.php
+++ b/app/Core/Cache/Base.php
@@ -10,6 +10,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
     *
--- 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)
    {
--- 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
--- 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()
    {
--- 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)
    {
--- 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)
--- 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)
--- 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)
    {
--- 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();

--- 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();

--- 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();
 }