AS1024
/
Kanboard-Prod
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Better documentation 

These changes have been automatically suggested by scrutinizer-ci.com
This commit is contained in:
Raphaël Doursenaud 2014-04-22 15:08:18 +02:00
parent 919e5d51a4
commit d156c47f09
14 changed files with 30 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
actions/task_assign_color_user.php
View File

@ -17,7 +17,7 @@ class TaskAssignColorUser extends Base
*
* @access public
* @param integer $project_id Project id
* @param Task $task Task model instance
* @param \Model\Task $task Task model instance
*/
public function __construct($project_id, \Model\Task $task)
{
@ -44,7 +44,7 @@ class TaskAssignColorUser extends Base
* Get the required parameter for the event
*
* @access public
* @return array
* @return string[]
*/
public function getEventRequiredParameters()
{

6
actions/task_assign_current_user.php
View File

@ -17,8 +17,8 @@ class TaskAssignCurrentUser extends Base
*
* @access public
* @param integer $project_id Project id
* @param Task $task Task model instance
* @param Acl $acl Acl model instance
* @param \Model\Task $task Task model instance
* @param \Model\Acl $acl Acl model instance
*/
public function __construct($project_id, \Model\Task $task, \Model\Acl $acl)
{
@ -44,7 +44,7 @@ class TaskAssignCurrentUser extends Base
* Get the required parameter for the event
*
* @access public
* @return array
* @return string[]
*/
public function getEventRequiredParameters()
{

4
actions/task_assign_specific_user.php
View File

@ -17,7 +17,7 @@ class TaskAssignSpecificUser extends Base
*
* @access public
* @param integer $project_id Project id
* @param Task $task Task model instance
* @param \Model\Task $task Task model instance
*/
public function __construct($project_id, \Model\Task $task)
{
@ -43,7 +43,7 @@ class TaskAssignSpecificUser extends Base
* Get the required parameter for the event
*
* @access public
* @return array
* @return string[]
*/
public function getEventRequiredParameters()
{

4
actions/task_close.php
View File

@ -17,7 +17,7 @@ class TaskClose extends Base
*
* @access public
* @param integer $project_id Project id
* @param Task $task Task model instance
* @param \Model\Task $task Task model instance
*/
public function __construct($project_id, \Model\Task $task)
{
@ -42,7 +42,7 @@ class TaskClose extends Base
* Get the required parameter for the event
*
* @access public
* @return array
* @return string[]
*/
public function getEventRequiredParameters()
{

4
actions/task_duplicate_another_project.php
View File

@ -17,7 +17,7 @@ class TaskDuplicateAnotherProject extends Base
*
* @access public
* @param integer $project_id Project id
* @param Task $task Task model instance
* @param \Model\Task $task Task model instance
*/
public function __construct($project_id, \Model\Task $task)
{
@ -43,7 +43,7 @@ class TaskDuplicateAnotherProject extends Base
* Get the required parameter for the event
*
* @access public
* @return array
* @return string[]
*/
public function getEventRequiredParameters()
{

2
controllers/base.php
View File

@ -14,7 +14,7 @@ abstract class Base
* Constructor
*
* @access public
* @param Core\Registry $registry
* @param \Core\Registry $registry
*/
public function __construct(\Core\Registry $registry)
{

4
core/event.php
View File

@ -9,6 +9,10 @@ namespace Core;
* @author Frederic Guillot
*/
interface Listener {
/**
* @return boolean
*/
public function execute(array $data);
}

3
core/response.php
View File

@ -9,6 +9,9 @@ class Response
header('Content-Disposition: attachment; filename="'.$filename.'"');
}
/**
* @param integer $status_code
*/
public function status($status_code)
{
if (strpos(php_sapi_name(), 'apache') !== false) {

7
core/router.php
View File

@ -20,11 +20,18 @@ class Router
$this->action = empty($_GET['action']) ? $controller : $_GET['action'];
}
/**
* @param string $default_value
*/
public function sanitize($value, $default_value)
{
return ! ctype_alpha($value) || empty($value) ? $default_value : strtolower($value);
}
/**
* @param string $filename
* @param string $class
*/
public function load($filename, $class, $method)
{
if (file_exists($filename)) {

2
models/acl.php
View File

@ -110,7 +110,7 @@ class Acl extends Base
* Get the connected user id
*
* @access public
* @return bool
* @return integer
*/
public function getUserId()
{

2
models/base.php
View File

@ -43,7 +43,7 @@ abstract class Base
*
* @access public
* @param PicoDb\Database $db Database instance
* @param Core\Event $event Event dispatcher instance
* @param \Core\Event $event Event dispatcher instance
*/
public function __construct(\PicoDb\Database $db, \Core\Event $event)
{

2
models/config.php
View File

@ -60,7 +60,7 @@ class Config extends Base
*
* @access public
* @param string $name Parameter name
* @param mixed $default_value Default value of the parameter
* @param string $default_value Default value of the parameter
* @return mixed
*/
public function get($name, $default_value = '')

2
models/ldap.php
View File

@ -18,7 +18,7 @@ class Ldap extends Base
* @access public
* @param string $username Username
* @param string $password Password
* @return bool
* @return null|boolean
*/
public function authenticate($username, $password)
{

1
models/remember_me.php
View File

@ -37,7 +37,6 @@ class RememberMe extends Base
* Get a remember me record
*
* @access public
* @param integer $user_id User id
* @return mixed
*/
public function find($token, $sequence)