mediafront.field.inc in MediaFront 7.2

File

includes/mediafront.field.inc

<?php

/**
 * Implements hook_field_formatter_info().
 */
function mediafront_field_formatter_info() {
  $field_types = array(
    'file',
    'text',
    'youtube',
  );
  drupal_alter('mediafront_field_types', $field_types);
  return array(
    'mediafront_player' => array(
      'label' => t('MediaFront Player'),
      'description' => t('Play this file using a MediaFront Preset.'),
      'field types' => $field_types,
      'settings' => array(
        'preset' => '',
      ),
    ),
  );
}

/**
 * Implementation of hook_form_FORM_ID_alter().
 */
function mediafront_form_field_ui_field_edit_form_alter(&$form, $form_state) {

  // Get this field instance.
  $instance = $form['#instance'];

  // Get the options for this field from the field handler.
  $options = !empty($instance['settings']['mediafront']) ? $instance['settings']['mediafront'] : array();

  // Setup the mediafront settings for this field.
  $form['instance']['settings']['mediafront'] = array(
    '#type' => 'fieldset',
    '#title' => 'MediaFront Settings',
  );

  // Add the mediafront field select form.
  $form['instance']['settings']['mediafront'] = array_merge($form['instance']['settings']['mediafront'], mediafront_field_form($options, 'edit-instance-settings-mediafront-'));
}

/**
 * Implements hook_field_formatter_settings_form
 */
function mediafront_field_formatter_settings_form($field, $instance, $view_mode, $form, &$form_state, $type = 'mediafront_player') {
  $display = $instance['display'][$view_mode];
  $settings = $display['settings'];
  $element = array();
  if ($display['type'] == $type) {
    $element['preset'] = mediafront_preset_select_form($settings, 'preset');
  }
  return $element;
}

/**
 * Implements hook_field_formatter_settings_summary
 */
function mediafront_field_formatter_settings_summary($field, $instance, $view_mode, $type = 'mediafront_player') {
  $display = $instance['display'][$view_mode];
  $settings = $display['settings'];
  $summary = '';
  if ($display['type'] == $type) {
    $header = array(
      'Setting',
      'Value',
    );
    $items = array();
    foreach ($settings as $name => $value) {
      $items[] = $name . ': ' . $value;
    }
    $summary = theme('item_list', array(
      'title' => t('Player Settings'),
      'items' => $items,
    ));
  }
  return $summary;
}

/**
 * Implements hook_field_formatter_view().
 */
function mediafront_field_formatter_view($entity_type, $entity, $field, $instance, $langcode, &$items, $display, $type = 'mediafront_player') {
  $element = array();
  if ($display['type'] == $type) {
    $player_fields = array();

    // If this is a file, then we need just set the fields to the entity.
    if ($entity_type == 'file') {
      $player_fields = $entity;
    }
    else {

      // Set that the media was not found.
      $media_found = false;

      // Get the settings from this field first...
      if (!empty($instance['settings']['mediafront'])) {
        $options = $instance['settings']['mediafront'];
        $media_found |= $options['field_type'] == 'media';
        $player_fields[$instance['field_name']] = array(
          'type' => $options['field_type'],
          'field' => $instance['field_name'],
          'options' => $options,
        );
      }

      // Get the fields.
      $entity_fields = field_info_instances($instance['entity_type'], $instance['bundle']);

      // See if there is a views field defined for this display.
      $view = null;
      if (!empty($display['views_field'])) {
        $view = $display['views_field']->view;
      }
      foreach ($entity_fields as $name => $entity_field) {

        // Reset the options.
        $options = array();
        $include = TRUE;

        // If a views field is defined, use the options from it instead.
        if (!empty($view)) {
          $include = FALSE;
          foreach ($view->field as $view_field) {
            if ($view_field->field == $name && isset($view_field->options['mediafront'])) {
              $include = TRUE;
              $options = $view_field->options['mediafront'];
              break;
            }
          }
        }

        // If there aren't any options defined at this point, then use the field settings.
        if (!$options) {
          $options = !empty($entity_field['settings']['mediafront']) ? $entity_field['settings']['mediafront'] : array();
        }
        if ($include && !empty($options['field_type'])) {
          $is_media = $options['field_type'] == 'media';
          if (!$is_media || !$media_found) {
            $media_found |= $is_media;
            $player_fields[$entity_field['field_name']] = array(
              'type' => $options['field_type'],
              'field' => $entity_field['field_name'],
              'options' => $options,
            );
          }
        }
      }

      // If no media field is set, then just use this field.
      if (!$media_found && !empty($instance['field_name'])) {
        $player_fields[$instance['field_name']] = array(
          'type' => 'media',
          'field' => $instance['field_name'],
          'options' => array(
            'media_type' => 'media',
          ),
        );
      }
    }
    $settings = $display['settings'];

    // Use the first mediafront preset if none is defined.
    if (empty($settings['preset'])) {
      $temp = mediafront_preset_get_presets();
      $preset = array_shift($temp);
      $settings['preset'] = $preset['name'];
    }

    // If there was media found, but no items, we still want to render this player.
    if (!empty($instance['settings']['mediafront']['always_show_player']) && $media_found && empty($items)) {
      $items = array(
        0,
      );
    }
    $element[] = array(
      '#theme' => $type,
      '#entity' => $entity,
      '#preset' => $settings['preset'],
      '#fields' => $player_fields,
      '#type' => $display['type'],
    );
  }
  return $element;
}

/**
 * Implements hook_file_formatter_info().
 */
function mediafront_file_formatter_info() {

  // Add the mediafront file player.
  $formatters['mediafront_file_player'] = array(
    'label' => t('MediaFront File Player'),
    'file types' => array(
      'video',
      'audio',
    ),
    'default settings' => array(
      'preset' => '',
    ),
    'view callback' => 'mediafront_file_formatter_view',
    'settings callback' => 'mediafront_file_formatter_settings',
  );
  return $formatters;
}

/**
 * Implements hook_file_formatter_FORMATTER_settings().
 */
function mediafront_file_formatter_settings($form, &$form_state, $settings) {
  $element = array();
  $element['preset'] = mediafront_preset_select_form($settings, 'preset');
  return $element;
}

/**
 * Implements hook_file_formatter_FORMATTER_view().
 */
function mediafront_file_formatter_view($file, $display, $langcode) {
  $element = array();
  return $element;
}

Functions

Name	Description
mediafront_field_formatter_info	Implements hook_field_formatter_info().
mediafront_field_formatter_settings_form	Implements hook_field_formatter_settings_form
mediafront_field_formatter_settings_summary	Implements hook_field_formatter_settings_summary
mediafront_field_formatter_view	Implements hook_field_formatter_view().
mediafront_file_formatter_info	Implements hook_file_formatter_info().
mediafront_file_formatter_settings	Implements hook_file_formatter_FORMATTER_settings().
mediafront_file_formatter_view	Implements hook_file_formatter_FORMATTER_view().
mediafront_form_field_ui_field_edit_form_alter	Implementation of hook_form_FORM_ID_alter().