Differential D13626 Diff 32960 src/applications/badges/storage/PhabricatorBadge.php

Changeset View

Standalone View

src/applications/badges/storage/PhabricatorBadge.php

This file was added.

				<?php

				final class PhabricatorBadge extends PhabricatorBadgesDAO
				implements
				epriestleyUnsubmitted Done Inline Actions This should more properly be called `PhabricatorBadgesBadge`. epriestley: This should more properly be called `PhabricatorBadgesBadge`.
				PhabricatorPolicyInterface,
				PhabricatorApplicationTransactionInterface,
				PhabricatorSubscribableInterface,
				PhabricatorDestructibleInterface {

				protected $name;
				protected $flavor;
				protected $description;
				protected $icon;
				protected $quality;
				protected $viewPolicy;
				protected $editPolicy;
				protected $status;
				protected $creatorPHID;

				private $recipientPHIDs = self::ATTACHABLE;

				const STATUS_OPEN = 'open';
				const STATUS_CLOSED = 'closed';

				const DEFAULT_ICON = 'fa-star';
				const DEFAULT_QUALITY = 'green';

				const POOR = 'grey';
				const COMMON = 'white';
				const UNCOMMON = 'green';
				const RARE = 'blue';
				const EPIC = 'indigo';
				const LEGENDARY = 'orange';
				const HEIRLOOM = 'yellow';

				public static function getStatusNameMap() {
				return array(
				self::STATUS_OPEN => pht('Active'),
				self::STATUS_CLOSED => pht('Archived'),
				);
				}

				public static function getQualityNameMap() {
				return array(
				self::POOR => pht('Poor'),
				self::COMMON => pht('Common'),
				self::UNCOMMON => pht('Uncommon'),
				self::RARE => pht('Rare'),
				self::EPIC => pht('Epic'),
				self::LEGENDARY => pht('Legendary'),
				self::HEIRLOOM => pht('Heirloom'),
				);
				}

				public static function getIconNameMap() {
				return PhabricatorBadgesIcon::getIconMap();
				}

				public static function initializeNewBadge(PhabricatorUser $actor) {
				$app = id(new PhabricatorApplicationQuery())
				->setViewer($actor)
				->withClasses(array('PhabricatorBadgesApplication'))
				->executeOne();

				$view_policy =
				$app->getPolicy(PhabricatorBadgesDefaultViewCapability::CAPABILITY);

				$edit_policy =
				$app->getPolicy(PhabricatorBadgesDefaultEditCapability::CAPABILITY);

				return id(new PhabricatorBadge())
				->setIcon(self::DEFAULT_ICON)
				->setQuality(self::DEFAULT_QUALITY)
				->setCreatorPHID($actor->getPHID())
				->setViewPolicy($view_policy)
				->setEditPolicy($edit_policy)
				->setStatus(self::STATUS_OPEN);
				}

				protected function getConfiguration() {
				return array(
				self::CONFIG_AUX_PHID => true,
				self::CONFIG_COLUMN_SCHEMA => array(
				'name' => 'text255',
				'flavor' => 'text255',
				'description' => 'text',
				'icon' => 'text255',
				'quality' => 'text255',
				'status' => 'text32',
				),
				self::CONFIG_KEY_SCHEMA => array(
				'key_creator' => array(
				'columns' => array('creatorPHID', 'dateModified'),
				),
				),
				epriestleyUnsubmitted Not Done Inline Actions This key is probably unnecessary. epriestley: This key is probably unnecessary.
				) + parent::getConfiguration();
				}

				public function generatePHID() {
				return
				PhabricatorPHID::generateNewPHID(PhabricatorBadgesPHIDType::TYPECONST);
				}

				public function isClosed() {
				return ($this->getStatus() == self::STATUS_CLOSED);
				}

				public function attachRecipientPHIDs(array $phids) {
				$this->recipientPHIDs = $phids;
				return $this;
				}

				public function getRecipientPHIDs() {
				return $this->assertAttached($this->recipientPHIDs);
				}


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


				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;
				}


				/* -( PhabricatorApplicationTransactionInterface )------------------------- */


				public function getApplicationTransactionEditor() {
				return new PhabricatorBadgesEditor();
				}

				public function getApplicationTransactionObject() {
				return $this;
				}

				public function getApplicationTransactionTemplate() {
				return new PhabricatorBadgesTransaction();
				}

				public function willRenderTimeline(
				PhabricatorApplicationTransactionView $timeline,
				AphrontRequest $request) {

				return $timeline;
				}


				/* -( PhabricatorSubscribableInterface )----------------------------------- */


				public function isAutomaticallySubscribed($phid) {
				return ($this->creatorPHID == $phid);
				}

				public function shouldShowSubscribersProperty() {
				return true;
				}

				public function shouldAllowSubscription($phid) {
				return true;
				}


				/* -( PhabricatorDestructibleInterface )----------------------------------- */


				public function destroyObjectPermanently(
				PhabricatorDestructionEngine $engine) {

				$this->openTransaction();
				$this->delete();
				$this->saveTransaction();
				}

				}