cedi_add_page (line 205)
Add a CEDI page
AUTO_LINK
cedi_add_page
(SHORT_TEXT $title, LONG_TEXT $description, LONG_TEXT $notes, BINARY $hide_posts, [?MEMBER $member = NULL])
-
SHORT_TEXT
$title: The page title
-
LONG_TEXT
$description: The page description
-
LONG_TEXT
$notes: Hidden notes pertaining to the page
-
BINARY
$hide_posts: Whether to hide the posts on the page by default
-
?MEMBER
$member: The member doing the action (NULL: current member)
cedi_add_post (line 91)
Edit a CEDI post
AUTO_LINK
cedi_add_post
(AUTO_LINK $id, string $message, [BINARY $validated = 1], [?MEMBER $member = NULL], [boolean $send_mail = true])
-
AUTO_LINK
$id: The page ID
-
string
$message: The new post
-
BINARY
$validated: Whether the post will be validated
-
?MEMBER
$member: The member doing the action (NULL: current member)
-
boolean
$send_mail: Whether to send out a staff e-mail about the new CEDI post
cedi_breadcrumbs (line 323)
Convert a CEDI chain to a nice formatted XHTML tree.
tempcode
cedi_breadcrumbs
(string $chain, [?string $current_title = NULL], [boolean $final_link = false], [boolean $links = true], [boolean $this_link_virtual_root = false])
-
string
$chain: The chain to convert (which should include the current page ID)
-
?string
$current_title: The title of the current CEDI page (if not given, it is looked up) (NULL: work it out)
-
boolean
$final_link: Whether to show the final tree element with a link to it (all others will always have links if $links is true)
-
boolean
$links: Whether to show links to pages in the tree
-
boolean
$this_link_virtual_root: Whether to make the link as a virtual-root link (only applies if $final_link is true)
cedi_delete_page (line 262)
Delete a CEDI page
void
cedi_delete_page
(AUTO_LINK $id)
-
AUTO_LINK
$id: The page ID
cedi_delete_post (line 174)
Delete a CEDI post
void
cedi_delete_post
(AUTO_LINK $post_id, [?MEMBER $member = NULL])
-
AUTO_LINK
$post_id: The post ID
-
?MEMBER
$member: The member doing the action (NULL: current member)
cedi_derive_chain (line 383)
Create a CEDI chain from the specified page ID
string
cedi_derive_chain
(AUTO_LINK $id)
-
AUTO_LINK
$id: The ID of the page to derive a chain for
cedi_edit_page (line 238)
Edit a CEDI page
void
cedi_edit_page
(AUTO_LINK $id, SHORT_TEXT $title, LONG_TEXT $description, LONG_TEXT $notes, BINARY $hide_posts, SHORT_TEXT $meta_keywords, LONG_TEXT $meta_description, [?MEMBER $member = NULL])
-
AUTO_LINK
$id: The page ID
-
SHORT_TEXT
$title: The page title
-
LONG_TEXT
$description: The page description
-
LONG_TEXT
$notes: Hidden notes pertaining to the page
-
BINARY
$hide_posts: Whether to hide the posts on the page by default
-
SHORT_TEXT
$meta_keywords: Meta keywords
-
LONG_TEXT
$meta_description: Meta description
-
?MEMBER
$member: The member doing the action (NULL: current member)
cedi_edit_post (line 147)
Edit a CEDI post
void
cedi_edit_post
(AUTO_LINK $post_id, string $message, boolean $validated, [?MEMBER $member = NULL])
-
AUTO_LINK
$post_id: The post ID
-
string
$message: The new post
-
boolean
$validated: Whether the post will be validated
-
?MEMBER
$member: The member doing the action (NULL: current member)
cedi_show_tree (line 411)
Get a nice formatted XHTML list of all the children beneath the specified CEDI page. This function is recursive.
mixed
cedi_show_tree
([?AUTO_LINK $select = NULL], [?AUTO_LINK $id = NULL], [string $tree = ''], [boolean $include_orphans = true], [boolean $use_compound_list = false], [boolean $ins_format = false])
-
?AUTO_LINK
$select: The CEDI page to select by default (NULL: none)
-
?AUTO_LINK
$id: The CEDI page to look beneath (NULL: the root)
-
string
$tree: Tree built up so far, in recursion (blank: starting recursion)
-
boolean
$include_orphans: Whether to include orphaned pages in the tree
-
boolean
$use_compound_list: Whether to create a compound list (gets pairs: tempcode, and comma-separated list of children)
-
boolean
$ins_format: Whether to use titles in IDs after a ! (used on tree edit page)
get_cedi_page_html (line 58)
Get tempcode for a CEDI post 'feature box' for the given row
tempcode
get_cedi_page_html
(array $row, [ID_TEXT $zone = '_SEARCH'], [boolean $put_in_box = true])
-
array
$row: The database field row of it
-
ID_TEXT
$zone: The zone to use
-
boolean
$put_in_box: Whether to put it in a box
get_cedi_page_tree (line 514)
Get a list of maps containing all the subpages, and path information, of the specified page - and those beneath it, recursively.
array
get_cedi_page_tree
(array &$cedi_seen, [?AUTO_LINK $page_id = NULL], [?string $tree = NULL], [?ID_TEXT $title = NULL], [boolean $do_stats = true], [boolean $use_compound_list = false], [?integer $levels = NULL])
-
array
&$cedi_seen: A list of pages we've already seen (we don't repeat them in multiple list positions)
-
?AUTO_LINK
$page_id: The page being at the root of our recursion (NULL: true root page)
-
?string
$tree: The tree up to this point in the recursion (NULL: blank, as we are starting the recursion)
-
?ID_TEXT
$title: The name of the $page_id we are currently going through (NULL: look it up). This is here for efficiency reasons, as finding children IDs to recurse to also reveals the childs title
-
boolean
$do_stats: Whether to collect post counts with our tree information
-
boolean
$use_compound_list: Whether to make a compound list (a pair of a comma-separated list of children, and the child array)
-
?integer
$levels: The number of recursive levels to search (NULL: all)
get_cedi_post_html (line 33)
Get tempcode for a CEDI post 'feature box' for the given row
tempcode
get_cedi_post_html
(array $row, [ID_TEXT $zone = '_SEARCH'], [boolean $put_in_box = true])
-
array
$row: The database field row of it
-
ID_TEXT
$zone: The zone to use
-
boolean
$put_in_box: Whether to put it in a box
get_param_cedi_chain (line 297)
Get a chain script parameter or just an ID, in which case it does more work), and converts it into a id/chain pair
array
get_param_cedi_chain
(ID_TEXT $parameter_name, [?string $default_value = NULL])
-
ID_TEXT
$parameter_name: The name of the GET parameter that stores the chain
-
?string
$default_value: The default value for the chain (NULL: no default)
_cedi_show_tree (line 459)
Helper function. Get a nice formatted XHTML list of all the children beneath the specified CEDI page. This function is recursive.
mixed
_cedi_show_tree
(array &$cedi_seen, ?AUTO_LINK $select, AUTO_LINK $id, string $tree, SHORT_TEXT $title, [boolean $use_compound_list = false], [boolean $ins_format = false])
-
array
&$cedi_seen: A list of pages we've already seen (we don't repeat them in multiple list positions)
-
?AUTO_LINK
$select: The CEDI page to select by default (NULL: none)
-
AUTO_LINK
$id: The CEDI page to look beneath
-
string
$tree: Tree built up so far, in recursion (blank: starting recursion)
-
SHORT_TEXT
$title: The title of the CEDI page to look beneath
-
boolean
$use_compound_list: Whether to create a compound list (gets pairs: tempcode, and comma-separated list of children)
-
boolean
$ins_format: Whether to use titles in IDs after a ! (used on tree edit page)