Diviner Tech Docs PhabricatorStandardPageView

final class PhabricatorStandardPageView
Phorge Technical Documentation ()

This is a standard Phabricator page with menus, Javelin, DarkConsole, and basic styles.

Tasks

Managing Children

protected function canAppendChild() — Test if this View accepts children.
final public function hasChildren() — Test if an element has no children.
private function reduceChildren($children) — Reduce effectively-empty lists of children to be actually empty. This recursively removes `null`, `''`, and `array()` from the list of children so that @{method:hasChildren} can more effectively align with expectations.

Other Methods

public function setViewer($viewer) — Set the user viewing this element.
public function getViewer() — Get the user viewing this element.
public function hasViewer() — Test if a viewer has been set on this element.
final public function appendChild($child) — Append a child to the list of children.
public function getDefaultResourceSource()
public function requireResource($symbol)
public function initBehavior($name, $config)
public function willRender() — Inconsistent, unreliable pre-rendering hook.
public function render()
public function producePhutilSafeHTML()
public function setTitle($title)
public function getTitle()
protected function getHead()
protected function getBody()
protected function getTail()
protected function willRenderPage()
protected function willSendResponse($response)
protected function getBodyClasses()
public function setController($controller)
public function getController()
public function setRequest($request)
public function getRequest()
public function setFrameable($frameable)
public function getFrameable()
public function setDeviceReady($device_ready)
public function getDeviceReady()
private function newFavicons()
public function setShowFooter($show_footer)
public function getShowFooter()
public function setApplicationName($application_name)
public function setDisableConsole($disable)
public function getApplicationName()
public function setBaseURI($base_uri)
public function getBaseURI()
public function setShowChrome($show_chrome)
public function getShowChrome()
public function addClass($class)
public function setPageObjectPHIDs($phids)
public function setShowDurableColumn($show)
public function getShowDurableColumn()
private function isQuicksandBlacklistURI()
public function getDurableColumnVisible()
public function getDurableColumnMinimize()
public function addQuicksandConfig($config)
public function getQuicksandConfig()
public function setCrumbs($crumbs)
public function getCrumbs()
public function setTabs($tabs)
public function getTabs()
public function setNavigation($navigation)
public function getNavigation()
public function setGlyph($glyph)
public function getGlyph()
private function renderPageBodyContent()
private function getConsole()
private function getConsoleConfig()
private function getHighSecurityWarningConfig()
private function renderFooter()
public function renderForQuicksand()
private function buildQuicksandConfig()
private function buildAphlictListenConfigData()
private function getQuicksandURIPatternBlacklist()
private function getUserPreference($key, $default)
public function produceAphrontResponse()

config

public function setUser($user) — Deprecated, use @{method:setViewer}.
protected function getUser() — Deprecated, use @{method:getViewer}.

1

final protected function renderChildren() — Produce children for rendering.

Methods

public function setViewer($viewer)
Inherited

AphrontView

Set the user viewing this element.

Parameters

PhabricatorUser

$viewer

Viewing user.

Return

this

public function getViewer()
Inherited

AphrontView

Get the user viewing this element.

Throws an exception if no viewer has been set.

Return

PhabricatorUser

Viewing user.

public function hasViewer()
Inherited

AphrontView

Test if a viewer has been set on this element.

Return

bool	True if a viewer is available.

public function setUser($user)
Inherited

AphrontView

Deprecated, use setViewer().

Parameters

PhabricatorUser

$user

Return

wild

protected function getUser()
Inherited

AphrontView

Deprecated, use getViewer().

Return

wild

protected function canAppendChild()
Inherited

AphrontView

Test if this View accepts children.

By default, views accept children, but subclases may override this method to prevent children from being appended. Doing so will cause appendChild() to throw exceptions instead of appending children.

Return

bool	True if the View should accept children.

final public function appendChild($child)
Inherited

AphrontView

Append a child to the list of children.

This method will only work if the view supports children, which is determined by canAppendChild().

Parameters

wild

$child

Something renderable.

Return

this

final protected function renderChildren()
Inherited

AphrontView

Produce children for rendering.

Historically, this method reduced children to a string representation, but it no longer does.

Return

wild	Renderable children.

final public function hasChildren()
Inherited

AphrontView

Test if an element has no children.

Return

bool	True if this element has children.

private function reduceChildren($children)
Inherited

AphrontView

Reduce effectively-empty lists of children to be actually empty. This recursively removes null, '', and array() from the list of children so that hasChildren() can more effectively align with expectations.

