PhabricatorTokensToken.php

<?php

final class PhabricatorTokensToken extends PhabricatorTokenDAO
  implements
    PhabricatorDestructibleInterface,
    PhabricatorSubscribableInterface,
    PhabricatorFlaggableInterface,
    PhabricatorConduitResultInterface {

  protected $name;
  protected $flavor;
  protected $status;
  protected $creatorPHID;
  protected $tokenImagePHID;
  protected $builtinKey;

  private $tokenImageFile = self::ATTACHABLE;

  const STATUS_ACTIVE = 'active';
  const STATUS_ARCHIVED = 'archived';

  protected function getConfiguration() {
    return array(
      self::CONFIG_AUX_PHID   => true,
      self::CONFIG_COLUMN_SCHEMA => array(
        'name' => 'text64',
        'flavor' => 'text128',
        'status' => 'text32',
        'tokenImagePHID' => 'phid?',
        'builtinKey' => 'text32?',
      ),
      self::CONFIG_KEY_SCHEMA => array(
        'key_creator' => array(
          'columns' => array('creatorPHID', 'dateModified'),
        ),
        'key_builtin' => array(
          'columns' => array('builtinKey'),
          'unique' => true,
        ),
      ),
    ) + parent::getConfiguration();
  }

  public function getTableName() {
    return 'token_token';
  }

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

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

    $token = id(new self())
      ->setCreatorPHID($actor->getPHID())
      ->setStatus(self::STATUS_ACTIVE)
      ->setTokenImagePHID('');
    return $token;
  }

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

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

  public function getTokenImageURI() {
    return $this->getTokenImageFile()->getBestURI();
  }

  public function attachTokenImageFile(PhabricatorFile $file) {
    $this->tokenImageFile = $file;
    return $this;
  }

  public function getTokenImageFile() {
    return $this->assertAttached($this->tokenImageFile);
  }

  public function getViewURI() {
    return '/tokens/view/'.$this->getID().'/';
  }


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

  public function destroyObjectPermanently(
    PhabricatorDestructionEngine $engine) {

    $this->openTransaction();

      $tokens = id(new PhabricatorTokenGiven())
        ->loadAllWhere('tokenPHID = %s', $this->getPHID());
      foreach ($tokens as $token) {
        $token->delete();
      }
      if ($this->getTokenImagePHID()) {
        id(new PhabricatorFile())
          ->loadOneWhere('filePHID = %s', $this->getTokenImagePHID())
          ->delete();
      }

      $this->delete();

    $this->saveTransaction();
  }

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


  public function isAutomaticallySubscribed($phid) {
    return false;
  }


/* -(  PhabricatorConduitResultInterface  )---------------------------------- */


  public function getFieldSpecificationsForConduit() {
    return array(
      id(new PhabricatorConduitSearchFieldSpecification())
        ->setKey('name')
        ->setType('string')
        ->setDescription(pht('The name of the token.')),
      id(new PhabricatorConduitSearchFieldSpecification())
        ->setKey('flavor')
        ->setType('string')
        ->setDescription(pht('Token flavor.')),
      id(new PhabricatorConduitSearchFieldSpecification())
        ->setKey('status')
        ->setType('string')
        ->setDescription(pht('Archived or active status.')),
    );
  }

  public function getFieldValuesForConduit() {
    return array(
      'name' => $this->getName(),
      'flavor' => $this->getFlavor(),
      'status' => $this->getStatus(),
    );
  }

  public function getConduitSearchAttachments() {
    return array();
  }

}