2017 © Pedro Peláez
 

package purifier

Laravel 5 HtmlPurifier Package

image

luketowers/purifier

Laravel 5 HtmlPurifier Package

  • Tuesday, February 20, 2018
  • by LukeTowers
  • Repository
  • 1 Watchers
  • 20 Stars
  • 23,541 Installations
  • PHP
  • 4 Dependents
  • 0 Suggesters
  • 105 Forks
  • 2 Open issues
  • 17 Versions
  • 17 % Grown

The README.md

HTMLPurifier for Laravel 5

A simple Laravel 5 service provider for including the HTMLPurifier for Laravel 5., (*1)

This package can be installed via Composer by including the repository and requiring the luketowers/purifier package in your project's composer.json:, (*2)

{
    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/LukeTowers/Purifier"
        }
    ],
    "require": {
        "laravel/framework": "~5.0",
        "luketowers/purifier": "~3.0",
    }
}

Update your packages with composer update or install with composer install., (*3)

Usage

To use the HTMLPurifier Service Provider, you must register the provider when bootstrapping your Laravel application. There are essentially two ways to do this., (*4)

Find the providers key in config/app.php and register the HTMLPurifier Service Provider., (*5)

    'providers' => [
        // ...
        LukeTowers\Purifier\PurifierServiceProvider::class,
    ]

Find the aliases key in app/config/app.php., (*6)

    'aliases' => [
        // ...
        'Purifier' => LukeTowers\Purifier\Facades\Purifier::class,
    ]

Configuration

To use your own settings, publish config., (*7)

$ php artisan vendor:publish --provider="LukeTowers\Purifier\PurifierServiceProvider", (*8)

Config file config/purifier.php should like this, (*9)


return [
    'encoding'      => 'UTF-8',
    'finalize'      => true,
    'cachePath'     => storage_path('app/purifier'),
    'cacheFileMode' => 0755,
    'settings'      => [
        'default' => [
            'HTML.Doctype'             => 'HTML 4.01 Transitional',
            'HTML.Allowed'             => 'div,b,strong,i,em,u,a[href|title],ul,ol,li,p[style],br,span[style],img[width|height|alt|src]',
            'CSS.AllowedProperties'    => 'font,font-size,font-weight,font-style,font-family,text-decoration,padding-left,color,background-color,text-align',
            'AutoFormat.AutoParagraph' => true,
            'AutoFormat.RemoveEmpty'   => true,
        ],
        'test'    => [
            'Attr.EnableID' => 'true',
        ],
        "youtube" => [
            "HTML.SafeIframe"      => 'true',
            "URI.SafeIframeRegexp" => "%^(http://|https://|//)(www.youtube.com/embed/|player.vimeo.com/video/)%",
        ],
        'custom_definition' => [
            'id'  => 'html5-definitions',
            'rev' => 1,
            'debug' => false,
            'elements' => [
                // http://developers.whatwg.org/sections.html
                ['section', 'Block', 'Flow', 'Common'],
                ['nav',     'Block', 'Flow', 'Common'],
                ['article', 'Block', 'Flow', 'Common'],
                ['aside',   'Block', 'Flow', 'Common'],
                ['header',  'Block', 'Flow', 'Common'],
                ['footer',  'Block', 'Flow', 'Common'],

                // Content model actually excludes several tags, not modelled here
                ['address', 'Block', 'Flow', 'Common'],
                ['hgroup', 'Block', 'Required: h1 | h2 | h3 | h4 | h5 | h6', 'Common'],

                // http://developers.whatwg.org/grouping-content.html
                ['figure', 'Block', 'Optional: (figcaption, Flow) | (Flow, figcaption) | Flow', 'Common'],
                ['figcaption', 'Inline', 'Flow', 'Common'],

                // http://developers.whatwg.org/the-video-element.html#the-video-element
                ['video', 'Block', 'Optional: (source, Flow) | (Flow, source) | Flow', 'Common', [
                    'src' => 'URI',
                    'type' => 'Text',
                    'width' => 'Length',
                    'height' => 'Length',
                    'poster' => 'URI',
                    'preload' => 'Enum#auto,metadata,none',
                    'controls' => 'Bool',
                ]],
                ['source', 'Block', 'Flow', 'Common', [
                    'src' => 'URI',
                    'type' => 'Text',
                ]],

                // http://developers.whatwg.org/text-level-semantics.html
                ['s',    'Inline', 'Inline', 'Common'],
                ['var',  'Inline', 'Inline', 'Common'],
                ['sub',  'Inline', 'Inline', 'Common'],
                ['sup',  'Inline', 'Inline', 'Common'],
                ['mark', 'Inline', 'Inline', 'Common'],
                ['wbr',  'Inline', 'Empty', 'Core'],

                // http://developers.whatwg.org/edits.html
                ['ins', 'Block', 'Flow', 'Common', ['cite' => 'URI', 'datetime' => 'CDATA']],
                ['del', 'Block', 'Flow', 'Common', ['cite' => 'URI', 'datetime' => 'CDATA']],
            ],
            'attributes' => [
                ['iframe', 'allowfullscreen', 'Bool'],
                ['table', 'height', 'Text'],
                ['td', 'border', 'Text'],
                ['th', 'border', 'Text'],
                ['tr', 'width', 'Text'],
                ['tr', 'height', 'Text'],
                ['tr', 'border', 'Text'],
            ],
        ],
        'custom_attributes' => [
            ['a', 'target', 'Enum#_blank,_self,_target,_top'],
        ],
        'custom_elements' => [
            ['u', 'Inline', 'Inline', 'Common'],
        ],
    ],

];

