[ Index ]

PHP Cross Reference of Drupal 6 (gatewave)

title

Body

[close]

/sites/all/modules/views/includes/ -> handlers.inc (summary)

[Source view] [Print] [Project Stats]

(no description)

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

Defines 3 classes

views_handler:: (29 methods):
  init()
  ui_name()
  options_form()
  options_validate()
  options_submit()
  has_extra_options()
  extra_options()
  extra_options_form()
  extra_options_validate()
  extra_options_submit()
  expose_options()
  exposed_form()
  exposed_validate()
  exposed_submit()
  exposed_info()
  can_expose()
  access()
  pre_query()
  set_relationship()
  query()
  ensure_my_table()
  admin_summary()
  needs_style_plugin()
  is_exposed()
  accept_exposed_input()
  store_exposed_input()
  get_join()
  validate()
  broken()

views_many_to_one_helper:: (15 methods):
  views_many_to_one_helper()
  option_definition()
  options_form()
  get_field()
  add_table()
  get_join()
  summary_join()
  ensure_my_table()
  add_filter()
  views_break_phrase()
  views_get_timezone()
  views_date_sql_field()
  views_date_sql_format()
  views_date_sql_extract()
  views_views_handlers()

views_join:: (20 methods):
  construct()
  join()
  db_safe()
  views_views_api()
  aggregator_views_api()
  book_views_api()
  comment_views_api()
  locale_views_api()
  filter_views_api()
  node_views_api()
  poll_views_api()
  profile_views_api()
  search_views_api()
  statistics_views_api()
  system_views_api()
  taxonomy_views_api()
  translation_views_api()
  upload_views_api()
  user_views_api()
  contact_views_api()

Defines 20 functions

  _views_create_handler()
  views_include_handler()
  _views_prepare_handler()
  views_fetch_handler_data()
  views_discover_handlers()
  views_get_table_join()

Class: views_handler  - X-Ref

Base handler, from which all the other handlers are derived.
It creates a common interface to create consistency amongst
handlers and data.

This class would be abstract in PHP5, but PHP4 doesn't understand that.

Definition terms:
- table: The actual table this uses; only specify if different from
the table this is attached to.
- real field: The actual field this uses; only specify if different from
the field this item is attached to.
- group: A text string representing the 'group' this item is attached to,
for display in the UI. Examples: "Node", "Taxonomy", "Comment",
"User", etc. This may be inherited from the parent definition or
the 'table' definition.
- title: The title for this handler in the UI. This may be inherited from
the parent definition or the 'table' definition.
- help: A more informative string to give to the user to explain what this
field/handler is or does.
- access callback: If this field should have access control, this could
be a function to use. 'user_access' is a common
function to use here. If not specified, no access
control is provided.
- access arguments: An array of arguments for the access callback.
init(&$view, $options)   X-Ref
init the handler with necessary data.

param: $view
param: $options

ui_name($short = FALSE)   X-Ref
Return a string representing this handler's name in the UI.


options_form(&$form, &$form_state)   X-Ref
Provide a form for setting options.


options_validate($form, &$form_state)   X-Ref
Validate the options form.


options_submit($form, &$form_state)   X-Ref
Perform any necessary changes to the form values prior to storage.
There is no need for this function to actually store the data.


has_extra_options()   X-Ref
If a handler has 'extra options' it will get a little settings widget and
another form called extra_options.


extra_options(&$option)   X-Ref
Provide defaults for the handler.


extra_options_form(&$form, &$form_state)   X-Ref
Provide a form for setting options.


extra_options_validate($form, &$form_state)   X-Ref
Validate the options form.


extra_options_submit($form, &$form_state)   X-Ref
Perform any necessary changes to the form values prior to storage.
There is no need for this function to actually store the data.


expose_options()   X-Ref
Set new exposed option defaults when exposed setting is flipped
on.


exposed_form(&$form, &$form_state)   X-Ref
Render our chunk of the exposed filter form when selecting


exposed_validate(&$form, &$form_state)   X-Ref
Validate the exposed filter form


exposed_submit(&$form, &$form_state)   X-Ref
Submit the exposed filter form


exposed_info()   X-Ref
Get information about the exposed form for the form renderer.

return:

can_expose()   X-Ref
Determine if a handler can be exposed.


access()   X-Ref
Check whether current user has access to this handler.

return: boolean

pre_query()   X-Ref
Run before the view is built.

This gives all the handlers some time to set up before any handler has
been fully run.

set_relationship()   X-Ref
Called just prior to query(), this lets a handler set up any relationship
it needs.


query()   X-Ref
Add this handler into the query.

If we were using PHP5, this would be abstract.

ensure_my_table()   X-Ref
Ensure the main table for this handler is in the query. This is used
a lot.


admin_summary()   X-Ref
Provide text for the administrative summary


needs_style_plugin()   X-Ref
Determine if the argument needs a style plugin.

return: TRUE/FALSE

is_exposed()   X-Ref
Determine if this item is 'exposed', meaning it provides form elements
to let users modify the view.

return: TRUE/FALSE

accept_exposed_input($input)   X-Ref
Take input from exposed filters and assign to this handler, if necessary.


store_exposed_input($input, $status)   X-Ref
If set to remember exposed input in the session, store it there.


get_join()   X-Ref
Get the join object that should be used for this handler.

