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 * Get LDAP username pattern
* *
* @access public * @access public
* @param string $username
* @return string * @return string
*/ */
public function getLdapUserPattern($username) public function getLdapUserPattern($username)

View File

@@ -10,70 +10,75 @@ use Pimple\Container;
* @package core * @package core
* @author Frederic Guillot * @author Frederic Guillot
* *
* @property \Core\Helper $helper * @property \Core\Helper $helper
* @property \Core\EmailClient $emailClient * @property \Core\EmailClient $emailClient
* @property \Core\HttpClient $httpClient * @property \Core\HttpClient $httpClient
* @property \Core\Paginator $paginator * @property \Core\Paginator $paginator
* @property \Core\Request $request * @property \Core\Request $request
* @property \Core\Session $session * @property \Core\Session $session
* @property \Core\Template $template * @property \Core\Template $template
* @property \Core\MemoryCache $memoryCache * @property \Core\OAuth2 $oauth
* @property \Core\OAuth2 $oauth * @property \Core\Router $router
* @property \Core\Router $router * @property \Core\Lexer $lexer
* @property \Core\Lexer $lexer * @property \Core\ObjectStorage\ObjectStorageInterface $objectStorage
* @property \Integration\BitbucketWebhook $bitbucketWebhook * @property \Core\Cache\Cache $memoryCache
* @property \Integration\GithubWebhook $githubWebhook * @property \Core\Plugin\Hook $hook
* @property \Integration\GitlabWebhook $gitlabWebhook * @property \Integration\BitbucketWebhook $bitbucketWebhook
* @property \Integration\HipchatWebhook $hipchatWebhook * @property \Integration\GithubWebhook $githubWebhook
* @property \Integration\Jabber $jabber * @property \Integration\GitlabWebhook $gitlabWebhook
* @property \Integration\Mailgun $mailgun * @property \Integration\HipchatWebhook $hipchatWebhook
* @property \Integration\Postmark $postmark * @property \Integration\Jabber $jabber
* @property \Integration\Sendgrid $sendgrid * @property \Integration\Mailgun $mailgun
* @property \Integration\SlackWebhook $slackWebhook * @property \Integration\Postmark $postmark
* @property \Integration\Smtp $smtp * @property \Integration\Sendgrid $sendgrid
* @property \Model\Acl $acl * @property \Integration\SlackWebhook $slackWebhook
* @property \Model\Action $action * @property \Integration\Smtp $smtp
* @property \Model\Authentication $authentication * @property \Model\Acl $acl
* @property \Model\Board $board * @property \Model\Action $action
* @property \Model\Category $category * @property \Model\Authentication $authentication
* @property \Model\Color $color * @property \Model\Board $board
* @property \Model\Comment $comment * @property \Model\Category $category
* @property \Model\Config $config * @property \Model\Color $color
* @property \Model\Currency $currency * @property \Model\Comment $comment
* @property \Model\DateParser $dateParser * @property \Model\Config $config
* @property \Model\File $file * @property \Model\Currency $currency
* @property \Model\LastLogin $lastLogin * @property \Model\DateParser $dateParser
* @property \Model\Link $link * @property \Model\File $file
* @property \Model\Notification $notification * @property \Model\LastLogin $lastLogin
* @property \Model\Project $project * @property \Model\Link $link
* @property \Model\ProjectActivity $projectActivity * @property \Model\Notification $notification
* @property \Model\ProjectAnalytic $projectAnalytic * @property \Model\Project $project
* @property \Model\ProjectDuplication $projectDuplication * @property \Model\ProjectActivity $projectActivity
* @property \Model\ProjectDailyColumnStats $projectDailyColumnStats * @property \Model\ProjectAnalytic $projectAnalytic
* @property \Model\ProjectDailyStats $projectDailyStats * @property \Model\ProjectDuplication $projectDuplication
* @property \Model\ProjectIntegration $projectIntegration * @property \Model\ProjectDailyColumnStats $projectDailyColumnStats
* @property \Model\ProjectPermission $projectPermission * @property \Model\ProjectDailyStats $projectDailyStats
* @property \Model\Subtask $subtask * @property \Model\ProjectIntegration $projectIntegration
* @property \Model\SubtaskExport $subtaskExport * @property \Model\ProjectPermission $projectPermission
* @property \Model\SubtaskTimeTracking $subtaskTimeTracking * @property \Model\Subtask $subtask
* @property \Model\Swimlane $swimlane * @property \Model\SubtaskExport $subtaskExport
* @property \Model\Task $task * @property \Model\SubtaskTimeTracking $subtaskTimeTracking
* @property \Model\TaskAnalytic $taskAnalytic * @property \Model\Swimlane $swimlane
* @property \Model\TaskCreation $taskCreation * @property \Model\Task $task
* @property \Model\TaskDuplication $taskDuplication * @property \Model\TaskAnalytic $taskAnalytic
* @property \Model\TaskExport $taskExport * @property \Model\TaskCreation $taskCreation
* @property \Model\TaskFinder $taskFinder * @property \Model\TaskDuplication $taskDuplication
* @property \Model\TaskFilter $taskFilter * @property \Model\TaskExport $taskExport
* @property \Model\TaskLink $taskLink * @property \Model\TaskFinder $taskFinder
* @property \Model\TaskModification $taskModification * @property \Model\TaskFilter $taskFilter
* @property \Model\TaskPermission $taskPermission * @property \Model\TaskLink $taskLink
* @property \Model\TaskPosition $taskPosition * @property \Model\TaskModification $taskModification
* @property \Model\TaskStatus $taskStatus * @property \Model\TaskPermission $taskPermission
* @property \Model\TaskValidator $taskValidator * @property \Model\TaskPosition $taskPosition
* @property \Model\Transition $transition * @property \Model\TaskStatus $taskStatus
* @property \Model\User $user * @property \Model\TaskValidator $taskValidator
* @property \Model\UserSession $userSession * @property \Model\Transition $transition
* @property \Model\Webhook $webhook * @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 abstract class Base
{ {

View File

@@ -85,7 +85,7 @@ class FileStorage implements ObjectStorageInterface
* Move local file to object storage * Move local file to object storage
* *
* @access public * @access public
* @param string $filename * @param string $src_filename
* @param string $key * @param string $key
* @return boolean * @return boolean
*/ */

View File

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

View File

@@ -206,7 +206,6 @@ class Router extends Base
* @access public * @access public
* @param string $uri * @param string $uri
* @param string $query_string * @param string $query_string
* @return boolean
*/ */
public function dispatch($uri, $query_string = '') public function dispatch($uri, $query_string = '')
{ {

View File

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

View File

@@ -12,26 +12,6 @@ use Pimple\Container;
*/ */
abstract class Base extends \Core\Base 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 * Save a record in the database
* *

View File

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

View File

@@ -103,11 +103,11 @@ class ClassProvider implements ServiceProviderInterface
return new OAuth2($c); return new OAuth2($c);
}); });
$container['htmlConverter'] = function($c) { $container['htmlConverter'] = function() {
return new HtmlConverter(array('strip_tags' => true)); return new HtmlConverter(array('strip_tags' => true));
}; };
$container['objectStorage'] = function($c) { $container['objectStorage'] = function() {
return new FileStorage(FILES_DIR); return new FileStorage(FILES_DIR);
}; };
} }