class schema__publication
Hierarchy
- class \TripalField
- class \ChadoField
- class \schema__publication
- class \ChadoField
Expanded class hierarchy of schema__publication
4 string references to 'schema__publication'
- schema__publication_formatter.inc in tripal_chado/
includes/ TripalFields/ schema__publication/ schema__publication_formatter.inc - schema__publication_widget.inc in tripal_chado/
includes/ TripalFields/ schema__publication/ schema__publication_widget.inc - tripal_chado_bundle_fields_info_linker in tripal_chado/
includes/ tripal_chado.fields.inc - tripal_chado_bundle_instances_info_linker in tripal_chado/
includes/ tripal_chado.fields.inc
File
- tripal_chado/
includes/ TripalFields/ schema__publication/ schema__publication.inc, line 3
View source
class schema__publication 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 = 'Publication';
// The default description for this field.
public static $description = 'Associates a publication (e.g. journal article,
conference proceedings, book chapter, etc.) with this record.';
// 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' => 'schema',
// The name of the term.
'term_name' => 'publication',
// The unique ID (i.e. accession) of the term.
'term_accession' => 'publication',
// 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 = 'schema__publication_widget';
// The default formatter for this field.
public static $default_formatter = 'schema__publication_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(),
'sortable' => FALSE,
'searchable' => FALSE,
'type' => 'xs:string',
'readonly' => TRUE,
),
);
}
/**
*
* @see TripalField::load()
*/
public function load($entity) {
$record = $entity->chado_record;
$field_name = $this->field['field_name'];
$field_type = $this->field['type'];
$field_table = $this->instance['settings']['chado_table'];
$field_column = $this->instance['settings']['chado_column'];
$base_table = $this->instance['settings']['base_table'];
// Get the FK that links to the base record.
$schema = chado_get_schema($field_table);
$pkey = $schema['primary key'][0];
$fkey_lcolumn = key($schema['foreign keys'][$base_table]['columns']);
$fkey_rcolumn = $schema['foreign keys'][$base_table]['columns'][$fkey_lcolumn];
// Set some defaults for the empty record.
$entity->{$field_name}['und'][0] = array(
'value' => array(),
'chado-' . $field_table . '__' . $pkey => '',
'chado-' . $field_table . '__' . $fkey_lcolumn => '',
'chado-' . $field_table . '__' . 'pub_id' => '',
);
$linker_table = $base_table . '_pub';
$options = array(
'return_array' => 1,
);
$record = chado_expand_var($record, 'table', $linker_table, $options);
if (count($record->$linker_table) > 0) {
$i = 0;
foreach ($record->$linker_table as $index => $linker) {
$pub = $linker->pub_id;
$pub_details = chado_get_minimal_pub_info($pub);
$entity->{$field_name}['und'][$i]['value'] = $pub_details;
$entity->{$field_name}['und'][$i]['chado-' . $field_table . '__' . $pkey] = $linker->$pkey;
$entity->{$field_name}['und'][$i]['chado-' . $field_table . '__' . $fkey_lcolumn] = $linker->$fkey_lcolumn->$fkey_lcolumn;
$entity->{$field_name}['und'][$i]['chado-' . $field_table . '__' . 'pub_id'] = $pub->pub_id;
if (property_exists($pub, 'entity_id')) {
$entity->{$field_name}['und'][$i]['value']['entity'] = 'TripalEntity:' . $pub->entity_id;
}
$i++;
}
}
}
}
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:: |
schema__publication:: |
public static | property |
Overrides TripalField:: |
schema__publication:: |
public static | property |
Overrides ChadoField:: |
schema__publication:: |
public static | property |
Overrides ChadoField:: |
schema__publication:: |
public static | property |
Overrides TripalField:: |
schema__publication:: |
public static | property | |
schema__publication:: |
protected | property |
Overrides TripalField:: |
schema__publication:: |
protected | property |
Overrides TripalField:: |
schema__publication:: |
public | function |
Overrides TripalField:: |
schema__publication:: |
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 | 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. |