class flag_handler_relationship_content in Flag 6.2

Specialized relationship handler associating flags and content.

Hierarchy

• class \flag_handler_relationship extends \views_handler_relationship
  • class \flag_handler_relationship_content

1 string reference to 'flag_handler_relationship_content'

flag_views_data_alter in includes/flag.views.inc

Implements hook_views_data_alter().

File

includes/flag_handler_relationships.inc, line 84

Contains various relationship handlers.

class flag_handler_relationship_content extends flag_handler_relationship {
  function option_definition() {
    $options = parent::option_definition();
    $options['user_scope'] = array(
      'default' => 'current',
    );
    return $options;
  }
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $content_type = $this->definition['flag type'];
    $form['label']['#description'] .= ' ' . t('The name of the selected flag makes a good label.');
    $form['flag'] = flag_views_flag_config_form('radios', $content_type, $this->options['flag']);
    $form['user_scope'] = array(
      '#type' => 'radios',
      '#title' => t('By'),
      '#options' => array(
        'current' => t('Current user'),
        'any' => t('Any user'),
      ),
      '#default_value' => $this->options['user_scope'],
    );
    $form['required']['#title'] = t('Include only flagged content');
    $form['required']['#description'] = t('If checked, only content that has this flag will be included. Leave unchecked to include all content; or, in combination with the <em>Flagged</em> filter, <a href="@unflagged-url">to limit the results to specifically unflagged content</a>.', array(
      '@unflagged-url' => 'http://drupal.org/node/299335',
    ));
    if (!$form['flag']['#options']) {
      $form = array(
        'error' => array(
          '#value' => '<p class="error form-item">' . t('No %type flags exist. You must first <a href="@create-url">create a %type flag</a> before being able to use this relationship type.', array(
            '%type' => $content_type,
            '@create-url' => url('admin/build/flags'),
          )) . '</p>',
        ),
      );
      $form_state['no flags exist'] = TRUE;
    }
    if (module_exists('session_api')) {
      $form['session_warning'] = array(
        '#value' => '<p class="warning form-item">' . t('<strong>Warning</strong>: Adding this relationship for any flag that contains <strong>anonymous flagging access</strong> will disable page caching for anonymous users when this view is executed. (But this is only true when the relationship is constrained to "Current user", not to "Any user".) It is recommended to create a dedicated page for views containing anonymous user data.') . '</p>',
      );
    }
  }
  function options_validate($form, &$form_state) {
    if (!empty($form_state['no flags exist'])) {
      form_error($form, t('You must first create a flag'));
    }
  }
  function admin_summary() {
    return $this->options['user_scope'] == 'current' ? t('by current user') : t('by any user');
  }
  function ui_name($short = FALSE) {

    // We put the bookmark name in the UI string to save space.
    return t('!group: !title', array(
      '!group' => $this->definition['group'],
      '!title' => empty($this->options['flag']) ? t('(Please select a flag)') : $this->options['flag'],
    ));
  }

  /**
   * Called to implement a relationship in a query.
   */
  function query() {
    if (!($flag = $this
      ->get_flag())) {
      return;
    }
    $this->definition['extra'][] = array(
      'field' => 'fid',
      'value' => $flag->fid,
      'numeric' => TRUE,
    );
    if ($this->options['user_scope'] == 'current' && !$flag->global) {
      $this->definition['extra'][] = array(
        'field' => 'uid',
        'value' => '***CURRENT_USER***',
        'numeric' => TRUE,
      );
      if (array_search(DRUPAL_ANONYMOUS_RID, $flag->roles['flag']) !== FALSE) {

        // Disable page caching for anonymous users.
        $GLOBALS['conf']['cache'] = 0;

        // Add in the SID from Session API for anonymous users.
        $this->definition['extra'][] = array(
          'field' => 'sid',
          'value' => '***FLAG_CURRENT_USER_SID***',
          'numeric' => TRUE,
        );
      }
    }
    parent::query();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
flag_handler_relationship::get_flag		function	Returns the flag object.
flag_handler_relationship::get_flag_type		function
flag_handler_relationship::validate		function	Make sure the flag exists.
flag_handler_relationship_content::admin_summary		function
flag_handler_relationship_content::options_form		function
flag_handler_relationship_content::options_validate		function
flag_handler_relationship_content::option_definition		function	Every relationship has a 'flag' option. Overrides flag_handler_relationship::option_definition
flag_handler_relationship_content::query		function	Called to implement a relationship in a query.
flag_handler_relationship_content::ui_name		function