You are here

Home » API reference » Role Expire 7 » role_expire.views.inc

class role_expire_handler_field_all in Role Expire 7

Class role_expire_handler_field_all.

This class is extended by role_expire_handler_field_expiry_timestamp.

Hierarchy

Expanded class hierarchy of role_expire_handler_field_all

See also

views_handler_field_user_roles.

views_handler_field_date.

1 string reference to 'role_expire_handler_field_all'
role_expire_views_data in ./role_expire.views.inc
Implementation of hook_views_data().

File

./role_expire.views.inc, line 103
Role Expire Views hooks

View source 
class role_expire_handler_field_all extends views_handler_field_prerender_list {

  /**
   * {@inheritdoc}
   */
  public function construct() {
    parent::construct();
    $this->additional_fields['uid'] = array(
      'table' => 'users',
      'field' => 'uid',
    );
  }

  /**
   * {@inheritdoc}
   */
  public function query() {
    $this
      ->add_additional_fields();
    $this->field_alias = $this->aliases['uid'];
  }

  /**
   * {@inheritdoc}
   */
  public function option_definition() {
    $options = parent::option_definition();
    $options['role_value'] = array(
      'default' => 'name',
    );
    $options['date_format'] = array(
      'default' => 'small',
    );
    $options['custom_date_format'] = array(
      'default' => '',
    );
    $options['timezone'] = array(
      'default' => '',
    );
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function options_form(&$form, &$form_state) {
    $form['role_value'] = array(
      '#type' => 'select',
      '#title' => t('Role display'),
      '#options' => array(
        'name' => t('Role name'),
        'rid' => t('Role ID'),
      ),
      '#default_value' => isset($this->options['role_value']) ? $this->options['role_value'] : 'name',
    );
    $date_formats = array();
    $date_types = system_get_date_types();
    foreach ($date_types as $key => $value) {
      $date_formats[$value['type']] = t('@date_format format', array(
        '@date_format' => $value['title'],
      )) . ': ' . format_date(REQUEST_TIME, $value['type']);
    }
    $form['date_format'] = array(
      '#type' => 'select',
      '#title' => t('Date format'),
      '#options' => $date_formats + array(
        'custom' => t('Custom'),
      ),
      '#default_value' => isset($this->options['date_format']) ? $this->options['date_format'] : 'small',
    );
    $form['custom_date_format'] = array(
      '#type' => 'textfield',
      '#title' => t('Custom date format'),
      '#description' => t('If "Custom", see the <a href="@url" target="_blank">PHP manual</a> for date formats. Otherwise, enter the number of different time units to display, which defaults to 2.', array(
        '@url' => 'http://php.net/manual/function.date.php',
      )),
      '#default_value' => isset($this->options['custom_date_format']) ? $this->options['custom_date_format'] : '',
      '#dependency' => array(
        'edit-options-date-format' => $this
          ->supported_date_types(),
      ),
    );
    $form['timezone'] = array(
      '#type' => 'select',
      '#title' => t('Timezone'),
      '#description' => t('Timezone to be used for date output.'),
      '#options' => array(
        '' => t('- Default site/user timezone -'),
      ) + system_time_zones(FALSE),
      '#default_value' => $this->options['timezone'],
      '#dependency' => array(
        'edit-options-date-format' => array_merge(array(
          'custom',
        ), array_keys($date_formats)),
      ),
    );
    parent::options_form($form, $form_state);
  }

  /**
   * Provide a list of all of the supported standard date types.
   *
   * @return array
   *   The list of supported formats.
   */
  protected function supported_date_types() {
    return array(
      'custom',
    );
  }
  function pre_render(&$values) {
    $uids = array();
    $this->items = array();
    foreach ($values as $result) {
      $uids[] = $this
        ->get_value($result, NULL, TRUE);
    }
    if ($uids) {
      $format = $this->options['date_format'];
      if (in_array($format, $this
        ->supported_date_types())) {
        $custom_format = $this->options['custom_date_format'];
      }
      else {
        $custom_format = '';
      }
      $result = db_query("SELECT e.uid, e.rid, e.expiry_timestamp, r.name FROM {role_expire} e INNER JOIN {role} r ON r.rid = e.rid WHERE e.uid IN (:uids) ORDER BY r.name", array(
        ':uids' => $uids,
      ));
      foreach ($result as $role) {
        $timezone = !empty($this->options['timezone']) ? $this->options['timezone'] : NULL;
        $expirationDate = format_date(check_plain($role->expiry_timestamp), $format, $custom_format, $timezone);
        $this->items[$role->uid][$role->rid]['role'] = check_plain($role->name) . ' (' . $expirationDate . ')';
        $this->items[$role->uid][$role->rid]['rid'] = $role->rid . ' (' . $expirationDate . ')';
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function render_item($count, $item) {
    $format = $this->options['role_value'];
    if ($format == 'rid') {
      return $item['rid'];
    }
    return $item['role'];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
role_expire_handler_field_all::construct public function Construct a new field handler. Overrides views_handler_field::construct
role_expire_handler_field_all::options_form public function Default options form provides the label widget that all fields should have. Overrides views_handler_field_prerender_list::options_form
role_expire_handler_field_all::option_definition public function Information about options for all kinds of purposes will be held here. Overrides views_handler_field_prerender_list::option_definition
role_expire_handler_field_all::pre_render function Run before any fields are rendered. Overrides views_handler_field::pre_render
role_expire_handler_field_all::query public function Called to add the field to a query. Overrides views_handler_field::query
role_expire_handler_field_all::render_item public function
role_expire_handler_field_all::supported_date_types protected function Provide a list of all of the supported standard date types.
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::can_expose public function Determine if a handler can be exposed. 2
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_form public function Render our chunk of the exposed handler form when selecting. 1
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::is_exposed public function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
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_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::use_group_by public function Provides the handler some groupby. 2
views_handler::validate public function Validates the handler against the complete View. 1
views_handler_field::$additional_fields public property Stores additional fields which get added to the query. The generated aliases are stored in $aliases.
views_handler_field::$aliases public property
views_handler_field::$field_alias public property
views_handler_field::$last_render_index protected property Keeps track of the last render index.
views_handler_field::$original_value public property The field value prior to any rewriting.
views_handler_field::add_additional_fields public function Add 'additional' fields to the query.
views_handler_field::add_self_tokens public function Add any special tokens this field might use for itself. 4
views_handler_field::admin_summary public function Provide extra data to the administration form Overrides views_handler::admin_summary
views_handler_field::advanced_render public function Render a field using advanced settings.
views_handler_field::click_sort public function Called to determine what to tell the clicksorter. 1
views_handler_field::click_sortable public function Determine if this field is click sortable. 1
views_handler_field::document_self_tokens public function Document any special tokens this field might use for itself. 4
views_handler_field::element_classes public function Return the class of the field.
views_handler_field::element_label_classes public function Return the class of the field's label.
views_handler_field::element_label_type public function Return an HTML element for the label based upon the field's element type.
views_handler_field::element_type public function Return an HTML element based upon the field's element type. 2
views_handler_field::element_wrapper_classes public function Return the class of the field's wrapper.
views_handler_field::element_wrapper_type public function Return an HTML element for the wrapper based upon the field's element type.
views_handler_field::get_elements public function Provide a list of elements valid for field HTML.
views_handler_field::get_render_tokens public function Get the 'render' tokens to use for advanced rendering.
views_handler_field::get_token_values_recursive public function Recursive function to add replacements for nested query string parameters.
views_handler_field::init public function Init the handler with necessary data. Overrides views_handler::init 11
views_handler_field::is_value_empty public function Checks if a field value is empty.
views_handler_field::label public function Get this field's label.
views_handler_field::options_submit public function Performs some cleanup tasks on the options array before saving it. Overrides views_handler::options_submit 1
views_handler_field::render_altered public function Render this field as altered text, from a fieldset set by the user.
views_handler_field::render_as_link public function Render this field as a link, with info from a fieldset set by the user.
views_handler_field::render_text public function Perform an advanced text render for the item.
views_handler_field::render_trim_text public function Trim the field down to the specified length.
views_handler_field::theme public function Call out to the theme() function.
views_handler_field::theme_functions public function Build a list of suitable theme functions for this view.
views_handler_field::tokenize_value public function Replace a value with tokens from the last field.
views_handler_field::ui_name public function Return a string representing this handler's name in the UI. Overrides views_handler::ui_name 1
views_handler_field::use_string_group_by public function Determines if this field will be available as an option to group the result by in the style settings.
views_handler_field_prerender_list::$items public property Stores all items which are used to render the items.
views_handler_field_prerender_list::allow_advanced_render public function Determine if advanced rendering is allowed. Overrides views_handler_field::allow_advanced_render
views_handler_field_prerender_list::get_items public function Return an array of items for the field.
views_handler_field_prerender_list::get_value public function Get the value that's supposed to be rendered. Overrides views_handler_field::get_value
views_handler_field_prerender_list::render public function Render the field. Overrides views_handler_field::render
views_handler_field_prerender_list::render_items public function Render all items in this field together.
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::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