Placement_Type.php
239 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Advanced_Ads; |
| 4 | |
| 5 | /** |
| 6 | * Class wrapper for placement types array. |
| 7 | * |
| 8 | * @property-read string $title |
| 9 | * @property-read string $description |
| 10 | * @property-read string $image |
| 11 | * @property-read float $order |
| 12 | * @property-read Placement_Type_Options $options |
| 13 | */ |
| 14 | class Placement_Type extends \ArrayObject { |
| 15 | |
| 16 | /** |
| 17 | * Placement type title. |
| 18 | * |
| 19 | * @var string |
| 20 | */ |
| 21 | private $title; |
| 22 | |
| 23 | /** |
| 24 | * Placement type description. |
| 25 | * |
| 26 | * @var string |
| 27 | */ |
| 28 | private $description = ''; |
| 29 | |
| 30 | /** |
| 31 | * Admin UI image src. |
| 32 | * |
| 33 | * @var string |
| 34 | */ |
| 35 | private $image = ''; |
| 36 | |
| 37 | /** |
| 38 | * Admin UI order for new placements. |
| 39 | * |
| 40 | * @var float |
| 41 | */ |
| 42 | private $order; |
| 43 | |
| 44 | /** |
| 45 | * A class to resolve the placement type options. |
| 46 | * |
| 47 | * @var Placement_Type_Options |
| 48 | */ |
| 49 | private $options; |
| 50 | |
| 51 | /** |
| 52 | * Compute all allowed ads once and assign them to this variable. |
| 53 | * |
| 54 | * @var array |
| 55 | */ |
| 56 | private $allowed_ads; |
| 57 | |
| 58 | /** |
| 59 | * Compute all allowed groups once and assign them to this variable. |
| 60 | * |
| 61 | * @var array |
| 62 | */ |
| 63 | private $allowed_groups; |
| 64 | |
| 65 | /** |
| 66 | * The placement type. |
| 67 | * |
| 68 | * @var string |
| 69 | */ |
| 70 | private $type; |
| 71 | |
| 72 | /** |
| 73 | * Assign simple placement definitions to properties. |
| 74 | * Instantiate Placement_Type_Options class. |
| 75 | * |
| 76 | * @param string $type The type of placement. |
| 77 | * @param array $placement_definition The definition options for the placement. |
| 78 | */ |
| 79 | public function __construct( $type, array $placement_definition ) { |
| 80 | $this->type = $type; |
| 81 | |
| 82 | if ( array_key_exists( 'title', $placement_definition ) ) { |
| 83 | $this->title = $placement_definition['title']; |
| 84 | } |
| 85 | |
| 86 | if ( array_key_exists( 'description', $placement_definition ) ) { |
| 87 | $this->description = $placement_definition['description']; |
| 88 | } |
| 89 | |
| 90 | if ( array_key_exists( 'image', $placement_definition ) ) { |
| 91 | $this->image = $placement_definition['image']; |
| 92 | } |
| 93 | |
| 94 | if ( array_key_exists( 'order', $placement_definition ) ) { |
| 95 | $this->order = (float) $placement_definition['order']; |
| 96 | } |
| 97 | |
| 98 | if ( ! array_key_exists( 'options', $placement_definition ) || ! is_array( $placement_definition['options'] ) ) { |
| 99 | $placement_definition['options'] = []; |
| 100 | } |
| 101 | |
| 102 | $this->options = new Placement_Type_Options( $placement_definition['options'] ); |
| 103 | |
| 104 | parent::__construct( $placement_definition ); |
| 105 | } |
| 106 | |
| 107 | /** |
| 108 | * Magic catch to have readonly properties. |
| 109 | * |
| 110 | * @param string $name The name of the requested property. |
| 111 | * |
| 112 | * @return mixed |
| 113 | * @noinspection MagicMethodsValidityInspection -- no setter as we only want readonly properties |
| 114 | */ |
| 115 | public function __get( $name ) { |
| 116 | if ( property_exists( $this, $name ) ) { |
| 117 | return $this->{$name}; |
| 118 | } |
| 119 | |
| 120 | return null; |
| 121 | } |
| 122 | |
| 123 | /** |
| 124 | * Check if the provided ad type is allowed (or at least not excluded). |
| 125 | * If an ad type is both allowed and forbidden, the allow-list takes precedence. |
| 126 | * |
| 127 | * @param string $type Ad type. |
| 128 | * |
| 129 | * @return bool |
| 130 | */ |
| 131 | public function is_ad_type_allowed( $type ) { |
| 132 | return $this->is_abstract_allowed( $type, 'ad' ); |
| 133 | } |
| 134 | |
| 135 | /** |
| 136 | * Check if the provided ad group type is allowed. |
| 137 | * |
| 138 | * @param string $type Ad group type. |
| 139 | * |
| 140 | * @return bool |
| 141 | */ |
| 142 | public function is_group_type_allowed( $type ) { |
| 143 | return $this->is_abstract_allowed( $type, 'group' ); |
| 144 | } |
| 145 | |
| 146 | /** |
| 147 | * Abstraction of comparing whether type is allowed or excluded. |
| 148 | * |
| 149 | * @param string $type Specific Advanced_Ads_Ad::$type or Advanced_Ads_Ad_Group::$type. |
| 150 | * @param string $class Overall classification, one of `ad` or `group`. |
| 151 | * |
| 152 | * @return bool |
| 153 | */ |
| 154 | private function is_abstract_allowed( $type, $class ) { |
| 155 | $allowed = $this->options->offsetGet( 'allowed_' . $class . '_types' ); |
| 156 | |
| 157 | if ( $allowed === null ) { |
| 158 | return ! in_array( $type, $this->options->offsetGet( 'excluded_' . $class . '_types' ), true ); |
| 159 | } |
| 160 | |
| 161 | return in_array( $type, $allowed, true ); |
| 162 | } |
| 163 | |
| 164 | /** |
| 165 | * Get all allowed groups for this placement type. |
| 166 | * Save them in instance, so they only have to be calculated once per type. |
| 167 | * |
| 168 | * @return array |
| 169 | */ |
| 170 | public function get_allowed_groups() { |
| 171 | if ( isset( $this->allowed_groups ) ) { |
| 172 | return $this->allowed_groups; |
| 173 | } |
| 174 | |
| 175 | $this->allowed_groups = []; |
| 176 | |
| 177 | foreach ( \Advanced_Ads::get_instance()->get_model()->get_ad_groups() as $group ) { |
| 178 | if ( ! $this->is_group_type_allowed( $group->type ) ) { |
| 179 | continue; |
| 180 | } |
| 181 | |
| 182 | // check if the group has allowed ads. |
| 183 | $group_ads = array_filter( $group->get_all_ads(), function( \WP_Post $ad_post ) { |
| 184 | return $this->is_ad_type_allowed( ( new \Advanced_Ads_Ad( $ad_post->ID ) )->type ); |
| 185 | } ); |
| 186 | if ( empty( $group_ads ) ) { |
| 187 | continue; |
| 188 | } |
| 189 | |
| 190 | $this->allowed_groups[ 'group_' . $group->id ] = $group->name; |
| 191 | } |
| 192 | |
| 193 | return $this->allowed_groups; |
| 194 | } |
| 195 | |
| 196 | /** |
| 197 | * Get all allowed ads for this placement type. |
| 198 | * Save them in instance, so they only have to be calculated once per type. |
| 199 | * |
| 200 | * @return array |
| 201 | */ |
| 202 | public function get_allowed_ads() { |
| 203 | if ( isset( $this->allowed_ads ) ) { |
| 204 | return $this->allowed_ads; |
| 205 | } |
| 206 | |
| 207 | $this->allowed_ads = []; |
| 208 | |
| 209 | foreach ( $this->get_all_ads() as $ad ) { |
| 210 | if ( ! $this->is_ad_type_allowed( $ad->type ) ) { |
| 211 | continue; |
| 212 | } |
| 213 | $this->allowed_ads[ 'ad_' . apply_filters( 'wpml_object_id', $ad->id, 'advanced_ads', true ) ] = $ad->title; |
| 214 | } |
| 215 | |
| 216 | return $this->allowed_ads; |
| 217 | } |
| 218 | |
| 219 | /** |
| 220 | * Get all available ads once. |
| 221 | * |
| 222 | * @return \Advanced_Ads_Ad[] |
| 223 | */ |
| 224 | private function get_all_ads() { |
| 225 | static $all_ads; |
| 226 | if ( $all_ads === null ) { |
| 227 | $all_ads = array_map( function( $ad_id ) { |
| 228 | return new \Advanced_Ads_Ad( $ad_id ); |
| 229 | }, \Advanced_Ads::get_instance()->get_model()->get_ads( [ |
| 230 | 'orderby' => 'title', |
| 231 | 'order' => 'ASC', |
| 232 | 'fields' => 'ids', |
| 233 | ] ) ); |
| 234 | } |
| 235 | |
| 236 | return $all_ads; |
| 237 | } |
| 238 | } |
| 239 |