382 lines
10 KiB
PHP
382 lines
10 KiB
PHP
<?php
|
|
|
|
|
|
namespace CRM\TwingleCampaign\BAO;
|
|
|
|
use Civi;
|
|
use CRM_TwingleCampaign_ExtensionUtil as E;
|
|
use CRM\TwingleCampaign\Utils\ExtensionCache as Cache;
|
|
use CRM\TwingleCampaign\BAO\Campaign;
|
|
use Exception;
|
|
use CiviCRM_API3_Exception;
|
|
|
|
include_once E::path() . '/CRM/TwingleCampaign/BAO/Campaign.php';
|
|
include_once E::path() . '/CRM/TwingleCampaign/Utils/ExtensionCache.php';
|
|
|
|
class TwingleEvent extends Campaign {
|
|
|
|
/**
|
|
* TwingleEvent constructor.
|
|
*
|
|
* @param array $event
|
|
* Result array of Twingle API call to
|
|
* https://project.twingle.de/api/$project_id/event
|
|
*
|
|
* @param string $origin
|
|
* Origin of the arrays. It can be one of two constants:
|
|
* TwingleEvent::TWINGLE|CIVICRM
|
|
*
|
|
* @throws Exception
|
|
*/
|
|
protected function __construct(array $event, string $origin) {
|
|
parent::__construct($event, $origin);
|
|
|
|
$this->className = (new \ReflectionClass($this))->getShortName();
|
|
$this->prefix = 'twingle_event_';
|
|
$this->values['campaign_type_id'] = 'twingle_event';
|
|
$this->id_custom_field = Cache::getInstance()
|
|
->getCustomFieldMapping()['twingle_event_id'];
|
|
$this->values['parent_id'] = $this->getParentCampaignId();
|
|
|
|
}
|
|
|
|
/**
|
|
* Synchronizes events between Twingle and CiviCRM (both directions)
|
|
* based on the timestamp.
|
|
*
|
|
* @param array $values
|
|
* @param TwingleApiCall $twingleApi
|
|
* @param bool $is_test
|
|
* If TRUE, don't do any changes
|
|
*
|
|
* @return array|null
|
|
* Returns a response array that contains title, id, event_id, project_id
|
|
* and status or NULL if $values is not an array
|
|
*
|
|
* @throws CiviCRM_API3_Exception
|
|
*/
|
|
public static function sync(
|
|
array $values,
|
|
TwingleApiCall &$twingleApi,
|
|
bool $is_test = FALSE
|
|
) {
|
|
|
|
// If $values is an array
|
|
if (is_array($values)) {
|
|
|
|
// Instantiate TwingleEvent
|
|
try {
|
|
$event = new TwingleEvent(
|
|
$values,
|
|
self::TWINGLE
|
|
);
|
|
} catch (Exception $e) {
|
|
|
|
// Log Exception
|
|
Civi::log()->error(
|
|
"Failed to instantiate TwingleEvent: $e->getMessage()"
|
|
);
|
|
|
|
// Return result array with error description
|
|
return [
|
|
"title" => $values['description'],
|
|
"event_id" => (int) $values['id'],
|
|
"project_id" => (int) $values['project_id'],
|
|
"status" =>
|
|
"Failed to instantiate TwingleEvent: $e->getMessage()",
|
|
];
|
|
}
|
|
|
|
// Check if the TwingleEvent campaign already exists
|
|
if (!$event->exists()) {
|
|
|
|
// ... if not, get embed data and create event
|
|
try {
|
|
$result = $event->create($is_test);
|
|
} catch (Exception $e) {
|
|
|
|
// Log Exception
|
|
Civi::log()->error(
|
|
"Could not create campaign from TwingleEvent: $e->getMessage()"
|
|
);
|
|
|
|
// Return result array with error description
|
|
return [
|
|
"title" => $values['description'],
|
|
"event_id" => (int) $values['id'],
|
|
"project_id" => (int) $values['project_id'],
|
|
"status" =>
|
|
"Could not create campaign from TwingleEvent: $e->getMessage()",
|
|
];
|
|
}
|
|
}
|
|
else {
|
|
$result = $event->getResponse('TwingleEvent exists');
|
|
|
|
// If Twingle's version of the event is newer than the CiviCRM
|
|
// TwingleEvent campaign update the campaign
|
|
if ($values['updated_at'] > $event->lastUpdate()) {
|
|
try {
|
|
$event->update($values);
|
|
$result = $event->create();
|
|
$result['status'] = $result['status'] == 'TwingleEvent created'
|
|
? 'TwingleEvent updated'
|
|
: 'TwingleEvent Update failed';
|
|
} catch (Exception $e) {
|
|
// Log Exception
|
|
Civi::log()->error(
|
|
"Could not update TwingleEvent campaign: $e->getMessage()"
|
|
);
|
|
// Return result array with error description
|
|
$result = $event->getResponse(
|
|
"Could not update TwingleEvent campaign: $e->getMessage()"
|
|
);
|
|
}
|
|
}
|
|
elseif ($result['status'] == 'TwingleEvent exists') {
|
|
$result = $event->getResponse('TwingleEvent up to date');
|
|
}
|
|
}
|
|
|
|
// Return a response of the synchronization
|
|
return $result;
|
|
}
|
|
else {
|
|
return NULL;
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Create the Event as a campaign in CiviCRM if it does not exist
|
|
*
|
|
* @param bool $is_test
|
|
* If true: don't do any changes
|
|
*
|
|
* @return array
|
|
* Returns a response array that contains title, id, project_id and status
|
|
*
|
|
* @throws CiviCRM_API3_Exception
|
|
* @throws Exception
|
|
*/
|
|
public function create(bool $is_test = FALSE) {
|
|
|
|
// Create campaign only if it does not already exist
|
|
if (!$is_test) {
|
|
|
|
// Prepare project values for import into database
|
|
$values_prepared_for_import = $this->values;
|
|
self::formatValues(
|
|
$values_prepared_for_import,
|
|
self::IN
|
|
);
|
|
self::translateKeys(
|
|
$values_prepared_for_import,
|
|
self::IN
|
|
);
|
|
$this->translateCustomFields(
|
|
$values_prepared_for_import,
|
|
self::IN
|
|
);
|
|
|
|
// Set id
|
|
$values_prepared_for_import['id'] = $this->id;
|
|
|
|
// Create campaign
|
|
$result = civicrm_api3('Campaign', 'create', $values_prepared_for_import);
|
|
|
|
// Update id
|
|
$this->id = $result['id'];
|
|
|
|
// Check if campaign was created successfully
|
|
if ($result['is_error'] == 0) {
|
|
$response = $this->getResponse("$this->className created");
|
|
}
|
|
else {
|
|
$response = $this->getResponse("$this->className creation failed");
|
|
}
|
|
|
|
}
|
|
// If this is a test, do not create campaign
|
|
else {
|
|
$response = $this->getResponse("$this->className not yet created");
|
|
}
|
|
|
|
return $response;
|
|
}
|
|
|
|
|
|
/**
|
|
* Translate values between CiviCRM Campaigns and Twingle
|
|
*
|
|
* @param array $values
|
|
* array of which values shall be translated
|
|
*
|
|
* @param string $direction
|
|
* self::IN -> translate array values from Twingle to CiviCRM <br>
|
|
* self::OUT -> translate array values from CiviCRM to Twingle
|
|
*
|
|
* @throws Exception
|
|
*/
|
|
protected function formatValues(array &$values, string $direction) {
|
|
|
|
if ($direction == self::IN) {
|
|
|
|
// Change timestamp into DateTime string
|
|
if ($values['updated_at']) {
|
|
$values['updated_at'] =
|
|
self::getDateTime($values['updated_at']);
|
|
}
|
|
if ($values['confirmed_at']) {
|
|
$values['confirmed_at'] =
|
|
self::getDateTime($values['confirmed_at']);
|
|
}
|
|
if ($values['created_at']) {
|
|
$values['created_at'] =
|
|
self::getDateTime($values['created_at']);
|
|
}
|
|
if ($values['user_name']) {
|
|
$values['user_name'] = $this->matchContact(
|
|
$values['user_name'],
|
|
$values['user_email']
|
|
);
|
|
}
|
|
|
|
|
|
}
|
|
elseif ($direction == self::OUT) {
|
|
|
|
// Change DateTime string into timestamp
|
|
$values['updated_at'] =
|
|
self::getTimestamp($values['updated_at']);
|
|
$values['confirmed_at'] =
|
|
self::getTimestamp($values['confirmed_at']);
|
|
$values['created_at'] =
|
|
self::getTimestamp($values['created_at']);
|
|
|
|
// Cast project target to integer
|
|
$values['project_target'] = (int) $values['project_target'];
|
|
|
|
}
|
|
else {
|
|
|
|
throw new Exception(
|
|
"Invalid Parameter $direction for formatValues()"
|
|
);
|
|
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Get a response that describes the status of a TwingleEvent
|
|
*
|
|
* @param string $status
|
|
* status of the TwingleEvent you want the response for
|
|
*
|
|
* @return array
|
|
* Returns a response array that contains title, id, project_id and status
|
|
*/
|
|
public function getResponse(string $status) {
|
|
return [
|
|
'title' => $this->values['description'],
|
|
'id' => (int) $this->id,
|
|
'event_id' => (int) $this->values['id'],
|
|
'project_id' => (int) $this->values['project_id'],
|
|
'status' => $status,
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Matches a single string that should contain first and lastname to match a
|
|
* contact or create a new one if it does not exist yet.
|
|
*
|
|
* TODO: The logic of this method should instead be handled in the XCM
|
|
* extension. This ist only a temporary solution.
|
|
*
|
|
* @param string $names
|
|
* @param string $email
|
|
*
|
|
* @return int|null
|
|
* Returns a contact id
|
|
*/
|
|
private function matchContact(string $names, string $email) {
|
|
$names = explode(' ', $names);
|
|
$lastname = '';
|
|
|
|
if (is_array($names) && count($names) > 1) {
|
|
$lastname = array_pop($names);
|
|
$test = $names[count($names) - 1];
|
|
$nameSuffixes = ['de', 'da', 'von', 'van'];
|
|
|
|
if (in_array($test, $nameSuffixes)) {
|
|
array_pop($names);
|
|
$lastname = $test . ' ' . $lastname;
|
|
}
|
|
|
|
$names = implode(" ", $names);
|
|
}
|
|
try {
|
|
$contact = civicrm_api3('Contact', 'getorcreate', [
|
|
'xcm_profile' => Civi::settings()->get('twinglecampaign_xcm_profile'),
|
|
'first_name' => $names,
|
|
'last_name' => $lastname,
|
|
'email' => $email,
|
|
]);
|
|
return (int) $contact['id'];
|
|
} catch (CiviCRM_API3_Exception $e) {
|
|
$message = $e->getMessage();
|
|
\Civi::log()->error("TwingleCampaign extension could not match or create a contact for:
|
|
$names $lastname $email./nError Message: $message");
|
|
return NULL;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Gets the campaign id of the parent TwingleProject campaign.
|
|
* @return int|null
|
|
* @throws CiviCRM_API3_Exception
|
|
*/
|
|
private function getParentCampaignId() {
|
|
$cf_project_id = Cache::getInstance()->getCustomFieldMapping()['twingle_project_id'];
|
|
$parentCampaign = civicrm_api3('Campaign', 'get', [
|
|
'sequential' => 1,
|
|
$cf_project_id => $this->values['project_id']
|
|
]);
|
|
if ($parentCampaign['is_error'] == 0) {
|
|
return (int) $parentCampaign['id'];
|
|
}
|
|
else return NULL;
|
|
}
|
|
|
|
/**
|
|
* Return a timestamp of the last update of the Campaign
|
|
*
|
|
* @return int|null
|
|
*/
|
|
public function lastUpdate() {
|
|
|
|
return self::getTimestamp($this->values['updated_at']);
|
|
}
|
|
|
|
|
|
/**
|
|
* Returns the project_id of a TwingleEvent
|
|
*
|
|
* @return int
|
|
*/
|
|
public function getProjectId() {
|
|
return (int) $this->values['project_id'];
|
|
}
|
|
|
|
|
|
/**
|
|
* Returns the event_id of a TwingleEvent
|
|
*
|
|
* @return int
|
|
*/
|
|
public function getEventId() {
|
|
return (int) $this->values['id'];
|
|
}
|
|
|
|
}
|