Example

default, (*10)

clean(Input::get('inputname'));

or, (*11)

Purifier::clean(Input::get('inputname'));

dynamic config, (*12)

clean('This is my H1 title', 'titles');
clean('This is my H1 title', array('Attr.EnableID' => true));

or, (*13)

Purifier::clean('This is my H1 title', 'titles');
Purifier::clean('This is my H1 title', array('Attr.EnableID' => true));

The Versions

20/02 2018

dev-master

9999999-dev https://github.com/LukeTowers/Purifier

Laravel 5 HtmlPurifier Package

  Sources   Download

MIT

The Requires

 

The Development Requires

by Muharrem ERIN
by Luke Towers

security xss purifier laravel5 security htmlpurifier laravel5 htmlpurifier laravel5 purifier

20/02 2018

3.0.4

3.0.4.0 https://github.com/LukeTowers/Purifier

Laravel 5 HtmlPurifier Package

  Sources   Download

MIT

The Requires

 

The Development Requires

by Muharrem ERIN
by Luke Towers

security xss purifier laravel5 security htmlpurifier laravel5 htmlpurifier laravel5 purifier

05/08 2017

3.0.3

3.0.3.0 https://github.com/LukeTowers/Purifier

Laravel 5 HtmlPurifier Package

  Sources   Download

MIT

The Requires

 

The Development Requires

by Muharrem ERIN
by Luke Towers

security xss purifier laravel5 security htmlpurifier laravel5 htmlpurifier laravel5 purifier

10/02 2017

3.0.2

3.0.2.0 https://github.com/LukeTowers/Purifier

Laravel 5 HtmlPurifier Package

  Sources   Download

MIT

The Requires

 

The Development Requires

by Muharrem ERIN
by Luke Towers

security xss purifier laravel5 security htmlpurifier laravel5 htmlpurifier laravel5 purifier

12/01 2017

dev-feature-customDefinitions

dev-feature-customDefinitions https://github.com/mewebstudio/purifier

Laravel 5 HtmlPurifier Package

  Sources   Download

MIT

The Requires

 

The Development Requires

by Muharrem ERIN

security xss purifier laravel5 security htmlpurifier laravel5 htmlpurifier laravel5 purifier

12/01 2017

