You are here

Home » API reference » Media Browser Plus 7.3 » media_browser_plus_views_handler_area_basket.inc

class media_browser_plus_views_handler_area_basket in Media Browser Plus 7.3

MBP area with file basket.

Hierarchy

Expanded class hierarchy of media_browser_plus_views_handler_area_basket

2 string references to 'media_browser_plus_views_handler_area_basket'
media_browser_plus_views_data_alter in views/media_browser_plus.views.inc
Implements hook_views_data_alter().
media_browser_plus_views_management in views/media_browser_plus.views_default.inc
View to display the folders in the library.

File

views/media_browser_plus_views_handler_area_basket.inc, line 13
Definition of media_browser_plus_views_handler_area_actions.

View source 
class media_browser_plus_views_handler_area_basket extends views_handler_area {

  /**
   * Has no options, so don't return a form.
   */
  public function options_form(&$form, &$form_state) {
  }

  /**
   * Returns the markup for the basket area.
   */
  public function render($empty = FALSE) {
    $output['mbp_basket'] = array(
      '#type' => 'fieldset',
      '#title' => t('Media Basket'),
      '#collapsed' => FALSE,
      '#collapsible' => FALSE,
      '#attributes' => array(
        'class' => array(
          'mbp-file-basket',
        ),
      ),
    );

    // Check if there are files in the basket, if so add them to the list.
    $selected_files = NULL;
    $fids = array();
    if (!empty($this->view->exposed_data['mbp_basket_files'])) {
      $fids = explode(' ', trim($this->view->exposed_data['mbp_basket_files']));

      // Save the basket into a cookie to make them more persistent.
      user_cookie_save(array(
        'mbp.basket' => implode(' ', $fids),
      ));
    }
    if (empty($fids) && isset($_COOKIE['Drupal_visitor_mbp_basket'])) {
      $fids = explode(' ', trim($_COOKIE['Drupal_visitor_mbp_basket']));
    }
    if (!empty($fids)) {

      // Sanitize.
      foreach ($fids as &$fid) {
        $fid = (int) $fid;
      }
      $file_query = new EntityFieldQuery();
      $files = $file_query
        ->entityCondition('entity_type', 'file')
        ->propertyCondition('fid', $fids)
        ->execute();
      if (!empty($files['file'])) {
        $file_entities = file_load_multiple(array_keys($files['file']));
        foreach ($file_entities as $file) {
          $preview = media_get_thumbnail_preview($file);
          $selected_files .= '<li id="media-item-' . $file->fid . '">' . render($preview) . '</li>';
        }
      }
    }
    $output['mbp_basket']['list'] = array(
      '#type' => 'markup',
      '#markup' => '<ul class="mbp-file-basket-list clearfix">' . $selected_files . '</ul>',
    );
    $output['mbp_basket']['download'] = array(
      '#type' => 'button',
      '#value' => t('Download files in Media Basket'),
      '#name' => 'mbp_basket_files_download',
    );
    $output = render($output);

    // Add javascript.
    drupal_add_js(array(
      'mbp' => array(
        'views' => array(
          $this->view->name . ':' . $this->view->current_display => array(
            'media_basket' => TRUE,
          ),
        ),
      ),
    ), 'setting');
    drupal_add_library('media_browser_plus', 'media_browser_plus.area_actions');

    // Hide this input from the pager. That way the cookie can do its work.
    unset($this->view->exposed_raw_input['mbp_basket_files']);
    return $output;
  }

  /**
   * Always exposed.
   */
  public function can_expose() {
    return TRUE;
  }

  /**
   * Always exposed.
   */
  public function is_exposed() {
    return TRUE;
  }

  /**
   * Form element to track the media basket.
   */
  public function exposed_form(&$form, &$form_state) {
    $default_value = NULL;
    if (isset($_COOKIE['Drupal_visitor_mbp_basket'])) {
      $fids = explode(' ', trim($_COOKIE['Drupal_visitor_mbp_basket']));

      // Sanitize.
      foreach ($fids as &$fid) {
        $fid = (int) $fid;
      }
      $default_value = implode(' ', array_filter($fids));
    }
    $form['mbp_basket_files'] = array(
      '#type' => 'hidden',
      '#title' => 'Media Basket selected files',
      '#default_value' => $default_value,
      '#attributes' => array(
        'class' => array(
          'mbp-basket-files',
        ),
      ),
    );
  }

}

Members

