HeraldRuleSearchEngine.php
51cb7a3db9e8master

HeraldRuleSearchEngine.php
View Options

			<?php

			final class HeraldRuleSearchEngine extends PhabricatorApplicationSearchEngine {

			public function getResultTypeDescription() {
			return pht('Herald Rules');
			}

			public function getApplicationClassName() {
			return 'PhabricatorHeraldApplication';
			}

			public function newQuery() {
			return id(new HeraldRuleQuery())
			->needValidateAuthors(true);
			}

			protected function buildCustomSearchFields() {
			$viewer = $this->requireViewer();

			$rule_types = HeraldRuleTypeConfig::getRuleTypeMap();
			$content_types = HeraldAdapter::getEnabledAdapterMap($viewer);

			return array(
			id(new PhabricatorUsersSearchField())
			->setLabel(pht('Authors'))
			->setKey('authorPHIDs')
			->setAliases(array('author', 'authors', 'authorPHID'))
			->setDescription(
			pht('Search for rules with given authors.')),
			id(new PhabricatorSearchCheckboxesField())
			->setKey('ruleTypes')
			->setAliases(array('ruleType'))
			->setLabel(pht('Rule Type'))
			->setDescription(
			pht('Search for rules of given types.'))
			->setOptions($rule_types),
			id(new PhabricatorSearchCheckboxesField())
			->setKey('contentTypes')
			->setLabel(pht('Content Type'))
			->setDescription(
			pht('Search for rules affecting given types of content.'))
			->setOptions($content_types),
			id(new PhabricatorSearchThreeStateField())
			->setLabel(pht('Active Rules'))
			->setKey('active')
			->setOptions(
			pht('(Show All)'),
			pht('Show Only Active Rules'),
			pht('Show Only Inactive Rules')),
			id(new PhabricatorSearchThreeStateField())
			->setLabel(pht('Disabled Rules'))
			->setKey('disabled')
			->setOptions(
			pht('(Show All)'),
			pht('Show Only Disabled Rules'),
			pht('Show Only Enabled Rules')),
			id(new PhabricatorPHIDsSearchField())
			->setLabel(pht('Affected Objects'))
			->setKey('affectedPHIDs')
			->setAliases(array('affectedPHID')),
			);
			}

			protected function buildQueryFromParameters(array $map) {
			$query = $this->newQuery();

			if ($map['authorPHIDs']) {
			$query->withAuthorPHIDs($map['authorPHIDs']);
			}

			if ($map['contentTypes']) {
			$query->withContentTypes($map['contentTypes']);
			}

			if ($map['ruleTypes']) {
			$query->withRuleTypes($map['ruleTypes']);
			}

			if ($map['disabled'] !== null) {
			$query->withDisabled($map['disabled']);
			}

			if ($map['active'] !== null) {
			$query->withActive($map['active']);
			}

			if ($map['affectedPHIDs']) {
			$query->withAffectedObjectPHIDs($map['affectedPHIDs']);
			}

			return $query;
			}

			protected function getURI($path) {
			return '/herald/'.$path;
			}

			protected function getBuiltinQueryNames() {
			$names = array();

			if ($this->requireViewer()->isLoggedIn()) {
			$names['authored'] = pht('Authored');
			}

			$names['active'] = pht('Active');
			$names['all'] = pht('All');

			return $names;
			}

			public function buildSavedQueryFromBuiltin($query_key) {
			$query = $this->newSavedQuery();
			$query->setQueryKey($query_key);

			$viewer_phid = $this->requireViewer()->getPHID();

			switch ($query_key) {
			case 'all':
			return $query;
			case 'active':
			return $query
			->setParameter('active', true);
			case 'authored':
			return $query
			->setParameter('authorPHIDs', array($viewer_phid))
			->setParameter('disabled', false);
			}

			return parent::buildSavedQueryFromBuiltin($query_key);
			}

			protected function renderResultList(
			array $rules,
			PhabricatorSavedQuery $query,
			array $handles) {
			assert_instances_of($rules, 'HeraldRule');
			$viewer = $this->requireViewer();

			$list = id(new HeraldRuleListView())
			->setViewer($viewer)
			->setRules($rules)
			->newObjectList();

			$result = new PhabricatorApplicationSearchResultView();
			$result->setObjectList($list);
			$result->setNoDataString(pht('No rules found.'));

			return $result;
			}

			protected function getNewUserBody() {
			$create_button = id(new PHUIButtonView())
			->setTag('a')
			->setText(pht('Create Herald Rule'))
			->setHref('/herald/create/')
			->setColor(PHUIButtonView::GREEN);

			$icon = $this->getApplication()->getIcon();
			$app_name = $this->getApplication()->getName();
			$view = id(new PHUIBigInfoView())
			->setIcon($icon)
			->setTitle(pht('Welcome to %s', $app_name))
			->setDescription(
			pht('A flexible rules engine that can notify and act on '.
			'other actions such as tasks, diffs, and commits.'))
			->addAction($create_button);

			return $view;
			}

			}

Owner Packages

No Owners

phabricator/src/applications/herald/query/HeraldRuleSearchEngine.php51cb7a3db9e8master

HeraldRuleSearchEngine.phpView Options

Owner Packages

phabricator/src/applications/herald/query/HeraldRuleSearchEngine.php
51cb7a3db9e8master

HeraldRuleSearchEngine.php
View Options