Diviner Tech Docs PhabricatorObjectHandle

final class PhabricatorObjectHandle
Phorge Technical Documentation (PHIDs)

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	$key	Name of the constant.
int\|null	$byte_limit	Maximum number of bytes permitted in the value.

Return

string

Value of the constant.

public function setIcon($icon)

This method is not documented.

Parameters

$icon

Return

wild

public function getIcon()

This method is not documented.

Return

wild

public function setSubtitle($subtitle)

This method is not documented.

Parameters

$subtitle

Return

wild

public function getSubtitle()

This method is not documented.

Return

wild

public function setTagColor($color)

This method is not documented.

Parameters

$color

Return

wild

public function getTagColor()

This method is not documented.

Return

wild

public function getIconColor()

This method is not documented.

Return

wild

public function setTokenIcon($icon)

This method is not documented.

Parameters

$icon

Return

wild

public function getTokenIcon()

This method is not documented.

Return

wild

public function getTypeIcon()

This method is not documented.

Return

wild

public function setPolicyFiltered($policy_filered)

This method is not documented.

Parameters

$policy_filered

Return

wild

public function getPolicyFiltered()

This method is not documented.

Return

wild

public function setObjectName($object_name)

This method is not documented.

Parameters

$object_name

Return

wild

public function getObjectName()

This method is not documented.

Return

wild

public function setMailStampName($mail_stamp_name)

This method is not documented.

Parameters

$mail_stamp_name

Return

wild

public function getMailStampName()

This method is not documented.

Return

wild

public function setURI($uri)

This method is not documented.

Parameters

$uri

Return

wild

public function getURI()

This method is not documented.

Return

wild

public function setPHID($phid)

This method is not documented.

Parameters

$phid

Return

wild

public function getPHID()

This method is not documented.

Return

wild

public function setName($name)

This method is not documented.

Parameters

$name

Return

wild

public function getName()

This method is not documented.

Return

wild

public function setAvailability($availability)

This method is not documented.

Parameters

$availability

Return

wild

public function getAvailability()

This method is not documented.

Return

wild

public function isDisabled()

This method is not documented.

Return

wild

public function setStatus($status)

This method is not documented.

Parameters

$status

Return

wild

public function getStatus()

This method is not documented.

Return

wild

public function isClosed()

This method is not documented.

Return

wild

public function setFullName($full_name)

This method is not documented.

Parameters

$full_name

Return

wild

public function getFullName()

This method is not documented.

Return

wild

public function setCommandLineObjectName($command_line_object_name)

This method is not documented.

Parameters

$command_line_object_name

Return

wild

public function getCommandLineObjectName()

This method is not documented.

Return

wild

public function setTitle($title)

This method is not documented.

Parameters

$title

Return

wild

public function getTitle()

This method is not documented.

Return

wild

public function setType($type)

This method is not documented.

Parameters

$type

Return

wild

public function getType()

This method is not documented.

Return

wild

public function setImageURI($uri)

This method is not documented.

Parameters

$uri

Return

wild

public function getImageURI()

This method is not documented.

Return

wild

public function setTimestamp($timestamp)

This method is not documented.

Parameters

$timestamp

Return

wild

public function getTimestamp()

This method is not documented.

Return

wild

public function getTypeName()

This method is not documented.

Return

wild

public function setComplete($complete)

Set whether or not the underlying object is complete. See isComplete() for an explanation of what it means to be complete.

Parameters

bool

$complete

True if the handle represents a complete object.

Return

this

public function isComplete()

Determine if the handle represents an object which was completely loaded (i.e., the underlying object exists) vs an object which could not be completely loaded (e.g., the type or data for the PHID could not be identified or located).

Basically, PhabricatorHandleQuery gives you back a handle for any PHID you give it, but it gives you a complete handle only for valid PHIDs.

Return

bool	True if the handle represents a complete object.

public function renderLink($name)

This method is not documented.

Parameters

$name

Return

wild

public function renderHovercardLink($name, $context_phid)

This method is not documented.

Parameters

	$name
	$context_phid

