UNB Components Code Reference

UnbMarkup class

Markup processing class

Public methods

   Class constructor No description available.
   Convert

Converts a plain input into HTML output.

   PostProcess

Post-processes a converted HTML string.

   SetSmileyPath

Sets a new smiley image path.

Private methods

   ApplyStyle

Applies the desired style and writes all necessary HTML output.

   CheckSmiley

Determines whether there's a smiley code at a given position.

   ClearStyle

Clear current styles.

   ProcessInline

Processes inline input.

   ProcessLine

Processes a complete line from the input.

   ResetState

Resets the internal state.

   ResolveLink

Resolves a link specification into a URL.

   TranslateSmiley

Translates a smiley code into HTML.

   TranslateStyle

Translates style IDs into HTML.

   UpdateBlockQuote

Applies the new block quote level.

   UpdateList

Applies the new list type.

   UpdateTable

Applies the new table state.

Private fields

actualStyle  –  default: array()

Actual style flags at the current output position

desiredStyle  –  default: array()

Desired style flags (those are matched with $actualStyle)

dst  –  default: ''

Destination buffer, this is where the generated HTML is assembled into

listType  –  default: ''

Current list type (string of the * and # symbols from the beginning of a line)

maxTableColumns  –  default: 0

Remembers the maximum columns count of the table to set a line (----) over the correct number of columns

quoteLevel  –  default: 0

Current quote level (0 is no quote)

smileyImages  –  default: array()

Known smiley images, array(Code => array('file' => image filename, 'width'/'height' => image dimensions)

smileyPath  –  default: ''

Path to smiley images

smileyRegexps  –  default: ''

Cache combined regular expression for all smileys

smileyStarts  –  default: ''

Cache all possible characters that a smiley can start with, in one string

smileyStartsRegexpCC  –  default: ''

Like $smileyStarts, for use in a regex character class

styleStack  –  default: array()

Style stack, used to open and close HTML tags in the output in the correct order

tableColumns  –  default: 0

Counts the columns in a single line (compared with $maxTableColumns at the end of each table line)

tableLine  –  default: false

Constants

STYLE_LEFT 0

Second style array level constants: Left-aligned floating box

File: markup.class.php, line 13
STYLE_RIGHT 1

Right-aligned floating box

File: markup.class.php, line 14
STYLE_CENTRE 2

Centre-aligned box

File: markup.class.php, line 15
STYLE_BOX 3

Bordered box

File: markup.class.php, line 16
STYLE_OT 4

Off topic

File: markup.class.php, line 17
STYLE_PAR 5

Paragraph

File: markup.class.php, line 18
STYLE_EM 6

Emphasis

File: markup.class.php, line 19
STYLE_STRONG 7

Strong emphasis

File: markup.class.php, line 20
STYLE_MONO 8

Monospace font

File: markup.class.php, line 21
STYLE_COLOUR 9

Text colour

File: markup.class.php, line 22
STYLE_BACKC 10

Background colour

File: markup.class.php, line 23
STYLE_SIZE 11

Font size

File: markup.class.php, line 24
STYLE_BIG 12

Bigger font

File: markup.class.php, line 25
STYLE_SMALL 13

Smaller font

File: markup.class.php, line 26
STYLE_ULINE 14

Font size

File: markup.class.php, line 27
STYLE_STRIKE 15

Font size

File: markup.class.php, line 28
STYLE_SUB 16

Subscript

File: markup.class.php, line 29
STYLE_SUP 17

Superscript

File: markup.class.php, line 30
STYLE_RAW 18

Raw text (monospace)

File: markup.class.php, line 31
STYLE_ID_MAX 18 No description available. File: markup.class.php, line 32

Implementation file: markup.class.php, line 10

© 2011 Yves Goergen. UNB Components Homepage. Reference generated on 2011-02-06.