Docs For Class blocklet

Description

The blocklet is simply a part of a block. It is almost a 'paragraph' of

content, excepting that a blocklet might have content of several text paragraphs, so it is something slightly different, hence the name. This class knows how to get, save and delete blocklets, and how to render them as html.

Located in /block-defs.php (line 1107)

RenderableObject
   |
   --blocklet

Variable Summary

mixed $blockletid

mixed $blocklet_style

mixed $content

mixed $content_colour

mixed $content_size

mixed $desc

mixed $display_order

mixed $exists

mixed $heading

mixed $heading_colour

mixed $heading_level

mixed $justify

mixed $ruler

mixed $ruler_colour

mixed $ruler_size

mixed $ruler_width

mixed $table_autojustify

mixed $table_rowstripes

mixed $table_style

mixed $type

mixed $visible

mixed $width

Method Summary

blocklet blocklet ([string $id = NEW_BLOCKLET])

void content_css ()

void content_style ()

string csv ()

void delete ()

string expanded_content ()

void format_content (mixed $content, [mixed $type = "text"], [mixed $css = ""])

void get (string $id)

string html ()

void put ()

Variables

mixed $blockletid (line 1109)

blocklet ID

mixed $blocklet_style = "" (line 1141)

Manual style to apply to content

mixed $content = "" (line 1135)

Blocklet textual content

mixed $content_colour = "" (line 1139)

Content colour

mixed $content_size = 0 (line 1137)

Content size adjustment -2 thru +2

mixed $desc = "" (line 1113)

The description of the current blocklet

mixed $display_order = 1 (line 1151)

Display order of this blocklet

mixed $exists = false (line 1111)

Whether blocklet exists in database

mixed $heading (line 1121)

blocklet heading

mixed $heading_colour = "" (line 1125)

Heading colour

mixed $heading_level = 3 (line 1123)

blocklet heading level (1-6)

mixed $justify = "left" (line 1119)

Justification: 'left', 'right', 'centered'

mixed $ruler = "none" (line 1127)

blocklet ruler: 'none', 'top', 'bottom'

mixed $ruler_colour = "" (line 1133)

Ruler colour

mixed $ruler_size = 1 (line 1131)

Ruler pixel size

mixed $ruler_width = 100 (line 1129)

Ruler width percent: 0-100

mixed $table_autojustify = false (line 1145)

True if we autojustify table

mixed $table_rowstripes = false (line 1147)

True if we autojustify table

mixed $table_style = "" (line 1143)

Table style to apply to content

mixed $type = "text" (line 1115)

The blocklet type: 'text', 'list', 'ordered', 'bullets', or 'table'

mixed $visible = true (line 1149)

Whether blocklet is visible

mixed $width = 100 (line 1117)

The width % of the blocklet table

Methods

Constructor blocklet (line 1158)

Constructor Create a new blocklet object.

blocklet blocklet ([string $id = NEW_BLOCKLET])

string $id: The unique identity of the blocklet.

content_css (line 1267)

Content style.

Returns an internal class style string based on the values of properties: content_colour and content_size. Returns the string as bare style specs 'font-size:0.8em;' etc. $access private

void content_css ()

content_style (line 1292)

Content style.

Returns an internal class style string based on the values of properties: content_colour and content_size. Returns the string as a full 'style="..." style, ready for a <span> tag etc.. $access private

void content_style ()

csv (line 1405)

Render the blocklet as a CSV stream. We split the content types for this into 'table' and 'other'. For tables we use the "|" delimiter to determine where our commas go. For other content we basically just leave it as-is, only adding quotes.

return: The CSV formatted blocklet content.

string csv ()

delete (line 1248)

Delete the blocklet.

Delete this blocklet from the database.

void delete ()

expanded_content (line 1456)

Process the current blocklet content for special tags. This effectively expands the special tags into 'real' content from database, or as image references etc. We return the expanded content as a string.

return: The new content, expanded as appropriate to the tags. $access private

string expanded_content ()

format_content (line 1303)

Format Content.

Formats the given content according to the given content type. $access private

void format_content (mixed $content, [mixed $type = "text"], [mixed $css = ""])

get (line 1169)

Get the blocklet.

Retrieves the specified blocklet from database.

void get (string $id)

string $id: The unique integer identity of the blocklet to get.

html (line 1650)

Render the blocklet.

return: The HTML

string html ()

Redefinition of:

RenderableObject::html(): Return output suitable for normal HTML-capable device. This method must be over-ridden by a method of the same name in the descendant class which renders output to web browsers.

put (line 1208)

Save the blocklet.

Save this blocklet to the database. Create a new one if it doesn't already exist.

void put ()

Inherited Methods

Inherited From RenderableObject

RenderableObject::RenderableObject()
RenderableObject::html()
RenderableObject::render()
RenderableObject::wml()
RenderableObject::wmlup()
RenderableObject::xml()