panels_context Class Reference

Detailed Description

Forms the basis for describing and storing a context that a display might be running in.

Definition at line 15 of file plugins.inc.


Public Member Functions
	get_argument ()
	get_identifier ()
	get_keyword ()
	get_page_title ()
	get_title ()
	is_type ($type)
	panels_context ($type= 'none', $data=NULL)
Public Attributes
	$argument = NULL
	$data = NULL
	$identifier = ''
	$keyword = ''
	$page_title = ''
	$title = ''
	$type = NULL

Member Function Documentation

panels_context::get_argument ( )

Definition at line 43 of file plugins.inc.

00043                           {
00044     return $this->argument;
00045   }

panels_context::get_identifier ( )

Definition at line 51 of file plugins.inc.

00051                             {
00052     return $this->identifier;
00053   }

panels_context::get_keyword ( )

Definition at line 47 of file plugins.inc.

00047                          {
00048     return $this->keyword;
00049   }

panels_context::get_page_title ( )

Definition at line 59 of file plugins.inc.

00059                             {
00060     return $this->page_title;
00061   }

panels_context::get_title ( )

Definition at line 55 of file plugins.inc.

00055                        {
00056     return $this->title;
00057   }

panels_context::is_type ( $ type )

Definition at line 33 of file plugins.inc.

References $type.

00033                           {
00034     if ($type == 'any' || $this->type == 'any') {
00035       return TRUE;
00036     }
00037 
00038     $a = is_array($type) ? $type : array($type);
00039     $b = is_array($this->type) ? $this->type : array($this->type);
00040     return (bool) array_intersect($a, $b);
00041   }

panels_context::panels_context	(	$	type = `'none'`,
		$	data = `NULL`
	)

Definition at line 27 of file plugins.inc.

References $data, and $type.

00027                                                         {
00028     $this->type  = $type;
00029     $this->data  = $data;
00030     $this->title = t('Unknown context');
00031   }