Page MenuHomePhorge
Diviner Tech Docs PhabricatorDashboardPanelType

abstract class PhabricatorDashboardPanelType
Phorge Technical Documentation (Dashboard)

This class is not documented.

Methods

public function __get($name)
Inherited

This method is not documented.
Parameters
$name
Return
wild

public function __set($name, $value)
Inherited

This method is not documented.
Parameters
$name
$value
Return
wild

public function current()
Inherited

This method is not documented.
Return
wild

public function key()
Inherited

This method is not documented.
Return
wild

public function next()
Inherited

This method is not documented.
Return
wild

public function rewind()
Inherited

This method is not documented.
Return
wild

public function valid()
Inherited

This method is not documented.
Return
wild

private function throwOnAttemptedIteration()
Inherited

This method is not documented.
Return
wild

public function getPhobjectClassConstant($key, $byte_limit)
Inherited

Phobject

Read the value of a class constant.

This is the same as just typing self::CONSTANTNAME, but throws a more useful message if the constant is not defined and allows the constant to be limited to a maximum length.

Parameters
string$keyName of the constant.
int|null$byte_limitMaximum number of bytes permitted in the value.
Return
stringValue of the constant.

abstract public function getPanelTypeKey()

This method is not documented.
Return
wild

abstract public function getPanelTypeName()

This method is not documented.
Return
wild

abstract public function getPanelTypeDescription()

This method is not documented.
Return
wild

abstract public function getIcon()

This method is not documented.
Return
wild

abstract public function renderPanelContent($viewer, $panel, $engine)

This method is not documented.
Parameters
PhabricatorUser$viewer
PhabricatorDashboardPanel$panel
PhabricatorDashboardPanelRenderingEngine$engine
Return
wild

public function shouldRenderAsync()

Should this panel pull content in over AJAX?

Normally, panels use AJAX to render their content. This makes the page interactable sooner, allows panels to render in parallel, and prevents one slow panel from slowing everything down.

However, some panels are very cheap to build (i.e., no expensive service calls or complicated rendering). In these cases overall performance can be improved by disabling async rendering so the panel rendering happens in the same process.

Return
boolTrue to enable asynchronous rendering when appropriate.

public function adjustPanelHeader($viewer, $panel, $engine, $header)

This method is not documented.
Parameters
PhabricatorUser$viewer
PhabricatorDashboardPanel$panel
PhabricatorDashboardPanelRenderingEngine$engine
PHUIHeaderView$header
Return
wild

public static function getAllPanelTypes()

This method is not documented.
Return
wild

final public function getEditEngineFields($panel)

This method is not documented.
Parameters
PhabricatorDashboardPanel$panel
Return
wild

abstract protected function newEditEngineFields($panel)

This method is not documented.
Parameters
PhabricatorDashboardPanel$panel
Return
wild

public function getSubpanelPHIDs($panel)

This method is not documented.
Parameters
PhabricatorDashboardPanel$panel
Return
wild

public function newHeaderEditActions($panel, $viewer, $context_phid)

This method is not documented.
Parameters
PhabricatorDashboardPanel$panel
PhabricatorUser$viewer
$context_phid
Return
wild