PHPXRef 0.7 : Drupal 6 (gatewave) : Detail view of views_handler

(no description)

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

Defines 4 classes

views_handler_field:: (24 methods):
  construct()
  allow_advanced_render()
  init()
  query()
  add_additional_fields()
  click_sort()
  click_sortable()
  label()
  element_type()
  option_definition()
  options_form()
  admin_summary()
  pre_render()
  render()
  advanced_render()
  render_text()
  render_altered()
  render_trim_text()
  render_as_link()
  get_render_tokens()
  add_self_tokens()
  document_self_tokens()
  theme()
  theme_functions()

views_handler_field_broken:: (5 methods):
  ui_name()
  ensure_my_table()
  query()
  options_form()
  broken()

views_handler_field_file_size:: (3 methods):
  option_definition()
  options_form()
  render()

views_handler_field_xss:: (1 method):
render()

Class: views_handler_field - X-Ref

Base field handler that has no options and renders an unformatted field.

Definition terms:
- additional fields: An array of fields that should be added to the query
for some purpose. The array is in the form of:
array('identifier' => array('table' => tablename,
'field' => fieldname); as many fields as are necessary
may be in this array.
- click sortable: If TRUE, this field may be click sorted.

construct() X-Ref

Construct a new field handler.

allow_advanced_render() X-Ref

Determine if this field can allow advanced rendering.

Fields can set this to FALSE if they do not wish to allow
token based rewriting or link-making.

init(&$view, $options) X-Ref

No description

query() X-Ref

Called to add the field to a query.

add_additional_fields($fields = NULL) X-Ref

Add 'additional' fields to the query.

param: $fields

click_sort($order) X-Ref

Called to determine what to tell the clicksorter.

click_sortable() X-Ref

Determine if this field is click sortable.

label() X-Ref

Get this field's label.

element_type() X-Ref

Return DIV or SPAN based upon the field's element type.

option_definition() X-Ref

No description

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

Default options form that provides the label widget that all fields
should have.

admin_summary() X-Ref

Provide extra data to the administration form

pre_render($values) X-Ref

Run before any fields are rendered.

This gives the handlers some time to set up before any handler has
been rendered.

param: $values

render($values) X-Ref

Render the field.

param: $values

advanced_render($values) X-Ref

Render a field using advanced settings.

This renders a field normally, then decides if render-as-link and
text-replacement rendering is necessary.

render_text($alter) X-Ref

Perform an advanced text render for the item.

This is separated out as some fields may render lists, and this allows
each item to be handled individually.

render_altered($alter, $tokens) X-Ref

Render this field as altered text, from a fieldset set by the user.

render_trim_text($alter, $value) X-Ref

Trim the field down to the specified length.

render_as_link($alter, $text, $tokens) X-Ref

Render this field as a link, with the info from a fieldset set by
the user.

get_render_tokens($item) X-Ref

Get the 'render' tokens to use for advanced rendering.

This runs through all of the fields and arguments that
are available and gets their values. This will then be
used in one giant str_replace().

add_self_tokens(&$tokens, $item) X-Ref

Add any special tokens this field might use for itself.

This method is intended to be overridden by items that generate
fields as a list. For example, the field that displays all terms
on a node might have tokens for the tid and the term.

By convention, tokens should follow the format of [token-subtoken]
where token is the field ID and subtoken is the field. If the
field ID is terms, then the tokens might be [terms-tid] and [terms-name].

document_self_tokens(&$tokens) X-Ref

Document any special tokens this field might use for itself.

theme($values) X-Ref

Call out to the theme() function, which probably just calls render() but
allows sites to override output fairly easily.

theme_functions() X-Ref

No description

Class: views_handler_field_broken - X-Ref

A special handler to take the place of missing or broken handlers.

ui_name($short = FALSE) X-Ref

No description

ensure_my_table() X-Ref

No description