class-capabilities.php
182 lines
| 1 | <?php |
| 2 | /** |
| 3 | * The class is responsible for managing and registering capabilities in WordPress. |
| 4 | * |
| 5 | * @package AdvancedAds |
| 6 | * @author Advanced Ads <info@wpadvancedads.com> |
| 7 | * @since 1.47.0 |
| 8 | */ |
| 9 | |
| 10 | namespace AdvancedAds\Installation; |
| 11 | |
| 12 | defined( 'ABSPATH' ) || exit; |
| 13 | |
| 14 | /** |
| 15 | * Capabilities manager. |
| 16 | */ |
| 17 | class Capabilities { |
| 18 | |
| 19 | /** |
| 20 | * Instance |
| 21 | * |
| 22 | * @var object |
| 23 | */ |
| 24 | protected static $instance; |
| 25 | |
| 26 | /** |
| 27 | * Registered capabilities. |
| 28 | * |
| 29 | * @var array |
| 30 | */ |
| 31 | private $capabilities = []; |
| 32 | |
| 33 | /** |
| 34 | * Registered capabilities by role. |
| 35 | * |
| 36 | * @var array |
| 37 | */ |
| 38 | private $role_capabilities = []; |
| 39 | |
| 40 | /** |
| 41 | * The constructor |
| 42 | */ |
| 43 | public function __construct() { |
| 44 | $this->register_defaults(); |
| 45 | } |
| 46 | |
| 47 | /** |
| 48 | * Get instance |
| 49 | * |
| 50 | * @return Capabilities |
| 51 | */ |
| 52 | public static function get_instance() { |
| 53 | // If the single instance hasn't been set, set it now. |
| 54 | if ( null === self::$instance ) { |
| 55 | self::$instance = new self(); |
| 56 | } |
| 57 | |
| 58 | return self::$instance; |
| 59 | } |
| 60 | |
| 61 | /** |
| 62 | * Set default capabilities. |
| 63 | * |
| 64 | * @return void |
| 65 | */ |
| 66 | public function register_defaults(): void { |
| 67 | $this->register( |
| 68 | 'advanced_ads_manage_options', |
| 69 | esc_html__( 'Allows changing plugin options', 'advanced-ads' ), |
| 70 | 'administrator' |
| 71 | ); |
| 72 | |
| 73 | $this->register( |
| 74 | 'advanced_ads_see_interface', |
| 75 | esc_html__( 'Allows access to the Advanced Ads backend', 'advanced-ads' ), |
| 76 | 'administrator' |
| 77 | ); |
| 78 | |
| 79 | $this->register( |
| 80 | 'advanced_ads_edit_ads', |
| 81 | esc_html__( 'Allows editing ads', 'advanced-ads' ), |
| 82 | 'administrator' |
| 83 | ); |
| 84 | |
| 85 | $this->register( |
| 86 | 'advanced_ads_manage_placements', |
| 87 | esc_html__( 'Allows changing the placements page', 'advanced-ads' ), |
| 88 | 'administrator' |
| 89 | ); |
| 90 | |
| 91 | $this->register( |
| 92 | 'advanced_ads_place_ads', |
| 93 | esc_html__( 'Enables shortcode button', 'advanced-ads' ), |
| 94 | 'administrator' |
| 95 | ); |
| 96 | } |
| 97 | |
| 98 | /** |
| 99 | * Register a capability. |
| 100 | * |
| 101 | * @param string $capability Capability slug. |
| 102 | * @param string $title Capability title. |
| 103 | * @param array|string $roles Roles to assigned. |
| 104 | * |
| 105 | * @return void |
| 106 | */ |
| 107 | public function register( $capability, $title, $roles ): void { |
| 108 | $this->capabilities[ $capability ] = $title; |
| 109 | |
| 110 | foreach ( (array) $roles as $role ) { |
| 111 | $this->role_capabilities[ $role ] = $this->role_capabilities[ $role ] ?? []; |
| 112 | $this->role_capabilities[ $role ][] = $capability; |
| 113 | } |
| 114 | } |
| 115 | |
| 116 | /** |
| 117 | * Create capabilities. |
| 118 | * |
| 119 | * @return void |
| 120 | */ |
| 121 | public function create_capabilities(): void { |
| 122 | foreach ( $this->get_roles() as $role ) { |
| 123 | $this->loop_capabilities( $role, 'add_cap' ); |
| 124 | } |
| 125 | } |
| 126 | |
| 127 | /** |
| 128 | * Remove capabilities. |
| 129 | * |
| 130 | * @return void |
| 131 | */ |
| 132 | public function remove_capabilities(): void { |
| 133 | foreach ( $this->get_roles() as $role ) { |
| 134 | $this->loop_capabilities( $role, 'remove_cap' ); |
| 135 | } |
| 136 | } |
| 137 | |
| 138 | /** |
| 139 | * Reset capabilities. |
| 140 | * |
| 141 | * @return void |
| 142 | */ |
| 143 | public function reset_capabilities(): void { |
| 144 | $this->remove_capabilities(); |
| 145 | $this->create_capabilities(); |
| 146 | } |
| 147 | |
| 148 | /** |
| 149 | * Get roles names |
| 150 | * |
| 151 | * @return array |
| 152 | */ |
| 153 | private function get_roles(): array { |
| 154 | $roles = wp_roles(); |
| 155 | return array_keys( $roles->get_names() ); |
| 156 | } |
| 157 | |
| 158 | /** |
| 159 | * Loop capabilities and perform action. |
| 160 | * |
| 161 | * @param string $role_slug Role slug. |
| 162 | * @param string $perform Action to perform. |
| 163 | * |
| 164 | * @return void |
| 165 | */ |
| 166 | private function loop_capabilities( $role_slug, $perform ): void { |
| 167 | // Early bail!! |
| 168 | if ( ! isset( $this->role_capabilities[ $role_slug ] ) ) { |
| 169 | return; |
| 170 | } |
| 171 | |
| 172 | $role = get_role( $role_slug ); |
| 173 | if ( ! $role ) { |
| 174 | return; |
| 175 | } |
| 176 | |
| 177 | foreach ( $this->role_capabilities[ $role_slug ] as $cap ) { |
| 178 | $role->$perform( $cap ); |
| 179 | } |
| 180 | } |
| 181 | } |
| 182 |