Fix some phpdoc and remove useless code

This commit is contained in:
Frederic Guillot 2015-09-20 18:44:51 -04:00
parent e6f547abcf
commit f579663adc
9 changed files with 75 additions and 91 deletions

View File

@ -144,6 +144,7 @@ class Ldap extends Base
* Get LDAP username pattern
*
* @access public
* @param string $username
* @return string
*/
public function getLdapUserPattern($username)

View File

@ -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
{

View File

@ -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
*/

View File

@ -45,6 +45,7 @@ class Loader extends \Core\Base
* Load plugin
*
* @access public
* @param string $plugin
*/
public function load($plugin)
{

View File

@ -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 = '')
{

View File

@ -2,8 +2,6 @@
namespace Core;
use LogicException;
/**
* Template class
*

View File

@ -12,26 +12,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
*

View File

@ -55,7 +55,7 @@ class Subtask extends Base
* Get available status
*
* @access public
* @return array
* @return string[]
*/
public function getStatusList()
{

View File

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