Helper refactoring

This commit is contained in:
Frederic Guillot
2016-03-04 20:10:34 -05:00
parent f32507d423
commit 8f3e2b2e5c
141 changed files with 562 additions and 445 deletions

View File

@@ -5,12 +5,12 @@ namespace Kanboard\Helper;
use Kanboard\Core\Base;
/**
* Application helpers
* Application Helper
*
* @package helper
* @author Frederic Guillot
*/
class App extends Base
class AppHelper extends Base
{
/**
* Get config variable
@@ -116,11 +116,11 @@ class App extends Base
$failure_message = $this->flash->getMessage('failure');
if (! empty($success_message)) {
return '<div class="alert alert-success alert-fade-out">'.$this->helper->e($success_message).'</div>';
return '<div class="alert alert-success alert-fade-out">'.$this->helper->text->e($success_message).'</div>';
}
if (! empty($failure_message)) {
return '<div class="alert alert-error">'.$this->helper->e($failure_message).'</div>';
return '<div class="alert alert-error">'.$this->helper->text->e($failure_message).'</div>';
}
return '';

View File

@@ -2,13 +2,15 @@
namespace Kanboard\Helper;
use Kanboard\Core\Base;
/**
* Assets helpers
* Asset Helper
*
* @package helper
* @author Frederic Guillot
*/
class Asset extends \Kanboard\Core\Base
class AssetHelper extends Base
{
/**
* Add a Javascript asset

View File

@@ -2,13 +2,15 @@
namespace Kanboard\Helper;
use Kanboard\Core\Base;
/**
* Board Helper
*
* @package helper
* @author Frederic Guillot
*/
class Board extends \Kanboard\Core\Base
class BoardHelper extends Base
{
/**
* Return true if tasks are collapsed

View File

@@ -3,6 +3,7 @@
namespace Kanboard\Helper;
use DateTime;
use Kanboard\Core\Base;
/**
* DateTime helpers
@@ -10,7 +11,7 @@ use DateTime;
* @package helper
* @author Frederic Guillot
*/
class Dt extends \Kanboard\Core\Base
class DateHelper extends Base
{
/**
* Get formatted time

View File

@@ -2,13 +2,15 @@
namespace Kanboard\Helper;
use Kanboard\Core\Base;
/**
* File helpers
*
* @package helper
* @author Frederic Guillot
*/
class File extends \Kanboard\Core\Base
class FileHelper extends Base
{
/**
* Get file icon

View File

@@ -10,7 +10,7 @@ use Kanboard\Core\Base;
* @package helper
* @author Frederic Guillot
*/
class Form extends Base
class FormHelper extends Base
{
/**
* Hidden CSRF token field
@@ -52,7 +52,7 @@ class Form extends Base
$html = '<select name="'.$name.'" id="form-'.$name.'" class="'.$class.'" '.implode(' ', $attributes).'>';
foreach ($options as $id => $value) {
$html .= '<option value="'.$this->helper->e($id).'"';
$html .= '<option value="'.$this->helper->text->e($id).'"';
if (isset($values->$name) && $id == $values->$name) {
$html .= ' selected="selected"';
@@ -61,7 +61,7 @@ class Form extends Base
$html .= ' selected="selected"';
}
$html .= '>'.$this->helper->e($value).'</option>';
$html .= '>'.$this->helper->text->e($value).'</option>';
}
$html .= '</select>';
@@ -103,7 +103,7 @@ class Form extends Base
*/
public function radio($name, $label, $value, $selected = false, $class = '')
{
return '<label><input type="radio" name="'.$name.'" class="'.$class.'" value="'.$this->helper->e($value).'" '.($selected ? 'checked="checked"' : '').'> '.$this->helper->e($label).'</label>';
return '<label><input type="radio" name="'.$name.'" class="'.$class.'" value="'.$this->helper->text->e($value).'" '.($selected ? 'checked="checked"' : '').'> '.$this->helper->text->e($label).'</label>';
}
/**
@@ -139,7 +139,7 @@ class Form extends Base
*/
public function checkbox($name, $label, $value, $checked = false, $class = '')
{
return '<label><input type="checkbox" name="'.$name.'" class="'.$class.'" value="'.$this->helper->e($value).'" '.($checked ? 'checked="checked"' : '').'>&nbsp;'.$this->helper->e($label).'</label>';
return '<label><input type="checkbox" name="'.$name.'" class="'.$class.'" value="'.$this->helper->text->e($value).'" '.($checked ? 'checked="checked"' : '').'>&nbsp;'.$this->helper->text->e($label).'</label>';
}
/**
@@ -153,7 +153,7 @@ class Form extends Base
*/
public function label($label, $name, array $attributes = array())
{
return '<label for="form-'.$name.'" '.implode(' ', $attributes).'>'.$this->helper->e($label).'</label>';
return '<label for="form-'.$name.'" '.implode(' ', $attributes).'>'.$this->helper->text->e($label).'</label>';
}
/**
@@ -173,7 +173,7 @@ class Form extends Base
$html = '<textarea name="'.$name.'" id="form-'.$name.'" class="'.$class.'" ';
$html .= implode(' ', $attributes).'>';
$html .= isset($values->$name) ? $this->helper->e($values->$name) : isset($values[$name]) ? $values[$name] : '';
$html .= isset($values->$name) ? $this->helper->text->e($values->$name) : isset($values[$name]) ? $values[$name] : '';
$html .= '</textarea>';
$html .= $this->errorList($errors, $name);
@@ -334,7 +334,7 @@ class Form extends Base
$html .= '<ul class="form-errors">';
foreach ($errors[$name] as $error) {
$html .= '<li>'.$this->helper->e($error).'</li>';
$html .= '<li>'.$this->helper->text->e($error).'</li>';
}
$html .= '</ul>';
@@ -354,9 +354,9 @@ class Form extends Base
private function formValue($values, $name)
{
if (isset($values->$name)) {
return 'value="'.$this->helper->e($values->$name).'"';
return 'value="'.$this->helper->text->e($values->$name).'"';
}
return isset($values[$name]) ? 'value="'.$this->helper->e($values[$name]).'"' : '';
return isset($values[$name]) ? 'value="'.$this->helper->text->e($values[$name]).'"' : '';
}
}

View File

@@ -2,13 +2,15 @@
namespace Kanboard\Helper;
use Kanboard\Core\Base;
/**
* Template Hook helpers
*
* @package helper
* @author Frederic Guillot
*/
class Hook extends \Kanboard\Core\Base
class HookHelper extends Base
{
/**
* Add assets JS or CSS

View File

@@ -10,7 +10,7 @@ use Kanboard\Core\Base;
* @package helper
* @author Frederic Guillot
*/
class Layout extends Base
class LayoutHelper extends Base
{
/**
* Render a template without the layout if Ajax request

View File

@@ -10,7 +10,7 @@ use Kanboard\Core\Base;
* @package helper
* @author Frederic Guillot
*/
class Model extends Base
class ModelHelper extends Base
{
/**
* Remove keys from an array

View File

@@ -2,13 +2,15 @@
namespace Kanboard\Helper;
use Kanboard\Core\Base;
/**
* Subtask helpers
*
* @package helper
* @author Frederic Guillot
*/
class Subtask extends \Kanboard\Core\Base
class SubtaskHelper extends Base
{
public function getTitle(array $subtask)
{
@@ -20,7 +22,7 @@ class Subtask extends \Kanboard\Core\Base
$html = '<i class="fa fa-check-square-o fa-fw"></i>';
}
return $html.$this->helper->e($subtask['title']);
return $html.$this->helper->text->e($subtask['title']);
}
/**

View File

@@ -10,7 +10,7 @@ use Kanboard\Core\Base;
* @package helper
* @author Frederic Guillot
*/
class Task extends Base
class TaskHelper extends Base
{
/**
* Local cache for project columns

View File

@@ -11,8 +11,19 @@ use Kanboard\Core\Base;
* @package helper
* @author Frederic Guillot
*/
class Text extends Base
class TextHelper extends Base
{
/**
* HTML escaping
*
* @param string $value Value to escape
* @return string
*/
public function e($value)
{
return htmlspecialchars($value, ENT_QUOTES, 'UTF-8', false);
}
/**
* Markdown transformation
*
@@ -88,7 +99,7 @@ class Text extends Base
public function in($id, array $listing, $default_value = '?')
{
if (isset($listing[$id])) {
return $this->helper->e($listing[$id]);
return $this->helper->text->e($listing[$id]);
}
return $default_value;

View File

@@ -5,12 +5,12 @@ namespace Kanboard\Helper;
use Kanboard\Core\Base;
/**
* Url helpers
* Url Helper
*
* @package helper
* @author Frederic Guillot
*/
class Url extends Base
class UrlHelper extends Base
{
private $base = '';
private $directory = '';

View File

@@ -2,13 +2,15 @@
namespace Kanboard\Helper;
use Kanboard\Core\Base;
/**
* User helpers
*
* @package helper
* @author Frederic Guillot
*/
class User extends \Kanboard\Core\Base
class UserHelper extends Base
{
/**
* Return true if the logged user as unread notifications
@@ -168,7 +170,7 @@ class User extends \Kanboard\Core\Base
public function avatar($email, $alt = '')
{
if (! empty($email) && $this->config->get('integration_gravatar') == 1) {
return '<img class="avatar" src="https://www.gravatar.com/avatar/'.md5(strtolower($email)).'?s=25" alt="'.$this->helper->e($alt).'" title="'.$this->helper->e($alt).'">';
return '<img class="avatar" src="https://www.gravatar.com/avatar/'.md5(strtolower($email)).'?s=25" alt="'.$this->helper->text->e($alt).'" title="'.$this->helper->text->e($alt).'">';
}
return '';