diff --git a/CHANGELOG.md b/CHANGELOG.md index 342a656..9bd1de8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,12 @@ # Changelog All notable changes for the CiviGeometry extension will be noted here. +## [1.12.0] - 2023-08-01 +### Added + - Geometry.getcachedoverlaps APIv4 method + - `reason` field for Geometry-Entity relationship table (`civigeometry_geometry_entity`) + - Managed Entity Option Group for the `reason` field + ## [1.11.0] - 2023-07-28 ### Added - GeometryEntity APIv4 entity with basic CRUD methods diff --git a/CRM/CiviGeometry/DAO/Geometry.php b/CRM/CiviGeometry/DAO/Geometry.php index c65e7fd..624ba96 100644 --- a/CRM/CiviGeometry/DAO/Geometry.php +++ b/CRM/CiviGeometry/DAO/Geometry.php @@ -6,7 +6,7 @@ * * Generated from au.org.greens.civigeometry/xml/schema/CRM/CiviGeometry/Geometry.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:02ef5e8786d1988485a442e43b15f27c) + * (GenCodeChecksum:26998ebb213bbf12a7c407b781fe0d94) */ use CRM_CiviGeometry_ExtensionUtil as E; @@ -24,6 +24,13 @@ class CRM_CiviGeometry_DAO_Geometry extends CRM_Core_DAO { */ public static $_tableName = 'civigeometry_geometry'; + /** + * Field to show when displaying a record. + * + * @var string + */ + public static $_labelField = 'label'; + /** * Should CiviCRM log any modifications to this table in the civicrm_log table. * @@ -138,6 +145,7 @@ public static function &fields() { 'id' => [ 'name' => 'id', 'type' => CRM_Utils_Type::T_INT, + 'title' => E::ts('ID'), 'description' => E::ts('Unique Geometry ID'), 'required' => TRUE, 'where' => 'civigeometry_geometry.id', @@ -207,6 +215,7 @@ public static function &fields() { 'is_archived' => [ 'name' => 'is_archived', 'type' => CRM_Utils_Type::T_BOOLEAN, + 'title' => E::ts('Is Archived'), 'description' => E::ts('Is this geometry archived?'), 'where' => 'civigeometry_geometry.is_archived', 'default' => '0', diff --git a/CRM/CiviGeometry/DAO/GeometryCollection.php b/CRM/CiviGeometry/DAO/GeometryCollection.php index cfc5760..9df5cbe 100644 --- a/CRM/CiviGeometry/DAO/GeometryCollection.php +++ b/CRM/CiviGeometry/DAO/GeometryCollection.php @@ -6,7 +6,7 @@ * * Generated from au.org.greens.civigeometry/xml/schema/CRM/CiviGeometry/GeometryCollection.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:c820f9c0629916039df11d4895ede8d7) + * (GenCodeChecksum:d7e88053931cda06bec713f1afdebe86) */ use CRM_CiviGeometry_ExtensionUtil as E; @@ -24,6 +24,13 @@ class CRM_CiviGeometry_DAO_GeometryCollection extends CRM_Core_DAO { */ public static $_tableName = 'civigeometry_geometry_collection'; + /** + * Field to show when displaying a record. + * + * @var string + */ + public static $_labelField = 'label'; + /** * Should CiviCRM log any modifications to this table in the civicrm_log table. * @@ -138,6 +145,7 @@ public static function &fields() { 'id' => [ 'name' => 'id', 'type' => CRM_Utils_Type::T_INT, + 'title' => E::ts('ID'), 'description' => E::ts('Unique GeometryCollection ID'), 'required' => TRUE, 'where' => 'civigeometry_geometry_collection.id', @@ -151,6 +159,7 @@ public static function &fields() { 'geometry_collection_type_id' => [ 'name' => 'geometry_collection_type_id', 'type' => CRM_Utils_Type::T_INT, + 'title' => E::ts('Geometry Collection Type ID'), 'description' => E::ts('FK to civigeomety_geometry_collection_type'), 'required' => TRUE, 'where' => 'civigeometry_geometry_collection.geometry_collection_type_id', @@ -226,6 +235,7 @@ public static function &fields() { 'is_archived' => [ 'name' => 'is_archived', 'type' => CRM_Utils_Type::T_BOOLEAN, + 'title' => E::ts('Is Archived'), 'description' => E::ts('Is this Geometry Collection archived'), 'where' => 'civigeometry_geometry_collection.is_archived', 'default' => '0', diff --git a/CRM/CiviGeometry/DAO/GeometryCollectionGeometry.php b/CRM/CiviGeometry/DAO/GeometryCollectionGeometry.php index 29a22d8..b3ea201 100644 --- a/CRM/CiviGeometry/DAO/GeometryCollectionGeometry.php +++ b/CRM/CiviGeometry/DAO/GeometryCollectionGeometry.php @@ -6,7 +6,7 @@ * * Generated from au.org.greens.civigeometry/xml/schema/CRM/CiviGeometry/GeometryCollectionGeometry.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:0ba274e3125b1d7bf07d40ce082527d5) + * (GenCodeChecksum:4e26bec81904d9c27d1c7a9f51f92027) */ use CRM_CiviGeometry_ExtensionUtil as E; @@ -103,6 +103,7 @@ public static function &fields() { 'id' => [ 'name' => 'id', 'type' => CRM_Utils_Type::T_INT, + 'title' => E::ts('ID'), 'description' => E::ts('Unique Geometry ID'), 'required' => TRUE, 'where' => 'civigeometry_geometry_collection_geometry.id', diff --git a/CRM/CiviGeometry/DAO/GeometryCollectionType.php b/CRM/CiviGeometry/DAO/GeometryCollectionType.php index e0efc74..f6d50cb 100644 --- a/CRM/CiviGeometry/DAO/GeometryCollectionType.php +++ b/CRM/CiviGeometry/DAO/GeometryCollectionType.php @@ -6,7 +6,7 @@ * * Generated from au.org.greens.civigeometry/xml/schema/CRM/CiviGeometry/GeometryCollectionType.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:fe2fcc715214608bf7cab118a93e28ec) + * (GenCodeChecksum:86243c796dbd1fa2321213290abca599) */ use CRM_CiviGeometry_ExtensionUtil as E; @@ -24,6 +24,13 @@ class CRM_CiviGeometry_DAO_GeometryCollectionType extends CRM_Core_DAO { */ public static $_tableName = 'civigeometry_geometry_collection_type'; + /** + * Field to show when displaying a record. + * + * @var string + */ + public static $_labelField = 'label'; + /** * Should CiviCRM log any modifications to this table in the civicrm_log table. * @@ -87,6 +94,7 @@ public static function &fields() { 'id' => [ 'name' => 'id', 'type' => CRM_Utils_Type::T_INT, + 'title' => E::ts('ID'), 'description' => E::ts('Unique GeometryCollectionType ID'), 'required' => TRUE, 'where' => 'civigeometry_geometry_collection_type.id', diff --git a/CRM/CiviGeometry/DAO/GeometryEntity.php b/CRM/CiviGeometry/DAO/GeometryEntity.php index 2f0cc07..29e11b7 100644 --- a/CRM/CiviGeometry/DAO/GeometryEntity.php +++ b/CRM/CiviGeometry/DAO/GeometryEntity.php @@ -6,7 +6,7 @@ * * Generated from au.org.greens.civigeometry/xml/schema/CRM/CiviGeometry/GeometryEntity.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:8c5ae45be2adee0affc8827859427d90) + * (GenCodeChecksum:975a5fa2a229cae5b909950513534982) */ use CRM_CiviGeometry_ExtensionUtil as E; @@ -76,6 +76,15 @@ class CRM_CiviGeometry_DAO_GeometryEntity extends CRM_Core_DAO { */ public $expiry_date; + /** + * The reason for the relationship between the geometry and entity + * + * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. + */ + public $reason; + /** * Class constructor. */ @@ -120,6 +129,7 @@ public static function &fields() { 'id' => [ 'name' => 'id', 'type' => CRM_Utils_Type::T_INT, + 'title' => E::ts('ID'), 'description' => E::ts('Unique GeometryEntity ID'), 'required' => TRUE, 'where' => 'civigeometry_geometry_entity.id', @@ -133,6 +143,7 @@ public static function &fields() { 'entity_id' => [ 'name' => 'entity_id', 'type' => CRM_Utils_Type::T_INT, + 'title' => E::ts('Entity ID'), 'description' => E::ts('entity id that is associated with this geometry'), 'required' => TRUE, 'where' => 'civigeometry_geometry_entity.entity_id', @@ -160,6 +171,7 @@ public static function &fields() { 'geometry_id' => [ 'name' => 'geometry_id', 'type' => CRM_Utils_Type::T_INT, + 'title' => E::ts('Geometry ID'), 'description' => E::ts('FK to Geometry Table'), 'required' => TRUE, 'where' => 'civigeometry_geometry_entity.geometry_id', @@ -184,6 +196,26 @@ public static function &fields() { 'localizable' => 0, 'add' => NULL, ], + 'reason' => [ + 'name' => 'reason', + 'type' => CRM_Utils_Type::T_STRING, + 'title' => E::ts('Reason'), + 'description' => E::ts('The reason for the relationship between the geometry and entity'), + 'required' => FALSE, + 'maxlength' => 64, + 'size' => CRM_Utils_Type::BIG, + 'where' => 'civigeometry_geometry_entity.reason', + 'default' => NULL, + 'table_name' => 'civigeometry_geometry_entity', + 'entity' => 'GeometryEntity', + 'bao' => 'CRM_CiviGeometry_DAO_GeometryEntity', + 'localizable' => 0, + 'pseudoconstant' => [ + 'optionGroupName' => 'OptionGroup_geom_entity_relationship_reason', + 'optionEditPath' => 'civicrm/admin/options/OptionGroup_geom_entity_relationship_reason', + ], + 'add' => NULL, + ], ]; CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); } diff --git a/CRM/CiviGeometry/DAO/GeometryOverlapCache.php b/CRM/CiviGeometry/DAO/GeometryOverlapCache.php index 646a7a0..36efe0a 100644 --- a/CRM/CiviGeometry/DAO/GeometryOverlapCache.php +++ b/CRM/CiviGeometry/DAO/GeometryOverlapCache.php @@ -6,7 +6,7 @@ * * Generated from au.org.greens.civigeometry/xml/schema/CRM/CiviGeometry/GeometryOverlapCache.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:1fc0b657148c8d261d843726695c294f) + * (GenCodeChecksum:12f52bd7c9efbede862ca6997f14201e) */ use CRM_CiviGeometry_ExtensionUtil as E; @@ -121,6 +121,7 @@ public static function &fields() { 'id' => [ 'name' => 'id', 'type' => CRM_Utils_Type::T_INT, + 'title' => E::ts('ID'), 'description' => E::ts('Unique Geometry ID'), 'required' => TRUE, 'where' => 'civigeometry_geometry_overlap_cache.id', diff --git a/CRM/CiviGeometry/DAO/GeometryType.php b/CRM/CiviGeometry/DAO/GeometryType.php index 94b0f3a..6e63d36 100644 --- a/CRM/CiviGeometry/DAO/GeometryType.php +++ b/CRM/CiviGeometry/DAO/GeometryType.php @@ -6,7 +6,7 @@ * * Generated from au.org.greens.civigeometry/xml/schema/CRM/CiviGeometry/GeometryType.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:7b6b7d9f84ac90e433434b302751ff87) + * (GenCodeChecksum:bca42adf6d80d8b90da5abb2a7b7cf75) */ use CRM_CiviGeometry_ExtensionUtil as E; @@ -24,6 +24,13 @@ class CRM_CiviGeometry_DAO_GeometryType extends CRM_Core_DAO { */ public static $_tableName = 'civigeometry_geometry_type'; + /** + * Field to show when displaying a record. + * + * @var string + */ + public static $_labelField = 'label'; + /** * Should CiviCRM log any modifications to this table in the civicrm_log table. * @@ -87,6 +94,7 @@ public static function &fields() { 'id' => [ 'name' => 'id', 'type' => CRM_Utils_Type::T_INT, + 'title' => E::ts('ID'), 'description' => E::ts('Unique GeometryType ID'), 'required' => TRUE, 'where' => 'civigeometry_geometry_type.id', diff --git a/CRM/CiviGeometry/Upgrader.php b/CRM/CiviGeometry/Upgrader.php index a11190e..76aec30 100644 --- a/CRM/CiviGeometry/Upgrader.php +++ b/CRM/CiviGeometry/Upgrader.php @@ -3,7 +3,7 @@ /** * Collection of upgrade steps. */ -class CRM_CiviGeometry_Upgrader extends CRM_CiviGeometry_Upgrader_Base { +class CRM_CiviGeometry_Upgrader extends CRM_Extension_Upgrader_Base { // By convention, functions that look like "function upgrade_NNNN()" are // upgrade tasks. They are executed in order (like Drupal's hook_update_N). @@ -180,4 +180,10 @@ public function upgrade_5184() { return TRUE; } + public function upgrade_5200() { + $this->ctx->log->info('Applying update 5200 - Adding reason field to civigeometry_geometry_entity table'); + CRM_Core_DAO::executeQuery("ALTER TABLE civigeometry_geometry_entity ADD COLUMN reason varchar(64) DEFAULT NULL COMMENT 'Reason for relationship between geometry and entity'"); + return TRUE; + } + } diff --git a/CRM/CiviGeometry/Upgrader/Base.php b/CRM/CiviGeometry/Upgrader/Base.php deleted file mode 100644 index 76530b0..0000000 --- a/CRM/CiviGeometry/Upgrader/Base.php +++ /dev/null @@ -1,397 +0,0 @@ -ctx = array_shift($args); - $instance->queue = $instance->ctx->queue; - $method = array_shift($args); - return call_user_func_array([$instance, $method], $args); - } - - /** - * CRM_CiviGeometry_Upgrader_Base constructor. - * - * @param $extensionName - * @param $extensionDir - */ - public function __construct($extensionName, $extensionDir) { - $this->extensionName = $extensionName; - $this->extensionDir = $extensionDir; - } - - // ******** Task helpers ******** - - /** - * Run a CustomData file. - * - * @param string $relativePath - * the CustomData XML file path (relative to this extension's dir) - * @return bool - */ - public function executeCustomDataFile($relativePath) { - $xml_file = $this->extensionDir . '/' . $relativePath; - return $this->executeCustomDataFileByAbsPath($xml_file); - } - - /** - * Run a CustomData file - * - * @param string $xml_file - * the CustomData XML file path (absolute path) - * - * @return bool - */ - protected function executeCustomDataFileByAbsPath($xml_file) { - $import = new CRM_Utils_Migrate_Import(); - $import->run($xml_file); - return TRUE; - } - - /** - * Run a SQL file. - * - * @param string $relativePath - * the SQL file path (relative to this extension's dir) - * - * @return bool - */ - public function executeSqlFile($relativePath) { - CRM_Utils_File::sourceSQLFile( - CIVICRM_DSN, - $this->extensionDir . DIRECTORY_SEPARATOR . $relativePath - ); - return TRUE; - } - - /** - * Run the sql commands in the specified file. - * - * @param string $tplFile - * The SQL file path (relative to this extension's dir). - * Ex: "sql/mydata.mysql.tpl". - * - * @return bool - * @throws \CRM_Core_Exception - */ - public function executeSqlTemplate($tplFile) { - // Assign multilingual variable to Smarty. - $upgrade = new CRM_Upgrade_Form(); - - $tplFile = CRM_Utils_File::isAbsolute($tplFile) ? $tplFile : $this->extensionDir . DIRECTORY_SEPARATOR . $tplFile; - $smarty = CRM_Core_Smarty::singleton(); - $smarty->assign('domainID', CRM_Core_Config::domainID()); - CRM_Utils_File::sourceSQLFile( - CIVICRM_DSN, $smarty->fetch($tplFile), NULL, TRUE - ); - return TRUE; - } - - /** - * Run one SQL query. - * - * This is just a wrapper for CRM_Core_DAO::executeSql, but it - * provides syntactic sugar for queueing several tasks that - * run different queries - * - * @return bool - */ - public function executeSql($query, $params = []) { - // FIXME verify that we raise an exception on error - CRM_Core_DAO::executeQuery($query, $params); - return TRUE; - } - - /** - * Syntactic sugar for enqueuing a task which calls a function in this class. - * - * The task is weighted so that it is processed - * as part of the currently-pending revision. - * - * After passing the $funcName, you can also pass parameters that will go to - * the function. Note that all params must be serializable. - */ - public function addTask($title) { - $args = func_get_args(); - $title = array_shift($args); - $task = new CRM_Queue_Task( - [get_class($this), '_queueAdapter'], - $args, - $title - ); - return $this->queue->createItem($task, ['weight' => -1]); - } - - // ******** Revision-tracking helpers ******** - - /** - * Determine if there are any pending revisions. - * - * @return bool - */ - public function hasPendingRevisions() { - $revisions = $this->getRevisions(); - $currentRevision = $this->getCurrentRevision(); - - if (empty($revisions)) { - return FALSE; - } - if (empty($currentRevision)) { - return TRUE; - } - - return ($currentRevision < max($revisions)); - } - - /** - * Add any pending revisions to the queue. - * - * @param CRM_Queue_Queue $queue - */ - public function enqueuePendingRevisions(CRM_Queue_Queue $queue) { - $this->queue = $queue; - - $currentRevision = $this->getCurrentRevision(); - foreach ($this->getRevisions() as $revision) { - if ($revision > $currentRevision) { - $title = E::ts('Upgrade %1 to revision %2', [ - 1 => $this->extensionName, - 2 => $revision, - ]); - - // note: don't use addTask() because it sets weight=-1 - - $task = new CRM_Queue_Task( - [get_class($this), '_queueAdapter'], - ['upgrade_' . $revision], - $title - ); - $this->queue->createItem($task); - - $task = new CRM_Queue_Task( - [get_class($this), '_queueAdapter'], - ['setCurrentRevision', $revision], - $title - ); - $this->queue->createItem($task); - } - } - } - - /** - * Get a list of revisions. - * - * @return array - * revisionNumbers sorted numerically - */ - public function getRevisions() { - if (!is_array($this->revisions)) { - $this->revisions = []; - - $clazz = new ReflectionClass(get_class($this)); - $methods = $clazz->getMethods(); - foreach ($methods as $method) { - if (preg_match('/^upgrade_(.*)/', $method->name, $matches)) { - $this->revisions[] = $matches[1]; - } - } - sort($this->revisions, SORT_NUMERIC); - } - - return $this->revisions; - } - - public function getCurrentRevision() { - $revision = CRM_Core_BAO_Extension::getSchemaVersion($this->extensionName); - if (!$revision) { - $revision = $this->getCurrentRevisionDeprecated(); - } - return $revision; - } - - private function getCurrentRevisionDeprecated() { - $key = $this->extensionName . ':version'; - if ($revision = \Civi::settings()->get($key)) { - $this->revisionStorageIsDeprecated = TRUE; - } - return $revision; - } - - public function setCurrentRevision($revision) { - CRM_Core_BAO_Extension::setSchemaVersion($this->extensionName, $revision); - // clean up legacy schema version store (CRM-19252) - $this->deleteDeprecatedRevision(); - return TRUE; - } - - private function deleteDeprecatedRevision() { - if ($this->revisionStorageIsDeprecated) { - $setting = new CRM_Core_BAO_Setting(); - $setting->name = $this->extensionName . ':version'; - $setting->delete(); - CRM_Core_Error::debug_log_message("Migrated extension schema revision ID for {$this->extensionName} from civicrm_setting (deprecated) to civicrm_extension.\n"); - } - } - - // ******** Hook delegates ******** - - /** - * @see https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install - */ - public function onInstall() { - $files = glob($this->extensionDir . '/sql/*_install.sql'); - if (is_array($files)) { - foreach ($files as $file) { - CRM_Utils_File::sourceSQLFile(CIVICRM_DSN, $file); - } - } - $files = glob($this->extensionDir . '/sql/*_install.mysql.tpl'); - if (is_array($files)) { - foreach ($files as $file) { - $this->executeSqlTemplate($file); - } - } - $files = glob($this->extensionDir . '/xml/*_install.xml'); - if (is_array($files)) { - foreach ($files as $file) { - $this->executeCustomDataFileByAbsPath($file); - } - } - if (is_callable([$this, 'install'])) { - $this->install(); - } - } - - /** - * @see https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall - */ - public function onPostInstall() { - $revisions = $this->getRevisions(); - if (!empty($revisions)) { - $this->setCurrentRevision(max($revisions)); - } - if (is_callable([$this, 'postInstall'])) { - $this->postInstall(); - } - } - - /** - * @see https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall - */ - public function onUninstall() { - $files = glob($this->extensionDir . '/sql/*_uninstall.mysql.tpl'); - if (is_array($files)) { - foreach ($files as $file) { - $this->executeSqlTemplate($file); - } - } - if (is_callable([$this, 'uninstall'])) { - $this->uninstall(); - } - $files = glob($this->extensionDir . '/sql/*_uninstall.sql'); - if (is_array($files)) { - foreach ($files as $file) { - CRM_Utils_File::sourceSQLFile(CIVICRM_DSN, $file); - } - } - } - - /** - * @see https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable - */ - public function onEnable() { - // stub for possible future use - if (is_callable([$this, 'enable'])) { - $this->enable(); - } - } - - /** - * @see https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable - */ - public function onDisable() { - // stub for possible future use - if (is_callable([$this, 'disable'])) { - $this->disable(); - } - } - - public function onUpgrade($op, CRM_Queue_Queue $queue = NULL) { - switch ($op) { - case 'check': - return [$this->hasPendingRevisions()]; - - case 'enqueue': - return $this->enqueuePendingRevisions($queue); - - default: - } - } - -} diff --git a/Civi/Api4/Action/Geometry/GetCachedOverlaps.php b/Civi/Api4/Action/Geometry/GetCachedOverlaps.php index e093efe..9098416 100644 --- a/Civi/Api4/Action/Geometry/GetCachedOverlaps.php +++ b/Civi/Api4/Action/Geometry/GetCachedOverlaps.php @@ -7,7 +7,7 @@ /** * Get Overlaps between 2 Geometries. * @method getGeometryId() - * @method setGeometryId($geometry_id) + * @method setGeometryId(int|array $geometry_id) * @method getOverlap() * @method setOverlap(int $overlap) */ @@ -16,7 +16,8 @@ class GetCachedOverlaps extends \Civi\Api4\Generic\AbstractAction { /** * Geometry id a * - * @var int + * @var int|array + * @required */ protected $geometry_id; @@ -32,6 +33,12 @@ public function _run(Result $result) { 'geometry_id' => $this->geometry_id, 'overlap' => $this->overlap, ]; + // If we've been passed an array of geometry IDs, we need to transform + // the geometry_id value to be a nested array of the shape + // "IN" => [geometry_id, geometry_id, ...] + if (is_array($params['geometry_id'])) { + $params['geometry_id'] = ['IN' => $params['geometry_id']]; + } $dbResult = \CRM_CiviGeometry_BAO_Geometry::getCachedOverlappingGeometries($params); foreach ($dbResult as $res) { $result[] = $res; diff --git a/civigeometry.civix.php b/civigeometry.civix.php index a579b38..5d6a48d 100644 --- a/civigeometry.civix.php +++ b/civigeometry.civix.php @@ -24,7 +24,7 @@ class CRM_CiviGeometry_ExtensionUtil { * Translated text. * @see ts */ - public static function ts($text, $params = []) { + public static function ts($text, $params = []): string { if (!array_key_exists('domain', $params)) { $params['domain'] = [self::LONG_NAME, NULL]; } @@ -41,7 +41,7 @@ public static function ts($text, $params = []) { * 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) { + public static function url($file = NULL): string { if ($file === NULL) { return rtrim(CRM_Core_Resources::singleton()->getUrl(self::LONG_NAME), '/'); } @@ -84,40 +84,17 @@ public static function findClass($suffix) { * * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config */ -function _civigeometry_civix_civicrm_config(&$config = NULL) { +function _civigeometry_civix_civicrm_config($config = NULL) { static $configured = FALSE; if ($configured) { return; } $configured = TRUE; - $template = CRM_Core_Smarty::singleton(); - $extRoot = __DIR__ . DIRECTORY_SEPARATOR; - $extDir = $extRoot . 'templates'; - - if (is_array($template->template_dir)) { - array_unshift($template->template_dir, $extDir); - } - else { - $template->template_dir = [$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 _civigeometry_civix_civicrm_xmlMenu(&$files) { - foreach (_civigeometry_civix_glob(__DIR__ . '/xml/Menu/*.xml') as $file) { - $files[] = $file; - } + // Based on , this does not currently require mixin/polyfill.php. } /** @@ -127,35 +104,7 @@ function _civigeometry_civix_civicrm_xmlMenu(&$files) { */ function _civigeometry_civix_civicrm_install() { _civigeometry_civix_civicrm_config(); - if ($upgrader = _civigeometry_civix_upgrader()) { - $upgrader->onInstall(); - } -} - -/** - * Implements hook_civicrm_postInstall(). - * - * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall - */ -function _civigeometry_civix_civicrm_postInstall() { - _civigeometry_civix_civicrm_config(); - if ($upgrader = _civigeometry_civix_upgrader()) { - if (is_callable([$upgrader, 'onPostInstall'])) { - $upgrader->onPostInstall(); - } - } -} - -/** - * Implements hook_civicrm_uninstall(). - * - * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall - */ -function _civigeometry_civix_civicrm_uninstall() { - _civigeometry_civix_civicrm_config(); - if ($upgrader = _civigeometry_civix_upgrader()) { - $upgrader->onUninstall(); - } + // Based on , this does not currently require mixin/polyfill.php. } /** @@ -163,188 +112,9 @@ function _civigeometry_civix_civicrm_uninstall() { * * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable */ -function _civigeometry_civix_civicrm_enable() { - _civigeometry_civix_civicrm_config(); - if ($upgrader = _civigeometry_civix_upgrader()) { - if (is_callable([$upgrader, 'onEnable'])) { - $upgrader->onEnable(); - } - } -} - -/** - * (Delegated) Implements hook_civicrm_disable(). - * - * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable - * @return mixed - */ -function _civigeometry_civix_civicrm_disable() { +function _civigeometry_civix_civicrm_enable(): void { _civigeometry_civix_civicrm_config(); - if ($upgrader = _civigeometry_civix_upgrader()) { - if (is_callable([$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 - * based on op. for 'check', returns array(boolean) (TRUE if upgrades are pending) - * for 'enqueue', returns void - * - * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_upgrade - */ -function _civigeometry_civix_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) { - if ($upgrader = _civigeometry_civix_upgrader()) { - return $upgrader->onUpgrade($op, $queue); - } -} - -/** - * @return CRM_CiviGeometry_Upgrader - */ -function _civigeometry_civix_upgrader() { - if (!file_exists(__DIR__ . '/CRM/CiviGeometry/Upgrader.php')) { - return NULL; - } - else { - return CRM_CiviGeometry_Upgrader_Base::instance(); - } -} - -/** - * Search directory tree for files which match a glob pattern. - * - * Note: Dot-directories (like "..", ".git", or ".svn") will be ignored. - * Note: Delegate to CRM_Utils_File::findFiles(), this function kept only - * for backward compatibility of extension code that uses it. - * - * @param string $dir base dir - * @param string $pattern , glob pattern, eg "*.txt" - * - * @return array - */ -function _civigeometry_civix_find_files($dir, $pattern) { - return CRM_Utils_File::findFiles($dir, $pattern); -} - -/** - * (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 _civigeometry_civix_civicrm_managed(&$entities) { - $mgdFiles = _civigeometry_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 _civigeometry_civix_civicrm_caseTypes(&$caseTypes) { - if (!is_dir(__DIR__ . '/xml/case')) { - return; - } - - foreach (_civigeometry_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)); - throw new CRM_Core_Exception($errorMessage); - } - $caseTypes[$name] = [ - '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 _civigeometry_civix_civicrm_angularModules(&$angularModules) { - if (!is_dir(__DIR__ . '/ang')) { - return; - } - - $files = _civigeometry_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 _civigeometry_civix_civicrm_themes(&$themes) { - $files = _civigeometry_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 - */ -function _civigeometry_civix_glob($pattern) { - $result = glob($pattern); - return is_array($result) ? $result : []; + // Based on , this does not currently require mixin/polyfill.php. } /** @@ -363,8 +133,8 @@ function _civigeometry_civix_insert_navigation_menu(&$menu, $path, $item) { if (empty($path)) { $menu[] = [ 'attributes' => array_merge([ - 'label' => CRM_Utils_Array::value('name', $item), - 'active' => 1, + 'label' => $item['name'] ?? NULL, + 'active' => 1, ], $item), ]; return TRUE; @@ -428,62 +198,3 @@ function _civigeometry_civix_fixNavigationMenuItems(&$nodes, &$maxNavID, $parent } } } - -/** - * (Delegated) Implements hook_civicrm_alterSettingsFolders(). - * - * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_alterSettingsFolders - */ -function _civigeometry_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 _civigeometry_civix_civicrm_entityTypes(&$entityTypes) { - $entityTypes = array_merge($entityTypes, [ - 'CRM_CiviGeometry_DAO_Geometry' => [ - 'name' => 'Geometry', - 'class' => 'CRM_CiviGeometry_DAO_Geometry', - 'table' => 'civigeometry_geometry', - ], - 'CRM_CiviGeometry_DAO_GeometryCollection' => [ - 'name' => 'GeometryCollection', - 'class' => 'CRM_CiviGeometry_DAO_GeometryCollection', - 'table' => 'civigeometry_geometry_collection', - ], - 'CRM_CiviGeometry_DAO_GeometryCollectionGeometry' => [ - 'name' => 'GeometryCollectionGeometry', - 'class' => 'CRM_CiviGeometry_DAO_GeometryCollectionGeometry', - 'table' => 'civigeometry_geometry_collection_geometry', - ], - 'CRM_CiviGeometry_DAO_GeometryCollectionType' => [ - 'name' => 'GeometryCollectionType', - 'class' => 'CRM_CiviGeometry_DAO_GeometryCollectionType', - 'table' => 'civigeometry_geometry_collection_type', - ], - 'CRM_CiviGeometry_DAO_GeometryEntity' => [ - 'name' => 'GeometryEntity', - 'class' => 'CRM_CiviGeometry_DAO_GeometryEntity', - 'table' => 'civigeometry_geometry_entity', - ], - 'CRM_CiviGeometry_DAO_GeometryOverlapCache' => [ - 'name' => 'GeometryOverlapCache', - 'class' => 'CRM_CiviGeometry_DAO_GeometryOverlapCache', - 'table' => 'civigeometry_geometry_overlap_cache', - ], - 'CRM_CiviGeometry_DAO_GeometryType' => [ - 'name' => 'GeometryType', - 'class' => 'CRM_CiviGeometry_DAO_GeometryType', - 'table' => 'civigeometry_geometry_type', - ], - ]); -} diff --git a/civigeometry.php b/civigeometry.php index a297239..28ca5b2 100644 --- a/civigeometry.php +++ b/civigeometry.php @@ -13,15 +13,6 @@ function civigeometry_civicrm_config(&$config) { Civi::service('dispatcher')->addListener('hook_civicrm_post', 'civigeometry_symfony_civicrm_post', -99); } -/** - * Implements hook_civicrm_xmlMenu(). - * - * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_xmlMenu - */ -function civigeometry_civicrm_xmlMenu(&$files) { - _civigeometry_civix_civicrm_xmlMenu($files); -} - /** * Implements hook_civicrm_install(). * @@ -31,24 +22,6 @@ function civigeometry_civicrm_install() { _civigeometry_civix_civicrm_install(); } -/** - * Implements hook_civicrm_postInstall(). - * - * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_postInstall - */ -function civigeometry_civicrm_postInstall() { - _civigeometry_civix_civicrm_postInstall(); -} - -/** - * Implements hook_civicrm_uninstall(). - * - * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_uninstall - */ -function civigeometry_civicrm_uninstall() { - _civigeometry_civix_civicrm_uninstall(); -} - /** * Implements hook_civicrm_enable(). * @@ -58,83 +31,6 @@ function civigeometry_civicrm_enable() { _civigeometry_civix_civicrm_enable(); } -/** - * Implements hook_civicrm_disable(). - * - * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_disable - */ -function civigeometry_civicrm_disable() { - _civigeometry_civix_civicrm_disable(); -} - -/** - * Implements hook_civicrm_upgrade(). - * - * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_upgrade - */ -function civigeometry_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) { - return _civigeometry_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 http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_managed - */ -function civigeometry_civicrm_managed(&$entities) { - _civigeometry_civix_civicrm_managed($entities); -} - -/** - * Implements hook_civicrm_caseTypes(). - * - * Generate a list of case-types. - * - * Note: This hook only runs in CiviCRM 4.4+. - * - * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_caseTypes - */ -function civigeometry_civicrm_caseTypes(&$caseTypes) { - _civigeometry_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 http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_angularModules - */ -function civigeometry_civicrm_angularModules(&$angularModules) { - _civigeometry_civix_civicrm_angularModules($angularModules); -} - -/** - * Implements hook_civicrm_alterSettingsFolders(). - * - * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_alterSettingsFolders - */ -function civigeometry_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) { - _civigeometry_civix_civicrm_alterSettingsFolders($metaDataFolders); -} - -/** - * Implements hook_civicrm_entityTypes(). - * - * Declare entity types provided by this module. - * - * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_entityTypes - */ -function civigeometry_civicrm_entityTypes(&$entityTypes) { - _civigeometry_civix_civicrm_entityTypes($entityTypes); -} - /** * Implements hook_civicrm_permission(). * diff --git a/info.xml b/info.xml index 54d3bfc..37f7d4c 100644 --- a/info.xml +++ b/info.xml @@ -14,18 +14,24 @@ https://github.com/australiangreens/au.org.greens.civigeometry http://www.gnu.org/licenses/agpl-3.0.html - 2023-07-28 - 1.11.0 + 2023-08-01 + 1.12.0 stable - 5.13 + 5.45 - + + CRM/CiviGeometry + 23.02.1 + + mgd-php@1.0.0 + entity-types-php@1.0.0 + + CRM_CiviGeometry_Upgrader - diff --git a/manage/OptionGroup_geom_entity_relationship_reason.mgd.php b/manage/OptionGroup_geom_entity_relationship_reason.mgd.php new file mode 100644 index 0000000..28dfff4 --- /dev/null +++ b/manage/OptionGroup_geom_entity_relationship_reason.mgd.php @@ -0,0 +1,23 @@ + 'OptionGroup_geom_entity_relationship_reason', + 'entity' => 'OptionGroup', + 'cleanup' => 'unused', + 'update' => 'unmodified', + 'params' => [ + 'version' => 4, + 'values' => [ + 'name' => 'geom_entity_relationship_reason', + 'title' => 'Geom-Entity Relationship Reasons', + 'description' => 'CiviGeometry Geometry-Entity relationship reasons', + 'data_type' => 'String', + 'is_reserved' => FALSE, + 'is_active' => TRUE, + 'is_locked' => FALSE, + ], + 'match' => ['name'], + ], + ], +]; diff --git a/mixin/entity-types-php@1.0.0.mixin.php b/mixin/entity-types-php@1.0.0.mixin.php new file mode 100644 index 0000000..8ec4203 --- /dev/null +++ b/mixin/entity-types-php@1.0.0.mixin.php @@ -0,0 +1,36 @@ +addListener('hook_civicrm_entityTypes', function ($e) use ($mixInfo) { + // When deactivating on a polyfill/pre-mixin system, listeners may not cleanup automatically. + if (!$mixInfo->isActive() || !is_dir($mixInfo->getPath('xml/schema/CRM'))) { + return; + } + + $files = (array) glob($mixInfo->getPath('xml/schema/CRM/*/*.entityType.php')); + foreach ($files as $file) { + $entities = include $file; + foreach ($entities as $entity) { + $e->entityTypes[$entity['class']] = $entity; + } + } + }); + +}; diff --git a/sql/auto_install.sql b/sql/auto_install.sql index 14cfc2d..dfdaccb 100644 --- a/sql/auto_install.sql +++ b/sql/auto_install.sql @@ -137,6 +137,7 @@ CREATE TABLE `civigeometry_geometry_entity` ( `entity_table` varchar(255) NOT NULL COMMENT 'entity table that is associated with this geometry', `geometry_id` int unsigned NOT NULL COMMENT 'FK to Geometry Table', `expiry_date` timestamp NULL DEFAULT NULL COMMENT 'When Should this geometry entity relationship expire', + `reason` varchar(64) NULL DEFAULT NULL COMMENT 'The reason for the relationship between the geometry and entity', PRIMARY KEY (`id`), UNIQUE INDEX `index_entity_table_geometry_id_entity_id`(entity_table, geometry_id, entity_id), INDEX `index_expiry_date`(expiry_date), diff --git a/xml/schema/CRM/CiviGeometry/GeometryEntity.xml b/xml/schema/CRM/CiviGeometry/GeometryEntity.xml index 6b32b53..d3e3509 100644 --- a/xml/schema/CRM/CiviGeometry/GeometryEntity.xml +++ b/xml/schema/CRM/CiviGeometry/GeometryEntity.xml @@ -66,4 +66,15 @@ entity_table entity_id + + reason + varchar + 64 + The reason for the relationship between the geometry and entity + false + + OptionGroup_geom_entity_relationship_reason + + NULL +