You are here

Home » API reference » Views (for Drupal 7) 8.3 » Picture.php

class Picture in Views (for Drupal 7) 8.3

Field handler to provide simple renderer that allows using a themed user link.

Plugin annotation


@Plugin(
  id = "user_picture",
  module = "user"
)

Hierarchy

Expanded class hierarchy of Picture

Related topics

Views field handlers
Handlers to tell Views how to build and display fields.
1 string reference to 'Picture'
user_views_data in modules/user.views.inc
Implements hook_views_data().

File

lib/Views/user/Plugin/views/field/Picture.php, line 24
Definition of Views\user\Plugin\views\field\Picture.

Namespace

Views\user\Plugin\views\field
View source 
class Picture extends FieldPluginBase {

  /**
   * Overrides Drupal\views\Plugin\views\field\FieldPluginBase::init().
   */
  public function init(ViewExecutable $view, &$options) {
    parent::init($view, $options);
    $this->additional_fields['uid'] = 'uid';
    $this->additional_fields['name'] = 'name';
    $this->additional_fields['mail'] = 'mail';
  }
  function element_type($none_supported = FALSE, $default_empty = FALSE, $inline = FALSE) {
    if ($inline) {
      return 'span';
    }
    if ($none_supported) {
      if ($this->options['element_type'] === '0') {
        return '';
      }
    }
    if ($this->options['element_type']) {
      return check_plain($this->options['element_type']);
    }
    if ($default_empty) {
      return '';
    }
    if (isset($this->definition['element type'])) {
      return $this->definition['element type'];
    }
    return 'div';
  }
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['link_photo_to_profile'] = array(
      'default' => TRUE,
      'bool' => TRUE,
    );
    $options['image_style'] = array(
      'default' => '',
    );
    return $options;
  }
  public function buildOptionsForm(&$form, &$form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['link_photo_to_profile'] = array(
      '#title' => t("Link to user's profile"),
      '#description' => t("Link the user picture to the user's profile"),
      '#type' => 'checkbox',
      '#default_value' => $this->options['link_photo_to_profile'],
    );
    if (module_exists('image')) {
      $styles = image_styles();
      $style_options = array(
        '' => t('Default'),
      );
      foreach ($styles as $style) {
        $style_options[$style['name']] = $style['name'];
      }
      $form['image_style'] = array(
        '#title' => t('Image style'),
        '#description' => t('Using <em>Default</em> will use the site-wide image style for user pictures set in the <a href="!account-settings">Account settings</a>.', array(
          '!account-settings' => url('admin/config/people/accounts', array(
            'fragment' => 'edit-personalization',
          )),
        )),
        '#type' => 'select',
        '#options' => $style_options,
        '#default_value' => $this->options['image_style'],
      );
    }
  }
  function render($values) {
    if ($this->options['image_style'] && module_exists('image')) {

      // @todo: Switch to always using theme('user_picture') when it starts
      // supporting image styles. See http://drupal.org/node/1021564
      if ($picture_fid = $this
        ->get_value($values)) {
        $picture = file_load($picture_fid);
        $picture_filepath = $picture->uri;
      }
      else {
        $picture_filepath = variable_get('user_picture_default', '');
      }
      if (file_valid_uri($picture_filepath)) {
        $output = theme('image_style', array(
          'style_name' => $this->options['image_style'],
          'path' => $picture_filepath,
        ));
        if ($this->options['link_photo_to_profile'] && user_access('access user profiles')) {
          $uid = $this
            ->get_value($values, 'uid');
          $output = l($output, "user/{$uid}", array(
            'html' => TRUE,
          ));
        }
      }
      else {
        $output = '';
      }
    }
    else {

      // Fake an account object.
      $account = entity_create('user', array());
      if ($this->options['link_photo_to_profile']) {

        // Prevent template_preprocess_user_picture from adding a link
        // by not setting the uid.
        $account->uid = $this
          ->get_value($values, 'uid');
      }
      $account->name = $this
        ->get_value($values, 'name');
      $account->mail = $this
        ->get_value($values, 'mail');
      $account->picture = $this
        ->get_value($values);
      $output = theme('user_picture', array(
        'account' => $account,
      ));
    }
    return $output;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
FieldPluginBase::$additional_fields property Stores additional fields which get's added to the query. The generated aliases are stored in $aliases.
FieldPluginBase::$aliases property
FieldPluginBase::$field_alias property
FieldPluginBase::$original_value public property The field value prior to any rewriting.
FieldPluginBase::add_additional_fields function Add 'additional' fields to the query.
FieldPluginBase::add_self_tokens function Add any special tokens this field might use for itself. 4
FieldPluginBase::adminLabel public function Return a string representing this handler's name in the UI. Overrides HandlerBase::adminLabel 1
FieldPluginBase::adminSummary public function Provide extra data to the administration form Overrides HandlerBase::adminSummary
FieldPluginBase::advanced_render function Render a field using advanced settings.
FieldPluginBase::allow_advanced_render function Determine if this field can allow advanced rendering. 1
FieldPluginBase::click_sort function Called to determine what to tell the clicksorter. 1
FieldPluginBase::click_sortable function Determine if this field is click sortable. 1
FieldPluginBase::document_self_tokens function Document any special tokens this field might use for itself. 3
FieldPluginBase::element_classes function Return the class of the field.
FieldPluginBase::element_label_classes function Return the class of the field's label.
FieldPluginBase::element_label_type function Return an HTML element for the label based upon the field's element type.
FieldPluginBase::element_wrapper_classes function Return the class of the field's wrapper.
FieldPluginBase::element_wrapper_type function Return an HTML element for the wrapper based upon the field's element type.
FieldPluginBase::get_elements function Provide a list of elements valid for field HTML.
FieldPluginBase::get_entity function Get the entity matching the current row and relationship.
FieldPluginBase::get_render_tokens function Get the 'render' tokens to use for advanced rendering.
FieldPluginBase::get_token_values_recursive function Recursive function to add replacements for nested query string parameters.
FieldPluginBase::get_value function Get the value that's supposed to be rendered. 1
FieldPluginBase::is_value_empty function Checks if a field value is empty.
FieldPluginBase::label public function Get this field's label.
FieldPluginBase::pre_render function Run before any fields are rendered. 6
FieldPluginBase::query public function Called to add the field to a query. Overrides PluginBase::query 22
FieldPluginBase::render_altered function Render this field as altered text, from a fieldset set by the user.
FieldPluginBase::render_as_link function Render this field as a link, with the info from a fieldset set by the user.
FieldPluginBase::render_text function Perform an advanced text render for the item.
FieldPluginBase::render_trim_text function Trim the field down to the specified length.
FieldPluginBase::submitOptionsForm public function Performs some cleanup tasks on the options array before saving it. Overrides HandlerBase::submitOptionsForm
FieldPluginBase::theme function Call out to the theme() function, which probably just calls render() but allows sites to override output fairly easily.
FieldPluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. Overrides PluginBase::themeFunctions
FieldPluginBase::tokenize_value function Replace a value with tokens from the last field.
FieldPluginBase::use_string_group_by function Determines if this field will be available as an option to group the result by in the style settings.
HandlerBase::$actualField public property When a field has been moved this property is set.
HandlerBase::$actualTable public property When a table has been moved this property is set.
HandlerBase::$field public property With field you can override the realField if the real field is not set.
HandlerBase::$query public property Where the $query object will reside: 1
HandlerBase::$realField public property The actual field in the database table, maybe different on other kind of query plugins/special handlers.
HandlerBase::$relationship public property The relationship used for this field.
HandlerBase::$table public property The table this handler is attached to.
HandlerBase::$tableAlias public property The alias of the table of this handler which is used in the query.
HandlerBase::acceptExposedInput public function Take input from exposed handlers and assign to this handler, if necessary. 1
HandlerBase::access public function Check whether current user has access to this handler. 7
HandlerBase::breakPhrase public static function Breaks x,y,z and x+y+z into an array. Numeric only.
HandlerBase::breakPhraseString public static function Breaks x,y,z and x+y+z into an array. Works for strings.
HandlerBase::broken public function Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found. 6
HandlerBase::buildExposedForm public function Render our chunk of the exposed handler form when selecting 1
HandlerBase::buildExposeForm public function Form for exposed handler options. 2
HandlerBase::buildExtraOptionsForm public function Provide a form for setting options. 1
HandlerBase::buildGroupByForm public function Provide a form for aggregation settings. 1
HandlerBase::canExpose public function Determine if a handler can be exposed. 2
HandlerBase::caseTransform protected function Transform a string by a certain method.
HandlerBase::defaultExposeOptions public function Set new exposed option defaults when exposed setting is flipped on. 2
HandlerBase::defineExtraOptions public function Provide defaults for the handler.
HandlerBase::ensureMyTable public function Ensure the main table for this handler is in the query. This is used a lot. 8
HandlerBase::exposedInfo public function Get information about the exposed form for the form renderer. 1
HandlerBase::getField public function Shortcut to get a handler's raw field value.
HandlerBase::getJoin public function Get the join object that should be used for this handler.
HandlerBase::getSQLDateField public function Creates cross-database SQL dates.
HandlerBase::getSQLFormat public function Creates cross-database SQL date formatting.
HandlerBase::getTableJoin public static function Fetches a handler to join one table to a primary table from the data cache.
HandlerBase::getTimezone public static function Figure out what timezone we're in; needed for some date manipulations.
HandlerBase::hasExtraOptions public function If a handler has 'extra options' it will get a little settings widget and another form called extra_options. 1
HandlerBase::isAGroup public function Returns TRUE if the exposed filter works like a grouped filter. 1
HandlerBase::isExposed public function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
HandlerBase::multipleExposedInput 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
HandlerBase::placeholder protected function Provides a unique placeholders for handlers.
HandlerBase::postExecute public function Run after the view is executed, before the result is cached.
HandlerBase::preQuery public function Run before the view is built. 1
HandlerBase::sanitizeValue protected function Sanitize the value for output.
HandlerBase::setRelationship public function Called just prior to query(), this lets a handler set up any relationship it needs.
HandlerBase::showExposeButton public function Shortcut to display the expose/hide button. 2
HandlerBase::showExposeForm public function Shortcut to display the exposed options form.
HandlerBase::storeExposedInput public function If set to remember exposed input in the session, store it there. 1
HandlerBase::submitExposed public function Submit the exposed handler form
HandlerBase::submitExposeForm 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.
HandlerBase::submitExtraOptionsForm 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.
HandlerBase::submitGroupByForm 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
HandlerBase::usesGroupBy public function Provides the handler some groupby. 2
HandlerBase::validate public function Validates the handler against the complete View. Overrides PluginBase::validate 1
HandlerBase::validateExposed public function Validate the exposed handler form 4
HandlerBase::validateExposeForm public function Validate the options form. 1
HandlerBase::validateExtraOptionsForm public function Validate the options form.
HandlerBase::validateOptionsForm public function Validate the options form. Overrides PluginBase::validateOptionsForm 4
HandlerBase::__construct public function Constructs a Handler object. Overrides PluginBase::__construct
Picture::buildOptionsForm public function Default options form that provides the label widget that all fields should have. Overrides FieldPluginBase::buildOptionsForm
Picture::defineOptions protected function Information about options for all kinds of purposes will be held here. @code 'option_name' => array( Overrides FieldPluginBase::defineOptions
Picture::element_type function Return an HTML element based upon the field's element type. Overrides FieldPluginBase::element_type
Picture::init public function Overrides Drupal\views\Plugin\views\field\FieldPluginBase::init(). Overrides FieldPluginBase::init
Picture::render function Render the field. Overrides FieldPluginBase::render
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$definition public property Plugins's definition
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. 8
PluginBase::$view public property The top object of a view. 1
PluginBase::additionalThemeFunctions public function Provide a list of additional theme functions for the theme information page
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy public function Clears a plugin. 2
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::setOptionDefaults protected function
PluginBase::summaryTitle public function Returns the summary of the settings in the display. 6
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::usesOptions public function Returns the usesOptions property. 8