Travis support.
[htmlpurifier.git] / extras / README
blob4bfece79ea5d6a509155a36521e27b3dd287a939
2 HTML Purifier Extras
3     The Method Behind The Madness!
5 The extras/ folder in HTML Purifier contains--you guessed it--extra things
6 for HTML Purifier.  Specifically, these are two extra libraries called
7 FSTools and ConfigSchema.  They're extra for a reason: you don't need them
8 if you're using HTML Purifier for normal usage: filtering HTML.  However,
9 if you're a developer, and would like to test HTML Purifier, or need to
10 use one of HTML Purifier's maintenance scripts, chances are they'll need
11 these libraries. Who knows: maybe you'll find them useful too!
13 Here are the libraries:
16 FSTools
17 -------
19 Short for File System Tools, this is a poor-man's object-oriented wrapper for
20 the filesystem. It currently consists of two classes:
22 - FSTools: This is a singleton that contains a manner of useful functions
23   such as recursive glob, directory removal, etc, as well as the ability
24   to call arbitrary native PHP functions through it like $FS->fopen(...).
25   This makes it a lot simpler to mock these filesystem calls for unit testing.
27 - FSTools_File: This object represents a single file, and has almost any
28   method imaginable one would need.
30 Check the files themselves for more information.
32     vim: et sw=4 sts=4