mirror of
https://we.phorge.it/source/phorge.git
synced 2024-11-15 03:12:41 +01:00
29957d196b
Summary: Fixes T11569. This fixes a known bad `setIcon()`. I also looked for more calls to `setIcon()` without success, and stubbed `setIcon()` so we're in good shape even if more exist. Test Plan: - Grepped for `setIcon(` and manually inspect all 1,004 callsites to look for calls on `PHUIObjectItemView` objects. - Grepped for "high risk" callsites (`setIcon` in file after `PHUIObjectItemView`) and re-examined them. I identified these files with this command: ``` git ls-tree -r --name-only HEAD | xargs pcregrep -i -M -H -c --files-with-matches -o 'PHUIObjectItemView(.|\n)*setIcon' ``` There might be some more clever way to do that. - Since this only identified the callsites I already knew about and I don't have a ton of confidence that I didn't miss any, I put a stub in place that logs a deprecation warning. I'll file a followup to go clean these up in a month or so if the logs are clean. - Loaded Nuance, saw it work but warn. - Changed Nuance to use `setStatusIcon()`, loaded Nuance, no more fatal. Reviewers: chad Reviewed By: chad Maniphest Tasks: T11569 Differential Revision: https://secure.phabricator.com/D16477
740 lines
16 KiB
PHP
740 lines
16 KiB
PHP
<?php
|
|
|
|
final class PHUIObjectItemView extends AphrontTagView {
|
|
|
|
private $objectName;
|
|
private $header;
|
|
private $subhead;
|
|
private $href;
|
|
private $attributes = array();
|
|
private $icons = array();
|
|
private $barColor;
|
|
private $object;
|
|
private $effect;
|
|
private $statusIcon;
|
|
private $handleIcons = array();
|
|
private $bylines = array();
|
|
private $grippable;
|
|
private $actions = array();
|
|
private $headIcons = array();
|
|
private $disabled;
|
|
private $imageURI;
|
|
private $imageIcon;
|
|
private $titleText;
|
|
private $badge;
|
|
private $countdownNum;
|
|
private $countdownNoun;
|
|
private $launchButton;
|
|
private $coverImage;
|
|
|
|
public function setDisabled($disabled) {
|
|
$this->disabled = $disabled;
|
|
return $this;
|
|
}
|
|
|
|
public function getDisabled() {
|
|
return $this->disabled;
|
|
}
|
|
|
|
public function addHeadIcon($icon) {
|
|
$this->headIcons[] = $icon;
|
|
return $this;
|
|
}
|
|
|
|
public function setObjectName($name) {
|
|
$this->objectName = $name;
|
|
return $this;
|
|
}
|
|
|
|
public function setGrippable($grippable) {
|
|
$this->grippable = $grippable;
|
|
return $this;
|
|
}
|
|
|
|
public function getGrippable() {
|
|
return $this->grippable;
|
|
}
|
|
|
|
public function setEffect($effect) {
|
|
$this->effect = $effect;
|
|
return $this;
|
|
}
|
|
|
|
public function getEffect() {
|
|
return $this->effect;
|
|
}
|
|
|
|
public function setObject($object) {
|
|
$this->object = $object;
|
|
return $this;
|
|
}
|
|
|
|
public function getObject() {
|
|
return $this->object;
|
|
}
|
|
|
|
public function setHref($href) {
|
|
$this->href = $href;
|
|
return $this;
|
|
}
|
|
|
|
public function getHref() {
|
|
return $this->href;
|
|
}
|
|
|
|
public function setHeader($header) {
|
|
$this->header = $header;
|
|
return $this;
|
|
}
|
|
|
|
public function setSubHead($subhead) {
|
|
$this->subhead = $subhead;
|
|
return $this;
|
|
}
|
|
|
|
public function setBadge(PHUIBadgeMiniView $badge) {
|
|
$this->badge = $badge;
|
|
return $this;
|
|
}
|
|
|
|
public function setCountdown($num, $noun) {
|
|
$this->countdownNum = $num;
|
|
$this->countdownNoun = $noun;
|
|
return $this;
|
|
}
|
|
|
|
public function setTitleText($title_text) {
|
|
$this->titleText = $title_text;
|
|
return $this;
|
|
}
|
|
|
|
public function getTitleText() {
|
|
return $this->titleText;
|
|
}
|
|
|
|
public function getHeader() {
|
|
return $this->header;
|
|
}
|
|
|
|
public function addByline($byline) {
|
|
$this->bylines[] = $byline;
|
|
return $this;
|
|
}
|
|
|
|
public function setImageURI($image_uri) {
|
|
$this->imageURI = $image_uri;
|
|
return $this;
|
|
}
|
|
|
|
public function getImageURI() {
|
|
return $this->imageURI;
|
|
}
|
|
|
|
public function setImageIcon($image_icon) {
|
|
if (!$image_icon instanceof PHUIIconView) {
|
|
$image_icon = id(new PHUIIconView())
|
|
->setIcon($image_icon);
|
|
}
|
|
$this->imageIcon = $image_icon;
|
|
return $this;
|
|
}
|
|
|
|
public function getImageIcon() {
|
|
return $this->imageIcon;
|
|
}
|
|
|
|
public function setCoverImage($image) {
|
|
$this->coverImage = $image;
|
|
return $this;
|
|
}
|
|
|
|
public function setEpoch($epoch) {
|
|
$date = phabricator_datetime($epoch, $this->getUser());
|
|
$this->addIcon('none', $date);
|
|
return $this;
|
|
}
|
|
|
|
public function addAction(PHUIListItemView $action) {
|
|
if (count($this->actions) >= 3) {
|
|
throw new Exception(pht('Limit 3 actions per item.'));
|
|
}
|
|
$this->actions[] = $action;
|
|
return $this;
|
|
}
|
|
|
|
public function addIcon($icon, $label = null, $attributes = array()) {
|
|
$this->icons[] = array(
|
|
'icon' => $icon,
|
|
'label' => $label,
|
|
'attributes' => $attributes,
|
|
);
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* This method has been deprecated, use @{method:setImageIcon} instead.
|
|
*
|
|
* @deprecated
|
|
*/
|
|
public function setIcon($icon) {
|
|
phlog(
|
|
pht('Deprecated call to setIcon(), use setImageIcon() instead.'));
|
|
|
|
return $this->setImageIcon($icon);
|
|
}
|
|
|
|
public function setStatusIcon($icon, $label = null) {
|
|
$this->statusIcon = array(
|
|
'icon' => $icon,
|
|
'label' => $label,
|
|
);
|
|
return $this;
|
|
}
|
|
|
|
public function addHandleIcon(
|
|
PhabricatorObjectHandle $handle,
|
|
$label = null) {
|
|
$this->handleIcons[] = array(
|
|
'icon' => $handle,
|
|
'label' => $label,
|
|
);
|
|
return $this;
|
|
}
|
|
|
|
public function setBarColor($bar_color) {
|
|
$this->barColor = $bar_color;
|
|
return $this;
|
|
}
|
|
|
|
public function getBarColor() {
|
|
return $this->barColor;
|
|
}
|
|
|
|
public function addAttribute($attribute) {
|
|
if (!empty($attribute)) {
|
|
$this->attributes[] = $attribute;
|
|
}
|
|
return $this;
|
|
}
|
|
|
|
public function setLaunchButton(PHUIButtonView $button) {
|
|
$button->setSize(PHUIButtonView::SMALL);
|
|
$this->launchButton = $button;
|
|
return $this;
|
|
}
|
|
|
|
protected function getTagName() {
|
|
return 'li';
|
|
}
|
|
|
|
protected function getTagAttributes() {
|
|
$item_classes = array();
|
|
$item_classes[] = 'phui-object-item';
|
|
|
|
if ($this->icons) {
|
|
$item_classes[] = 'phui-object-item-with-icons';
|
|
}
|
|
|
|
if ($this->attributes) {
|
|
$item_classes[] = 'phui-object-item-with-attrs';
|
|
}
|
|
|
|
if ($this->handleIcons) {
|
|
$item_classes[] = 'phui-object-item-with-handle-icons';
|
|
}
|
|
|
|
if ($this->barColor) {
|
|
$item_classes[] = 'phui-object-item-bar-color-'.$this->barColor;
|
|
} else {
|
|
$item_classes[] = 'phui-object-item-no-bar';
|
|
}
|
|
|
|
if ($this->actions) {
|
|
$n = count($this->actions);
|
|
$item_classes[] = 'phui-object-item-with-actions';
|
|
$item_classes[] = 'phui-object-item-with-'.$n.'-actions';
|
|
}
|
|
|
|
if ($this->disabled) {
|
|
$item_classes[] = 'phui-object-item-disabled';
|
|
}
|
|
|
|
switch ($this->effect) {
|
|
case 'highlighted':
|
|
$item_classes[] = 'phui-object-item-highlighted';
|
|
break;
|
|
case 'selected':
|
|
$item_classes[] = 'phui-object-item-selected';
|
|
break;
|
|
case 'visited':
|
|
$item_classes[] = 'phui-object-item-visited';
|
|
break;
|
|
case null:
|
|
break;
|
|
default:
|
|
throw new Exception(pht('Invalid effect!'));
|
|
}
|
|
|
|
if ($this->getGrippable()) {
|
|
$item_classes[] = 'phui-object-item-grippable';
|
|
}
|
|
|
|
if ($this->getImageURI()) {
|
|
$item_classes[] = 'phui-object-item-with-image';
|
|
}
|
|
|
|
if ($this->getImageIcon()) {
|
|
$item_classes[] = 'phui-object-item-with-image-icon';
|
|
}
|
|
|
|
return array(
|
|
'class' => $item_classes,
|
|
);
|
|
}
|
|
|
|
protected function getTagContent() {
|
|
$viewer = $this->getUser();
|
|
|
|
$content_classes = array();
|
|
$content_classes[] = 'phui-object-item-content';
|
|
|
|
$header_name = array();
|
|
|
|
if ($viewer) {
|
|
$header_name[] = id(new PHUISpacesNamespaceContextView())
|
|
->setUser($viewer)
|
|
->setObject($this->object);
|
|
}
|
|
|
|
if ($this->objectName) {
|
|
$header_name[] = array(
|
|
phutil_tag(
|
|
'span',
|
|
array(
|
|
'class' => 'phui-object-item-objname',
|
|
),
|
|
$this->objectName),
|
|
' ',
|
|
);
|
|
}
|
|
|
|
$title_text = null;
|
|
if ($this->titleText) {
|
|
$title_text = $this->titleText;
|
|
} else if ($this->href) {
|
|
$title_text = $this->header;
|
|
}
|
|
|
|
$header_link = phutil_tag(
|
|
$this->href ? 'a' : 'div',
|
|
array(
|
|
'href' => $this->href,
|
|
'class' => 'phui-object-item-link',
|
|
'title' => $title_text,
|
|
),
|
|
$this->header);
|
|
|
|
// Wrap the header content in a <span> with the "slippery" sigil. This
|
|
// prevents us from beginning a drag if you click the text (like "T123"),
|
|
// but not if you click the white space after the header.
|
|
$header = phutil_tag(
|
|
'div',
|
|
array(
|
|
'class' => 'phui-object-item-name',
|
|
),
|
|
javelin_tag(
|
|
'span',
|
|
array(
|
|
'sigil' => 'slippery',
|
|
),
|
|
array(
|
|
$this->headIcons,
|
|
$header_name,
|
|
$header_link,
|
|
)));
|
|
|
|
$icons = array();
|
|
if ($this->icons) {
|
|
$icon_list = array();
|
|
foreach ($this->icons as $spec) {
|
|
$icon = $spec['icon'];
|
|
$icon = id(new PHUIIconView())
|
|
->setIcon($icon)
|
|
->addClass('phui-object-item-icon-image');
|
|
|
|
if (isset($spec['attributes']['tip'])) {
|
|
$sigil = 'has-tooltip';
|
|
$meta = array(
|
|
'tip' => $spec['attributes']['tip'],
|
|
'align' => 'W',
|
|
);
|
|
$icon->addSigil($sigil);
|
|
$icon->setMetadata($meta);
|
|
}
|
|
|
|
$label = phutil_tag(
|
|
'span',
|
|
array(
|
|
'class' => 'phui-object-item-icon-label',
|
|
),
|
|
$spec['label']);
|
|
|
|
if (isset($spec['attributes']['href'])) {
|
|
$icon_href = phutil_tag(
|
|
'a',
|
|
array('href' => $spec['attributes']['href']),
|
|
array($icon, $label));
|
|
} else {
|
|
$icon_href = array($icon, $label);
|
|
}
|
|
|
|
$classes = array();
|
|
$classes[] = 'phui-object-item-icon';
|
|
if (isset($spec['attributes']['class'])) {
|
|
$classes[] = $spec['attributes']['class'];
|
|
}
|
|
|
|
$icon_list[] = javelin_tag(
|
|
'li',
|
|
array(
|
|
'class' => implode(' ', $classes),
|
|
),
|
|
$icon_href);
|
|
}
|
|
|
|
$icons[] = phutil_tag(
|
|
'ul',
|
|
array(
|
|
'class' => 'phui-object-item-icons',
|
|
),
|
|
$icon_list);
|
|
}
|
|
|
|
$handle_bar = null;
|
|
if ($this->handleIcons) {
|
|
$handle_bar = array();
|
|
foreach ($this->handleIcons as $handleicon) {
|
|
$handle_bar[] =
|
|
$this->renderHandleIcon($handleicon['icon'], $handleicon['label']);
|
|
}
|
|
$handle_bar = phutil_tag(
|
|
'li',
|
|
array(
|
|
'class' => 'phui-object-item-handle-icons',
|
|
),
|
|
$handle_bar);
|
|
}
|
|
|
|
$bylines = array();
|
|
if ($this->bylines) {
|
|
foreach ($this->bylines as $byline) {
|
|
$bylines[] = phutil_tag(
|
|
'div',
|
|
array(
|
|
'class' => 'phui-object-item-byline',
|
|
),
|
|
$byline);
|
|
}
|
|
$bylines = phutil_tag(
|
|
'div',
|
|
array(
|
|
'class' => 'phui-object-item-bylines',
|
|
),
|
|
$bylines);
|
|
}
|
|
|
|
$subhead = null;
|
|
if ($this->subhead) {
|
|
$subhead = phutil_tag(
|
|
'div',
|
|
array(
|
|
'class' => 'phui-object-item-subhead',
|
|
),
|
|
$this->subhead);
|
|
}
|
|
|
|
if ($icons) {
|
|
$icons = phutil_tag(
|
|
'div',
|
|
array(
|
|
'class' => 'phui-object-icon-pane',
|
|
),
|
|
$icons);
|
|
}
|
|
|
|
$attrs = null;
|
|
if ($this->attributes || $handle_bar) {
|
|
$attrs = array();
|
|
$spacer = phutil_tag(
|
|
'span',
|
|
array(
|
|
'class' => 'phui-object-item-attribute-spacer',
|
|
),
|
|
"\xC2\xB7");
|
|
$first = true;
|
|
foreach ($this->attributes as $attribute) {
|
|
$attrs[] = phutil_tag(
|
|
'li',
|
|
array(
|
|
'class' => 'phui-object-item-attribute',
|
|
),
|
|
array(
|
|
($first ? null : $spacer),
|
|
$attribute,
|
|
));
|
|
$first = false;
|
|
}
|
|
|
|
$attrs = phutil_tag(
|
|
'ul',
|
|
array(
|
|
'class' => 'phui-object-item-attributes',
|
|
),
|
|
array(
|
|
$handle_bar,
|
|
$attrs,
|
|
));
|
|
}
|
|
|
|
$status = null;
|
|
if ($this->statusIcon) {
|
|
$icon = $this->statusIcon;
|
|
$status = $this->renderStatusIcon($icon['icon'], $icon['label']);
|
|
}
|
|
|
|
$grippable = null;
|
|
if ($this->getGrippable()) {
|
|
$grippable = phutil_tag(
|
|
'div',
|
|
array(
|
|
'class' => 'phui-object-item-grip',
|
|
),
|
|
'');
|
|
}
|
|
|
|
$content = phutil_tag(
|
|
'div',
|
|
array(
|
|
'class' => implode(' ', $content_classes),
|
|
),
|
|
array(
|
|
$subhead,
|
|
$attrs,
|
|
$this->renderChildren(),
|
|
));
|
|
|
|
$image = null;
|
|
if ($this->getImageURI()) {
|
|
$image = phutil_tag(
|
|
'div',
|
|
array(
|
|
'class' => 'phui-object-item-image',
|
|
'style' => 'background-image: url('.$this->getImageURI().')',
|
|
),
|
|
'');
|
|
} else if ($this->getImageIcon()) {
|
|
$image = phutil_tag(
|
|
'div',
|
|
array(
|
|
'class' => 'phui-object-item-image-icon',
|
|
),
|
|
$this->getImageIcon());
|
|
}
|
|
|
|
if ($image && $this->href) {
|
|
$image = phutil_tag(
|
|
'a',
|
|
array(
|
|
'href' => $this->href,
|
|
),
|
|
$image);
|
|
}
|
|
|
|
/* Build a fake table */
|
|
$column0 = null;
|
|
if ($status) {
|
|
$column0 = phutil_tag(
|
|
'div',
|
|
array(
|
|
'class' => 'phui-object-item-col0',
|
|
),
|
|
$status);
|
|
}
|
|
|
|
if ($this->badge) {
|
|
$column0 = phutil_tag(
|
|
'div',
|
|
array(
|
|
'class' => 'phui-object-item-col0 phui-object-item-badge',
|
|
),
|
|
$this->badge);
|
|
}
|
|
|
|
if ($this->countdownNum) {
|
|
$countdown = phutil_tag(
|
|
'div',
|
|
array(
|
|
'class' => 'phui-object-item-countdown-number',
|
|
),
|
|
array(
|
|
phutil_tag_div('', $this->countdownNum),
|
|
phutil_tag_div('', $this->countdownNoun),
|
|
));
|
|
$column0 = phutil_tag(
|
|
'div',
|
|
array(
|
|
'class' => 'phui-object-item-col0 phui-object-item-countdown',
|
|
),
|
|
$countdown);
|
|
}
|
|
|
|
$column1 = phutil_tag(
|
|
'div',
|
|
array(
|
|
'class' => 'phui-object-item-col1',
|
|
),
|
|
array(
|
|
$header,
|
|
$content,
|
|
));
|
|
|
|
$column2 = null;
|
|
if ($icons || $bylines) {
|
|
$column2 = phutil_tag(
|
|
'div',
|
|
array(
|
|
'class' => 'phui-object-item-col2',
|
|
),
|
|
array(
|
|
$icons,
|
|
$bylines,
|
|
));
|
|
}
|
|
|
|
if ($this->launchButton) {
|
|
$column2 = phutil_tag(
|
|
'div',
|
|
array(
|
|
'class' => 'phui-object-item-col2 phui-object-item-launch-button',
|
|
),
|
|
array(
|
|
$this->launchButton,
|
|
));
|
|
}
|
|
|
|
$table = phutil_tag(
|
|
'div',
|
|
array(
|
|
'class' => 'phui-object-item-table',
|
|
),
|
|
phutil_tag_div(
|
|
'phui-object-item-table-row',
|
|
array(
|
|
$column0,
|
|
$column1,
|
|
$column2,
|
|
)));
|
|
|
|
$box = phutil_tag(
|
|
'div',
|
|
array(
|
|
'class' => 'phui-object-item-content-box',
|
|
),
|
|
array(
|
|
$grippable,
|
|
$table,
|
|
));
|
|
|
|
$actions = array();
|
|
if ($this->actions) {
|
|
Javelin::initBehavior('phabricator-tooltips');
|
|
|
|
foreach (array_reverse($this->actions) as $action) {
|
|
$action->setRenderNameAsTooltip(true);
|
|
$actions[] = $action;
|
|
}
|
|
$actions = phutil_tag(
|
|
'ul',
|
|
array(
|
|
'class' => 'phui-object-item-actions',
|
|
),
|
|
$actions);
|
|
}
|
|
|
|
$frame_content = phutil_tag(
|
|
'div',
|
|
array(
|
|
'class' => 'phui-object-item-frame-content',
|
|
),
|
|
array(
|
|
$actions,
|
|
$image,
|
|
$box,
|
|
));
|
|
|
|
$frame_cover = null;
|
|
if ($this->coverImage) {
|
|
$cover_image = phutil_tag(
|
|
'img',
|
|
array(
|
|
'src' => $this->coverImage,
|
|
'class' => 'phui-object-item-cover-image',
|
|
));
|
|
|
|
$frame_cover = phutil_tag(
|
|
'div',
|
|
array(
|
|
'class' => 'phui-object-item-frame-cover',
|
|
),
|
|
$cover_image);
|
|
}
|
|
|
|
$frame = phutil_tag(
|
|
'div',
|
|
array(
|
|
'class' => 'phui-object-item-frame',
|
|
),
|
|
array(
|
|
$frame_cover,
|
|
$frame_content,
|
|
));
|
|
|
|
return $frame;
|
|
}
|
|
|
|
private function renderStatusIcon($icon, $label) {
|
|
Javelin::initBehavior('phabricator-tooltips');
|
|
|
|
$icon = id(new PHUIIconView())
|
|
->setIcon($icon);
|
|
|
|
$options = array(
|
|
'class' => 'phui-object-item-status-icon',
|
|
);
|
|
|
|
if (strlen($label)) {
|
|
$options['sigil'] = 'has-tooltip';
|
|
$options['meta'] = array('tip' => $label, 'size' => 300);
|
|
}
|
|
|
|
return javelin_tag('div', $options, $icon);
|
|
}
|
|
|
|
|
|
private function renderHandleIcon(PhabricatorObjectHandle $handle, $label) {
|
|
Javelin::initBehavior('phabricator-tooltips');
|
|
|
|
$options = array(
|
|
'class' => 'phui-object-item-handle-icon',
|
|
'style' => 'background-image: url('.$handle->getImageURI().')',
|
|
);
|
|
|
|
if (strlen($label)) {
|
|
$options['sigil'] = 'has-tooltip';
|
|
$options['meta'] = array('tip' => $label, 'align' => 'E');
|
|
}
|
|
|
|
return javelin_tag('span', $options, '');
|
|
}
|
|
|
|
}
|