FeatureFlagsController.php
3 years ago
FeatureFlagsRepository.php
3 years ago
FeaturesController.php
1 month ago
index.php
3 years ago
FeaturesController.php
88 lines
| 1 | <?php // phpcs:ignore SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing |
| 2 | |
| 3 | namespace MailPoet\Features; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoetVendor\Doctrine\DBAL\Exception\TableNotFoundException; |
| 9 | |
| 10 | class FeaturesController { |
| 11 | const FEATURE_BRAND_TEMPLATES = 'brand_templates'; |
| 12 | const FEATURE_SEND_BY_TIMEZONE = 'send_by_timezone'; |
| 13 | |
| 14 | // Define feature defaults in the array below in the following form: |
| 15 | // self::FEATURE_NAME_OF_FEATURE => true, |
| 16 | private $defaults = [ |
| 17 | self::FEATURE_BRAND_TEMPLATES => false, |
| 18 | self::FEATURE_SEND_BY_TIMEZONE => false, |
| 19 | ]; |
| 20 | |
| 21 | /** @var array|null */ |
| 22 | private $flags; |
| 23 | |
| 24 | /** @var FeatureFlagsRepository */ |
| 25 | private $featureFlagsRepository; |
| 26 | |
| 27 | public function __construct( |
| 28 | FeatureFlagsRepository $featureFlagsRepository |
| 29 | ) { |
| 30 | $this->featureFlagsRepository = $featureFlagsRepository; |
| 31 | } |
| 32 | |
| 33 | /** @return bool */ |
| 34 | public function isSupported($feature) { |
| 35 | if (!$this->exists($feature)) { |
| 36 | throw new \RuntimeException("Unknown feature '$feature'"); |
| 37 | } |
| 38 | // ensure controller works even if used before migrator, return default value in such case |
| 39 | try { |
| 40 | $this->ensureFlagsLoaded(); |
| 41 | } catch (TableNotFoundException $e) { |
| 42 | return $this->defaults[$feature]; |
| 43 | } |
| 44 | return ($this->flags ?? [])[$feature]; |
| 45 | } |
| 46 | |
| 47 | /** @return bool */ |
| 48 | public function exists($feature) { |
| 49 | return array_key_exists($feature, $this->defaults); |
| 50 | } |
| 51 | |
| 52 | /** @return array */ |
| 53 | public function getDefaults() { |
| 54 | return $this->defaults; |
| 55 | } |
| 56 | |
| 57 | /** @return array */ |
| 58 | public function getAllFlags() { |
| 59 | $this->ensureFlagsLoaded(); |
| 60 | return $this->flags ?? []; |
| 61 | } |
| 62 | |
| 63 | public function resetCache(): void { |
| 64 | $this->flags = null; |
| 65 | } |
| 66 | |
| 67 | private function ensureFlagsLoaded() { |
| 68 | if ($this->flags !== null) { |
| 69 | return; |
| 70 | } |
| 71 | |
| 72 | $flagsMap = $this->getValueMap(); |
| 73 | $this->flags = []; |
| 74 | foreach ($this->defaults as $name => $default) { |
| 75 | $this->flags[$name] = isset($flagsMap[$name]) ? $flagsMap[$name] : $default; |
| 76 | } |
| 77 | } |
| 78 | |
| 79 | private function getValueMap() { |
| 80 | $features = $this->featureFlagsRepository->findAll(); |
| 81 | $featuresMap = []; |
| 82 | foreach ($features as $feature) { |
| 83 | $featuresMap[$feature->getName()] = (bool)$feature->getValue(); |
| 84 | } |
| 85 | return $featuresMap; |
| 86 | } |
| 87 | } |
| 88 |