Class comcode_xml_to_tempcode

Description

Located in /sources/comcode_xml.php (line 64)


	
			
Variable Summary
Method Summary
tempcode comcode_xml_to_tempcode (LONG_TEXT $comcode, MEMBER $source_member, ?integer $wrap_pos, ?string $pass_id, object The $connection, boolean $semiparse_mode, boolean $preparse_mode, boolean $is_all_semihtml, boolean $structure_sweep, boolean $check_only, [?MEMBER $on_behalf_of_member = NULL])
array convertFinalisedElement (object The $parser, tempcode $child_tempcode, array $special_child_elements)
void endElement (object The $parser)
void endNameSpace (object The $parser)
void startElement (object The $parser, string $name, array $attributes)
void startNameSpace (object The $parser, string $prefix, [?URLPATH $uri = NULL])
void startText (object The $parser, string $data)
Variables
mixed $attribute_stack (line 67)
mixed $check_only (line 68)
mixed $comcode (line 68)
mixed $connection (line 68)
mixed $is_all_semihtml (line 68)
mixed $marker (line 68)
mixed $namespace_stack (line 67)
mixed $on_behalf_of_member (line 68)
mixed $pass_id (line 68)
mixed $semiparse_mode (line 68)
mixed $source_member (line 68)
mixed $special_child_elements_stack (line 67)
mixed $structure_sweep (line 68)
mixed $tag_stack (line 67)
mixed $tempcode (line 71)
mixed $wml (line 68)
mixed $wrap_pos (line 68)
Methods
Constructor comcode_xml_to_tempcode (line 89)

Convert the specified comcode (text format) into a tempcode tree. You shouldn't output the tempcode tree to the browser, as it looks really horrible. If you are in a rare case where you need to output directly (not through templates), you should call the evaluate method on the tempcode object, to convert it into a string.

  • return: The tempcode tree.
tempcode comcode_xml_to_tempcode (LONG_TEXT $comcode, MEMBER $source_member, ?integer $wrap_pos, ?string $pass_id, object The $connection, boolean $semiparse_mode, boolean $preparse_mode, boolean $is_all_semihtml, boolean $structure_sweep, boolean $check_only, [?MEMBER $on_behalf_of_member = NULL])
  • LONG_TEXT $comcode: The comcode to convert
  • MEMBER $source_member: The member the evaluation is running as. This is a security issue, and you should only run as an administrator if you have considered where the comcode came from carefully
  • ?integer $wrap_pos: The position to conduct wordwrapping at (NULL: do not conduct word-wrapping)
  • ?string $pass_id: A special identifier that can identify this resource in a sea of our resources of this class; usually this can be ignored, but may be used to provide a binding between Javascript in evaluated comcode, and the surrounding environment (NULL: no explicit binding)
  • object The $connection: database connection to use
  • boolean $semiparse_mode: Whether to parse so as to create something that would fit inside a semihtml tag. It means we generate HTML, with Comcode written into it where the tag could never be reverse-converted (e.g. a block).
  • boolean $preparse_mode: Whether this is being pre-parsed, to pick up errors before row insertion.
  • boolean $is_all_semihtml: Whether to treat this whole thing as being wrapped in semihtml, but apply normal security otherwise.
  • boolean $structure_sweep: Whether we are only doing this parse to find the title structure
  • boolean $check_only: Whether to only check the Comcode. It's best to use the check_comcode function which will in turn use this parameter.
  • ?MEMBER $on_behalf_of_member: The member we are running on behalf of, with respect to how attachments are handled; we may use this members attachments that are already within this post, and our new attachments will be handed to this member (NULL: member evaluating)
convertFinalisedElement (line 252)

Parse the complete text of the inside of the tag.

  • return: A pair: The resultant tempcode. Whether the resultant tempcode is aggregated with neighbours.
array convertFinalisedElement (object The $parser, tempcode $child_tempcode, array $special_child_elements)
  • object The $parser: parser object (same as 'this')
  • tempcode $child_tempcode: Tempcode from child elements
  • array $special_child_elements: A map containing arrays of tempcode from child elements indexed under element name
endElement (line 201)

Standard PHP XML parser function.

void endElement (object The $parser)
  • object The $parser: parser object (same as 'this')
endNameSpace (line 172)

Standard PHP XML parser function.

void endNameSpace (object The $parser)
  • object The $parser: parser object (same as 'this')
startElement (line 186)

Standard PHP XML parser function.

void startElement (object The $parser, string $name, array $attributes)
  • object The $parser: parser object (same as 'this')
  • string $name: The name of the element found
  • array $attributes: Array of attributes of the element
startNameSpace (line 159)

Standard PHP XML parser function.

void startNameSpace (object The $parser, string $prefix, [?URLPATH $uri = NULL])
  • object The $parser: parser object (same as 'this')
  • string $prefix: N/A
  • ?URLPATH $uri: The URI of the name space we are entering (NULL: not given)
startText (line 235)

Standard PHP XML parser function.

void startText (object The $parser, string $data)
  • object The $parser: parser object (same as 'this')
  • string $data: The text

Documentation generated on Sun, 02 Jan 2011 23:11:50 +0000 by phpDocumentor 1.4.3