From f7760c8cb60fb64229a25fb80ee6b0769be1bd5a Mon Sep 17 00:00:00 2001 From: "Edward Z. Yang" Date: Sun, 20 Aug 2006 21:59:41 +0000 Subject: [PATCH] Document Strategies. git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@310 48356398-32a2-884e-a903-53898d9a118a --- library/HTMLPurifier/Strategy/Composite.php | 6 ++++++ library/HTMLPurifier/Strategy/Core.php | 3 +++ library/HTMLPurifier/Strategy/MakeWellFormed.php | 3 +++ 3 files changed, 12 insertions(+) diff --git a/library/HTMLPurifier/Strategy/Composite.php b/library/HTMLPurifier/Strategy/Composite.php index 8faa528c..9ed233c3 100644 --- a/library/HTMLPurifier/Strategy/Composite.php +++ b/library/HTMLPurifier/Strategy/Composite.php @@ -3,9 +3,15 @@ require_once 'HTMLPurifier/Strategy.php'; require_once 'HTMLPurifier/Config.php'; +/** + * Composite strategy that runs multiple strategies on tokens. + */ class HTMLPurifier_Strategy_Composite { + /** + * List of strategies to run tokens through. + */ var $strategies = array(); function HTMLPurifier_Strategy_Composite() { diff --git a/library/HTMLPurifier/Strategy/Core.php b/library/HTMLPurifier/Strategy/Core.php index f854b120..66e7bb36 100644 --- a/library/HTMLPurifier/Strategy/Core.php +++ b/library/HTMLPurifier/Strategy/Core.php @@ -7,6 +7,9 @@ require_once 'HTMLPurifier/Strategy/MakeWellFormed.php'; require_once 'HTMLPurifier/Strategy/FixNesting.php'; require_once 'HTMLPurifier/Strategy/ValidateAttributes.php'; +/** + * Core strategy composed of the big four strategies. + */ class HTMLPurifier_Strategy_Core extends HTMLPurifier_Strategy_Composite { diff --git a/library/HTMLPurifier/Strategy/MakeWellFormed.php b/library/HTMLPurifier/Strategy/MakeWellFormed.php index 69e39ae4..e3ebfcf8 100644 --- a/library/HTMLPurifier/Strategy/MakeWellFormed.php +++ b/library/HTMLPurifier/Strategy/MakeWellFormed.php @@ -4,6 +4,9 @@ require_once 'HTMLPurifier/Strategy.php'; require_once 'HTMLPurifier/HTMLDefinition.php'; require_once 'HTMLPurifier/Generator.php'; +/** + * Takes tokens makes them well-formed (balance end tags, etc.) + */ class HTMLPurifier_Strategy_MakeWellFormed extends HTMLPurifier_Strategy {