Feature
7 years ago
View
7 years ago
Widget
7 years ago
phtml
7 years ago
Authorization.php
7 years ago
Feature.php
7 years ago
Filter.php
7 years ago
Manager.php
7 years ago
Subject.php
7 years ago
View.php
7 years ago
Feature.php
156 lines
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * ====================================================================== |
| 5 | * LICENSE: This file is subject to the terms and conditions defined in * |
| 6 | * file 'license.txt', which is part of this source code package. * |
| 7 | * ====================================================================== |
| 8 | */ |
| 9 | |
| 10 | /** |
| 11 | * AAM Backend Feature |
| 12 | * |
| 13 | * This class is used to hold the list of all registered UI features with few neat |
| 14 | * methods to manipulate it. |
| 15 | * |
| 16 | * @author Vasyl Martyniuk <vasyl@vasyltech.com> |
| 17 | */ |
| 18 | class AAM_Backend_Feature { |
| 19 | |
| 20 | /** |
| 21 | * Collection of features |
| 22 | * |
| 23 | * @var array |
| 24 | * |
| 25 | * @access private |
| 26 | * @static |
| 27 | */ |
| 28 | static private $_features = array(); |
| 29 | |
| 30 | /** |
| 31 | * Register UI Feature |
| 32 | * |
| 33 | * @param stdClass $feature |
| 34 | * |
| 35 | * @return boolean |
| 36 | * |
| 37 | * @access public |
| 38 | * @static |
| 39 | */ |
| 40 | public static function registerFeature(stdClass $feature) { |
| 41 | $response = false; |
| 42 | |
| 43 | if (empty($feature->capability)){ |
| 44 | $cap = 'aam_manager'; |
| 45 | } else { |
| 46 | $cap = $feature->capability; |
| 47 | } |
| 48 | |
| 49 | if (isset($feature->option)) { |
| 50 | $show = self::isVisible($feature->option); |
| 51 | } else { |
| 52 | $show = true; |
| 53 | } |
| 54 | |
| 55 | if ($show && current_user_can($cap)) { |
| 56 | self::$_features[] = $feature; |
| 57 | $response = true; |
| 58 | } |
| 59 | |
| 60 | return $response; |
| 61 | } |
| 62 | |
| 63 | /** |
| 64 | * Check if feature is visible |
| 65 | * |
| 66 | * There is a way to show/hide feature based on the option. For example some |
| 67 | * features should be visible only when Backend Access options is enabled. |
| 68 | * |
| 69 | * @param string $options |
| 70 | * |
| 71 | * @return boolean |
| 72 | * |
| 73 | * @access protected |
| 74 | */ |
| 75 | protected static function isVisible($options) { |
| 76 | $count = 0; |
| 77 | |
| 78 | foreach(explode(',', $options) as $option) { |
| 79 | $count += AAM_Core_Config::get($option, true); |
| 80 | } |
| 81 | |
| 82 | return ($count > 0); |
| 83 | } |
| 84 | |
| 85 | /** |
| 86 | * Initiate the Controller |
| 87 | * |
| 88 | * @param stdClass $feature |
| 89 | * |
| 90 | * @return stdClass |
| 91 | * |
| 92 | * @access public |
| 93 | * @static |
| 94 | */ |
| 95 | public static function initView(stdClass $feature){ |
| 96 | if (is_string($feature->view)){ |
| 97 | $feature->view = new $feature->view(AAM_Backend_Subject::getInstance()); |
| 98 | } |
| 99 | |
| 100 | return $feature; |
| 101 | } |
| 102 | |
| 103 | /** |
| 104 | * Retrieve list of features |
| 105 | * |
| 106 | * Retrieve sorted list of featured based on current subject |
| 107 | * |
| 108 | * @param string $type |
| 109 | * |
| 110 | * @return array |
| 111 | * |
| 112 | * @access public |
| 113 | * @static |
| 114 | */ |
| 115 | public static function retrieveList($type) { |
| 116 | $response = array(); |
| 117 | |
| 118 | $subject = AAM_Backend_Subject::getInstance()->getUID(); |
| 119 | foreach (self::$_features as $feature) { |
| 120 | $ftype = (!empty($feature->type) ? $feature->type : 'main'); //TODO - legacy Nov 2018 |
| 121 | if ($ftype === $type |
| 122 | && (empty($feature->subjects) || in_array($subject, $feature->subjects, true))) { |
| 123 | $response[] = self::initView($feature); |
| 124 | } |
| 125 | } |
| 126 | usort($response, 'AAM_Backend_Feature::reorder'); |
| 127 | |
| 128 | return $response; |
| 129 | } |
| 130 | |
| 131 | /** |
| 132 | * Order list of features |
| 133 | * |
| 134 | * Reorganize the list based on "position" attribute |
| 135 | * |
| 136 | * @param array $features |
| 137 | * |
| 138 | * @return array |
| 139 | * |
| 140 | * @access public |
| 141 | * @static |
| 142 | */ |
| 143 | public static function reorder($feature_a, $feature_b){ |
| 144 | $pos_a = (empty($feature_a->position) ? 9999 : $feature_a->position); |
| 145 | $pos_b = (empty($feature_b->position) ? 9999 : $feature_b->position); |
| 146 | |
| 147 | if ($pos_a === $pos_b){ |
| 148 | $response = 0; |
| 149 | } else { |
| 150 | $response = ($pos_a < $pos_b ? -1 : 1); |
| 151 | } |
| 152 | |
| 153 | return $response; |
| 154 | } |
| 155 | |
| 156 | } |