NOTE: Because View children are not rendered, a View which renders down to nothing will not be reduced by this method.

Parameters

list<wild>

$children

Renderable children.

Return

list<wild>

Reduced list of children.

public function getDefaultResourceSource()
Inherited

This method is not documented.

Return

wild

public function requireResource($symbol)
Inherited

This method is not documented.

Parameters

$symbol

Return

wild

public function initBehavior($name, $config)
Inherited

This method is not documented.

Parameters

	$name
	$config

Return

wild

public function willRender()
Inherited

AphrontView

Inconsistent, unreliable pre-rendering hook.

This hook may fire before views render. It is not fired reliably, and may fire multiple times.

If it does fire, views might use it to register data for later loads, but almost no datasources support this now; this is currently only useful for tokenizers. This mechanism might eventually see wider support or might be removed.

Return

wild

public function render()
Inherited

This method is not documented.

Return

wild

public function producePhutilSafeHTML()
Inherited

This method is not documented.

Return

wild

public function setTitle($title)
Inherited

This method is not documented.

Parameters

$title

Return

wild

public function getTitle()

This method is not documented.

Return

wild

protected function getHead()

This method is not documented.

Return

wild

protected function getBody()

This method is not documented.

Return

wild

protected function getTail()

This method is not documented.

Return

wild

protected function willRenderPage()

This method is not documented.

Return

wild

protected function willSendResponse($response)

This method is not documented.

Parameters

$response

Return

wild

protected function getBodyClasses()

This method is not documented.

Return

wild

public function setController($controller)
Inherited

This method is not documented.

Parameters

AphrontController

$controller

Return

wild

public function getController()
Inherited

This method is not documented.

Return

wild

public function setRequest($request)
Inherited

This method is not documented.

Parameters

AphrontRequest

$request

Return

wild

public function getRequest()
Inherited

This method is not documented.

Return

wild

public function setFrameable($frameable)
Inherited

This method is not documented.

Parameters

$frameable

Return

wild

public function getFrameable()
Inherited

This method is not documented.

Return

wild

public function setDeviceReady($device_ready)
Inherited

This method is not documented.

Parameters

$device_ready

Return

wild

public function getDeviceReady()
Inherited

This method is not documented.

Return

wild

private function newFavicons()
Inherited

This method is not documented.

Return

wild

public function setShowFooter($show_footer)

This method is not documented.

Parameters

$show_footer

Return

wild

public function getShowFooter()

This method is not documented.

Return

wild

public function setApplicationName($application_name)

This method is not documented.

Parameters

$application_name

Return

wild

public function setDisableConsole($disable)

This method is not documented.

Parameters

$disable

Return

wild

public function getApplicationName()

This method is not documented.

Return

wild

public function setBaseURI($base_uri)

This method is not documented.

Parameters

$base_uri

Return

wild

public function getBaseURI()

This method is not documented.

Return

wild

public function setShowChrome($show_chrome)

This method is not documented.

Parameters

$show_chrome

Return

wild

public function getShowChrome()

This method is not documented.

Return

wild

public function addClass($class)

This method is not documented.

Parameters

$class

Return

wild

public function setPageObjectPHIDs($phids)

This method is not documented.

Parameters

array

$phids

Return

wild

public function setShowDurableColumn($show)

This method is not documented.

Parameters

$show

Return

wild

public function getShowDurableColumn()

This method is not documented.

Return

wild

private function isQuicksandBlacklistURI()

This method is not documented.

Return

wild

public function getDurableColumnVisible()

This method is not documented.

Return

wild

public function getDurableColumnMinimize()

This method is not documented.

Return

wild

public function addQuicksandConfig($config)

This method is not documented.

Parameters

array

$config

Return

wild

public function getQuicksandConfig()

This method is not documented.

Return

wild

public function setCrumbs($crumbs)

This method is not documented.

Parameters

PHUICrumbsView

$crumbs

Return

wild

public function getCrumbs()

This method is not documented.

Return

wild

public function setTabs($tabs)

This method is not documented.

Parameters

PHUIListView

$tabs

Return

wild

public function getTabs()

This method is not documented.

Return

wild

public function setNavigation($navigation)

This method is not documented.

Parameters

AphrontSideNavFilterView

$navigation

Return

wild

public function getNavigation()

This method is not documented.

Return

wild

public function setGlyph($glyph)

This method is not documented.

Parameters

$glyph

Return

wild

public function getGlyph()

This method is not documented.

Return

wild

private function renderPageBodyContent()

This method is not documented.

Return

wild

