Commit 6dd9e4b3 authored by ErikHommel's avatar ErikHommel
Browse files

initial load

parents
<?php
use CRM_Acqgeneriek_ExtensionUtil as E;
/**
* Config class met Acq Specifieke instellingen
*
* @author Erik Hommel <erik.hommel@civicoop.org>
* @date 10 July 2019
* @license AGPL-3.0
*/
class CRM_Acqgeneriek_AcqConfig {
// property for singleton pattern
private static $_singleton = NULL;
// properties voor Acquire org
private $_acqKvkNummer = NULL;
private $_acqContactId = NULL;
// properties voor custom groups and fields
private $_contactDataCustomGroup = [];
private $_extraPartnerDataCustomGroup = [];
private $_factDataCustomGroup = [];
private $_organizationDataCustomGroup = [];
private $_publicatieDataCustomGroup = [];
/**
* CRM_Acqgeneriek_AcqConfig constructor.
*/
public function __construct() {
$this->_acqKvkNummer = "KVK 05080891";
$this->setCustomData();
// Acquire org id na de custom data omdat custom veld kvk nodig is
$this->setAcquireOrgId();
}
/**
* Getter voor Acquire contact
*
* @return null
*/
public function getAcqContactId() {
return $this->_acqContactId;
}
/**
* Getter voor contact data custom veld
*
* @param $customFieldName
* @param $key
* @return mixed
*/
public function getContactDataCustomField($customFieldName, $key = NULL) {
foreach ($this->_contactDataCustomGroup['custom_fields'] as $customField) {
if ($customField['name'] == $customFieldName) {
if ($key && isset($customField[$key])) {
return $customField[$key];
}
else {
return $customField;
}
}
}
return FALSE;
}
/**
* Getter voor extra partner data custom veld
*
* @param $customFieldName
* @param $key
* @return mixed
*/
public function getExtraPartnerDataCustomField($customFieldName, $key = NULL) {
foreach ($this->_extraPartnerDataCustomGroup['custom_fields'] as $customField) {
if ($customField['name'] == $customFieldName) {
if ($key && isset($customField[$key])) {
return $customField[$key];
}
else {
return $customField;
}
}
}
return FALSE;
}
/**
* Getter voor facturatie data custom veld
*
* @param $customFieldName
* @param $key
* @return mixed
*/
public function getFactDataCustomField($customFieldName, $key = NULL) {
foreach ($this->_factDataCustomGroup['custom_fields'] as $customField) {
if ($customField['name'] == $customFieldName) {
if ($key && isset($customField[$key])) {
return $customField[$key];
}
else {
return $customField;
}
}
}
return FALSE;
}
/**
* Getter voor publicatie data custom veld
*
* @param $customFieldName
* @param $key
* @return mixed
*/
public function getPublicatieDataCustomField($customFieldName, $key = NULL) {
foreach ($this->_publicatieDataCustomGroup['custom_fields'] as $customField) {
if ($customField['name'] == $customFieldName) {
if ($key && isset($customField[$key])) {
return $customField[$key];
}
else {
return $customField;
}
}
}
return FALSE;
}
/**
* Getter voor organisatie data custom veld
*
* @param $customFieldName
* @param $key
* @return mixed
*/
public function getOrgDataCustomField($customFieldName, $key = NULL) {
foreach ($this->_organizationDataCustomGroup['custom_fields'] as $customField) {
if ($customField['name'] == $customFieldName) {
if ($key && isset($customField[$key])) {
return $customField[$key];
}
else {
return $customField;
}
}
}
return FALSE;
}
/**
* Vind het contact ID voor Acquire
*
* @throws API_Exception
*/
private function setAcquireOrgId() {
if ($this->_acqKvkNummer) {
try {
$this->_acqContactId = (int) civicrm_api3('Contact', 'getvalue', [
'return' => "id",
'custom_' . $this->getOrgDataCustomField('acq_kvk_id', 'id') => $this->_acqKvkNummer,
]);
}
catch (CiviCRM_API3_Exception $ex) {
throw new API_Exception(E::ts('Kon geen contact vinden voor Acquire met KVK nummer ') . $this->_acqKvkNummer . E::ts(' in ') . __METHOD__, 0001);
}
}
}
/**
* Method to set the custom data
*/
private function setCustomData() {
$relevantCustomGroups = [
'acq_contact_data',
'acq_extra_partner_data',
'acq_fact_data',
'acq_publicatie_data',
'acq_organization_data',
];
try {
$customGroups = civicrm_api3('CustomGroup', 'get', [
'name' => ['LIKE' => "%acq%"],
'options' => ['limit' => 0],
]);
foreach ($customGroups['values'] as $customGroupId => $customGroup) {
if (in_array($customGroup['name'], $relevantCustomGroups)) {
$name = str_replace('acq_', '', $customGroup['name']);
$parts = explode('_', $name);
foreach ($parts as $partId => $part) {
if ($partId == 0) {
$parts[$partId] = strtolower($part);
}
else {
$parts[$partId] = ucfirst(strtolower($part));
}
}
$property = '_' . implode('', $parts) . 'CustomGroup';
// add custom fields
$customFields = civicrm_api3('CustomField', 'get', [
'custom_group_id' => $customGroup['id'],
'options' => ['limit' => 0],
]);
$customGroup['custom_fields'] = $customFields['values'];
$this->$property = $customGroup;
}
}
}
catch (CiviCRM_API3_Exception $ex) {
}
}
/**
* Method to return the singleton object or instantiate
*
* @return CRM_Acqgeneriek_AcqConfig|null
* @throws
*/
public static function &singleton() {
if (self::$_singleton === NULL) {
self::$_singleton = new CRM_Acqgeneriek_AcqConfig();
}
return self::$_singleton;
}
}
This diff is collapsed.
# acqgeneriek
![Screenshot](/images/screenshot.png)
(*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.4+
* 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 acqgeneriek@https://github.com/FIXME/acqgeneriek/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/acqgeneriek.git
cv en acqgeneriek
```
## Usage
(* FIXME: Where would a new user navigate to get started? What changes would they see? *)
## Known Issues
(* FIXME *)
<?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_Acqgeneriek_ExtensionUtil {
const SHORT_NAME = "acqgeneriek";
const LONG_NAME = "acqgeneriek";
const CLASS_PREFIX = "CRM_Acqgeneriek";
/**
* 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_Acqgeneriek_ExtensionUtil as E;
/**
* (Delegated) Implements hook_civicrm_config().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_config
*/
function _acqgeneriek_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 http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_xmlMenu
*/
function _acqgeneriek_civix_civicrm_xmlMenu(&$files) {
foreach (_acqgeneriek_civix_glob(__DIR__ . '/xml/Menu/*.xml') as $file) {
$files[] = $file;
}
}
/**
* Implements hook_civicrm_install().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_install
*/
function _acqgeneriek_civix_civicrm_install() {
_acqgeneriek_civix_civicrm_config();
if ($upgrader = _acqgeneriek_civix_upgrader()) {
$upgrader->onInstall();
}
}
/**
* Implements hook_civicrm_postInstall().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_postInstall
*/
function _acqgeneriek_civix_civicrm_postInstall() {
_acqgeneriek_civix_civicrm_config();
if ($upgrader = _acqgeneriek_civix_upgrader()) {
if (is_callable(array($upgrader, 'onPostInstall'))) {
$upgrader->onPostInstall();
}
}
}
/**
* Implements hook_civicrm_uninstall().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_uninstall
*/
function _acqgeneriek_civix_civicrm_uninstall() {
_acqgeneriek_civix_civicrm_config();
if ($upgrader = _acqgeneriek_civix_upgrader()) {
$upgrader->onUninstall();
}
}
/**
* (Delegated) Implements hook_civicrm_enable().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_enable
*/
function _acqgeneriek_civix_civicrm_enable() {
_acqgeneriek_civix_civicrm_config();
if ($upgrader = _acqgeneriek_civix_upgrader()) {
if (is_callable(array($upgrader, 'onEnable'))) {
$upgrader->onEnable();
}
}
}
/**
* (Delegated) Implements hook_civicrm_disable().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_disable
* @return mixed
*/
function _acqgeneriek_civix_civicrm_disable() {
_acqgeneriek_civix_civicrm_config();
if ($upgrader = _acqgeneriek_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 based on op. for 'check', returns array(boolean) (TRUE if upgrades are pending)
* for 'enqueue', returns void
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_upgrade
*/
function _acqgeneriek_civix_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
if ($upgrader = _acqgeneriek_civix_upgrader()) {
return $upgrader->onUpgrade($op, $queue);
}
}
/**
* @return CRM_Acqgeneriek_Upgrader
*/
function _acqgeneriek_civix_upgrader() {
if (!file_exists(__DIR__ . '/CRM/Acqgeneriek/Upgrader.php')) {
return NULL;
}
else {
return CRM_Acqgeneriek_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 _acqgeneriek_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 (_acqgeneriek_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 http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_managed
*/
function _acqgeneriek_civix_civicrm_managed(&$entities) {
$mgdFiles = _acqgeneriek_civix_find_files(__DIR__, '*.mgd.php');
foreach ($mgdFiles as $file) {
$es = include $file;
foreach ($es as $e) {
if (empty($e['module'])) {
$e['module'] = E::LONG_NAME;
}
$entities[] = $e;
if (empty($e['params']['version'])) {
$e['params']['version'] = '3';
}
}
}
}
/**
* (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 http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_caseTypes
*/
function _acqgeneriek_civix_civicrm_caseTypes(&$caseTypes) {
if (!is_dir(__DIR__ . '/xml/case')) {
return;
}
foreach (_acqgeneriek_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 http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_angularModules
*/
function _acqgeneriek_civix_civicrm_angularModules(&$angularModules) {
if (!is_dir(__DIR__ . '/ang')) {
return;
}
$files = _acqgeneriek_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;
}
}
/**
* 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 _acqgeneriek_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'