summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2015-09-20 18:44:51 -0400
committerFrederic Guillot <fred@kanboard.net>2015-09-20 18:44:51 -0400
commitf579663adcbc0b202d9a068d734e8f9284dc3a37 (patch)
tree150f71842dee501d369c342c4d9a8c1e93efed91
parente6f547abcfe684658a7498391db72d13b6aa7d9a (diff)
Fix some phpdoc and remove useless code
-rw-r--r--app/Auth/Ldap.php1
-rw-r--r--app/Core/Base.php133
-rw-r--r--app/Core/ObjectStorage/FileStorage.php2
-rw-r--r--app/Core/Plugin/Loader.php1
-rw-r--r--app/Core/Router.php1
-rw-r--r--app/Core/Template.php2
-rw-r--r--app/Model/Base.php20
-rw-r--r--app/Model/Subtask.php2
-rw-r--r--app/ServiceProvider/ClassProvider.php4
9 files changed, 75 insertions, 91 deletions
diff --git a/app/Auth/Ldap.php b/app/Auth/Ldap.php
index 0ccd09a4..a3c7522c 100644
--- a/app/Auth/Ldap.php
+++ b/app/Auth/Ldap.php
@@ -144,6 +144,7 @@ class Ldap extends Base
* Get LDAP username pattern
*
* @access public
+ * @param string $username
* @return string
*/
public function getLdapUserPattern($username)
diff --git a/app/Core/Base.php b/app/Core/Base.php
index ba925ebe..be5052b6 100644
--- a/app/Core/Base.php
+++ b/app/Core/Base.php
@@ -10,70 +10,75 @@ use Pimple\Container;
* @package core
* @author Frederic Guillot
*
- * @property \Core\Helper $helper
- * @property \Core\EmailClient $emailClient
- * @property \Core\HttpClient $httpClient
- * @property \Core\Paginator $paginator
- * @property \Core\Request $request
- * @property \Core\Session $session
- * @property \Core\Template $template
- * @property \Core\MemoryCache $memoryCache
- * @property \Core\OAuth2 $oauth
- * @property \Core\Router $router
- * @property \Core\Lexer $lexer
- * @property \Integration\BitbucketWebhook $bitbucketWebhook
- * @property \Integration\GithubWebhook $githubWebhook
- * @property \Integration\GitlabWebhook $gitlabWebhook
- * @property \Integration\HipchatWebhook $hipchatWebhook
- * @property \Integration\Jabber $jabber
- * @property \Integration\Mailgun $mailgun
- * @property \Integration\Postmark $postmark
- * @property \Integration\Sendgrid $sendgrid
- * @property \Integration\SlackWebhook $slackWebhook
- * @property \Integration\Smtp $smtp
- * @property \Model\Acl $acl
- * @property \Model\Action $action
- * @property \Model\Authentication $authentication
- * @property \Model\Board $board
- * @property \Model\Category $category
- * @property \Model\Color $color
- * @property \Model\Comment $comment
- * @property \Model\Config $config
- * @property \Model\Currency $currency
- * @property \Model\DateParser $dateParser
- * @property \Model\File $file
- * @property \Model\LastLogin $lastLogin
- * @property \Model\Link $link
- * @property \Model\Notification $notification
- * @property \Model\Project $project
- * @property \Model\ProjectActivity $projectActivity
- * @property \Model\ProjectAnalytic $projectAnalytic
- * @property \Model\ProjectDuplication $projectDuplication
- * @property \Model\ProjectDailyColumnStats $projectDailyColumnStats
- * @property \Model\ProjectDailyStats $projectDailyStats
- * @property \Model\ProjectIntegration $projectIntegration
- * @property \Model\ProjectPermission $projectPermission
- * @property \Model\Subtask $subtask
- * @property \Model\SubtaskExport $subtaskExport
- * @property \Model\SubtaskTimeTracking $subtaskTimeTracking
- * @property \Model\Swimlane $swimlane
- * @property \Model\Task $task
- * @property \Model\TaskAnalytic $taskAnalytic
- * @property \Model\TaskCreation $taskCreation
- * @property \Model\TaskDuplication $taskDuplication
- * @property \Model\TaskExport $taskExport
- * @property \Model\TaskFinder $taskFinder
- * @property \Model\TaskFilter $taskFilter
- * @property \Model\TaskLink $taskLink
- * @property \Model\TaskModification $taskModification
- * @property \Model\TaskPermission $taskPermission
- * @property \Model\TaskPosition $taskPosition
- * @property \Model\TaskStatus $taskStatus
- * @property \Model\TaskValidator $taskValidator
- * @property \Model\Transition $transition
- * @property \Model\User $user
- * @property \Model\UserSession $userSession
- * @property \Model\Webhook $webhook
+ * @property \Core\Helper $helper
+ * @property \Core\EmailClient $emailClient
+ * @property \Core\HttpClient $httpClient
+ * @property \Core\Paginator $paginator
+ * @property \Core\Request $request
+ * @property \Core\Session $session
+ * @property \Core\Template $template
+ * @property \Core\OAuth2 $oauth
+ * @property \Core\Router $router
+ * @property \Core\Lexer $lexer
+ * @property \Core\ObjectStorage\ObjectStorageInterface $objectStorage
+ * @property \Core\Cache\Cache $memoryCache
+ * @property \Core\Plugin\Hook $hook
+ * @property \Integration\BitbucketWebhook $bitbucketWebhook
+ * @property \Integration\GithubWebhook $githubWebhook
+ * @property \Integration\GitlabWebhook $gitlabWebhook
+ * @property \Integration\HipchatWebhook $hipchatWebhook
+ * @property \Integration\Jabber $jabber
+ * @property \Integration\Mailgun $mailgun
+ * @property \Integration\Postmark $postmark
+ * @property \Integration\Sendgrid $sendgrid
+ * @property \Integration\SlackWebhook $slackWebhook
+ * @property \Integration\Smtp $smtp
+ * @property \Model\Acl $acl
+ * @property \Model\Action $action
+ * @property \Model\Authentication $authentication
+ * @property \Model\Board $board
+ * @property \Model\Category $category
+ * @property \Model\Color $color
+ * @property \Model\Comment $comment
+ * @property \Model\Config $config
+ * @property \Model\Currency $currency
+ * @property \Model\DateParser $dateParser
+ * @property \Model\File $file
+ * @property \Model\LastLogin $lastLogin
+ * @property \Model\Link $link
+ * @property \Model\Notification $notification
+ * @property \Model\Project $project
+ * @property \Model\ProjectActivity $projectActivity
+ * @property \Model\ProjectAnalytic $projectAnalytic
+ * @property \Model\ProjectDuplication $projectDuplication
+ * @property \Model\ProjectDailyColumnStats $projectDailyColumnStats
+ * @property \Model\ProjectDailyStats $projectDailyStats
+ * @property \Model\ProjectIntegration $projectIntegration
+ * @property \Model\ProjectPermission $projectPermission
+ * @property \Model\Subtask $subtask
+ * @property \Model\SubtaskExport $subtaskExport
+ * @property \Model\SubtaskTimeTracking $subtaskTimeTracking
+ * @property \Model\Swimlane $swimlane
+ * @property \Model\Task $task
+ * @property \Model\TaskAnalytic $taskAnalytic
+ * @property \Model\TaskCreation $taskCreation
+ * @property \Model\TaskDuplication $taskDuplication
+ * @property \Model\TaskExport $taskExport
+ * @property \Model\TaskFinder $taskFinder
+ * @property \Model\TaskFilter $taskFilter
+ * @property \Model\TaskLink $taskLink
+ * @property \Model\TaskModification $taskModification
+ * @property \Model\TaskPermission $taskPermission
+ * @property \Model\TaskPosition $taskPosition
+ * @property \Model\TaskStatus $taskStatus
+ * @property \Model\TaskValidator $taskValidator
+ * @property \Model\Transition $transition
+ * @property \Model\User $user
+ * @property \Model\UserSession $userSession
+ * @property \Model\Webhook $webhook
+ * @property \Psr\Log\LoggerInterface $logger
+ * @property \League\HTMLToMarkdown\HtmlConverter $htmlConverter
+ * @property \PicoDb\Database $db
*/
abstract class Base
{
diff --git a/app/Core/ObjectStorage/FileStorage.php b/app/Core/ObjectStorage/FileStorage.php
index 66c62334..96478c3a 100644
--- a/app/Core/ObjectStorage/FileStorage.php
+++ b/app/Core/ObjectStorage/FileStorage.php
@@ -85,7 +85,7 @@ class FileStorage implements ObjectStorageInterface
* Move local file to object storage
*
* @access public
- * @param string $filename
+ * @param string $src_filename
* @param string $key
* @return boolean
*/
diff --git a/app/Core/Plugin/Loader.php b/app/Core/Plugin/Loader.php
index 45da135b..2758f37e 100644
--- a/app/Core/Plugin/Loader.php
+++ b/app/Core/Plugin/Loader.php
@@ -45,6 +45,7 @@ class Loader extends \Core\Base
* Load plugin
*
* @access public
+ * @param string $plugin
*/
public function load($plugin)
{
diff --git a/app/Core/Router.php b/app/Core/Router.php
index 902c7de6..f1cdc040 100644
--- a/app/Core/Router.php
+++ b/app/Core/Router.php
@@ -206,7 +206,6 @@ class Router extends Base
* @access public
* @param string $uri
* @param string $query_string
- * @return boolean
*/
public function dispatch($uri, $query_string = '')
{
diff --git a/app/Core/Template.php b/app/Core/Template.php
index b75f7da1..9ca904de 100644
--- a/app/Core/Template.php
+++ b/app/Core/Template.php
@@ -2,8 +2,6 @@
namespace Core;
-use LogicException;
-
/**
* Template class
*
diff --git a/app/Model/Base.php b/app/Model/Base.php
index e700f326..3ee60844 100644
--- a/app/Model/Base.php
+++ b/app/Model/Base.php
@@ -13,26 +13,6 @@ use Pimple\Container;
abstract class Base extends \Core\Base
{
/**
- * Database instance
- *
- * @access protected
- * @var \PicoDb\Database
- */
- protected $db;
-
- /**
- * Constructor
- *
- * @access public
- * @param \Pimple\Container $container
- */
- public function __construct(Container $container)
- {
- $this->container = $container;
- $this->db = $this->container['db'];
- }
-
- /**
* Save a record in the database
*
* @access public
diff --git a/app/Model/Subtask.php b/app/Model/Subtask.php
index 24508c91..95e60bce 100644
--- a/app/Model/Subtask.php
+++ b/app/Model/Subtask.php
@@ -55,7 +55,7 @@ class Subtask extends Base
* Get available status
*
* @access public
- * @return array
+ * @return string[]
*/
public function getStatusList()
{
diff --git a/app/ServiceProvider/ClassProvider.php b/app/ServiceProvider/ClassProvider.php
index e72d880a..5a8eeea4 100644
--- a/app/ServiceProvider/ClassProvider.php
+++ b/app/ServiceProvider/ClassProvider.php
@@ -103,11 +103,11 @@ class ClassProvider implements ServiceProviderInterface
return new OAuth2($c);
});
- $container['htmlConverter'] = function($c) {
+ $container['htmlConverter'] = function() {
return new HtmlConverter(array('strip_tags' => true));
};
- $container['objectStorage'] = function($c) {
+ $container['objectStorage'] = function() {
return new FileStorage(FILES_DIR);
};
}