Page MenuHomeClusterLabs Projects
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

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$viewerViewing user.
Return
this

public function getViewer()
Inherited

AphrontView

Get the user viewing this element.

Throws an exception if no viewer has been set.

Return
PhabricatorUserViewing user.

public function hasViewer()
Inherited

AphrontView

Test if a viewer has been set on this element.

Return
boolTrue 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
boolTrue 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$childSomething 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
wildRenderable children.

final public function hasChildren()
Inherited

AphrontView

Test if an element has no children.

Return
boolTrue 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>$childrenRenderable 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
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