class data__sequence_length
Hierarchy
- class \TripalField
- class \ChadoField
- class \data__sequence_length
- class \ChadoField
Expanded class hierarchy of data__sequence_length
4 string references to 'data__sequence_length'
- data__sequence_length_formatter.inc in tripal_chado/
includes/ TripalFields/ data__sequence_length/ data__sequence_length_formatter.inc - data__sequence_length_widget.inc in tripal_chado/
includes/ TripalFields/ data__sequence_length/ data__sequence_length_widget.inc - tripal_chado_bundle_fields_info_custom in tripal_chado/
includes/ tripal_chado.fields.inc - tripal_chado_bundle_instances_info_custom in tripal_chado/
includes/ tripal_chado.fields.inc - Helper function for the hook_create_tripalfield_instance().
File
- tripal_chado/
includes/ TripalFields/ data__sequence_length/ data__sequence_length.inc, line 3
View source
class data__sequence_length extends ChadoField {
// --------------------------------------------------------------------------
// EDITABLE STATIC CONSTANTS
//
// The following constants SHOULD be set for each descendent class. They are
// used by the static functions to provide information to Drupal about
// the field and it's default widget and formatter.
// --------------------------------------------------------------------------
// The default lable for this field.
public static $default_label = 'Sequence length';
// The default description for this field.
public static $description = 'A field for calculating the length of a sequence.';
// Provide a list of instance specific settings. These can be access within
// the instanceSettingsForm. When the instanceSettingsForm is submitted
// then Drupal with automatically change these settings for the instnace.
// It is recommended to put settings at the instance level whenever possible.
// If you override this variable in a child class be sure to replicate the
// term_name, term_vocab, term_accession and term_fixed keys as these are
// required for all TripalFields.
public static $default_instance_settings = array(
// The short name for the vocabulary (e.g. shcema, SO, GO, PATO, etc.).
'term_vocabulary' => 'data',
// The name of the term.
'term_name' => 'sequence_length',
// The unique ID (i.e. accession) of the term.
'term_accession' => '1249',
// Set to TRUE if the site admin is allowed to change the term
// type. This will create form elements when editing the field instance
// to allow the site admin to change the term settings above.
'term_fixed' => FALSE,
);
// The default widget for this field.
public static $default_widget = 'data__sequence_length_widget';
// The default formatter for this field.
public static $default_formatter = 'data__sequence_length_formatter';
// --------------------------------------------------------------------------
// PROTECTED CLASS MEMBERS -- DO NOT OVERRIDE
// --------------------------------------------------------------------------
// An array containing details about the field. The format of this array
// is the same as that returned by field_info_fields()
protected $field;
// An array containing details about an instance of the field. A field does
// not have to have an instance. But if dealing with an instance (such as
// when using the widgetForm, formatterSettingsForm, etc.) it should be set.
protected $instance;
/**
* @see TripalField::elementInfo()
*/
public function elementInfo() {
$field_term = $this->getFieldTermID();
return array(
$field_term => array(
'operations' => array('eq', 'gt', 'lt', 'gte', 'lte'),
'sortable' => TRUE,
'searchable' => TRUE,
'type' => 'xs:integer',
'readonly' => TRUE,
),
);
}
}
Members
Name | Modifiers | Type | Description |
---|---|---|---|
ChadoField:: |
public static | property |
Overrides TripalField:: |
ChadoField:: |
public static | property |
Overrides TripalField:: |
ChadoField:: |
public static | property |
Overrides TripalField:: |
ChadoField:: |
public static | property |
Overrides TripalField:: |
ChadoField:: |
public | function |
Overrides TripalField:: |
ChadoField:: |
public | function |
In addition to the rules to follow for the TripalField::query function
these should also be followed for the ChadoField::query implementation. Overrides TripalField:: |
ChadoField:: |
protected | function | A convient way to join a table to a query without duplicates. |
ChadoField:: |
public | function |
Overrides TripalField:: |
data__sequence_length:: |
public static | property |
Overrides TripalField:: |
data__sequence_length:: |
public static | property |
Overrides ChadoField:: |
data__sequence_length:: |
public static | property |
Overrides ChadoField:: |
data__sequence_length:: |
public static | property |
Overrides TripalField:: |
data__sequence_length:: |
public static | property | |
data__sequence_length:: |
protected | property |
Overrides TripalField:: |
data__sequence_length:: |
protected | property |
Overrides TripalField:: |
data__sequence_length:: |
public | function |
Overrides TripalField:: |
TripalField:: |
public static | property | |
TripalField:: |
public static | property | |
TripalField:: |
protected | property | |
TripalField:: |
public | function | After a field instance is created the following function is run. |
TripalField:: |
public | function | |
TripalField:: |
public | function | Retrives the name of this field. |
TripalField:: |
public | function | |
TripalField:: |
public | function | |
TripalField:: |
public | function | |
TripalField:: |
protected | function | When constructing a pager for use by a field, all pagers must have a unique ID |
TripalField:: |
public static | function | Provides default information about this field type |
TripalField:: |
public | function | Provides validation of the instance settings form. |
TripalField:: |
public | function | Loads the field values from the underlying data store. |
TripalField:: |
public | function | Provides a form for the 'Field Settings' of the field management page. |
TripalField:: |
public | function | _state |
TripalField:: |
public | function | Perform validation of the field regardless how it is updated. |
TripalField:: |
public | function | Describes this field to Views. |
TripalField:: |
public | function | Describes this field to Tripal web services. |
TripalField:: |
protected | function | |
TripalField:: |
protected | function | |
TripalField:: |
public | function | Instantiates a new TripalField object. |