abstract-ad.php
2 days ago
abstract-admin-list-table.php
1 week ago
abstract-data.php
1 week ago
abstract-factory.php
2 days ago
abstract-group.php
2 days ago
abstract-placement-type.php
1 week ago
abstract-placement.php
2 days ago
abstract-screen.php
3 months ago
abstract-types.php
2 days ago
index.php
2 years ago
abstract-placement-type.php
175 lines
| 1 | <?php |
| 2 | /** |
| 3 | * This class is serving as the base for placement types. |
| 4 | * |
| 5 | * @package AdvancedAds |
| 6 | * @author Advanced Ads <info@wpadvancedads.com> |
| 7 | * @since 1.50.0 |
| 8 | */ |
| 9 | |
| 10 | namespace AdvancedAds\Abstracts; |
| 11 | |
| 12 | defined( 'ABSPATH' ) || exit; |
| 13 | |
| 14 | /** |
| 15 | * Placement Type. |
| 16 | */ |
| 17 | class Placement_Type { |
| 18 | |
| 19 | /** |
| 20 | * Hold allowed ads for cache purpose. |
| 21 | * |
| 22 | * @var array |
| 23 | */ |
| 24 | private $allowed_ads = null; |
| 25 | |
| 26 | /** |
| 27 | * Hold allowed groups for cache purpose. |
| 28 | * |
| 29 | * @var array |
| 30 | */ |
| 31 | private $allowed_groups = null; |
| 32 | |
| 33 | /** |
| 34 | * Apply filters on options by type id. |
| 35 | * |
| 36 | * @param array $options Options array. |
| 37 | * |
| 38 | * @return array |
| 39 | */ |
| 40 | protected function apply_filter_on_options( $options ): array { |
| 41 | $defaults = [ |
| 42 | 'show_position' => false, |
| 43 | 'show_lazy_load' => false, |
| 44 | 'uses_the_content' => false, |
| 45 | 'amp' => false, |
| 46 | ]; |
| 47 | $options = wp_parse_args( $options, $defaults ); |
| 48 | |
| 49 | return apply_filters( |
| 50 | 'advanced-ads-placement-' . $this->get_id() . '-options', |
| 51 | $options |
| 52 | ); |
| 53 | } |
| 54 | |
| 55 | /** |
| 56 | * Get allowed item array for dropdown |
| 57 | * |
| 58 | * @param string $add_empty Add empty option. |
| 59 | * |
| 60 | * @return array |
| 61 | */ |
| 62 | public function get_allowed_items( $add_empty = '' ): array { |
| 63 | |
| 64 | $options = []; |
| 65 | |
| 66 | if ( ! empty( $add_empty ) ) { |
| 67 | $options[] = [ |
| 68 | 'label' => $add_empty, |
| 69 | 'value' => 0, |
| 70 | ]; |
| 71 | } |
| 72 | |
| 73 | $options['ads'] = [ |
| 74 | 'label' => __( 'Ads', 'advanced-ads' ), |
| 75 | 'items' => $this->get_allowed_ads(), |
| 76 | ]; |
| 77 | |
| 78 | $options['groups'] = [ |
| 79 | 'label' => __( 'Ad Groups', 'advanced-ads' ), |
| 80 | 'items' => $this->get_allowed_groups(), |
| 81 | ]; |
| 82 | |
| 83 | return $options; |
| 84 | } |
| 85 | |
| 86 | /** |
| 87 | * Get all allowed ads for this placement type. |
| 88 | * |
| 89 | * @return array |
| 90 | */ |
| 91 | public function get_allowed_ads(): array { |
| 92 | if ( null !== $this->allowed_ads ) { |
| 93 | return $this->allowed_ads; |
| 94 | } |
| 95 | |
| 96 | $this->allowed_ads = []; |
| 97 | foreach ( wp_advads_get_ad_summaries() as $ad_id => $summary ) { |
| 98 | if ( ! $this->is_ad_type_allowed( $summary['type'] ) ) { |
| 99 | continue; |
| 100 | } |
| 101 | |
| 102 | $this->allowed_ads[ 'ad_' . $ad_id ] = $summary['title'] . ( 'draft' === $summary['status'] ? ' (' . __( 'draft', 'advanced-ads' ) . ')' : '' ); |
| 103 | } |
| 104 | |
| 105 | return $this->allowed_ads; |
| 106 | } |
| 107 | |
| 108 | /** |
| 109 | * Get all allowed groups for this placement type. |
| 110 | * |
| 111 | * @return array |
| 112 | */ |
| 113 | public function get_allowed_groups(): array { |
| 114 | if ( null !== $this->allowed_groups ) { |
| 115 | return $this->allowed_groups; |
| 116 | } |
| 117 | |
| 118 | $this->allowed_groups = []; |
| 119 | |
| 120 | $group_summaries = wp_advads_get_group_summaries(); |
| 121 | |
| 122 | foreach ( $group_summaries as $group_id => $summary ) { |
| 123 | if ( ! $this->is_group_type_allowed( $summary['type'] ) ) { |
| 124 | continue; |
| 125 | } |
| 126 | |
| 127 | foreach ( wp_advads_get_ads_by_group_id( $group_id, 'summaries' ) as $ad_id => $ad_summary ) { |
| 128 | if ( $this->is_ad_type_allowed( $ad_summary['type'] ) ) { |
| 129 | $this->allowed_groups[ 'group_' . $group_id ] = $summary['title']; |
| 130 | break; |
| 131 | } |
| 132 | } |
| 133 | } |
| 134 | |
| 135 | return $this->allowed_groups; |
| 136 | } |
| 137 | |
| 138 | /** |
| 139 | * Check if the provided ad type is allowed |
| 140 | * |
| 141 | * @param string $type Ad type. |
| 142 | * |
| 143 | * @return bool |
| 144 | */ |
| 145 | public function is_ad_type_allowed( $type ): bool { |
| 146 | return $this->is_entity_allowed( $type, 'ad' ); |
| 147 | } |
| 148 | |
| 149 | /** |
| 150 | * Check if the provided group type is allowed. |
| 151 | * |
| 152 | * @param string $type Group type. |
| 153 | * |
| 154 | * @return bool |
| 155 | */ |
| 156 | public function is_group_type_allowed( $type ): bool { |
| 157 | return $this->is_entity_allowed( $type, 'group' ); |
| 158 | } |
| 159 | |
| 160 | /** |
| 161 | * Abstraction of whether entity is allowed. |
| 162 | * |
| 163 | * @param string $type Type to check. |
| 164 | * @param string $entity Entity type i.e. `ad` or `group`. |
| 165 | * |
| 166 | * @return bool |
| 167 | */ |
| 168 | public function is_entity_allowed( $type, $entity ) { |
| 169 | $options = $this->get_options(); |
| 170 | $allowed = $options[ 'allowed_' . $entity . '_types' ] ?? true; |
| 171 | |
| 172 | return true === $allowed ? true : in_array( $type, $allowed, true ); |
| 173 | } |
| 174 | } |
| 175 |