[ Index ]

PHP Cross Reference of MyBB 1.8.32

title

Body

[close]

/admin/inc/ -> class_page.php (summary)

MyBB 1.8 Copyright 2014 MyBB Group, All Rights Reserved

File Size: 1257 lines (35 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 0 files

Defines 3 classes

DefaultPage:: (20 methods):
  output_header()
  output_footer()
  add_breadcrumb_item()
  _generate_breadcrumb()
  output_success()
  output_alert()
  output_inline_message()
  output_error()
  output_inline_error()
  show_login()
  show_2fa()
  show_lockedout()
  show_lockout_unlock()
  add_menu_item()
  _build_menu()
  _build_submenu()
  output_tab_control()
  output_nav_tabs()
  output_confirm_action()
  build_codebuttons_editor()

DefaultSidebarItem:: (4 methods):
  __construct()
  add_menu_items()
  set_contents()
  get_markup()

DefaultPopupMenu:: (4 methods):
  __construct()
  add_item()
  fetch()
  output()


Class: DefaultPage  - X-Ref

output_header($title="")   X-Ref
Output the page header.
param: string $title The title of the page.

output_footer($quit=true)   X-Ref
Output the page footer.
param: bool $quit

add_breadcrumb_item($name, $url="")   X-Ref
Add an item to the page breadcrumb trail.
param: string $name The name of the item to add.
param: string $url The URL to the item we're adding (if there is one)

_generate_breadcrumb()   X-Ref
Generate a breadcrumb trail.
return: bool|string

output_success($message)   X-Ref
Output a success message.
param: string $message The message to output.

output_alert($message, $id="")   X-Ref
Output an alert/warning message.
param: string $message The message to output.
param: string $id The ID of the alert/warning (optional)

output_inline_message($message)   X-Ref
Output an inline message.
param: string $message The message to output.

output_error($error)   X-Ref
Output a single error message.
param: string $error The message to output.

output_inline_error($errors)   X-Ref
Output one or more inline error messages.
param: array $errors Array of error messages to output.

show_login($message="", $class="success")   X-Ref
Generate the login page.
param: string $message The any message to output on the page if there is one.
param: string $class The class name of the message (defaults to success)

show_2fa()   X-Ref
No description

show_lockedout()   X-Ref
Generate the lockout page

show_lockout_unlock($message="", $class="success")   X-Ref
Generate the lockout unlock page
param: string $message The any message to output on the page if there is one.
param: string $class The class name of the message (defaults to success)

add_menu_item($title, $id, $link, $order=10, $submenu=array()   X-Ref
Add an item to the primary navigation menu.
param: string $title The title of the menu item.
param: string $id The ID of the menu item. This should correspond with the module the menu will run.
param: string $link The link to follow when the menu item is clicked.
param: int $order The display order of the menu item. Lower display order means closer to start of the menu.
param: array $submenu Array of sub menu items if there are any.

_build_menu()   X-Ref
Build the actual navigation menu.
return: bool|string

_build_submenu($title, $items)   X-Ref
Build a navigation sub menu if we have one.
param: string $title A title for the sub menu.
param: array $items Array of items for the sub menu.

output_tab_control($tabs=array()   X-Ref
Output a Javascript based tab control on to the page.
param: array $tabs Array of tabs in name => title format. Name should correspond to the name of a DIV containing the tab content.
param: boolean $observe_onload Whether or not to run the event onload or instantly
param: string $id The ID to use for the tabs for if you run multiple instances of the tabbing control in one html page

output_nav_tabs($tabs=array()   X-Ref
Output a series of primary navigation tabs for swithcing between items within a particular module/action.
param: array $tabs Nested array of tabs containing possible keys of align, link_target, link_rel, link, title.
param: string $active The name of the active tab. Corresponds with the key of each tab item.

output_confirm_action($url, $message="", $title="")   X-Ref
Output a page asking if a user wishes to continue performing a specific action.
param: string $url The URL to be forwarded to.
param: string $message The confirmation message to output.
param: string $title The title to use in the output header

build_codebuttons_editor($bind, $editor_language, $smilies)   X-Ref
Build a clickable MyCode editor for the Admin CP.
return: string The build MyCode editor Javascript.
param: string $bind The ID of the textarea to bind the editor to.
param: string $editor_language The language string for the editor.
param: bool $smilies Whether or not smilies should be included

Class: DefaultSidebarItem  - X-Ref

A class for generating side bar blocks.
__construct($title="")   X-Ref
Constructor. Set the title of the side bar block.
param: string $title The title of the side bar block.

add_menu_items($items, $active)   X-Ref
Add menus item to the side bar block.
param: array $items Array of menu items to add. Each menu item should be a nested array of id, link and title.
param: string $active The ID of the active menu item if there is one.

set_contents($html)   X-Ref
Sets custom html to the contents variable
param: string $html The custom html to set

get_markup()   X-Ref
Fetch the HTML markup for the side bar box.
return: string

Class: DefaultPopupMenu  - X-Ref

Generate a Javascript based popup menu.
__construct($id, $title='')   X-Ref
Initialise a new popup menu.

add_item($text, $link, $onclick='')   X-Ref
Add an item to the popup menu.
param: string $text The title of this item.
param: string $link The page this item should link to.
param: string $onclick The onclick event handler if we have one.

fetch()   X-Ref
Fetch the contents of the popup menu.
return: string The popup menu.

output()   X-Ref
Outputs a popup menu to the browser.



2005 - 2021 © MyBB.de | Alle Rechte vorbehalten! | Sponsor: netcup Cross-referenced by PHPXref