mirror/php-htmlpurifier
1
0
Fork 0
mirror of https://github.com/ezyang/htmlpurifier.git synced 2025-07-30 19:00:10 +02:00
Code Issues Releases Wiki Activity

PSR-2 reformatting PHPDoc corrections

Browse Source 
With minor corrections.

Signed-off-by: Marcus Bointon <marcus@synchromedia.co.uk>
Signed-off-by: Edward Z. Yang <ezyang@mit.edu>
This commit is contained in:
Marcus Bointon
2013-07-16 13:56:14 +02:00
committed by Edward Z. Yang
parent 19eee14899
commit fac747bdbd
433 changed files with 13302 additions and 6690 deletions
Download Patch File Download Diff File Expand all files Collapse all files

134
library/HTMLPurifier/Printer.php
View File

@@ -7,25 +7,30 @@ class HTMLPurifier_Printer
{
/**
* Instance of HTMLPurifier_Generator for HTML generation convenience funcs
* For HTML generation convenience funcs.
* @type HTMLPurifier_Generator
*/
protected $generator;
/**
* Instance of HTMLPurifier_Config, for easy access
* For easy access.
* @type HTMLPurifier_Config
*/
protected $config;
/**
* Initialize $generator.
*/
public function __construct() {
public function __construct()
{
}
/**
* Give generator necessary configuration if possible
* @param HTMLPurifier_Config $config
*/
public function prepareGenerator($config) {
public function prepareGenerator($config)
{
$all = $config->getAll();
$context = new HTMLPurifier_Context();
$this->generator = new HTMLPurifier_Generator($config, $context);
@@ -39,45 +44,62 @@ class HTMLPurifier_Printer
/**
* Returns a start tag
* @param $tag Tag name
* @param $attr Attribute array
* @param string $tag Tag name
* @param array $attr Attribute array
* @return string
*/
protected function start($tag, $attr = array()) {
protected function start($tag, $attr = array())
{
return $this->generator->generateFromToken(
new HTMLPurifier_Token_Start($tag, $attr ? $attr : array())
);
new HTMLPurifier_Token_Start($tag, $attr ? $attr : array())
);
}
/**
* Returns an end teg
* @param $tag Tag name
* Returns an end tag
* @param string $tag Tag name
* @return string
*/
protected function end($tag) {
protected function end($tag)
{
return $this->generator->generateFromToken(
new HTMLPurifier_Token_End($tag)
);
new HTMLPurifier_Token_End($tag)
);
}
/**
* Prints a complete element with content inside
* @param $tag Tag name
* @param $contents Element contents
* @param $attr Tag attributes
* @param $escape Bool whether or not to escape contents
* @param string $tag Tag name
* @param string $contents Element contents
* @param array $attr Tag attributes
* @param bool $escape whether or not to escape contents
* @return string
*/
protected function element($tag, $contents, $attr = array(), $escape = true) {
protected function element($tag, $contents, $attr = array(), $escape = true)
{
return $this->start($tag, $attr) .
($escape ? $this->escape($contents) : $contents) .
$this->end($tag);
($escape ? $this->escape($contents) : $contents) .
$this->end($tag);
}
protected function elementEmpty($tag, $attr = array()) {
/**
* @param string $tag
* @param array $attr
* @return string
*/
protected function elementEmpty($tag, $attr = array())
{
return $this->generator->generateFromToken(
new HTMLPurifier_Token_Empty($tag, $attr)
);
}
protected function text($text) {
/**
* @param string $text
* @return string
*/
protected function text($text)
{
return $this->generator->generateFromToken(
new HTMLPurifier_Token_Text($text)
);
@@ -85,24 +107,29 @@ class HTMLPurifier_Printer
/**
* Prints a simple key/value row in a table.
* @param $name Key
* @param $value Value
* @param string $name Key
* @param mixed $value Value
* @return string
*/
protected function row($name, $value) {
if (is_bool($value)) $value = $value ? 'On' : 'Off';
protected function row($name, $value)
{
if (is_bool($value)) {
$value = $value ? 'On' : 'Off';
}
return
$this->start('tr') . "\n" .
$this->element('th', $name) . "\n" .
$this->element('td', $value) . "\n" .
$this->end('tr')
;
$this->element('th', $name) . "\n" .
$this->element('td', $value) . "\n" .
$this->end('tr');
}
/**
* Escapes a string for HTML output.
* @param $string String to escape
* @param string $string String to escape
* @return string
*/
protected function escape($string) {
protected function escape($string)
{
$string = HTMLPurifier_Encoder::cleanUTF8($string);
$string = htmlspecialchars($string, ENT_COMPAT, 'UTF-8');
return $string;
@@ -110,32 +137,46 @@ class HTMLPurifier_Printer
/**
* Takes a list of strings and turns them into a single list
* @param $array List of strings
* @param $polite Bool whether or not to add an end before the last
* @param string[] $array List of strings
* @param bool $polite Bool whether or not to add an end before the last
* @return string
*/
protected function listify($array, $polite = false) {
if (empty($array)) return 'None';
protected function listify($array, $polite = false)
{
if (empty($array)) {
return 'None';
}
$ret = '';
$i = count($array);
foreach ($array as $value) {
$i--;
$ret .= $value;
if ($i > 0 && !($polite && $i == 1)) $ret .= ', ';
if ($polite && $i == 1) $ret .= 'and ';
if ($i > 0 && !($polite && $i == 1)) {
$ret .= ', ';
}
if ($polite && $i == 1) {
$ret .= 'and ';
}
}
return $ret;
}
/**
* Retrieves the class of an object without prefixes, as well as metadata
* @param $obj Object to determine class of
* @param $prefix Further prefix to remove
* @param object $obj Object to determine class of
* @param string $sec_prefix Further prefix to remove
* @return string
*/
protected function getClass($obj, $sec_prefix = '') {
protected function getClass($obj, $sec_prefix = '')
{
static $five = null;
if ($five === null) $five = version_compare(PHP_VERSION, '5', '>=');
if ($five === null) {
$five = version_compare(PHP_VERSION, '5', '>=');
}
$prefix = 'HTMLPurifier_' . $sec_prefix;
if (!$five) $prefix = strtolower($prefix);
if (!$five) {
$prefix = strtolower($prefix);
}
$class = str_replace($prefix, '', get_class($obj));
$lclass = strtolower($class);
$class .= '(';
@@ -164,13 +205,14 @@ class HTMLPurifier_Printer
break;
case 'css_importantdecorator':
$class .= $this->getClass($obj->def, $sec_prefix);
if ($obj->allow) $class .= ', !important';
if ($obj->allow) {
$class .= ', !important';
}
break;
}
$class .= ')';
return $class;
}
}
// vim: et sw=4 sts=4