PHPXRef 0.7 : Drupal 6 (gatewave) : Detail view of context.inc

Class: ctools_context - X-Ref

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.

ctools_context($type = 'none', $data = NULL) X-Ref

No description

is_type($type) X-Ref

No description

get_argument() X-Ref

No description

get_original_argument() X-Ref

No description

get_keyword() X-Ref

No description

get_identifier() X-Ref

No description

get_title() X-Ref

No description

get_page_title() X-Ref

No description

Class: ctools_context_required - X-Ref

Used to create a method of comparing if a list of contexts
match a required context type.

ctools_context_required($title) X-Ref

param: $title
param: ...

filter($contexts) X-Ref

No description

select($contexts, $context) X-Ref

No description

Class: ctools_context_optional - X-Ref

Used to compare to see if a list of contexts match an optional context. This
can produce empty contexts to use as placeholders.

ctools_context_optional() X-Ref

No description

add_empty(&$contexts) X-Ref

Add the 'empty' context which is possible for optional

filter($contexts) X-Ref

No description

select($contexts, $context) X-Ref

No description

ctools_context_filter($contexts, $required) X-Ref

Return a keyed array of context that match the given 'required context'
filters.

Functions or systems that require contexts of a particular type provide a
ctools_context_required or ctools_context_optional object. This function
examines that object and an array of contexts to determine which contexts
match the filter.

Since multiple contexts can be required, this function will accept either
an array of all required contexts, or just a single required context object.

param: $contexts
param: $required
return:

_ctools_context_filter($contexts, $required) X-Ref

No description

ctools_context_selector($contexts, $required, $default) X-Ref

Create a select box to choose possible contexts.

This only creates a selector if there is actually a choice; if there
is only one possible context, that one is silently assigned.

If an array of required contexts is provided, one selector will be
provided for each context.

param: $contexts
param: $required
return:

_ctools_context_selector($contexts, $required, $default, $num = 0) X-Ref

No description

ctools_context_match_requirements($contexts, $required) X-Ref

Are there enough contexts for a plugin?

Some plugins can have a 'required contexts' item which can either
be a context requirement object or an array of them. When contexts
are required, items that do not have enough contexts should not
appear. This tests an item to see if it has enough contexts
to actually appear.

param: $contexts
param: $required
return:

ctools_context_converter_selector($contexts, $required, $default) X-Ref

_ctools_context_converter_selector($contexts, $required, $default, $num = 0) X-Ref

No description

ctools_context_get_converters($cid, $context) X-Ref

Get a list of converters available for a given context.

_ctools_context_get_converters($id, $plugin_name) X-Ref

Get a list of converters available for a given context.

ctools_context_get_all_converters() X-Ref

Get a list of all contexts + converters available.

ctools_context_convert_context($context, $converter) X-Ref

Let the context convert an argument based upon the converter that was given.

ctools_context_select($contexts, $required, $context) X-Ref

Choose a context or contexts based upon the selection made via
ctools_context_filter.

param: $contexts
param: $required
param: $context

_ctools_context_select($contexts, $required, $context) X-Ref

No description

ctools_context_create($type, $data = NULL, $conf = FALSE) X-Ref

Create a new context object.

param: $type
param: $data
param: $empty
param: $conf
return:

ctools_context_create_empty($type) X-Ref

Create an empty context object.

Empty context objects are primarily used as placeholders in the UI where
the actual contents of a context object may not be known. It may have
additional text embedded to give the user clues as to how the context
is used.

param: $type
return:

ctools_context_keyword_substitute($string, $keywords, $contexts) X-Ref

Perform keyword and context substitutions.

ctools_context_id($context, $type = 'context') X-Ref

Determine a unique context ID for a context

Often contexts of many different types will be placed into a list. This
ensures that even though contexts of multiple types may share IDs, they
are unique in the final list.

ctools_context_next_id($objects, $name) X-Ref

Get the next id available given a list of already existing objects.

This finds the next id available for the named object.

param: $objects
param: $name

ctools_get_argument($argument) X-Ref

Fetch metadata on a specific argument plugin.

param: $argument
return:

ctools_get_arguments() X-Ref

Fetch metadata for all argument plugins.

return:

ctools_context_get_context_from_argument($argument, $arg, $empty = FALSE) X-Ref

Get a context from an argument.

param: $argument
param: $arg
param: $empty
return:

ctools_context_get_placeholders_from_argument($arguments) X-Ref

