Differential D14405 Diff 34806 src/applications/transactions/storage/PhabricatorApplicationEditConfiguration.php

Changeset View

Standalone View

src/applications/transactions/storage/PhabricatorApplicationEditConfiguration.php

This file was added.

				<?php

				final class PhabricatorApplicationEditConfiguration
				extends PhabricatorSearchDAO
				implements
				PhabricatorPolicyInterface {

				protected $engineKey;
				protected $builtinKey;
				protected $viewPolicy;
				protected $editPolicy;
				protected $properties = array();
				protected $isDisabled = 0;

				public function generatePHID() {
				// TODO: Proper type.
				Lint: TODO Comment Inline Actions This comment has a TODO. Lint: TODO Comment: This comment has a TODO.
				return PhabricatorPHID::generateNewPHID('EDIT');
				}

				protected function getConfiguration() {
				return array(
				self::CONFIG_AUX_PHID => true,
				self::CONFIG_SERIALIZATION => array(
				'properties' => self::SERIALIZATION_JSON,
				),
				self::CONFIG_COLUMN_SCHEMA => array(
				'engineKey' => 'text64',
				'builtinKey' => 'text64?',
				'isDisabled' => 'bool',
				),
				self::CONFIG_KEY_SCHEMA => array(
				'key_engine' => array(
				'columns' => array('engineKey', 'builtinKey'),
				'unique' => true,
				),
				),
				) + parent::getConfiguration();
				}

				public function getProperty($key, $default = null) {
				return idx($this->properties, $key, $default);
				}

				public function setProperty($key, $value) {
				$this->properties[$key] = $value;
				return $this;
				}

				public function applyConfigurationToFields(
				PhabricatorApplicationEditEngine $engine,
				array $fields) {
				$fields = mpull($fields, null, 'getKey');

				$values = $this->getProperty('defaults', array());
				$locked = $this->getProperty('locked', array());
				foreach ($fields as $key => $field) {
				if ($engine->getIsCreate()) {
				if (array_key_exists($key, $values)) {
				$field->readDefaultValueFromConfiguration($values[$key]);
				}
				}

				// Randomly lock half the fields.
				if (isset($locked[$key]) \|\| mt_rand(0, 1)) {
				$field->setIsLocked(true);
				}
				}

				$fields = $this->reorderFields($fields);

				$head_instructions = $this->getProperty('instructions.head');
				if (strlen($head_instructions)) {
				$fields = array(
				'config.instructions.head' => id(new PhabricatorInstructionsEditField())
				->setKey('config.instructions.head')
				->setValue($head_instructions),
				) + $fields;
				}

				return $fields;
				}

				private function reorderFields(array $fields) {
				// Shuffle fields randomly.
				$keys = array_keys($fields);
				shuffle($keys);
				$fields = array_select_keys($fields, $keys);

				// Now, move locked fields to the bottom.
				$head = array();
				$tail = array();
				foreach ($fields as $key => $field) {
				if (!$field->getIsLocked()) {
				$head[$key] = $field;
				} else {
				$tail[$key] = $field;
				}
				}

				return $head + $tail;
				}

				/* -( PhabricatorPolicyInterface Implementation )-------------------------- */


				public function getCapabilities() {
				return array(
				PhabricatorPolicyCapability::CAN_VIEW,
				PhabricatorPolicyCapability::CAN_EDIT,
				);
				}

				public function getPolicy($capability) {
				switch ($capability) {
				case PhabricatorPolicyCapability::CAN_VIEW:
				return $this->getViewPolicy();
				case PhabricatorPolicyCapability::CAN_EDIT:
				return $this->getEditPolicy();
				}
				}

				public function hasAutomaticCapability($capability, PhabricatorUser $viewer) {
				return false;
				}

				public function describeAutomaticCapability($capability) {
				return null;
				}


				}