-
$background_colour
-
Colour of block background
-
$background_img
-
Background image - ID from ax_catalog table, if defined
-
$base_element
-
Whether this is a base element, or has a parent
-
$block
-
The block we are providing
-
$blockfm
-
The form name for the current block @access private
-
$blockid
-
The id of the current block
-
$blockletid
-
blocklet ID
-
$blocklets
-
Array of blocklet objects in this block
-
$blocklet_sep
-
Vertical separation of blocklets in pixels
-
$blocklet_style
-
Manual style to apply to content
-
$block_desc
-
The description of the current block
-
$block_style
-
Manual style entered by user
-
$block_type
-
Type of block, ""=empty, "b"=block content, "w"=wysiwyg, "p"=plain cell
-
$border_colour
-
Colour of border
-
$border_width
-
Width of border in pixels
-
$bytesize
-
-
block
-
Block
-
block
-
Constructor Create a new block object.
-
block-defs.php
-
-
block-editor-defs.php
-
-
blockeditor
-
Block Editor
-
blockeditor
-
Constructor Create a new blockeditor object.
-
blocklet
-
Constructor Create a new blocklet object.
-
blocklet
-
The blocklet is simply a part of a block. It is almost a 'paragraph' of
-
BLOCK_CONTENT
-
Layout cell content: standard block
-
$datasrc_uri
-
URI of scheme data
-
$default_value
-
The default value for this element
-
$default_value
-
Default value of this qualifier
-
$deleted
-
-
$desc
-
The description of the current blocklet
-
$description
-
A description of the scheme
-
$description
-
Element description, usage details
-
$display_order
-
Display order
-
$display_order
-
Order of display
-
$display_order
-
Display order of this blocklet
-
data_meta_tag
-
Constructor
-
data_meta_tag
-
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.
-
DEFAULT_AUTHOR_GROUPS
-
Default Author group membership
-
DEFAULT_EDITOR_GROUPS
-
Default Editor group membership
-
DEFAULT_ENTRY_GROUPS
-
Default Entry group membership
-
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.
-
definition_form
-
Render this scheme as HTML. This produces a table containing the
-
delete
-
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.
-
delete
-
Delete the blocklet.
-
delete
-
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.
-
delete
-
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.
-
delete
-
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.
-
delete_story
-
Remove the story from the system. We actually just flag it as deleted on the database, and keep the record.
-
$editable_cells
-
Array of layout cells with edit permission
-
$editor_groups
-
The group membership for Editor privilege
-
$editor_groups
-
The group membership for Editor privilege
-
$edit_blocks
-
Array of layout blocks in edit mode
-
$element_id
-
The element ID for this item
-
$element_name
-
The base name of this element
-
$enc_scheme_id
-
The encoding scheme/vocabulary used to pick the tag content
-
$enc_scheme_name
-
Name of this encoding scheme
-
$enc_scheme_tag
-
The tag used to identify the encoding scheme used
-
$entry_groups
-
The group membership for Entry privilege
-
$entry_groups
-
The group membership for Entry privilege
-
$exists
-
Whether the block exists in database or not
-
$exists
-
Whether blocklet exists in database
-
$exists
-
Whether the layout exists in database or not
-
$expiry_date
-
-
$expiry_date_ts
-
-
$exportable
-
If true, then an EXPORT button will be provided for CSV dump
-
editform
-
Render the story details as an edit form.
-
EMPTY_CELL
-
Layout cell content: empty
-
enc_qualifier
-
A class which encapsulates a scheme qualifier. A qualifier is an attribute which is used in a metadata tag to qualify or refine it.
-
enc_qualifier
-
Constructor
-
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.
-
$gotinfo
-
Whether info has been already got
-
$gotschemes
-
Whether schemes have been already got
-
$gutter_colour
-
Colour of inter-column gutter
-
$gutter_width
-
Width of inter-column gutter in pixels
-
get
-
Get all the relevant data for this metadata element.
-
get
-
Get all of the metadata elements associated with this layout. We can
-
get
-
Get the data for this qualifier.
-
get
-
Get the block.
-
get
-
Get the data for this scheme.
-
get
-
Get the blocklet.
-
get
-
Get the layout.
-
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.
-
get_full_tag_name
-
Function to acquire the full tag name including descendants, given the tag name, and the parent element ID of that tag.
-
get_info
-
Get all the info which are associated with this metadata element.
-
get_metadata_element
-
Return a metadata element, given its element_id.
-
get_schemes
-
Get all the schemes which are associated with this metadata element.
-
get_story
-
Get a story in total. We always access stories by their ID.
-
get_translation
-
Returns the story_id of a translation of the current story in the
-
$label
-
Label for scheme
-
$label
-
Label against the element value field
-
$language
-
The language of the layout (0 = default)
-
$language
-
The language of the content or resource referenced by URI
-
$language
-
-
$language
-
The language of the block (0 = default)
-
$lang_direction
-
The language text direction
-
$lang_direction
-
The language text direction
-
$lang_encoding
-
The language encoding code
-
$lang_encoding
-
The language encoding code
-
$lastmodified
-
-
$lastmodified_ts
-
-
$last_modified
-
Last modified date/time string.
-
$layout
-
The layout we are providing
-
$layouteditor
-
Local layouteditor object, only instantiated if the
-
$layoutfm
-
The name of the layout form
-
$layoutid
-
The layout this block belongs to
-
$layoutid
-
The unique ID of this layout
-
$layout_blocks
-
The layout blocks, keyed on 'row|col'
-
$layout_id
-
The layout these elements are for
-
$layout_lang_direction
-
The language direction for the containing layout
-
$layout_lang_encoding
-
The language encoding for the containing layout
-
$layout_name
-
The name of the current layout
-
$layout_style
-
Supplemental layout table style
-
$layout_table
-
The layout table itself
-
$layout_version
-
Version of layout this block belongs to (optional). If present
-
$layout_version_count
-
Count of layout versions in existence.
-
$linked_uri
-
Whether the tag value is actually a URL/URI
-
$list_of_values
-
Allowed list of values for this qualifier
-
$list_of_values
-
A list of permitted element values
-
$lookahead
-
Number of chars to look ahead
-
$lookback
-
Number of chars to look back
-
layout
-
Constructor Create a new layout object. To create a new layout then just leave leave the argument list empty.
-
layout
-
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.
-
layout-defs.php
-
-
layout-editor-defs.php
-
-
layouteditor
-
Layouteditor
-
layouteditor
-
Constructor Create a new layouteditor object.
-
layout_metadata_elements
-
Constructor
-
layout_metadata_elements
-
A class which holds multiple metadata elements, for a given layout.
-
$message
-
Message to display (optional)
-
$metadata_elements
-
The metadata elements themselves
-
$microsite_name
-
-
$mode
-
Mode of operation, 'viewing', 'editing', 'saving' @access private
-
make_precis
-
Generate a precis from the story content.
-
metadata-defs.php
-
-
metadata_element
-
Constructor
-
metadata_element
-
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.
-
metadata_scheme
-
A class which encapsulates a metadata scheme. This is a set of
-
metadata_scheme
-
Constructor
-
metadata_tree
-
Returns a string containing a table which contains all of the meta data in a nice tree view.
-
metatag
-
Render this metadata element as a metatag object. This method creates the metatag object and returns it.
-
meta_element_count
-
Returns the number of meta elements in this layout.
-
meta_tag
-
Constructor. Creates an empty HTML meta tag object.
-
meta_tag
-
A class which is derived from the generic tag class, and which is specifically for the HTML META tag.
-
$pageno
-
Current page number
-
$pagesize
-
Size of each page in characters
-
$pagetext
-
Text for current page
-
$paginghref
-
URL for getting next page
-
$parent_element_id
-
The element ID of the parent element of this item
-
$posted_publish
-
Flag to indicate POST told us to publish
-
$posted_revert
-
Flag to indicate POST told us to revert
-
$preferred
-
Whether this is the 'preferred' scheme, of many
-
$preferred_scheme_id
-
ID of preferred scheme for this metadata element
-
$prefix_last_modified
-
The prefix string for last modified datetime
-
$privileges
-
The group privilege settings for this layout, as
-
$privilege_groups
-
The groups which have privilege settings for this layout, as
-
page
-
Deliver page N Delivers the text content for the specified page.
-
pages
-
Pages class
-
pages
-
Constructor Creates the basic text paging object.
-
paging-defs.php
-
-
paste_layout
-
Paste the given layout into this layout, replacing the complete
-
perform_hierarchy_scan
-
Assembles all metadata elements for this layout.
-
plaintext_content
-
Return the content of this story formatted for plaintext display
-
PLAIN_CELL
-
Layout cell content: plain cell
-
POSTprocess
-
Process the POST from form. This method deals with POSTed content from the edit form.
-
POSTprocess
-
Process the POST of the form of this metadata element. We are just looking for the few fields containing the relevant data.
-
POSTprocess
-
Process a block edit form POST.
-
publish
-
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.
-
put
-
Save the layout.
-
put
-
Save the blocklet.
-
put
-
Save the block.
-
$reference_url
-
Reference URL for this scheme
-
$root_translation_id
-
-
$root_translation_lang
-
-
$ruler
-
blocklet ruler: 'none', 'top', 'bottom'
-
$ruler_colour
-
Ruler colour
-
$ruler_size
-
Ruler pixel size
-
$ruler_width
-
Ruler width percent: 0-100
-
refresh
-
Refresh the layout reference..
-
remove_blocklet
-
Remove blocklet from the block.
-
remove_metadata_element
-
Removes the layout metadata for a given element. This deletes the relevant record from the ax_layout_metadata table.
-
render_layouts
-
Find content layout tags in a string.
-
render_story_icon
-
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.
-
replicate
-
Replicate this block into a new block with a new set of blocklets as a complete content copy of this original block.
-
replicate
-
Replicate this block into a new block with a new set of blocklets as a complete content copy of this original block.
-
replicate
-
Replicate the hosted layout as a new layout. Creates a brand new
-
replicate
-
Replicate the hosted layout as a new layout. Creates a brand new
-
$schema_name
-
The meta schema that this item was sourced from
-
$schema_namespace
-
The namespace code for the schema
-
$schema_namespace_uri
-
The refence URi for the schema
-
$schemes
-
Schemes associated with this metadata element. This
-
$scheme_id
-
Unique encoding scheme ID
-
$scheme_id
-
Unique encoding scheme ID
-
$searchable
-
Whether this element can be searched for
-
$show_last_modified
-
True if we should display last modified date
-
$storymode
-
-
$story_author
-
-
$story_author_name
-
-
$story_category
-
-
$story_category_desc
-
-
$story_content
-
-
$story_date
-
-
$story_date_ts
-
-
$story_headline
-
-
$story_icon
-
-
$story_icon_url
-
-
$story_id
-
-
$story_id
-
ID of story this media belongs to
-
$story_locs
-
-
$story_media
-
-
$story_precis
-
-
$story_translations
-
-
$story_type
-
-
save_metadata_element
-
Saves the layout metadata for a given element. This saves data to the ax_layout_metadata table.
-
save_story
-
Routine to save the story to the database.
-
set_language
-
Set the language of the content of this meta data element
-
set_scheme
-
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.
-
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.
-
set_uri
-
Set the tag value to be a URI. Same as setting tag value but we also flick the uri flag as well.
-
story
-
Constructor
-
story
-
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.
-
story-defs.php
-
-
story_media
-
Create a new piece of story media. This comprises a catalogitem object, and a set of methods to access it.
-
story_media
-
A container class for media item associated with a story. Contains a single piece of media which is associated with this story.
-
$table_autojustify
-
True if we autojustify table
-
$table_autojustify
-
Table autojustify flag
-
$table_rowstripes
-
Table rowstriping mode flag
-
$table_rowstripes
-
True if we autojustify table
-
$table_style
-
Table style to apply for plain cells table
-
$table_style
-
Table style to apply to content
-
$table_width
-
Table width specification
-
$tag_name
-
Scheme name to be used in meta tags
-
$tag_name
-
The full tag name of this element
-
$tag_value
-
The content of this metadata tag. This is the actual metadata
-
$tot_block
-
Total cells containing a content block
-
$tot_cols
-
Total columns in layout
-
$tot_editable
-
Total editable plain content cells
-
$tot_empty
-
Total empty/undefined cells
-
$tot_plain
-
Total plain content cells
-
$tot_rows
-
Total rows in layout
-
$tot_viewable
-
Total viewable plain content cells
-
$tot_wysiwyg
-
Total wysiwyg content cells
-
$type
-
The blocklet type: 'text', 'list', 'ordered', 'bullets', or 'table'
-
$valid
-
Whether object contains valid data
-
$valid
-
Whether object contains valid data
-
$valid
-
Whether object contains valid data
-
$valid
-
-
$valign
-
Vertical alignment: 'top', 'middle', 'bottom'
-
$values
-
Array of scheme key/value pairs
-
$version
-
The version of the layout we have
-
$version_count
-
Total versions of this layout in database
-
$viewable_cells
-
Array of layout cells with view permission
-
$visible
-
-
$visible
-
Whether blocklet is visible
-
VERSION_LIVE
-
Block/layout version is live
-
VERSION_PENDING
-
Block/layout version is pending
-
VERSION_PREVIOUS
-
Block/layout version is previous
-
VERSION_UNDEFINED
-
Block/layout version undefined
-
view
-
Render the story as a maintainer reader would view it. Note that this