Docs for page comcode_conversion.php

Description

copyright: ocProducts Ltd
license: Common Public Attribution License

Classes

Class	Description
ocp_tempcode_static

Functions

comcode_text__to__comcode_xml (line 43)

Convert Comcode-Text to Comcode-XML.

return: The converted comcode

LONG_TEXT comcode_text__to__comcode_xml (LONG_TEXT $comcode, [boolean $skip_wrapper = false])

LONG_TEXT $comcode: The comcode to convert
boolean $skip_wrapper: Whether to not include a wrapper element (<comcode>)

init__comcode_conversion (line 24)

Standard code module initialisation function.

void init__comcode_conversion ()

read_single_uncompiled_symbol (line 1195)

Convert and return an uncompiled textual symbol (as used in templates, and comcode) into tempcode (these pieces are attached to other pieces, in a certain way, forming a tempcode tree for a template or a symbol-in-comcode).

return: The tempcode variable array that our symbol gets represented of

array read_single_uncompiled_symbol (string $text, integer &$symbol_pos, integer $symbol_len)

string $text: The full text that is being parsed (we only look into this - the whole thing will be passed into PHP by reference, hence avoiding us a memory block copy)
integer &$symbol_pos: The position we are looking at in the text
integer $symbol_len: The length of our symbol

template_to_tempcode_static (line 1097)

Convert template text into tempcode format.

return: The converted/compiled template as tempcode, OR if a directive, encoded directive information

mixed template_to_tempcode_static (string $text, [integer $symbol_pos = 0], [boolean $inside_directive = false], [ID_TEXT $codename = ''])

string $text: The template text
integer $symbol_pos: The position we are looking at in the text
boolean $inside_directive: Whether this text is infact a directive, about to be put in the context of a wider template
ID_TEXT $codename: The codename of the template (e.g. foo)

_convert_close_open_lists (line 1077)

Get HTML to close any open lists.

return: The output needed to close the lists, and the new list indentation (always zero). Done like this so we can use 'list' to set both at once in the main parser.

array _convert_close_open_lists (integer $list_indent)

integer $list_indent: The depth level of lists that we need to close

/sources/comcode_conversion.php