SnapContentHtml Class Reference
[Content Modules]
HTML Content Module.
More...
Public Member Functions | |
| checkMedia () | |
| INSERT BRIEF DESCRIPTION HERE. | |
| setHTML ($html) | |
| Set the HTML content. | |
| updateFileList () | |
| INSERT BRIEF DESCRIPTION HERE. | |
Protected Member Functions | |
| doGetHTML ($params) | |
| INSERT BRIEF DESCRIPTION HERE. | |
| validate () | |
| INSERT BRIEF DESCRIPTION HERE. | |
Detailed Description
HTML Content Module.This content module contains simple HTML. It need not be a full HTML document. A valid snippet is fine. The HTML is validated using SXMLHelper::validateXML(), but it is not validated against any schema (so it is only checked for well-formedness).
Definition at line 12 of file SnapContentHtml.php5.
Member Function Documentation
| SnapContentHtml::checkMedia | ( | ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Returns:
- [TYPE]: RETURN DESCRIPTION
Reimplemented from SnapContent.
Definition at line 66 of file SnapContentHtml.php5.
| SnapContentHtml::doGetHTML | ( | $ | params | ) | [protected] |
INSERT BRIEF DESCRIPTION HERE.
For internal use only.
INSERT FULL DESCRIPTION HERE
- Parameters:
-
$params [TYPE]: DESCRIPTION
- Returns:
- [TYPE]: RETURN DESCRIPTION
Reimplemented from SnapContent.
Definition at line 55 of file SnapContentHtml.php5.
References SnapContent::getAll().
| SnapContentHtml::setHTML | ( | $ | html | ) |
Set the HTML content.
If the HTML is invalid, an error is set on this object. You should check the validity of the HTML before putting it into this content module if you want better control over error propagation.
- Parameters:
-
$html [string]: valid HTML string to put into this content module
- Returns:
- [boolean]: success or failure
Definition at line 25 of file SnapContentHtml.php5.
References SXMLHelper::formatXML(), SnapContent::setAll(), and SXMLHelper::validateXML().
| SnapContentHtml::updateFileList | ( | ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Returns:
- [TYPE]: RETURN DESCRIPTION
Reimplemented from SnapContent.
Definition at line 77 of file SnapContentHtml.php5.
| SnapContentHtml::validate | ( | ) | [protected] |
INSERT BRIEF DESCRIPTION HERE.
For internal use only.
INSERT FULL DESCRIPTION HERE
- Returns:
- [TYPE]: RETURN DESCRIPTION
Reimplemented from SnapContent.
Definition at line 43 of file SnapContentHtml.php5.
The documentation for this class was generated from the following file:
- snap2/content/SnapContentHtml.php5
