Differential D25080 Diff 1838 src/applications/project/trigger/PhabricatorProjectTriggerAddSubscriberRule.php

Changeset View

Standalone View

src/applications/project/trigger/PhabricatorProjectTriggerAddSubscriberRule.php

This file was added.

				<?php

				/**
				* Trigger Rule that Adds Subscribers
				*
				* This may be useful to automatically engage some
				* Users or Project Tags on certain Workboard areas.
				*
				* This class was adapted from these classes:
				* - PhabricatorProjectTriggerAddProjectsRule
				* - PhabricatorProjectTriggerManiphestOwnerRule
				*
				* https://we.phorge.it/T15162
				*/
				final class PhabricatorProjectTriggerAddSubscriberRule
				extends PhabricatorProjectTriggerRule {

				const TRIGGERTYPE = 'task.subscriber.add';

				public function getSelectControlName() {
				return pht('Add subscriber');
				}

				protected function getValueForEditorField() {
				return $this->getDatasource()->getWireTokens($this->getValue());
				}

				protected function assertValidRuleRecordFormat($value) {
				if (!is_array($value)) {
				throw new Exception(
				pht(
				'Subscriber rule value should be a list, but is not (value is "%s").',
				phutil_describe_type($value)));
				}
				}

				protected function assertValidRuleRecordValue($value) {
				if (!$value) {
				throw new Exception(
				pht(
				'You must select at least one user or project Tag to add.'));
				}
				}

				protected function newDropTransactions($object, $value) {
				$project_edge_type = PhabricatorObjectHasSubscriberEdgeType::EDGECONST;

				$xaction = $object->getApplicationTransactionTemplate()
				->setTransactionType(PhabricatorTransactions::TYPE_EDGE)
				->setMetadataValue('edge:type', $project_edge_type)
				->setNewValue(
				array(
				'+' => array_fuse($value),
				));

				return array($xaction);
				}

				protected function newDropEffects($value) {
				return array(
				$this->newEffect()
				->setIcon('fa-briefcase')
				->setContent($this->getRuleViewDescription($value)),
				);
				}

				protected function getDefaultValue() {
				return null;
				}

				protected function getPHUIXControlType() {
				return 'tokenizer';
				}

				private function getDatasource() {
				$datasource = new PhabricatorProjectOrUserDatasource();

				if ($this->getViewer()) {
				$datasource->setViewer($this->getViewer());
				}

				return $datasource;
				}

				protected function getPHUIXControlSpecification() {
				$template = id(new AphrontTokenizerTemplateView())
				->setViewer($this->getViewer());

				$template_markup = $template->render();
				$datasource = $this->getDatasource();

				return array(
				'markup' => (string)hsprintf('%s', $template_markup),
				'config' => array(
				'src' => $datasource->getDatasourceURI(),
				'browseURI' => $datasource->getBrowseURI(),
				'placeholder' => $datasource->getPlaceholderText(),
				'limit' => $datasource->getLimit(),
				),
				'value' => null,
				);
				}

				public function getRuleViewLabel() {
				return pht('Add subscriber');
				}

				public function getRuleViewDescription($value) {
				return pht(
				'Add subscribers: %s.',
				phutil_tag(
				'strong',
				array(),
				$this->getViewer()
				->renderHandleList($value)
				->setAsInline(true)
				->render()));
				}

				public function getRuleViewIcon($value) {
				return id(new PHUIIconView())
				->setIcon('fa-users', 'green');
				}


				}