class media_browser_plus_views_handler_area_navigation in Media Browser Plus 7.3

MBP navigation handler.

@todo Review / refactor to meet the proper views coding style.

Hierarchy

class \views_object
- class \views_handler
  - class \views_handler_area
    class \views_handler_area_view
    class \media_browser_plus_views_handler_area_navigation

Expanded class hierarchy of media_browser_plus_views_handler_area_navigation

2 string references to 'media_browser_plus_views_handler_area_navigation'

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_navigation.inc, line 15: Definition of media_browser_plus_views_handler_area_navigation.

View source

class media_browser_plus_views_handler_area_navigation extends views_handler_area_view {

  /**
   * Initialize the handler.
   *
   * This is kind of hackish, how is this done properly?
   *
   * @todo Review / refactor to meet the proper views coding style.
   */
  public function init(&$view, &$options) {
    parent::init($view, $options);

    // @todo Review / refactor to meet the proper views coding style.
    $this->table = 'field_data_field_folder';
  }

  /**
   * Define options.
   *
   * @todo Review / refactor to meet the proper views coding style.
   */
  public function option_definition() {
    $options = parent::option_definition();
    $this->definition['field'] = 'field_folder_tid';
    $options['table'] = array(
      'default' => 'field_data_field_folder',
    );
    $options['field'] = array(
      'default' => 'field_folder_tid',
    );
    return $options;
  }

  /**
   * Remove label from options form.
   */
  public function options_form(&$form, &$form_state) {
    $options = parent::options_form($form, $form_state);
    unset($form['label']);
    return $options;
  }

  /**
   * Add folder filter to the query.
   */
  public function query() {
    $root_folder = media_browser_plus_get_media_root_folder();
    if (!empty($this->view->exposed_data['mbp_current_folder'])) {
      $this->value = (int) $this->view->exposed_data['mbp_current_folder'];
      user_cookie_save(array(
        'mbp.current_folder' => $this->value,
      ));
    }
    elseif (!empty($_COOKIE['Drupal_visitor_mbp_current_folder']) && (int) $_COOKIE['Drupal_visitor_mbp_current_folder'] > 0) {
      $this->value = (int) $_COOKIE['Drupal_visitor_mbp_current_folder'];
    }
    else {
      $this->value = $root_folder->tid;
    }
    $this
      ->ensure_my_table();
    $where_group = 1;

    // Ensure folders is always an array.
    $folders = array(
      $this->value,
    );

    // If including subfolders is enabled fetch all child terms of the current
    // folder.
    if (isset($this->view->exposed_data['mbp_current_folder_include_subfolders']) && $this->view->exposed_data['mbp_current_folder_include_subfolders'] !== 0) {
      $taxonomy_tree = taxonomy_get_tree(taxonomy_vocabulary_machine_name_load('media_folders')->vid, $this->value);
      if (is_array($taxonomy_tree)) {
        foreach ($taxonomy_tree as $term) {
          $folders[] = (int) $term->tid;
        }
      }
    }

    // If this is the root folder also show files without a folder.
    if ($this->value == $root_folder->tid) {

      // Add new where group to use OR condition.
      $where_group = $this->query
        ->set_where_group('OR');
      $this->query
        ->add_where($where_group, "{$this->table_alias}.{$this->real_field}", $this->value, 'IS NULL');
    }
    $this->query
      ->add_where($where_group, "{$this->table_alias}.{$this->real_field}", $folders, 'IN');
  }

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

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

  /**
   * Doesn't output anything because it's hijacked by the MBP.
   *
   * @see template_preprocess_media_browser_plus_views_view_media_browser()
   * @see media_browser_plus_views_handler_area_navigation::render_custom()
   */
  public function render($empty = FALSE) {
  }

  /**
   * Called to embed the view into the sidebar of the media browser plus style.
   *
   * @see template_preprocess_media_browser_plus_views_view_media_browser()
   * @see media_browser_plus_views_handler_area_navigation::render_custom()
   */
  public function render_custom($empty = FALSE) {
    return parent::render($empty);
  }

  /**
   * Form element to track the media basket.
   */
  public function exposed_form(&$form, &$form_state) {
    $root_folder = media_browser_plus_get_media_root_folder();
    $folders = taxonomy_get_tree($root_folder->vid, $root_folder->tid);
    $folder_options = array(
      $root_folder->tid => $root_folder->name,
    );
    foreach ($folders as $folder) {
      $folder_options[$folder->tid] = str_repeat('-', $folder->depth + 1) . $folder->name;
    }
    $default_folder = $root_folder->tid;
    if (!empty($_COOKIE['Drupal_visitor_mbp_current_folder']) && (int) $_COOKIE['Drupal_visitor_mbp_current_folder'] > 0) {
      $default_folder = (int) $_COOKIE['Drupal_visitor_mbp_current_folder'];
    }
    $form['mbp_current_folder'] = array(
      '#type' => 'select',
      '#title' => t('Folder'),
      '#default_value' => $default_folder,
      '#options' => $folder_options,
      '#attributes' => array(
        'class' => array(
          'mbp-selected-folder',
        ),
      ),
    );

    // Add a checkbox to include subfolders in the view results.
    $form['mbp_current_folder_include_subfolders'] = array(
      '#type' => 'checkbox',
      '#title' => t('Include subfolders in results'),
      '#default_value' => 0,
    );
  }

}

Members

Name	Modifiers	Type	Description	Overrides
media_browser_plus_views_handler_area_navigation::can_expose	public	function	Always exposed. Overrides views_handler::can_expose
media_browser_plus_views_handler_area_navigation::exposed_form	public	function	Form element to track the media basket. Overrides views_handler::exposed_form
media_browser_plus_views_handler_area_navigation::init	public	function	Initialize the handler. Overrides views_handler_area::init
media_browser_plus_views_handler_area_navigation::is_exposed	public	function	Always expose. Overrides views_handler::is_exposed
media_browser_plus_views_handler_area_navigation::options_form	public	function	Remove label from options form. Overrides views_handler_area_view::options_form
media_browser_plus_views_handler_area_navigation::option_definition	public	function	Define options. Overrides views_handler_area_view::option_definition
media_browser_plus_views_handler_area_navigation::query	public	function	Add folder filter to the query. Overrides views_handler_area::query
media_browser_plus_views_handler_area_navigation::render	public	function	Doesn't output anything because it's hijacked by the MBP. Overrides views_handler_area_view::render
media_browser_plus_views_handler_area_navigation::render_custom	public	function	Called to embed the view into the sidebar of the media browser plus style.
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::label	public	function
views_handler_area::use_group_by	public	function	Area handlers shouldn't have groupby. Overrides views_handler::use_group_by
views_handler_area_view::loadView	protected	function	Loads the used view for rendering.
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

You are here

class media_browser_plus_views_handler_area_navigation in Media Browser Plus 7.3

Hierarchy

File

Members

API Navigation