README 1.2 KB

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