ad-positioning.php
216 lines
| 1 | <?php // phpcs:ignoreFile |
| 2 | |
| 3 | use AdvancedAds\Abstracts\Ad; |
| 4 | |
| 5 | /** |
| 6 | * Class handling the ad positioning and migrating values from previous solutions. |
| 7 | */ |
| 8 | class Advanced_Ads_Ad_Positioning { |
| 9 | /** |
| 10 | * The instance of the current ad. |
| 11 | * |
| 12 | * @var Ad |
| 13 | */ |
| 14 | private $ad; |
| 15 | |
| 16 | /** |
| 17 | * The structure of these output options. |
| 18 | * |
| 19 | * @var array |
| 20 | */ |
| 21 | private $positioning = [ |
| 22 | 'position' => 'none', |
| 23 | 'clearfix' => false, |
| 24 | 'margin' => [ |
| 25 | 'top' => 0, |
| 26 | 'left' => 0, |
| 27 | 'bottom' => 0, |
| 28 | 'right' => 0, |
| 29 | ], |
| 30 | ]; |
| 31 | |
| 32 | /** |
| 33 | * Class constructor. |
| 34 | * |
| 35 | * @param Ad $ad The current ad object. |
| 36 | */ |
| 37 | public function __construct( Ad $ad ) { |
| 38 | $this->ad = $ad; |
| 39 | $this->migrate_values(); |
| 40 | $this->filter_values(); |
| 41 | } |
| 42 | |
| 43 | /** |
| 44 | * Migrate option from a previous solution where floating was an additional setting. |
| 45 | * |
| 46 | * @return void |
| 47 | */ |
| 48 | private function migrate_values() { |
| 49 | $options = $this->get_options(); |
| 50 | |
| 51 | $this->positioning['margin'] = array_merge( |
| 52 | $this->positioning['margin'], |
| 53 | array_map( function($value) { return (int)$value; }, $options['margin'] ) |
| 54 | ); |
| 55 | |
| 56 | $this->positioning['position'] = $options['position']; |
| 57 | // instead of having an empty value, set an explicit default. |
| 58 | if ( empty( $this->positioning['position'] ) ) { |
| 59 | $this->positioning['position'] = 'none'; |
| 60 | $this->positioning['clearfix'] = false; |
| 61 | } |
| 62 | |
| 63 | // left, center, right are the old values, if it's none of these we've already migrated. |
| 64 | if ( ! in_array( $this->positioning['position'], [ 'left', 'center', 'right' ], true ) ) { |
| 65 | // ensure we get an array with min two elements. |
| 66 | $position = explode( '_', $this->positioning['position'] . '_' ); |
| 67 | |
| 68 | // explicitly set clearfix option. |
| 69 | $this->positioning['clearfix'] = $position[0] !== 'center' && $position[1] === 'nofloat'; |
| 70 | |
| 71 | return; |
| 72 | } |
| 73 | |
| 74 | if ( $this->positioning['position'] === 'center' ) { |
| 75 | $this->positioning['position'] = 'center_nofloat'; |
| 76 | |
| 77 | return; |
| 78 | } |
| 79 | |
| 80 | $this->positioning['clearfix'] = ! empty( $options['clearfix'] ); |
| 81 | $this->positioning['position'] .= $this->positioning['clearfix'] ? '_nofloat' : '_float'; |
| 82 | } |
| 83 | |
| 84 | /** |
| 85 | * Filter the option value for Ad. |
| 86 | * This ensures we don't have to update the whole positioning process but can change only the wp-admin side of things. |
| 87 | * |
| 88 | * @return void |
| 89 | */ |
| 90 | private function filter_values() { |
| 91 | foreach ( $this->positioning as $key => $value ) { |
| 92 | add_filter( "advanced-ads-ad-option-output.{$key}", function() use ( $value ) { |
| 93 | return $value; |
| 94 | } ); |
| 95 | |
| 96 | if ( is_array( $value ) ) { |
| 97 | foreach ( $value as $sub_key => $sub_value ) { |
| 98 | add_filter( "advanced-ads-ad-option-output.{$sub_key}", function() use ( $sub_value ) { |
| 99 | return $sub_value; |
| 100 | } ); |
| 101 | } |
| 102 | } |
| 103 | } |
| 104 | } |
| 105 | |
| 106 | /** |
| 107 | * Set up the positioning options with title, description and icon. |
| 108 | * |
| 109 | * @return array |
| 110 | */ |
| 111 | private function setup_positioning_options() { |
| 112 | return [ |
| 113 | 'default' => [ |
| 114 | 'title' => __( "Theme’s Default", 'advanced-ads' ), |
| 115 | 'description' => __( 'The ad will behave as predefined by the theme.', 'advanced-ads' ), |
| 116 | 'options' => [ |
| 117 | 'none' => [], |
| 118 | ], |
| 119 | ], |
| 120 | 'float' => [ |
| 121 | 'title' => _x( 'Float', 'Layout options "Text Flow" heading', 'advanced-ads' ), |
| 122 | 'description' => __( 'Text will wrap around the ad and its margin.', 'advanced-ads' ), |
| 123 | 'options' => [ |
| 124 | 'left_float' => [], |
| 125 | 'right_float' => [], |
| 126 | ], |
| 127 | ], |
| 128 | 'block' => [ |
| 129 | 'title' => _x( 'Block', 'Layout options "Text Flow" heading', 'advanced-ads' ), |
| 130 | 'description' => __( 'Text will continue after the ad and its margin.', 'advanced-ads' ), |
| 131 | 'options' => [ |
| 132 | 'left_nofloat' => [ |
| 133 | 'img' => 'block-lr', |
| 134 | ], |
| 135 | 'center_nofloat' => [ |
| 136 | 'img' => 'block-cntr', |
| 137 | ], |
| 138 | 'right_nofloat' => [ |
| 139 | 'img' => 'block-lr', |
| 140 | ], |
| 141 | ], |
| 142 | ], |
| 143 | ]; |
| 144 | } |
| 145 | |
| 146 | /** |
| 147 | * Concatenate the templates and prepare inline styles and scripts. |
| 148 | * |
| 149 | * @return string |
| 150 | */ |
| 151 | public function return_admin_view() { |
| 152 | return $this->positioning_admin_view() . $this->spacing_admin_view(); |
| 153 | } |
| 154 | |
| 155 | /** |
| 156 | * Include the positioning view. |
| 157 | * |
| 158 | * @return string |
| 159 | */ |
| 160 | private function positioning_admin_view() { |
| 161 | $positioning = $this->positioning['position']; |
| 162 | $positioning_options = $this->setup_positioning_options(); |
| 163 | |
| 164 | ob_start(); |
| 165 | include_once __DIR__ . '/../views/ad-positioning.php'; |
| 166 | |
| 167 | return ob_get_clean(); |
| 168 | } |
| 169 | |
| 170 | /** |
| 171 | * Include the spacing/margin view. |
| 172 | * |
| 173 | * @return string |
| 174 | */ |
| 175 | private function spacing_admin_view() { |
| 176 | $is_centered = explode( '_', $this->positioning['position'] )[0] === 'center'; |
| 177 | $spacings = [ |
| 178 | 'top' => [ |
| 179 | 'label' => _x( 'Top', 'Ad positioning spacing label', 'advanced-ads' ), |
| 180 | ], |
| 181 | 'right' => [ |
| 182 | 'label' => _x( 'Right', 'Ad positioning spacing label', 'advanced-ads' ), |
| 183 | ], |
| 184 | 'bottom' => [ |
| 185 | 'label' => _x( 'Bottom', 'Ad positioning spacing label', 'advanced-ads' ), |
| 186 | ], |
| 187 | 'left' => [ |
| 188 | 'label' => _x( 'Left', 'Ad positioning spacing label', 'advanced-ads' ), |
| 189 | ], |
| 190 | ]; |
| 191 | foreach ( $spacings as $direction => $item ) { |
| 192 | $spacings[ $direction ]['value'] = (int) $this->positioning['margin'][ $direction ]; |
| 193 | } |
| 194 | |
| 195 | ob_start(); |
| 196 | include_once __DIR__ . '/../views/ad-spacing.php'; |
| 197 | |
| 198 | return ob_get_clean(); |
| 199 | } |
| 200 | |
| 201 | /** |
| 202 | * Get a well-formed array to work with. |
| 203 | * |
| 204 | * @return array |
| 205 | */ |
| 206 | private function get_options() { |
| 207 | $options = [ |
| 208 | 'position' => $this->ad->get_position(), |
| 209 | 'clearfix' => $this->ad->get_clearfix(), |
| 210 | 'margin' => $this->ad->get_margin(), |
| 211 | ]; |
| 212 | |
| 213 | return wp_parse_args( $options, $this->positioning ); |
| 214 | } |
| 215 | } |
| 216 |