diff options
| author | marcus <marcus@36083f99-b078-4883-b0ff-0f9b5a30f544> | 2009-04-17 15:41:16 +0000 |
|---|---|---|
| committer | marcus <marcus@36083f99-b078-4883-b0ff-0f9b5a30f544> | 2009-04-17 15:41:16 +0000 |
| commit | 07155a084db111c0586ce7ed958c87eed6116704 (patch) | |
| tree | e5e64cd58d20bdb2a0ad896403d8814f11018f52 /mod/kses/vendors/kses/oop/oop.simple.api.txt | |
| parent | 566de88eb3a15b58600f5195dc7b185b8aae0d41 (diff) | |
| download | elgg-07155a084db111c0586ce7ed958c87eed6116704.tar.gz elgg-07155a084db111c0586ce7ed958c87eed6116704.tar.bz2 | |
Closes #833: Kses now built as module
git-svn-id: https://code.elgg.org/elgg/trunk@3222 36083f99-b078-4883-b0ff-0f9b5a30f544
Diffstat (limited to 'mod/kses/vendors/kses/oop/oop.simple.api.txt')
| -rw-r--r-- | mod/kses/vendors/kses/oop/oop.simple.api.txt | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/mod/kses/vendors/kses/oop/oop.simple.api.txt b/mod/kses/vendors/kses/oop/oop.simple.api.txt new file mode 100644 index 000000000..144308a93 --- /dev/null +++ b/mod/kses/vendors/kses/oop/oop.simple.api.txt @@ -0,0 +1,58 @@ +Parse($string = "")
+ The basic function of kses. Give it a $string, and it will strip
+ out the unwanted HTML and attributes.
+
+AddProtocols()
+ Add a protocol or list of protocols to the kses object to be
+ considered valid during a Parse(). The parameter can be a string
+ containing a single protocol, or an array of strings, each
+ containing a single protocol.
+
+Protocols()
+ Deprecated. Use AddProtocols()
+
+AddProtocol($protocol = "")
+ Adds a single protocol to the kses object that will be considered
+ valid during a Parse().
+
+SetProtocols()
+ This is a straight setting/overwrite of existing protocols in the
+ kses object. All existing protocols are removed, and the parameter
+ is used to determine what protocol(s) the kses object will consider
+ valid. The parameter can be a string containing a single protocol,
+ or an array of strings, each constaining a single protocol.
+
+DumpProtocols()
+ This returns an indexed array of the valid protocols contained in
+ the kses object.
+
+DumpElements()
+ This returns an associative array of the valid (X)HTML elements in
+ the kses object along with attributes for each element, and tests
+ that will be performed on each attribute.
+
+AddHTML($tag = "", $attribs = array())
+ This allows the end user to add a single (X)HTML element to the
+ kses object along with the (if any) attributes that the specific
+ (X)HTML element is allowed to have.
+
+ See the file 'attribute-value-checks' for more information as to
+ the format of the data to be provided to this method.
+
+RemoveProtocol($protocol = "")
+ This allows for the removal of a single protocol from the list of
+ valid protocols in the kses object.
+
+RemoveProtocols()
+ This allows for the single or batch removal of protocols from the
+ kses object. The parameter is either a string containing a
+ protocol to be removed, or an array of strings that each contain
+ a protocol.
+
+filterKsesTextHook($string)
+ For the OOP version of kses, this is an additional hook that allows
+ the end user to perform additional postprocessing of a string
+ that's being run through Parse().
+
+_hook()
+ Deprecated. Use filterKsesTextHook().
\ No newline at end of file |