mirror of
https://we.phorge.it/source/phorge.git
synced 2024-11-25 00:02:41 +01:00
97a8700e45
Summary: Ref T5655. Rename `PhabricatorPHIDType` subclasses for clarity (see discussion in D9839). I'm not too keen on some of the resulting class names, so feel free to suggest alternatives. Test Plan: Ran unit tests. Reviewers: epriestley, #blessed_reviewers Reviewed By: epriestley, #blessed_reviewers Subscribers: epriestley, Korvin, hach-que Maniphest Tasks: T5655 Differential Revision: https://secure.phabricator.com/D9986
337 lines
7.4 KiB
PHP
337 lines
7.4 KiB
PHP
<?php
|
|
|
|
final class PhabricatorObjectHandle
|
|
implements PhabricatorPolicyInterface {
|
|
|
|
private $uri;
|
|
private $phid;
|
|
private $type;
|
|
private $name;
|
|
private $fullName;
|
|
private $title;
|
|
private $imageURI;
|
|
private $icon;
|
|
private $tagColor;
|
|
private $timestamp;
|
|
private $status = PhabricatorObjectHandleStatus::STATUS_OPEN;
|
|
private $complete;
|
|
private $disabled;
|
|
private $objectName;
|
|
private $policyFiltered;
|
|
|
|
public function setIcon($icon) {
|
|
$this->icon = $icon;
|
|
return $this;
|
|
}
|
|
|
|
public function getIcon() {
|
|
if ($this->getPolicyFiltered()) {
|
|
return 'fa-lock';
|
|
}
|
|
|
|
if ($this->icon) {
|
|
return $this->icon;
|
|
}
|
|
return $this->getTypeIcon();
|
|
}
|
|
|
|
public function setTagColor($color) {
|
|
static $colors;
|
|
if (!$colors) {
|
|
$colors = array_fuse(array_keys(PHUITagView::getShadeMap()));
|
|
}
|
|
|
|
if (isset($colors[$color])) {
|
|
$this->tagColor = $color;
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function getTagColor() {
|
|
if ($this->getPolicyFiltered()) {
|
|
return 'disabled';
|
|
}
|
|
|
|
if ($this->tagColor) {
|
|
return $this->tagColor;
|
|
}
|
|
return 'blue';
|
|
}
|
|
|
|
public function getTypeIcon() {
|
|
if ($this->getPHIDType()) {
|
|
return $this->getPHIDType()->getTypeIcon();
|
|
}
|
|
return null;
|
|
}
|
|
|
|
public function setPolicyFiltered($policy_filered) {
|
|
$this->policyFiltered = $policy_filered;
|
|
return $this;
|
|
}
|
|
|
|
public function getPolicyFiltered() {
|
|
return $this->policyFiltered;
|
|
}
|
|
|
|
public function setObjectName($object_name) {
|
|
$this->objectName = $object_name;
|
|
return $this;
|
|
}
|
|
|
|
public function getObjectName() {
|
|
if (!$this->objectName) {
|
|
return $this->getName();
|
|
}
|
|
return $this->objectName;
|
|
}
|
|
|
|
public function setURI($uri) {
|
|
$this->uri = $uri;
|
|
return $this;
|
|
}
|
|
|
|
public function getURI() {
|
|
return $this->uri;
|
|
}
|
|
|
|
public function setPHID($phid) {
|
|
$this->phid = $phid;
|
|
return $this;
|
|
}
|
|
|
|
public function getPHID() {
|
|
return $this->phid;
|
|
}
|
|
|
|
public function setName($name) {
|
|
$this->name = $name;
|
|
return $this;
|
|
}
|
|
|
|
public function getName() {
|
|
if ($this->name === null) {
|
|
if ($this->getPolicyFiltered()) {
|
|
return pht('Restricted %s', $this->getTypeName());
|
|
} else {
|
|
return pht('Unknown Object (%s)', $this->getTypeName());
|
|
}
|
|
}
|
|
return $this->name;
|
|
}
|
|
|
|
public function setStatus($status) {
|
|
$this->status = $status;
|
|
return $this;
|
|
}
|
|
|
|
public function getStatus() {
|
|
return $this->status;
|
|
}
|
|
|
|
public function setFullName($full_name) {
|
|
$this->fullName = $full_name;
|
|
return $this;
|
|
}
|
|
|
|
public function getFullName() {
|
|
if ($this->fullName !== null) {
|
|
return $this->fullName;
|
|
}
|
|
return $this->getName();
|
|
}
|
|
|
|
public function setTitle($title) {
|
|
$this->title = $title;
|
|
return $this;
|
|
}
|
|
|
|
public function getTitle() {
|
|
return $this->title;
|
|
}
|
|
|
|
public function setType($type) {
|
|
$this->type = $type;
|
|
return $this;
|
|
}
|
|
|
|
public function getType() {
|
|
return $this->type;
|
|
}
|
|
|
|
public function setImageURI($uri) {
|
|
$this->imageURI = $uri;
|
|
return $this;
|
|
}
|
|
|
|
public function getImageURI() {
|
|
return $this->imageURI;
|
|
}
|
|
|
|
public function setTimestamp($timestamp) {
|
|
$this->timestamp = $timestamp;
|
|
return $this;
|
|
}
|
|
|
|
public function getTimestamp() {
|
|
return $this->timestamp;
|
|
}
|
|
|
|
public function getTypeName() {
|
|
if ($this->getPHIDType()) {
|
|
return $this->getPHIDType()->getTypeName();
|
|
}
|
|
|
|
return $this->getType();
|
|
}
|
|
|
|
|
|
/**
|
|
* Set whether or not the underlying object is complete. See
|
|
* @{method:isComplete} for an explanation of what it means to be complete.
|
|
*
|
|
* @param bool True if the handle represents a complete object.
|
|
* @return this
|
|
*/
|
|
public function setComplete($complete) {
|
|
$this->complete = $complete;
|
|
return $this;
|
|
}
|
|
|
|
|
|
/**
|
|
* 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, @{class: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 isComplete() {
|
|
return $this->complete;
|
|
}
|
|
|
|
|
|
/**
|
|
* Set whether or not the underlying object is disabled. See
|
|
* @{method:isDisabled} for an explanation of what it means to be disabled.
|
|
*
|
|
* @param bool True if the handle represents a disabled object.
|
|
* @return this
|
|
*/
|
|
public function setDisabled($disabled) {
|
|
$this->disabled = $disabled;
|
|
return $this;
|
|
}
|
|
|
|
|
|
/**
|
|
* Determine if the handle represents an object which has been disabled --
|
|
* for example, disabled users, archived projects, etc. These objects are
|
|
* complete and exist, but should be excluded from some system interactions
|
|
* (for instance, they usually should not appear in typeaheads, and should
|
|
* not have mail/notifications delivered to or about them).
|
|
*
|
|
* @return bool True if the handle represents a disabled object.
|
|
*/
|
|
public function isDisabled() {
|
|
return $this->disabled;
|
|
}
|
|
|
|
|
|
public function renderLink($name = null) {
|
|
if ($name === null) {
|
|
$name = $this->getLinkName();
|
|
}
|
|
$classes = array();
|
|
$classes[] = 'phui-handle';
|
|
$title = $this->title;
|
|
|
|
if ($this->status != PhabricatorObjectHandleStatus::STATUS_OPEN) {
|
|
$classes[] = 'handle-status-'.$this->status;
|
|
$title = $title ? $title : $this->status;
|
|
}
|
|
|
|
if ($this->disabled) {
|
|
$classes[] = 'handle-disabled';
|
|
$title = pht('Disabled'); // Overwrite status.
|
|
}
|
|
|
|
if ($this->getType() == PhabricatorPeopleUserPHIDType::TYPECONST) {
|
|
$classes[] = 'phui-link-person';
|
|
}
|
|
|
|
$uri = $this->getURI();
|
|
|
|
$icon = null;
|
|
if ($this->getPolicyFiltered()) {
|
|
$icon = id(new PHUIIconView())
|
|
->setIconFont('fa-lock lightgreytext');
|
|
}
|
|
|
|
return phutil_tag(
|
|
$uri ? 'a' : 'span',
|
|
array(
|
|
'href' => $uri,
|
|
'class' => implode(' ', $classes),
|
|
'title' => $title,
|
|
),
|
|
array($icon, $name));
|
|
}
|
|
|
|
public function renderTag() {
|
|
return id(new PHUITagView())
|
|
->setType(PHUITagView::TYPE_OBJECT)
|
|
->setShade($this->getTagColor())
|
|
->setIcon($this->getIcon())
|
|
->setHref($this->getURI())
|
|
->setName($this->getLinkName());
|
|
}
|
|
|
|
public function getLinkName() {
|
|
switch ($this->getType()) {
|
|
case PhabricatorPeopleUserPHIDType::TYPECONST:
|
|
$name = $this->getName();
|
|
break;
|
|
default:
|
|
$name = $this->getFullName();
|
|
break;
|
|
}
|
|
return $name;
|
|
}
|
|
|
|
protected function getPHIDType() {
|
|
$types = PhabricatorPHIDType::getAllTypes();
|
|
return idx($types, $this->getType());
|
|
}
|
|
|
|
|
|
/* -( PhabricatorPolicyInterface )----------------------------------------- */
|
|
|
|
|
|
public function getCapabilities() {
|
|
return array(
|
|
PhabricatorPolicyCapability::CAN_VIEW,
|
|
);
|
|
}
|
|
|
|
public function getPolicy($capability) {
|
|
return PhabricatorPolicies::POLICY_PUBLIC;
|
|
}
|
|
|
|
public function hasAutomaticCapability($capability, PhabricatorUser $viewer) {
|
|
// NOTE: Handles are always visible, they just don't get populated with
|
|
// data if the user can't see the underlying object.
|
|
return true;
|
|
}
|
|
|
|
public function describeAutomaticCapability($capability) {
|
|
return null;
|
|
}
|
|
|
|
}
|