panels_optional_context Class Reference

Inheritance diagram for panels_optional_context:

[legend]

Collaboration diagram for panels_optional_context:

[legend]

List of all members.

---

Detailed Description

Definition at line 100 of file plugins.inc.

Public Member Functions
	add_empty (&$contexts)
	filter ($contexts)
	panels_optional_context ()
	select ($contexts, $context)

---

Member Function Documentation

panels_optional_context::add_empty

(

&$

contexts

)

Add the 'empty' context which is possible for optional

Definition at line 109 of file plugins.inc.

Referenced by filter(), and select().

                                 {
    $context = new panels_context('any');
    $context->title      = t('No context');
    $context->identifier = t('No context');
    $contexts = array_merge(array('empty' => $context), $contexts);
  }

Here is the caller graph for this function:

panels_optional_context::filter

(

$

contexts

)

Reimplemented from panels_required_context.

Definition at line 116 of file plugins.inc.

References add_empty().

                             {
    $this->add_empty($contexts);
    return parent::filter($contexts);
  }

Here is the call graph for this function:

panels_optional_context::panels_optional_context

(

)

Definition at line 101 of file plugins.inc.

                                     {
    $args = func_get_args();
    call_user_func_array(array($this, 'panels_required_context'), $args);
  }

panels_optional_context::select	(	$	contexts,
		$	context
	)

Reimplemented from panels_required_context.

Definition at line 121 of file plugins.inc.

References add_empty().

                                       {
    $this->add_empty($contexts);
    if (empty($context)) {
      return $contexts['empty'];
    }

    $result = parent::select($contexts, $context);

    // Don't flip out if it can't find the context; this is optional, put
    // in an empty.
    if ($result == FALSE) {
      $result = $contexts['empty'];
    }
    return $result;
  }

Here is the call graph for this function:

---

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)