123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167 |
- <?php
- /**
- * @file
- * Contains the flag Ops field handler.
- */
- /**
- * Views field handler for the Flag operations links (flag/unflag).
- *
- * @ingroup views
- */
- class flag_handler_field_ops extends views_handler_field {
- /**
- * Returns the flag object associated with our field.
- *
- * A field is in some relationship. This function reaches out for this
- * relationship and reads its 'flag' option, which holds the flag name.
- */
- function get_flag() {
- // When editing a view it's possible to delete the relationship (either by
- // error or to later recreate it), so we have to guard against a missing
- // one.
- if (isset($this->view->relationship[$this->options['relationship']])) {
- return $this->view->relationship[$this->options['relationship']]->get_flag();
- }
- }
- /**
- * Return the the relationship we're linked to. That is, the alias for its
- * table (which is suitbale for use with the various methods of the 'query'
- * object).
- */
- function get_parent_relationship() {
- $parent = $this->view->relationship[$this->options['relationship']]->options['relationship'];
- if (!$parent || $parent == 'none') {
- // Base query table.
- return NULL;
- }
- else {
- return $this->view->relationship[$parent]->alias;
- }
- }
- function option_definition() {
- $options = parent::option_definition();
- $options['link_type'] = array('default' => '');
- return $options;
- }
- function options_form(&$form, &$form_state) {
- parent::options_form($form, $form_state);
- $form['link_type'] = array(
- '#type' => 'radios',
- '#title' => t('Link type'),
- '#options' => array('' => t('Use flag link settings')) + _flag_link_type_options(),
- '#default_value' => $this->options['link_type'],
- );
- }
- /**
- * Override base ::query(). The purpose here is to make it possible for the
- * render() method to know two things: what's the content ID, and whether
- * it's flagged.
- */
- function query() {
- if (!($flag = $this->get_flag())) {
- // Error message is printed in render().
- return;
- }
- $info = $flag->get_views_info();
- $parent = $this->get_parent_relationship();
- // Find out if the content is flagged. We can't just peek at some field in
- // our loaded table because it doesn't always reflect the user browsing the
- // page. So we explicitly add the flagging table to find this out.
- // If the relationship is created with 'Current User' checked, we probably
- // already have the appropriate join. We just need the appropriate table
- // alias for that join. We look in the relationship settings to see if
- // user_scope is set to 'current' to determine this.
- $relationship = $this->view->relationship[$this->options['relationship']];
- if (isset($relationship->options['user_scope']) && $relationship->options['user_scope'] == 'current') {
- $table_alias = $relationship->alias;
- }
- // Otherwise, let's set up the alias, keeping it unique for this flag in
- // case there are multiple flag relationships in a single view.
- else {
- $table_alias = 'flagging_current_user_' . $flag->fid;
- }
- // Now that we have the table alias, let's see if it's already been joined
- // to. If it hasn't, we'll set up a join.
- if (!isset($this->query->table_queue[$table_alias])) {
- $join = new views_join();
- $join->construct('flagging', $info['views table'], $info['join field'], 'entity_id');
- $join->extra[] = array(
- 'field' => 'fid',
- 'value' => $flag->fid,
- 'numeric' => TRUE,
- );
- if (!$flag->global) {
- $join->extra[] = array(
- 'field' => 'uid',
- 'value' => '***CURRENT_USER***',
- 'numeric' => TRUE,
- );
- $join->extra[] = array(
- 'field' => 'sid',
- 'value' => '***FLAG_CURRENT_USER_SID***',
- 'numeric' => TRUE,
- );
- }
- $table_alias = $this->query->add_table($table_alias, $parent, $join);
- }
- $this->aliases['is_flagged'] = $this->query->add_field($table_alias, 'entity_id');
- // Next, find out the content ID. We can't add_field() on this table
- // (flagging), because its entity_id may be NULL (in case no user has
- // flagged this content, and it's a LEFT JOIN). So we reach to the parent
- // relationship and add_field() *its* content ID column.
- $left_table = $this->view->relationship[$this->options['relationship']]->table_alias;
- $this->aliases['entity_id'] = $this->query->add_field($left_table, $info['join field']);
- }
- /**
- * Find out if the flag applies to each item seen on the page. It's done in a
- * separate DB query to to avoid complexity and to make 'many to one' tests
- * (e.g. checking user roles) possible without causing duplicate rows.
- */
- function pre_render(&$values) {
- if (!($flag = $this->get_flag())) {
- // Error message is printed in render().
- return;
- }
- $ids = array();
- foreach ($values as $row) {
- $entity_id = $row->{$this->aliases['entity_id']};
- $is_flagged = $row->{$this->aliases['is_flagged']};
- if (isset($entity_id)) {
- $ids[$entity_id] = $is_flagged ? 'unflag' : 'flag';
- }
- }
- $this->flag_applies = $ids ? $flag->access_multiple($ids) : array();
- }
- function render($values) {
- if (!($flag = $this->get_flag())) {
- // get_flag() itself will print a more detailed message.
- return t('Missing flag');
- }
- $entity_id = $values->{$this->aliases['entity_id']};
- $is_flagged = $values->{$this->aliases['is_flagged']};
- if (empty($this->flag_applies[$entity_id])) {
- // Flag does not apply to this content.
- return;
- }
- if (!empty($this->options['link_type'])) {
- $flag->link_type = $this->options['link_type'];
- }
- return $flag->theme($is_flagged ? 'unflag' : 'flag', $entity_id);
- }
- }
|