Page MenuHomePhabricator

final class PHUITimelineEventView
Phabricator Technical Documentation (PHUI)

This class is not documented.

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()

This method is not documented.
Return
wild

public function producePhutilSafeHTML()
Inherited

This method is not documented.
Return
wild

public function setAuthorPHID($author_phid)

This method is not documented.
Parameters
$author_phid
Return
wild

public function getAuthorPHID()

This method is not documented.
Return
wild

public function setQuoteRef($quote_ref)

This method is not documented.
Parameters
$quote_ref
Return
wild

public function getQuoteRef()

This method is not documented.
Return
wild

public function setQuoteTargetID($quote_target_id)

This method is not documented.
Parameters
$quote_target_id
Return
wild

public function getQuoteTargetID()

This method is not documented.
Return
wild

public function setIsNormalComment($is_normal_comment)

This method is not documented.
Parameters
$is_normal_comment
Return
wild

public function getIsNormalComment()

This method is not documented.
Return
wild

public function setHideByDefault($hide_by_default)

This method is not documented.
Parameters
$hide_by_default
Return
wild

public function getHideByDefault()

This method is not documented.
Return
wild

public function setTransactionPHID($transaction_phid)

This method is not documented.
Parameters
$transaction_phid
Return
wild

public function getTransactionPHID()

This method is not documented.
Return
wild

public function setIsEdited($is_edited)

This method is not documented.
Parameters
$is_edited
Return
wild

public function getIsEdited()

This method is not documented.
Return
wild

public function setIsPreview($is_preview)

This method is not documented.
Parameters
$is_preview
Return
wild

public function getIsPreview()

This method is not documented.
Return
wild

public function setIsEditable($is_editable)

This method is not documented.
Parameters
$is_editable
Return
wild

public function getIsEditable()

This method is not documented.
Return
wild

public function setCanInteract($can_interact)

This method is not documented.
Parameters
$can_interact
Return
wild

public function getCanInteract()

This method is not documented.
Return
wild

public function setIsRemovable($is_removable)

This method is not documented.
Parameters
$is_removable
Return
wild

public function getIsRemovable()

This method is not documented.
Return
wild

public function setDateCreated($date_created)

This method is not documented.
Parameters
$date_created
Return
wild

public function getDateCreated()

This method is not documented.
Return
wild

public function setContentSource($content_source)

This method is not documented.
Parameters
PhabricatorContentSource$content_source
Return
wild

public function getContentSource()

This method is not documented.
Return
wild

public function setUserHandle($handle)

This method is not documented.
Parameters
PhabricatorObjectHandle$handle
Return
wild

public function setAnchor($anchor)

This method is not documented.
Parameters
$anchor
Return
wild

public function getAnchor()

This method is not documented.
Return
wild

public function setTitle($title)

This method is not documented.
Parameters
$title
Return
wild

public function addClass($class)

This method is not documented.
Parameters
$class
Return
wild

public function addBadge($badge)

This method is not documented.
Parameters
PHUIBadgeMiniView$badge
Return
wild

public function setIcon($icon)

This method is not documented.
Parameters
$icon
Return
wild

public function setColor($color)

This method is not documented.
Parameters
$color
Return
wild

public function setIsSilent($is_silent)

This method is not documented.
Parameters
$is_silent
Return
wild

public function getIsSilent()

This method is not documented.
Return
wild

public function setIsMFA($is_mfa)

This method is not documented.
Parameters
$is_mfa
Return
wild

public function getIsMFA()

This method is not documented.
Return
wild

public function setIsLockOverride($is_override)

This method is not documented.
Parameters
$is_override
Return
wild

public function getIsLockOverride()

This method is not documented.
Return
wild

public function setReallyMajorEvent($me)

This method is not documented.
Parameters
$me
Return
wild

public function setHideCommentOptions($hide_comment_options)

This method is not documented.
Parameters
$hide_comment_options
Return
wild

public function getHideCommentOptions()

This method is not documented.
Return
wild

public function addPinboardItem($item)

This method is not documented.
Parameters
PHUIPinboardItemView$item
Return
wild

public function setToken($token, $removed)

This method is not documented.
Parameters
$token
$removed
Return
wild

public function getEventGroup()

This method is not documented.
Return
wild

public function addEventToGroup($event)

This method is not documented.
Parameters
PHUITimelineEventView$event
Return
wild

protected function shouldRenderEventTitle()

This method is not documented.
Return
wild

protected function renderEventTitle($force_icon, $has_menu, $extra)

This method is not documented.
Parameters
$force_icon
$has_menu
$extra
Return
wild

private function renderExtra($events)

This method is not documented.
Parameters
array$events
Return
wild

private function getMenuItems($anchor)

This method is not documented.
Parameters
$anchor
Return
wild