Return

wild

private function renderLinkWithAttributes($name, $attributes)

This method is not documented.

Parameters

	$name
array	$attributes

Return

wild

public function renderTag()

This method is not documented.

Return

wild

public function getLinkName()

This method is not documented.

Return

wild

protected function getPHIDType()

This method is not documented.

Return

wild

public function hasCapabilities()

This method is not documented.

Return

wild

public function attachCapability($object, $capability, $has_capability)

This method is not documented.

Parameters

PhabricatorPolicyInterface	$object
	$capability
	$has_capability

Return

wild

public function hasViewCapability($object)

This method is not documented.

Parameters

PhabricatorPolicyInterface

$object

Return

wild

private function hasCapability($object, $capability)

This method is not documented.

Parameters

PhabricatorPolicyInterface	$object
	$capability

Return

wild

private function getObjectCapabilityKey($object)

This method is not documented.

Parameters

PhabricatorPolicyInterface

$object

Return

wild

public function getCapabilities()

This method is not documented.

Return

wild

public function getPolicy($capability)

This method is not documented.

Parameters

$capability

Return

wild

public function hasAutomaticCapability($capability, $viewer)

This method is not documented.

Parameters

	$capability
PhabricatorUser	$viewer

Return

wild

public function describeAutomaticCapability($capability)

This method is not documented.

Parameters

$capability

Return

wild

Defined: src/applications/phid/PhabricatorObjectHandle.php:3
Extends: Phobject
Implements: PhabricatorPolicyInterface

final class PhabricatorObjectHandlePhorge Technical Documentation (PHIDs)

Methods

public function __get($name)Inherited

public function __set($name, $value)Inherited

public function current()Inherited

public function key()Inherited

public function next()Inherited

public function rewind()Inherited

public function valid()Inherited

private function throwOnAttemptedIteration()Inherited

public function getPhobjectClassConstant($key, $byte_limit)Inherited

public function setIcon($icon)

public function getIcon()

public function setSubtitle($subtitle)

public function getSubtitle()

public function setTagColor($color)

public function getTagColor()

public function getIconColor()

public function setTokenIcon($icon)

public function getTokenIcon()

public function getTypeIcon()

public function setPolicyFiltered($policy_filered)

public function getPolicyFiltered()

public function setObjectName($object_name)

public function getObjectName()

public function setMailStampName($mail_stamp_name)

public function getMailStampName()

public function setURI($uri)

public function getURI()

public function setPHID($phid)

public function getPHID()

public function setName($name)

public function getName()

public function setAvailability($availability)

public function getAvailability()

public function isDisabled()

public function setStatus($status)

public function getStatus()

public function isClosed()

public function setFullName($full_name)

public function getFullName()

public function setCommandLineObjectName($command_line_object_name)

public function getCommandLineObjectName()

public function setTitle($title)

public function getTitle()

public function setType($type)

public function getType()

public function setImageURI($uri)

public function getImageURI()

public function setTimestamp($timestamp)

public function getTimestamp()

public function getTypeName()

public function setComplete($complete)

public function isComplete()

public function renderLink($name)

public function renderHovercardLink($name, $context_phid)

private function renderLinkWithAttributes($name, $attributes)

public function renderTag()

public function getLinkName()

protected function getPHIDType()

public function hasCapabilities()

public function attachCapability($object, $capability, $has_capability)

public function hasViewCapability($object)

private function hasCapability($object, $capability)

private function getObjectCapabilityKey($object)

public function getCapabilities()

public function getPolicy($capability)

public function hasAutomaticCapability($capability, $viewer)

public function describeAutomaticCapability($capability)

final class PhabricatorObjectHandle
Phorge Technical Documentation (PHIDs)

public function __get($name)
Inherited

public function __set($name, $value)
Inherited

public function current()
Inherited

public function key()
Inherited

public function next()
Inherited

public function rewind()
Inherited

public function valid()
Inherited

private function throwOnAttemptedIteration()
Inherited

public function getPhobjectClassConstant($key, $byte_limit)
Inherited