private function getConsole()

This method is not documented.

Return

wild

private function getConsoleConfig()

This method is not documented.

Return

wild

private function getHighSecurityWarningConfig()

This method is not documented.

Return

wild

private function renderFooter()

This method is not documented.

Return

wild

public function renderForQuicksand()

This method is not documented.

Return

wild

private function buildQuicksandConfig()

This method is not documented.

Return

wild

private function buildAphlictListenConfigData()

This method is not documented.

Return

wild

private function getQuicksandURIPatternBlacklist()

This method is not documented.

Return

wild

private function getUserPreference($key, $default)

This method is not documented.

Parameters

	$key
	$default

Return

wild

public function produceAphrontResponse()

This method is not documented.

Return

wild

Defined: src/view/page/PhabricatorStandardPageView.php:7
Extends: AphrontViewAphrontPageViewPhabricatorBarePageView
Implements: AphrontResponseProducerInterface
PhutilSafeHTMLProducerInterface ◀ AphrontView

final class PhabricatorStandardPageViewPhorge Technical Documentation ()

Tasks

Managing Children

Other Methods

config

1

Methods

public function setViewer($viewer)Inherited

public function getViewer()Inherited

public function hasViewer()Inherited

public function setUser($user)Inherited

protected function getUser()Inherited

protected function canAppendChild()Inherited

final public function appendChild($child)Inherited

final protected function renderChildren()Inherited

final public function hasChildren()Inherited

private function reduceChildren($children)Inherited

public function getDefaultResourceSource()Inherited

public function requireResource($symbol)Inherited

public function initBehavior($name, $config)Inherited

public function willRender()Inherited

public function render()Inherited

public function producePhutilSafeHTML()Inherited

public function setTitle($title)Inherited

public function getTitle()

protected function getHead()

protected function getBody()

protected function getTail()

protected function willRenderPage()

protected function willSendResponse($response)

protected function getBodyClasses()

public function setController($controller)Inherited

public function getController()Inherited

public function setRequest($request)Inherited

public function getRequest()Inherited

public function setFrameable($frameable)Inherited

public function getFrameable()Inherited

public function setDeviceReady($device_ready)Inherited

public function getDeviceReady()Inherited

private function newFavicons()Inherited

public function setShowFooter($show_footer)

public function getShowFooter()

public function setApplicationName($application_name)

public function setDisableConsole($disable)

public function getApplicationName()

public function setBaseURI($base_uri)

public function getBaseURI()

public function setShowChrome($show_chrome)

public function getShowChrome()

public function addClass($class)

public function setPageObjectPHIDs($phids)

public function setShowDurableColumn($show)

public function getShowDurableColumn()

private function isQuicksandBlacklistURI()

public function getDurableColumnVisible()

public function getDurableColumnMinimize()

public function addQuicksandConfig($config)

public function getQuicksandConfig()

public function setCrumbs($crumbs)

public function getCrumbs()

public function setTabs($tabs)

public function getTabs()

public function setNavigation($navigation)

public function getNavigation()

public function setGlyph($glyph)

public function getGlyph()

private function renderPageBodyContent()

private function getConsole()

private function getConsoleConfig()

private function getHighSecurityWarningConfig()

private function renderFooter()

public function renderForQuicksand()

private function buildQuicksandConfig()

private function buildAphlictListenConfigData()

private function getQuicksandURIPatternBlacklist()

private function getUserPreference($key, $default)

public function produceAphrontResponse()

final class PhabricatorStandardPageView
Phorge Technical Documentation ()

public function setViewer($viewer)
Inherited

public function getViewer()
Inherited

public function hasViewer()
Inherited

public function setUser($user)
Inherited

protected function getUser()
Inherited

protected function canAppendChild()
Inherited

final public function appendChild($child)
Inherited

final protected function renderChildren()
Inherited

final public function hasChildren()
Inherited

private function reduceChildren($children)
Inherited

public function getDefaultResourceSource()
Inherited

public function requireResource($symbol)
Inherited

public function initBehavior($name, $config)
Inherited

public function willRender()
Inherited

public function render()
Inherited

public function producePhutilSafeHTML()
Inherited

public function setTitle($title)
Inherited

public function setController($controller)
Inherited

public function getController()
Inherited

public function setRequest($request)
Inherited

public function getRequest()
Inherited

public function setFrameable($frameable)
Inherited

public function getFrameable()
Inherited

public function setDeviceReady($device_ready)
Inherited

public function getDeviceReady()
Inherited

private function newFavicons()
Inherited