public function __get($name)Inherited
public function __get($name)
Inherited
Parameters
$name |
Return
wild |
public function __set($name, $value)Inherited
public function __set($name, $value)
Inherited
Parameters
$name | ||
$value |
Return
wild |
public function current()Inherited
public function current()
Inherited
Return
wild |
public function key()Inherited
public function key()
Inherited
Return
wild |
public function next()Inherited
public function next()
Inherited
Return
wild |
public function rewind()Inherited
public function rewind()
Inherited
Return
wild |
public function valid()Inherited
public function valid()
Inherited
Return
wild |
private function throwOnAttemptedIteration()Inherited
private function throwOnAttemptedIteration()
Inherited
Return
wild |
public function getPhobjectClassConstant($key, $byte_limit)Inherited
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 | $key | Name of the constant. |
int|null | $byte_limit | Maximum number of bytes permitted in the value. |
Return
string | Value of the constant. |
abstract public function getPanelTypeKey()
abstract public function getPanelTypeKey()
Return
wild |
abstract public function getPanelTypeName()
abstract public function getPanelTypeName()
Return
wild |
abstract public function getPanelTypeDescription()
abstract public function getPanelTypeDescription()
Return
wild |
abstract public function getIcon()
abstract public function getIcon()
Return
wild |
abstract public function renderPanelContent($viewer, $panel, $engine)
abstract public function renderPanelContent($viewer, $panel, $engine)
Parameters
PhabricatorUser | $viewer | |
PhabricatorDashboardPanel | $panel | |
PhabricatorDashboardPanelRenderingEngine | $engine |
Return
wild |
public function shouldRenderAsync()
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
bool | True to enable asynchronous rendering when appropriate. |
public function adjustPanelHeader($viewer, $panel, $engine, $header)
public function adjustPanelHeader($viewer, $panel, $engine, $header)
Parameters
PhabricatorUser | $viewer | |
PhabricatorDashboardPanel | $panel | |
PhabricatorDashboardPanelRenderingEngine | $engine | |
PHUIHeaderView | $header |
Return
wild |
public static function getAllPanelTypes()
public static function getAllPanelTypes()
Return
wild |
final public function getEditEngineFields($panel)
final public function getEditEngineFields($panel)
Parameters
PhabricatorDashboardPanel | $panel |
Return
wild |
abstract protected function newEditEngineFields($panel)
abstract protected function newEditEngineFields($panel)
Parameters
PhabricatorDashboardPanel | $panel |
Return
wild |
public function getSubpanelPHIDs($panel)
public function getSubpanelPHIDs($panel)
Parameters
PhabricatorDashboardPanel | $panel |
Return
wild |
public function newHeaderEditActions($panel, $viewer, $context_phid)
public function newHeaderEditActions($panel, $viewer, $context_phid)
Parameters
PhabricatorDashboardPanel | $panel | |
PhabricatorUser | $viewer | |
$context_phid |
Return
wild |