Class Module_tickets

Description

Module page class.

Located in /site/pages/modules/tickets.php (line 24)


	
			
Method Summary
array build_types_list (?AUTO_LINK $selected_ticket_type)
void check_id (string $id)
tempcode do_choose_ticket ()
?tempcode do_search (tempcode $title, string $ticket_id, string $content)
tempcode do_ticket ()
tempcode do_update_ticket ()
array extract_page_link_permissions (string $page_link)
?array get_entry_points ()
?array get_page_links ([?integer $max_depth = NULL], [boolean $require_permission_support = false], [?string $start_at = NULL], [boolean $dont_care_about_categories = false])
void get_sitemap_pagelinks (string $callback, MEMBER $member_id, integer $depth, string $pagelink_stub, [?string $parent_pagelink = NULL], [integer $recurse_level = 0], [?array $category_data = NULL])
?array info ()
void install ([?integer $upgrade_from = NULL], [?integer $upgrade_from_hack = NULL])
tempcode run ()
tempcode toggle_ticket_closed ()
void uninstall ()
Methods
build_types_list (line 381)

Build a list of ticket types.

  • return: A map between ticket types, and template-ready details about them
array build_types_list (?AUTO_LINK $selected_ticket_type)
  • ?AUTO_LINK $selected_ticket_type: The current selected ticket type (NULL: none)
check_id (line 287)

Checks the ticket ID is valid, and there is access for the current member to view it. Bombs out if there's a problem.

void check_id (string $id)
  • string $id: The ticket ID to check
do_choose_ticket (line 306)

The UI to show support tickets we may view.

  • return: The UI
tempcode do_choose_ticket ()
do_search (line 713)

Check for existing FAQs matching a ticket to be submitted, via searching.

  • return: The search results (NULL: could not search)
?tempcode do_search (tempcode $title, string $ticket_id, string $content)
  • tempcode $title: Page title
  • string $ticket_id: Ticket ID we'd be creating
  • string $content: What is being searched for
do_ticket (line 400)

The UI to either show an existing ticket and allow a reply, or to start a new ticket.

  • return: The UI
tempcode do_ticket ()
do_update_ticket (line 632)

Actualise ticket creation/reply, then show the ticket again.

  • return: The UI
tempcode do_update_ticket ()
extract_page_link_permissions (line 249)

Convert a page link to a category ID and category permission module type.

  • return: The pair
array extract_page_link_permissions (string $page_link)
  • string $page_link: The page link
get_entry_points (line 150)

Standard modular entry-point finder function.

  • return: A map of entry points (type-code=>language-code) (NULL: disabled).
?array get_entry_points ()
get_page_links (line 164)

Standard modular page-link finder function (does not return the main entry-points that are not inside the tree).

  • return: A tuple: 1) full tree structure [made up of (pagelink, permission-module, permissions-id, title, children, ?entry point for the children, ?children permission module, ?whether there are children) OR a list of maps from a get_* function] 2) permissions-page 3) optional base entry-point for the tree 4) optional permission-module 5) optional permissions-id (NULL: disabled).
?array get_page_links ([?integer $max_depth = NULL], [boolean $require_permission_support = false], [?string $start_at = NULL], [boolean $dont_care_about_categories = false])
  • ?integer $max_depth: The number of tree levels to computer (NULL: no limit)
  • boolean $require_permission_support: Whether to not return stuff that does not support permissions (unless it is underneath something that does).
  • ?string $start_at: Position to start at in the tree. Does not need to be respected. (NULL: from root)
  • boolean $dont_care_about_categories: Whether to avoid returning categories.
get_sitemap_pagelinks (line 193)

Standard modular new-style deep page-link finder function (does not return the main entry-points).

void get_sitemap_pagelinks (string $callback, MEMBER $member_id, integer $depth, string $pagelink_stub, [?string $parent_pagelink = NULL], [integer $recurse_level = 0], [?array $category_data = NULL])
  • string $callback: Callback function to send discovered page-links to.
  • MEMBER $member_id: The member we are finding stuff for (we only find what the member can view).
  • integer $depth: Code for how deep we are tunnelling down, in terms of whether we are getting entries as well as categories.
  • string $pagelink_stub: Stub used to create page-links. This is passed in because we don't want to assume a zone or page name within this function.
  • ?string $parent_pagelink: Where we're looking under (NULL: root of tree). We typically will NOT show a root node as there's often already an entry-point representing it.
  • integer $recurse_level: Our recursion depth (used to calculate importance of page-link, used for instance by Google sitemap). Deeper is typically less important.
  • ?array $category_data: Non-standard for API [extra parameter tacked on] (NULL: yet unknown). Contents of database table for performance.
info (line 32)

Standard modular info function.

  • return: Map of module info (NULL: module is disabled).
?array info ()
install (line 72)

Standard modular install function.

void install ([?integer $upgrade_from = NULL], [?integer $upgrade_from_hack = NULL])
  • ?integer $upgrade_from: What version we're upgrading from (NULL: new install)
  • ?integer $upgrade_from_hack: What hack version we're upgrading from (NULL: new-install/not-upgrading-from-a-hacked-version)
run (line 261)

Standard modular run function.

  • return: The result of execution.
tempcode run ()
toggle_ticket_closed (line 600)

Actualise to toggle the closed state of a ticket.

  • return: The UI
tempcode toggle_ticket_closed ()
uninstall (line 48)

Standard modular uninstall function.

void uninstall ()

Documentation generated on Sun, 02 Jan 2011 23:27:05 +0000 by phpDocumentor 1.4.3