- Never
- Never collapse ad slots.
- Collapse only
- Collapse before any ad is loaded. Useful if ad slots will get filled most of the time.
- Expand only
- Collapse all divs on the page before any ads are fetched and expand if an ad is loaded into the ad slot. Useful if ad slots will stay empty most of the time.
',
- '#suffix' => '
',
- '#theme' => 'dfp_target_settings',
- '#element_validate' => array('dfp_targeting_form_validate'),
- );
-
- // Add existing targets to the form unless they are empty.
- foreach ($existing_targeting as $key => $data) {
- _dfp_target_form($targeting_form, $key, $data);
- }
- // Add one blank set of target fields.
- _dfp_target_form($targeting_form, count($existing_targeting));
-
- $targeting_form['targeting']['dfp_more_targets'] = array(
- '#type' => 'submit',
- '#value' => t('Add another target'),
- '#submit' => array('dfp_more_targets_submit'),
- '#limit_validation_errors' => array(),
- '#ajax' => array(
- 'callback' => 'dfp_more_targets_js',
- 'wrapper' => 'dfp-targeting-wrapper',
- 'effect' => 'fade',
- 'file' => 'plugins/export_ui/dfp_ctools_export_ui.inc',
- ),
- );
- $targeting_form['tokens'] = array(
- '#theme' => 'token_tree',
- '#token_types' => array('dfp_tag', 'node', 'term', 'user'),
- '#global_types' => TRUE,
- '#click_insert' => TRUE,
- '#dialog' => TRUE,
- );
-}
-
-/**
- * Helper form builder for an individual target.
- */
-function _dfp_target_form(&$form, $key, $data = array()) {
- $form['targeting'][$key] = array(
- '#prefix' => '',
- '#suffix' => '
',
- '#element_validate' => array('dfp_target_form_validate'),
- );
- $form['targeting'][$key]['target'] = array(
- '#type' => 'textfield',
- '#title_display' => 'invisible',
- '#title' => t('Target Name'),
- '#size' => 10,
- '#default_value' => isset($data['target']) ? $data['target'] : '',
- '#parents' => array('targeting', $key, 'target'),
- '#attributes' => array('class' => array('field-target-target')),
- );
- $form['targeting'][$key]['value'] = array(
- '#type' => 'textfield',
- '#title_display' => 'invisible',
- '#title' => t('Target Value'),
- '#size' => 20,
- '#default_value' => isset($data['value']) ? $data['value'] : '',
- '#parents' => array('targeting', $key, 'value'),
- '#attributes' => array('class' => array('field-target-value')),
- );
- if (empty($data)) {
- $form['targeting'][$key]['target']['#description'] = t('Example: color');
- $form['targeting'][$key]['value']['#description'] = t('Example: red,white,blue');
- }
-}
-
-/**
- * Returns the current targets. The default value will be used unless an "input"
- * exists in the form_state variable, in which case that will be used.
- */
-function _dfp_targeting_get_existing($form_state, $default = array()) {
- $targeting = array();
- if (isset($form_state['input']['targeting'])) {
- $targeting = $form_state['input']['targeting'];
- }
- elseif (!empty($default)) {
- $targeting = $default;
- }
-
- return $targeting;
-}
-
-/**
- * Helper function to remove empty target values from a given array.
- */
-function _dfp_targeting_remove_empty(&$target) {
- foreach ($target as $key => $val) {
- if (empty($val['target']) && empty($val['value'])) {
- unset($target[$key]);
- }
- }
- // Reset the target array's indexes to prevents strange behavior when users
- // leave a blank row in the targeting form followed by a filled-in row. In
- // this case clicking "Add another target" will not work as expected.
- $target = array_values($target);
-}
-
-/**
- * Validation function used by an individual breakpoint in the breakpoints form.
- */
-function dfp_breakpoint_form_validate($element, &$form_state) {
- if (empty($element['browser_size']['#value']) && !empty($element['ad_sizes']['#value'])) {
- form_error($element['browser_size'], t('The browser size cannot be empty if ad size(s) exists.'));
- }
- elseif (!empty($element['browser_size']['#value']) && empty($element['ad_sizes']['#value'])) {
- form_error($element['ad_sizes'], t('The ad size(s) cannot be empty if a browser size exists.'));
- }
- if (!empty($element['browser_size']['#value']) && !empty($element['ad_sizes']['#value'])) {
- if (preg_match('/[^x|0-9]/', $element['browser_size']['#value'])) {
- form_error($element['browser_size'], t('The browser size can only contain numbers and the character x.'));
- }
- elseif (preg_match('/[^x|,|0-9]/', $element['ad_sizes']['#value'])) {
- form_error($element['ad_sizes'], t('The ad size(s) can only contain numbers, the character x and commas.'));
- }
- }
-}
-
-/**
- * Validation function used by the breakpoints form.
- */
-function dfp_breakpoints_form_validate(&$element, &$form_state) {
- if ($form_state['triggering_element']['#value'] != t('Add another breakpoint')) {
- dfp_breakpoints_trim($form_state['values']);
- }
-}
-
-/**
- * Helper function that takes a form_state['values'] and removes
- * empty breakpoints.
- */
-function dfp_breakpoints_trim(&$values, $parent = 'breakpoints') {
- foreach ($values as $key => &$val) {
- if ($key === $parent) {
- // We found the browser_size values.
- foreach ($val as $k => $v) {
- if (empty($val[$k]['browser_size']) && empty($val[$k]['ad_sizes'])) {
- unset($val[$k]);
- }
- }
- // Reset the array indexes to prevent wierd behavior caused by a
- // breakpoint being removed in the middle of the array.
- $val = array_values($val);
- break;
- }
- elseif (is_array($val)) {
- dfp_breakpoints_trim($val, $parent);
- }
- }
-}
-
-/**
- * Submit handler to add more breakpoints to an ad tag.
- */
-function dfp_more_breakpoints_submit($form, &$form_state) {
- $form_state['breakpoints'] = $form_state['input']['breakpoints'];
- $form_state['rebuild'] = TRUE;
-}
-
-/**
- * Ajax callback for adding breakpoints to the breakpoint form.
- */
-function dfp_more_breakpoints_js($form, $form_state) {
- return $form['breakpoint_settings']['breakpoints'];
-}
-
-/**
- * Helper form builder for the breakpoints form.
- */
-function _dfp_breakpoints_form(&$breakpoints_form, $existing_breakpoints = array()) {
- // Display settings.
- $breakpoints_form['breakpoints'] = array(
- '#type' => 'markup',
- '#tree' => FALSE,
- '#prefix' => '',
- '#suffix' => '
',
- '#theme' => 'dfp_breakpoint_settings',
- '#element_validate' => array('dfp_breakpoints_form_validate'),
- );
-
- // Add existing breakpoints to the form unless they are empty.
- foreach ($existing_breakpoints as $key => $data) {
- _dfp_breakpoint_form($breakpoints_form, $key, $data);
- }
- // Add one blank set of breakpoint fields.
- _dfp_breakpoint_form($breakpoints_form, count($existing_breakpoints));
-
- $breakpoints_form['breakpoints']['dfp_more_breakpoints'] = array(
- '#type' => 'submit',
- '#value' => t('Add another breakpoint'),
- '#submit' => array('dfp_more_breakpoints_submit'),
- '#limit_validation_errors' => array(),
- '#ajax' => array(
- 'callback' => 'dfp_more_breakpoints_js',
- 'wrapper' => 'dfp-breakpoints-wrapper',
- 'effect' => 'fade',
- 'file' => 'plugins/export_ui/dfp_ctools_export_ui.inc',
- ),
- );
-}
-
-/**
- * Helper form builder for an individual breakpoint.
- */
-function _dfp_breakpoint_form(&$form, $key, $data = array()) {
- $form['breakpoints'][$key] = array(
- '#prefix' => '',
- '#suffix' => '
',
- '#element_validate' => array('dfp_breakpoint_form_validate'),
- );
- $form['breakpoints'][$key]['browser_size'] = array(
- '#type' => 'textfield',
- '#title_display' => 'invisible',
- '#title' => t('Minimum Browser Size'),
- '#size' => 10,
- '#default_value' => isset($data['browser_size']) ? $data['browser_size'] : '',
- '#parents' => array('breakpoints', $key, 'browser_size'),
- '#attributes' => array('class' => array('field-breakpoint-browser-size')),
- );
- $form['breakpoints'][$key]['ad_sizes'] = array(
- '#type' => 'textfield',
- '#title_display' => 'invisible',
- '#title' => t('Ad Sizes'),
- '#size' => 20,
- '#default_value' => isset($data['ad_sizes']) ? $data['ad_sizes'] : '',
- '#parents' => array('breakpoints', $key, 'ad_sizes'),
- '#attributes' => array('class' => array('field-breakpoint-ad-sizes')),
- );
- $form['breakpoints'][$key]['delete_breakpoint'] = array(
- '#type' => 'textfield',
- '#title_display' => 'invisible',
- '#title' => t('Ad Sizes'),
- '#size' => 20,
- '#default_value' => isset($data['ad_sizes']) ? $data['ad_sizes'] : '',
- '#parents' => array('breakpoints', $key, 'ad_sizes'),
- '#attributes' => array('class' => array('field-breakpoint-ad-sizes')),
- );
- if (empty($data)) {
- $form['breakpoints'][$key]['browser_size']['#description'] = t('Example: 1024x768');
- $form['breakpoints'][$key]['ad_sizes']['#description'] = t('Example: 300x600,300x250');
- }
-}
-
-/**
- * Returns the current breakpoints. The default value will be used unless an
- * "input" exists in the form_state variable, in which case that will be used.
- */
-function _dfp_breakpoints_get_existing($form_state, $default = array()) {
- $breakpoints = array();
- if (isset($form_state['input']['breakpoints'])) {
- $breakpoints = $form_state['input']['breakpoints'];
- }
- elseif (!empty($default)) {
- $breakpoints = $default;
- }
-
- return $breakpoints;
-}
-
-/**
- * Theme function for the "breakpoint" form.
- */
-function theme_dfp_breakpoint_settings($variables) {
- $form = $variables['form'];
-
- $more_button = drupal_render($form['dfp_more_breakpoints']);
- unset($form['dfp_more_breakpoints']);
-
- $headers = array(t('Browser Size'), t('Ad Size(s)'));
- $rows = array();
- foreach (element_children($form) as $key) {
- $rows[] = array(drupal_render($form[$key]['browser_size']), drupal_render($form[$key]['ad_sizes']));
- }
- $rows[] = array(array('data' => 'These breakpoints are set to implement DFP responsive mappings. See this support article for more information.', 'colspan' => 2));
- return theme('table', array('header' => $headers, 'rows' => $rows)) . $more_button;
-}
-
-
-/**
- * Helper function returns the a value from a givne multidimensional array given
- * a specific key. If the key exists in more than one place, the first occurance
- * is used.
- */
-function _dfp_get_form_item($needle_key, $array) {
- $children = element_children($array);
-
- foreach ($children as $child) {
- if ($child == $needle_key) {
- return $array[$child];
- }
- elseif (is_array($array[$child])) {
- $result = _dfp_get_form_item($needle_key, $array[$child]);
- if ($result) {
- return $result;
- }
- }
- }
-
- return FALSE;
-}
-
-/**
- * Theme function for the "target" form.
- */
-function theme_dfp_target_settings($variables) {
- $form = $variables['form'];
-
- $more_button = drupal_render($form['dfp_more_targets']);
- unset($form['dfp_more_targets']);
-
- $headers = array(t('Target'), t('Value(s)'));
- $rows = array();
- foreach (element_children($form) as $key) {
- $rows[] = array(drupal_render($form[$key]['target']), drupal_render($form[$key]['value']));
- }
-
- return theme('table', array('header' => $headers, 'rows' => $rows)) . $more_button;
-}
-
-/**
- * Theme function for the "target" form.
- */
-function theme_dfp_adsense_color_settings($variables) {
- $form = $variables['form'];
-
- $caption = t('AdSense Color Settings');
- $header = array(t('Color Setting'), t('Hex color value'), t('Sample'));
- $rows = array();
- foreach (element_children($form) as $key) {
- $rows[] = array(
- $form[$key]['#title'],
- drupal_render($form[$key]),
- "' . t('This module provides you with a general settings form as well as the ability to create a tag (with all its associated data) in the database. You can display your ads as blocks, or add a simple bit of php to your tpl.php file(s) within your theme to indicate where specific tags should be displayed.') . '
'; return $output; @@ -17,1020 +20,40 @@ function dfp_help($path, $arg) { } /** - * Implements hook_permission(). - */ -function dfp_permission() { - return array( - 'administer DFP' => array( - 'title' => t('Administer Doubleclick for Publisher ads'), - 'description' => t('Users can create, edit, and delete Doubleclick for Publishers (dfp) ad tags and configure how and when they should be displayed.'), - ), - ); -} - -/** * Implements hook_theme(). */ -function dfp_theme($existing, $type, $theme, $path) { - $theme_hooks = array( - 'dfp_tag' => array( - 'variables' => array( +function dfp_theme() { + return [ + 'dfp_tag' => [ + 'variables' => [ 'tag' => NULL, - 'slug' => NULL, - ), - 'template' => 'theme/dfp_tag', - ), - 'dfp_short_tag' => array( - 'variables' => array( + ] + ], + 'dfp_short_tag' => [ + 'variables' => [ 'tag' => NULL, - ), - 'template' => 'theme/dfp_short_tag', - ), - 'dfp_target_settings' => array( - 'render element' => 'form', - 'file' => 'dfp.admin.inc', - ), - 'dfp_breakpoint_settings' => array( - 'render element' => 'form', - 'file' => 'dfp.admin.inc', - ), - 'dfp_adsense_color_settings' => array( - 'render element' => 'form', - 'file' => 'dfp.admin.inc', - ), - 'dfp_size_settings' => array( - 'render element' => 'form', - 'file' => 'dfp.admin.inc', - ), - ); - - return $theme_hooks; -} - -/** - * Implements hook_menu(). - */ -function dfp_menu() { - $items = array(); - - $items['admin/structure/dfp_ads/settings'] = array( - 'title' => 'Global DFP Settings', - 'type' => MENU_LOCAL_TASK, - 'description' => "Configure your site-wide DFP settings.", - 'page callback' => 'drupal_get_form', - 'page arguments' => array('dfp_admin_settings'), - 'access arguments' => array('administer DFP'), - 'file' => 'dfp.admin.inc', - 'weight' => 5, - ); - $items['admin/structure/dfp_ads/test_page'] = array( - 'title' => 'DFP Test Page', - 'type' => MENU_LOCAL_TASK, - 'description' => "View all your DFP tags on a single page", - 'page callback' => 'dfp_adtest_page', - 'access arguments' => array('administer DFP'), - 'file' => 'dfp.adtest.inc', - 'weight' => 10, - ); - - return $items; -} - -/** - * Implements hook_menu_alter(). - */ -function dfp_menu_alter(&$items) { - $items['admin/structure/dfp_ads/list/%ctools_export_ui/edit']['context'] = MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE; - $items['admin/structure/dfp_ads/list/%ctools_export_ui/edit']['title'] = t('Edit DFP ad tag'); -} - -/** - * Implements hook_block_info(). - */ -function dfp_block_info() { - $tags = dfp_tag_load_all(); - $blocks = array(); - $hashes = array(); - - foreach ($tags as $tag) { - if ($tag->block) { - // The block table chokes when the delta is more than 32 characters. To - // solve this we create a hash of the machine name when needed. - if (drupal_strlen($tag->machinename) >= 32) { - $delta = md5($tag->machinename); - $hashes[$delta] = $tag->machinename; - } - else { - $delta = $tag->machinename; - } - - $blocks[$delta]['info'] = t('DFP tag: @slotname', array('@slotname' => $tag->slot)); - $blocks[$delta]['cache'] = DRUPAL_CACHE_PER_PAGE; - } - } - - // Only save hashes if they have changed. - $old_hashes = variable_get('dfp_block_hashes', array()); - if ($hashes != $old_hashes) { - variable_set('dfp_block_hashes', $hashes); - } - - return $blocks; -} - -/** - * Implements hook_block_view(). - */ -function dfp_block_view($delta) { - $block = array(); - - // If this is 32, this should be an md5 hash. - if (drupal_strlen($delta) == 32) { - $hashes = variable_get('dfp_block_hashes', array()); - if (!empty($hashes[$delta])) { - $delta = $hashes[$delta]; - } - } - - $tag = dfp_tag_load($delta); - - if (empty($tag->disabled)) { - $block['content'] = dfp_tag($delta); - $block['content']['#contextual_links'] = array( - 'dfp' => array('admin/structure/dfp_ads/list', array($delta, 'edit')) - ); - } - - return $block; -} - -/** - * Implements hook_entity_view(). - */ -function dfp_entity_view($entity, $type, $view_mode, $langcode) { - $dfp_targeting_terms = &drupal_static('dfp_entity_targeting_terms', array()); - - if (variable_get('dfp_enable_ad_categories', 0) && $view_mode == 'full') { - // If this entity is itself a taxonomy term add it to the - // dfp_targetting_terms array. Check it to see if a DFP Ad Category - // has been assigned to it. If so, add that term to the array instead. Note - // that we check all types of entities here because any fieldable entity can - // have a taxonomy term reference field attached to it. - if ($type == 'taxonomy_term') { - $dfp_targeting_terms[] = _dfp_get_ad_category($entity, TRUE); - } - - // Find all taxonomy terms attached to the given entity and add them to the - // dfp_targeting_terms array. Check each term to see if a DFP Ad Category - // has been assigned to it. If so, add that term to the array instead. - foreach (element_children($entity->content) as $key) { - if (isset($entity->content[$key]['#field_type']) && $entity->content[$key]['#field_type'] == 'taxonomy_term_reference') { - $terms = field_view_field($type, $entity, $key); - if (isset($terms['#items']) && is_array($terms['#items'])) { - foreach ($terms['#items'] as $item) { - if (array_key_exists('taxonomy_term', $item)) { - $dfp_targeting_terms[] = _dfp_get_ad_category($item['taxonomy_term'], TRUE); - } - } - } - } - } - - $dfp_targeting_terms = array_unique($dfp_targeting_terms); - } -} - -/** - * Implements hook_ctools_plugin_directory(). - */ -function dfp_ctools_plugin_directory($module, $type) { - // Load the export_ui plugin. - if ($type == 'export_ui' || $type == 'content_types') { - return 'plugins/' . $type; - } -} - -/** - * Implements hook_context_registry(). - */ -function dfp_context_registry() { - return array( - 'reactions' => array( - 'dfp_tags' => array( - 'title' => t('DFP Tags'), - 'plugin' => 'dfp_context_reaction_tags', - ), - 'dfp_outofpage' => array( - 'title' => t('DFP Out of page'), - 'plugin' => 'dfp_context_reaction_outofpage', - ), - 'dfp_settings' => array( - 'title' => t('DFP Variables'), - 'plugin' => 'dfp_context_reaction_settings', - ), - 'dfp_adunit' => array( - 'title' => t('DFP AdUnit'), - 'plugin' => 'dfp_context_reaction_adunit', - ), - 'dfp_adsize' => array( - 'title' => t('DFP Sizes'), - 'plugin' => 'dfp_context_reaction_sizes', - ), - ), - ); -} - -/** - * Implements hook_context_plugins(). - */ -function dfp_context_plugins() { - $plugins = array(); - $plugins['dfp_context_reaction_tags'] = array( - 'handler' => array( - 'path' => drupal_get_path('module', 'dfp') . '/plugins/contexts', - 'file' => 'dfp_context_reaction_tags.inc', - 'class' => 'dfp_context_reaction_tags', - 'parent' => 'context_reaction', - ), - ); - $plugins['dfp_context_reaction_outofpage'] = array( - 'handler' => array( - 'path' => drupal_get_path('module', 'dfp') . '/plugins/contexts', - 'file' => 'dfp_context_reaction_outofpage.inc', - 'class' => 'dfp_context_reaction_outofpage', - 'parent' => 'context_reaction', - ), - ); - $plugins['dfp_context_reaction_settings'] = array( - 'handler' => array( - 'path' => drupal_get_path('module', 'dfp') . '/plugins/contexts', - 'file' => 'dfp_context_reaction_settings.inc', - 'class' => 'dfp_context_reaction_settings', - 'parent' => 'context_reaction', - ), - ); - $plugins['dfp_context_reaction_adunit'] = array( - 'handler' => array( - 'path' => drupal_get_path('module', 'dfp') . '/plugins/contexts', - 'file' => 'dfp_context_reaction_adunit.inc', - 'class' => 'dfp_context_reaction_adunit', - 'parent' => 'context_reaction', - ), - ); - $plugins['dfp_context_reaction_sizes'] = array( - 'handler' => array( - 'path' => drupal_get_path('module', 'dfp') . '/plugins/contexts', - 'file' => 'dfp_context_reaction_sizes.inc', - 'class' => 'dfp_context_reaction_sizes', - 'parent' => 'context_reaction', - ), - ); - return $plugins; -} - -/** - * Implements hook_token_info(). - */ -function dfp_token_info() { - $type = array( - 'name' => t('DFP Ad Tags'), - 'description' => t('Tokens related to a given DFP ad tag.'), - 'needs-data' => 'tag', - ); - - $tag['slot'] = array( - 'name' => t('Slot Name'), - 'description' => t("The name of the ad slot defined by this tag."), - ); - $tag['network_id'] = array( - 'name' => t("Network ID"), - 'description' => t("The unique ID provided by Google."), - ); - $tag['ad_categories'] = array( - 'name' => t("DFP Ad Categories"), - 'description' => t("The DFP Ad Categories or uncategorized taxonomy terms attached to the entities currently being displayed to the user."), - ); - $tag['url_parts'] = array( - 'name' => t("URL Parts (n)"), - 'description' => t('**Deprecated. See this issue for alternitives.'), - ); - - return array( - 'types' => array('dfp_tag' => $type), - 'tokens' => array('dfp_tag' => $tag), - ); -} - -/** - * Implements hook_tokens(). - */ -function dfp_tokens($type, $tokens, array $data = array(), array $options = array()) { - $replacements = array(); - - if ($type == 'dfp_tag') { - foreach ($tokens as $name => $original) { - switch ($name) { - case 'slot': - if (!empty($data['tag'])) { - $replacements[$original] = check_plain($data['tag']->slot); - } - break; - - case 'network_id': - $replacements[$original] = check_plain(variable_get('dfp_network_id', '')); - break; - - case 'ad_categories': - $term_names = &drupal_static('dfp_entity_targeting_terms', array()); - $replacements[$original] = implode(',', $term_names); - break; - } - } - - if ($created_tokens = token_find_with_prefix($tokens, 'url_parts')) { - foreach ($created_tokens as $name => $original) { - $url_parts = explode('/', $_GET['q']); - $replacements[$original] = implode('/', array_slice($url_parts, 0, $name)); - } - } - } - - return $replacements; -} - -/** - * Implements preprocess_html(). - */ -function dfp_preprocess_html($variables) { - // Add the header js here so that enough information has been loaded for - // tokens to work properly. - _dfp_js_global_settings(); -} - - -/** - * Return a render array for the tag specified by machinename. - */ -function dfp_tag($machinename) { - $tag = dfp_tag_load($machinename); - $render_array = array(); - - if (!$tag) { - watchdog('dfp', 'Unknown ad tag %machinename passed to dfp_tag().', array('%machinename' => $machinename), WATCHDOG_WARNING); - } - else { - $tag->slug = dfp_format_slug($tag->slug); - $slug_placement = variable_get('dfp_slug_placement', 0); - - if (!empty($tag)) { - $render_array = array( - 'dfp_wrapper' => array( - '#type' => 'container', - '#attributes' => array( - 'id' => $tag->wrapper_id, - 'class' => array( - 'dfp-tag-wrapper', - ), - ), - 'tag' => array( - '#theme' => $tag->short_tag ? 'dfp_short_tag' : 'dfp_tag', - '#tag' => $tag, - ), - ), - ); - if (!empty($tag->slug) && $slug_placement == 0) { - $render_array['dfp_wrapper']['slug_wrapper'] = array( - '#type' => 'container', - '#attributes' => array( - 'class' => array( - 'slug', - ), - ), - 'slug' => array( - '#markup' => $tag->slug, - ), - '#weight' => -1, - ); - } - } - } - - return $render_array; -} - -/** - * Load function. - * - * @param string $machinename - * - * @return object - * - */ -function dfp_tag_load($machinename) { - ctools_include('export'); - - $tags = &drupal_static(__FUNCTION__, array()); - - if (!isset($tags[$machinename])) { - // Load the tag. - $result = ctools_export_load_object('dfp_tags', 'names', array($machinename)); - if (isset($result[$machinename])) { - $tag = $result[$machinename]; - } - else { - return NULL; - } - - // Store the original tag. This is used by the tag edit form. - $tag->raw = clone $tag; - - // Allow modules to alter the raw tag object. - drupal_alter('dfp_tag_load', $tag); - - // Move the settings out of the settings array. - foreach ($tag->settings as $key => $val) { - $tag->{$key} = $val; - } - - // Configure this tag based on the defined settings. - $tag->wrapper_id = 'dfp-ad-' . $tag->machinename . '-wrapper'; - $tag->placeholder_id = 'dfp-ad-' . $tag->machinename; - - // Allow modules to alter the fully-loaded tag object. - drupal_alter('dfp_tag', $tag); - - // Statically cache the fully loaded tag. - $tags[$machinename] = $tag; - } - else { - // Use the statically cached tag object. - $tag = $tags[$machinename]; - } - - return $tag; -} - -/** - * Load all dfp ad tags. - * - * @param boolean $include_disabled - * - * @return array of tags. - */ -function dfp_tag_load_all($include_disabled = FALSE) { - ctools_include('export'); - - $tags = ctools_export_crud_load_all('dfp_tags'); - foreach ($tags as $key => $tag) { - if (!$include_disabled && isset($tag->disabled) && $tag->disabled) { - unset($tags[$key]); - } - } - - return $tags; -} - -/** - * Save a single tag. - */ -function dfp_tag_save(&$tag) { - $update = (isset($tag->adid) && is_numeric($tag->adid)) ? array('adid') : array(); - return drupal_write_record('dfp_tags', $tag, $update); -} - -/** - * Alter a dfp tag object to integrate with the contexts module. - */ -function dfp_dfp_tag_load_alter(&$tag) { - // Execute context reactions for each plugin. - if (module_exists('context')) { - $contexts = dfp_context_registry(); - foreach ($contexts['reactions'] as $key => $val) { - if ($plugin = context_get_plugin('reaction', $key)) { - $plugin->execute($tag); - } - } - } - - // Handle ad testing. - module_load_include('inc', 'dfp', 'dfp.adtest'); - dfp_adtest_alter_tag($tag); -} - -/** - * Alter the vertical tabs group in which the exportable scheduler form should - * live. - */ -function dfp_exportable_scheduler_form_group_alter(&$group) { - $group = 'settings'; -} - -/** - * Form alter for the ctools_export_ui_edit_item_form. - */ -function dfp_form_ctools_export_ui_edit_item_form_alter(&$form, &$form_state) { - if (arg(2) == 'context') { - // Make sure that dfp.admin.inc is included on the context ui form to avoid - // errors when doing an ajax submit. - form_load_include($form_state, 'inc', 'dfp', 'dfp.admin'); - //array_unshift($form['#submit'], 'dps_targeting_form_submit'); - } -} - -/** - * Format the given array of values to be displayed as part of a javascript. - * - * @param array $variables - * 'values' => A simple array of targeting values. Ex. val1, val2, val3 - * - * @return string - * If $values had one item, then a string in the format ["val1"]. If $values - * has more than one item, then a string in the format ["val1","val2","val3"]. - * - */ -function dfp_format_targeting($targeting, $tag = '') { - foreach ($targeting as $key => &$target) { - $target['target'] = '"' . check_plain($target['target']) . '"'; - $target['value'] = dfp_token_replace(check_plain($target['value']), $tag, array('sanitize' => TRUE, 'clear' => TRUE)); - - // The target value could be blank if tokens are used. If so, removed it. - if (empty($target['value'])) { - unset($targeting[$key]); - continue; - } - - // Allow other modules to alter the target. - drupal_alter('dfp_target', $target); - - // Convert the values into an array and trim the whitespace from each value. - $values = explode(',', $target['value']); - $values = array_map('trim', $values); - - if (count($values) == 1) { - $target['value'] = '"' . $values[0] . '"'; - } - elseif (count($values) > 1) { - $target['value'] = '["' . implode('","', $values) . '"]'; - } - } - - return $targeting; -} - -/** - * Format the the size of an ad tag. - * - * @param array $variables - * 'size' => A string in the format 123x321,987x789. - * - * @return string - * A string in the format [456, 654] or [[123, 321], [987, 789]]. - * - */ -function dfp_format_size($size) { - $formatted_sizes = array(); - - $sizes = explode(',', check_plain($size)); - foreach ($sizes as $size) { - $formatted_size = explode('x', trim($size)); - $formatted_sizes[] = '[' . implode(', ', $formatted_size) . ']'; - } - - return count($formatted_sizes) == 1 ? $formatted_sizes[0] : '[' . implode(', ', $formatted_sizes) . ']'; -} - -/** - * Format the the size of an ad tag. - * - * @param array $variables - * 'slug' => A label for for this particular ad tag. - * - * @return string - * If $slug is none, an empty string will be returned; if $slug is a non-empty - * string then it will be returned unchanged; if $slug is empty, then the - * default slug will be returned. - * - */ -function dfp_format_slug($slug) { - $formatted_slug = t(check_plain(variable_get('dfp_default_slug', ''))); - - if ($slug == '- Never
- Never collapse ad slots.
- Collapse only
- Collapse before any ad is loaded. Useful if ad slots will get filled most of the time.
- Expand only
- Collapse all divs on the page before any ads are fetched and expand if an ad is loaded into the ad slot. Useful if ad slots will stay empty most of the time.
',
+ '#suffix' => '
',
+ '#element_validate' => [[get_class($this), 'breakpointsFormValidate']],
+ ];
+
+ $breakpoints_form['breakpoints']['table'] = [
+ '#type' => 'table',
+ '#header' => [
+ $this->t('Browser Size'),
+ $this->t('Ad Size(s)'),
+ ],
+ ];
+
+ $breakpoints_form['breakpoints']['help'] = [
+ '#type' => 'markup',
+ '#prefix' => '', + '#markup' => $this->t('These breakpoints are set to implement DFP responsive mappings. See this support article for more information.'), + '#suffix' => '
', + ]; + + // Add existing breakpoints to the form unless they are empty. + foreach ($existing_breakpoints as $key => $data) { + $this->addBreakpointForm($breakpoints_form, $key, $data); + } + // Add one blank set of breakpoint fields. + $this->addBreakpointForm($breakpoints_form, count($existing_breakpoints)); + + $breakpoints_form['breakpoints']['dfp_more_breakpoints'] = [ + '#type' => 'submit', + '#value' => $this->t('Add another breakpoint'), + '#submit' => [[get_class($this), 'moreBreakpointsSubmit']], + '#limit_validation_errors' => [], + '#ajax' => [ + 'callback' => [get_class($this), 'moreBreakpointsJs'], + 'wrapper' => 'dfp-breakpoints-wrapper', + 'effect' => 'fade', + ], + ]; + } + + /** + * Helper form builder for an individual breakpoint. + */ + protected function addBreakpointForm(array &$form, $key, array $data = []) { + $form['breakpoints']['table'][$key] = [ + '#prefix' => '',
+ '#suffix' => '
',
+ '#element_validate' => [[get_class($this), 'breakpointFormValidate']],
+ ];
+ $form['breakpoints']['table'][$key]['browser_size'] = [
+ '#type' => 'textfield',
+ '#title_display' => 'invisible',
+ '#title' => $this->t('Minimum Browser Size'),
+ '#size' => 10,
+ '#default_value' => isset($data['browser_size']) ? $data['browser_size'] : '',
+ '#parents' => ['breakpoints', $key, 'browser_size'],
+ '#attributes' => ['class' => ['field-breakpoint-browser-size']],
+ ];
+ $form['breakpoints']['table'][$key]['ad_sizes'] = [
+ '#type' => 'textfield',
+ '#title_display' => 'invisible',
+ '#title' => $this->t('Ad Sizes'),
+ '#size' => 20,
+ '#default_value' => isset($data['ad_sizes']) ? $data['ad_sizes'] : '',
+ '#parents' => ['breakpoints', $key, 'ad_sizes'],
+ '#attributes' => ['class' => ['field-breakpoint-ad-sizes']],
+ ];
+ if (empty($data)) {
+ $form['breakpoints']['table'][$key]['browser_size']['#description'] = $this->t('Example: 1024x768');
+ $form['breakpoints']['table'][$key]['ad_sizes']['#description'] = $this->t('Example: 300x600,300x250');
+ }
+ }
+
+ /**
+ * Returns the current breakpoints.
+ *
+ * @return array
+ * The default value will be used unless an "input" exists in the form_state
+ * variable, in which case that will be used.
+ */
+ protected function getExistingBreakpoints(FormStateInterface $form_state, array $breakpoints = []) {
+ $user_input = $form_state->getUserInput();
+ if (isset($user_input['breakpoints'])) {
+ $breakpoints = $user_input['breakpoints'];
+ }
+ return $breakpoints;
+ }
+
+}
diff --git a/src/Form/Tag.php b/src/Form/Tag.php
new file mode 100644
index 0000000..5993713
--- /dev/null
+++ b/src/Form/Tag.php
@@ -0,0 +1,223 @@
+entity;
+ if ($this->operation == 'add') {
+ $form['#title'] = $this->t('Add DFP tag');
+ }
+ else {
+ $form['#title'] = $this->t('Edit %label DFP tag', ['%label' => $tag->label()]);
+ }
+
+ // Tag settings.
+ $form['tag_settings'] = [
+ '#type' => 'details',
+ '#title' => $this->t('Tag Settings'),
+ '#open' => TRUE,
+ ];
+
+ $form['tag_settings']['slot'] = [
+ '#type' => 'textfield',
+ '#title' => $this->t('Ad Slot Name'),
+ '#required' => TRUE,
+ '#maxlength' => 64,
+ '#default_value' => $tag->slot(),
+ '#description' => $this->t('Example: leaderboard or box1'),
+ ];
+
+ $form['tag_settings']['id'] = [
+ '#type' => 'machine_name',
+ '#maxlength' => 128,
+ '#default_value' => $tag->id(),
+ '#description' => $this->t('A unique machine-readable name for this DFP tag. Only use letters, numbers and underscores. Example: top_banner'),
+ '#machine_name' => [
+ 'exists' => ['Drupal\dfp\Entity\Tag', 'load'],
+ 'source' => ['tag_settings', 'slot'],
+ ],
+ ];
+
+ $form['tag_settings']['size'] = [
+ '#type' => 'textfield',
+ '#title' => $this->t('Size(s)'),
+ '#description' => $this->t('Example: 300x600,300x250. For Out Of Page slots, use 0x0'),
+ '#required' => TRUE,
+ '#maxlength' => 64,
+ '#default_value' => $tag->size(),
+ ];
+ $form['tag_settings']['adunit'] = [
+ '#type' => 'textfield',
+ '#title' => $this->t('Ad Unit Pattern'),
+ '#required' => FALSE,
+ '#maxlength' => 255,
+ '#default_value' => $tag->adunit(),
+ '#description' => $this->t('Use the tokens below to define how the ad unit should display. The network id will be included automatically. Example: [dfp_tag:url_parts:4]/[dfp_tag:slot]. Leave this field empty to use the default ad unit adunit as defined in Global DFP Settings.', [':url' => Url::fromRoute('dfp.admin_settings')->toString()]),
+ ];
+ // @todo Add token browser.
+
+ // Global Display settings.
+ $form['tag_display_options'] = [
+ '#type' => 'details',
+ '#title' => $this->t('Display Options'),
+ '#open' => TRUE,
+ ];
+ $form['tag_display_options']['slug'] = [
+ '#type' => 'textfield',
+ '#title' => $this->t('Slug'),
+ '#description' => $this->t('Override the default slug for this ad tag. Use @none for no slug. Leave this field empty to use the default slug. Example: Advertisement', ['@none' => '',
+ '#suffix' => '
',
+ '#element_validate' => [[get_class($this), 'targetingFormValidate']],
+ ];
+
+ $targeting_form['targeting']['table'] = [
+ '#type' => 'table',
+ '#header' => [
+ $this->t('Target'),
+ $this->t('Value(s)'),
+ ],
+ ];
+
+ // Add existing targets to the form unless they are empty.
+ foreach ($existing_targeting as $key => $data) {
+ $this->addTargetForm($targeting_form, $key, $data);
+ }
+ // Add one blank set of target fields.
+ $this->addTargetForm($targeting_form, count($existing_targeting));
+
+ $targeting_form['targeting']['dfp_more_targets'] = [
+ '#type' => 'submit',
+ '#value' => t('Add another target'),
+ '#submit' => [get_class($this), 'targetingFormMoreTargetsSubmit'],
+ '#limit_validation_errors' => [],
+ '#ajax' => [
+ 'callback' => [get_class($this), 'moreTargetsJs'],
+ 'wrapper' => 'dfp-targeting-wrapper',
+ 'effect' => 'fade',
+ ],
+ ];
+ // @todo Add token browser.
+ }
+
+ /**
+ * Validation function used by the targeting form.
+ */
+ public static function targetingFormValidate(array &$element, FormStateInterface &$form_state) {
+ if ($form_state->getTriggeringElement()['#name'] != 'dfp_more_targets') {
+ self::trimTargetingValues($form_state->getValues());
+ }
+ }
+
+ /**
+ * Submit handler to add more targets to an ad tag.
+ */
+ public function targetingFormMoreTargetsSubmit(array $form, FormStateInterface &$form_state) {
+ $form_state->set('targeting', $form_state->getUserInput()['targeting']);
+ $form_state->setRebuild();
+ }
+
+ /**
+ * Ajax callback for adding targets to the targeting form.
+ */
+ public function moreTargetsJs(array $form, FormStateInterface $form_state) {
+ return $form['targeting_settings']['targeting'];
+ }
+
+ /**
+ * Helper form builder for an individual target.
+ */
+ protected function addTargetForm(array &$form, $key, array $data = []) {
+ $form['targeting']['table'][$key] = [
+ '#prefix' => '',
+ '#suffix' => '
',
+ '#element_validate' => [[get_class($this), 'targetFormValidate']],
+ ];
+ $form['targeting']['table'][$key]['target'] = [
+ '#type' => 'textfield',
+ '#title_display' => 'invisible',
+ '#title' => t('Target Name'),
+ '#size' => 10,
+ '#default_value' => isset($data['target']) ? $data['target'] : '',
+ '#parents' => ['targeting', $key, 'target'],
+ '#attributes' => ['class' => ['field-target-target']],
+ ];
+ $form['targeting']['table'][$key]['value'] = [
+ '#type' => 'textfield',
+ '#title_display' => 'invisible',
+ '#title' => t('Target Value'),
+ '#size' => 20,
+ '#default_value' => isset($data['value']) ? $data['value'] : '',
+ '#parents' => ['targeting', $key, 'value'],
+ '#attributes' => ['class' => ['field-target-value']],
+ ];
+ if (empty($data)) {
+ $form['targeting']['table'][$key]['target']['#description'] = t('Example: color');
+ $form['targeting']['table'][$key]['value']['#description'] = t('Example: red,white,blue');
+ }
+ }
+
+ /**
+ * Validation function used by an individual target in the targeting form.
+ */
+ public static function targetFormValidate(array $element, FormStateInterface &$form_state) {
+ if (empty($element['target']['#value']) && !empty($element['value']['#value'])) {
+ $form_state->setError($element['target'], t('The target cannot be empty if a value exists.'));
+ }
+ elseif (!empty($element['target']['#value']) && empty($element['value']['#value'])) {
+ $form_state->setError($element['value'], t('The value cannot be empty if a target exists.'));
+ }
+ }
+
+ /**
+ * Helper function that removes empty targets form form values.
+ */
+ protected static function trimTargetingValues(&$values, $parent = 'targeting') {
+ foreach ($values as $key => &$val) {
+ if ($key === $parent) {
+ // We found the targeting values.
+ foreach ($val as $k => $v) {
+ if (empty($val[$k]['target']) && empty($val[$k]['value'])) {
+ unset($val[$k]);
+ }
+ }
+ // Reset the array indexes to prevent wierd behavior caused by a target
+ // being removed in the middle of the array.
+ $val = array_values($val);
+ break;
+ }
+ elseif (is_array($val)) {
+ self::trimTargetingValues($val, $parent);
+ }
+ }
+ }
+
+}
diff --git a/src/Plugin/Block/TagBlock.php b/src/Plugin/Block/TagBlock.php
new file mode 100644
index 0000000..e7dc403
--- /dev/null
+++ b/src/Plugin/Block/TagBlock.php
@@ -0,0 +1,130 @@
+entityRepository = $entity_repository;
+ $this->entityTypeManager = $entity_type_manager;
+ $this->account = $account;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
+ return new static(
+ $configuration,
+ $plugin_id,
+ $plugin_definition,
+ $container->get('entity.repository'),
+ $container->get('entity_type.manager'),
+ $container->get('current_user')
+ );
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function defaultConfiguration() {
+ return [
+ 'label_display' => 'hidden',
+ ];
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function build() {
+ if ($tag = $this->getEntity()) {
+ return $this->entityTypeManager->getViewBuilder($tag->getEntityTypeId())->view($tag);
+ }
+ else {
+ return [
+ '#markup' => $this->t('DFP tag with uuid %uuid does not exist. Add DFP tag.', [
+ '%uuid' => $this->getDerivativeId(),
+ ':url' => Url::fromRoute('entity.dfp_tag.add_form')->toString(),
+ ]),
+ '#access' => $this->account->hasPermission('administer DFP'),
+ ];
+ }
+ }
+
+ /**
+ * Loads the block content entity of the block.
+ *
+ * @return \Drupal\dfp\Entity\TagInterface|null
+ * The block content entity.
+ */
+ protected function getEntity() {
+ $uuid = $this->getDerivativeId();
+ if (!isset($this->tag)) {
+ $this->tag = $this->entityRepository->loadEntityByUuid('dfp_tag', $uuid);
+ }
+ return $this->tag;
+ }
+
+}
diff --git a/src/Plugin/Derivative/TagBlock.php b/src/Plugin/Derivative/TagBlock.php
new file mode 100644
index 0000000..3e761b8
--- /dev/null
+++ b/src/Plugin/Derivative/TagBlock.php
@@ -0,0 +1,65 @@
+tagStorage = $tag_storage;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public static function create(ContainerInterface $container, $base_plugin_id) {
+ $entity_type_manager = $container->get('entity_type.manager');
+ return new static(
+ $entity_type_manager->getStorage('dfp_tag')
+ );
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getDerivativeDefinitions($base_plugin_definition) {
+ /** @var \Drupal\dfp\Entity\TagInterface[] $tags */
+ $tags = $this->tagStorage->loadMultiple();
+ foreach ($tags as $tag) {
+ if ($tag->hasBlock()) {
+ $this->derivatives[$tag->uuid()] = $base_plugin_definition;
+ $this->derivatives[$tag->uuid()]['admin_label'] = $this->t('DFP tag: @slotname', ['@slotname' => $tag->slot()]);
+ $this->derivatives[$tag->uuid()]['config_dependencies']['config'] = [$tag->getConfigDependencyName()];
+ }
+ }
+ return parent::getDerivativeDefinitions($base_plugin_definition);
+ }
+
+}
diff --git a/src/Tests/DfpTestBase.php b/src/Tests/DfpTestBase.php
new file mode 100644
index 0000000..f6169a6
--- /dev/null
+++ b/src/Tests/DfpTestBase.php
@@ -0,0 +1,229 @@
+adminUser = $this->drupalCreateUser([
+ 'administer DFP',
+ 'administer taxonomy',
+ 'access administration pages',
+ 'administer blocks',
+ 'bypass node access',
+ 'administer nodes',
+ ]);
+ $this->drupalLogin($this->adminUser);
+
+ // Set up global settings needed for DFP ads to work.
+ \Drupal::configFactory()->getEditable('dfp.settings')
+ ->set('network_id', '12345')
+ ->set('default_slug', 'Global DFP slug')
+ ->save();
+ }
+
+ /**
+ * Creates a basic dfp ad tag.
+ *
+ * @param array $edit
+ * An array of values for the DFP tag form.
+ *
+ * @return \Drupal\dfp\Entity\Tag
+ * The created DFP tag.
+ */
+ protected function dfpCreateTag($edit = []) {
+ // Create a new tag.
+ $edit += $this->dfpBasicTagEditValues();
+ $this->drupalPostForm('admin/structure/dfp/tags/add', $edit, t('Save'));
+
+ // Load the tag object.
+ $tag = Tag::load($edit['id']);
+ $this->assertTrue(is_object($tag) && $tag->id() == $edit['id'], 'The new DFP tag was saved correctly.');
+
+ // Display the new tag.
+ $this->drupalPlaceBlock('dfp_ad:' . $tag->uuid());
+
+ return $tag;
+ }
+
+ /**
+ * Edits a given tag specified by $id with the given values.
+ *
+ * @param string $id
+ * The DFP tag ID.
+ * @param array $edit
+ * An array of values for the DFP tag form.
+ *
+ * @return \Drupal\dfp\Entity\Tag
+ * The edited DFP tag.
+ */
+ protected function dfpEditTag($id, &$edit) {
+ // Make sure there is no machinename set when we are editing.
+ if (isset($edit['id'])) {
+ unset($edit['id']);
+ }
+ $this->drupalPostForm('admin/structure/dfp/tags/manage/' . $id, $edit, t('Save'));
+ return Tag::load($id);
+ }
+
+ /**
+ * Converts a DFP Tag config entity to a TagView object.
+ *
+ * @param \Drupal\dfp\Entity\TagInterface $tag
+ * The DFP tag.
+ *
+ * @return \Drupal\dfp\View\TagView
+ * The TagView object.
+ */
+ protected function dfpTagToTagView(TagInterface $tag) {
+ return new TagView($tag, $this->getGlobalConfig(), $this->container->get('dfp.token'), $this->container->get('module_handler'));
+ }
+
+ /**
+ * Creates a simple form values $edit array to be used to create a DFP tag.
+ *
+ * @return array
+ * A simple $edit array to be used on the DFP tag form.
+ */
+ protected function dfpBasicTagEditValues() {
+ $machinename = $this->randomMachineName(16);
+ $basic_tag = [
+ 'id' => Unicode::strtolower($machinename),
+ 'slot' => $machinename,
+ 'size' => implode(',', $this->dfpGenerateSize(2)),
+ 'adunit' => $this->randomMachineName(),
+ 'block' => 1,
+ 'slug' => $this->randomMachineName(32),
+ 'adsense_backfill[ad_types]' => '',
+ 'adsense_backfill[channel_ids]' => '',
+ 'adsense_backfill[color][background]' => '',
+ 'adsense_backfill[color][border]' => '',
+ 'adsense_backfill[color][link]' => '',
+ 'adsense_backfill[color][text]' => '',
+ 'adsense_backfill[color][url]' => '',
+ 'targeting[0][target]' => $this->randomMachineName(8),
+ 'targeting[0][value]' => $this->randomMachineName(8),
+ 'breakpoints[0][browser_size]' => $this->dfpGenerateSize(),
+ 'breakpoints[0][ad_sizes]' => implode(',', $this->dfpGenerateSize(2)),
+ ];
+
+ return $basic_tag;
+ }
+
+ /**
+ * Generates a random size (or array of sizes) to use when testing tags.
+ *
+ * @param int $count
+ * How many sizes to generate.
+ *
+ * @return string|array
+ * A size formatted as ###x### or an array of sizes if $count > 1.
+ */
+ protected function dfpGenerateSize($count = 1) {
+ $sizes = [
+ '300x250', '300x600', '728x90', '728x10', '160x600', '120x80', '300x100',
+ '50x50', '160x300',
+ ];
+ shuffle($sizes);
+
+ return $count == 1 ? array_pop($sizes) : array_slice($sizes, 0, min($count, count($sizes)));
+ }
+
+ /**
+ * Gets the global DFP settings.
+ *
+ * @return \Drupal\Core\Config\ImmutableConfig
+ * The global DFP settings.
+ */
+ protected function getGlobalConfig() {
+ return \Drupal::config('dfp.settings');
+ }
+
+ /**
+ * Assert that a property is properly being set.
+ *
+ * @param string $property
+ * The property.
+ * @param string $key
+ * The key.
+ * @param string $val
+ * The value.
+ *
+ * @return bool
+ * TRUE if the property is set, FALSE otherwise.
+ */
+ protected function assertPropertySet($property, $key, $val) {
+ $pattern = $this->getPropertyPattern($property, $key, $val);
+ return $this->assertPattern($pattern, 'A ' . $property . ' property was set for ' . $key . ' = ' . $val);
+ }
+
+ /**
+ * Assert that a property is not being set.
+ *
+ * @param string $property
+ * The property.
+ * @param string $key
+ * The key.
+ * @param string $val
+ * The value.
+ *
+ * @return bool
+ * TRUE if the property is not set, FALSE otherwise.
+ */
+ protected function assertPropertyNotSet($property, $key, $val) {
+ $pattern = $this->getPropertyPattern($property, $key, $val);
+ return $this->assertNoPattern($pattern, 'A ' . $property . ' property was not set for ' . $key . ' = ' . $val);
+ }
+
+ /**
+ * Gets pattern used in assertPropertySet() and assertPropertyNotSet().
+ *
+ * @param string $property
+ * The property.
+ * @param string $key
+ * The key.
+ * @param string $val
+ * The value.
+ *
+ * @return string
+ * The pattern.
+ */
+ private function getPropertyPattern($property, $key, $val) {
+ return '|' . '.set' . $property . '\(\'' . $key . '\',{1}\s(.)*' . addslashes($val) . '|';
+ }
+
+}
diff --git a/src/Tests/DisplayTagTest.php b/src/Tests/DisplayTagTest.php
new file mode 100644
index 0000000..261359f
--- /dev/null
+++ b/src/Tests/DisplayTagTest.php
@@ -0,0 +1,210 @@
+dfpCreateTag();
+ $tag_view = $this->dfpTagToTagView($tag);
+ $this->drupalGet('' . check_plain($tag->slot) . '
', - ), - ); + ], + ]; $tag_tag = dfp_tag($tag->machinename); - $tag_devel = array(); + $tag_devel = []; if (module_exists('devel')) { - $tag_devel['object'] = array( + $tag_devel['object'] = [ '#markup' => kpr($tag, TRUE), - ); + ]; } - $output[] = array($tag_slot, $tag_tag, $tag_devel); + $output[] = [$tag_slot, $tag_tag, $tag_devel]; } return $output; @@ -49,24 +49,24 @@ function dfp_adtest_form($form, &$form_state) { form_load_include($form_state, 'inc', 'dfp', 'dfp.adtest'); $form['#method'] = 'get'; - $form['adunit_override'] = array( + $form['adunit_override'] = [ '#type' => 'textfield', '#title' => t('Ad Unit Override'), '#default_value' => isset($_GET['adunit_override']) ? $_GET['adunit_override'] : '', '#description' => t('Override the Ad Unit value for all the ad tags below. Use the tokens below to define how the ad unit should display. Example: [dfp_tag:network_id]/test/[dfp_tag:slot]'), - ); - $form['tokens'] = array( + ]; + $form['tokens'] = [ '#theme' => 'token_tree', - '#token_types' => array('dfp_tag', 'node', 'term', 'user'), + '#token_types' => ['dfp_tag', 'node', 'term', 'user'], '#global_types' => TRUE, '#click_insert' => TRUE, '#dialog' => TRUE, '#weight' => 100, - ); - $form['submit'] = array( + ]; + $form['submit'] = [ '#type' => 'submit', '#value' => t('Override'), - ); + ]; return $form; } diff --git a/templates/dfp-js-head-bottom.html.twig b/templates/dfp-js-head-bottom.html.twig new file mode 100644 index 0000000..c90cd76 --- /dev/null +++ b/templates/dfp-js-head-bottom.html.twig @@ -0,0 +1,45 @@ +{# +/** + * @file + * Default theme implementation to display a DFP short tag. + * + * Available variables: + * - async_rendering + * - single_request + * - collapse_empty_divs + * - disable_init_load + * - targeting + * + * @see dfp_page_attachments() + * + * @ingroup themeable + */ +#} + diff --git a/templates/dfp-js-head-top.html.twig b/templates/dfp-js-head-top.html.twig new file mode 100644 index 0000000..e4d1fa8 --- /dev/null +++ b/templates/dfp-js-head-top.html.twig @@ -0,0 +1,25 @@ +{# +/** + * @file + * Default theme implementation to display a DFP short tag. + * + * Available variables: + * - google_tag_services_url: + * + * @see dfp_page_attachments() + * + * @ingroup themeable + */ +#} + diff --git a/templates/dfp-short-tag.html.twig b/templates/dfp-short-tag.html.twig new file mode 100644 index 0000000..58a555f --- /dev/null +++ b/templates/dfp-short-tag.html.twig @@ -0,0 +1,18 @@ +{# +/** + * @file + * Default theme implementation to display a DFP short tag. + * + * Available variables: + * - tag: The DFP Tag configuration entity. + * - url_jump: Url to link to. + * - url_ad: Url to display the ad. + * + * @see \Drupal\dfp\View\Tag\TagViewBuilder::buildPreTag() + * + * @ingroup themeable + */ +#} + +
+ {% if tag.isSlugHidden == false and tag.slug %}
+
diff --git a/tests/dfp.test b/tests/dfp.test
deleted file mode 100644
index 48480fa..0000000
--- a/tests/dfp.test
+++ /dev/null
@@ -1,549 +0,0 @@
-admin_user = $this->drupalCreateUser(array('administer DFP', 'administer taxonomy', 'access administration pages', 'administer blocks', 'bypass node access', 'administer nodes', 'edit terms in 1'));
- $this->drupalLogin($this->admin_user);
-
- // Add the some global settings needed for dfp ads to work.
- variable_set('dfp_network_id', '12345');
- variable_set('dfp_default_slug', $this->randomName(8));
- }
-
- /**
- * Create a simple $edit array to be used on the DFP tag form to create a new
- * DFP tag object.
- */
- function dfpBasicTagEditValues() {
- $machinename = drupal_strtolower($this->randomName(8));
- $basic_tag = array(
- 'machinename' => $machinename,
- 'slot' => $machinename,
- 'size' => implode(',', $this->dfpGenerateSize(2)),
- 'adunit' => $this->randomName(8),
- 'block' => 1,
- 'settings[slug]' => $this->randomName(32),
- 'settings[adsense_ad_types]' => '',
- 'settings[adsense_channel_ids]' => '',
- 'settings[adsense_colors][background]' => '',
- 'settings[adsense_colors][border]' => '',
- 'settings[adsense_colors][link]' => '',
- 'settings[adsense_colors][text]' => '',
- 'settings[adsense_colors][url]' => '',
- 'targeting[0][target]' => $this->randomName(8),
- 'targeting[0][value]' => $this->randomName(8),
- 'breakpoints[0][browser_size]' => $this->dfpGenerateSize(),
- 'breakpoints[0][ad_sizes]' => implode(',', $this->dfpGenerateSize(2)),
- );
-
- return $basic_tag;
- }
-
- /**
- * Generate a random size (or array or sizes) to use when testing tags
- * formatted as ###x###.
- */
- function dfpGenerateSize($count = 1) {
- $sizes = array('300x250', '300x600', '728x90', '728x10', '160x600', '120x80', '300x100', '50x50', '160x300');
- shuffle($sizes);
-
- return $count == 1 ? array_pop($sizes) : array_slice($sizes, 0, min($count, count($sizes)));
- }
-
- /**
- * Creates a basic dfp ad tag.
- */
- function createTag($edit = array()) {
- // Create a new tag.
- $edit += $this->dfpBasicTagEditValues();
- $this->drupalPost('admin/structure/dfp_ads/add', $edit, t('Save'));
-
- // Load the tag object.
- $tag = dfp_tag_load($edit['machinename']);
- $this->assertTrue(is_object($tag) && $tag->machinename = $edit['machinename'], 'The new tag was saved correctly.');
-
- // Display the new tag.
- $edit = array();
- $delta = 'dfp_' . (drupal_strlen($tag->machinename) >= 32 ? md5($tag->machinename) : $tag->machinename);
- $edit['blocks[' . $delta . '][region]'] = 'sidebar_first';
- $this->drupalPost('admin/structure/block', $edit, t('Save blocks'));
-
- return $tag;
- }
-
- /**
- * Edit a given tag specified by $machinename with the given values.
- */
- function editTag($machinename, &$edit) {
- // Make sure there is no machinename set when we are editing.
- if (isset($edit['machinename'])) {
- unset($edit['machinename']);
- }
- $this->drupalPost('admin/structure/dfp_ads/list/' . $machinename . '/edit', $edit, t('Save'));
- $tag = dfp_tag_load($machinename);
- return $tag;
- }
-
- /**
- * Create a taxonomy term.
- */
- function createTerm($vocabulary) {
- $term = new stdClass();
- $term->name = $this->randomName();
- $term->description = $this->randomName();
- // Use the first available text format.
- $term->format = db_query_range('SELECT format FROM {filter_format}', 0, 1)->fetchField();
- $term->vid = $vocabulary->vid;
- taxonomy_term_save($term);
- return $term;
- }
-
- /**
- * Assert that a property is properly being set.
- */
- function assertPropertySet($property, $key, $val) {
- $pattern = '|' . '.set' . $property . '\("' . $key . '",{1}\s(.)*' . addslashes($val) . '|';
- $this->assertPattern($pattern, 'A ' . $property . ' property was set for ' . $key . ' = ' . $val);
- }
-
- /**
- * Assert that a property is not being set.
- */
- function assertPropertyNotSet($property, $key, $val) {
- $pattern = '|' . '.set' . $property . '\("' . $key . '",{1}\s(.)*' . addslashes($val) . '|';
- $this->assertNoPattern($pattern, 'A ' . $property . ' property was not set for ' . $key . ' = ' . $val);
- }
-
-}
-
-class dfpDisplayTagTest extends dfpBaseTest {
- /**
- * Implements getInfo().
- */
- public static function getInfo() {
- return array(
- 'name' => t('Displaying DFP Tags'),
- 'description' => t('Tests for displaying DFP tags.'),
- 'group' => t('DFP'),
- );
- }
-
- function testDisplayTag() {
- // Create a simple tag as a block.
- $tag = $this->createTag();
- $this->assertRaw('googletag.defineSlot("' . variable_get('dfp_network_id', '') . '/' . $tag->adunit . '", ' . dfp_format_size($tag->size) . ', "' . $tag->placeholder_id . '")', 'The ad slot has been correctly defined in javascript.');
-
- // Create a tag with a machine name longer than 32 characters.
- $edit = array('machinename' => drupal_strtolower($this->randomName(64)));
- $tag = $this->createTag($edit);
- $this->assertRaw('googletag.defineSlot("' . variable_get('dfp_network_id', '') . '/' . $tag->adunit . '", ' . dfp_format_size($tag->size) . ', "' . $tag->placeholder_id . '")', 'The ad slot with a very long machine name has been correctly defined in javascript.');
- }
-
- function testDisplayTagWithMapping() {
- $edit = $this->dfpBasicTagEditValues();
-
- // Create a simple tag with a mapping. Verify javascript on page.
- $tag = $this->createTag($edit);
- $mapping_sizes = explode(',', $edit['breakpoints[0][ad_sizes]']);
- $size_count = count($mapping_sizes);
- // Calculate addSize mappings.
- $mapping_tag = '.addSize(';
- $mapping_tag .= '[' . str_replace('x', ', ', $edit['breakpoints[0][browser_size]']) . '], ';
- $mapping_tag .= ($size_count > 1) ? '[' : '';
- for ($i = 0; $i < $size_count; $i++) {
- $mapping_sizes[$i] = '[' . str_replace('x', ', ', $mapping_sizes[$i]) . ']';
- $mapping_tag .= ($i + 1 !== $size_count) ? $mapping_sizes[$i] . ', ' : $mapping_sizes[$i];
- }
- $mapping_tag .= ($size_count > 1) ? '])' : ')';
- $this->assertRaw('googletag.sizeMapping()', 'The ad slot correctly attaches size mapping.');
- $this->assertRaw('.defineSizeMapping(mapping)', 'The ad slot correctly defines size mapping.');
- $this->assertRaw($mapping_tag, 'The ad slot correctly defines specific size mappings.');
-
- // Create a tag with invalid browser size mappings.
- $edit['breakpoints[0][browser_size]'] = $this->randomName(8);
- $this->editTag($tag->machinename, $edit);
- $this->assertText(t('The browser size can only contain numbers and the character x.'), 'An error was correctly thrown when invalid characters.');
-
- // Create a tag with invalid ad size mappings.
- $edit['breakpoints[0][browser_size]'] = $this->dfpGenerateSize();
- $edit['breakpoints[0][ad_sizes]'] = $this->randomName(8);
- $this->editTag($tag->machinename, $edit);
- $this->assertText(t('The ad size(s) can only contain numbers, the character x and commas.'), 'An error was correctly thrown when invalid characters.');
- }
-
- function testSlug() {
- $edit = $this->dfpBasicTagEditValues();
-
- // Create a tag without a slug, display it and ensure the default slug is
- // displayed.
- variable_set('dfp_default_slug', $this->randomName(8));
- $edit['settings[slug]'] = '';
- $tag = $this->createTag($edit);
- $this->assertRaw('
+ {{ tag.slug }}
+
+ {% endif %}
+
+' . dfp_format_slug(variable_get('dfp_default_slug', '')) . '
', 'The default slug is correctly used when no slug exists for an individual tag.');
-
- // Change the slug to ', t('No slug is appearing when "@none" is used.', array('@none' => '')));
-
- // Specify a slug and check that it shows instead of the default slug.
- $slug = $this->randomName(8);
- $edit['settings[slug]'] = $slug;
- $this->editTag($tag->machinename, $edit);
- $this->assertRaw('', 'default_slug', ''],
+ ];
+ }
+
+ /**
+ * @covers ::getAdUnit
+ * @dataProvider getAdUnitProvider
+ */
+ public function testGetAdUnit($tag_ad_unit, $default_ad_unit, $network_id, $expected_adunit) {
+ $tag = $this->prophesize(TagInterface::class);
+ $tag->adunit()->willReturn($tag_ad_unit);
+ $config_factory = $this->getConfigFactoryStub(['dfp.settings' => ['default_pattern' => $default_ad_unit, 'network_id' => $network_id]]);
+ $token = $this->getMock(TokenInterface::class);
+ $token->method('replace')->willReturnArgument(0);
+ $module_handler = $this->prophesize(ModuleHandlerInterface::class)->reveal();
+ $tag_view = new TagView($tag->reveal(), $config_factory->get('dfp.settings'), $token, $module_handler);
+ $this->assertSame($expected_adunit, $tag_view->getAdUnit());
+ }
+
+ /**
+ * Data provider for self::testGetAdUnit().
+ */
+ public function getAdUnitProvider() {
+ return [
+ ['adunit', 'default_adunit', '12345', '/12345/adunit'],
+ ['', 'default_adunit', '67890', '/67890/default_adunit'],
+ ];
+ }
+
+ /**
+ * @covers ::getShortTagQueryString
+ * @dataProvider getShortTagQueryStringProvider
+ */
+ public function testGetShortTagQueryString($tag_ad_unit, $tag_sizes, $tag_targeting, $network_id, $regex) {
+ $tag = $this->prophesize(TagInterface::class);
+ $tag->adunit()->willReturn($tag_ad_unit);
+ $tag->size()->willReturn($tag_sizes);
+ $tag->targeting()->willReturn($tag_targeting);
+ $config_factory = $this->getConfigFactoryStub(['dfp.settings' => ['default_pattern' => 'default_adunit', 'network_id' => $network_id]]);
+ $token = $this->getMock(TokenInterface::class);
+ $token->method('replace')->willReturnArgument(0);
+ $module_handler = $this->prophesize(ModuleHandlerInterface::class)->reveal();
+ $tag_view = new TagView($tag->reveal(), $config_factory->get('dfp.settings'), $token, $module_handler);
+ $this->assertRegExp($regex, $tag_view->getShortTagQueryString());
+ }
+
+ /**
+ * Data provider for self::testGetShortTagQueryString().
+ */
+ public function getShortTagQueryStringProvider() {
+ return [
+ ['adunit', '300x200', [], '12345', '|^iu=/12345/adunit&sz=300x200&c=[0-9]{5}$|'],
+ ['adunit', '300x200', [['target' => 'target', 'value' => 'value,value2']], '12345', '|^iu=/12345/adunit&sz=300x200&c=[0-9]{5}&t=target%3Dvalue%2Cvalue2$|'],
+ ['adunit', '300x200', [['target' => 'target', 'value' => 'value,value2'], ['target' => 'target2', 'value' => 'value3']], '12345', '|^iu=/12345/adunit&sz=300x200&c=[0-9]{5}&t=target%3Dvalue%2Cvalue2%26target2%3Dvalue3$|'],
+ ];
+ }
+
+}
diff --git a/theme/dfp_short_tag.tpl.php b/theme/dfp_short_tag.tpl.php
deleted file mode 100644
index 2ed724e..0000000
--- a/theme/dfp_short_tag.tpl.php
+++ /dev/null
@@ -1,10 +0,0 @@
-
-
-
- 
-
diff --git a/theme/dfp_tag.tpl.php b/theme/dfp_tag.tpl.php
deleted file mode 100644
index 0dd89d7..0000000
--- a/theme/dfp_tag.tpl.php
+++ /dev/null
@@ -1,17 +0,0 @@
-
-
-
' . $slug . '
', 'The provided slug is correctly displayed with its tag.');
- }
-
- function testTargeting() {
- $edit = $this->dfpBasicTagEditValues();
-
- // Create a tag with a target with only one value.
- $tag = $this->createTag($edit);
- $this->assertPropertySet('Targeting', $edit['targeting[0][target]'], $edit['targeting[0][value]']);
-
- // Create a tag with a target with multiple values.
- $values = array($this->randomName(8), $this->randomName(8), $this->randomName(8));
- $edit['targeting[0][target]'] = $this->randomName(8);
- $edit['targeting[0][value]'] = implode(', ', $values);
- $this->editTag($tag->machinename, $edit);
- $this->assertPropertySet('Targeting', $edit['targeting[0][target]'], implode('","', $values));
-
- // Create a tag with a target but no value.
- $edit['targeting[0][target]'] = $this->randomName(8);
- $edit['targeting[0][value]'] = '';
- $this->editTag($tag->machinename, $edit);
- $this->assertText(t('The value cannot be empty if a target exists.'), 'An error was correctly thrown when a target has no value.');
-
- // Create a tag with an empty target, but a value.
- $edit['targeting[0][target]'] = '';
- $edit['targeting[0][value]'] = $this->randomName(8);
- $this->editTag($tag->machinename, $edit);
- $this->assertText(t('The target cannot be empty if a value exists.'), 'An error was correctly thrown when a target is blank, but a value has been entered.');
-
- // Create a tag with multiple targets.
- $count = 3;
- for ($i = 0; $i < $count; $i++) {
- $edit['targeting[' . $i . '][target]'] = $this->randomName(8);
- $edit['targeting[' . $i . '][value]'] = $this->randomName(8);
- $this->drupalPost('admin/structure/dfp_ads/list/' . $tag->machinename . '/edit', $edit, t('Add another target'));
- $this->editTag($tag->machinename, $edit);
- }
-
- for ($i = 0; $i < $count; $i++) {
- $this->assertPropertySet('Targeting', $edit['targeting[' . $i . '][target]'], $edit['targeting[' . $i . '][value]']);
- }
- // Make sure that empty values are ignored.
- $this->drupalPost('admin/structure/dfp_ads/list/' . $tag->machinename . '/edit', $edit, t('Add another target'));
- $this->editTag($tag->machinename, $edit);
- $this->assertPropertyNotSet('Targeting', '', '');
-
- // Test that target can be removed.
- $edit['targeting[0][target]'] = '';
- $edit['targeting[0][value]'] = '';
- $this->editTag($tag->machinename, $edit);
- $this->assertPropertyNotSet('Targeting', '', '');
- }
-
- function testBackfill() {
- $edit = $this->dfpBasicTagEditValues();
-
- // Create a tag with backfill settings.
- $colors = array('background', 'border', 'link', 'text', 'url');
- $types = array('text', 'image', 'text_image');
- shuffle($types);
-
- $edit['settings[adsense_ad_types]'] = array_pop($types);
- $edit['settings[adsense_channel_ids]'] = $this->randomName(8);
- foreach ($colors as $color) {
- $edit['settings[adsense_colors][' . $color . ']'] = drupal_strtoupper($this->randomName(8));
- }
- $tag = $this->createTag($edit);
- $this->assertPropertySet('', 'adsense_ad_types', $edit['settings[adsense_ad_types]']);
- $this->assertPropertySet('', 'adsense_channel_ids', $edit['settings[adsense_channel_ids]']);
- foreach ($colors as $color) {
- $this->assertPropertySet('', 'adsense_' . $color . '_color', $edit['settings[adsense_colors][' . $color . ']']);
- }
- }
-
-}
-
-class dfpAdCategoriesTest extends dfpBaseTest {
- /**
- * Implements getInfo().
- */
- public static function getInfo() {
- return array(
- 'name' => t('DFP Ad Categories'),
- 'description' => t('Tests the functionaility of DFP ad categories.'),
- 'group' => t('DFP'),
- );
- }
-
- function testEnableDisableAdCategories() {
- // Check that enabling DFP Ad Categories for the "tags" vocabulary works.
- $edit = array(
- 'dfp_enable_ad_categories' => 1,
- 'dfp_enable_ad_categories_bundles[tags]' => 'tags',
- );
- $this->drupalPost('admin/structure/dfp_ads/settings', $edit, t('Save configuration'));
- $this->drupalGet('admin/structure/taxonomy/tags/add');
- $this->assertFieldByName('field_dfp_ad_categories[und]');
-
- // Check that disabling DFP Ad Categories vocabulary works even when a
- // bundle is selected.
- $edit = array(
- 'dfp_enable_ad_categories' => 0,
- );
- $this->drupalPost('admin/structure/dfp_ads/settings', $edit, t('Save configuration'));
- $this->drupalGet('admin/structure/taxonomy/tags/add');
- $this->assertNoFieldByName('field_dfp_ad_categories[und]');
-
- // Check that disabling DFP Ad Categories on a specific vocabulary works.
- // For this test to be valid, we first need to reenable DFP Ad Categories.
- $edit = array(
- 'dfp_enable_ad_categories' => 1,
- 'dfp_enable_ad_categories_bundles[tags]' => 'tags',
- );
- $this->drupalPost('admin/structure/dfp_ads/settings', $edit, t('Save configuration'));
- $this->drupalGet('admin/structure/taxonomy/tags/add');
- $edit = array(
- 'dfp_enable_ad_categories_bundles[tags]' => 0,
- );
- $this->drupalPost('admin/structure/dfp_ads/settings', $edit, t('Save configuration'));
- $this->drupalGet('admin/structure/taxonomy/tags/add');
- $this->assertNoFieldByName('field_dfp_ad_categories[und]');
- }
-
- // Test that DFP Catetories are displayed properly.
- function testDisplayAdCategories() {
- $dfp_add_categories_vocabulary = taxonomy_vocabulary_machine_name_load('dfp_ad_categories');
- $tags_vocabulary = taxonomy_vocabulary_machine_name_load('tags');
-
- // Turn on DFP ad categories for the "tags" vocabulary.
- $edit = array(
- 'dfp_enable_ad_categories' => 1,
- 'dfp_enable_ad_categories_bundles[tags]' => 'tags',
- );
- $this->drupalPost('admin/structure/dfp_ads/settings', $edit, t('Save configuration'));
-
- // Create a new DFP Ad Category term.
- $dfp_category = $this->createTerm($dfp_add_categories_vocabulary);
- $control_tag = $this->createTerm($tags_vocabulary);
- $test_tag = $this->createTerm($tags_vocabulary);
-
- // Create a new "Article" node with these two tags.
- $edit = array(
- 'title' => $this->randomName(8),
- 'field_tags[und]' => $control_tag->name . ', ' . $test_tag->name,
- );
- $this->drupalPost('node/add/article', $edit, t('Save'));
-
- // Edit one the new tags and tag it with a DFP Ad Category.
- $edit = array(
- 'field_dfp_ad_categories[und]' => $dfp_category->tid,
- );
- $this->drupalPost('taxonomy/term/' . $test_tag->tid . '/edit', $edit, t('Save'));
-
- // Create a DFP ad slot that targets the [dfp_tag:ad_categories] token.
- $edit = $this->dfpBasicTagEditValues();
-
- // Create a tag that uses the slot token in a target.
- $edit['slot'] = $this->randomName(8);
- $edit['targeting[0][target]'] = 'categories';
- $edit['targeting[0][value]'] = '[dfp_tag:ad_categories]';
- $tag = $this->createTag($edit);
-
- // Check that when we are on the node page, that the DFP Ad Category is used
- // and that the control tag is also displayed.
- $this->drupalGet('node/1');
- $this->assertPropertySet('Targeting', 'categories', $control_tag->name);
- $this->assertPropertySet('Targeting', 'categories', $dfp_category->name);
-
- // Check that when we are on the term page for one of DFP Ad Categories that
- // it is correctly included.
- $this->drupalGet('taxonomy/term/' . $dfp_category->tid);
- $this->assertPropertySet('Targeting', 'categories', $dfp_category->name);
-
- // Check that when we are on a term page for a term with a coresponding
- // DFP Ad Categories the DFP Ad Category is included.
- $this->drupalGet('taxonomy/term/' . $test_tag->tid);
- $this->assertPropertySet('Targeting', 'categories', $dfp_category->name);
- }
-}
-
-class dfpTokensTest extends dfpBaseTest {
- /**
- * Implements getInfo().
- */
- public static function getInfo() {
- return array(
- 'name' => t('DFP Tokens'),
- 'description' => t('Tests for custom tokens created by the DFP module.'),
- 'group' => t('DFP'),
- );
- }
-
- function testSlotToken() {
- $edit = $this->dfpBasicTagEditValues();
-
- // Create a tag that uses the slot token in a target.
- $test_slot = $this->randomName(8);
- $edit['slot'] = $test_slot;
- $edit['targeting[0][target]'] = 'slot';
- $edit['targeting[0][value]'] = '[dfp_tag:slot]';
- $tag = $this->createTag($edit);
- $this->assertPropertySet('Targeting', 'slot', $test_slot);
- }
-
- function testNetworkIDToken() {
- $edit = $this->dfpBasicTagEditValues();
-
- // Create a tag that uses the networkid token in a target.
- $test_network_id = $this->randomName(8);
- variable_set('dfp_network_id', $test_network_id);
- $edit['targeting[0][target]'] = 'network id';
- $edit['targeting[0][value]'] = '[dfp_tag:network_id]';
- $tag = $this->createTag($edit);
- $this->assertPropertySet('Targeting', 'network id', $test_network_id);
- }
-
- function testUrlPartsToken() {
- // Create a tag that uses the url parts token in a target.
- $tag = $this->createTag();
- $url = 'admin/structure/dfp_ads';
- $url_parts = explode('/', $url);
-
- $max_parts_to_test = 3;
- for ($i = 1; $i <= $max_parts_to_test; $i++) {
- $edit['targeting[0][target]'] = 'url parts';
- $edit['targeting[0][value]'] = '[dfp_tag:url_parts:' . $i . ']';
- $this->editTag($tag->machinename, $edit);
-
- $this->drupalGet($url);
- $replacement = implode('/', array_slice($url_parts, 0, $i));
- $this->assertPropertySet('Targeting', 'url parts', $replacement);
- }
- }
-
-}
-
-class dfpGlobalsTest extends dfpBaseTest {
- /**
- * Implements getInfo().
- */
- public static function getInfo() {
- return array(
- 'name' => t('Gloabl DFP Tag Settings'),
- 'description' => t('Tests for the settings defined in admin/structure/dfp_ads/settings.'),
- 'group' => t('DFP'),
- );
- }
-
- function testGlobalSettingsOn() {
- $injected_js = $this->randomName(32);
- $target = array(
- 'target' => $this->randomName(8),
- 'value' => $this->randomName(8),
- );
-
- variable_set('dfp_async_rendering', '1');
- variable_set('dfp_single_request', '1');
- variable_set('dfp_collapse_empty_divs', '1');
- variable_set('dfp_injected_js', $injected_js);
- variable_set('dfp_targeting', array($target));
- $this->drupalGet('/');
- $this->assertRaw('googletag.pubads().enableAsyncRendering();', 'Asyncronous rendering is turned on.');
- $this->assertRaw('googletag.pubads().enableSingleRequest();', 'Single request is turned on.');
- $this->assertRaw('googletag.pubads().collapseEmptyDivs();', 'Collapse empty divs is turned on.');
- $this->assertRaw($injected_js, 'Injected javascript correctly appears on the page.');
- $this->assertRaw('googletag.pubads().setTargeting("' . $target['target'] . '", "' . $target['value'] . '");', 'Global targetting values appear correclty in javascript.');
- }
-
- function testGlobalSettingsOff() {
- variable_set('dfp_async_rendering', '0');
- variable_set('dfp_single_request', '0');
- variable_set('dfp_collapse_empty_divs', '0');
- $this->drupalGet('/');
- $this->assertNoRaw('googletag.pubads().enableAsyncRendering();', 'Asyncronous rendering is turned off.');
- $this->assertNoRaw('googletag.pubads().enableSingleRequest();', 'Single request is turned off.');
- $this->assertNoRaw('googletag.pubads().collapseEmptyDivs();', 'Collapse empty divs is turned off.');
- }
-
-}
-
-class dfpAdTestTest extends dfpBaseTest {
- /**
- * Implements getInfo().
- */
- public static function getInfo() {
- return array(
- 'name' => t('Displaying AdTest DFP Tags'),
- 'description' => t('Tests for displaying overridden DFP tags for ad test purposes.'),
- 'group' => t('DFP'),
- );
- }
-
- function testTestPage() {
- $tag = $this->createTag();
-
- $override = $this->randomName(8);
- $this->drupalGet('admin/structure/dfp_ads/test_page', array('query' => array('adunit_override' => $override)));
- $this->assertRaw('googletag.defineSlot("' . variable_get('dfp_network_id', '') . '/' . $override . '"', 'The Ad Unit Name was properly overridden on the Ad Test Page.');
- }
-
- function testQueryString() {
- $tag = $this->createTag();
-
- $override = $this->randomName(8);
- variable_set('dfp_adtest_adunit', $override);
- $this->drupalGet('admin/structure/dfp_ads/test_page', array('query' => array('adtest' => 'true')));
- $this->assertRaw('googletag.defineSlot("' . variable_get('dfp_network_id', '') . '/' . $override . '"', 'The Ad Unit Name was properly overridden using the adtest query string.');
- }
-
-}
-
-class DFPUnitTest extends DrupalUnitTestCase {
- protected $profile = 'testing';
-
- /**
- * Implementation of setUp().
- */
- function setUp() {
- // Enable a couple modules.
- drupal_load('module', 'dfp');
- parent::setUp();
- }
-
- /**
- * Implements getInfo().
- */
- public static function getInfo() {
- return array(
- 'name' => t('DFP Unit Tests'),
- 'description' => t('Checks the integrity of certain DFP functions.'),
- 'group' => t('DFP'),
- );
- }
-
- function testDFPformatSize() {
- $sizes = '300x250';
- $expected_result = '[300, 250]';
-
- $this->assertTrue(dfp_format_size($sizes) == $expected_result, 'The dfp_format_sizes function correctly handles an single size.');
- $sizes = '300x250,728x90';
- $expected_result = '[[300, 250], [728, 90]]';
- $this->assertTrue(dfp_format_size($sizes) == $expected_result, 'The dfp_format_sizes function correctly handles multiple sizes.');
- }
-}
diff --git a/tests/src/Unit/DfpHtmlResponseAttachmentsProcessorTest.php b/tests/src/Unit/DfpHtmlResponseAttachmentsProcessorTest.php
new file mode 100644
index 0000000..51d53d8
--- /dev/null
+++ b/tests/src/Unit/DfpHtmlResponseAttachmentsProcessorTest.php
@@ -0,0 +1,163 @@
+attachmentProcessor = $this->getMockBuilder(AttachmentsResponseProcessorInterface::class)->disableOriginalConstructor()->getMock();
+ $this->attachmentProcessor->method('processAttachments')
+ ->willReturnArgument(0);
+
+ $this->token = $this->prophesize(TokenInterface::class);
+ $this->assetResolver = $this->prophesize(AssetResolverInterface::class);
+ $this->cssCollectionRenderer = $this->prophesize(AssetCollectionRendererInterface::class);
+ $this->jsCollectionRenderer = $this->prophesize(AssetCollectionRendererInterface::class);
+ $this->requestStack = $this->prophesize(RequestStack::class);
+ $this->renderer = $this->prophesize(RendererInterface::class);
+ $this->moduleHandler = $this->prophesize(ModuleHandlerInterface::class);
+ }
+
+ /**
+ * @covers ::processAttachments
+ */
+ public function testProcessAttachments() {
+ // Create a response with two dfp_slot attachments and ensure that the
+ // they are converted to html_head attachments. Also ensure that the other
+ // html_head elements are added to create the necessary javascript in the
+ // right order.
+ $response = new HtmlResponse();
+ for ($i = 1; $i < 3; $i++) {
+ $tag = $this->prophesize(TagView::class);
+ $tag->id()->willReturn($i);
+ $attachments['dfp_slot'][] = $tag->reveal();
+ }
+ $response->setAttachments($attachments);
+ $config_factory = $this->getConfigFactoryStub(['dfp.settings' => ['targeting' => []]]);
+
+ $response = $this->getDfpAttachmentProcessor($config_factory)->processAttachments($response);
+ $this->assertEquals('dfp-js-head-top', $response->getAttachments()['html_head'][0][1]);
+ $this->assertEquals('dfp-slot-definition-1', $response->getAttachments()['html_head'][1][1]);
+ $this->assertEquals('dfp-slot-definition-2', $response->getAttachments()['html_head'][2][1]);
+ $this->assertEquals('dfp-js-head-bottom', $response->getAttachments()['html_head'][3][1]);
+ $this->assertArrayNotHasKey('dfp_slot', $response->getAttachments(), 'The dfp_slot attachments are converted to html_head attachments.');
+ }
+
+ /**
+ * @covers ::processAttachments
+ */
+ public function testProcessAttachmentsNoSlots() {
+ // Ensure that if there are no slots nothing is added to the attachments.
+ $response = new HtmlResponse();
+ $config_factory = $this->getConfigFactoryStub();
+ $response = $this->getDfpAttachmentProcessor($config_factory)->processAttachments($response);
+ $this->assertEmpty($response->getAttachments());
+ }
+
+ /**
+ * Creates a DfpHtmlResponseAttachmentsProcessor object.
+ *
+ * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
+ * A mock config factory that can contain 'dfp.settings' configuration.
+ *
+ * @return \Drupal\dfp\DfpHtmlResponseAttachmentsProcessor
+ * The DfpHtmlResponseAttachmentsProcessor object.
+ */
+ protected function getDfpAttachmentProcessor(ConfigFactoryInterface $config_factory) {
+ return new DfpHtmlResponseAttachmentsProcessor(
+ $this->attachmentProcessor,
+ $this->token->reveal(),
+ $this->assetResolver->reveal(),
+ $config_factory,
+ $this->cssCollectionRenderer->reveal(),
+ $this->jsCollectionRenderer->reveal(),
+ $this->requestStack->reveal(),
+ $this->renderer->reveal(),
+ $this->moduleHandler->reveal()
+ );
+ }
+
+}
diff --git a/tests/src/Unit/View/TagViewTest.php b/tests/src/Unit/View/TagViewTest.php
new file mode 100644
index 0000000..95f644f
--- /dev/null
+++ b/tests/src/Unit/View/TagViewTest.php
@@ -0,0 +1,118 @@
+assertSame($expected, TagView::formatSize($size));
+ }
+
+ /**
+ * Data provider for self::testFormatSize().
+ */
+ public function formatSizeProvider() {
+ return [
+ ['300x250 ', '[300, 250]'],
+ ['300x250, 728x90 ', '[[300, 250], [728, 90]]'],
+ ];
+ }
+
+ /**
+ * @covers ::getSlug
+ * @dataProvider getSlugProvider
+ */
+ public function testGetSlug($tag_slug, $default_slug, $expected_slug) {
+ $tag = $this->prophesize(TagInterface::class);
+ $tag->slug()->willReturn($tag_slug);
+ $config_factory = $this->getConfigFactoryStub(['dfp.settings' => ['default_slug' => $default_slug]]);
+ $token = $this->prophesize(TokenInterface::class)->reveal();
+ $module_handler = $this->prophesize(ModuleHandlerInterface::class)->reveal();
+ $tag_view = new TagView($tag->reveal(), $config_factory->get('dfp.settings'), $token, $module_handler);
+ $this->assertSame($expected_slug, $tag_view->getSlug());
+ }
+
+ /**
+ * Data provider for self::testGetSlug().
+ */
+ public function getSlugProvider() {
+ return [
+ ['slug', 'default_slug', 'slug'],
+ ['', 'default_slug', 'default_slug'],
+ ['>
-
-
-