abstract-ad.php
1 week ago
abstract-admin-list-table.php
1 week ago
abstract-data.php
1 week ago
abstract-factory.php
1 week ago
abstract-group.php
6 days ago
abstract-placement-type.php
1 week ago
abstract-placement.php
3 months ago
abstract-screen.php
3 months ago
abstract-types.php
1 week ago
index.php
2 years ago
abstract-types.php
215 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Abstracts Types. |
| 4 | * |
| 5 | * @package AdvancedAds |
| 6 | * @author Advanced Ads <info@wpadvancedads.com> |
| 7 | * @since 1.47.0 |
| 8 | */ |
| 9 | |
| 10 | namespace AdvancedAds\Abstracts; |
| 11 | |
| 12 | use AdvancedAds\Framework\Utilities\Str; |
| 13 | use AdvancedAds\Framework\Interfaces\Integration_Interface; |
| 14 | |
| 15 | defined( 'ABSPATH' ) || exit; |
| 16 | |
| 17 | /** |
| 18 | * Abstracts Types. |
| 19 | */ |
| 20 | abstract class Types implements Integration_Interface { |
| 21 | |
| 22 | /** |
| 23 | * Hold types. |
| 24 | * |
| 25 | * @var array |
| 26 | */ |
| 27 | protected $types = []; |
| 28 | |
| 29 | /** |
| 30 | * Hook to filter types. |
| 31 | * |
| 32 | * @var string |
| 33 | */ |
| 34 | protected $hook = 'advanced-ads-none-types'; |
| 35 | |
| 36 | /** |
| 37 | * Class for unknown type. |
| 38 | * |
| 39 | * @var string |
| 40 | */ |
| 41 | protected $type_unknown = ''; |
| 42 | |
| 43 | /** |
| 44 | * Type interface to check. |
| 45 | * |
| 46 | * @var string |
| 47 | */ |
| 48 | protected $type_interface = ''; |
| 49 | |
| 50 | /** |
| 51 | * Check if has premium types. |
| 52 | * |
| 53 | * @var bool |
| 54 | */ |
| 55 | private $has_premium = null; |
| 56 | |
| 57 | /** |
| 58 | * Hook into WordPress. |
| 59 | * |
| 60 | * @return void |
| 61 | */ |
| 62 | public function hooks(): void { |
| 63 | add_action( 'init', [ $this, 'register_types' ], 25 ); |
| 64 | } |
| 65 | |
| 66 | /** |
| 67 | * Create missing type |
| 68 | * |
| 69 | * @param string $type Missing type. |
| 70 | * |
| 71 | * @return mixed |
| 72 | */ |
| 73 | public function create_missing( $type ) { |
| 74 | $this->types[ $type ] = new $this->type_unknown( |
| 75 | [ |
| 76 | 'id' => $type, |
| 77 | 'title' => Str::capitalize( $type ), |
| 78 | ] |
| 79 | ); |
| 80 | |
| 81 | return $this->types[ $type ]; |
| 82 | } |
| 83 | |
| 84 | /** |
| 85 | * Register custom type. |
| 86 | * |
| 87 | * @param string $classname Type class name. |
| 88 | * |
| 89 | * @return void |
| 90 | */ |
| 91 | public function register_type( $classname ): void { |
| 92 | $type = new $classname(); |
| 93 | $this->types[ $type->get_id() ] = $type; |
| 94 | } |
| 95 | |
| 96 | /** |
| 97 | * Register custom types. |
| 98 | * |
| 99 | * @return void |
| 100 | */ |
| 101 | public function register_types(): void { |
| 102 | $this->register_default_types(); |
| 103 | /** |
| 104 | * Developers can add new types using this filter |
| 105 | */ |
| 106 | do_action( $this->hook . '-manager', $this ); |
| 107 | $this->types = apply_filters( $this->hook, $this->types ); |
| 108 | |
| 109 | $this->validate_types(); |
| 110 | } |
| 111 | |
| 112 | /** |
| 113 | * Has type. |
| 114 | * |
| 115 | * @param string $type Type to check. |
| 116 | * |
| 117 | * @return bool |
| 118 | */ |
| 119 | public function has_type( $type ): bool { |
| 120 | return array_key_exists( $type, $this->types ); |
| 121 | } |
| 122 | |
| 123 | /** |
| 124 | * Get the registered type. |
| 125 | * |
| 126 | * @param string $type Type to get. |
| 127 | * |
| 128 | * @return mixed|bool |
| 129 | */ |
| 130 | public function get_type( $type ) { |
| 131 | return $this->types[ $type ] ?? false; |
| 132 | } |
| 133 | |
| 134 | /** |
| 135 | * Resolve the entity class for a type id, with lazy registration and default fallback. |
| 136 | * |
| 137 | * @param string $entity_type Entity type id. |
| 138 | * @param string $default_type Fallback type id when $entity_type is unknown. |
| 139 | * |
| 140 | * @return string Entity class name. |
| 141 | */ |
| 142 | public function get_classname_for_type( $entity_type, $default_type = 'default' ): string { |
| 143 | if ( empty( $this->types ) || ! $this->has_type( $default_type ) ) { |
| 144 | $this->register_types(); |
| 145 | } |
| 146 | |
| 147 | $type = $this->has_type( $entity_type ) |
| 148 | ? $this->get_type( $entity_type ) |
| 149 | : $this->get_type( $default_type ); |
| 150 | |
| 151 | return $type->get_classname(); |
| 152 | } |
| 153 | |
| 154 | /** |
| 155 | * Get the registered types. |
| 156 | * |
| 157 | * @param bool $with_unknown Include unknown type placements. |
| 158 | * |
| 159 | * @return array |
| 160 | */ |
| 161 | public function get_types( $with_unknown = true ): array { |
| 162 | return $with_unknown ? $this->types : array_filter( $this->types, fn( $type ) => ! is_a( $type, $this->type_unknown ) ); |
| 163 | } |
| 164 | |
| 165 | /** |
| 166 | * Check if has premium types. |
| 167 | * |
| 168 | * @return bool |
| 169 | */ |
| 170 | public function has_premium(): bool { |
| 171 | if ( null !== $this->has_premium ) { |
| 172 | return $this->has_premium; |
| 173 | } |
| 174 | |
| 175 | $this->has_premium = false; |
| 176 | |
| 177 | foreach ( $this->get_types() as $type ) { |
| 178 | if ( $type->is_premium() ) { |
| 179 | $this->has_premium = true; |
| 180 | break; |
| 181 | } |
| 182 | } |
| 183 | |
| 184 | return $this->has_premium; |
| 185 | } |
| 186 | |
| 187 | /** |
| 188 | * Register default types. |
| 189 | * |
| 190 | * @return void |
| 191 | */ |
| 192 | abstract protected function register_default_types(): void; |
| 193 | |
| 194 | /** |
| 195 | * Validate types by type interface |
| 196 | * |
| 197 | * @return void |
| 198 | */ |
| 199 | private function validate_types(): void { |
| 200 | // Early bail!! |
| 201 | if ( empty( $this->type_unknown ) || empty( $this->type_interface ) ) { |
| 202 | return; |
| 203 | } |
| 204 | |
| 205 | foreach ( $this->types as $slug => $type ) { |
| 206 | if ( ! is_array( $type ) || is_a( $type, $this->type_interface ) ) { |
| 207 | continue; |
| 208 | } |
| 209 | |
| 210 | $type['id'] = $slug; |
| 211 | $this->types[ $slug ] = new $this->type_unknown( $type ); |
| 212 | } |
| 213 | } |
| 214 | } |
| 215 |