[cm] element index

Package indexes

All elements
a b c d e f g h i j k l m n o p q r s t u v w
a
top
Variable $author_groups
layout::$author_groups in layout-defs.php
The group membership for Authoring privilege
Variable $author_groups
block::$author_groups in block-defs.php
The group membership for Authoring privilege
Method activate_editing
block::activate_editing() in block-defs.php
Provide a blockeditor. This is used to instantiate a blockeditor object for when we need to change this block somewhow. We only need one, so we check if it's already been done first.
Method activate_editing
layout::activate_editing() in layout-defs.php
Provide a layouteditor. This is used to instantiate a layouteditor object for when we need to change this layout somewhow. We only need one, so we check if it's already been done first.
Method add_blocklet
block::add_blocklet() in block-defs.php
Add a new blocklet to the block.
Method add_metadata_element
Add a metadata element to our array of elements. We add it to an associative array keyed on the element_id, ensuring no duplicates.
b
top
Variable $background_colour
block::$background_colour in block-defs.php
Colour of block background
Variable $background_img
block::$background_img in block-defs.php
Background image - ID from ax_catalog table, if defined
Variable $base_element
metadata_element::$base_element in metadata-defs.php
Whether this is a base element, or has a parent
Variable $block
blockeditor::$block in block-editor-defs.php
The block we are providing
Variable $blockfm
block::$blockfm in block-defs.php
The form name for the current block @access private
Variable $blockid
block::$blockid in block-defs.php
The id of the current block
Variable $blockletid
blocklet::$blockletid in block-defs.php
blocklet ID
Variable $blocklets
block::$blocklets in block-defs.php
Array of blocklet objects in this block
Variable $blocklet_sep
block::$blocklet_sep in block-defs.php
Vertical separation of blocklets in pixels
Variable $blocklet_style
blocklet::$blocklet_style in block-defs.php
Manual style to apply to content
Variable $block_desc
block::$block_desc in block-defs.php
The description of the current block
Variable $block_style
block::$block_style in block-defs.php
Manual style entered by user
Variable $block_type
block::$block_type in block-defs.php
Type of block, ""=empty, "b"=block content, "w"=wysiwyg, "p"=plain cell
Variable $border_colour
block::$border_colour in block-defs.php
Colour of border
Variable $border_width
block::$border_width in block-defs.php
Width of border in pixels
Variable $bytesize
story::$bytesize in story-defs.php
Class block
block in block-defs.php
Block
Method block
block::block() in block-defs.php
Constructor Create a new block object.
Page block-defs.php
block-defs.php in block-defs.php
Page block-editor-defs.php
block-editor-defs.php in block-editor-defs.php
Class blockeditor
blockeditor in block-editor-defs.php
Block Editor
Method blockeditor
blockeditor::blockeditor() in block-editor-defs.php
Constructor Create a new blockeditor object.
Method blocklet
blocklet::blocklet() in block-defs.php
Constructor Create a new blocklet object.
Class blocklet
blocklet in block-defs.php
The blocklet is simply a part of a block. It is almost a 'paragraph' of
Constant BLOCK_CONTENT
BLOCK_CONTENT in block-defs.php
Layout cell content: standard block
c
top
Variable $caption
story_media::$caption in story-defs.php
The caption for this item
Variable $catalogitem
story_media::$catalogitem in story-defs.php
The catalogitem object
Variable $child_element_ids
Child element_ids of this element
Variable $cols
block::$cols in block-defs.php
The number of columns in this block
Variable $comments
enc_qualifier::$comments in metadata-defs.php
Blurb regarding this qualifier
Variable $content
blocklet::$content in block-defs.php
Blocklet textual content
Variable $content
pages::$content in paging-defs.php
Pages content
Variable $content_colour
blocklet::$content_colour in block-defs.php
Content colour
Variable $content_size
blocklet::$content_size in block-defs.php
Content size adjustment -2 thru +2
Method content_css
blocklet::content_css() in block-defs.php
Content style.
Method content_style
blocklet::content_style() in block-defs.php
Content style.
Method csv
block::csv() in block-defs.php
Render the block content as a CSV formatted stream. This is designed to facilitate the exporting of complex tables of data as CSV format for importing into spreadsheets, or databases etc.
Method csv
blocklet::csv() in block-defs.php
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.
d
top
Variable $datasrc_uri
metadata_scheme::$datasrc_uri in metadata-defs.php
URI of scheme data
Variable $default_value
The default value for this element
Variable $default_value
enc_qualifier::$default_value in metadata-defs.php
Default value of this qualifier
Variable $deleted
story::$deleted in story-defs.php
Variable $desc
blocklet::$desc in block-defs.php
The description of the current blocklet
Variable $description
metadata_scheme::$description in metadata-defs.php
A description of the scheme
Variable $description
metadata_element::$description in metadata-defs.php
Element description, usage details
Variable $display_order
enc_qualifier::$display_order in metadata-defs.php
Display order
Variable $display_order
Order of display
Variable $display_order
blocklet::$display_order in block-defs.php
Display order of this blocklet
Method data_meta_tag
data_meta_tag::data_meta_tag() in metadata-defs.php
Constructor
Class data_meta_tag
data_meta_tag in metadata-defs.php
A class which encapsulates a meta tag which itself contains particular information, which may be in a specified language, and may have been picked from a defined vocabulary/encoding scheme.
Constant DEFAULT_AUTHOR_GROUPS
DEFAULT_AUTHOR_GROUPS in block-defs.php
Default Author group membership
Constant DEFAULT_EDITOR_GROUPS
DEFAULT_EDITOR_GROUPS in block-defs.php
Default Editor group membership
Constant DEFAULT_ENTRY_GROUPS
DEFAULT_ENTRY_GROUPS in block-defs.php
Default Entry group membership
Method definition_form
Render a definition form for this metadata element as HTML. This is a self-contained table, and it has all of the element details, and fields for setting the content, language, and scheme. It is not enclosed in a form.
Method definition_form
Render this scheme as HTML. This produces a table containing the
Method delete
block::delete() in block-defs.php
Delete this block from the database. NB: we do not rely on RI to do this since various versions of Postgres don't support this nicely.
Method delete
blocklet::delete() in block-defs.php
Delete the blocklet.
Method delete
layouteditor::delete() in layout-editor-defs.php
Delete the hosted layout from the database. Afterwards, the current object still exists as it was before this method was executed, but the $this->layout->exists flag will have been reset to false.
Method delete
layout::delete() in layout-defs.php
Delete the hosted layout from the database. Afterwards, the current object still exists as it was before this method was executed, but the $this->layout->exists flag will have been reset to false.
Method delete
blockeditor::delete() in block-editor-defs.php
Delete this block from the database. NB: we do not rely on RI to do this since various versions of Postgres don't support this nicely.
Method delete_story
story::delete_story() in story-defs.php
Remove the story from the system. We actually just flag it as deleted on the database, and keep the record.
e
top
Variable $editable_cells
layout::$editable_cells in layout-defs.php
Array of layout cells with edit permission
Variable $editor_groups
layout::$editor_groups in layout-defs.php
The group membership for Editor privilege
Variable $editor_groups
block::$editor_groups in block-defs.php
The group membership for Editor privilege
Variable $edit_blocks
layout::$edit_blocks in layout-defs.php
Array of layout blocks in edit mode
Variable $element_id
metadata_element::$element_id in metadata-defs.php
The element ID for this item
Variable $element_name
metadata_element::$element_name in metadata-defs.php
The base name of this element
Variable $enc_scheme_id
The encoding scheme/vocabulary used to pick the tag content
Variable $enc_scheme_name
Name of this encoding scheme
Variable $enc_scheme_tag
The tag used to identify the encoding scheme used
Variable $entry_groups
layout::$entry_groups in layout-defs.php
The group membership for Entry privilege
Variable $entry_groups
block::$entry_groups in block-defs.php
The group membership for Entry privilege
Variable $exists
block::$exists in block-defs.php
Whether the block exists in database or not
Variable $exists
blocklet::$exists in block-defs.php
Whether blocklet exists in database
Variable $exists
layout::$exists in layout-defs.php
Whether the layout exists in database or not
Variable $expiry_date
story::$expiry_date in story-defs.php
Variable $expiry_date_ts
story::$expiry_date_ts in story-defs.php
Variable $exportable
block::$exportable in block-defs.php
If true, then an EXPORT button will be provided for CSV dump
Method editform
story::editform() in story-defs.php
Render the story details as an edit form.
Constant EMPTY_CELL
EMPTY_CELL in block-defs.php
Layout cell content: empty
Class enc_qualifier
enc_qualifier in metadata-defs.php
A class which encapsulates a scheme qualifier. A qualifier is an attribute which is used in a metadata tag to qualify or refine it.
Method enc_qualifier
enc_qualifier::enc_qualifier() in metadata-defs.php
Constructor
Method expanded_content
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.
f
top
Variable $format_last_modified
The format string for last modified datetime
Variable $formname
story::$formname in story-defs.php
Variable $formname
Standard form name to use
Method format_content
blocklet::format_content() in block-defs.php
Format Content.
Function format_tag_name
format_tag_name() in metadata-defs.php
Function to format a tag name which might have multiple parents.
g
top
Variable $gotinfo
metadata_element::$gotinfo in metadata-defs.php
Whether info has been already got
Variable $gotschemes
metadata_element::$gotschemes in metadata-defs.php
Whether schemes have been already got
Variable $gutter_colour
block::$gutter_colour in block-defs.php
Colour of inter-column gutter
Variable $gutter_width
block::$gutter_width in block-defs.php
Width of inter-column gutter in pixels
Method get
metadata_element::get() in metadata-defs.php
Get all the relevant data for this metadata element.
Method get
layout_metadata_elements::get() in metadata-defs.php
Get all of the metadata elements associated with this layout. We can
Method get
enc_qualifier::get() in metadata-defs.php
Get the data for this qualifier.
Method get
block::get() in block-defs.php
Get the block.
Method get
metadata_scheme::get() in metadata-defs.php
Get the data for this scheme.
Method get
blocklet::get() in block-defs.php
Get the blocklet.
Method get
layout::get() in layout-defs.php
Get the layout.
Method get_catalogitem
Define this story media object from the given catalog item key. This will obtain the given piece of catalog media from the database and assign the object variables accordingly.
Function get_full_tag_name
get_full_tag_name() in metadata-defs.php
Function to acquire the full tag name including descendants, given the tag name, and the parent element ID of that tag.
Method get_info
metadata_element::get_info() in metadata-defs.php
Get all the info which are associated with this metadata element.
Method get_metadata_element
Return a metadata element, given its element_id.
Method get_schemes
metadata_element::get_schemes() in metadata-defs.php
Get all the schemes which are associated with this metadata element.
Method get_story
story::get_story() in story-defs.php
Get a story in total. We always access stories by their ID.
Method get_translation
story::get_translation() in story-defs.php
Returns the story_id of a translation of the current story in the
h
top
Variable $has_expiry
story::$has_expiry in story-defs.php
Variable $has_media
story::$has_media in story-defs.php
Variable $has_multilang
story::$has_multilang in story-defs.php
Variable $has_multimedia
story::$has_multimedia in story-defs.php
Variable $has_precis
story::$has_precis in story-defs.php
Variable $heading
blocklet::$heading in block-defs.php
blocklet heading
Variable $heading_colour
blocklet::$heading_colour in block-defs.php
Heading colour
Variable $heading_level
blocklet::$heading_level in block-defs.php
blocklet heading level (1-6)
Variable $height
story_media::$height in story-defs.php
Local override height
Method html
story::html() in story-defs.php
Render the story. We render the story as a table within a form containing all the form elements required to manipulate the story content, email it to someone, save it, and delete it etc...
Method html
metadata_element::html() in metadata-defs.php
Render this metadata element as HTML.
Method html
layout::html() in layout-defs.php
Render the block content according to the mode of operation we are in. Possible modes: 'viewing', 'editing', 'saving'.
Method html
blocklet::html() in block-defs.php
Render the blocklet.
Method html
named_layout::html() in layout-defs.php
Return HTML for this named layout.
Method html
Render all of the elements as HTML
Method html
block::html() in block-defs.php
Render the block content according to the mode of operation we are in. Possible modes: 'viewing', 'editing', 'saving'.
Method html
pages::html() in paging-defs.php
Deliver HTML format page
i
top
Variable $indexed
metadata_element::$indexed in metadata-defs.php
Whether this element should be indexed
Variable $index_category
layout::$index_category in layout-defs.php
The index category of the current layout - used with Lucene indexing
Variable $info_msg
story::$info_msg in story-defs.php
Variable $instantiated
metadata_element::$instantiated in metadata-defs.php
Whether this element is instantiated as layout metadata
Method index
block::index() in block-defs.php
Index the block.
Method index
story::index() in story-defs.php
Index this story to Lucene, if enabled for this website.
Method index
layout::index() in layout-defs.php
Index all blocks in this layout.
Method index
named_layout::index() in layout-defs.php
Index the named layout. We only do this if the layout version is LIVE or there is only a single version in existence.
Method inherit_schemes
Inherit schemes from parent metadata elements. This involves a traversal of the lineage (parentage) of this current metadata element and retreival of the schemes of each one. Where the scheme is not already associated with this element, it is added.
Method initialise
story::initialise() in story-defs.php
Initialise local vars..
Method insert_metatags
Insert the instantiated metatags into the given webpage. This is intended to be used on the $RESPONSE object to actually jam the tags for this layout into the webapage.
Method is_pendingver
layout::is_pendingver() in layout-defs.php
Return PENDING version status.
j
top
Variable $justify
story_media::$justify in story-defs.php
The way to justify this item
Variable $justify
blocklet::$justify in block-defs.php
Justification: 'left', 'right', 'centered'
Variable $justify
block::$justify in block-defs.php
Justification: 'left', 'center', 'right'
k
top
Method keyinfo
story_media::keyinfo() in story-defs.php
Return the keyinfo string for this media item. This is encoded
l
top
Variable $label
metadata_scheme::$label in metadata-defs.php
Label for scheme
Variable $label
metadata_element::$label in metadata-defs.php
Label against the element value field
Variable $language
layout::$language in layout-defs.php
The language of the layout (0 = default)
Variable $language
metadata_element::$language in metadata-defs.php
The language of the content or resource referenced by URI
Variable $language
story::$language in story-defs.php
Variable $language
block::$language in block-defs.php
The language of the block (0 = default)
Variable $lang_direction
layout::$lang_direction in layout-defs.php
The language text direction
Variable $lang_direction
block::$lang_direction in block-defs.php
The language text direction
Variable $lang_encoding
layout::$lang_encoding in layout-defs.php
The language encoding code
Variable $lang_encoding
block::$lang_encoding in block-defs.php
The language encoding code
Variable $lastmodified
story::$lastmodified in story-defs.php
Variable $lastmodified_ts
story::$lastmodified_ts in story-defs.php
Variable $last_modified
layout::$last_modified in layout-defs.php
Last modified date/time string.
Variable $layout
layouteditor::$layout in layout-editor-defs.php
The layout we are providing
Variable $layouteditor
layout::$layouteditor in layout-defs.php
Local layouteditor object, only instantiated if the
Variable $layoutfm
layout::$layoutfm in layout-defs.php
The name of the layout form
Variable $layoutid
block::$layoutid in block-defs.php
The layout this block belongs to
Variable $layoutid
layout::$layoutid in layout-defs.php
The unique ID of this layout
Variable $layout_blocks
layout::$layout_blocks in layout-defs.php
The layout blocks, keyed on 'row|col'
Variable $layout_id
The layout these elements are for
Variable $layout_lang_direction
The language direction for the containing layout
Variable $layout_lang_encoding
The language encoding for the containing layout
Variable $layout_name
layout::$layout_name in layout-defs.php
The name of the current layout
Variable $layout_style
layout::$layout_style in layout-defs.php
Supplemental layout table style
Variable $layout_table
layout::$layout_table in layout-defs.php
The layout table itself
Variable $layout_version
block::$layout_version in block-defs.php
Version of layout this block belongs to (optional). If present
Variable $layout_version_count
Count of layout versions in existence.
Variable $linked_uri
metadata_element::$linked_uri in metadata-defs.php
Whether the tag value is actually a URL/URI
Variable $list_of_values
enc_qualifier::$list_of_values in metadata-defs.php
Allowed list of values for this qualifier
Variable $list_of_values
A list of permitted element values
Variable $lookahead
pages::$lookahead in paging-defs.php
Number of chars to look ahead
Variable $lookback
pages::$lookback in paging-defs.php
Number of chars to look back
Method layout
layout::layout() in layout-defs.php
Constructor Create a new layout object. To create a new layout then just leave leave the argument list empty.
Class layout
layout in layout-defs.php
Layout A layout can be simply viewed as a table definition. The table cells can contain blocks, and so this entity is provided to allow control of how blocks of content can be arranged on a webpage.
Page layout-defs.php
layout-defs.php in layout-defs.php
Page layout-editor-defs.php
layout-editor-defs.php in layout-editor-defs.php
Class layouteditor
layouteditor in layout-editor-defs.php
Layouteditor
Method layouteditor
layouteditor::layouteditor() in layout-editor-defs.php
Constructor Create a new layouteditor object.
Method layout_metadata_elements
Constructor
Class layout_metadata_elements
layout_metadata_elements in metadata-defs.php
A class which holds multiple metadata elements, for a given layout.
m
top
Variable $message
layout::$message in layout-defs.php
Message to display (optional)
Variable $metadata_elements
The metadata elements themselves
Variable $microsite_name
story::$microsite_name in story-defs.php
Variable $mode
block::$mode in block-defs.php
Mode of operation, 'viewing', 'editing', 'saving' @access private
Method make_precis
story::make_precis() in story-defs.php
Generate a precis from the story content.
Page metadata-defs.php
metadata-defs.php in metadata-defs.php
Method metadata_element
Constructor
Class metadata_element
metadata_element in metadata-defs.php
A class which encapsulates a metadata element. This is the actual object which will be rendered into the end-user content (eg. the webpage), and contains everything necessary for that process.
Class metadata_scheme
metadata_scheme in metadata-defs.php
A class which encapsulates a metadata scheme. This is a set of
Method metadata_scheme
Constructor
Method metadata_tree
Returns a string containing a table which contains all of the meta data in a nice tree view.
Method metatag
metadata_element::metatag() in metadata-defs.php
Render this metadata element as a metatag object. This method creates the metatag object and returns it.
Method meta_element_count
Returns the number of meta elements in this layout.
Method meta_tag
meta_tag::meta_tag() in metadata-defs.php
Constructor. Creates an empty HTML meta tag object.
Class meta_tag
meta_tag in metadata-defs.php
A class which is derived from the generic tag class, and which is specifically for the HTML META tag.
n
top
Variable $newstory
story::$newstory in story-defs.php
Method named_layout
named_layout::named_layout() in layout-defs.php
Constructor
Class named_layout
named_layout in layout-defs.php
Named Layout. A named layout is just another way of grabbing a layout,
Constant NEW_BLOCK
NEW_BLOCK in block-defs.php
Identity value signifying new block
Constant NEW_BLOCKLET
NEW_BLOCKLET in block-defs.php
Identity value signifying new blocklet
Constant NEW_LAYOUT
NEW_LAYOUT in layout-defs.php
New layout to be created
Constant NEW_STORY
NEW_STORY in story-defs.php
New story ID indicator
o
top
Variable $obligation
metadata_element::$obligation in metadata-defs.php
Whether optional, mandatory, conditional or recommended
Variable $obligation_desc
Obligation, descriptive
p
top
Variable $pageno
pages::$pageno in paging-defs.php
Current page number
Variable $pagesize
pages::$pagesize in paging-defs.php
Size of each page in characters
Variable $pagetext
pages::$pagetext in paging-defs.php
Text for current page
Variable $paginghref
pages::$paginghref in paging-defs.php
URL for getting next page
Variable $parent_element_id
The element ID of the parent element of this item
Variable $posted_publish
Flag to indicate POST told us to publish
Variable $posted_revert
named_layout::$posted_revert in layout-defs.php
Flag to indicate POST told us to revert
Variable $preferred
metadata_scheme::$preferred in metadata-defs.php
Whether this is the 'preferred' scheme, of many
Variable $preferred_scheme_id
ID of preferred scheme for this metadata element
Variable $prefix_last_modified
The prefix string for last modified datetime
Variable $privileges
layout::$privileges in layout-defs.php
The group privilege settings for this layout, as
Variable $privilege_groups
layout::$privilege_groups in layout-defs.php
The groups which have privilege settings for this layout, as
Method page
pages::page() in paging-defs.php
Deliver page N Delivers the text content for the specified page.
Class pages
pages in paging-defs.php
Pages class
Method pages
pages::pages() in paging-defs.php
Constructor Creates the basic text paging object.
Page paging-defs.php
paging-defs.php in paging-defs.php
Method paste_layout
layout::paste_layout() in layout-defs.php
Paste the given layout into this layout, replacing the complete
Method perform_hierarchy_scan
Assembles all metadata elements for this layout.
Method plaintext_content
story::plaintext_content() in story-defs.php
Return the content of this story formatted for plaintext display
Constant PLAIN_CELL
PLAIN_CELL in block-defs.php
Layout cell content: plain cell
Method POSTprocess
story::POSTprocess() in story-defs.php
Process the POST from form. This method deals with POSTed content from the edit form.
Method POSTprocess
metadata_element::POSTprocess() in metadata-defs.php
Process the POST of the form of this metadata element. We are just looking for the few fields containing the relevant data.
Method POSTprocess
named_layout::POSTprocess() in layout-defs.php
Process a block edit form POST.
Method publish
named_layout::publish() in layout-defs.php
Publish a pending named layout. All we do in fact, is to replicate the current pending version of the layout (this one) into a new version. That automatically makes this layout the current LIVE one, and the newly created version becomes the new PENDING one.
Method put
layout::put() in layout-defs.php
Save the layout.
Method put
blocklet::put() in block-defs.php
Save the blocklet.
Method put
block::put() in block-defs.php
Save the block.
q
top
Variable $qualifiers
metadata_scheme::$qualifiers in metadata-defs.php
Array of scheme qualifier objects
Variable $qual_label
enc_qualifier::$qual_label in metadata-defs.php
Label for qualifier
Variable $qual_name
enc_qualifier::$qual_name in metadata-defs.php
Name of this qualifier
r
top
Variable $reference_url
metadata_scheme::$reference_url in metadata-defs.php
Reference URL for this scheme
Variable $root_translation_id
story::$root_translation_id in story-defs.php
Variable $root_translation_lang
Variable $ruler
blocklet::$ruler in block-defs.php
blocklet ruler: 'none', 'top', 'bottom'
Variable $ruler_colour
blocklet::$ruler_colour in block-defs.php
Ruler colour
Variable $ruler_size
blocklet::$ruler_size in block-defs.php
Ruler pixel size
Variable $ruler_width
blocklet::$ruler_width in block-defs.php
Ruler width percent: 0-100
Method refresh
layouteditor::refresh() in layout-editor-defs.php
Refresh the layout reference..
Method remove_blocklet
block::remove_blocklet() in block-defs.php
Remove blocklet from the block.
Method remove_metadata_element
Removes the layout metadata for a given element. This deletes the relevant record from the ax_layout_metadata table.
Function render_layouts
render_layouts() in layout-defs.php
Find content layout tags in a string.
Method render_story_icon
story::render_story_icon() in story-defs.php
Return the rendering of the story icon (if one exists) either as a standard HTML anchor tag if an icon URL exists, or as an image.
Method replicate
block::replicate() in block-defs.php
Replicate this block into a new block with a new set of blocklets as a complete content copy of this original block.
Method replicate
blockeditor::replicate() in block-editor-defs.php
Replicate this block into a new block with a new set of blocklets as a complete content copy of this original block.
Method replicate
layout::replicate() in layout-defs.php
Replicate the hosted layout as a new layout. Creates a brand new
Method replicate
layouteditor::replicate() in layout-editor-defs.php
Replicate the hosted layout as a new layout. Creates a brand new
s
top
Variable $schema_name
metadata_element::$schema_name in metadata-defs.php
The meta schema that this item was sourced from
Variable $schema_namespace
The namespace code for the schema
Variable $schema_namespace_uri
The refence URi for the schema
Variable $schemes
metadata_element::$schemes in metadata-defs.php
Schemes associated with this metadata element. This
Variable $scheme_id
metadata_scheme::$scheme_id in metadata-defs.php
Unique encoding scheme ID
Variable $scheme_id
enc_qualifier::$scheme_id in metadata-defs.php
Unique encoding scheme ID
Variable $searchable
metadata_element::$searchable in metadata-defs.php
Whether this element can be searched for
Variable $show_last_modified
layout::$show_last_modified in layout-defs.php
True if we should display last modified date
Variable $storymode
story::$storymode in story-defs.php
Variable $story_author
story::$story_author in story-defs.php
Variable $story_author_name
story::$story_author_name in story-defs.php
Variable $story_category
story::$story_category in story-defs.php
Variable $story_category_desc
story::$story_category_desc in story-defs.php
Variable $story_content
story::$story_content in story-defs.php
Variable $story_date
story::$story_date in story-defs.php
Variable $story_date_ts
story::$story_date_ts in story-defs.php
Variable $story_headline
story::$story_headline in story-defs.php
Variable $story_icon
story::$story_icon in story-defs.php
Variable $story_icon_url
story::$story_icon_url in story-defs.php
Variable $story_id
story::$story_id in story-defs.php
Variable $story_id
story_media::$story_id in story-defs.php
ID of story this media belongs to
Variable $story_locs
story::$story_locs in story-defs.php
Variable $story_media
story::$story_media in story-defs.php
Variable $story_precis
story::$story_precis in story-defs.php
Variable $story_translations
story::$story_translations in story-defs.php
Variable $story_type
story::$story_type in story-defs.php
Method save_metadata_element
Saves the layout metadata for a given element. This saves data to the ax_layout_metadata table.
Method save_story
story::save_story() in story-defs.php
Routine to save the story to the database.
Method set_language
Set the language of the content of this meta data element
Method set_scheme
metadata_element::set_scheme() in metadata-defs.php
Set the scheme used to define the content of this meta data element. If the tag of the scheme is not specified, then we go and find it by looking up the scheme record in the DB.
Method set_tag_value
Set the tag value of this meta data element. This is used when the content is NOT a URI/URL. If it is, then use set_uri() instead.
Method set_uri
metadata_element::set_uri() in metadata-defs.php
Set the tag value to be a URI. Same as setting tag value but we also flick the uri flag as well.
Method story
story::story() in story-defs.php
Constructor
Class story
story in story-defs.php
A class which encapsulates a story or article item. Provides methods to get/save to database, edit the story in a popup window, and view it.
Page story-defs.php
story-defs.php in story-defs.php
Method story_media
story_media::story_media() in story-defs.php
Create a new piece of story media. This comprises a catalogitem object, and a set of methods to access it.
Class story_media
story_media in story-defs.php
A container class for media item associated with a story. Contains a single piece of media which is associated with this story.
t
top
Variable $table_autojustify
True if we autojustify table
Variable $table_autojustify
layout::$table_autojustify in layout-defs.php
Table autojustify flag
Variable $table_rowstripes
layout::$table_rowstripes in layout-defs.php
Table rowstriping mode flag
Variable $table_rowstripes
blocklet::$table_rowstripes in block-defs.php
True if we autojustify table
Variable $table_style
layout::$table_style in layout-defs.php
Table style to apply for plain cells table
Variable $table_style
blocklet::$table_style in block-defs.php
Table style to apply to content
Variable $table_width
layout::$table_width in layout-defs.php
Table width specification
Variable $tag_name
metadata_scheme::$tag_name in metadata-defs.php
Scheme name to be used in meta tags
Variable $tag_name
metadata_element::$tag_name in metadata-defs.php
The full tag name of this element
Variable $tag_value
metadata_element::$tag_value in metadata-defs.php
The content of this metadata tag. This is the actual metadata
Variable $tot_block
layout::$tot_block in layout-defs.php
Total cells containing a content block
Variable $tot_cols
layout::$tot_cols in layout-defs.php
Total columns in layout
Variable $tot_editable
layout::$tot_editable in layout-defs.php
Total editable plain content cells
Variable $tot_empty
layout::$tot_empty in layout-defs.php
Total empty/undefined cells
Variable $tot_plain
layout::$tot_plain in layout-defs.php
Total plain content cells
Variable $tot_rows
layout::$tot_rows in layout-defs.php
Total rows in layout
Variable $tot_viewable
layout::$tot_viewable in layout-defs.php
Total viewable plain content cells
Variable $tot_wysiwyg
layout::$tot_wysiwyg in layout-defs.php
Total wysiwyg content cells
Variable $type
blocklet::$type in block-defs.php
The blocklet type: 'text', 'list', 'ordered', 'bullets', or 'table'
u
top
Method unindex
story::unindex() in story-defs.php
Un-Index this story from Lucene, if enabled for this website.
Method unindex
block::unindex() in block-defs.php
Un-index the block.
Method unindex
named_layout::unindex() in layout-defs.php
Un-Index the named layout. We only do this if the layout version is LIVE or there is only a single version in existence.
Method unindex
layout::unindex() in layout-defs.php
Un-Index all blocks in this layout. After calling this method all the bloacks in the layout will have been removed from the Lucene index.
Method unpublish
named_layout::unpublish() in layout-defs.php
Un-Publish a live named layout. This simply deletes the current pending version of the layout. That makes the current LIVE version the new pending version.
Method uri_meta_tag
uri_meta_tag::uri_meta_tag() in metadata-defs.php
Constructor
Class uri_meta_tag
uri_meta_tag in metadata-defs.php
A class which encapsulates a meta tag which represents a reference to an item using a URL/URI.
Method user_can_edit
story::user_can_edit() in story-defs.php
Determine wwhether user can edit this story.
Method user_can_edit
block::user_can_edit() in block-defs.php
Return true if the current user is permitted to edit block details.
Method user_can_edit
layout::user_can_edit() in layout-defs.php
Return true if the current user is permitted to edit layout details.
v
top
Variable $valid
metadata_scheme::$valid in metadata-defs.php
Whether object contains valid data
Variable $valid
metadata_element::$valid in metadata-defs.php
Whether object contains valid data
Variable $valid
enc_qualifier::$valid in metadata-defs.php
Whether object contains valid data
Variable $valid
story::$valid in story-defs.php
Variable $valign
block::$valign in block-defs.php
Vertical alignment: 'top', 'middle', 'bottom'
Variable $values
metadata_scheme::$values in metadata-defs.php
Array of scheme key/value pairs
Variable $version
named_layout::$version in layout-defs.php
The version of the layout we have
Variable $version_count
named_layout::$version_count in layout-defs.php
Total versions of this layout in database
Variable $viewable_cells
layout::$viewable_cells in layout-defs.php
Array of layout cells with view permission
Variable $visible
story::$visible in story-defs.php
Variable $visible
blocklet::$visible in block-defs.php
Whether blocklet is visible
Constant VERSION_LIVE
VERSION_LIVE in block-defs.php
Block/layout version is live
Constant VERSION_PENDING
VERSION_PENDING in block-defs.php
Block/layout version is pending
Constant VERSION_PREVIOUS
VERSION_PREVIOUS in block-defs.php
Block/layout version is previous
Constant VERSION_UNDEFINED
VERSION_UNDEFINED in block-defs.php
Block/layout version undefined
Method view
story::view() in story-defs.php
Render the story as a maintainer reader would view it. Note that this
w
top
Variable $width
story_media::$width in story-defs.php
Local override width
Variable $width
blocklet::$width in block-defs.php
The width % of the blocklet table
Variable $wordcount
story::$wordcount in story-defs.php
Method wml
pages::wml() in paging-defs.php
Deliver WML format page
Method word_count
story::word_count() in story-defs.php
Do a re-count of the story words. Set our local variable and also return the value as a by-product..
Constant WYSIWYG_EDITOR
WYSIWYG_EDITOR in block-defs.php
Layout cell content: HTMLArea wysiwyg editor
a b c d e f g h i j k l m n o p q r s t u v w