69 lines
2.0 KiB
PHP
69 lines
2.0 KiB
PHP
<?php
|
|
|
|
/**
|
|
* @file
|
|
* Hooks provided by farm_plan.
|
|
*
|
|
* This file contains no working PHP code; it exists to provide additional
|
|
* documentation for doxygen as well as to document hooks in the standard
|
|
* Drupal manner.
|
|
*/
|
|
|
|
/**
|
|
* @defgroup farm_plan Farm plan module integrations.
|
|
*
|
|
* Module integrations with the farm_plan module.
|
|
*/
|
|
|
|
/**
|
|
* @defgroup farm_plan_hooks Farm plan's hooks
|
|
* @{
|
|
* Hooks that can be implemented by other modules in order to extend farm_plan.
|
|
*/
|
|
|
|
/**
|
|
* Define farm plan record relationships.
|
|
*
|
|
* This will be used to automatically integrate with Views, and create
|
|
* constraints on linked records.
|
|
*
|
|
* @return array
|
|
* Returns an array of record types with the database table and field names
|
|
* used to store relationships, using the following keys:
|
|
* - label: The human-readable label for this record type.
|
|
* - entity_type: The Drupal entity type.
|
|
* - entity_pk: The column name of the entity type's primary key.
|
|
* - table: The table that links the record to the plan.
|
|
* - field: The column name in the table that links to the record's PK.
|
|
* - required: It's possible for one table to maintain multiple
|
|
* relationships so this key indicates that this relationship is
|
|
* required. This defaults to TRUE, so generally you only need to set it
|
|
* to FALSE if you are adding an optional relationship to an existing
|
|
* table. This affects how the farm_plan_link_record() and
|
|
* farm_plan_link_record() functions work, and whether they will
|
|
* insert/delete rows or update them instead.
|
|
*/
|
|
function hook_farm_plan_record_relationships() {
|
|
return array(
|
|
'my_plan_asset' => array(
|
|
'label' => t('Asset'),
|
|
'entity_type' => 'farm_asset',
|
|
'entity_pk' => 'id',
|
|
'table' => 'my_plan_asset',
|
|
'field' => 'asset_id',
|
|
),
|
|
'my_plan_log' => array(
|
|
'label' => t('Log'),
|
|
'entity_type' => 'log',
|
|
'entity_pk' => 'id',
|
|
'table' => 'my_plan_asset',
|
|
'field' => 'log_id',
|
|
'required' => FALSE,
|
|
),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @}
|
|
*/
|