You are here

Home » API reference » Views Atom 7 » views_atom_handler_area_atom_tombstone.inc

class views_atom_handler_area_atom_tombstone in Views Atom 7

Hierarchy

Expanded class hierarchy of views_atom_handler_area_atom_tombstone

1 string reference to 'views_atom_handler_area_atom_tombstone'
views_atom_views_data in ./views_atom.views.inc
Implements hook_views_data().

File

includes/views_atom_handler_area_atom_tombstone.inc, line 12
Views area text handler.

View source 
class views_atom_handler_area_atom_tombstone extends views_handler_area_text {
  function option_definition() {
    $options = parent::option_definition();
    $options['feed_url'] = array(
      'default' => NULL,
    );
    $options['hub_url'] = array(
      'default' => NULL,
    );
    $options['item_url'] = array(
      'default' => NULL,
    );
    $options['use_push'] = array(
      'default' => FALSE,
    );

    // @todo, options could be added for updated, and email and name.
    return $options;
  }
  function options_form(&$form, &$form_state) {
    $form['use_push'] = array(
      '#type' => 'checkbox',
      // @todo better title?
      '#title' => t('Use Push Hub'),
      '#default_value' => $this->options['use_push'],
    );
    $form['hub_url'] = array(
      '#title' => 'Hub URL',
      '#type' => 'textfield',
      '#default_value' => $this->options['hub_url'],
      // @todo, better description.
      '#description' => t('Enter an absolute path of a pubsubhubbub URL. You can also enter a path relative to this site which will then be transformed into an absolute.'),
      '#dependency' => array(
        'edit-options-use-push' => array(
          1,
        ),
      ),
    );
    $form['feed_url'] = array(
      '#title' => 'Feed URL',
      '#type' => 'textfield',
      '#default_value' => $this->options['feed_url'],
      // @todo, better description.
      '#description' => t('Enter an absolute path of a feed URL. You can also enter a path relative to this site which will then be transformed into an absolute.'),
    );
    $form['item_url'] = array(
      '#title' => 'Item URL',
      '#type' => 'textfield',
      '#default_value' => $this->options['item_url'],
      // @todo, better description.
      '#description' => t('Enter an absolute path of the item to delete. You can also enter a path relative to this site which will then be transformed into an absolute.'),
    );
    parent::options_form($form, $form_state);
    unset($form['content']);
  }
  function options_submit(&$form, &$form_state) {

    // Redeclaring this blank method prevents the parent, views_handler_area_text,
    // from acting on the non-existent content variable.
  }

  // @todo, What is this parameter for?
  function render($empty = FALSE) {
    if (!$empty || !empty($this->options['empty'])) {
      $updated = date('c', REQUEST_TIME);

      // If we are using the REQUEST as the updated variable then we don't really
      // know when the entity was deleted and a human-readable comment will be set.
      $show_updated_comment = TRUE;
      $tombstone_array = array(
        // @todo, what should title be, a field?
        'title' => t('Atom Tombstone'),
        'use_push' => $this->options['use_push'],
        'hub_url' => $this
          ->render_option_as_url('hub_url'),
        'feed_url' => $this
          ->render_option_as_url('feed_url'),
        'updated' => $updated,
        'show_updated_comment' => $show_updated_comment,
        'items' => array(),
      );
      if (!empty($this->options['item_url'])) {

        // @todo, security on tokenize? What happens if something maliscious is used in "!1" ?
        $tombstone_array['items'][] = array(
          'guid' => $this
            ->render_option_as_url('item_url'),
          'when' => $updated,
        );
      }
      return theme('views_atom_tombstone', $tombstone_array);
    }
    return '';
  }

  /**
   * Render a text area, using the proper format.
   */
  function render_option_as_url($option_name) {
    if (!empty($this->options[$option_name])) {
      if ($this->options['tokenize']) {
        $value = $this->view->style_plugin
          ->tokenize_value($this->options[$option_name], 0);
      }
      else {
        $value = $this->options[$option_name];
      }
      return url($value, array(
        'absolute' => TRUE,
      ));
    }
    else {
      return '';
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
views_atom_handler_area_atom_tombstone::options_form function Default options form that provides the label widget that all fields should have. Overrides views_handler_area_text::options_form
views_atom_handler_area_atom_tombstone::options_submit function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. Overrides views_handler_area_text::options_submit
views_atom_handler_area_atom_tombstone::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_handler_area_text::option_definition
views_atom_handler_area_atom_tombstone::render function Render the area. Overrides views_handler_area_text::render
views_atom_handler_area_atom_tombstone::render_option_as_url function Render a text area, using the proper format.
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::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::init public function Init the handler with necessary data. Overrides views_handler::init
views_handler_area::label public function
views_handler_area::query public function Don't run a query. 1
views_handler_area::use_group_by public function Area handlers shouldn't have groupby. Overrides views_handler::use_group_by
views_handler_area_text::render_textarea public function Render a text area, using the proper format.
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