Phalcon\Html\Escaper

Complexity

Total Complexity

10

Size/Duplication

Total Lines	140
Duplicated Lines	0 %

Test Coverage

Coverage

30.76%

Importance

Changes	1
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	js()	0	3	1
A	setDoubleEncode()	0	5	1
A	getEncoding()	0	3	1
A	attributes()	0	3	1
A	css()	0	3	1
A	html()	0	7	1
A	setEncoding()	0	5	1
A	getDoubleEncode()	0	3	1
A	url()	0	3	1
A	getFlags()	0	3	1

<?php

/**
 * This file is part of the Phalcon Framework.
 *
 * For the full copyright and license information, please view the LICENSE.md
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Phalcon\Html;

use const ENT_QUOTES;
use const ENT_SUBSTITUTE;

/**
 * Class Escaper
 *
 * @property bool   $doubleEncode
 * @property string $encoding
 * @property int    $flags
 */
class Escaper
{
    /**
     * @var bool
     */
    protected $doubleEncode = true;

    /**
     * @var string
     */
    protected $encoding = "utf-8";

    /**
     * ENT_QUOTES | ENT_SUBSTITUTE
     *
     * @var int
     */
    protected $flags = 11;

    /**
     * Escape HTML attributes
     *
     * @param string $input
     *
     * @return string
     */
    public function attributes(string $input): string
    {
        return $input;
    }

    /**
     * Escape CSS
     *
     * @param string $input
     *
     * @return string
     */
    public function css(string $input): string
    {
        return $input;
    }

    /**
     * Returns whether we will use double encoding or not
     *
     * @return bool
     */
    public function getDoubleEncode(): bool
    {
        return $this->doubleEncode;
    }

    /**
     * Returns the encoding used
     *
     * @return string
     */
    public function getEncoding(): string
    {
        return $this->encoding;
    }

    /**
     * Get the htmlspecialchars flags
     *
     * @return int
     */
    public function getFlags(): int
    {
        return $this->flags;
    }

    /**
     * Escapes HTML
     *
     * @param mixed $input
     *
     * @return string
     */
    public function html($input): string
    {
        return htmlspecialchars(
            $input,
            $this->flags,
            $this->encoding,
            $this->doubleEncode
        );
    }

    /**
     * Escape JS
     *
     * @param string $input
     *
     * @return string
     */
    public function js(string $input): string
    {
        return $input;
    }

    /**
     * Sets whether we will used double encoding or not
     *
     * @param bool $flag
     *
     * @return Escaper
     */
    public function setDoubleEncode(bool $flag): Escaper
    {
        $this->doubleEncode = $flag;

        return $this;
    }

    /**
     * Sets the encoding to be used
     *
     * @param string $encoding
     *
     * @return Escaper
     */
    public function setEncoding(string $encoding): Escaper
    {
        $this->encoding = $encoding;

        return $this;
    }

    /**
     * Escapes a URL
     *
     * @param string $url
     *
     * @return string
     */
    public function url(string $url): string
    {
        return rawurldecode($url);
    }
}