Namesort descending Modifiers Type Description Overrides
media_browser_plus_views_handler_area_basket::can_expose public function Always exposed. Overrides views_handler::can_expose
media_browser_plus_views_handler_area_basket::exposed_form public function Form element to track the media basket. Overrides views_handler::exposed_form
media_browser_plus_views_handler_area_basket::is_exposed public function Always exposed. Overrides views_handler::is_exposed
media_browser_plus_views_handler_area_basket::options_form public function Has no options, so don't return a form. Overrides views_handler_area::options_form
media_browser_plus_views_handler_area_basket::render public function Returns the markup for the basket area. Overrides views_handler_area::render
views_handler::$handler_type public property The type of the handler, for example filter/footer/field.
views_handler::$query public property Where the $query object will reside:. 1
views_handler::$real_field public property The actual field in the database table, maybe different on other kind of query plugins/special handlers.
views_handler::$relationship public property The relationship used for this field.
views_handler::$table_alias public property The alias of the table of this handler which is used in the query.
views_handler::$view public property The top object of a view. Overrides views_object::$view
views_handler::accept_exposed_input public function Take input from exposed handlers and assign to this handler, if necessary. 1
views_handler::access public function Check whether current user has access to this handler. 10
views_handler::broken public function Determine if the handler is considered 'broken'. 6
views_handler::case_transform public function Transform a string by a certain method.
views_handler::ensure_my_table public function Ensure the main table for this handler is in the query. This is used a lot. 8
views_handler::exposed_info public function Get information about the exposed form for the form renderer. 1
views_handler::exposed_submit public function Submit the exposed handler form.
views_handler::exposed_validate public function Validate the exposed handler form. 4
views_handler::expose_form public function Form for exposed handler options. 2
views_handler::expose_options public function Set new exposed option defaults when exposed setting is flipped on. 2
views_handler::expose_submit public function Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data.
views_handler::expose_validate public function Validate the options form. 1
views_handler::extra_options public function Provide defaults for the handler.
views_handler::extra_options_form public function Provide a form for setting options. 1
views_handler::extra_options_submit public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.
views_handler::extra_options_validate public function Validate the options form.
views_handler::get_field public function Shortcut to get a handler's raw field value.
views_handler::get_join public function Get the join object that should be used for this handler.
views_handler::groupby_form public function Provide a form for aggregation settings. 1
views_handler::groupby_form_submit public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. 1
views_handler::has_extra_options public function If a handler has 'extra options' it will get a little settings widget and another form called extra_options. 1
views_handler::is_a_group public function Returns TRUE if the exposed filter works like a grouped filter. 1
views_handler::multiple_exposed_input public function Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. 1
views_handler::needs_style_plugin public function Determine if the argument needs a style plugin. 1
views_handler::options_submit public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. 5
views_handler::options_validate public function Validate the options form. 4
views_handler::placeholder public function Provides a unique placeholders for handlers.
views_handler::post_execute public function Run after the view is executed, before the result is cached. 1
views_handler::pre_query public function Run before the view is built. 1
views_handler::sanitize_value public function Sanitize the value for output.
views_handler::set_relationship public function Called just prior to query(), this lets a handler set up any relationship it needs.
views_handler::show_expose_button public function Shortcut to display the expose/hide button. 2
views_handler::show_expose_form public function Shortcut to display the exposed options form.
views_handler::store_exposed_input public function If set to remember exposed input in the session, store it there. 1
views_handler::ui_name public function Return a string representing this handler's name in the UI. 9
views_handler::validate public function Validates the handler against the complete View. 1
views_handler_area::admin_summary public function Provide extra data to the administration form. Overrides views_handler::admin_summary
views_handler_area::init public function Init the handler with necessary data. Overrides views_handler::init
views_handler_area::label public function
views_handler_area::option_definition public function Information about options for all kinds of purposes will be held here. Overrides views_handler::option_definition 5
views_handler_area::query public function Don't run a query. 1
views_handler_area::use_group_by public function Area handlers shouldn't have groupby. Overrides views_handler::use_group_by
views_object::$definition public property Handler's definition.
views_object::$options public property Except for displays, options for the object will be held here. 1
views_object::altered_option_definition function Collect this handler's option definition and alter them, ready for use.
views_object::construct public function Views handlers use a special construct function. 4
views_object::destroy public function Destructor. 2
views_object::export_option public function 1
views_object::export_options public function
views_object::export_option_always public function Always exports the option, regardless of the default value.
views_object::options Deprecated public function Set default options on this object. 1
views_object::set_default_options public function Set default options.
views_object::set_definition public function Let the handler know what its full definition is.
views_object::unpack_options public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable public function Unpack a single option definition.
views_object::unpack_translatables public function Unpacks each handler to store translatable texts.
views_object::_set_option_defaults public function