Added extension code
This commit is contained in:
civiwaresolution
Pradeep Nayak
commit
5596e9b90b
8
CRM/RelateEntities/BAO/RelateEntities.php
Normal file
8
CRM/RelateEntities/BAO/RelateEntities.php
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* CRM_RelateEntities_BAO_RelateEntities constructor.
|
||||||
|
*/
|
||||||
|
class CRM_RelateEntities_BAO_RelateEntities extends CRM_RelateEntities_DAO_RelateEntities {
|
||||||
|
|
||||||
|
}
|
||||||
275
CRM/RelateEntities/DAO/RelateEntities.php
Normal file
275
CRM/RelateEntities/DAO/RelateEntities.php
Normal file
@ -0,0 +1,275 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @package CRM
|
||||||
|
* @copyright CiviCRM LLC (c) 2004-2019
|
||||||
|
*
|
||||||
|
* Generated from xml/schema/CRM/Contact/RelateEntities.xml
|
||||||
|
* DO NOT EDIT. Generated by CRM_Core_CodeGen
|
||||||
|
* (GenCodeChecksum:ebfcea88ae4bd09a0821a942ecdfa4db)
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Database access object for the RelateEntities entity.
|
||||||
|
*/
|
||||||
|
class CRM_RelateEntities_DAO_RelateEntities extends CRM_Core_DAO {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Static instance to hold the table name.
|
||||||
|
*
|
||||||
|
* @var string
|
||||||
|
*/
|
||||||
|
public static $_tableName = 'civicrm_relate_entities';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Should CiviCRM log any modifications to this table in the civicrm_log table.
|
||||||
|
*
|
||||||
|
* @var bool
|
||||||
|
*/
|
||||||
|
public static $_log = TRUE;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* RelateEntities ID
|
||||||
|
*
|
||||||
|
* @var int
|
||||||
|
*/
|
||||||
|
public $id;
|
||||||
|
public $entity_table_a;
|
||||||
|
public $entity_table_b;
|
||||||
|
public $entity_id_a;
|
||||||
|
public $entity_id_b;
|
||||||
|
public $relationship_type_id;
|
||||||
|
public $created_date;
|
||||||
|
public $modified_date;
|
||||||
|
public $is_active;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Class constructor.
|
||||||
|
*/
|
||||||
|
public function __construct() {
|
||||||
|
$this->__table = 'civicrm_relate_entities';
|
||||||
|
parent::__construct();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns foreign keys and entity references.
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
* [CRM_Core_Reference_Interface]
|
||||||
|
*/
|
||||||
|
public static function getReferenceColumns() {
|
||||||
|
if (!isset(Civi::$statics[__CLASS__]['links'])) {
|
||||||
|
Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
|
||||||
|
Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'relationship_type_id', 'civicrm_relationship_type', 'id');
|
||||||
|
CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
|
||||||
|
}
|
||||||
|
return Civi::$statics[__CLASS__]['links'];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns all the column names of this table
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
public static function &fields() {
|
||||||
|
if (!isset(Civi::$statics[__CLASS__]['fields'])) {
|
||||||
|
Civi::$statics[__CLASS__]['fields'] = [
|
||||||
|
'id' => [
|
||||||
|
'name' => 'id',
|
||||||
|
'type' => CRM_Utils_Type::T_INT,
|
||||||
|
'title' => ts('RelateEntities ID'),
|
||||||
|
'description' => ts('RelateEntities ID'),
|
||||||
|
'required' => TRUE,
|
||||||
|
'where' => 'civicrm_relate_entities.id',
|
||||||
|
'table_name' => 'civicrm_relate_entities',
|
||||||
|
'entity' => 'RelateEntities',
|
||||||
|
'bao' => 'CRM_RelateEntities_BAO_RelateEntities',
|
||||||
|
'localizable' => 0,
|
||||||
|
],
|
||||||
|
'entity_table_a' => [
|
||||||
|
'name' => 'entity_table_a',
|
||||||
|
'type' => CRM_Utils_Type::T_STRING,
|
||||||
|
'title' => ts('Entity Table A'),
|
||||||
|
'description' => ts('May contain civicrm_financial_item, civicrm_contribution, civicrm_financial_trxn, civicrm_grant, etc'),
|
||||||
|
'required' => TRUE,
|
||||||
|
'maxlength' => 64,
|
||||||
|
'size' => CRM_Utils_Type::BIG,
|
||||||
|
'import' => TRUE,
|
||||||
|
'export' => TRUE,
|
||||||
|
'table_name' => 'civicrm_relate_entities',
|
||||||
|
'entity' => 'RelateEntities',
|
||||||
|
'bao' => 'CRM_RelateEntities_DAO_RelateEntities',
|
||||||
|
'localizable' => 0,
|
||||||
|
],
|
||||||
|
'entity_table_b' => [
|
||||||
|
'name' => 'entity_table_b',
|
||||||
|
'type' => CRM_Utils_Type::T_STRING,
|
||||||
|
'title' => ts('Entity Table B'),
|
||||||
|
'description' => ts('May contain civicrm_financial_item, civicrm_contribution, civicrm_financial_trxn, civicrm_grant, etc'),
|
||||||
|
'required' => TRUE,
|
||||||
|
'maxlength' => 64,
|
||||||
|
'size' => CRM_Utils_Type::BIG,
|
||||||
|
'import' => TRUE,
|
||||||
|
'export' => TRUE,
|
||||||
|
'table_name' => 'civicrm_relate_entities',
|
||||||
|
'entity' => 'RelateEntities',
|
||||||
|
'bao' => 'CRM_RelateEntities_DAO_RelateEntities',
|
||||||
|
'localizable' => 0,
|
||||||
|
],
|
||||||
|
'entity_id_a' => [
|
||||||
|
'name' => 'entity_id_a',
|
||||||
|
'type' => CRM_Utils_Type::T_INT,
|
||||||
|
'title' => ts('Entity Id A'),
|
||||||
|
'description' => '',
|
||||||
|
'required' => TRUE,
|
||||||
|
'table_name' => 'civicrm_relate_entities',
|
||||||
|
'entity' => 'RelateEntities',
|
||||||
|
'bao' => 'CRM_RelateEntities_BAO_RelateEntities',
|
||||||
|
'localizable' => 0,
|
||||||
|
],
|
||||||
|
'entity_id_b' => [
|
||||||
|
'name' => 'entity_id_b',
|
||||||
|
'type' => CRM_Utils_Type::T_INT,
|
||||||
|
'title' => ts('Entity Id B'),
|
||||||
|
'description' => '',
|
||||||
|
'required' => TRUE,
|
||||||
|
'table_name' => 'civicrm_relate_entities',
|
||||||
|
'entity' => 'RelateEntities',
|
||||||
|
'bao' => 'CRM_RelateEntities_BAO_RelateEntities',
|
||||||
|
'localizable' => 0,
|
||||||
|
],
|
||||||
|
'relationship_type_id' => [
|
||||||
|
'name' => 'relationship_type_id',
|
||||||
|
'type' => CRM_Utils_Type::T_INT,
|
||||||
|
'title' => ts('Relationship Type'),
|
||||||
|
'description' => ts('id of the relationship'),
|
||||||
|
'required' => TRUE,
|
||||||
|
'table_name' => 'civicrm_relate_entities',
|
||||||
|
'entity' => 'RelateEntities',
|
||||||
|
'bao' => 'CRM_RelateEntities_BAO_RelateEntities',
|
||||||
|
'localizable' => 0,
|
||||||
|
'FKClassName' => 'CRM_Relationship_DAO_RelationshipType',
|
||||||
|
'html' => [
|
||||||
|
'type' => 'Select',
|
||||||
|
],
|
||||||
|
],
|
||||||
|
'created_date' => [
|
||||||
|
'name' => 'created_date',
|
||||||
|
'type' => CRM_Utils_Type::T_DATE,
|
||||||
|
'title' => ts('RelateEntities Created Date'),
|
||||||
|
'description' => ts('date when the relationship created'),
|
||||||
|
'table_name' => 'civicrm_relate_entities',
|
||||||
|
'entity' => 'RelateEntities',
|
||||||
|
'bao' => 'CRM_RelateEntities_BAO_RelateEntities',
|
||||||
|
'localizable' => 0,
|
||||||
|
'html' => [
|
||||||
|
'type' => 'Select Date',
|
||||||
|
'formatType' => 'activityDate',
|
||||||
|
],
|
||||||
|
],
|
||||||
|
'modified_date' => [
|
||||||
|
'name' => 'modified_date',
|
||||||
|
'type' => CRM_Utils_Type::T_DATE,
|
||||||
|
'title' => ts('RelateEntities Modified Date'),
|
||||||
|
'description' => ts('date when the relationship modified'),
|
||||||
|
'table_name' => 'civicrm_relate_entities',
|
||||||
|
'entity' => 'RelateEntities',
|
||||||
|
'bao' => 'CRM_RelateEntities_BAO_RelateEntities',
|
||||||
|
'localizable' => 0,
|
||||||
|
'html' => [
|
||||||
|
'type' => 'Select Date',
|
||||||
|
'formatType' => 'activityDate',
|
||||||
|
],
|
||||||
|
],
|
||||||
|
'is_active' => [
|
||||||
|
'name' => 'is_active',
|
||||||
|
'type' => CRM_Utils_Type::T_BOOLEAN,
|
||||||
|
'title' => ts('Is Active?'),
|
||||||
|
'description' => ts('is active ?'),
|
||||||
|
'default' => '1',
|
||||||
|
'table_name' => 'civicrm_relate_entities',
|
||||||
|
'entity' => 'RelateEntities',
|
||||||
|
'bao' => 'CRM_RelateEntities_BAO_RelateEntities',
|
||||||
|
'localizable' => 0,
|
||||||
|
'html' => [
|
||||||
|
'type' => 'Radio',
|
||||||
|
],
|
||||||
|
'options' => [
|
||||||
|
'1' => ts('Yes'),
|
||||||
|
'0' => ts('No'),
|
||||||
|
],
|
||||||
|
],
|
||||||
|
];
|
||||||
|
CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
|
||||||
|
}
|
||||||
|
return Civi::$statics[__CLASS__]['fields'];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return a mapping from field-name to the corresponding key (as used in fields()).
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
* Array(string $name => string $uniqueName).
|
||||||
|
*/
|
||||||
|
public static function &fieldKeys() {
|
||||||
|
if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
|
||||||
|
Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
|
||||||
|
}
|
||||||
|
return Civi::$statics[__CLASS__]['fieldKeys'];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the names of this table
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public static function getTableName() {
|
||||||
|
return self::$_tableName;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns if this table needs to be logged
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
public function getLog() {
|
||||||
|
return self::$_log;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the list of fields that can be imported
|
||||||
|
*
|
||||||
|
* @param bool $prefix
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
public static function &import($prefix = FALSE) {
|
||||||
|
$r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'relate_entities', $prefix, []);
|
||||||
|
return $r;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the list of fields that can be exported
|
||||||
|
*
|
||||||
|
* @param bool $prefix
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
public static function &export($prefix = FALSE) {
|
||||||
|
$r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'relate_entities', $prefix, []);
|
||||||
|
return $r;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the list of indices
|
||||||
|
*
|
||||||
|
* @param bool $localize
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
public static function indices($localize = TRUE) {
|
||||||
|
$indices = [];
|
||||||
|
return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
283
CRM/RelateEntities/Form/RelatedEntity.php
Normal file
283
CRM/RelateEntities/Form/RelatedEntity.php
Normal file
@ -0,0 +1,283 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This class generates form components for Bank Account
|
||||||
|
*/
|
||||||
|
class CRM_RelateEntities_Form_RelatedEntity extends CRM_Core_Form {
|
||||||
|
use CRM_Core_Form_EntityFormTrait;
|
||||||
|
|
||||||
|
public $_id;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set variables up before form is built.
|
||||||
|
*/
|
||||||
|
public function preProcess() {
|
||||||
|
parent::preProcess();
|
||||||
|
$this->entity_table = CRM_Utils_Request::retrieve('entityTable', 'String', $this, TRUE);
|
||||||
|
$this->_id = CRM_Utils_Request::retrieve('id', 'String', $this);
|
||||||
|
if (!$this->_id) {
|
||||||
|
$this->entity_id = CRM_Utils_Request::retrieve('entityId', 'Positive', $this, TRUE);
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->entityA = ($this->entity_table == 'Contact') ? 'Contact' : 'FinancialType';
|
||||||
|
$this->entityB = ($this->entity_table == 'FinancialType') ? 'Contact' : 'FinancialType';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set entity fields to be assigned to the form.
|
||||||
|
*/
|
||||||
|
protected function setEntityFields() {
|
||||||
|
$this->entityFields = [
|
||||||
|
'is_active' => [
|
||||||
|
'name' => 'is_active',
|
||||||
|
'required' => TRUE,
|
||||||
|
],
|
||||||
|
];
|
||||||
|
return $this->entityFields;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Classes extending CRM_Core_Form should implement this method.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
public function getDefaultContext() {
|
||||||
|
return 'create';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Classes extending CRM_Core_Form should implement this method.
|
||||||
|
*/
|
||||||
|
public function getDefaultEntity() {
|
||||||
|
return 'RelateEntities';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set the delete message.
|
||||||
|
*
|
||||||
|
* We do this from the constructor in order to do a translation.
|
||||||
|
*/
|
||||||
|
public function setDeleteMessage() {
|
||||||
|
$this->deleteMessage = ts('Deleting a related entity cannot be undone.') . ts('Do you want to continue?');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add defined entity field to template.
|
||||||
|
*/
|
||||||
|
protected function addEntityFieldsToTemplates() {
|
||||||
|
foreach ($this->setEntityFields() as $fieldSpec) {
|
||||||
|
if (empty($fieldSpec['not-auto-addable'])) {
|
||||||
|
$element = $this->addField($fieldSpec['name'], CRM_Utils_Array::value('props', $fieldSpec, []), CRM_Utils_Array::value('required', $fieldSpec));
|
||||||
|
if (!empty($fieldSpec['is_freeze'])) {
|
||||||
|
$element->freeze();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Build the form object.
|
||||||
|
*/
|
||||||
|
public function buildQuickForm() {
|
||||||
|
self::buildQuickEntityForm();
|
||||||
|
if ($this->_action & CRM_Core_Action::DELETE) {
|
||||||
|
$this->addButtons([
|
||||||
|
[
|
||||||
|
'type' => 'next',
|
||||||
|
'name' => ts('Delete'),
|
||||||
|
'isDefault' => TRUE,
|
||||||
|
],
|
||||||
|
[
|
||||||
|
'type' => 'cancel',
|
||||||
|
'name' => ts('Cancel'),
|
||||||
|
],
|
||||||
|
]);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
$this->addEntityFieldsToTemplates();
|
||||||
|
$this->addEntityRef(
|
||||||
|
'entity_a',
|
||||||
|
ts('Entity A'),
|
||||||
|
[
|
||||||
|
'entity' => $this->entityA,
|
||||||
|
],
|
||||||
|
TRUE
|
||||||
|
)->freeze();
|
||||||
|
|
||||||
|
$this->addEntityRef(
|
||||||
|
'entity_b',
|
||||||
|
ts('Entity B'),
|
||||||
|
[
|
||||||
|
'entity' => $this->entityB,
|
||||||
|
'select' => ['minimumInputLength' => 0],
|
||||||
|
],
|
||||||
|
TRUE
|
||||||
|
);
|
||||||
|
|
||||||
|
$this->add(
|
||||||
|
'select',
|
||||||
|
'relationship_type_id',
|
||||||
|
ts('Relationship Type'),
|
||||||
|
CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, NULL, NULL, NULL, TRUE),
|
||||||
|
FALSE,
|
||||||
|
['class' => 'crm-select2', 'placeholder' => ts('Select Relationship Types')]
|
||||||
|
);
|
||||||
|
|
||||||
|
$fields = [
|
||||||
|
'entity_a' => [
|
||||||
|
'name' => 'entity_a',
|
||||||
|
],
|
||||||
|
'relationship_type_id' => [
|
||||||
|
'name' => 'relationship_type_id',
|
||||||
|
],
|
||||||
|
'entity_b' => [
|
||||||
|
'name' => 'entity_b',
|
||||||
|
]
|
||||||
|
] + $this->entityFields;
|
||||||
|
$this->assign('entityFields', $fields);
|
||||||
|
$this->addButtons([
|
||||||
|
[
|
||||||
|
'type' => 'next',
|
||||||
|
'name' => ts('Save'),
|
||||||
|
'isDefault' => TRUE,
|
||||||
|
],
|
||||||
|
[
|
||||||
|
'type' => 'next',
|
||||||
|
'name' => ts('Save and New'),
|
||||||
|
'subName' => 'new',
|
||||||
|
],
|
||||||
|
[
|
||||||
|
'type' => 'cancel',
|
||||||
|
'name' => ts('Cancel'),
|
||||||
|
],
|
||||||
|
]);
|
||||||
|
$this->addFormRule(array('CRM_RelateEntities_Form_RelatedEntity', 'formRule'), $this);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Global form rule.
|
||||||
|
*
|
||||||
|
* @param array $fields
|
||||||
|
* The input form values.
|
||||||
|
* @param array $files
|
||||||
|
* The uploaded files if any.
|
||||||
|
* @param $self
|
||||||
|
*
|
||||||
|
* @return bool|array
|
||||||
|
* true if no errors, else array of errors
|
||||||
|
*/
|
||||||
|
public static function formRule($fields, $files, $self) {
|
||||||
|
$error = [];
|
||||||
|
return $error;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set the default values for the form.
|
||||||
|
*/
|
||||||
|
public function setDefaultValues() {
|
||||||
|
$defaults = [];
|
||||||
|
if (!$this->_id) {
|
||||||
|
$defaults['is_active'] = 1;
|
||||||
|
$defaults['entity_a'] = $this->entity_id;
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$defaults = civicrm_api3('RelateEntities', 'getsingle', [
|
||||||
|
'id' => $this->_id,
|
||||||
|
]);
|
||||||
|
if ($defaults['entity_table_b'] == CRM_RelateEntities_Utils::getEntityTable($this->entityB)) {
|
||||||
|
$defaults['entity_b'] = $defaults['entity_id_b'];
|
||||||
|
$defaults['relationship_type_id'] .= '_a_b';
|
||||||
|
}
|
||||||
|
else if ($defaults['entity_table_a'] == CRM_RelateEntities_Utils::getEntityTable($this->entityB)) {
|
||||||
|
$defaults['entity_b'] = $defaults['entity_id_a'];
|
||||||
|
$defaults['relationship_type_id'] .= '_b_a';
|
||||||
|
}
|
||||||
|
if ($defaults['entity_table_b'] == CRM_RelateEntities_Utils::getEntityTable($this->entityA)) {
|
||||||
|
$defaults['entity_a'] = $defaults['entity_id_b'];
|
||||||
|
}
|
||||||
|
else if ($defaults['entity_table_a'] == CRM_RelateEntities_Utils::getEntityTable($this->entityA)) {
|
||||||
|
$defaults['entity_a'] = $defaults['entity_id_a'];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return $defaults;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Process the form submission.
|
||||||
|
*/
|
||||||
|
public function postProcess() {
|
||||||
|
if ($this->_action & CRM_Core_Action::DELETE) {
|
||||||
|
$result = civicrm_api3('RelateEntities', 'delete', [
|
||||||
|
'id' => $this->_id,
|
||||||
|
]);
|
||||||
|
if (!empty($result['is_error'])) {
|
||||||
|
CRM_Core_Error::statusBounce($result['error_message'], CRM_Utils_System::url('civicrm/', "reset=1&action=browse"), ts('Cannot Delete'));
|
||||||
|
}
|
||||||
|
CRM_Core_Session::setStatus(ts('Selected Bank Account has been deleted.'), ts('Record Deleted'), 'success');
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
// store the submitted values in an array
|
||||||
|
$params = $this->_submitValues;
|
||||||
|
try {
|
||||||
|
$apiParams = $this->buildParams($params);
|
||||||
|
if ($this->_id) {
|
||||||
|
$apiParams['id'] = $this->_id;
|
||||||
|
}
|
||||||
|
civicrm_api3('RelateEntities', 'create', $apiParams);
|
||||||
|
CRM_Core_Session::setStatus(ts('The Related entity has been saved.'), ts('Saved'), 'success');
|
||||||
|
}
|
||||||
|
catch (CRM_Core_Exception $e) {
|
||||||
|
CRM_Core_Error::statusBounce($e->getMessage());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$buttonName = $this->controller->getButtonName();
|
||||||
|
$session = CRM_Core_Session::singleton();
|
||||||
|
if ($this->entity_table == 'Contact') {
|
||||||
|
$this->ajaxResponse['updateTabs']['#tab_relateentities'] = CRM_RelateEntities_Utils::getRelatedEntities(
|
||||||
|
'Contact', $apiParams['entity_id_a'], FALSE, TRUE
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if ($buttonName == $this->getButtonName('next', 'new')) {
|
||||||
|
CRM_Core_Session::setStatus(ts(' You can add another Bank Account.'));
|
||||||
|
$session->replaceUserContext(CRM_Utils_System::url('civicrm/relatedentities/add',
|
||||||
|
"action=add&reset=1&entityTable={$this->entity_table}&entityId={$apiParams['entity_id_a']}")
|
||||||
|
);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
if ($this->entity_table == 'Contact') {
|
||||||
|
$url = CRM_Utils_System::url('civicrm/contact/view',
|
||||||
|
"reset=1&force=1&cid={$apiParams['entity_id_a']}&selectedChild=relateentities");
|
||||||
|
}
|
||||||
|
if ($this->entity_table == 'FinancialType') {
|
||||||
|
$url = CRM_Utils_System::url('civicrm/admin/financial/financialType', 'reset=1');
|
||||||
|
}
|
||||||
|
$session->replaceUserContext($url);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public function buildParams($formValues) {
|
||||||
|
$rType = explode('_', $formValues['relationship_type_id'], 2);
|
||||||
|
if ($rType[1] == 'a_b') {
|
||||||
|
$params = [
|
||||||
|
'entity_id_a' => $formValues['entity_a'],
|
||||||
|
'entity_id_b' => $formValues['entity_b'],
|
||||||
|
'entity_table_a' => CRM_RelateEntities_Utils::getEntityTable($this->entityA),
|
||||||
|
'entity_table_b' => CRM_RelateEntities_Utils::getEntityTable($this->entityB),
|
||||||
|
];
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$params = [
|
||||||
|
'entity_id_a' => $formValues['entity_b'],
|
||||||
|
'entity_id_b' => $formValues['entity_a'],
|
||||||
|
'entity_table_a' => CRM_RelateEntities_Utils::getEntityTable($this->entityB),
|
||||||
|
'entity_table_b' => CRM_RelateEntities_Utils::getEntityTable($this->entityA),
|
||||||
|
];
|
||||||
|
}
|
||||||
|
$params['relationship_type_id'] = $rType[0];
|
||||||
|
$params['is_active'] = $formValues['is_active'];
|
||||||
|
return $params;
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
111
CRM/RelateEntities/Page/Tab.php
Normal file
111
CRM/RelateEntities/Page/Tab.php
Normal file
@ -0,0 +1,111 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
class CRM_RelateEntities_Page_Tab extends CRM_Core_Page_Basic {
|
||||||
|
/**
|
||||||
|
* The action links that we need to display for the browse screen.
|
||||||
|
*
|
||||||
|
* @var array
|
||||||
|
*/
|
||||||
|
public static $_links = NULL;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get BAO Name.
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
* Classname of BAO.
|
||||||
|
*/
|
||||||
|
public function getBAOName() {
|
||||||
|
return 'CRM_RelateEntities_DAO_RelateEntities';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get action Links.
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
* (reference) of action links
|
||||||
|
*/
|
||||||
|
public function &links() {
|
||||||
|
if (!(self::$_links)) {
|
||||||
|
self::$_links = [
|
||||||
|
CRM_Core_Action::UPDATE => [
|
||||||
|
'name' => ts('Edit'),
|
||||||
|
'url' => 'civicrm/relateentities/list',
|
||||||
|
'qs' => 'reset=1&action=update&id=%%id%%&entityTable=%%entityTable%%',
|
||||||
|
'title' => ts('Edit'),
|
||||||
|
],
|
||||||
|
CRM_Core_Action::DISABLE => [
|
||||||
|
'name' => ts('Disable'),
|
||||||
|
'ref' => 'crm-enable-disable',
|
||||||
|
'title' => ts('Disable'),
|
||||||
|
],
|
||||||
|
CRM_Core_Action::ENABLE => [
|
||||||
|
'name' => ts('Enable'),
|
||||||
|
'ref' => 'crm-enable-disable',
|
||||||
|
'title' => ts('Enable'),
|
||||||
|
],
|
||||||
|
CRM_Core_Action::DELETE => [
|
||||||
|
'name' => ts('Delete'),
|
||||||
|
'url' => 'civicrm/relateentities/list',
|
||||||
|
'qs' => 'reset=1&action=delete&id=%%id%%',
|
||||||
|
'title' => ts('Delete'),
|
||||||
|
],
|
||||||
|
];
|
||||||
|
}
|
||||||
|
return self::$_links;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Browse all address formats for country.
|
||||||
|
*/
|
||||||
|
public function browse() {
|
||||||
|
$this->_id = CRM_Utils_Request::retrieve('entityId', 'Positive', $this, TRUE);
|
||||||
|
$this->_entityTable = CRM_Utils_Request::retrieve('entityTable', 'String', $this, TRUE);
|
||||||
|
$this->assign('contactId', $this->_id);
|
||||||
|
$this->assign('contactID', $this->_id);
|
||||||
|
|
||||||
|
// check logged in url permission
|
||||||
|
if ($this->_entityTable == 'Contact') {
|
||||||
|
$this->_contactId = $this->_id;
|
||||||
|
CRM_Contact_Page_View::checkUserPermission($this);
|
||||||
|
}
|
||||||
|
|
||||||
|
CRM_RelateEntities_Utils::buildEntitiesList($this, $this->_entityTable, $this->_id);
|
||||||
|
|
||||||
|
$this->ajaxResponse['tabCount'] = CRM_RelateEntities_Utils::getRelatedEntities(
|
||||||
|
$this->_entityTable, $this->_id, FALSE, TRUE
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get name of edit form.
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
* Classname of edit form.
|
||||||
|
*/
|
||||||
|
public function editForm() {
|
||||||
|
return 'CRM_RelateEntities_Form_RelatedEntity';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get edit form name.
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
* name of this page.
|
||||||
|
*/
|
||||||
|
public function editName() {
|
||||||
|
return ts('Relate Entity');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get user context.
|
||||||
|
*
|
||||||
|
* @param null $mode
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
* user context.
|
||||||
|
*/
|
||||||
|
public function userContext($mode = NULL) {
|
||||||
|
return 'civicrm/relateentities/list';
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
37
CRM/RelateEntities/Settings.php
Normal file
37
CRM/RelateEntities/Settings.php
Normal file
@ -0,0 +1,37 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
class CRM_RelateEntities_Settings {
|
||||||
|
|
||||||
|
public static function install() {
|
||||||
|
CRM_Core_DAO::executeQuery("
|
||||||
|
CREATE TABLE IF NOT EXISTS `civicrm_relate_entities` (
|
||||||
|
`id` int(10) UNSIGNED NOT NULL,
|
||||||
|
`entity_table_a` varchar(255) NOT NULL,
|
||||||
|
`entity_table_b` varchar(255) NOT NULL,
|
||||||
|
`entity_id_a` int(10) UNSIGNED NOT NULL,
|
||||||
|
`entity_id_b` int(10) UNSIGNED NOT NULL,
|
||||||
|
`relationship_type_id` int(10) UNSIGNED NOT NULL,
|
||||||
|
`is_active` tinyint(4) NOT NULL DEFAULT '1',
|
||||||
|
`created_date` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
|
||||||
|
`modified_date` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
|
||||||
|
PRIMARY KEY (`id`),
|
||||||
|
KEY `UI_civicrm_relate_entities_entity_table_a` (`entity_table_a`),
|
||||||
|
KEY `UI_civicrm_relate_entities_entity_table_b` (`entity_table_b`),
|
||||||
|
KEY `UI_civicrm_relate_entities_entity_id_a` (`entity_id_a`),
|
||||||
|
KEY `UI_civicrm_relate_entities_entity_id_b` (`entity_id_b`),
|
||||||
|
KEY `FK_civicrm_relate_entities_relationship_type_id` (`relationship_type_id`)
|
||||||
|
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;
|
||||||
|
");
|
||||||
|
CRM_Core_DAO::executeQuery("
|
||||||
|
ALTER TABLE `civicrm_relate_entities`
|
||||||
|
ADD CONSTRAINT `FK_civicrm_relate_entities_relationship_type_id` FOREIGN KEY (`relationship_type_id`) REFERENCES `civicrm_relationship_type` (`id`) ON DELETE CASCADE;
|
||||||
|
");
|
||||||
|
}
|
||||||
|
|
||||||
|
public static function uninstall() {
|
||||||
|
CRM_Core_DAO::executeQuery("
|
||||||
|
DROP TABLE IF EXISTS civicrm_relate_entities;
|
||||||
|
");
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
220
CRM/RelateEntities/Utils.php
Normal file
220
CRM/RelateEntities/Utils.php
Normal file
@ -0,0 +1,220 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
class CRM_RelateEntities_Utils {
|
||||||
|
public static $_entityRefs = [];
|
||||||
|
|
||||||
|
public static function getList() {
|
||||||
|
$requiredParameters = [
|
||||||
|
'entityId' => 'Integer',
|
||||||
|
'entityTable' => 'String',
|
||||||
|
'entityTableB' => 'String',
|
||||||
|
];
|
||||||
|
|
||||||
|
$optionalParameters = [];
|
||||||
|
|
||||||
|
$params = CRM_Core_Page_AJAX::defaultSortAndPagerParams();
|
||||||
|
$params += CRM_Core_Page_AJAX::validateParams($requiredParameters, $optionalParameters);
|
||||||
|
$params['offset'] = ($params['page'] - 1) * $params['rp'];
|
||||||
|
$params['rowCount'] = $params['rp'];
|
||||||
|
$params['sort'] = CRM_Utils_Array::value('sortBy', $params);
|
||||||
|
|
||||||
|
$relatedEntities = self::getrelatedEntitiesSelector($params);
|
||||||
|
CRM_Utils_JSON::output($relatedEntities);
|
||||||
|
}
|
||||||
|
|
||||||
|
public static function getrelatedEntitiesSelector($params) {
|
||||||
|
|
||||||
|
$total = self::getRelatedEntities(
|
||||||
|
$params['entityTable'], $params['entityId'], TRUE, TRUE,
|
||||||
|
$params['entityTableB']
|
||||||
|
);
|
||||||
|
|
||||||
|
$results = self::getRelatedEntities(
|
||||||
|
$params['entityTable'], $params['entityId'], TRUE, FALSE,
|
||||||
|
$params['entityTableB']
|
||||||
|
);
|
||||||
|
$relatedEntities = [];
|
||||||
|
$links = new CRM_RelateEntities_Page_Tab();
|
||||||
|
$links = $links->links();
|
||||||
|
while ($results->fetch()) {
|
||||||
|
$action = CRM_Core_Action::UPDATE + CRM_Core_Action::DELETE + CRM_Core_Action::ADD;
|
||||||
|
$class = ' crm-entity ';
|
||||||
|
if ($results->is_active) {
|
||||||
|
$action += CRM_Core_Action::DISABLE;
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$class .= ' disabled';
|
||||||
|
$action += CRM_Core_Action::ENABLE;
|
||||||
|
}
|
||||||
|
$relatedEntity = [
|
||||||
|
'DT_RowId' => $results->id,
|
||||||
|
'DT_RowClass' => $class,
|
||||||
|
'DT_RowAttr' => [
|
||||||
|
'data-entity' => 'RelateEntities',
|
||||||
|
'data-id' => $results->id,
|
||||||
|
],
|
||||||
|
'name' => self::buildName($results->entity_id, $params['entityTableB']),
|
||||||
|
'is_active' => $results->is_active ? ts('Yes') : ts('No'),
|
||||||
|
'relationship_name' => $results->relationship_name,
|
||||||
|
];
|
||||||
|
$relatedEntity['links'] = CRM_Core_Action::formLink(
|
||||||
|
$links,
|
||||||
|
$action,
|
||||||
|
['id' => $results->id, 'entityTable' => $params['entityTable']],
|
||||||
|
ts('more'),
|
||||||
|
FALSE,
|
||||||
|
'relatedentity.manage.action',
|
||||||
|
'RelatedEntity',
|
||||||
|
$results->id
|
||||||
|
);
|
||||||
|
array_push($relatedEntities, $relatedEntity);
|
||||||
|
}
|
||||||
|
$relatedEntitiesDT = [];
|
||||||
|
$relatedEntitiesDT['data'] = $relatedEntities;
|
||||||
|
$relatedEntitiesDT['recordsTotal'] = $total;
|
||||||
|
$relatedEntitiesDT['recordsFiltered'] = $total;
|
||||||
|
return $relatedEntitiesDT;
|
||||||
|
}
|
||||||
|
|
||||||
|
public static function buildName($entityId, $entityTable) {
|
||||||
|
$name = '';
|
||||||
|
$createLink = TRUE;
|
||||||
|
try {
|
||||||
|
switch ($entityTable) {
|
||||||
|
case 'Contact':
|
||||||
|
$return = 'sort_name';
|
||||||
|
$url = 'civicrm/contact/view';
|
||||||
|
$q = "reset=1&cid=$entityId";
|
||||||
|
break;
|
||||||
|
case 'FinancialType':
|
||||||
|
$return = 'name';
|
||||||
|
$url = 'civicrm/admin/financial/financialType';
|
||||||
|
$q = "action=update&id={$entityId}&reset=1";
|
||||||
|
break;
|
||||||
|
case 'MembershipType':
|
||||||
|
$return = 'name';
|
||||||
|
$url = 'civicrm/admin/member/membershipType';
|
||||||
|
$q = "action=update&id={$entityId}&reset=1";
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
$name = civicrm_api3($entityTable, 'getvalue', ['id' => $entityId, 'return' => $return]);
|
||||||
|
if ($createLink) {
|
||||||
|
$name = CRM_Utils_System::href($name, $url, $q);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch (Exception $e) {
|
||||||
|
}
|
||||||
|
|
||||||
|
return $name;
|
||||||
|
}
|
||||||
|
|
||||||
|
public static function buildEntitiesList(&$form, $entityTable, $entityId) {
|
||||||
|
$results = self::getRelatedEntities($entityTable, $entityId, TRUE, FALSE, NULL, TRUE);
|
||||||
|
$relatedEntities = [];
|
||||||
|
while ($results->fetch()) {
|
||||||
|
$entityRef = self::getEntityTable($results->entity_table, TRUE);
|
||||||
|
$relatedEntities[$entityRef] = [
|
||||||
|
'label' => preg_replace('/(?<!\ )[A-Z]/', ' $0', $entityRef),
|
||||||
|
'columns' => self::getColumnHeaders($entityTable, $entityRef),
|
||||||
|
];
|
||||||
|
}
|
||||||
|
$form->assign('entityTable', $entityTable);
|
||||||
|
$form->assign('entityId', $entityId);
|
||||||
|
$form->assign('relatedEntities', $relatedEntities);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function getColumnHeaders($entityTable, $entityRef) {
|
||||||
|
return [
|
||||||
|
'relationship_name' => ts('Relationship Type'),
|
||||||
|
'name' => ts('Title'),
|
||||||
|
'is_active' => ts('Is Active?'),
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
public static function getEntityTable($entityTable, $returnEntityRef = FALSE) {
|
||||||
|
if (empty($entityTable)) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (empty(self::$_entityRefs)) {
|
||||||
|
$entityTypesClasses = array_flip(CRM_Core_DAO_AllCoreTables::daoToClass());
|
||||||
|
$entityTablesClasses = array_flip(CRM_Core_DAO_AllCoreTables::tables());
|
||||||
|
self::$_entityRefs = array_combine($entityTablesClasses, $entityTypesClasses);
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($returnEntityRef) {
|
||||||
|
return CRM_Utils_Array::value($entityTable, self::$_entityRefs);
|
||||||
|
}
|
||||||
|
|
||||||
|
return array_search($entityTable, self::$_entityRefs);
|
||||||
|
}
|
||||||
|
|
||||||
|
public static function getRelatedEntities(
|
||||||
|
$entityTableA, $entityIdA, $all = TRUE, $getCount = FALSE, $entityTableB = NULL,
|
||||||
|
$groupBy = FALSE
|
||||||
|
) {
|
||||||
|
$entityTableA = self::getEntityTable($entityTableA);
|
||||||
|
if (empty($entityTableA) || empty($entityIdA)) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$isActiveClause = '';
|
||||||
|
if (!$all) {
|
||||||
|
$isActiveClause = ' AND cre.is_active = 1 ';
|
||||||
|
}
|
||||||
|
$selectClause = '*';
|
||||||
|
if ($getCount) {
|
||||||
|
$selectClause = ' count(*) ';
|
||||||
|
}
|
||||||
|
|
||||||
|
$queryParams = [
|
||||||
|
1 => [$entityTableA, 'String'],
|
||||||
|
2 => [$entityIdA, 'Integer'],
|
||||||
|
];
|
||||||
|
|
||||||
|
$entityTable1Clause = $entityTable2Clause = '';
|
||||||
|
$entityTableB = self::getEntityTable($entityTableB);
|
||||||
|
if ($entityTableB) {
|
||||||
|
$entityTable1Clause = ' AND `entity_table_a`= %3 ';
|
||||||
|
$entityTable2Clause = ' AND `entity_table_b`= %3 ';
|
||||||
|
$queryParams[3] = [$entityTableB, 'String'];
|
||||||
|
}
|
||||||
|
|
||||||
|
$groupByClause = '';
|
||||||
|
if ($groupBy) {
|
||||||
|
$groupByClause = ' GROUP BY entity_table ';
|
||||||
|
}
|
||||||
|
|
||||||
|
$query = "
|
||||||
|
SELECT {$selectClause} FROM (
|
||||||
|
SELECT
|
||||||
|
cre.`id`, cre.`entity_table_a` entity_table, cre.`entity_id_a` entity_id,
|
||||||
|
crt.`label_b_a` relationship_name, cre.`is_active`
|
||||||
|
FROM `civicrm_relate_entities` cre
|
||||||
|
INNER JOIN civicrm_relationship_type crt
|
||||||
|
ON crt.id = cre.relationship_type_id
|
||||||
|
WHERE `entity_table_b`= %1 AND `entity_id_b` = %2
|
||||||
|
{$isActiveClause} $entityTable1Clause
|
||||||
|
UNION
|
||||||
|
|
||||||
|
SELECT
|
||||||
|
cre.`id`, cre.`entity_table_b` entity_table, cre.`entity_id_b`,
|
||||||
|
crt.`label_a_b` relationship_name, cre.`is_active`
|
||||||
|
FROM `civicrm_relate_entities` cre
|
||||||
|
INNER JOIN civicrm_relationship_type crt
|
||||||
|
ON crt.id = cre.relationship_type_id
|
||||||
|
WHERE `entity_table_a`= %1 AND `entity_id_a` = %2
|
||||||
|
{$isActiveClause} $entityTable2Clause
|
||||||
|
) AS temp
|
||||||
|
$groupByClause
|
||||||
|
";
|
||||||
|
|
||||||
|
if ($getCount) {
|
||||||
|
return CRM_Core_DAO::singleValueQuery($query, $queryParams);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
return CRM_Core_DAO::executeQuery($query, $queryParams);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
667
LICENSE.txt
Normal file
667
LICENSE.txt
Normal file
@ -0,0 +1,667 @@
|
|||||||
|
Package: com.megaphonetech.relateentities
|
||||||
|
Copyright (C) 2019, Pradeep Nayak <pradpnayak@gmail.com>
|
||||||
|
Licensed under the GNU Affero Public License 3.0 (below).
|
||||||
|
|
||||||
|
-------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 19 November 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU Affero General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works, specifically designed to ensure
|
||||||
|
cooperation with the community in the case of network server software.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
our General Public Licenses are intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
Developers that use our General Public Licenses protect your rights
|
||||||
|
with two steps: (1) assert copyright on the software, and (2) offer
|
||||||
|
you this License which gives you legal permission to copy, distribute
|
||||||
|
and/or modify the software.
|
||||||
|
|
||||||
|
A secondary benefit of defending all users' freedom is that
|
||||||
|
improvements made in alternate versions of the program, if they
|
||||||
|
receive widespread use, become available for other developers to
|
||||||
|
incorporate. Many developers of free software are heartened and
|
||||||
|
encouraged by the resulting cooperation. However, in the case of
|
||||||
|
software used on network servers, this result may fail to come about.
|
||||||
|
The GNU General Public License permits making a modified version and
|
||||||
|
letting the public access it on a server without ever releasing its
|
||||||
|
source code to the public.
|
||||||
|
|
||||||
|
The GNU Affero General Public License is designed specifically to
|
||||||
|
ensure that, in such cases, the modified source code becomes available
|
||||||
|
to the community. It requires the operator of a network server to
|
||||||
|
provide the source code of the modified version running there to the
|
||||||
|
users of that server. Therefore, public use of a modified version, on
|
||||||
|
a publicly accessible server, gives the public access to the source
|
||||||
|
code of the modified version.
|
||||||
|
|
||||||
|
An older license, called the Affero General Public License and
|
||||||
|
published by Affero, was designed to accomplish similar goals. This is
|
||||||
|
a different license, not a version of the Affero GPL, but Affero has
|
||||||
|
released a new version of the Affero GPL which permits relicensing under
|
||||||
|
this license.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, if you modify the
|
||||||
|
Program, your modified version must prominently offer all users
|
||||||
|
interacting with it remotely through a computer network (if your version
|
||||||
|
supports such interaction) an opportunity to receive the Corresponding
|
||||||
|
Source of your version by providing access to the Corresponding Source
|
||||||
|
from a network server at no charge, through some standard or customary
|
||||||
|
means of facilitating copying of software. This Corresponding Source
|
||||||
|
shall include the Corresponding Source for any work covered by version 3
|
||||||
|
of the GNU General Public License that is incorporated pursuant to the
|
||||||
|
following paragraph.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the work with which it is combined will remain governed by version
|
||||||
|
3 of the GNU General Public License.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU Affero General Public License from time to time. Such new versions
|
||||||
|
will be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU Affero General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU Affero General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU Affero General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If your software can interact with users remotely through a computer
|
||||||
|
network, you should also make sure that it provides a way for users to
|
||||||
|
get its source. For example, if your program is a web application, its
|
||||||
|
interface could display a "Source" link that leads users to an archive
|
||||||
|
of the code. There are many ways you could offer source, and different
|
||||||
|
solutions will be better for different programs; see section 13 for the
|
||||||
|
specific requirements.
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU AGPL, see
|
||||||
|
<http://www.gnu.org/licenses/>.
|
||||||
42
README.md
Normal file
42
README.md
Normal file
@ -0,0 +1,42 @@
|
|||||||
|
# com.megaphonetech.relateentities
|
||||||
|
|
||||||
|
(*FIXME: In one or two paragraphs, describe what the extension does and why one would download it. *)
|
||||||
|
|
||||||
|
The extension is licensed under [AGPL-3.0](LICENSE.txt).
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
* PHP v5.6+
|
||||||
|
* CiviCRM (*FIXME: Version number*)
|
||||||
|
|
||||||
|
## Installation (Web UI)
|
||||||
|
|
||||||
|
This extension has not yet been published for installation via the web UI.
|
||||||
|
|
||||||
|
## Installation (CLI, Zip)
|
||||||
|
|
||||||
|
Sysadmins and developers may download the `.zip` file for this extension and
|
||||||
|
install it with the command-line tool [cv](https://github.com/civicrm/cv).
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd <extension-dir>
|
||||||
|
cv dl com.megaphonetech.relateentities@https://github.com/FIXME/com.megaphonetech.relateentities/archive/master.zip
|
||||||
|
```
|
||||||
|
|
||||||
|
## Installation (CLI, Git)
|
||||||
|
|
||||||
|
Sysadmins and developers may clone the [Git](https://en.wikipedia.org/wiki/Git) repo for this extension and
|
||||||
|
install it with the command-line tool [cv](https://github.com/civicrm/cv).
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/FIXME/com.megaphonetech.relateentities.git
|
||||||
|
cv en relateentities
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
(* FIXME: Where would a new user navigate to get started? What changes would they see? *)
|
||||||
|
|
||||||
|
## Known Issues
|
||||||
|
|
||||||
|
(* FIXME *)
|
||||||
41
api/v3/RelateEntities.php
Normal file
41
api/v3/RelateEntities.php
Normal file
@ -0,0 +1,41 @@
|
|||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* This api exposes CiviCRM RelateEntities.
|
||||||
|
*
|
||||||
|
* @package CiviCRM_APIv3
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Save a RelateEntities.
|
||||||
|
*
|
||||||
|
* @param array $params
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
function civicrm_api3_relate_entities_create($params) {
|
||||||
|
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'RelateEntities');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get a RelateEntities.
|
||||||
|
*
|
||||||
|
* @param array $params
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
* Array of retrieved RelateEntities property values.
|
||||||
|
*/
|
||||||
|
function civicrm_api3_relate_entities_get($params) {
|
||||||
|
return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Delete a RelateEntities.
|
||||||
|
*
|
||||||
|
* @param array $params
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
* Array of deleted values.
|
||||||
|
*/
|
||||||
|
function civicrm_api3_relate_entities_delete($params) {
|
||||||
|
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
|
||||||
|
}
|
||||||
27
info.xml
Normal file
27
info.xml
Normal file
@ -0,0 +1,27 @@
|
|||||||
|
<?xml version="1.0"?>
|
||||||
|
<extension key="com.megaphonetech.relateentities" type="module">
|
||||||
|
<file>relateentities</file>
|
||||||
|
<name>Relate Entities</name>
|
||||||
|
<description>FIXME</description>
|
||||||
|
<license>AGPL-3.0</license>
|
||||||
|
<maintainer>
|
||||||
|
<author>Jon Goldberg</author>
|
||||||
|
<email>jon@megaphonetech.com</email>
|
||||||
|
</maintainer>
|
||||||
|
<urls>
|
||||||
|
<url desc="Main Extension Page">http://FIXME</url>
|
||||||
|
<url desc="Documentation">http://FIXME</url>
|
||||||
|
<url desc="Support">http://FIXME</url>
|
||||||
|
<url desc="Licensing">http://www.gnu.org/licenses/agpl-3.0.html</url>
|
||||||
|
</urls>
|
||||||
|
<releaseDate>2019-09-01</releaseDate>
|
||||||
|
<version>1.0</version>
|
||||||
|
<develStage>stable</develStage>
|
||||||
|
<compatibility>
|
||||||
|
<ver>5.13</ver>
|
||||||
|
</compatibility>
|
||||||
|
<comments>This is a new, undeveloped module</comments>
|
||||||
|
<civix>
|
||||||
|
<namespace>CRM/RelateEntities</namespace>
|
||||||
|
</civix>
|
||||||
|
</extension>
|
||||||
472
relateentities.civix.php
Normal file
472
relateentities.civix.php
Normal file
@ -0,0 +1,472 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
// AUTO-GENERATED FILE -- Civix may overwrite any changes made to this file
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The ExtensionUtil class provides small stubs for accessing resources of this
|
||||||
|
* extension.
|
||||||
|
*/
|
||||||
|
class CRM_Relateentities_ExtensionUtil {
|
||||||
|
const SHORT_NAME = "relateentities";
|
||||||
|
const LONG_NAME = "com.megaphonetech.relateentities";
|
||||||
|
const CLASS_PREFIX = "CRM_Relateentities";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Translate a string using the extension's domain.
|
||||||
|
*
|
||||||
|
* If the extension doesn't have a specific translation
|
||||||
|
* for the string, fallback to the default translations.
|
||||||
|
*
|
||||||
|
* @param string $text
|
||||||
|
* Canonical message text (generally en_US).
|
||||||
|
* @param array $params
|
||||||
|
* @return string
|
||||||
|
* Translated text.
|
||||||
|
* @see ts
|
||||||
|
*/
|
||||||
|
public static function ts($text, $params = array()) {
|
||||||
|
if (!array_key_exists('domain', $params)) {
|
||||||
|
$params['domain'] = array(self::LONG_NAME, NULL);
|
||||||
|
}
|
||||||
|
return ts($text, $params);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the URL of a resource file (in this extension).
|
||||||
|
*
|
||||||
|
* @param string|NULL $file
|
||||||
|
* Ex: NULL.
|
||||||
|
* Ex: 'css/foo.css'.
|
||||||
|
* @return string
|
||||||
|
* Ex: 'http://example.org/sites/default/ext/org.example.foo'.
|
||||||
|
* Ex: 'http://example.org/sites/default/ext/org.example.foo/css/foo.css'.
|
||||||
|
*/
|
||||||
|
public static function url($file = NULL) {
|
||||||
|
if ($file === NULL) {
|
||||||
|
return rtrim(CRM_Core_Resources::singleton()->getUrl(self::LONG_NAME), '/');
|
||||||
|
}
|
||||||
|
return CRM_Core_Resources::singleton()->getUrl(self::LONG_NAME, $file);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the path of a resource file (in this extension).
|
||||||
|
*
|
||||||
|
* @param string|NULL $file
|
||||||
|
* Ex: NULL.
|
||||||
|
* Ex: 'css/foo.css'.
|
||||||
|
* @return string
|
||||||
|
* Ex: '/var/www/example.org/sites/default/ext/org.example.foo'.
|
||||||
|
* Ex: '/var/www/example.org/sites/default/ext/org.example.foo/css/foo.css'.
|
||||||
|
*/
|
||||||
|
public static function path($file = NULL) {
|
||||||
|
// return CRM_Core_Resources::singleton()->getPath(self::LONG_NAME, $file);
|
||||||
|
return __DIR__ . ($file === NULL ? '' : (DIRECTORY_SEPARATOR . $file));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the name of a class within this extension.
|
||||||
|
*
|
||||||
|
* @param string $suffix
|
||||||
|
* Ex: 'Page_HelloWorld' or 'Page\\HelloWorld'.
|
||||||
|
* @return string
|
||||||
|
* Ex: 'CRM_Foo_Page_HelloWorld'.
|
||||||
|
*/
|
||||||
|
public static function findClass($suffix) {
|
||||||
|
return self::CLASS_PREFIX . '_' . str_replace('\\', '_', $suffix);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
use CRM_Relateentities_ExtensionUtil as E;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* (Delegated) Implements hook_civicrm_config().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config
|
||||||
|
*/
|
||||||
|
function _relateentities_civix_civicrm_config(&$config = NULL) {
|
||||||
|
static $configured = FALSE;
|
||||||
|
if ($configured) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
$configured = TRUE;
|
||||||
|
|
||||||
|
$template =& CRM_Core_Smarty::singleton();
|
||||||
|
|
||||||
|
$extRoot = dirname(__FILE__) . DIRECTORY_SEPARATOR;
|
||||||
|
$extDir = $extRoot . 'templates';
|
||||||
|
|
||||||
|
if (is_array($template->template_dir)) {
|
||||||
|
array_unshift($template->template_dir, $extDir);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$template->template_dir = array($extDir, $template->template_dir);
|
||||||
|
}
|
||||||
|
|
||||||
|
$include_path = $extRoot . PATH_SEPARATOR . get_include_path();
|
||||||
|
set_include_path($include_path);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* (Delegated) Implements hook_civicrm_xmlMenu().
|
||||||
|
*
|
||||||
|
* @param $files array(string)
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_xmlMenu
|
||||||
|
*/
|
||||||
|
function _relateentities_civix_civicrm_xmlMenu(&$files) {
|
||||||
|
foreach (_relateentities_civix_glob(__DIR__ . '/xml/Menu/*.xml') as $file) {
|
||||||
|
$files[] = $file;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_install().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install
|
||||||
|
*/
|
||||||
|
function _relateentities_civix_civicrm_install() {
|
||||||
|
_relateentities_civix_civicrm_config();
|
||||||
|
if ($upgrader = _relateentities_civix_upgrader()) {
|
||||||
|
$upgrader->onInstall();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_postInstall().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall
|
||||||
|
*/
|
||||||
|
function _relateentities_civix_civicrm_postInstall() {
|
||||||
|
_relateentities_civix_civicrm_config();
|
||||||
|
if ($upgrader = _relateentities_civix_upgrader()) {
|
||||||
|
if (is_callable(array($upgrader, 'onPostInstall'))) {
|
||||||
|
$upgrader->onPostInstall();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_uninstall().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall
|
||||||
|
*/
|
||||||
|
function _relateentities_civix_civicrm_uninstall() {
|
||||||
|
_relateentities_civix_civicrm_config();
|
||||||
|
if ($upgrader = _relateentities_civix_upgrader()) {
|
||||||
|
$upgrader->onUninstall();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* (Delegated) Implements hook_civicrm_enable().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable
|
||||||
|
*/
|
||||||
|
function _relateentities_civix_civicrm_enable() {
|
||||||
|
_relateentities_civix_civicrm_config();
|
||||||
|
if ($upgrader = _relateentities_civix_upgrader()) {
|
||||||
|
if (is_callable(array($upgrader, 'onEnable'))) {
|
||||||
|
$upgrader->onEnable();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* (Delegated) Implements hook_civicrm_disable().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable
|
||||||
|
* @return mixed
|
||||||
|
*/
|
||||||
|
function _relateentities_civix_civicrm_disable() {
|
||||||
|
_relateentities_civix_civicrm_config();
|
||||||
|
if ($upgrader = _relateentities_civix_upgrader()) {
|
||||||
|
if (is_callable(array($upgrader, 'onDisable'))) {
|
||||||
|
$upgrader->onDisable();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* (Delegated) Implements hook_civicrm_upgrade().
|
||||||
|
*
|
||||||
|
* @param $op string, the type of operation being performed; 'check' or 'enqueue'
|
||||||
|
* @param $queue CRM_Queue_Queue, (for 'enqueue') the modifiable list of pending up upgrade tasks
|
||||||
|
*
|
||||||
|
* @return mixed
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_upgrade
|
||||||
|
*/
|
||||||
|
function _relateentities_civix_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
|
||||||
|
if ($upgrader = _relateentities_civix_upgrader()) {
|
||||||
|
return $upgrader->onUpgrade($op, $queue);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return CRM_Relateentities_Upgrader
|
||||||
|
*/
|
||||||
|
function _relateentities_civix_upgrader() {
|
||||||
|
if (!file_exists(__DIR__ . '/CRM/Relateentities/Upgrader.php')) {
|
||||||
|
return NULL;
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
return CRM_Relateentities_Upgrader_Base::instance();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Search directory tree for files which match a glob pattern
|
||||||
|
*
|
||||||
|
* Note: Dot-directories (like "..", ".git", or ".svn") will be ignored.
|
||||||
|
* Note: In Civi 4.3+, delegate to CRM_Utils_File::findFiles()
|
||||||
|
*
|
||||||
|
* @param $dir string, base dir
|
||||||
|
* @param $pattern string, glob pattern, eg "*.txt"
|
||||||
|
* @return array(string)
|
||||||
|
*/
|
||||||
|
function _relateentities_civix_find_files($dir, $pattern) {
|
||||||
|
if (is_callable(array('CRM_Utils_File', 'findFiles'))) {
|
||||||
|
return CRM_Utils_File::findFiles($dir, $pattern);
|
||||||
|
}
|
||||||
|
|
||||||
|
$todos = array($dir);
|
||||||
|
$result = array();
|
||||||
|
while (!empty($todos)) {
|
||||||
|
$subdir = array_shift($todos);
|
||||||
|
foreach (_relateentities_civix_glob("$subdir/$pattern") as $match) {
|
||||||
|
if (!is_dir($match)) {
|
||||||
|
$result[] = $match;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if ($dh = opendir($subdir)) {
|
||||||
|
while (FALSE !== ($entry = readdir($dh))) {
|
||||||
|
$path = $subdir . DIRECTORY_SEPARATOR . $entry;
|
||||||
|
if ($entry{0} == '.') {
|
||||||
|
}
|
||||||
|
elseif (is_dir($path)) {
|
||||||
|
$todos[] = $path;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
closedir($dh);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return $result;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* (Delegated) Implements hook_civicrm_managed().
|
||||||
|
*
|
||||||
|
* Find any *.mgd.php files, merge their content, and return.
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_managed
|
||||||
|
*/
|
||||||
|
function _relateentities_civix_civicrm_managed(&$entities) {
|
||||||
|
$mgdFiles = _relateentities_civix_find_files(__DIR__, '*.mgd.php');
|
||||||
|
sort($mgdFiles);
|
||||||
|
foreach ($mgdFiles as $file) {
|
||||||
|
$es = include $file;
|
||||||
|
foreach ($es as $e) {
|
||||||
|
if (empty($e['module'])) {
|
||||||
|
$e['module'] = E::LONG_NAME;
|
||||||
|
}
|
||||||
|
if (empty($e['params']['version'])) {
|
||||||
|
$e['params']['version'] = '3';
|
||||||
|
}
|
||||||
|
$entities[] = $e;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* (Delegated) Implements hook_civicrm_caseTypes().
|
||||||
|
*
|
||||||
|
* Find any and return any files matching "xml/case/*.xml"
|
||||||
|
*
|
||||||
|
* Note: This hook only runs in CiviCRM 4.4+.
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_caseTypes
|
||||||
|
*/
|
||||||
|
function _relateentities_civix_civicrm_caseTypes(&$caseTypes) {
|
||||||
|
if (!is_dir(__DIR__ . '/xml/case')) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
foreach (_relateentities_civix_glob(__DIR__ . '/xml/case/*.xml') as $file) {
|
||||||
|
$name = preg_replace('/\.xml$/', '', basename($file));
|
||||||
|
if ($name != CRM_Case_XMLProcessor::mungeCaseType($name)) {
|
||||||
|
$errorMessage = sprintf("Case-type file name is malformed (%s vs %s)", $name, CRM_Case_XMLProcessor::mungeCaseType($name));
|
||||||
|
CRM_Core_Error::fatal($errorMessage);
|
||||||
|
// throw new CRM_Core_Exception($errorMessage);
|
||||||
|
}
|
||||||
|
$caseTypes[$name] = array(
|
||||||
|
'module' => E::LONG_NAME,
|
||||||
|
'name' => $name,
|
||||||
|
'file' => $file,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* (Delegated) Implements hook_civicrm_angularModules().
|
||||||
|
*
|
||||||
|
* Find any and return any files matching "ang/*.ang.php"
|
||||||
|
*
|
||||||
|
* Note: This hook only runs in CiviCRM 4.5+.
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_angularModules
|
||||||
|
*/
|
||||||
|
function _relateentities_civix_civicrm_angularModules(&$angularModules) {
|
||||||
|
if (!is_dir(__DIR__ . '/ang')) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$files = _relateentities_civix_glob(__DIR__ . '/ang/*.ang.php');
|
||||||
|
foreach ($files as $file) {
|
||||||
|
$name = preg_replace(':\.ang\.php$:', '', basename($file));
|
||||||
|
$module = include $file;
|
||||||
|
if (empty($module['ext'])) {
|
||||||
|
$module['ext'] = E::LONG_NAME;
|
||||||
|
}
|
||||||
|
$angularModules[$name] = $module;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* (Delegated) Implements hook_civicrm_themes().
|
||||||
|
*
|
||||||
|
* Find any and return any files matching "*.theme.php"
|
||||||
|
*/
|
||||||
|
function _relateentities_civix_civicrm_themes(&$themes) {
|
||||||
|
$files = _relateentities_civix_glob(__DIR__ . '/*.theme.php');
|
||||||
|
foreach ($files as $file) {
|
||||||
|
$themeMeta = include $file;
|
||||||
|
if (empty($themeMeta['name'])) {
|
||||||
|
$themeMeta['name'] = preg_replace(':\.theme\.php$:', '', basename($file));
|
||||||
|
}
|
||||||
|
if (empty($themeMeta['ext'])) {
|
||||||
|
$themeMeta['ext'] = E::LONG_NAME;
|
||||||
|
}
|
||||||
|
$themes[$themeMeta['name']] = $themeMeta;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Glob wrapper which is guaranteed to return an array.
|
||||||
|
*
|
||||||
|
* The documentation for glob() says, "On some systems it is impossible to
|
||||||
|
* distinguish between empty match and an error." Anecdotally, the return
|
||||||
|
* result for an empty match is sometimes array() and sometimes FALSE.
|
||||||
|
* This wrapper provides consistency.
|
||||||
|
*
|
||||||
|
* @link http://php.net/glob
|
||||||
|
* @param string $pattern
|
||||||
|
* @return array, possibly empty
|
||||||
|
*/
|
||||||
|
function _relateentities_civix_glob($pattern) {
|
||||||
|
$result = glob($pattern);
|
||||||
|
return is_array($result) ? $result : array();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Inserts a navigation menu item at a given place in the hierarchy.
|
||||||
|
*
|
||||||
|
* @param array $menu - menu hierarchy
|
||||||
|
* @param string $path - path to parent of this item, e.g. 'my_extension/submenu'
|
||||||
|
* 'Mailing', or 'Administer/System Settings'
|
||||||
|
* @param array $item - the item to insert (parent/child attributes will be
|
||||||
|
* filled for you)
|
||||||
|
*/
|
||||||
|
function _relateentities_civix_insert_navigation_menu(&$menu, $path, $item) {
|
||||||
|
// If we are done going down the path, insert menu
|
||||||
|
if (empty($path)) {
|
||||||
|
$menu[] = array(
|
||||||
|
'attributes' => array_merge(array(
|
||||||
|
'label' => CRM_Utils_Array::value('name', $item),
|
||||||
|
'active' => 1,
|
||||||
|
), $item),
|
||||||
|
);
|
||||||
|
return TRUE;
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
// Find an recurse into the next level down
|
||||||
|
$found = FALSE;
|
||||||
|
$path = explode('/', $path);
|
||||||
|
$first = array_shift($path);
|
||||||
|
foreach ($menu as $key => &$entry) {
|
||||||
|
if ($entry['attributes']['name'] == $first) {
|
||||||
|
if (!isset($entry['child'])) {
|
||||||
|
$entry['child'] = array();
|
||||||
|
}
|
||||||
|
$found = _relateentities_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item, $key);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return $found;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* (Delegated) Implements hook_civicrm_navigationMenu().
|
||||||
|
*/
|
||||||
|
function _relateentities_civix_navigationMenu(&$nodes) {
|
||||||
|
if (!is_callable(array('CRM_Core_BAO_Navigation', 'fixNavigationMenu'))) {
|
||||||
|
_relateentities_civix_fixNavigationMenu($nodes);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Given a navigation menu, generate navIDs for any items which are
|
||||||
|
* missing them.
|
||||||
|
*/
|
||||||
|
function _relateentities_civix_fixNavigationMenu(&$nodes) {
|
||||||
|
$maxNavID = 1;
|
||||||
|
array_walk_recursive($nodes, function($item, $key) use (&$maxNavID) {
|
||||||
|
if ($key === 'navID') {
|
||||||
|
$maxNavID = max($maxNavID, $item);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
_relateentities_civix_fixNavigationMenuItems($nodes, $maxNavID, NULL);
|
||||||
|
}
|
||||||
|
|
||||||
|
function _relateentities_civix_fixNavigationMenuItems(&$nodes, &$maxNavID, $parentID) {
|
||||||
|
$origKeys = array_keys($nodes);
|
||||||
|
foreach ($origKeys as $origKey) {
|
||||||
|
if (!isset($nodes[$origKey]['attributes']['parentID']) && $parentID !== NULL) {
|
||||||
|
$nodes[$origKey]['attributes']['parentID'] = $parentID;
|
||||||
|
}
|
||||||
|
// If no navID, then assign navID and fix key.
|
||||||
|
if (!isset($nodes[$origKey]['attributes']['navID'])) {
|
||||||
|
$newKey = ++$maxNavID;
|
||||||
|
$nodes[$origKey]['attributes']['navID'] = $newKey;
|
||||||
|
$nodes[$newKey] = $nodes[$origKey];
|
||||||
|
unset($nodes[$origKey]);
|
||||||
|
$origKey = $newKey;
|
||||||
|
}
|
||||||
|
if (isset($nodes[$origKey]['child']) && is_array($nodes[$origKey]['child'])) {
|
||||||
|
_relateentities_civix_fixNavigationMenuItems($nodes[$origKey]['child'], $maxNavID, $nodes[$origKey]['attributes']['navID']);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* (Delegated) Implements hook_civicrm_alterSettingsFolders().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_alterSettingsFolders
|
||||||
|
*/
|
||||||
|
function _relateentities_civix_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) {
|
||||||
|
$settingsDir = __DIR__ . DIRECTORY_SEPARATOR . 'settings';
|
||||||
|
if (!in_array($settingsDir, $metaDataFolders) && is_dir($settingsDir)) {
|
||||||
|
$metaDataFolders[] = $settingsDir;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* (Delegated) Implements hook_civicrm_entityTypes().
|
||||||
|
*
|
||||||
|
* Find any *.entityType.php files, merge their content, and return.
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes
|
||||||
|
*/
|
||||||
|
function _relateentities_civix_civicrm_entityTypes(&$entityTypes) {
|
||||||
|
$entityTypes = array_merge($entityTypes, []);
|
||||||
|
}
|
||||||
190
relateentities.php
Normal file
190
relateentities.php
Normal file
@ -0,0 +1,190 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
require_once 'relateentities.civix.php';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_config().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/
|
||||||
|
*/
|
||||||
|
function relateentities_civicrm_config(&$config) {
|
||||||
|
_relateentities_civix_civicrm_config($config);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_xmlMenu().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_xmlMenu
|
||||||
|
*/
|
||||||
|
function relateentities_civicrm_xmlMenu(&$files) {
|
||||||
|
_relateentities_civix_civicrm_xmlMenu($files);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_install().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install
|
||||||
|
*/
|
||||||
|
function relateentities_civicrm_install() {
|
||||||
|
_relateentities_civix_civicrm_install();
|
||||||
|
CRM_RelateEntities_Settings::install();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_postInstall().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall
|
||||||
|
*/
|
||||||
|
function relateentities_civicrm_postInstall() {
|
||||||
|
_relateentities_civix_civicrm_postInstall();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_uninstall().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall
|
||||||
|
*/
|
||||||
|
function relateentities_civicrm_uninstall() {
|
||||||
|
_relateentities_civix_civicrm_uninstall();
|
||||||
|
CRM_RelateEntities_Settings::uninstall();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_enable().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable
|
||||||
|
*/
|
||||||
|
function relateentities_civicrm_enable() {
|
||||||
|
_relateentities_civix_civicrm_enable();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_disable().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable
|
||||||
|
*/
|
||||||
|
function relateentities_civicrm_disable() {
|
||||||
|
_relateentities_civix_civicrm_disable();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_upgrade().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_upgrade
|
||||||
|
*/
|
||||||
|
function relateentities_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
|
||||||
|
return _relateentities_civix_civicrm_upgrade($op, $queue);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_managed().
|
||||||
|
*
|
||||||
|
* Generate a list of entities to create/deactivate/delete when this module
|
||||||
|
* is installed, disabled, uninstalled.
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_managed
|
||||||
|
*/
|
||||||
|
function relateentities_civicrm_managed(&$entities) {
|
||||||
|
_relateentities_civix_civicrm_managed($entities);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_caseTypes().
|
||||||
|
*
|
||||||
|
* Generate a list of case-types.
|
||||||
|
*
|
||||||
|
* Note: This hook only runs in CiviCRM 4.4+.
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_caseTypes
|
||||||
|
*/
|
||||||
|
function relateentities_civicrm_caseTypes(&$caseTypes) {
|
||||||
|
_relateentities_civix_civicrm_caseTypes($caseTypes);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_angularModules().
|
||||||
|
*
|
||||||
|
* Generate a list of Angular modules.
|
||||||
|
*
|
||||||
|
* Note: This hook only runs in CiviCRM 4.5+. It may
|
||||||
|
* use features only available in v4.6+.
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_angularModules
|
||||||
|
*/
|
||||||
|
function relateentities_civicrm_angularModules(&$angularModules) {
|
||||||
|
_relateentities_civix_civicrm_angularModules($angularModules);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_alterSettingsFolders().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_alterSettingsFolders
|
||||||
|
*/
|
||||||
|
function relateentities_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) {
|
||||||
|
_relateentities_civix_civicrm_alterSettingsFolders($metaDataFolders);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_entityTypes().
|
||||||
|
*
|
||||||
|
* Declare entity types provided by this module.
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes
|
||||||
|
*/
|
||||||
|
function relateentities_civicrm_entityTypes(&$entityTypes) {
|
||||||
|
_relateentities_civix_civicrm_entityTypes($entityTypes);
|
||||||
|
$entityTypes[] = [
|
||||||
|
'name' => 'RelateEntities',
|
||||||
|
'class' => 'CRM_RelateEntities_DAO_RelateEntities',
|
||||||
|
'table' => 'civicrm_relate_entities',
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_thems().
|
||||||
|
*/
|
||||||
|
function relateentities_civicrm_themes(&$themes) {
|
||||||
|
_relateentities_civix_civicrm_themes($themes);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_tabset().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_tabset
|
||||||
|
*/
|
||||||
|
function relateentities_civicrm_tabset($tabsetName, &$tabs, $context) {
|
||||||
|
if ('civicrm/contact/view' == $tabsetName) {
|
||||||
|
$tabs[] = [
|
||||||
|
'id' => 'relateentities',
|
||||||
|
'url' => CRM_Utils_System::url(
|
||||||
|
'civicrm/relateentities/list',
|
||||||
|
"reset=1&entityId={$context['contact_id']}&entityTable=Contact"
|
||||||
|
),
|
||||||
|
'title' => ts('Related Entities'),
|
||||||
|
'weight' => '35',
|
||||||
|
'count' => CRM_RelateEntities_Utils::getRelatedEntities(
|
||||||
|
'Contact', $context['contact_id'], FALSE, TRUE
|
||||||
|
),
|
||||||
|
'class' => 'livePage',
|
||||||
|
'icon' => 'crm-i fa-handshake-o',
|
||||||
|
];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function relateentities_civicrm_pageRun(&$page) {
|
||||||
|
if (is_a($page, 'CRM_Financial_Page_FinancialType')) {
|
||||||
|
$page->assign('entityTable', 'FinancialType');
|
||||||
|
$financialTypes = $page->get_template_vars('rows');
|
||||||
|
foreach ($financialTypes as &$financialType) {
|
||||||
|
$url = CRM_Utils_System::url(
|
||||||
|
'civicrm/relateentities/list',
|
||||||
|
"reset=1&entityTable=FinancialType&entityId={$financialType['id']}"
|
||||||
|
);
|
||||||
|
$financialType['expand'] = '<td><a class="nowrap bold crm-expand-row" title="' . ts('view related entity') . '" href="' . $url . '"></a></td>';
|
||||||
|
}
|
||||||
|
$page->assign('rows', $financialTypes);
|
||||||
|
CRM_Core_Region::instance('page-body')->add([
|
||||||
|
'template' => 'CRM/RelateEntities/Expand.tpl',
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
}
|
||||||
21
templates/CRM/RelateEntities/Common.tpl
Normal file
21
templates/CRM/RelateEntities/Common.tpl
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
<div class="crm-accordion-wrapper crm-search_filters-accordion">
|
||||||
|
<a accesskey="N" href="{crmURL p='civicrm/relatedentities/add' q="action=add&reset=1&entityTable=$entityTable&entityId=$entityId"}" class="button"><span><i class="crm-i fa-plus-circle"></i> {ts}New Entity relation{/ts}</span></a>
|
||||||
|
</div>
|
||||||
|
</br></br>
|
||||||
|
{include file="CRM/common/enableDisableApi.tpl"}
|
||||||
|
{foreach from=$relatedEntities item="relatedEntity" key="entityRef"}
|
||||||
|
<h3>{ts}{$relatedEntity.label}{/ts}</h3>
|
||||||
|
<table id='related-entities' class="related-entities-selector-{$entityTable}-{$entityId} crm-ajax-table"
|
||||||
|
data-ajax="{crmURL p="civicrm/ajax/relatedentities" q="entityTable=$entityTable&entityId=$entityId&entityTableB=$entityRef"}"
|
||||||
|
dataref='{$entityRef}'>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
{foreach from=$relatedEntity.columns item="header" key="key"}
|
||||||
|
<th data-data="{$key}" class="crm-related-entities-{$key}">{ts}{$header}{/ts}</th>
|
||||||
|
{/foreach}
|
||||||
|
<th data-data="links" data-orderable="false" class="crm-related-entities-links"> </th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
</table>
|
||||||
|
</br></br>
|
||||||
|
{/foreach}
|
||||||
12
templates/CRM/RelateEntities/Expand.tpl
Normal file
12
templates/CRM/RelateEntities/Expand.tpl
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
{crmScript file='js/crm.expandRow.js'}
|
||||||
|
{literal}
|
||||||
|
<script type="text/javascript">
|
||||||
|
CRM.$(function($) {
|
||||||
|
let rows = {/literal}{$rows|@json_encode}{literal};
|
||||||
|
$('table tr th:first').before('<th></th>');
|
||||||
|
$.each(rows, function(index, value) {
|
||||||
|
$('table tr#financial_type-' + value['id'] + ' td:first').before(value['expand']);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
{/literal}
|
||||||
1
templates/CRM/RelateEntities/Form/RelatedEntity.tpl
Normal file
1
templates/CRM/RelateEntities/Form/RelatedEntity.tpl
Normal file
@ -0,0 +1 @@
|
|||||||
|
{include file="CRM/Core/Form/EntityForm.tpl"}
|
||||||
7
templates/CRM/RelateEntities/Page/Tab.tpl
Normal file
7
templates/CRM/RelateEntities/Page/Tab.tpl
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
{if $action eq 1 or $action eq 2 or $action eq 8}
|
||||||
|
{include file="CRM/RelateEntities/Form/RelatedEntity.tpl"}
|
||||||
|
{else}
|
||||||
|
<div class="crm-related-entities-{$context}">
|
||||||
|
{include file="CRM/RelateEntities/Common.tpl"}
|
||||||
|
</div>
|
||||||
|
{/if}
|
||||||
21
xml/Menu/relateentities.xml
Normal file
21
xml/Menu/relateentities.xml
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
<?xml version="1.0" encoding="iso-8859-1" ?>
|
||||||
|
<menu>
|
||||||
|
<item>
|
||||||
|
<path>civicrm/relateentities/list</path>
|
||||||
|
<title>Related Entities</title>
|
||||||
|
<page_callback>CRM_RelateEntities_Page_Tab</page_callback>
|
||||||
|
<access_arguments>access CiviCRM</access_arguments>
|
||||||
|
</item>
|
||||||
|
<item>
|
||||||
|
<path>civicrm/ajax/relatedentities</path>
|
||||||
|
<page_callback>CRM_RelateEntities_Utils::getList</page_callback>
|
||||||
|
<access_arguments>access CiviCRM</access_arguments>
|
||||||
|
</item>
|
||||||
|
<item>
|
||||||
|
<path>civicrm/relatedentities/add</path>
|
||||||
|
<title>New Related Entity</title>
|
||||||
|
<page_callback>CRM_RelateEntities_Page_Tab</page_callback>
|
||||||
|
<path_arguments>action=add</path_arguments>
|
||||||
|
<access_arguments>access CiviCRM</access_arguments>
|
||||||
|
</item>
|
||||||
|
</menu>
|
||||||
Loading…
Reference in New Issue
Block a user