NuanceSourceDefinition.php
f50693de61d9stable

NuanceSourceDefinition.php
View Options

			<?php

			/**
			* @task action Handling Action Requests
			*/
			abstract class NuanceSourceDefinition extends Phobject {

			private $viewer;
			private $source;

			public function setViewer(PhabricatorUser $viewer) {
			$this->viewer = $viewer;
			return $this;
			}

			public function getViewer() {
			if (!$this->viewer) {
			throw new PhutilInvalidStateException('setViewer');
			}
			return $this->viewer;
			}

			public function setSource(NuanceSource $source) {
			$this->source = $source;
			return $this;
			}

			public function getSource() {
			if (!$this->source) {
			throw new PhutilInvalidStateException('setSource');
			}
			return $this->source;
			}

			public function getSourceViewActions(AphrontRequest $request) {
			return array();
			}

			public static function getAllDefinitions() {
			return id(new PhutilClassMapQuery())
			->setAncestorClass(__CLASS__)
			->setUniqueMethod('getSourceTypeConstant')
			->execute();
			}

			public function hasImportCursors() {
			return false;
			}

			final public function getImportCursors() {
			if (!$this->hasImportCursors()) {
			throw new Exception(
			pht('This source has no input cursors.'));
			}

			$viewer = PhabricatorUser::getOmnipotentUser();
			$source = $this->getSource();
			$cursors = $this->newImportCursors();

			$data = id(new NuanceImportCursorDataQuery())
			->setViewer($viewer)
			->withSourcePHIDs(array($source->getPHID()))
			->execute();
			$data = mpull($data, null, 'getCursorKey');

			$map = array();
			foreach ($cursors as $cursor) {
			if (!($cursor instanceof NuanceImportCursor)) {
			throw new Exception(
			pht(
			'Source "%s" (of class "%s") returned an invalid value from '.
			'method "%s": all values must be objects of class "%s".',
			$this->getName(),
			get_class($this),
			'newImportCursors()',
			'NuanceImportCursor'));
			}

			$key = $cursor->getCursorKey();
			if (!strlen($key)) {
			throw new Exception(
			pht(
			'Source "%s" (of class "%s") returned an import cursor with '.
			'a missing key from "%s". Each cursor must have a unique, '.
			'nonempty key.',
			$this->getName(),
			get_class($this),
			'newImportCursors()'));
			}

			$other = idx($map, $key);
			if ($other) {
			throw new Exception(
			pht(
			'Source "%s" (of class "%s") returned two cursors from method '.
			'"%s" with the same key ("%s"). Each cursor must have a unique '.
			'key.',
			$this->getName(),
			get_class($this),
			'newImportCursors()',
			$key));
			}

			$map[$key] = $cursor;

			$cursor_data = idx($data, $key);
			if (!$cursor_data) {
			$cursor_data = $cursor->newEmptyCursorData($source);
			}

			$cursor
			->setViewer($viewer)
			->setSource($source)
			->setCursorData($cursor_data);
			}

			return $map;
			}

			protected function newImportCursors() {
			throw new PhutilMethodNotImplementedException();
			}

			/**
			* A human readable string like "Twitter" or "Phabricator Form".
			*/
			abstract public function getName();


			/**
			* Human readable description of this source, a sentence or two long.
			*/
			abstract public function getSourceDescription();

			/**
			* This should be a any VARCHAR(32).
			*
			* @{method:getAllDefinitions} will throw if you choose a string that
			* collides with another @{class:NuanceSourceDefinition} class.
			*/
			abstract public function getSourceTypeConstant();

			public function renderView() {
			return null;
			}

			public function renderListView() {
			return null;
			}

			protected function newItemFromProperties(
			array $properties,
			PhabricatorContentSource $content_source) {

			// TODO: Should we have a tighter actor/viewer model? Requestors will
			// often have no real user associated with them...
			$actor = PhabricatorUser::getOmnipotentUser();
			$source = $this->getSource();

			$item = NuanceItem::initializeNewItem();

			$xactions = array();

			$xactions[] = id(new NuanceItemTransaction())
			->setTransactionType(NuanceItemTransaction::TYPE_SOURCE)
			->setNewValue($source->getPHID());

			// TODO: Eventually, apply real routing rules. For now, just put everything
			// in the default queue for the source.
			$xactions[] = id(new NuanceItemTransaction())
			->setTransactionType(NuanceItemTransaction::TYPE_QUEUE)
			->setNewValue($source->getDefaultQueuePHID());

			foreach ($properties as $key => $property) {
			$xactions[] = id(new NuanceItemTransaction())
			->setTransactionType(NuanceItemTransaction::TYPE_PROPERTY)
			->setMetadataValue(NuanceItemTransaction::PROPERTY_KEY, $key)
			->setNewValue($property);
			}

			$editor = id(new NuanceItemEditor())
			->setActor($actor)
			->setContentSource($content_source);

			$editor->applyTransactions($item, $xactions);

			return $item;
			}

			public function renderItemEditProperties(
			PhabricatorUser $viewer,
			NuanceItem $item,
			PHUIPropertyListView $view) {
			return;
			}


			/* -( Handling Action Requests )------------------------------------------- */


			public function handleActionRequest(AphrontRequest $request) {
			return new Aphront404Response();
			}

			public function getActionURI($path = null) {
			$source_id = $this->getSource()->getID();
			return '/action/'.$source_id.'/'.ltrim($path, '/');
			}

			}

phab/src/applications/nuance/source/NuanceSourceDefinition.phpf50693de61d9stable

NuanceSourceDefinition.phpView Options

phab/src/applications/nuance/source/NuanceSourceDefinition.php
f50693de61d9stable

NuanceSourceDefinition.php
View Options