class ctools_context in Chaos Tool Suite (ctools) 6

The context object is largely a wrapper around some other object, with an interface to finding out what is contained and getting to both the object and information about the object.

Each context object has its own information, but some things are very common, such as titles, data, keywords, etc. In particulare, the 'type' of the context is important.

Hierarchy

• class \ctools_context

3 string references to 'ctools_context'

ctools_access_menu in ./ctools.module

Determine if the current user has access via a plugin.

page_manager_page_execute in page_manager/plugins/tasks/page.inc

Execute a page task.

views_content_plugin_display_ctools_context::option_definition in views_content/plugins/views/views_content_plugin_display_ctools_context.inc

File

includes/context.inc, line 30

Contains code related to the ctools system of 'context'.

class ctools_context {
  var $type = NULL;
  var $data = NULL;

  // The title of this object.
  var $title = '';

  // The title of the page if this object exists
  var $page_title = '';

  // The identifier (in the UI) of this object
  var $identifier = '';
  var $argument = NULL;
  var $keyword = '';
  var $original_argument = NULL;
  var $restrictions = array();
  var $empty = FALSE;
  function ctools_context($type = 'none', $data = NULL) {
    $this->type = $type;
    $this->data = $data;
    $this->title = t('Unknown context');
  }
  function is_type($type) {
    if ($type == 'any' || $this->type == 'any') {
      return TRUE;
    }
    $a = is_array($type) ? $type : array(
      $type,
    );
    $b = is_array($this->type) ? $this->type : array(
      $this->type,
    );
    return (bool) array_intersect($a, $b);
  }
  function get_argument() {
    return $this->argument;
  }
  function get_original_argument() {
    if (!is_null($this->original_argument)) {
      return $this->original_argument;
    }
    return $this->argument;
  }
  function get_keyword() {
    return $this->keyword;
  }
  function get_identifier() {
    return $this->identifier;
  }
  function get_title() {
    return $this->title;
  }
  function get_page_title() {
    return $this->page_title;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ctools_context::$argument		property
ctools_context::$data		property
ctools_context::$empty		property
ctools_context::$identifier		property
ctools_context::$keyword		property
ctools_context::$original_argument		property
ctools_context::$page_title		property
ctools_context::$restrictions		property
ctools_context::$title		property
ctools_context::$type		property
ctools_context::ctools_context		function
ctools_context::get_argument		function
ctools_context::get_identifier		function
ctools_context::get_keyword		function
ctools_context::get_original_argument		function
ctools_context::get_page_title		function
ctools_context::get_title		function
ctools_context::is_type		function