Download the PHP package akibatech/wysiwygpreprocessor without Composer
On this page you can find all versions of the php package akibatech/wysiwygpreprocessor. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package wysiwygpreprocessor
WYSIWYG Preprocessor
WYSIWYG Preprocessor is a PHP library with no dependencies. It's a sort of toolbox for processing your HTML textareas.
- Installation
- Basic Usage
- Customizing modifiers
- Modifiers
- BBCode
- Parse Variables
- Absolute Path
- Words Filter
- Empty Paragraphs
- Mail to Link
- NlToBr
- StripTags
- URL to Link
- Youtube Link to Iframe
- Your own modifiers
- Unit Tests
- Authors
Installation
Sources are managed with Composer.
Basic usage
For the given textarea,
We want to transform the link and the email adress to HTML tags
Results in :
Customizing modifiers
Modifiers are easily customizable.
Imagine you want to target all links to a new page or adding to it a custom class.
Results in :
Modifiers
BBCode
Class: Akibatech\Wysiwyg\Modifier\BbCode
Description: Apply a basic BBCode to enhance your content.
Example input:
Example output:
Options:
Defaults tags are: b, i, u, left, right, center, quote, link, img, size and color.
Options are wilcard BBCode tag. Key is the wanted BBCode tag and option is the HTML replacement.
If pattern is given as array, it can access Tag option like as .
Parse Variables
Class: Akibatech\Wysiwyg\Modifier\ParseVariables
Description: Replace a preset of variables.
Example input:
Example output:
Options:
You can specify the delimiter and the accepted variables.
Absolute Path
Class: Akibatech\Wysiwyg\Modifier\AbsolutePath
Description: Will replace "href" and "src" attributes with absolute values.
Example input:
Example output:
Options:
You can specify a custom prefix for your paths.
Words Filter
Class: Akibatech\Wysiwyg\Modifier\WordsFilter
Description: Remove a words list from a text. Act as a censorship system.
Example input:
Example output:
Options:
The list and the replacement.
Empty Paragraphs
Class: Akibatech\Wysiwyg\Modifier\EmptyParagraphs
Description: Delete empty paragraphs from your content.
Example input:
Example output:
Options:
None.
Mail to Link
Class: Akibatech\Wysiwyg\Modifier\MailToLink
Description: Transforms emails adresses in clickable link tag.
Example input:
Example output:
Options:
NlToBr
Class: Akibatech\Wysiwyg\Modifier\NlToBr
Description: Replace line breaks into HTML line breaks. Similar to php native function nl2br().
Example input:
Example output:
Options:
StripTags
Class: Akibatech\Wysiwyg\Modifier\StripTags
Description: Remove HTML tags from input. Similar to php native function strip_tags().
Example input:
Example output:
Options:
URL to Link
Class: Akibatech\Wysiwyg\Modifier\UrlToLink
Description: Transforms web adresses in clickable link tag.
Example input:
Example output:
Options:
Youtube Link to Iframe
Class: Akibatech\Wysiwyg\Modifier\YoutubeLinkToIframe
Description: Transforms youtube links (long and shorts) to a embed video player (iframe).
Example input:
Example output:
Options:
Your own modifiers
You can easily extends the preprocessor by adding your own modifiers.
All you need is to create a class implementing ModifierInterface.
You're also encouraged to extends AbstractModifier to access common methods (setOptions, getOptions, ...).
Basically, a modifier receive the input to transform through a public method handle($input).
Options are handled by a public method defaultOptions() returning an array of available options. And in your modifier body, you can access these options with the instance attribute options.
Callable modifier
You also have the possibility to add a dynamic modifier.
The method "addModifier" also accepts a callback function.
Example :
Unit Tests
WYSIWYG Preprocessor is tested with PHPUnit.
Make sure you have composer dev dependencies installed and type :
Authors
Author: Marceau Casals and all contributors
Licence: MIT
