Better documentation for prep_atom_text_construct props darkdragon

git-svn-id: https://develop.svn.wordpress.org/trunk@6516 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Peter Westwood 2007-12-28 21:21:50 +00:00
parent 38e2dc5791
commit aa78f6c4c0
1 changed files with 11 additions and 9 deletions

View File

@ -178,21 +178,23 @@ function atom_enclosure() {
} }
/** /**
* prep_atom_text_construct() - determine if given string of data is * prep_atom_text_construct() - Determine the type of a given string of data
* type text, html, or xhtml, per RFC 4287 section 3.1. *
* Tell whether the type is text, html, or xhtml, per RFC 4287 section 3.1.
* *
* In the case of WordPress, text is defined as containing no markup, * In the case of WordPress, text is defined as containing no markup,
* xhtml is defined as "well formed", and html as tag soup (i.e., the rest). * xhtml is defined as "well formed", and html as tag soup (i.e., the rest).
* *
* Container div tags are added to xhtml values, per section 3.1.1.3. * Container div tags are added to xhtml values, per section 3.1.1.3.
* *
* @link http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.3.1
*
* @package WordPress * @package WordPress
* @subpackage Feed * @subpackage Feed
* @since 2.4 * @since 2.4
* *
* @param string $data input string * @param string $data input string
* @return array $result array(type, value) * @return array $result array(type, value)
* @link http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.3.1
*/ */
function prep_atom_text_construct($data) { function prep_atom_text_construct($data) {
if (strpos($data, '<') === false && strpos($data, '&') === false) { if (strpos($data, '<') === false && strpos($data, '&') === false) {
@ -205,12 +207,12 @@ function prep_atom_text_construct($data) {
xml_parser_free($parser); xml_parser_free($parser);
if (!$code) { if (!$code) {
if (strpos($data, '<') === false) { if (strpos($data, '<') === false) {
return array('text', $data); return array('text', $data);
} else { } else {
$data = "<div xmlns='http://www.w3.org/1999/xhtml'>$data</div>"; $data = "<div xmlns='http://www.w3.org/1999/xhtml'>$data</div>";
return array('xhtml', $data); return array('xhtml', $data);
} }
} }
if (strpos($data, ']]>') == false) { if (strpos($data, ']]>') == false) {