[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/actions/ -> InfoAction.php (summary)

Displays information about a page. Copyright © 2011 Alexandre Emsenhuber

File Size: 849 lines (25 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

InfoAction:: (13 methods):
  getName()
  requiresUnblock()
  requiresWrite()
  invalidateCache()
  onView()
  makeHeader()
  addRow()
  addTable()
  pageInfo()
  pageCounts()
  getPageTitle()
  getContributors()
  getDescription()


Class: InfoAction  - X-Ref

Displays information about a page.

getName()   X-Ref
Returns the name of the action this object responds to.

return: string Lowercase name

requiresUnblock()   X-Ref
Whether this action can still be executed by a blocked user.

return: bool

requiresWrite()   X-Ref
Whether this action requires the wiki not to be locked.

return: bool

invalidateCache( Title $title )   X-Ref
Clear the info cache for a given Title.

param: Title $title Title to clear cache for

onView()   X-Ref
Shows page information on GET request.

return: string Page information that will be added to the output

makeHeader( $header )   X-Ref
Creates a header that can be added to the output.

param: string $header The header text.
return: string The HTML.

addRow( $table, $name, $value, $id )   X-Ref
Adds a row to a table that will be added to the content.

param: string $table The table that will be added to the content
param: string $name The name of the row
param: string $value The value of the row
param: string $id The ID to use for the 'tr' element
return: string The table with the row added

addTable( $content, $table )   X-Ref
Adds a table to the content that will be added to the output.

param: string $content The content that will be added to the output
param: string $table The table
return: string The content with the table added

pageInfo()   X-Ref
Returns page information in an easily-manipulated format. Array keys are used so extensions
may add additional information in arbitrary positions. Array values are arrays with one
element to be rendered as a header, arrays with two elements to be rendered as a table row.

return: array

pageCounts( Title $title )   X-Ref
Returns page counts that would be too "expensive" to retrieve by normal means.

param: Title $title Title to get counts for
return: array

getPageTitle()   X-Ref
Returns the name that goes in the "<h1>" page title.

return: string

getContributors()   X-Ref
Get a list of contributors of $article

return: string Html

getDescription()   X-Ref
Returns the description that goes below the "<h1>" tag.

return: string



Generated: Fri Nov 28 14:03:12 2014 Cross-referenced by PHPXref 0.7.1