Retrieve a list of empty contexts for all arguments.

ctools_context_get_context_from_arguments($arguments, &$contexts, $args) X-Ref

Load the contexts for a given list of arguments.

param: $arguments
param: &$contexts
param: $args
return:

ctools_get_relationship($relationship) X-Ref

Fetch metadata on a specific relationship plugin.

param: $content type
return:

ctools_get_relationships() X-Ref

Fetch metadata for all relationship plugins.

return:

ctools_context_get_context_from_relationship($relationship, $source_context, $placeholders = FALSE) X-Ref

param: $relationship
param: $source_context
param: $placeholders
return:

ctools_context_get_relevant_relationships($contexts) X-Ref

Fetch all relevant relationships.

Relevant relationships are any relationship that can be created based upon
the list of existing contexts. For example, the 'node author' relationship
is relevant if there is a 'node' context, but makes no sense if there is
not one.

param: $contexts
return:

ctools_context_get_context_from_relationships($relationships, &$contexts, $placeholders = FALSE) X-Ref

Fetch all active relationships

param: $relationships
param: $contexts
param: $placeholders

ctools_get_context($context) X-Ref

Fetch metadata on a specific context plugin.

param: $context
return:

ctools_get_contexts() X-Ref

Fetch metadata for all context plugins.

return:

ctools_context_get_context_from_context($context, $type = 'context', $argument = NULL) X-Ref

param: $context
param: $type
return:

ctools_context_get_context_from_contexts($contexts, $type = 'context', $placeholders = FALSE) X-Ref

Retrieve a list of base contexts based upon a simple 'contexts' definition.

For required contexts this will always retrieve placeholders.

param: $contexts
param: $type
param: $placeholders

ctools_context_match_required_contexts($required, $contexts) X-Ref

Match up external contexts to our required contexts.

This function is used to create a list of contexts with proper
IDs based upon a list of required contexts.

These contexts passed in should match the numeric positions of the
required contexts. The caller must ensure this has already happened
correctly as this function will not detect errors here.

param: $required
param: $contexts

ctools_context_load_contexts($object, $placeholders = TRUE, $contexts = array() X-Ref

Load a full array of contexts for an object.

Not all of the types need to be supported by this object.

This function is not used to load contexts from external data, but may
be used to load internal contexts and relationships. Otherwise it can also
be used to generate a full set of placeholders for UI purposes.

param: $object
param: $placeholders
param: $contexts

ctools_context_get_form($contexts) X-Ref

Return the first context with a form id from a list of contexts.

This function is used to figure out which contexts represents 'the form'
from a list of contexts. Only one contexts can actually be 'the form' for
a given page, since the @code{<form>} tag can not be embedded within
itself.

ctools_context_replace_placeholders($contexts, $arguments) X-Ref

Replace placeholders with real contexts using data extracted from a form
for the purposes of previews.

param: $contexts
param: $arguments
return:

ctools_context_replace_form(&$form, $contexts) X-Ref

Provide a form array for getting data to replace placeholder contexts
with real data.

ctools_get_access_plugin($name) X-Ref

Fetch metadata on a specific access control plugin.

param: $name
return:

ctools_get_access_plugins() X-Ref

Fetch metadata for all access control plugins.

return:

ctools_get_relevant_access_plugins($contexts) X-Ref

Fetch a list of access plugins that are available for a given list of
contexts.

if 'logged-in-user' is not in the list of contexts, it will be added as
this is required.

ctools_access_get_loggedin_context() X-Ref

Create a context for the logged in user.

ctools_access_summary($plugin, $contexts, $test) X-Ref

Get a summary of an access plugin's settings.

ctools_access_group_summary($access, $contexts) X-Ref

Get a summary of a group of access plugin's settings.

ctools_access($settings, $contexts = array() X-Ref

Determine if the current user has access via plugin.

param: $settings
param: $contexts
return:

ctools_access_new_test($plugin) X-Ref

Create default settings for a new access plugin.

param: $plugin
return:

ctools_access_add_restrictions($settings, $contexts) X-Ref

Apply restrictions to contexts based upon the access control configured.

These restrictions allow the UI to not show content that may not
be relevant to all types of a particular context.

File Size:	1538 lines (46 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

PHP Cross Reference of Drupal 6 (gatewave)

/sites/all/modules/ctools/includes/ -> context.inc (summary)

Defines 3 classes