3.0.1

3.0.1.0 https://github.com/LukeTowers/Purifier

Laravel 5 HtmlPurifier Package

  Sources   Download

MIT

The Requires

 

The Development Requires

by Muharrem ERIN
by Luke Towers

security xss purifier laravel5 security htmlpurifier laravel5 htmlpurifier laravel5 purifier

12/01 2017

3.0.0

3.0.0.0 https://github.com/LukeTowers/Purifier

Laravel 5 HtmlPurifier Package

  Sources   Download

MIT

The Requires

 

The Development Requires

by Muharrem ERIN
by Luke Towers

security xss purifier laravel5 security htmlpurifier laravel5 htmlpurifier laravel5 purifier

11/01 2017

dev-patch-1

dev-patch-1 https://github.com/mewebstudio/purifier

Laravel 5 HtmlPurifier Package

  Sources   Download

MIT

The Requires

 

The Development Requires

by Muharrem ERIN

security xss purifier laravel5 security htmlpurifier laravel5 htmlpurifier laravel5 purifier

27/07 2016

2.0.6

2.0.6.0 https://github.com/mewebstudio/purifier

Laravel 5 HtmlPurifier Package

  Sources   Download

MIT

The Requires

 

The Development Requires

by Muharrem ERIN

security xss purifier laravel5 security htmlpurifier laravel5 htmlpurifier laravel5 purifier

26/04 2016

2.0.5

2.0.5.0 https://github.com/mewebstudio/purifier

Laravel 5 HtmlPurifier Package

  Sources   Download

MIT

The Requires

 

The Development Requires

by Muharrem ERIN

security xss purifier laravel5 security htmlpurifier laravel5 htmlpurifier laravel5 purifier

02/02 2016

2.0.4

2.0.4.0 https://github.com/mewebstudio/purifier

Laravel 5 HtmlPurifier Package

  Sources   Download

MIT

The Requires

 

The Development Requires

by Muharrem ERIN

security xss purifier laravel5 security htmlpurifier laravel5 htmlpurifier laravel5 purifier

31/08 2015

2.0.3

2.0.3.0 https://github.com/mewebstudio/purifier

Laravel 5 HtmlPurifier Package

  Sources   Download

MIT

The Requires

 

The Development Requires

by Muharrem ERIN

security xss purifier laravel5 security htmlpurifier laravel5 htmlpurifier laravel5 purifier

28/08 2015

2.0.2

2.0.2.0 https://github.com/mewebstudio/purifier

Laravel 5 HtmlPurifier Package

  Sources   Download

MIT

The Requires

 

The Development Requires

by Muharrem ERIN

security xss purifier laravel5 security htmlpurifier laravel5 htmlpurifier laravel5 purifier

29/07 2015

2.0.1

2.0.1.0 https://github.com/mewebstudio/purifier

Laravel 5 HtmlPurifier Package

  Sources   Download

MIT

The Requires

 

The Development Requires

by Muharrem ERIN

security xss purifier laravel5 security htmlpurifier laravel5 htmlpurifier laravel5 purifier

11/04 2015

2.0.0

2.0.0.0 https://github.com/mewebstudio/purifier

Laravel 5 HtmlPurifier Package

  Sources   Download

MIT

The Requires

 

The Development Requires

by Muharrem ERIN

security xss purifier laravel5 security htmlpurifier laravel5 htmlpurifier laravel5 purifier

31/12 2014

1.0.2

1.0.2.0 http://github.com/mewebstudio/Purifier

HTMLPurifier Package for Laravel 4

  Sources   Download

LGPL

The Requires

 

by Muharrem ERIN

laravel laravel 4 purifier l4 htmlpurifier

25/01 2014

1.0.1

1.0.1.0 http://github.com/mewebstudio/Purifier

HTMLPurifier Package for Laravel 4

  Sources   Download

LGPL

The Requires

 

by Muharrem ERIN

laravel laravel 4 purifier l4 htmlpurifier