Advanced_Ads_Modal.php
3 years ago
EDD_SL_Plugin_Updater.php
4 years ago
ad-ajax.php
3 years ago
ad-debug.php
3 years ago
ad-expiration.php
3 years ago
ad-health-notices.php
3 years ago
ad-model.php
3 years ago
ad-select.php
3 years ago
ad.php
3 years ago
ad_ajax_callbacks.php
3 years ago
ad_group.php
3 years ago
ad_placements.php
3 years ago
ad_type_abstract.php
3 years ago
ad_type_content.php
3 years ago
ad_type_dummy.php
3 years ago
ad_type_group.php
3 years ago
ad_type_image.php
3 years ago
ad_type_plain.php
3 years ago
checks.php
3 years ago
compatibility.php
3 years ago
display-conditions.php
3 years ago
filesystem.php
3 years ago
frontend-notices.php
3 years ago
frontend_checks.php
3 years ago
in-content-injector.php
3 years ago
inline-css.php
3 years ago
plugin.php
3 years ago
upgrades.php
6 years ago
utils.php
3 years ago
visitor-conditions.php
3 years ago
widget.php
3 years ago
ad_type_abstract.php
161 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Advanced Ads Abstract Ad Type |
| 4 | * |
| 5 | * @package Advanced_Ads |
| 6 | * @author Thomas Maier <support@wpadvancedads.com> |
| 7 | * @license GPL-2.0+ |
| 8 | * @link https://wpadvancedads.com |
| 9 | * @copyright 2014 Thomas Maier, Advanced Ads GmbH |
| 10 | * |
| 11 | * Class containing information that are defaults for all the other ad types |
| 12 | * |
| 13 | * see ad_type_content.php for an example on ad type |
| 14 | * |
| 15 | */ |
| 16 | class Advanced_Ads_Ad_Type_Abstract { |
| 17 | |
| 18 | /** |
| 19 | * ID - internal type of the ad type |
| 20 | * |
| 21 | * must be static so set your own ad type ID here |
| 22 | * use slug like format, only lower case, underscores and hyphens |
| 23 | * |
| 24 | * @since 1.0.0 |
| 25 | */ |
| 26 | public $ID = ''; |
| 27 | |
| 28 | /** |
| 29 | * Public title |
| 30 | * |
| 31 | * will be set within __construct so one can localize it |
| 32 | * |
| 33 | * @since 1.0.0 |
| 34 | */ |
| 35 | public $title = ''; |
| 36 | |
| 37 | /** |
| 38 | * Description of the ad type |
| 39 | * |
| 40 | * will be set within __construct so one can localize it |
| 41 | * |
| 42 | * @since 1.0.0 |
| 43 | */ |
| 44 | public $description = ''; |
| 45 | |
| 46 | /** |
| 47 | * Parameters of the ad |
| 48 | * |
| 49 | * defaults are set in construct |
| 50 | */ |
| 51 | public $parameters = []; |
| 52 | |
| 53 | /** |
| 54 | * Output for the ad parameters metabox |
| 55 | * |
| 56 | * @param Advanced_Ads_Ad $ad ad object. |
| 57 | */ |
| 58 | public function render_parameters( Advanced_Ads_Ad $ad ) { |
| 59 | /** |
| 60 | * This will be loaded by default or using ajax when changing the ad type radio buttons |
| 61 | * echo the output right away here |
| 62 | * name parameters must be in the "advanced_ads" array |
| 63 | */ |
| 64 | } |
| 65 | |
| 66 | /** |
| 67 | * Render icon on the ad overview list. |
| 68 | * |
| 69 | * @param Advanced_Ads_Ad $ad ad object. |
| 70 | * |
| 71 | * @return void |
| 72 | */ |
| 73 | public function render_icon( Advanced_Ads_Ad $ad ) { |
| 74 | $icon_path = sprintf( 'admin/assets/img/ad-types/%s.svg', esc_attr( $ad->type ) ); |
| 75 | if ( ! file_exists( ADVADS_BASE_PATH . $icon_path ) ) { |
| 76 | $icon_path = 'admin/assets/img/ad-types/empty.svg'; |
| 77 | } |
| 78 | printf( '<img src="%s" width="50" height="50"/>', esc_url( ADVADS_BASE_URL . $icon_path ) ); |
| 79 | } |
| 80 | |
| 81 | /** |
| 82 | * Render preview on the ad overview list |
| 83 | * |
| 84 | * @param Advanced_Ads_Ad $ad ad object. |
| 85 | */ |
| 86 | public function render_preview( Advanced_Ads_Ad $ad ) {} |
| 87 | |
| 88 | /** |
| 89 | * Render additional information in the ad type tooltip on the ad overview page |
| 90 | * |
| 91 | * @param Advanced_Ads_Ad $ad ad object. |
| 92 | */ |
| 93 | public function render_ad_type_tooltip( Advanced_Ads_Ad $ad ) {} |
| 94 | |
| 95 | /** |
| 96 | * Sanitize ad options on save |
| 97 | * |
| 98 | * @param array $options all ad options. |
| 99 | * @return array sanitized ad options. |
| 100 | * @since 1.0.0 |
| 101 | */ |
| 102 | public function sanitize_options( $options = [] ) { |
| 103 | return $options; |
| 104 | } |
| 105 | |
| 106 | /** |
| 107 | * Sanitize content field on save |
| 108 | * |
| 109 | * @param str $content ad content |
| 110 | * @return str $content sanitized ad content |
| 111 | * @since 1.0.0 |
| 112 | */ |
| 113 | public function sanitize_content($content = ''){ |
| 114 | return $content = wp_unslash( $content ); |
| 115 | } |
| 116 | |
| 117 | /** |
| 118 | * Load content field for the ad |
| 119 | * |
| 120 | * @param obj $post WP post object |
| 121 | * @return str $content ad content |
| 122 | * @since 1.0.0 |
| 123 | */ |
| 124 | public function load_content($post){ |
| 125 | return $post->post_content; |
| 126 | } |
| 127 | |
| 128 | /** |
| 129 | * Prepare the ads frontend output |
| 130 | * |
| 131 | * @param Advanced_Ads_Ad $ad The current ad object. |
| 132 | * |
| 133 | * @return string $content ad content prepared for frontend output |
| 134 | * @since 1.0.0 |
| 135 | */ |
| 136 | public function prepare_output( $ad ) { |
| 137 | return $ad->content; |
| 138 | } |
| 139 | |
| 140 | /** |
| 141 | * Process shortcodes. |
| 142 | * |
| 143 | * @param string $output Ad content. |
| 144 | * @param Advanced_Ads_Ad $ad The current ad object. |
| 145 | * |
| 146 | * @return string |
| 147 | */ |
| 148 | protected function do_shortcode( $output, Advanced_Ads_Ad $ad ) { |
| 149 | $ad_options = $ad->options(); |
| 150 | |
| 151 | if ( ! isset( $ad_options['output']['has_shortcode'] ) || $ad_options['output']['has_shortcode'] ) { |
| 152 | // Store arguments so that shortcode hooks can access it. |
| 153 | $ad_args = $ad->args; |
| 154 | $ad_args['shortcode_ad_id'] = $ad->id; |
| 155 | $output = preg_replace( '/\[(the_ad_group|the_ad_placement|the_ad)/', '[$1 ad_args="' . urlencode( json_encode( $ad_args ) ) . '"', $output ); |
| 156 | } |
| 157 | |
| 158 | return do_shortcode( $output ); |
| 159 | } |
| 160 | } |
| 161 |