This method isn't used a great deal, but it's very handy for easily
getting the join if it is necessary to make some changes to it, such
as adding an 'extra'.

validate()   X-Ref
Validates the handler against the complete View.

This is called when the complete View is being validated. For validating
the handler options form use options_validate().

return:

broken()   X-Ref
Determine if the handler is considered 'broken', meaning it's a
a placeholder used when a handler can't be found.


Class: views_many_to_one_helper  - X-Ref

This many to one helper object is used on both arguments and filters.

views_many_to_one_helper(&$handler)   X-Ref
No description

option_definition(&$options)   X-Ref
No description

options_form(&$form, &$form_state)   X-Ref
No description

get_field()   X-Ref
Sometimes the handler might want us to use some kind of formula, so give
it that option. If it wants us to do this, it must set $helper->formula = TRUE
and implement handler->get_formula();


add_table($join = NULL, $alias = NULL)   X-Ref
Add a table to the query.

This is an advanced concept; not only does it add a new instance of the table,
but it follows the relationship path all the way down to the relationship
link point and adds *that* as a new relationship and then adds the table to
the relationship, if necessary.

get_join()   X-Ref
No description

summary_join()   X-Ref
Provide the proper join for summary queries. This is important in part because
it will cooperate with other arguments if possible.


ensure_my_table()   X-Ref
Override ensure_my_table so we can control how this joins in.
The operator actually has influence over joining.


add_filter()   X-Ref
No description

views_break_phrase($str, &$filter)   X-Ref
No description

views_get_timezone()   X-Ref
Figure out what timezone we're in; needed for some date manipulations.


views_date_sql_field($field, $field_type = 'int', $set_offset = NULL)   X-Ref
Helper function to create cross-database SQL dates.

param: $field
param: $field_type
param: $set_offset
return:

views_date_sql_format($format, $field, $field_type = 'int', $set_offset = NULL)   X-Ref
Helper function to create cross-database SQL date formatting.

param: $format
param: $field
param: $field_type
param: $set_offset
return:

views_date_sql_extract($extract_type, $field, $field_type = 'int', $set_offset = NULL)   X-Ref
Helper function to create cross-database SQL date extraction.

param: $extract_type
param: $field
param: $field_type
param: $set_offset
return:

views_views_handlers()   X-Ref
Implementation of hook_views_handlers() to register all of the basic handlers
views uses.


Class: views_join  - X-Ref

A function class to represent a join and create the SQL necessary
to implement the join.

This is the Delegation pattern. If we had PHP5 exclusively, we would
declare this an interface.

Extensions of this class can be used to create more interesting joins.

join definition
- table: table to join (right table)
- field: field to join on (right field)
- left_table: The table we join to
- left_field: The field we join to
- type: either LEFT (default) or INNER
- extra: Either a string that's directly added, or an array of items:
- - table: if not set, current table; if NULL, no table. This field can't
be set in the cached definition because it can't know aliases; this field
can only be used by realtime joins.
- - field: Field or formula
- - operator: defaults to =
- - value: Must be set. If an array, operator will be defaulted to IN.
- - numeric: If true, the value will not be surrounded in quotes.
- extra type: How all the extras will be combined. Either AND or OR. Defaults to AND.
construct($table = NULL, $left_table = NULL, $left_field = NULL, $field = NULL, $extra = array()   X-Ref
Construct the views_join object.


join($table, &$query)   X-Ref
Build the SQL for the join this object represents.


db_safe($input)   X-Ref
Ensure that input is db safe. We only check strings and ints tho
so something that needs floats in their joins needs to do their
own type checking.


views_views_api()   X-Ref
Implementation of hook_views_api().

This one is used as the base to reduce errors when updating.

aggregator_views_api()   X-Ref
No description

book_views_api()   X-Ref
No description

comment_views_api()   X-Ref
No description

locale_views_api()   X-Ref
No description

filter_views_api()   X-Ref
No description

node_views_api()   X-Ref
No description

poll_views_api()   X-Ref
No description

profile_views_api()   X-Ref
No description

search_views_api()   X-Ref
No description

statistics_views_api()   X-Ref
No description

system_views_api()   X-Ref
No description

taxonomy_views_api()   X-Ref
No description

translation_views_api()   X-Ref
No description

upload_views_api()   X-Ref
No description

user_views_api()   X-Ref
No description

contact_views_api()   X-Ref
No description

Functions
Functions that are not part of a class:

_views_create_handler($definition, $type = 'handler')   X-Ref
Instantiate and construct a new handler


views_include_handler($definition, $type, $count = 0)   X-Ref
Attempt to find the include file for a given handler from its definition.

This will also attempt to include all parents, though we're maxing the
parent chain to 10 to prevent infinite loops.

_views_prepare_handler($definition, $data, $field)   X-Ref
Prepare a handler's data by checking defaults and such.


views_fetch_handler_data($handler = NULL)   X-Ref
Fetch the handler data from cache.


views_discover_handlers()   X-Ref
Builds and return a list of all handlers available in the system.

return: Nested array of handlers

views_get_table_join($table, $base_table)   X-Ref
Fetch a handler to join one table to a primary table from the data cache



Generated: Thu Mar 24 11:18:33 2011 Cross-referenced by PHPXref 0.7