src/applications/settings/setting/PhabricatorSetting.php

   1 <?php
   2
   3 abstract class PhabricatorSetting extends Phobject {
   4
   5   private $viewer = false;
   6
   7   public function setViewer(PhabricatorUser $viewer = null) {
   8     $this->viewer = $viewer;
   9     return $this;
  10   }
  11
  12   public function getViewer() {
  13     if ($this->viewer === false) {
  14       throw new PhutilInvalidStateException('setViewer');
  15     }
  16     return $this->viewer;
  17   }
  18
  19   abstract public function getSettingName();
  20
  21   public function getSettingPanelKey() {
  22     return null;
  23   }
  24
  25   protected function getSettingOrder() {
  26     return 1000;
  27   }
  28
  29   public function getSettingOrderVector() {
  30     return id(new PhutilSortVector())
  31       ->addInt($this->getSettingOrder())
  32       ->addString($this->getSettingName());
  33   }
  34
  35   protected function getControlInstructions() {
  36     return null;
  37   }
  38
  39   protected function isEnabledForViewer(PhabricatorUser $viewer) {
  40     return true;
  41   }
  42
  43   public function getSettingDefaultValue() {
  44     return null;
  45   }
  46
  47   final public function getSettingKey() {
  48     return $this->getPhobjectClassConstant('SETTINGKEY');
  49   }
  50
  51   public static function getAllSettings() {
  52     return id(new PhutilClassMapQuery())
  53       ->setAncestorClass(__CLASS__)
  54       ->setUniqueMethod('getSettingKey')
  55       ->execute();
  56   }
  57
  58   public static function getAllEnabledSettings(PhabricatorUser $viewer) {
  59     $settings = self::getAllSettings();
  60     foreach ($settings as $key => $setting) {
  61       if (!$setting->isEnabledForViewer($viewer)) {
  62         unset($settings[$key]);
  63       }
  64     }
  65     return $settings;
  66   }
  67
  68   final public function newCustomEditFields($object) {
  69     $fields = array();
  70
  71     $field = $this->newCustomEditField($object);
  72     if ($field) {
  73       $fields[] = $field;
  74     }
  75
  76     return $fields;
  77   }
  78
  79   protected function newCustomEditField($object) {
  80     return null;
  81   }
  82
  83   protected function newEditField($object, PhabricatorEditField $template) {
  84     $setting_property = PhabricatorUserPreferencesTransaction::PROPERTY_SETTING;
  85     $setting_key = $this->getSettingKey();
  86     $value = $object->getPreference($setting_key);
  87     $xaction_type = PhabricatorUserPreferencesTransaction::TYPE_SETTING;
  88     $label = $this->getSettingName();
  89
  90     $template
  91       ->setKey($setting_key)
  92       ->setLabel($label)
  93       ->setValue($value)
  94       ->setTransactionType($xaction_type)
  95       ->setMetadataValue($setting_property, $setting_key);
  96
  97     $instructions = $this->getControlInstructions();
  98     if (strlen($instructions)) {
  99       $template->setControlInstructions($instructions);
 100     }
 101
 102     return $template;
 103   }
 104
 105   public function validateTransactionValue($value) {
 106     return;
 107   }
 108
 109   public function assertValidValue($value) {
 110     $this->validateTransactionValue($value);
 111   }
 112
 113   public function getTransactionNewValue($value) {
 114     return $value;
 115   }
 116
 117   public function expandSettingTransaction($object, $xaction) {
 118     return array($xaction);
 119   }
 120
 121   protected function newSettingTransaction($object, $key, $value) {
 122     $setting_property = PhabricatorUserPreferencesTransaction::PROPERTY_SETTING;
 123     $xaction_type = PhabricatorUserPreferencesTransaction::TYPE_SETTING;
 124
 125     return id(clone $object->getApplicationTransactionTemplate())
 126       ->setTransactionType($xaction_type)
 127       ->setMetadataValue($setting_property, $key)
 128       ->setNewValue($value);
 129   }
 130
 131 }