panels_required_context Class Reference

Inheritance diagram for panels_required_context:

[legend]

List of all members.

---

Detailed Description

This is used to explain to Panels what context is required.

Definition at line 67 of file plugins.inc.

Public Member Functions
	filter ($contexts)
	panels_required_context ()
	select ($contexts, $context)
Public Attributes
	$keywords = ''

---

Member Function Documentation

panels_required_context::filter

(

$

contexts

)

Reimplemented in panels_optional_context.

Definition at line 79 of file plugins.inc.

                             {
    $result = array();

    // See which of these contexts are valid
    foreach ($contexts as $cid => $context) {
      if ($context->is_type($this->keywords)) {
        $result[$cid] = $context;
      }
    }

    return $result;
  }

panels_required_context::panels_required_context

(

)

Definition at line 70 of file plugins.inc.

                                     {
    $args = func_get_args();
    $this->title = array_shift($args);
    if (count($args) == 1) {
      $args = array_shift($args);
    }
    $this->keywords = $args;
  }

panels_required_context::select	(	$	contexts,
		$	context
	)

Reimplemented in panels_optional_context.

Definition at line 92 of file plugins.inc.

                                       {
    if (empty($context) || empty($contexts[$context])) {
      return FALSE;
    }
    return $contexts[$context];
  }

---

Member Data Documentation

panels_required_context::$keywords = ''

Definition at line 68 of file plugins.inc.

---

The documentation for this class was generated from the following file:

• includes/plugins.inc (1.1.2.55 2008/11/12 19:58:57 sdboyer)