Tripal
Public Member Functions | List of all members
tripal_views_handler_field_entity Class Reference
Inheritance diagram for tripal_views_handler_field_entity:
Inheritance graph
[legend]
Collaboration diagram for tripal_views_handler_field_entity:
Collaboration graph
[legend]

Public Member Functions

 init (&$view, &$options)
 
 option_definition ()
 
 options_form (&$form, &$form_state)
 
 get_value ($values, $field=NULL)
 
 render_link ($data, $values)
 
 render ($values)
 
- Public Member Functions inherited from tripal_views_handler_field
 query ()
 
 click_sort ($order)
 

Detailed Description

Field handler to provide simple renderer that allows linking to a entity. Definition terms:

Member Function Documentation

◆ get_value()

tripal_views_handler_field_entity::get_value (   $values,
  $field = NULL 
)

Get the value that's supposed to be rendered.

This api exists so that other modules can easy set the values of the field without having the need to change the render method as well.

Parameters
$valuesAn object containing all retrieved values.
$fieldOptional name of the field where the value is stored.

Reimplemented from tripal_views_handler_field.

◆ options_form()

tripal_views_handler_field_entity::options_form ( $form,
$form_state 
)

Provide link to entity option

◆ render()

tripal_views_handler_field_entity::render (   $values)

Render the field.

Parameters
$valuesThe values retrieved from the database.

Reimplemented from tripal_views_handler_field.

◆ render_link()

tripal_views_handler_field_entity::render_link (   $data,
  $values 
)

Render whatever the data is as a link to the entity.

Data should be made XSS safe prior to calling this function.


The documentation for this class was generated from the following file: