implement TwingleShop integration
This commit is contained in:
Marc Michalsky
Jens Schuppe
parent
ea46e6a747
commit
8cfa270dff
60 changed files with 5200 additions and 106 deletions
|
|
@ -1,48 +0,0 @@
|
|||
<?php
|
||||
|
||||
namespace CRM\Twingle\Exceptions;
|
||||
|
||||
use CRM_Twingle_ExtensionUtil as E;
|
||||
|
||||
/**
|
||||
* A simple custom exception class that indicates a problem within a class
|
||||
* of the Twingle API extension.
|
||||
*/
|
||||
class BaseException extends \Exception {
|
||||
|
||||
/**
|
||||
* @var int|string
|
||||
*/
|
||||
protected $code;
|
||||
protected string $log_message;
|
||||
|
||||
/**
|
||||
* BaseException Constructor
|
||||
* @param string $message
|
||||
* Error message
|
||||
* @param string $error_code
|
||||
* A meaningful error code
|
||||
*/
|
||||
public function __construct(string $message = '', string $error_code = '') {
|
||||
parent::__construct($message, 1);
|
||||
$this->log_message = !empty($message) ? E::LONG_NAME . ': ' . $message : '';
|
||||
$this->code = $error_code;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the error message, but with the extension name prefixed.
|
||||
* @return string
|
||||
*/
|
||||
public function getLogMessage() {
|
||||
return $this->log_message;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the error code.
|
||||
* @return string
|
||||
*/
|
||||
public function getErrorCode() {
|
||||
return $this->code;
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -251,6 +251,7 @@ class CRM_Twingle_Form_Profile extends CRM_Core_Form {
|
|||
|
||||
// Assign template variables.
|
||||
$this->assign('op', $this->_op);
|
||||
$this->assign('twingle_use_shop', (int) Civi::settings()->get('twingle_use_shop'));
|
||||
$this->assign('profile_name', $profile_name);
|
||||
$this->assign('is_default', $is_default);
|
||||
|
||||
|
|
@ -354,6 +355,10 @@ class CRM_Twingle_Form_Profile extends CRM_Core_Form {
|
|||
static::getPrefixOptions()
|
||||
);
|
||||
|
||||
// Add script and css for Twingle Shop integration
|
||||
Civi::resources()->addScriptUrl(E::url('js/twingle_shop.js'));
|
||||
Civi::resources()->addStyleFile(E::LONG_NAME, 'css/twingle_shop.css');
|
||||
|
||||
$payment_instruments = CRM_Twingle_Profile::paymentInstruments();
|
||||
$this->assign('payment_instruments', $payment_instruments);
|
||||
foreach ($payment_instruments as $pi_name => $pi_label) {
|
||||
|
|
@ -523,6 +528,42 @@ class CRM_Twingle_Form_Profile extends CRM_Core_Form {
|
|||
['class' => 'crm-select2 huge', 'multiple' => 'multiple']
|
||||
);
|
||||
|
||||
if (Civi::settings()->get('twingle_use_shop')) {
|
||||
$this->add(
|
||||
'checkbox', // field type
|
||||
'enable_shop_integration', // field name
|
||||
E::ts('Enable Shop Integration'), // field label
|
||||
FALSE,
|
||||
[]
|
||||
);
|
||||
|
||||
$this->add(
|
||||
'select', // field type
|
||||
'shop_financial_type', // field name
|
||||
E::ts('Default Financial Type'), // field label
|
||||
static::getFinancialTypes(), // list of options
|
||||
TRUE,
|
||||
['class' => 'crm-select2 huge']
|
||||
);
|
||||
|
||||
$this->add(
|
||||
'select', // field type
|
||||
'shop_donation_financial_type', // field name
|
||||
E::ts('Financial Type for top up donations'), // field label
|
||||
static::getFinancialTypes(), // list of options
|
||||
TRUE,
|
||||
['class' => 'crm-select2 huge']
|
||||
);
|
||||
|
||||
$this->add(
|
||||
'checkbox', // field type
|
||||
'shop_map_products', // field name
|
||||
E::ts('Map Products as Price Fields'), // field label
|
||||
FALSE, // is not required
|
||||
[]
|
||||
);
|
||||
}
|
||||
|
||||
$this->addButtons([
|
||||
[
|
||||
'type' => 'submit',
|
||||
|
|
@ -566,9 +607,6 @@ class CRM_Twingle_Form_Profile extends CRM_Core_Form {
|
|||
CRM_Core_Session::setStatus($e->getMessage(), E::ts('Warning'));
|
||||
}
|
||||
}
|
||||
catch (ProfileValidationError $e) {
|
||||
$this->setElementError($e->getAffectedFieldName(), $e->getMessage());
|
||||
}
|
||||
}
|
||||
|
||||
return parent::validate();
|
||||
|
|
@ -993,5 +1031,4 @@ class CRM_Twingle_Form_Profile extends CRM_Core_Form {
|
|||
}
|
||||
return static::$_campaigns;
|
||||
}
|
||||
|
||||
}
|
||||
|
|
|
|||
|
|
@ -29,14 +29,16 @@ class CRM_Twingle_Form_Settings extends CRM_Core_Form {
|
|||
* List of all settings options.
|
||||
*/
|
||||
public static $SETTINGS_LIST = [
|
||||
'twingle_prefix',
|
||||
'twingle_use_sepa',
|
||||
'twingle_dont_use_reference',
|
||||
'twingle_protect_recurring',
|
||||
'twingle_protect_recurring_activity_type',
|
||||
'twingle_protect_recurring_activity_subject',
|
||||
'twingle_protect_recurring_activity_status',
|
||||
'twingle_protect_recurring_activity_assignee',
|
||||
'twingle_prefix',
|
||||
'twingle_use_sepa',
|
||||
'twingle_dont_use_reference',
|
||||
'twingle_protect_recurring',
|
||||
'twingle_protect_recurring_activity_type',
|
||||
'twingle_protect_recurring_activity_subject',
|
||||
'twingle_protect_recurring_activity_status',
|
||||
'twingle_protect_recurring_activity_assignee',
|
||||
'twingle_use_shop',
|
||||
'twingle_access_key',
|
||||
];
|
||||
|
||||
/**
|
||||
|
|
@ -105,13 +107,25 @@ class CRM_Twingle_Form_Settings extends CRM_Core_Form {
|
|||
]
|
||||
);
|
||||
|
||||
$this->addButtons([
|
||||
[
|
||||
'type' => 'submit',
|
||||
'name' => E::ts('Save'),
|
||||
'isDefault' => TRUE,
|
||||
],
|
||||
]);
|
||||
$this->add(
|
||||
'checkbox',
|
||||
'twingle_use_shop',
|
||||
E::ts("Use Twingle Shop Integration")
|
||||
);
|
||||
|
||||
$this->add(
|
||||
'text',
|
||||
'twingle_access_key',
|
||||
E::ts("Twingle Access Key")
|
||||
);
|
||||
|
||||
$this->addButtons(array(
|
||||
array (
|
||||
'type' => 'submit',
|
||||
'name' => E::ts('Save'),
|
||||
'isDefault' => TRUE,
|
||||
)
|
||||
));
|
||||
|
||||
// set defaults
|
||||
foreach (self::$SETTINGS_LIST as $setting) {
|
||||
|
|
@ -124,8 +138,7 @@ class CRM_Twingle_Form_Settings extends CRM_Core_Form {
|
|||
}
|
||||
|
||||
/**
|
||||
* Custom form validation, because the activity creation fields
|
||||
* are only mandatory if activity creation is active
|
||||
* Custom form validation, as some fields are mandatory only when others are active.
|
||||
* @return bool
|
||||
*/
|
||||
public function validate() {
|
||||
|
|
@ -146,6 +159,14 @@ class CRM_Twingle_Form_Settings extends CRM_Core_Form {
|
|||
}
|
||||
}
|
||||
|
||||
// Twingle Access Key is required if Shop Integration is enabled
|
||||
if (
|
||||
CRM_Utils_Array::value('twingle_use_shop', $this->_submitValues) &&
|
||||
!CRM_Utils_Array::value('twingle_access_key', $this->_submitValues, FALSE)
|
||||
) {
|
||||
$this->_errors['twingle_access_key'] = E::ts("An Access Key is required to enable Twingle Shop Integration");
|
||||
}
|
||||
|
||||
return (0 == count($this->_errors));
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -33,6 +33,7 @@ class CRM_Twingle_Page_Profiles extends CRM_Core_Page {
|
|||
}
|
||||
$this->assign('profiles', $profiles);
|
||||
$this->assign('profile_stats', CRM_Twingle_Profile::getProfileStats());
|
||||
$this->assign('twingle_use_shop', (int) Civi::settings()->get('twingle_use_shop'));
|
||||
|
||||
// Add custom css
|
||||
Civi::resources()->addStyleFile(E::LONG_NAME, 'css/twingle.css');
|
||||
|
|
|
|||
|
|
@ -43,6 +43,16 @@ class CRM_Twingle_Profile {
|
|||
*/
|
||||
protected $data;
|
||||
|
||||
/**
|
||||
* @var array $check_box_fields
|
||||
* List of check box fields
|
||||
*/
|
||||
public $check_box_fields = [
|
||||
'newsletter_double_opt_in',
|
||||
'enable_shop_integration',
|
||||
'shop_map_products',
|
||||
];
|
||||
|
||||
/**
|
||||
* CRM_Twingle_Profile constructor.
|
||||
*
|
||||
|
|
@ -197,6 +207,16 @@ class CRM_Twingle_Profile {
|
|||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Determine if Twingle Shop integration is enabled in general and
|
||||
* specifically for this profile.
|
||||
* @return bool
|
||||
*/
|
||||
public function isShopEnabled(): bool {
|
||||
return Civi::settings()->get('twingle_use_shop') &&
|
||||
$this->data['enable_shop_integration'];
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves an attribute of the profile.
|
||||
*
|
||||
|
|
@ -532,6 +552,10 @@ class CRM_Twingle_Profile {
|
|||
'required_address_components' => ['required' => FALSE],
|
||||
'map_as_contribution_notes' => ['required' => FALSE],
|
||||
'map_as_contact_notes' => ['required' => FALSE],
|
||||
'enable_shop_integration' => ['required' => FALSE],
|
||||
'shop_financial_type' => ['required' => FALSE],
|
||||
'shop_donation_financial_type' => ['required' => FALSE],
|
||||
'shop_map_products' => ['required' => FALSE],
|
||||
],
|
||||
// Add payment methods.
|
||||
array_combine(
|
||||
|
|
@ -650,6 +674,10 @@ class CRM_Twingle_Profile {
|
|||
],
|
||||
'map_as_contribution_notes' => [],
|
||||
'map_as_contact_notes' => [],
|
||||
'enable_shop_integration' => FALSE,
|
||||
'shop_financial_type' => 1,
|
||||
'shop_donation_financial_type' => 1,
|
||||
'shop_map_products' => FALSE,
|
||||
]
|
||||
// Add contribution status for all payment methods.
|
||||
// phpcs:ignore Drupal.Formatting.SpaceUnaryOperator.PlusMinus
|
||||
|
|
@ -666,7 +694,7 @@ class CRM_Twingle_Profile {
|
|||
* @param string $project_id
|
||||
*
|
||||
* @return CRM_Twingle_Profile
|
||||
* @throws \CRM\Twingle\Exceptions\ProfileException
|
||||
* @throws \Civi\Twingle\Exceptions\ProfileException
|
||||
* @throws \Civi\Core\Exception\DBQueryException
|
||||
*/
|
||||
public static function getProfileForProject($project_id) {
|
||||
|
|
@ -683,7 +711,6 @@ class CRM_Twingle_Profile {
|
|||
}
|
||||
|
||||
// If none matches, use the default profile.
|
||||
$default_profile = $profiles['default'];
|
||||
if (!empty($default_profile)) {
|
||||
return $default_profile;
|
||||
}
|
||||
|
|
@ -780,5 +807,4 @@ class CRM_Twingle_Profile {
|
|||
}
|
||||
return $stats;
|
||||
}
|
||||
|
||||
}
|
||||
|
|
|
|||
|
|
@ -17,6 +17,8 @@ declare(strict_types = 1);
|
|||
|
||||
use CRM_Twingle_ExtensionUtil as E;
|
||||
use Civi\Twingle\Exceptions\BaseException;
|
||||
use Civi\Twingle\Shop\Exceptions\LineItemException;
|
||||
use Civi\Twingle\Shop\BAO\TwingleProduct;
|
||||
|
||||
class CRM_Twingle_Submission {
|
||||
|
||||
|
|
@ -41,7 +43,18 @@ class CRM_Twingle_Submission {
|
|||
public const EMPLOYER_RELATIONSHIP_TYPE_ID = 5;
|
||||
|
||||
/**
|
||||
* @param array<string, mixed> &$params
|
||||
* List of allowed product attributes.
|
||||
*/
|
||||
const ALLOWED_PRODUCT_ATTRIBUTES = [
|
||||
'name',
|
||||
'internal_id',
|
||||
'price',
|
||||
'count',
|
||||
'total_value',
|
||||
];
|
||||
|
||||
/**
|
||||
* @param array &$params
|
||||
* A reference to the parameters array of the submission.
|
||||
*
|
||||
* @param \CRM_Twingle_Profile $profile
|
||||
|
|
@ -123,6 +136,22 @@ class CRM_Twingle_Submission {
|
|||
}
|
||||
}
|
||||
|
||||
// Validate products
|
||||
if (!empty($params['products']) && $profile->isShopEnabled()) {
|
||||
if (is_string($params['products'])) {
|
||||
$products = json_decode($params['products'], TRUE);
|
||||
$params['products'] = array_map(function ($product) {
|
||||
return array_intersect_key($product, array_flip(self::ALLOWED_PRODUCT_ATTRIBUTES));
|
||||
}, $products);
|
||||
}
|
||||
if (!is_array($params['products'])) {
|
||||
throw new CiviCRM_API3_Exception(
|
||||
E::ts('Invalid format for products.'),
|
||||
'invalid_format'
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
// Validate campaign_id, if given.
|
||||
if (isset($params['campaign_id'])) {
|
||||
// Check whether campaign_id is a numeric string and cast it to an integer.
|
||||
|
|
@ -433,4 +462,131 @@ class CRM_Twingle_Submission {
|
|||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param $values
|
||||
* Processed data
|
||||
* @param $submission
|
||||
* Submission data
|
||||
* @param $profile
|
||||
* The twingle profile used
|
||||
*
|
||||
* @throws \CiviCRM_API3_Exception
|
||||
* @throws \CRM_Core_Exception
|
||||
* @throws \Civi\Twingle\Shop\Exceptions\LineItemException
|
||||
*/
|
||||
public static function createLineItems($values, $submission, $profile): array {
|
||||
$line_items = [];
|
||||
$sum_line_items = 0;
|
||||
|
||||
$contribution_id = $values['contribution']['id'];
|
||||
if (empty($contribution_id)) {
|
||||
throw new LineItemException(
|
||||
"Could not find contribution id for line item assignment.",
|
||||
LineItemException::ERROR_CODE_CONTRIBUTION_NOT_FOUND
|
||||
);
|
||||
}
|
||||
|
||||
foreach ($submission['products'] as $product) {
|
||||
|
||||
$line_item_data = [
|
||||
'entity_table' => "civicrm_contribution",
|
||||
'contribution_id' => $contribution_id,
|
||||
'entity_id' => $contribution_id,
|
||||
'label' => $product['name'],
|
||||
'qty' => $product['count'],
|
||||
'unit_price' => $product['price'],
|
||||
'line_total' => $product['total_value'],
|
||||
'sequential' => 1,
|
||||
];
|
||||
|
||||
// Try to find the TwingleProduct with its corresponding PriceField
|
||||
// for this product
|
||||
try {
|
||||
$price_field = TwingleProduct::findByExternalId($product['id']);
|
||||
}
|
||||
catch (Exception $e) {
|
||||
Civi::log()->error(E::LONG_NAME .
|
||||
": An error occurred when searching for TwingleShop with the external ID " .
|
||||
$product['id'], ['exception' => $e]);
|
||||
$price_field = NULL;
|
||||
}
|
||||
// If found, use the financial type and price field id from the price field
|
||||
if ($price_field) {
|
||||
|
||||
// Log warning if price differs from the submission
|
||||
if ($price_field->price != (int) $product['price']) {
|
||||
Civi::log()->warning(E::LONG_NAME .
|
||||
": Price for product " . $product['name'] . " differs from the PriceField. " .
|
||||
"Using the price from the submission.", ['price_field' => $price_field->price, 'submission' => $product['price']]);
|
||||
}
|
||||
|
||||
// Log warning if name differs from the submission
|
||||
if ($price_field->name != $product['name']) {
|
||||
Civi::log()->warning(E::LONG_NAME .
|
||||
": Name for product " . $product['name'] . " differs from the PriceField " .
|
||||
"Using the name from the submission.", ['price_field' => $price_field->name, 'submission' => $product['name']]);
|
||||
}
|
||||
|
||||
// Set the financial type and price field id
|
||||
$line_item_data['financial_type_id'] = $price_field->financial_type_id;
|
||||
$line_item_data['price_field_value_id'] = $price_field->getPriceFieldValueId();
|
||||
$line_item_data['price_field_id'] = $price_field->price_field_id;
|
||||
$line_item_data['description'] = $price_field->description;
|
||||
}
|
||||
// If not found, use the shops default financial type
|
||||
else {
|
||||
$financial_type_id = $profile->getAttribute('shop_financial_type', 1);
|
||||
$line_item_data['financial_type_id'] = $financial_type_id;
|
||||
}
|
||||
|
||||
// Create the line item
|
||||
$line_item = civicrm_api3('LineItem', 'create', $line_item_data);
|
||||
|
||||
if (!empty($line_item['is_error'])) {
|
||||
$line_item_name = $line_item_data['name'];
|
||||
throw new CiviCRM_API3_Exception(
|
||||
E::ts("Could not create line item for product '$line_item_name'"),
|
||||
'api_error'
|
||||
);
|
||||
}
|
||||
$line_items[] = array_pop($line_item['values']);
|
||||
|
||||
$sum_line_items += $product['total_value'];
|
||||
}
|
||||
|
||||
// Create line item for donation part
|
||||
$donation_sum = (float) $values['contribution']['total_amount'] - $sum_line_items;
|
||||
if ($donation_sum > 0) {
|
||||
$donation_financial_type_id = $profile->getAttribute('shop_donation_financial_type', 1);
|
||||
$donation_label = civicrm_api3('FinancialType', 'getsingle', [
|
||||
'return' => ['name'],
|
||||
'id' => $donation_financial_type_id,
|
||||
])['name'];
|
||||
|
||||
$donation_line_item_data = [
|
||||
'entity_table' => "civicrm_contribution",
|
||||
'contribution_id' => $contribution_id,
|
||||
'entity_id' => $contribution_id,
|
||||
'label' => $donation_label,
|
||||
'qty' => 1,
|
||||
'unit_price' => $donation_sum,
|
||||
'line_total' => $donation_sum,
|
||||
'financial_type_id' => $donation_financial_type_id,
|
||||
'sequential' => 1,
|
||||
];
|
||||
|
||||
$donation_line_item = civicrm_api3('LineItem', 'create', $donation_line_item_data);
|
||||
|
||||
if (!empty($donation_line_item['is_error'])) {
|
||||
throw new CiviCRM_API3_Exception(
|
||||
E::ts("Could not create line item for donation"),
|
||||
'api_error'
|
||||
);
|
||||
}
|
||||
|
||||
$line_items[] = array_pop($donation_line_item['values']);
|
||||
}
|
||||
|
||||
return $line_items;
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -137,4 +137,15 @@ class CRM_Twingle_Upgrader extends CRM_Extension_Upgrader_Base {
|
|||
return TRUE;
|
||||
}
|
||||
|
||||
/**
|
||||
* The Upgrade to 1.5.1 creates the tables civicrm_twingle_product and
|
||||
* civicrm_twingle_shop.
|
||||
*
|
||||
* @return TRUE on success
|
||||
*/
|
||||
public function upgrade_5151() {
|
||||
$this->ctx->log->info('Creating tables for Twingle Shop.');
|
||||
$this->executeSqlFile('sql/civicrm_twingle_shop.sql');
|
||||
return TRUE;
|
||||
}
|
||||
}
|
||||
|
|
|
|||
12
Civi/Api4/TwingleProduct.php
Normal file
12
Civi/Api4/TwingleProduct.php
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
<?php
|
||||
|
||||
namespace Civi\Api4;
|
||||
|
||||
/**
|
||||
* TwingleShop entity.
|
||||
*
|
||||
* @package Civi\Api4
|
||||
*/
|
||||
class TwingleProduct extends Generic\DAOEntity {
|
||||
|
||||
}
|
||||
12
Civi/Api4/TwingleShop.php
Normal file
12
Civi/Api4/TwingleShop.php
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
<?php
|
||||
|
||||
namespace Civi\Api4;
|
||||
|
||||
/**
|
||||
* TwingleShop entity.
|
||||
*
|
||||
* @package Civi\Api4
|
||||
*/
|
||||
class TwingleShop extends Generic\DAOEntity {
|
||||
|
||||
}
|
||||
|
|
@ -1,21 +1,4 @@
|
|||
<?php
|
||||
/*
|
||||
* Copyright (C) 2024 SYSTOPIA GmbH
|
||||
*
|
||||
* 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 in version 3.
|
||||
*
|
||||
* 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/>.
|
||||
*/
|
||||
|
||||
declare(strict_types = 1);
|
||||
|
||||
namespace Civi\Twingle\Exceptions;
|
||||
|
||||
|
|
@ -28,7 +11,7 @@ use CRM_Twingle_ExtensionUtil as E;
|
|||
class BaseException extends \Exception {
|
||||
|
||||
/**
|
||||
* @var string
|
||||
* @var int|string
|
||||
*/
|
||||
protected $code;
|
||||
protected string $log_message;
|
||||
|
|
@ -36,15 +19,13 @@ class BaseException extends \Exception {
|
|||
/**
|
||||
* BaseException Constructor
|
||||
* @param string $message
|
||||
* Error message
|
||||
* Error message
|
||||
* @param string $error_code
|
||||
* A meaningful error code
|
||||
* @param \Throwable $previous
|
||||
* A previously thrown exception to include.
|
||||
* A meaningful error code
|
||||
*/
|
||||
public function __construct(string $message = '', string $error_code = '', \Throwable $previous = NULL) {
|
||||
parent::__construct($message, 1, $previous);
|
||||
$this->log_message = '' !== $message ? E::LONG_NAME . ': ' . $message : '';
|
||||
public function __construct(string $message = '', string $error_code = '') {
|
||||
parent::__construct($message, 1);
|
||||
$this->log_message = !empty($message) ? E::LONG_NAME . ': ' . $message : '';
|
||||
$this->code = $error_code;
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,67 @@
|
|||
<?php
|
||||
/*
|
||||
* Copyright (C) 2024 SYSTOPIA GmbH
|
||||
*
|
||||
* 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 in version 3.
|
||||
*
|
||||
* 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/>.
|
||||
*/
|
||||
|
||||
declare(strict_types = 1);
|
||||
|
||||
namespace Civi\Twingle\Exceptions;
|
||||
|
||||
use CRM_Twingle_ExtensionUtil as E;
|
||||
|
||||
/**
|
||||
* A simple custom exception class that indicates a problem within a class
|
||||
* of the Twingle API extension.
|
||||
*/
|
||||
class BaseException extends \Exception {
|
||||
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
protected $code;
|
||||
protected string $log_message;
|
||||
|
||||
/**
|
||||
* BaseException Constructor
|
||||
* @param string $message
|
||||
* Error message
|
||||
* @param string $error_code
|
||||
* A meaningful error code
|
||||
* @param \Throwable $previous
|
||||
* A previously thrown exception to include.
|
||||
*/
|
||||
public function __construct(string $message = '', string $error_code = '', \Throwable $previous = NULL) {
|
||||
parent::__construct($message, 1, $previous);
|
||||
$this->log_message = '' !== $message ? E::LONG_NAME . ': ' . $message : '';
|
||||
$this->code = $error_code;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the error message, but with the extension name prefixed.
|
||||
* @return string
|
||||
*/
|
||||
public function getLogMessage() {
|
||||
return $this->log_message;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the error code.
|
||||
* @return string
|
||||
*/
|
||||
public function getErrorCode() {
|
||||
return $this->code;
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
<?php
|
||||
|
||||
namespace CRM\Twingle\Exceptions;
|
||||
namespace Civi\Twingle\Exceptions;
|
||||
|
||||
/**
|
||||
* A simple custom exception that indicates a problem within the
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
<?php
|
||||
|
||||
namespace CRM\Twingle\Exceptions;
|
||||
namespace Civi\Twingle\Exceptions;
|
||||
|
||||
/**
|
||||
* A simple custom error indicating a problem with the validation of the
|
||||
269
Civi/Twingle/Shop/ApiCall.php
Normal file
269
Civi/Twingle/Shop/ApiCall.php
Normal file
|
|
@ -0,0 +1,269 @@
|
|||
<?php /** @noinspection ALL */
|
||||
|
||||
namespace Civi\Twingle\Shop;
|
||||
|
||||
use CRM_TwingleCampaign_ExtensionUtil as E;
|
||||
use Civi\Twingle\Shop\Exceptions\ApiCallError;
|
||||
|
||||
/**
|
||||
* This class communicates with the Twingle API via cURL.
|
||||
* To keep the overhead of initialization low, this class is implemented as
|
||||
* a singleton. Please use CRM_Twingle_TwingleApiCall::singleton() to retrieve
|
||||
* an instance.
|
||||
*/
|
||||
class ApiCall {
|
||||
|
||||
/**
|
||||
* Twingle API url
|
||||
*/
|
||||
const BASE_URL = '.twingle.de/api';
|
||||
|
||||
/**
|
||||
* The transfer protocol
|
||||
*/
|
||||
const PROTOCOL = 'https://';
|
||||
|
||||
/**
|
||||
* The singleton object
|
||||
* @var \Civi\Twingle\Shop\ApiCall $singleton
|
||||
*/
|
||||
public static ApiCall $singleton;
|
||||
|
||||
/**
|
||||
* Your Twingle API token.
|
||||
* You can request an API token from Twingle support: <hilfe@twingle.de>
|
||||
* @var string $apiToken
|
||||
*/
|
||||
private string $apiToken;
|
||||
|
||||
/**
|
||||
* The ID of your organization in the Twingle database.
|
||||
* Automatically retrieved by sending a request with the associated API token.
|
||||
* @var int $organisationId
|
||||
*/
|
||||
public int $organisationId;
|
||||
|
||||
/**
|
||||
* This boolean indicates whether the connection was successful.
|
||||
*
|
||||
* @var bool $isConnected
|
||||
*/
|
||||
public bool $isConnected;
|
||||
|
||||
/**
|
||||
* Limit the number of items requested per API call.
|
||||
* @var int $limit
|
||||
*/
|
||||
public int $limit = 40;
|
||||
|
||||
/**
|
||||
* Header for cURL request.
|
||||
* @var string[] $header
|
||||
*/
|
||||
private array $header;
|
||||
|
||||
/**
|
||||
* The cURL wrapper
|
||||
* @var \Civi\Twingle\Shop\CurlWrapper $curlWrapper
|
||||
*/
|
||||
private CurlWrapper $curlWrapper;
|
||||
|
||||
/**
|
||||
* Protected TwingleApiCall constructor.
|
||||
* Use \Civi\Twingle\ApiCall::singleton() instead.
|
||||
* @param \Civi\Twingle\Shop\CurlWrapper $curlWrapper
|
||||
*/
|
||||
protected function __construct(CurlWrapper $curlWrapper) {
|
||||
$this->curlWrapper = $curlWrapper;
|
||||
$this->isConnected = FALSE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns \Civi\Twingle\Shop\ApiCall singleton
|
||||
*
|
||||
* @param \Civi\Twingle\Shop\CurlWrapper|null $curlWrapper
|
||||
* Optional cURL wrapper for testing purposes
|
||||
* @return \Civi\Twingle\Shop\ApiCall
|
||||
*/
|
||||
public static function singleton(CurlWrapper $curlWrapper = null): ApiCall {
|
||||
if (empty(self::$singleton)) {
|
||||
$curlWrapper = $curlWrapper ?? new CurlWrapper();
|
||||
self::$singleton = new ApiCall($curlWrapper);
|
||||
return self::$singleton;
|
||||
}
|
||||
else {
|
||||
return self::$singleton;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Try to connect to the Twingle API and retrieve the organisation ID.
|
||||
*
|
||||
* @return bool
|
||||
* returns TRUE if the connection was successfully established
|
||||
*
|
||||
* @throws \Civi\Twingle\Shop\Exceptions\ApiCallError
|
||||
*/
|
||||
public function connect(): bool {
|
||||
|
||||
$this->isConnected = FALSE;
|
||||
|
||||
try {
|
||||
// Get api token from settings
|
||||
$apiToken = \Civi::settings()->get("twingle_access_key");
|
||||
if (empty($apiToken)) {
|
||||
throw new \TypeError();
|
||||
}
|
||||
$this->apiToken = $apiToken;
|
||||
} catch (\TypeError $e) {
|
||||
throw new ApiCallError(
|
||||
E::ts("Could not find Twingle API token"),
|
||||
ApiCallError::ERROR_CODE_API_TOKEN_MISSING,
|
||||
);
|
||||
}
|
||||
|
||||
$this->header = [
|
||||
"x-access-code: $this->apiToken",
|
||||
'Content-Type: application/json',
|
||||
];
|
||||
|
||||
$url = self::PROTOCOL . 'organisation' . self::BASE_URL . "/";
|
||||
$curl = curl_init($url);
|
||||
curl_setopt($curl, CURLOPT_RETURNTRANSFER, TRUE);
|
||||
curl_setopt($curl, CURLOPT_HTTPHEADER, $this->header);
|
||||
|
||||
$response = json_decode(curl_exec($curl), TRUE);
|
||||
|
||||
if (empty($response)) {
|
||||
curl_close($curl);
|
||||
throw new ApiCallError(
|
||||
E::ts("Call to Twingle API failed. Please check your api token."),
|
||||
ApiCallError::ERROR_CODE_CONNECTION_FAILED,
|
||||
);
|
||||
}
|
||||
self::check_response_and_close($response, $curl);
|
||||
|
||||
$this->organisationId = array_column($response, 'id')[0];
|
||||
$this->isConnected = TRUE;
|
||||
return $this->isConnected;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check response on cURL
|
||||
*
|
||||
* @param $response
|
||||
* the cURL response to check
|
||||
* @param $curl
|
||||
* the cURL resource
|
||||
*
|
||||
* @return bool
|
||||
* returns true if the response is fine
|
||||
*
|
||||
* @throws \Civi\Twingle\Shop\Exceptions\ApiCallError
|
||||
*/
|
||||
protected static function check_response_and_close($response, $curl) {
|
||||
|
||||
$curl_status_code = curl_getinfo($curl, CURLINFO_HTTP_CODE);
|
||||
curl_close($curl);
|
||||
|
||||
if ($response == FALSE) {
|
||||
throw new ApiCallError(
|
||||
E::ts('GET curl failed'),
|
||||
ApiCallError::ERROR_CODE_GET_REQUEST_FAILED,
|
||||
);
|
||||
}
|
||||
if ($curl_status_code == 404) {
|
||||
throw new ApiCallError(
|
||||
E::ts('http status code 404 (not found)'),
|
||||
ApiCallError::ERROR_CODE_404,
|
||||
);
|
||||
}
|
||||
elseif ($curl_status_code == 500) {
|
||||
throw new ApiCallError(
|
||||
E::ts('https status code 500 (internal error)'),
|
||||
ApiCallError::ERROR_CODE_500,
|
||||
);
|
||||
}
|
||||
|
||||
return TRUE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends a GET cURL and returns the result array.
|
||||
*
|
||||
* @param $entity
|
||||
* Twingle entity
|
||||
*
|
||||
* @param null $params
|
||||
* Optional GET parameters
|
||||
*
|
||||
* @return array
|
||||
* Returns the result array of the or FALSE, if the cURL failed
|
||||
* @throws \Civi\Twingle\Shop\Exceptions\ApiCallError
|
||||
*/
|
||||
public function get(
|
||||
string $entity,
|
||||
string $entityId = NULL,
|
||||
string $endpoint = NULL,
|
||||
string $endpointId = NULL,
|
||||
array $params = NULL
|
||||
): array {
|
||||
|
||||
// Throw an error, if connection is not yet established
|
||||
if ($this->isConnected == FALSE) {
|
||||
throw new ApiCallError(
|
||||
E::ts("Connection not yet established. Use connect() method."),
|
||||
ApiCallError::ERROR_CODE_NOT_CONNECTED,
|
||||
);
|
||||
}
|
||||
|
||||
// Build URL and initialize cURL
|
||||
$url = self::PROTOCOL . $entity . self::BASE_URL;
|
||||
if (!empty($entityId)) {
|
||||
$url .= "/$entityId";
|
||||
}
|
||||
if (!empty($endpoint)) {
|
||||
$url .= "/$endpoint";
|
||||
}
|
||||
if (!empty($endpointId)) {
|
||||
$url .= "/$endpointId";
|
||||
}
|
||||
if (!empty($params)) {
|
||||
$url .= '?' . http_build_query($params);
|
||||
}
|
||||
$curl = curl_init($url);
|
||||
curl_setopt($curl, CURLOPT_RETURNTRANSFER, TRUE);
|
||||
curl_setopt($curl, CURLOPT_HTTPHEADER, $this->header);
|
||||
|
||||
// Execute cURL
|
||||
$response = json_decode(curl_exec($curl), TRUE);
|
||||
self::check_response_and_close($response, $curl);
|
||||
|
||||
return $response;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* A simple wrapper for the cURL functions to allow for easier testing.
|
||||
*/
|
||||
class CurlWrapper {
|
||||
public function init($url) {
|
||||
return curl_init($url);
|
||||
}
|
||||
|
||||
public function setopt($ch, $option, $value) {
|
||||
return curl_setopt($ch, $option, $value);
|
||||
}
|
||||
|
||||
public function exec($ch) {
|
||||
return curl_exec($ch);
|
||||
}
|
||||
|
||||
public function getinfo($ch, $option) {
|
||||
return curl_getinfo($ch, $option);
|
||||
}
|
||||
|
||||
public function close($ch) {
|
||||
curl_close($ch);
|
||||
}
|
||||
}
|
||||
649
Civi/Twingle/Shop/BAO/TwingleProduct.php
Normal file
649
Civi/Twingle/Shop/BAO/TwingleProduct.php
Normal file
|
|
@ -0,0 +1,649 @@
|
|||
<?php
|
||||
|
||||
namespace Civi\Twingle\Shop\BAO;
|
||||
|
||||
use Civi\Api4\PriceField;
|
||||
use Civi\Twingle\Shop\DAO\TwingleProduct as TwingleProductDAO;
|
||||
use Civi\Twingle\Shop\DAO\TwingleShop as TwingleShopDAO;
|
||||
use Civi\Twingle\Shop\Exceptions\ProductException;
|
||||
use Civi\Twingle\Shop\Exceptions\ShopException;
|
||||
use CRM_Core_Exception;
|
||||
use CRM_Core_Transaction;
|
||||
use CRM_Twingle_ExtensionUtil as E;
|
||||
use CRM_Utils_Type;
|
||||
use function Civi\Twingle\Shop\Utils\convert_int_to_bool;
|
||||
use function Civi\Twingle\Shop\Utils\convert_str_to_date;
|
||||
use function Civi\Twingle\Shop\Utils\convert_str_to_int;
|
||||
use function Civi\Twingle\Shop\Utils\convert_null_to_int;
|
||||
use function Civi\Twingle\Shop\Utils\filter_attributes;
|
||||
use function Civi\Twingle\Shop\Utils\validate_data_types;
|
||||
|
||||
require_once E::path() . '/Civi/Twingle/Shop/Utils/TwingleShopUtils.php';
|
||||
|
||||
/**
|
||||
* TwingleProduct BAO class.
|
||||
* This class is used to implement the logic for the TwingleProduct entity.
|
||||
*/
|
||||
class TwingleProduct extends TwingleProductDAO {
|
||||
|
||||
/**
|
||||
* Name of this product.
|
||||
*/
|
||||
public $name;
|
||||
|
||||
/**
|
||||
* Is this product active?
|
||||
*/
|
||||
public $is_active;
|
||||
|
||||
/**
|
||||
* Price of this product.
|
||||
*/
|
||||
public $price;
|
||||
|
||||
/**
|
||||
* Sort order of this product.
|
||||
*/
|
||||
public $sort;
|
||||
|
||||
/**
|
||||
* Short description of this Product.
|
||||
*/
|
||||
public $text;
|
||||
|
||||
/**
|
||||
* Long description of this Product.
|
||||
*/
|
||||
public $description;
|
||||
|
||||
/**
|
||||
* ID of the corresponding Twingle Shop.
|
||||
*/
|
||||
public $project_id;
|
||||
|
||||
/**
|
||||
* ID of the financial type of this product.
|
||||
*/
|
||||
public $financial_type_id;
|
||||
|
||||
/**
|
||||
* Timestamp of the last update in Twingle db.
|
||||
*/
|
||||
public $tw_updated_at;
|
||||
|
||||
/**
|
||||
* The values of this attributes can be 0.
|
||||
* (For filtering purposes)
|
||||
*/
|
||||
protected const CAN_BE_ZERO = [
|
||||
"price",
|
||||
"sort",
|
||||
];
|
||||
|
||||
/**
|
||||
* Attributes that need to be converted to int.
|
||||
*/
|
||||
protected const STR_TO_INT_CONVERSION = [
|
||||
"id",
|
||||
"twingle_shop_id",
|
||||
"financial_type_id",
|
||||
"price_field_id",
|
||||
"project_id",
|
||||
"external_id",
|
||||
"tw_updated_at",
|
||||
"tw_created_at",
|
||||
"price",
|
||||
"sort",
|
||||
];
|
||||
|
||||
/**
|
||||
* Attributes that need to be converted to boolean.
|
||||
*/
|
||||
protected const INT_TO_BOOL_CONVERSION = [
|
||||
"is_active",
|
||||
];
|
||||
|
||||
/**
|
||||
* String to date conversion.
|
||||
*/
|
||||
protected const STR_TO_DATE_CONVERSION = [
|
||||
"created_at",
|
||||
"updated_at",
|
||||
];
|
||||
|
||||
/**
|
||||
* Attributes that need to be converted from NULL to int.
|
||||
*/
|
||||
protected const NULL_TO_INT_CONVERSION = [
|
||||
"price",
|
||||
];
|
||||
|
||||
/**
|
||||
* Allowed product attributes.
|
||||
* Attributes that we currently don't support are commented out.
|
||||
*/
|
||||
protected const ALLOWED_ATTRIBUTES = [
|
||||
"id" => CRM_Utils_Type::T_INT,
|
||||
"external_id" => CRM_Utils_Type::T_INT,
|
||||
"name" => CRM_Utils_Type::T_STRING,
|
||||
"is_active" => CRM_Utils_Type::T_BOOLEAN,
|
||||
"description" => CRM_Utils_Type::T_STRING,
|
||||
"price" => CRM_Utils_Type::T_INT,
|
||||
"created_at" => CRM_Utils_Type::T_INT,
|
||||
"tw_created_at" => CRM_Utils_Type::T_INT,
|
||||
"updated_at" => CRM_Utils_Type::T_INT,
|
||||
"tw_updated_at" => CRM_Utils_Type::T_INT,
|
||||
"is_orphaned" => CRM_Utils_Type::T_BOOLEAN,
|
||||
"is_outdated" => CRM_Utils_Type::T_BOOLEAN,
|
||||
"project_id" => CRM_Utils_Type::T_INT,
|
||||
"sort" => CRM_Utils_Type::T_INT,
|
||||
"financial_type_id" => CRM_Utils_Type::T_INT,
|
||||
"twingle_shop_id" => CRM_Utils_Type::T_INT,
|
||||
"price_field_id" => CRM_Utils_Type::T_INT,
|
||||
# "text" => \CRM_Utils_Type::T_STRING,
|
||||
# "images" => \CRM_Utils_Type::T_STRING,
|
||||
# "categories" = \CRM_Utils_Type::T_STRING,
|
||||
# "internal_id" => \CRM_Utils_Type::T_STRING,
|
||||
# "has_zero_price" => \CRM_Utils_Type::T_BOOLEAN,
|
||||
# "name_plural" => \CRM_Utils_Type::T_STRING,
|
||||
# "max_count" => \CRM_Utils_Type::T_INT,
|
||||
# "has_textinput" => \CRM_Utils_Type::T_BOOLEAN,
|
||||
# "count" => \CRM_Utils_Type::T_INT,
|
||||
];
|
||||
|
||||
/**
|
||||
* Change attribute names to match the database column names.
|
||||
*
|
||||
* @param array $values
|
||||
* Array with product data from Twingle API
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public static function renameTwingleAttrs(array $values) {
|
||||
$new_values = [];
|
||||
foreach ($values as $key => $value) {
|
||||
// replace 'id' with 'external_id'
|
||||
if ($key == 'id') {
|
||||
$key = 'external_id';
|
||||
}
|
||||
// replace 'updated_at' with 'tw_updated_at'
|
||||
if ($key == 'updated_at') {
|
||||
$key = 'tw_updated_at';
|
||||
}
|
||||
// replace 'created_at' with 'tw_created_at'
|
||||
if ($key == 'created_at') {
|
||||
$key = 'tw_created_at';
|
||||
}
|
||||
$new_values[$key] = $value;
|
||||
}
|
||||
return $new_values;
|
||||
}
|
||||
|
||||
/**
|
||||
* Load product data.
|
||||
*
|
||||
* @param array $product_data
|
||||
* Array with product data
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @throws ProductException
|
||||
* @throws \Exception
|
||||
*/
|
||||
public function load(array $product_data): void {
|
||||
// Filter for allowed attributes
|
||||
filter_attributes(
|
||||
$product_data,
|
||||
self::ALLOWED_ATTRIBUTES,
|
||||
self::CAN_BE_ZERO,
|
||||
);
|
||||
|
||||
// Amend data from corresponding PriceFieldValue
|
||||
if (isset($product_data['price_field_id'])) {
|
||||
try {
|
||||
$price_field_value = civicrm_api3('PriceFieldValue', 'getsingle', [
|
||||
'price_field_id' => $product_data['price_field_id'],
|
||||
]);
|
||||
}
|
||||
catch (CRM_Core_Exception $e) {
|
||||
throw new ProductException(
|
||||
E::ts("Could not find PriceFieldValue for Twingle Product ['id': %1, 'external_id': %2]: %3",
|
||||
[
|
||||
1 => $product_data['id'],
|
||||
2 => $product_data['external_id'],
|
||||
3 => $e->getMessage(),
|
||||
]),
|
||||
ProductException::ERROR_CODE_PRICE_FIELD_VALUE_NOT_FOUND);
|
||||
}
|
||||
$product_data['name'] = $product_data['name'] ?? $price_field_value['label'];
|
||||
$product_data['price'] = $product_data['price'] ?? $price_field_value['amount'];
|
||||
$product_data['financial_type_id'] = $product_data['financial_type_id'] ?? $price_field_value['financial_type_id'];
|
||||
$product_data['is_active'] = $product_data['is_active'] ?? $price_field_value['is_active'];
|
||||
$product_data['sort'] = $product_data['sort'] ?? $price_field_value['weight'];
|
||||
$product_data['description'] = $product_data['description'] ?? $price_field_value['description'];
|
||||
}
|
||||
|
||||
// Change data types
|
||||
try {
|
||||
convert_str_to_int($product_data, self::STR_TO_INT_CONVERSION);
|
||||
convert_int_to_bool($product_data, self::INT_TO_BOOL_CONVERSION);
|
||||
convert_str_to_date($product_data, self::STR_TO_DATE_CONVERSION);
|
||||
convert_null_to_int($product_data, self::NULL_TO_INT_CONVERSION);
|
||||
}
|
||||
catch (\Exception $e) {
|
||||
throw new ProductException($e->getMessage(), ProductException::ERROR_CODE_ATTRIBUTE_WRONG_DATA_TYPE);
|
||||
}
|
||||
|
||||
// Validate data types
|
||||
try {
|
||||
validate_data_types($product_data, self::ALLOWED_ATTRIBUTES);
|
||||
}
|
||||
catch (\Exception $e) {
|
||||
throw new ProductException($e->getMessage(), ProductException::ERROR_CODE_ATTRIBUTE_WRONG_DATA_TYPE);
|
||||
}
|
||||
|
||||
// Set attributes
|
||||
foreach ($product_data as $key => $value) {
|
||||
$this->$key = $value;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a price field to represents this product in CiviCRM.
|
||||
*
|
||||
* @param string $mode
|
||||
* 'create' or 'edit'
|
||||
* @throws \Civi\Twingle\Shop\Exceptions\ProductException
|
||||
*/
|
||||
public function createPriceField() {
|
||||
// Define mode for PriceField
|
||||
$mode = $this->price_field_id ? 'edit' : 'create';
|
||||
$action = $mode == 'create' ? 'create' : 'update';
|
||||
|
||||
// Check if PriceSet for this Shop already exists
|
||||
try {
|
||||
$price_field = civicrm_api3('PriceField', 'get', [
|
||||
'name' => 'tw_product_' . $this->external_id,
|
||||
]);
|
||||
if ($price_field['count'] > 0 && $mode == 'create') {
|
||||
throw new ProductException(
|
||||
E::ts('PriceField for this Twingle Product already exists.'),
|
||||
ProductException::ERROR_CODE_PRICE_FIELD_ALREADY_EXISTS,
|
||||
);
|
||||
} elseif ($price_field['count'] == 0 && $mode == 'edit') {
|
||||
throw new ProductException(
|
||||
E::ts('PriceField for this Twingle Product does not exist and cannot be edited.'),
|
||||
ProductException::ERROR_CODE_PRICE_FIELD_NOT_FOUND,
|
||||
);
|
||||
}
|
||||
}
|
||||
catch (CRM_Core_Exception $e) {
|
||||
throw new ProductException(
|
||||
E::ts('Could not check if PriceField for this Twingle Product already exists.'),
|
||||
ProductException::ERROR_CODE_PRICE_FIELD_NOT_FOUND,
|
||||
);
|
||||
}
|
||||
|
||||
// Try to find corresponding price set via TwingleShop
|
||||
try {
|
||||
$shop = civicrm_api3('TwingleShop', 'getsingle', [
|
||||
'id' => $this->twingle_shop_id,
|
||||
]);
|
||||
$this->price_set_id = (int) $shop['price_set_id'];
|
||||
}
|
||||
catch (CRM_Core_Exception $e) {
|
||||
throw new ProductException(
|
||||
E::ts('Could not find PriceSet for this Twingle Product.'),
|
||||
ProductException::ERROR_CODE_PRICE_SET_NOT_FOUND,
|
||||
);
|
||||
}
|
||||
|
||||
// Create PriceField
|
||||
$price_field_data = [
|
||||
'price_set_id' => $this->price_set_id,
|
||||
'name' => 'tw_product_' . $this->external_id,
|
||||
'label' => $this->name,
|
||||
'is_active' => $this->is_active,
|
||||
'weight' => $this->sort,
|
||||
'html_type' => 'Text',
|
||||
];
|
||||
// Add id if in edit mode
|
||||
if ($mode == 'edit') {
|
||||
$price_field_data['id'] = $this->price_field_id;
|
||||
}
|
||||
try {
|
||||
$price_field = civicrm_api4(
|
||||
'PriceField',
|
||||
$action,
|
||||
['values' => $price_field_data],
|
||||
)->first();
|
||||
$this->price_field_id = (int) $price_field['id'];
|
||||
}
|
||||
catch (CRM_Core_Exception $e) {
|
||||
throw new ProductException(
|
||||
E::ts('Could not create PriceField for this Twingle Product: %1',
|
||||
[1 => $e->getMessage()]),
|
||||
ProductException::ERROR_CODE_COULD_NOT_CREATE_PRICE_FIELD);
|
||||
}
|
||||
|
||||
// Try to find existing PriceFieldValue if in edit mode
|
||||
$price_field_value = NULL;
|
||||
if ($mode == 'edit') {
|
||||
try {
|
||||
$price_field_value = civicrm_api3('PriceFieldValue', 'getsingle', [
|
||||
'price_field_id' => $this->price_field_id,
|
||||
]);
|
||||
}
|
||||
catch (CRM_Core_Exception $e) {
|
||||
throw new ProductException(
|
||||
E::ts('Could not find PriceFieldValue for this Twingle Product: %1',
|
||||
[1 => $e->getMessage()]),
|
||||
ProductException::ERROR_CODE_PRICE_FIELD_VALUE_NOT_FOUND);
|
||||
}
|
||||
}
|
||||
|
||||
// Create PriceFieldValue
|
||||
$price_field_value_data = [
|
||||
'price_field_id' => $this->price_field_id,
|
||||
'financial_type_id' => $this->financial_type_id,
|
||||
'label' => $this->name,
|
||||
'amount' => $this->price,
|
||||
'is_active' => $this->is_active,
|
||||
'description' => $this->description,
|
||||
];
|
||||
// Add id if in edit mode
|
||||
if ($mode == 'edit' && $price_field_value) {
|
||||
$price_field_value_data['id'] = $price_field_value['id'];
|
||||
}
|
||||
try {
|
||||
civicrm_api4(
|
||||
'PriceFieldValue',
|
||||
$action,
|
||||
['values' => $price_field_value_data],
|
||||
);
|
||||
}
|
||||
catch (CRM_Core_Exception $e) {
|
||||
throw new ProductException(
|
||||
E::ts('Could not create PriceFieldValue for this Twingle Product: %1',
|
||||
[1 => $e->getMessage()]),
|
||||
ProductException::ERROR_CODE_COULD_NOT_CREATE_PRICE_FIELD_VALUE);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns this TwingleProduct's attributes.
|
||||
*
|
||||
* @return array
|
||||
* @throws \CRM_Core_Exception
|
||||
*/
|
||||
public function getAttributes() {
|
||||
// Filter for allowed attributes
|
||||
return array_intersect_key(
|
||||
get_object_vars($this),
|
||||
$this::ALLOWED_ATTRIBUTES
|
||||
) // Add financial type id of this product if it exists
|
||||
+ ['financial_type_id' => $this->getFinancialTypeId()];
|
||||
}
|
||||
|
||||
/**
|
||||
* Find TwingleProduct by its external ID.
|
||||
*
|
||||
* @param int $external_id
|
||||
* External id of the product (by Twingle)
|
||||
*
|
||||
* @return TwingleProduct|null
|
||||
* TwingleProduct object or NULL if not found
|
||||
*
|
||||
* @throws \Civi\Twingle\Shop\Exceptions\ProductException
|
||||
* @throws \Civi\Core\Exception\DBQueryException
|
||||
*/
|
||||
public static function findByExternalId($external_id) {
|
||||
$dao = TwingleShopDAO::executeQuery("SELECT * FROM civicrm_twingle_product WHERE external_id = %1",
|
||||
[1 => [$external_id, 'String']]);
|
||||
if ($dao->fetch()) {
|
||||
$product = new self();
|
||||
$product->load($dao->toArray());
|
||||
return $product;
|
||||
}
|
||||
return NULL;
|
||||
}
|
||||
|
||||
/**
|
||||
* Add Twingle Product
|
||||
*
|
||||
* @param string $mode
|
||||
* 'create' or 'edit'
|
||||
* @return array
|
||||
* @throws \Civi\Twingle\Shop\Exceptions\ProductException
|
||||
* @throws \Exception
|
||||
*/
|
||||
public function add($mode = 'create') {
|
||||
|
||||
$tx = new CRM_Core_Transaction();
|
||||
|
||||
// Define mode
|
||||
$mode = $this->id ? 'edit' : 'create';
|
||||
|
||||
// Try to lookup object in database
|
||||
try {
|
||||
$dao = TwingleShopDAO::executeQuery("SELECT * FROM civicrm_twingle_product WHERE external_id = %1",
|
||||
[1 => [$this->external_id, 'String']]);
|
||||
if ($dao->fetch()) {
|
||||
$this->copyValues(array_merge($dao->toArray(), $this->getAttributes()));
|
||||
}
|
||||
}
|
||||
catch (\Civi\Core\Exception\DBQueryException $e) {
|
||||
throw new ProductException(
|
||||
E::ts('Could not find TwingleProduct in database: ' . $e->getMessage()),
|
||||
ShopException::ERROR_CODE_COULD_NOT_FIND_SHOP_IN_DB);
|
||||
}
|
||||
|
||||
// Register pre-hook
|
||||
$twingle_product_values = $this->getAttributes();
|
||||
try {
|
||||
\CRM_Utils_Hook::pre($mode, 'TwingleProduct', $this->id, $twingle_product_values);
|
||||
} catch (\Exception $e) {
|
||||
$tx->rollback();
|
||||
throw $e;
|
||||
}
|
||||
$this->load($twingle_product_values);
|
||||
|
||||
// Set latest tw_updated_at as new updated_at
|
||||
$this->updated_at = \CRM_Utils_Time::date('Y-m-d H:i:s', $this->tw_updated_at);
|
||||
|
||||
// Convert created_at to date string
|
||||
$this->created_at = \CRM_Utils_Time::date('Y-m-d H:i:s', $this->created_at);
|
||||
|
||||
// Save object to database
|
||||
try {
|
||||
$this->save();
|
||||
} catch (\Exception $e) {
|
||||
$tx->rollback();
|
||||
throw new ProductException(
|
||||
E::ts('Could not save TwingleProduct to database: ' . $e->getMessage()),
|
||||
ProductException::ERROR_CODE_COULD_NOT_CREATE_PRODUCT);
|
||||
}
|
||||
$result = self::findById($this->id);
|
||||
/* @var self $result */
|
||||
$this->load($result->getAttributes());
|
||||
|
||||
// Register post-hook
|
||||
$twingle_product_values = $this->getAttributes();
|
||||
try {
|
||||
\CRM_Utils_Hook::post($mode, 'TwingleProduct', $this->id, $twingle_product_values);
|
||||
}
|
||||
catch (\Exception $e) {
|
||||
$tx->rollback();
|
||||
throw $e;
|
||||
}
|
||||
$this->load($twingle_product_values);
|
||||
|
||||
return $result->toArray();
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete TwingleProduct along with associated PriceField and PriceFieldValue.
|
||||
*
|
||||
* @override \Civi\Twingle\Shop\DAO\TwingleProduct::delete
|
||||
* @throws \CRM_Core_Exception
|
||||
* @throws \Civi\Twingle\Shop\Exceptions\ProductException
|
||||
*/
|
||||
function delete($useWhere = FALSE) {
|
||||
// Register post-hook
|
||||
$twingle_product_values = $this->getAttributes();
|
||||
\CRM_Utils_Hook::pre('delete', 'TwingleProduct', $this->id, $twingle_product_values);
|
||||
$this->load($twingle_product_values);
|
||||
|
||||
// Delete TwingleProduct
|
||||
parent::delete($useWhere);
|
||||
|
||||
// Register post-hook
|
||||
\CRM_Utils_Hook::post('delete', 'TwingleProduct', $this->id, $instance);
|
||||
|
||||
// Free global arrays associated with this object
|
||||
$this->free();
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Complements the data with the data that was fetched from Twingle.
|
||||
*
|
||||
* @throws \Civi\Twingle\Shop\Exceptions\ProductException
|
||||
*/
|
||||
public function complementWithDataFromTwingle($product_from_twingle) {
|
||||
// Complement with data from Twingle
|
||||
$this->load([
|
||||
'project_id' => $product_from_twingle['project_id'],
|
||||
'tw_updated_at' => $product_from_twingle['updated_at'],
|
||||
'tw_created_at' => $product_from_twingle['created_at'],
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if the product is outdated.
|
||||
*
|
||||
* @param $product_from_twingle
|
||||
*
|
||||
* @return void
|
||||
* @throws \Civi\Twingle\Shop\Exceptions\ProductException
|
||||
*/
|
||||
public function checkOutdated($product_from_twingle) {
|
||||
// Mark outdated products which have a newer timestamp in Twingle
|
||||
if ($this->updated_at < intval($product_from_twingle['updated_at'])) {
|
||||
// Overwrite the product with the data from Twingle
|
||||
$this->load(self::renameTwingleAttrs($product_from_twingle));
|
||||
$this->is_outdated = TRUE;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Compare two products
|
||||
*
|
||||
* @param TwingleProduct $product_to_compare_with
|
||||
* Product from database
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function equals($product_to_compare_with) {
|
||||
return
|
||||
$this->name === $product_to_compare_with->name &&
|
||||
$this->description === $product_to_compare_with->description &&
|
||||
$this->text === $product_to_compare_with->text &&
|
||||
$this->price === $product_to_compare_with->price &&
|
||||
$this->external_id === $product_to_compare_with->external_id;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the financial type id of this product.
|
||||
*
|
||||
* @return int|null
|
||||
* @throws \CRM_Core_Exception
|
||||
*/
|
||||
public function getFinancialTypeId(): ?int {
|
||||
if (!empty($this->price_field_id)) {
|
||||
$price_set = \Civi\Api4\PriceField::get()
|
||||
->addSelect('financial_type_id')
|
||||
->addWhere('id', '=', $this->price_field_id)
|
||||
->execute()
|
||||
->first();
|
||||
return $price_set['financial_type_id'];
|
||||
}
|
||||
return NULL;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the price field value id of this product.
|
||||
*
|
||||
* @return int|null
|
||||
* @throws \CRM_Core_Exception
|
||||
*/
|
||||
public function getPriceFieldValueId() {
|
||||
if (!empty($this->price_field_id)) {
|
||||
$price_field_value = \Civi\Api4\PriceFieldValue::get()
|
||||
->addSelect('id')
|
||||
->addWhere('price_field_id', '=', $this->price_field_id)
|
||||
->execute()
|
||||
->first();
|
||||
return $price_field_value['id'];
|
||||
}
|
||||
return NULL;
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete PriceField and PriceFieldValue of this TwingleProduct if they exist.
|
||||
*
|
||||
* @return void
|
||||
* @throws \Civi\Twingle\Shop\Exceptions\ProductException
|
||||
*/
|
||||
public function deletePriceField(): void {
|
||||
// Before we can delete the PriceField we need to delete the associated
|
||||
// PriceFieldValue
|
||||
try {
|
||||
$result = civicrm_api3('PriceFieldValue', 'getsingle',
|
||||
['price_field_id' => $this->price_field_id]);
|
||||
}
|
||||
catch (CRM_Core_Exception $e) {
|
||||
throw new ProductException(
|
||||
E::ts('An Error occurred while searching for the associated PriceFieldValue: ' . $e->getMessage()),
|
||||
ProductException::ERROR_CODE_PRICE_FIELD_VALUE_NOT_FOUND);
|
||||
}
|
||||
try {
|
||||
civicrm_api3('PriceFieldValue', 'delete', ['id' => $result['id']]);
|
||||
}
|
||||
catch (CRM_Core_Exception $e) {
|
||||
throw new ProductException(
|
||||
E::ts('Could not delete associated PriceFieldValue: ' . $e->getMessage()),
|
||||
ProductException::ERROR_CODE_COULD_NOT_DELETE_PRICE_FIELD_VALUE);
|
||||
}
|
||||
|
||||
// Try to delete PriceField
|
||||
// If no PriceField is found, we assume that it has already been deleted
|
||||
try {
|
||||
civicrm_api3('PriceField', 'delete',
|
||||
['id' => $this->price_field_id]);
|
||||
}
|
||||
catch (CRM_Core_Exception $e) {
|
||||
// Check if PriceField yet exists
|
||||
try {
|
||||
$result = civicrm_api3('PriceField', 'get',
|
||||
['id' => $this->price_field_id]);
|
||||
// Throw exception if PriceField still exists
|
||||
if ($result['count'] > 0) {
|
||||
throw new ProductException(
|
||||
E::ts('PriceField for this Twingle Product still exists.'),
|
||||
ProductException::ERROR_CODE_PRICE_FIELD_STILL_EXISTS);
|
||||
}
|
||||
}
|
||||
catch (CRM_Core_Exception $e) {
|
||||
throw new ProductException(
|
||||
E::ts('An Error occurred while searching for the associated PriceField: ' . $e->getMessage()),
|
||||
ProductException::ERROR_CODE_PRICE_FIELD_NOT_FOUND);
|
||||
}
|
||||
throw new ProductException(
|
||||
E::ts('Could not delete associated PriceField: ' . $e->getMessage()),
|
||||
ProductException::ERROR_CODE_COULD_NOT_DELETE_PRICE_FIELD);
|
||||
}
|
||||
$this->price_field_id = NULL;
|
||||
}
|
||||
}
|
||||
478
Civi/Twingle/Shop/BAO/TwingleShop.php
Normal file
478
Civi/Twingle/Shop/BAO/TwingleShop.php
Normal file
|
|
@ -0,0 +1,478 @@
|
|||
<?php
|
||||
|
||||
namespace Civi\Twingle\Shop\BAO;
|
||||
|
||||
// phpcs:disable
|
||||
use CRM_Twingle_ExtensionUtil as E;
|
||||
use Civi\Twingle\Shop\DAO\TwingleShop as TwingleShopDAO;
|
||||
use Civi\Twingle\Shop\BAO\TwingleProduct as TwingleProductBAO;
|
||||
use Civi\Twingle\Shop\ApiCall;
|
||||
use Civi\Twingle\Shop\Exceptions\ShopException;
|
||||
use Civi\Twingle\Shop\Exceptions\ProductException;
|
||||
use Exception;
|
||||
use function Civi\Twingle\Shop\Utils\filter_attributes;
|
||||
use function Civi\Twingle\Shop\Utils\convert_str_to_int;
|
||||
use function Civi\Twingle\Shop\Utils\validate_data_types;
|
||||
// phpcs:enable
|
||||
|
||||
require_once E::path() . '/Civi/Twingle/Shop/Utils/TwingleShopUtils.php';
|
||||
|
||||
class TwingleShop extends TwingleShopDAO {
|
||||
|
||||
public const ALLOWED_ATTRIBUTES = [
|
||||
'id' => \CRM_Utils_Type::T_INT,
|
||||
'project_identifier' => \CRM_Utils_Type::T_STRING,
|
||||
'numerical_project_id' => \CRM_Utils_Type::T_INT,
|
||||
'name' => \CRM_Utils_Type::T_STRING,
|
||||
'price_set_id' => \CRM_Utils_Type::T_INT,
|
||||
'financial_type_id' => \CRM_Utils_Type::T_INT,
|
||||
];
|
||||
|
||||
public const STR_TO_INT_CONVERSION = [
|
||||
'id',
|
||||
'numerical_project_id',
|
||||
'price_set_id',
|
||||
'financial_type_id',
|
||||
];
|
||||
|
||||
/**
|
||||
* @var array $products
|
||||
* Array of Twingle Shop products (Cache)
|
||||
*/
|
||||
public $products;
|
||||
|
||||
/**
|
||||
* FK to Financial Type
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public $financial_type_id;
|
||||
|
||||
/**
|
||||
* TwingleShop constructor
|
||||
*/
|
||||
public function __construct() {
|
||||
parent::__construct();
|
||||
// Get TwingleApiCall singleton
|
||||
$this->twingleApi = ApiCall::singleton();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get Twingle Shop from database by its project identifier
|
||||
* (like 'tw620214349ac97')
|
||||
*
|
||||
* @param string $project_identifier
|
||||
* Twingle project identifier
|
||||
*
|
||||
* @return TwingleShop
|
||||
*
|
||||
* @throws ShopException
|
||||
* @throws \Civi\Twingle\Shop\Exceptions\ApiCallError
|
||||
* @throws \CRM_Core_Exception
|
||||
*/
|
||||
public static function findByProjectIdentifier(string $project_identifier) {
|
||||
$shop = new TwingleShop();
|
||||
$shop->get('project_identifier', $project_identifier);
|
||||
if (!$shop->id) {
|
||||
$shop->fetchDataFromTwingle($project_identifier);
|
||||
}
|
||||
else {
|
||||
$shop->price_set_id = civicrm_api3('PriceSet', 'getvalue',
|
||||
['return' => 'id', 'name' => $project_identifier]);
|
||||
}
|
||||
return $shop;
|
||||
}
|
||||
|
||||
/**
|
||||
* Load Twingle Shop data
|
||||
*
|
||||
* @param array $shop_data
|
||||
* Array with shop data
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @throws ShopException
|
||||
*/
|
||||
public function load(array $shop_data): void {
|
||||
// Filter for allowed attributes
|
||||
filter_attributes($shop_data, self::ALLOWED_ATTRIBUTES);
|
||||
|
||||
// Convert string to int
|
||||
try {
|
||||
convert_str_to_int($shop_data, self::STR_TO_INT_CONVERSION);
|
||||
}
|
||||
catch (Exception $e) {
|
||||
throw new ShopException($e->getMessage(), ShopException::ERROR_CODE_ATTRIBUTE_WRONG_DATA_TYPE);
|
||||
}
|
||||
|
||||
// Validate data types
|
||||
try {
|
||||
validate_data_types($shop_data, self::ALLOWED_ATTRIBUTES);
|
||||
}
|
||||
catch (Exception $e) {
|
||||
throw new ShopException($e->getMessage(), ShopException::ERROR_CODE_ATTRIBUTE_WRONG_DATA_TYPE);
|
||||
}
|
||||
|
||||
// Set attributes
|
||||
foreach ($shop_data as $key => $value) {
|
||||
$this->$key = $value;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get attributes
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
function getAttributes(): array {
|
||||
return [
|
||||
'id' => $this->id,
|
||||
'project_identifier' => $this->project_identifier,
|
||||
'numerical_project_id' => $this->numerical_project_id,
|
||||
'name' => $this->name,
|
||||
'price_set_id' => $this->price_set_id,
|
||||
'financial_type_id' => $this->financial_type_id,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Add Twingle Shop
|
||||
*
|
||||
* @param string $mode
|
||||
* 'create' or 'edit'
|
||||
* @return array
|
||||
* @throws \Civi\Twingle\Shop\Exceptions\ShopException
|
||||
*/
|
||||
public function add($mode = 'create') {
|
||||
|
||||
// Try to lookup object in database
|
||||
try {
|
||||
$dao = TwingleShopDAO::executeQuery("SELECT * FROM civicrm_twingle_shop WHERE project_identifier = %1",
|
||||
[1 => [$this->project_identifier, 'String']]);
|
||||
if ($dao->fetch()) {
|
||||
$this->load($dao->toArray());
|
||||
}
|
||||
} catch (\Civi\Core\Exception\DBQueryException $e) {
|
||||
throw new ShopException(
|
||||
E::ts('Could not find TwingleShop in database: ' . $e->getMessage()),
|
||||
ShopException::ERROR_CODE_COULD_NOT_FIND_SHOP_IN_DB);
|
||||
}
|
||||
|
||||
// Register pre-hook
|
||||
$twingle_shop_values = $this->getAttributes();
|
||||
\CRM_Utils_Hook::pre($mode, 'TwingleShop', $this->id, $twingle_shop_values);
|
||||
$this->load($twingle_shop_values);
|
||||
|
||||
// Save object to database
|
||||
$result = $this->save();
|
||||
|
||||
// Register post-hook
|
||||
\CRM_Utils_Hook::post($mode, 'TwingleShop', $this->id, $instance);
|
||||
|
||||
return $result->toArray();
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete object by deleting the associated PriceSet and letting the foreign
|
||||
* key constraint do the rest.
|
||||
*
|
||||
* @throws \Civi\Twingle\Shop\Exceptions\ShopException*
|
||||
* @throws \Civi\Twingle\Shop\Exceptions\ProductException
|
||||
*/
|
||||
function deleteByConstraint() {
|
||||
// Register post-hook
|
||||
$twingle_shop_values = $this->getAttributes();
|
||||
\CRM_Utils_Hook::pre('delete', 'TwingleShop', $this->id, $twingle_shop_values);
|
||||
$this->load($twingle_shop_values);
|
||||
|
||||
// Delete associated products
|
||||
$this->deleteProducts();
|
||||
|
||||
// Try to get single PriceSet
|
||||
try {
|
||||
civicrm_api3('PriceSet', 'getsingle',
|
||||
['id' => $this->price_set_id]);
|
||||
}
|
||||
catch (\CRM_Core_Exception $e) {
|
||||
if ($e->getMessage() != 'Expected one PriceSet but found 0') {
|
||||
throw new ShopException(
|
||||
E::ts('Could not find associated PriceSet: ' . $e->getMessage()),
|
||||
ShopException::ERROR_CODE_PRICE_SET_NOT_FOUND);
|
||||
}
|
||||
else {
|
||||
// If no PriceSet is found, we can simply delete the TwingleShop
|
||||
return $this->delete();
|
||||
}
|
||||
}
|
||||
|
||||
// Deleting the associated PriceSet will also lead to the deletion of this
|
||||
// TwingleShop because of the foreign key constraint and cascading.
|
||||
try {
|
||||
$result = civicrm_api3('PriceSet', 'delete',
|
||||
['id' => $this->price_set_id]);
|
||||
} catch (\CRM_Core_Exception $e) {
|
||||
throw new ShopException(
|
||||
E::ts('Could not delete associated PriceSet: ' . $e->getMessage()),
|
||||
ShopException::ERROR_CODE_COULD_NOT_DELETE_PRICE_SET);
|
||||
}
|
||||
|
||||
// Register post-hook
|
||||
\CRM_Utils_Hook::post('delete', 'TwingleShop', $this->id, $instance);
|
||||
|
||||
// Free global arrays associated with this object
|
||||
$this->free();
|
||||
|
||||
return $result['is_error'] == 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch Twingle Shop products from Twingle
|
||||
*
|
||||
* @return array
|
||||
* array of CRM_Twingle_Shop_BAO_Product
|
||||
*
|
||||
* @throws \Civi\Twingle\Shop\Exceptions\ApiCallError;
|
||||
* @throws \Civi\Twingle\Shop\Exceptions\ProductException;
|
||||
* @throws \Civi\Core\Exception\DBQueryException
|
||||
* @throws \CRM_Core_Exception
|
||||
*/
|
||||
public function fetchProducts(): array {
|
||||
// Establish connection, if not already connected
|
||||
if (!$this->twingleApi->isConnected) {
|
||||
$this->twingleApi->connect();
|
||||
}
|
||||
|
||||
// Fetch products from Twingle API
|
||||
$products_from_twingle = $this->twingleApi->get(
|
||||
'project',
|
||||
$this->numerical_project_id,
|
||||
'products',
|
||||
);
|
||||
|
||||
// Fetch products from database
|
||||
if ($this->id) {
|
||||
$products_from_db = $this->getProducts();
|
||||
|
||||
$products_from_twingle = array_reduce($products_from_twingle, function($carry, $product) {
|
||||
$carry[$product['id']] = $product;
|
||||
return $carry;
|
||||
}, []);
|
||||
|
||||
foreach ($products_from_db as $product) {
|
||||
/* @var TwingleProductBAO $product */
|
||||
|
||||
// Find orphaned products which are in the database but not in Twingle
|
||||
$found = array_key_exists($product->external_id, $products_from_twingle);
|
||||
if (!$found) {
|
||||
$product->is_orphaned = TRUE;
|
||||
}
|
||||
else {
|
||||
// Complement with data from Twingle
|
||||
$product->complementWithDataFromTwingle($products_from_twingle[$product->external_id]);
|
||||
// Mark outdated products which have a newer version in Twingle
|
||||
$product->checkOutdated($products_from_twingle[$product->external_id]);
|
||||
}
|
||||
$this->products[] = $product;
|
||||
}
|
||||
}
|
||||
|
||||
// Create array with external_id as key
|
||||
$products = array_reduce($this->products ?? [], function($carry, $product) {
|
||||
$carry[$product->external_id] = $product;
|
||||
return $carry;
|
||||
}, []);
|
||||
|
||||
// Add new products from Twingle
|
||||
foreach ($products_from_twingle as $product_from_twingle) {
|
||||
$found = array_key_exists($product_from_twingle['id'], $products);
|
||||
if (!$found) {
|
||||
$product = new TwingleProduct();
|
||||
$product->load(TwingleProduct::renameTwingleAttrs($product_from_twingle));
|
||||
$product->twingle_shop_id = $this->id;
|
||||
$this->products[] = $product;
|
||||
}
|
||||
}
|
||||
return $this->products;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get associated products.
|
||||
*
|
||||
* @return array[Civi\Twingle\Shop\BAO\TwingleProduct]
|
||||
* @throws \Civi\Core\Exception\DBQueryException
|
||||
* @throws \Civi\Twingle\Shop\Exceptions\ProductException
|
||||
*/
|
||||
public function getProducts() {
|
||||
$products = [];
|
||||
|
||||
$result = TwingleProductBAO::executeQuery(
|
||||
"SELECT * FROM civicrm_twingle_product WHERE twingle_shop_id = %1",
|
||||
[1 => [$this->id, 'Integer']]
|
||||
);
|
||||
|
||||
while ($result->fetch()) {
|
||||
$product = new TwingleProductBAO();
|
||||
$product->load($result->toArray());
|
||||
$products[] = $product;
|
||||
}
|
||||
|
||||
return $products;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates Twingle Shop as a price set in CiviCRM.
|
||||
*
|
||||
* @param string $mode
|
||||
* 'create' or 'edit'
|
||||
* @throws \Civi\Twingle\Shop\Exceptions\ShopException
|
||||
*/
|
||||
public function createPriceSet($mode = 'create') {
|
||||
|
||||
// Define mode
|
||||
$mode = $this->price_set_id ? 'edit' : 'create';
|
||||
|
||||
// Check if PriceSet for this Shop already exists
|
||||
try {
|
||||
$price_set = civicrm_api3('PriceSet', 'get', [
|
||||
'name' => $this->project_identifier,
|
||||
]);
|
||||
if ($price_set['count'] > 0 && $mode == 'create') {
|
||||
throw new ShopException(
|
||||
E::ts('PriceSet for this Twingle Shop already exists.'),
|
||||
ShopException::ERROR_CODE_PRICE_SET_ALREADY_EXISTS,
|
||||
);
|
||||
}
|
||||
elseif ($price_set['count'] == 0 && $mode == 'edit') {
|
||||
throw new ShopException(
|
||||
E::ts('PriceSet for this Twingle Shop does not exist and cannot be edited.'),
|
||||
ShopException::ERROR_CODE_PRICE_SET_NOT_FOUND,
|
||||
);
|
||||
}
|
||||
} catch (\CRM_Core_Exception $e) {
|
||||
throw new ShopException(
|
||||
E::ts('Could not check if PriceSet for this TwingleShop already exists.'),
|
||||
ShopException::ERROR_CODE_PRICE_SET_NOT_FOUND,
|
||||
);
|
||||
}
|
||||
|
||||
// Create PriceSet
|
||||
$price_set_data = [
|
||||
'name' => $this->project_identifier,
|
||||
'title' => "$this->name ($this->project_identifier)",
|
||||
'is_active' => 1,
|
||||
'extends' => 2,
|
||||
'financial_type_id' => $this->financial_type_id,
|
||||
];
|
||||
// Set id if in edit mode
|
||||
if ($mode == 'edit') {
|
||||
$price_set_data['id'] = $this->price_set_id;
|
||||
}
|
||||
try {
|
||||
$price_set = civicrm_api4('PriceSet', 'create',
|
||||
['values' => $price_set_data])->first();
|
||||
$this->price_set_id = (int) $price_set['id'];
|
||||
} catch (\CRM_Core_Exception $e) {
|
||||
throw new ShopException(
|
||||
E::ts('Could not create PriceSet for this TwingleShop.'),
|
||||
ShopException::ERROR_CODE_COULD_NOT_CREATE_PRICE_SET,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves the numerical project ID and the name of this shop from Twingle.
|
||||
*
|
||||
* @throws \Civi\Twingle\Shop\Exceptions\ShopException
|
||||
* @throws \Civi\Twingle\Shop\Exceptions\ApiCallError
|
||||
*/
|
||||
private function fetchDataFromTwingle() {
|
||||
|
||||
// Establish connection, if not already connected
|
||||
if (!$this->twingleApi->isConnected) {
|
||||
$this->twingleApi->connect();
|
||||
}
|
||||
|
||||
// Get shops from Twingle if not cached
|
||||
$shops = \Civi::cache('long')->get('twingle_shops');
|
||||
if (empty($shops)) {
|
||||
$this::fetchShops($this->twingleApi);
|
||||
$shops = \Civi::cache('long')->get('twingle_shops');
|
||||
}
|
||||
|
||||
// Set Shop ID and name
|
||||
foreach ($shops as $shop) {
|
||||
if (isset($shop['identifier']) && $shop['identifier'] == $this->project_identifier) {
|
||||
$this->numerical_project_id = $shop['id'];
|
||||
$this->name = $shop['name'];
|
||||
}
|
||||
}
|
||||
|
||||
// Throw an Exception if this Twingle Project is not of type 'shop'
|
||||
if (!isset($this->numerical_project_id)) {
|
||||
throw new ShopException(
|
||||
E::ts('This Twingle Project is not a shop.'),
|
||||
ShopException::ERROR_CODE_NOT_A_SHOP,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves all Twingle projects of the type 'shop'.
|
||||
*
|
||||
* @throws \Civi\Twingle\Shop\Exceptions\ShopException
|
||||
*/
|
||||
static private function fetchShops(ApiCall $api): void {
|
||||
$organisationId = $api->organisationId;
|
||||
try {
|
||||
$projects = $api->get(
|
||||
'project',
|
||||
NULL,
|
||||
'by-organisation',
|
||||
$organisationId,
|
||||
);
|
||||
$shops = array_filter(
|
||||
$projects,
|
||||
function($project) {
|
||||
return isset($project['type']) && $project['type'] == 'shop';
|
||||
}
|
||||
);
|
||||
\Civi::cache('long')->set('twingle_shops', $shops);
|
||||
}
|
||||
catch (Exception $e) {
|
||||
throw new ShopException(
|
||||
E::ts('Could not retrieve Twingle projects from API.
|
||||
Please check your API credentials.'),
|
||||
ShopException::ERROR_CODE_COULD_NOT_GET_PROJECTS,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes all associated products.
|
||||
*
|
||||
* @return void
|
||||
* @throws \Civi\Twingle\Shop\Exceptions\ProductException
|
||||
*/
|
||||
public function deleteProducts() {
|
||||
try {
|
||||
$products = $this->getProducts();
|
||||
} catch (\Civi\Core\Exception\DBQueryException $e) {
|
||||
throw new ProductException(
|
||||
E::ts('Could not retrieve associated products: ' . $e->getMessage()),
|
||||
ProductException::ERROR_CODE_COULD_NOT_GET_PRODUCTS
|
||||
);
|
||||
}
|
||||
try {
|
||||
foreach ($products as $product) {
|
||||
$product->delete();
|
||||
}
|
||||
}
|
||||
catch (ProductException $e) {
|
||||
throw new ProductException(
|
||||
E::ts('Could not delete associated products: ' . $e->getMessage()),
|
||||
ProductException::ERROR_CODE_COULD_NOT_DELETE_PRICE_SET
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
327
Civi/Twingle/Shop/DAO/TwingleProduct.php
Normal file
327
Civi/Twingle/Shop/DAO/TwingleProduct.php
Normal file
|
|
@ -0,0 +1,327 @@
|
|||
<?php
|
||||
|
||||
namespace Civi\Twingle\Shop\DAO;
|
||||
|
||||
/**
|
||||
* @package CRM
|
||||
* @copyright CiviCRM LLC https://civicrm.org/licensing
|
||||
*
|
||||
* Generated from de.systopia.twingle/xml/schema/CRM/Twingle/TwingleProduct.xml
|
||||
* DO NOT EDIT. Generated by CRM_Core_CodeGen
|
||||
* (GenCodeChecksum:b8ced533ba6f4249619ffe5353965a4f)
|
||||
*/
|
||||
use CRM_Twingle_ExtensionUtil as E;
|
||||
|
||||
/**
|
||||
* Database access object for the TwingleProduct entity.
|
||||
*/
|
||||
class TwingleProduct extends \CRM_Core_DAO {
|
||||
const EXT = E::LONG_NAME;
|
||||
const TABLE_ADDED = '';
|
||||
|
||||
/**
|
||||
* Static instance to hold the table name.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
public static $_tableName = 'civicrm_twingle_product';
|
||||
|
||||
/**
|
||||
* Should CiviCRM log any modifications to this table in the civicrm_log table.
|
||||
*
|
||||
* @var bool
|
||||
*/
|
||||
public static $_log = FALSE;
|
||||
|
||||
/**
|
||||
* Unique TwingleProduct ID
|
||||
*
|
||||
* @var int|string|null
|
||||
* (SQL type: int unsigned)
|
||||
* Note that values will be retrieved from the database as a string.
|
||||
*/
|
||||
public $id;
|
||||
|
||||
/**
|
||||
* The ID of this product in the Twingle database
|
||||
*
|
||||
* @var int|string
|
||||
* (SQL type: int unsigned)
|
||||
* Note that values will be retrieved from the database as a string.
|
||||
*/
|
||||
public $external_id;
|
||||
|
||||
/**
|
||||
* FK to Price Field
|
||||
*
|
||||
* @var int|string
|
||||
* (SQL type: int unsigned)
|
||||
* Note that values will be retrieved from the database as a string.
|
||||
*/
|
||||
public $price_field_id;
|
||||
|
||||
/**
|
||||
* FK to Twingle Shop
|
||||
*
|
||||
* @var int|string|null
|
||||
* (SQL type: int unsigned)
|
||||
* Note that values will be retrieved from the database as a string.
|
||||
*/
|
||||
public $twingle_shop_id;
|
||||
|
||||
/**
|
||||
* Timestamp of when the product was created in the database
|
||||
*
|
||||
* @var string
|
||||
* (SQL type: datetime)
|
||||
* Note that values will be retrieved from the database as a string.
|
||||
*/
|
||||
public $created_at;
|
||||
|
||||
/**
|
||||
* Timestamp of when the product was last updated in the database
|
||||
*
|
||||
* @var string
|
||||
* (SQL type: datetime)
|
||||
* Note that values will be retrieved from the database as a string.
|
||||
*/
|
||||
public $updated_at;
|
||||
|
||||
/**
|
||||
* Class constructor.
|
||||
*/
|
||||
public function __construct() {
|
||||
$this->__table = 'civicrm_twingle_product';
|
||||
parent::__construct();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns localized title of this entity.
|
||||
*
|
||||
* @param bool $plural
|
||||
* Whether to return the plural version of the title.
|
||||
*/
|
||||
public static function getEntityTitle($plural = FALSE) {
|
||||
return $plural ? E::ts('Twingle Products') : E::ts('Twingle Product');
|
||||
}
|
||||
|
||||
/**
|
||||
* 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(), 'price_field_id', 'civicrm_contact', 'id');
|
||||
\Civi::$statics[__CLASS__]['links'][] = new \CRM_Core_Reference_Basic(self::getTableName(), 'twingle_shop_id', 'civicrm_twingle_shop', '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' => E::ts('ID'),
|
||||
'description' => E::ts('Unique TwingleProduct ID'),
|
||||
'required' => TRUE,
|
||||
'usage' => [
|
||||
'import' => FALSE,
|
||||
'export' => FALSE,
|
||||
'duplicate_matching' => FALSE,
|
||||
'token' => FALSE,
|
||||
],
|
||||
'where' => 'civicrm_twingle_product.id',
|
||||
'table_name' => 'civicrm_twingle_product',
|
||||
'entity' => 'TwingleProduct',
|
||||
'bao' => 'Civi\Twingle\Shop\DAO\TwingleProduct',
|
||||
'localizable' => 0,
|
||||
'html' => [
|
||||
'type' => 'Number',
|
||||
],
|
||||
'readonly' => TRUE,
|
||||
'add' => NULL,
|
||||
],
|
||||
'external_id' => [
|
||||
'name' => 'external_id',
|
||||
'type' => \CRM_Utils_Type::T_INT,
|
||||
'title' => E::ts('External ID'),
|
||||
'description' => E::ts('The ID of this product in the Twingle database'),
|
||||
'required' => TRUE,
|
||||
'usage' => [
|
||||
'import' => FALSE,
|
||||
'export' => FALSE,
|
||||
'duplicate_matching' => FALSE,
|
||||
'token' => FALSE,
|
||||
],
|
||||
'where' => 'civicrm_twingle_product.external_id',
|
||||
'table_name' => 'civicrm_twingle_product',
|
||||
'entity' => 'TwingleProduct',
|
||||
'bao' => 'Civi\Twingle\Shop\DAO\TwingleProduct',
|
||||
'localizable' => 0,
|
||||
'html' => [
|
||||
'type' => 'Number',
|
||||
],
|
||||
'add' => NULL,
|
||||
],
|
||||
'price_field_id' => [
|
||||
'name' => 'price_field_id',
|
||||
'type' => \CRM_Utils_Type::T_INT,
|
||||
'title' => E::ts('Price Field ID'),
|
||||
'description' => E::ts('FK to Price Field'),
|
||||
'required' => TRUE,
|
||||
'usage' => [
|
||||
'import' => FALSE,
|
||||
'export' => FALSE,
|
||||
'duplicate_matching' => FALSE,
|
||||
'token' => FALSE,
|
||||
],
|
||||
'where' => 'civicrm_twingle_product.price_field_id',
|
||||
'table_name' => 'civicrm_twingle_product',
|
||||
'entity' => 'TwingleProduct',
|
||||
'bao' => 'Civi\Twingle\Shop\DAO\TwingleProduct',
|
||||
'localizable' => 0,
|
||||
'FKClassName' => 'CRM_Contact_DAO_Contact',
|
||||
'add' => NULL,
|
||||
],
|
||||
'twingle_shop_id' => [
|
||||
'name' => 'twingle_shop_id',
|
||||
'type' => \CRM_Utils_Type::T_INT,
|
||||
'title' => E::ts('Twingle Shop ID'),
|
||||
'description' => E::ts('FK to Twingle Shop'),
|
||||
'usage' => [
|
||||
'import' => FALSE,
|
||||
'export' => FALSE,
|
||||
'duplicate_matching' => FALSE,
|
||||
'token' => FALSE,
|
||||
],
|
||||
'where' => 'civicrm_twingle_product.twingle_shop_id',
|
||||
'table_name' => 'civicrm_twingle_product',
|
||||
'entity' => 'TwingleProduct',
|
||||
'bao' => 'Civi\Twingle\Shop\DAO\TwingleProduct',
|
||||
'localizable' => 0,
|
||||
'FKClassName' => 'Civi\Twingle\Shop\DAO\TwingleShop',
|
||||
'add' => NULL,
|
||||
],
|
||||
'created_at' => [
|
||||
'name' => 'created_at',
|
||||
'type' => \CRM_Utils_Type::T_DATE + \CRM_Utils_Type::T_TIME,
|
||||
'title' => E::ts('Created At'),
|
||||
'description' => E::ts('Timestamp of when the product was created in the database'),
|
||||
'required' => TRUE,
|
||||
'usage' => [
|
||||
'import' => FALSE,
|
||||
'export' => FALSE,
|
||||
'duplicate_matching' => FALSE,
|
||||
'token' => FALSE,
|
||||
],
|
||||
'where' => 'civicrm_twingle_product.created_at',
|
||||
'table_name' => 'civicrm_twingle_product',
|
||||
'entity' => 'TwingleProduct',
|
||||
'bao' => 'Civi\Twingle\Shop\DAO\TwingleProduct',
|
||||
'localizable' => 0,
|
||||
'add' => NULL,
|
||||
],
|
||||
'updated_at' => [
|
||||
'name' => 'updated_at',
|
||||
'type' => \CRM_Utils_Type::T_DATE + \CRM_Utils_Type::T_TIME,
|
||||
'title' => E::ts('Updated At'),
|
||||
'description' => E::ts('Timestamp of when the product was last updated in the database'),
|
||||
'required' => TRUE,
|
||||
'usage' => [
|
||||
'import' => FALSE,
|
||||
'export' => FALSE,
|
||||
'duplicate_matching' => FALSE,
|
||||
'token' => FALSE,
|
||||
],
|
||||
'where' => 'civicrm_twingle_product.updated_at',
|
||||
'table_name' => 'civicrm_twingle_product',
|
||||
'entity' => 'TwingleProduct',
|
||||
'bao' => 'Civi\Twingle\Shop\DAO\TwingleProduct',
|
||||
'localizable' => 0,
|
||||
'add' => NULL,
|
||||
],
|
||||
];
|
||||
\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__, 'twingle_product', $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__, 'twingle_product', $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;
|
||||
}
|
||||
|
||||
}
|
||||
307
Civi/Twingle/Shop/DAO/TwingleShop.php
Normal file
307
Civi/Twingle/Shop/DAO/TwingleShop.php
Normal file
|
|
@ -0,0 +1,307 @@
|
|||
<?php
|
||||
|
||||
namespace Civi\Twingle\Shop\DAO;
|
||||
|
||||
/**
|
||||
* @package CRM
|
||||
* @copyright CiviCRM LLC https://civicrm.org/licensing
|
||||
*
|
||||
* Generated from de.systopia.twingle/xml/schema/CRM/Twingle/TwingleShop.xml
|
||||
* DO NOT EDIT. Generated by CRM_Core_CodeGen
|
||||
* (GenCodeChecksum:95a46935c30b3da52e4df2bec871b962)
|
||||
*/
|
||||
use CRM_Twingle_ExtensionUtil as E;
|
||||
|
||||
/**
|
||||
* Database access object for the TwingleShop entity.
|
||||
*/
|
||||
class TwingleShop extends \CRM_Core_DAO {
|
||||
const EXT = E::LONG_NAME;
|
||||
const TABLE_ADDED = '';
|
||||
|
||||
/**
|
||||
* Static instance to hold the table name.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
public static $_tableName = 'civicrm_twingle_shop';
|
||||
|
||||
/**
|
||||
* Should CiviCRM log any modifications to this table in the civicrm_log table.
|
||||
*
|
||||
* @var bool
|
||||
*/
|
||||
public static $_log = FALSE;
|
||||
|
||||
/**
|
||||
* Unique TwingleShop ID
|
||||
*
|
||||
* @var int|string|null
|
||||
* (SQL type: int unsigned)
|
||||
* Note that values will be retrieved from the database as a string.
|
||||
*/
|
||||
public $id;
|
||||
|
||||
/**
|
||||
* Twingle Project Identifier
|
||||
*
|
||||
* @var string
|
||||
* (SQL type: varchar(32))
|
||||
* Note that values will be retrieved from the database as a string.
|
||||
*/
|
||||
public $project_identifier;
|
||||
|
||||
/**
|
||||
* Numerical Twingle Project Identifier
|
||||
*
|
||||
* @var int|string
|
||||
* (SQL type: int unsigned)
|
||||
* Note that values will be retrieved from the database as a string.
|
||||
*/
|
||||
public $numerical_project_id;
|
||||
|
||||
/**
|
||||
* FK to Price Set
|
||||
*
|
||||
* @var int|string|null
|
||||
* (SQL type: int unsigned)
|
||||
* Note that values will be retrieved from the database as a string.
|
||||
*/
|
||||
public $price_set_id;
|
||||
|
||||
/**
|
||||
* name of the shop
|
||||
*
|
||||
* @var string
|
||||
* (SQL type: varchar(64))
|
||||
* Note that values will be retrieved from the database as a string.
|
||||
*/
|
||||
public $name;
|
||||
|
||||
/**
|
||||
* Class constructor.
|
||||
*/
|
||||
public function __construct() {
|
||||
$this->__table = 'civicrm_twingle_shop';
|
||||
parent::__construct();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns localized title of this entity.
|
||||
*
|
||||
* @param bool $plural
|
||||
* Whether to return the plural version of the title.
|
||||
*/
|
||||
public static function getEntityTitle($plural = FALSE) {
|
||||
return $plural ? E::ts('Twingle Shops') : E::ts('Twingle Shop');
|
||||
}
|
||||
|
||||
/**
|
||||
* 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(), 'price_set_id', 'civicrm_price_set', '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' => E::ts('ID'),
|
||||
'description' => E::ts('Unique TwingleShop ID'),
|
||||
'required' => TRUE,
|
||||
'usage' => [
|
||||
'import' => FALSE,
|
||||
'export' => FALSE,
|
||||
'duplicate_matching' => FALSE,
|
||||
'token' => FALSE,
|
||||
],
|
||||
'where' => 'civicrm_twingle_shop.id',
|
||||
'table_name' => 'civicrm_twingle_shop',
|
||||
'entity' => 'TwingleShop',
|
||||
'bao' => 'Civi\Twingle\Shop\DAO\TwingleShop',
|
||||
'localizable' => 0,
|
||||
'html' => [
|
||||
'type' => 'Number',
|
||||
],
|
||||
'readonly' => TRUE,
|
||||
'add' => NULL,
|
||||
],
|
||||
'project_identifier' => [
|
||||
'name' => 'project_identifier',
|
||||
'type' => \CRM_Utils_Type::T_STRING,
|
||||
'title' => E::ts('Project Identifier'),
|
||||
'description' => E::ts('Twingle Project Identifier'),
|
||||
'required' => TRUE,
|
||||
'maxlength' => 32,
|
||||
'size' => \CRM_Utils_Type::MEDIUM,
|
||||
'usage' => [
|
||||
'import' => FALSE,
|
||||
'export' => FALSE,
|
||||
'duplicate_matching' => FALSE,
|
||||
'token' => FALSE,
|
||||
],
|
||||
'where' => 'civicrm_twingle_shop.project_identifier',
|
||||
'table_name' => 'civicrm_twingle_shop',
|
||||
'entity' => 'TwingleShop',
|
||||
'bao' => 'Civi\Twingle\Shop\DAO\TwingleShop',
|
||||
'localizable' => 0,
|
||||
'html' => [
|
||||
'type' => 'Text',
|
||||
],
|
||||
'add' => NULL,
|
||||
],
|
||||
'numerical_project_id' => [
|
||||
'name' => 'numerical_project_id',
|
||||
'type' => \CRM_Utils_Type::T_INT,
|
||||
'title' => E::ts('Numerical Project ID'),
|
||||
'description' => E::ts('Numerical Twingle Project Identifier'),
|
||||
'required' => TRUE,
|
||||
'usage' => [
|
||||
'import' => FALSE,
|
||||
'export' => FALSE,
|
||||
'duplicate_matching' => FALSE,
|
||||
'token' => FALSE,
|
||||
],
|
||||
'where' => 'civicrm_twingle_shop.numerical_project_id',
|
||||
'table_name' => 'civicrm_twingle_shop',
|
||||
'entity' => 'TwingleShop',
|
||||
'bao' => 'Civi\Twingle\Shop\DAO\TwingleShop',
|
||||
'localizable' => 0,
|
||||
'html' => [
|
||||
'type' => 'Number',
|
||||
],
|
||||
'add' => NULL,
|
||||
],
|
||||
'price_set_id' => [
|
||||
'name' => 'price_set_id',
|
||||
'type' => \CRM_Utils_Type::T_INT,
|
||||
'title' => E::ts('Price Set ID'),
|
||||
'description' => E::ts('FK to Price Set'),
|
||||
'usage' => [
|
||||
'import' => FALSE,
|
||||
'export' => FALSE,
|
||||
'duplicate_matching' => FALSE,
|
||||
'token' => FALSE,
|
||||
],
|
||||
'where' => 'civicrm_twingle_shop.price_set_id',
|
||||
'table_name' => 'civicrm_twingle_shop',
|
||||
'entity' => 'TwingleShop',
|
||||
'bao' => 'Civi\Twingle\Shop\DAO\TwingleShop',
|
||||
'localizable' => 0,
|
||||
'FKClassName' => 'CRM_Price_DAO_PriceSet',
|
||||
'add' => NULL,
|
||||
],
|
||||
'name' => [
|
||||
'name' => 'name',
|
||||
'type' => \CRM_Utils_Type::T_STRING,
|
||||
'title' => E::ts('Name'),
|
||||
'description' => E::ts('name of the shop'),
|
||||
'required' => TRUE,
|
||||
'maxlength' => 64,
|
||||
'size' => \CRM_Utils_Type::BIG,
|
||||
'usage' => [
|
||||
'import' => FALSE,
|
||||
'export' => FALSE,
|
||||
'duplicate_matching' => FALSE,
|
||||
'token' => FALSE,
|
||||
],
|
||||
'where' => 'civicrm_twingle_shop.name',
|
||||
'table_name' => 'civicrm_twingle_shop',
|
||||
'entity' => 'TwingleShop',
|
||||
'bao' => 'CRM_Twingle_Shop_DAO_TwingleShop',
|
||||
'localizable' => 0,
|
||||
'html' => [
|
||||
'type' => 'Text',
|
||||
],
|
||||
'add' => NULL,
|
||||
],
|
||||
];
|
||||
\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__, 'twingle_shop', $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__, 'twingle_shop', $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;
|
||||
}
|
||||
|
||||
}
|
||||
19
Civi/Twingle/Shop/Exceptions/ApiCallError.php
Normal file
19
Civi/Twingle/Shop/Exceptions/ApiCallError.php
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
<?php
|
||||
|
||||
namespace Civi\Twingle\Shop\Exceptions;
|
||||
|
||||
use Civi\Twingle\Exceptions\BaseException as BaseException;
|
||||
|
||||
/**
|
||||
* A simple custom exception that indicates a problem within the
|
||||
* Civi\Twingle\Shop\ApiCall class
|
||||
*/
|
||||
class ApiCallError extends BaseException {
|
||||
public const ERROR_CODE_API_TOKEN_MISSING = "api_token_missing";
|
||||
public const ERROR_CODE_CONNECTION_FAILED = "connection_failed";
|
||||
public const ERROR_CODE_NOT_CONNECTED = "not_connected";
|
||||
public const ERROR_CODE_GET_REQUEST_FAILED = "get_request_failed";
|
||||
public const ERROR_CODE_404 = "404";
|
||||
public const ERROR_CODE_500 = "500";
|
||||
|
||||
}
|
||||
14
Civi/Twingle/Shop/Exceptions/LineItemException.php
Normal file
14
Civi/Twingle/Shop/Exceptions/LineItemException.php
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
<?php
|
||||
|
||||
namespace Civi\Twingle\Shop\Exceptions;
|
||||
|
||||
use Civi\Twingle\Exceptions\BaseException as BaseException;
|
||||
|
||||
/**
|
||||
* A simple custom exception that indicates a problem within the Line Items
|
||||
*/
|
||||
class LineItemException extends BaseException {
|
||||
|
||||
public const ERROR_CODE_CONTRIBUTION_NOT_FOUND = "contribution_not_found";
|
||||
|
||||
}
|
||||
26
Civi/Twingle/Shop/Exceptions/ProductException.php
Normal file
26
Civi/Twingle/Shop/Exceptions/ProductException.php
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
<?php
|
||||
|
||||
namespace Civi\Twingle\Shop\Exceptions;
|
||||
|
||||
use Civi\Twingle\Exceptions\BaseException as BaseException;
|
||||
|
||||
/**
|
||||
* A simple custom exception that indicates a problem within the
|
||||
* CRM_Twingle_Product class
|
||||
*/
|
||||
|
||||
class ProductException extends BaseException {
|
||||
public const ERROR_CODE_ATTRIBUTE_WRONG_DATA_TYPE = 'attribute_wrong_data_type';
|
||||
public const ERROR_CODE_PRICE_FIELD_ALREADY_EXISTS = 'price_field_already_exists';
|
||||
public const ERROR_CODE_PRICE_FIELD_VALUE_NOT_FOUND = 'price_field_value_not_found';
|
||||
public const ERROR_CODE_PRICE_FIELD_NOT_FOUND = 'price_field_not_found';
|
||||
public const ERROR_CODE_PRICE_SET_NOT_FOUND = 'price_set_not_found';
|
||||
public const ERROR_CODE_COULD_NOT_CREATE_PRICE_FIELD = 'price_field_creation_failed';
|
||||
public const ERROR_CODE_COULD_NOT_CREATE_PRICE_FIELD_VALUE = 'price_field_value_creation_failed';
|
||||
public const ERROR_CODE_COULD_NOT_DELETE_PRICE_FIELD = 'price_field_deletion_failed';
|
||||
public const ERROR_CODE_COULD_NOT_DELETE_PRICE_FIELD_VALUE = 'price_field_value_deletion_failed';
|
||||
public const ERROR_CODE_PRICE_FIELD_STILL_EXISTS = 'price_field_still_exists';
|
||||
public const ERROR_CODE_COULD_NOT_CREATE_PRODUCT = 'product_creation_failed';
|
||||
public const ERROR_CODE_COULD_NOT_GET_PRODUCTS = 'product_retrieval_failed';
|
||||
public const ERROR_CODE_COULD_NOT_DELETE_PRICE_SET = 'price_set_deletion_failed';
|
||||
}
|
||||
22
Civi/Twingle/Shop/Exceptions/ShopException.php
Normal file
22
Civi/Twingle/Shop/Exceptions/ShopException.php
Normal file
|
|
@ -0,0 +1,22 @@
|
|||
<?php
|
||||
|
||||
namespace Civi\Twingle\Shop\Exceptions;
|
||||
|
||||
use Civi\Twingle\Exceptions\BaseException as BaseException;
|
||||
|
||||
/**
|
||||
* A simple custom exception that indicates a problem within the
|
||||
* CRM_Twingle_Shop class
|
||||
*/
|
||||
class ShopException extends BaseException {
|
||||
|
||||
public const ERROR_CODE_NOT_A_SHOP = "not_a_shop";
|
||||
public const ERROR_CODE_COULD_NOT_GET_PROJECTS = "could_not_get_projects";
|
||||
public const ERROR_CODE_COULD_NOT_FIND_SHOP_IN_DB = "could_not_find_shop_in_db";
|
||||
public const ERROR_CODE_PRICE_SET_ALREADY_EXISTS = "price_set_already_exists";
|
||||
public const ERROR_CODE_COULD_NOT_CREATE_PRICE_SET = "price_set_creation_failed";
|
||||
public const ERROR_CODE_PRICE_SET_NOT_FOUND = "price_set_not_found";
|
||||
public const ERROR_CODE_COULD_NOT_DELETE_PRICE_SET = "price_set_deletion_failed";
|
||||
public const ERROR_CODE_ATTRIBUTE_WRONG_DATA_TYPE = "attribute_wrong_data_type";
|
||||
|
||||
}
|
||||
155
Civi/Twingle/Shop/Utils/TwingleShopUtils.php
Normal file
155
Civi/Twingle/Shop/Utils/TwingleShopUtils.php
Normal file
|
|
@ -0,0 +1,155 @@
|
|||
<?php
|
||||
|
||||
namespace Civi\Twingle\Shop\Utils;
|
||||
|
||||
/**
|
||||
* Filter for allowed attributes.
|
||||
*
|
||||
* @param array $data
|
||||
* Data to filter.
|
||||
* @param array $allowed_attributes
|
||||
* Allowed attributes.
|
||||
* @param array $can_be_zero
|
||||
* Attributes that can be zero.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
function filter_attributes(array &$data, array $allowed_attributes, array $can_be_zero = Null): void {
|
||||
$can_be_zero = $can_be_zero ?? [];
|
||||
|
||||
// Remove empty values if not of type int
|
||||
$data = array_filter(
|
||||
$data,
|
||||
function($value, $key) use ($can_be_zero) {
|
||||
return !empty($value) || in_array($key, $can_be_zero);
|
||||
},
|
||||
ARRAY_FILTER_USE_BOTH
|
||||
);
|
||||
|
||||
// Filter for allowed attributes
|
||||
$data = array_intersect_key(
|
||||
$data,
|
||||
$allowed_attributes
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert string values to int.
|
||||
*
|
||||
* @param array $data
|
||||
* @param array $str_to_int_conversion
|
||||
*
|
||||
* @return void
|
||||
* @throws \Exception
|
||||
*/
|
||||
function convert_str_to_int(array &$data, array $str_to_int_conversion): void {
|
||||
// Convert string to int
|
||||
foreach ($str_to_int_conversion as $attribute) {
|
||||
if (isset($data[$attribute])) {
|
||||
try {
|
||||
$data[$attribute] = (int) $data[$attribute];
|
||||
} catch (\Exception $e) {
|
||||
throw new \Exception(
|
||||
"Could not convert attribute '$attribute' to int."
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert int values to bool.
|
||||
*
|
||||
* @param array $data
|
||||
* @param array $int_to_bool_conversion
|
||||
*
|
||||
* @return void
|
||||
* @throws \Exception
|
||||
*/
|
||||
function convert_int_to_bool(array &$data, array $int_to_bool_conversion): void {
|
||||
// Convert int to bool
|
||||
foreach ($int_to_bool_conversion as $attribute) {
|
||||
if (isset($data[$attribute])) {
|
||||
try {
|
||||
$data[$attribute] = (bool) $data[$attribute];
|
||||
}
|
||||
catch (\Exception $e) {
|
||||
throw new \Exception(
|
||||
"Could not convert attribute '$attribute' to bool."
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert string values to date.
|
||||
*
|
||||
* @param array $data
|
||||
* @param array $str_to_date_conversion
|
||||
*
|
||||
* @return void
|
||||
* @throws \Exception
|
||||
*/
|
||||
function convert_str_to_date(array &$data, array $str_to_date_conversion): void {
|
||||
// Convert string to date
|
||||
foreach ($str_to_date_conversion as $attribute) {
|
||||
if (isset($data[$attribute]) && is_string($data[$attribute])) {
|
||||
try {
|
||||
$data[$attribute] = strtotime($data[$attribute]);
|
||||
}
|
||||
catch (\Exception $e) {
|
||||
throw new \Exception(
|
||||
"Could not convert attribute '$attribute' to date."
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert null to int
|
||||
*
|
||||
* @param array $data
|
||||
* @param array $null_to_int_conversion
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
function convert_null_to_int(array &$data, array $null_to_int_conversion): void {
|
||||
// Convert null to int
|
||||
foreach ($null_to_int_conversion as $attribute) {
|
||||
if (array_key_exists($attribute, $data) && $data[$attribute] === NULL) {
|
||||
$data[$attribute] = 0;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Validate data types. Throws an exception if data type is not valid.
|
||||
*
|
||||
* @param array $data
|
||||
* @param array $allowed_attributes
|
||||
*
|
||||
* @return void
|
||||
* @throws \Exception
|
||||
*/
|
||||
function validate_data_types(array &$data, array $allowed_attributes): void {
|
||||
foreach ($data as $key => $value) {
|
||||
// Skip empty values
|
||||
if (empty($value)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// Find expected data type
|
||||
$expected_data_type = strtolower(\CRM_Utils_Type::typeToString($allowed_attributes[$key])); // It could be so easy...
|
||||
|
||||
// Validate data type
|
||||
if (!\CRM_Utils_Type::validatePhpType($value, $expected_data_type)) {
|
||||
$given_type = gettype($value);
|
||||
throw new \Exception(
|
||||
"Data type of attribute '$key' is $given_type, but $expected_data_type was expected."
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -254,7 +254,14 @@ function _civicrm_api3_twingle_donation_Submit_spec(&$params) {
|
|||
'title' => E::ts('Custom fields'),
|
||||
'type' => CRM_Utils_Type::T_STRING,
|
||||
'api.required' => 0,
|
||||
'description' => E::ts('Additional information for either the contact or the (recurring) contribution.'),
|
||||
'description' => E::ts('Additional information for either the contact or the (recurring) contribution.'),
|
||||
);
|
||||
$params['products'] = [
|
||||
'name' => 'products',
|
||||
'title' => E::ts('Products'),
|
||||
'type' => CRM_Utils_Type::T_STRING,
|
||||
'api.required' => 0,
|
||||
'description' => E::ts('Products ordered via TwingleShop'),
|
||||
];
|
||||
$params['remarks'] = [
|
||||
'name' => 'remarks',
|
||||
|
|
@ -634,6 +641,11 @@ function civicrm_api3_twingle_donation_Submit($params) {
|
|||
'total_amount' => $params['amount'] / 100,
|
||||
];
|
||||
|
||||
// If the submission contains products, do not auto-create a line item
|
||||
if (!empty($params['products']) && $profile->isShopEnabled()) {
|
||||
$contribution_data['skipLineItem'] = 1;
|
||||
}
|
||||
|
||||
// Add custom field values.
|
||||
if (isset($custom_fields['Contribution'])) {
|
||||
$contribution_data += $custom_fields['Contribution'];
|
||||
|
|
@ -727,6 +739,27 @@ function civicrm_api3_twingle_donation_Submit($params) {
|
|||
$mandate = civicrm_api3('SepaMandate', 'createfull', $mandate_data);
|
||||
|
||||
$result_values['sepa_mandate'] = reset($mandate['values']);
|
||||
|
||||
// Add contribution data to result_values for later use
|
||||
$contribution_id = $result_values['sepa_mandate']['entity_id'];
|
||||
if ($contribution_id) {
|
||||
$contribution = civicrm_api3(
|
||||
'Contribution',
|
||||
'getsingle',
|
||||
['id' => $contribution_id]
|
||||
);
|
||||
$result_values['contribution'] = $contribution;
|
||||
} else {
|
||||
$mandate_id = $result_values['sepa_mandate']['id'];
|
||||
$message = E::LONG_NAME . ": could not find contribution for sepa mandate $mandate_id";
|
||||
throw new CiviCRM_API3_Exception($message, 'api_error');
|
||||
}
|
||||
|
||||
// Add products as line items to the contribution
|
||||
if (!empty($params['products']) && $profile->isShopEnabled()) {
|
||||
$line_items = CRM_Twingle_Submission::createLineItems($result_values, $params, $profile);
|
||||
$result_values['contribution']['line_items'] = $line_items;
|
||||
}
|
||||
}
|
||||
else {
|
||||
// Set financial type depending on donation rhythm. This applies for
|
||||
|
|
@ -827,6 +860,12 @@ function civicrm_api3_twingle_donation_Submit($params) {
|
|||
}
|
||||
|
||||
$result_values['contribution'] = $contribution;
|
||||
|
||||
// Add products as line items to the contribution
|
||||
if (!empty($params['products']) && $profile->isShopEnabled()) {
|
||||
$line_items = CRM_Twingle_Submission::createLineItems($result_values, $params, $profile);
|
||||
$result_values['contribution']['line_items'] = $line_items;
|
||||
}
|
||||
}
|
||||
|
||||
// MEMBERSHIP CREATION
|
||||
|
|
|
|||
138
api/v3/TwingleProduct/Create.php
Normal file
138
api/v3/TwingleProduct/Create.php
Normal file
|
|
@ -0,0 +1,138 @@
|
|||
<?php
|
||||
|
||||
use Civi\Twingle\Shop\Exceptions\ProductException;
|
||||
use CRM_Twingle_ExtensionUtil as E;
|
||||
use Civi\Twingle\Shop\BAO\TwingleProduct;
|
||||
|
||||
/**
|
||||
* TwingleProduct.Create API specification (optional)
|
||||
* This is used for documentation and validation.
|
||||
*
|
||||
* @param array $spec description of fields supported by this API call
|
||||
*
|
||||
* @see https://docs.civicrm.org/dev/en/latest/framework/api-architecture/
|
||||
*/
|
||||
function _civicrm_api3_twingle_product_Create_spec(&$spec) {
|
||||
$spec['id'] = [
|
||||
'name' => 'id',
|
||||
'title' => E::ts('TwingleProduct ID'),
|
||||
'type' => CRM_Utils_Type::T_INT,
|
||||
'api.required' => 0,
|
||||
'description' => E::ts('The TwingleProduct ID in the database'),
|
||||
];
|
||||
$spec['external_id'] = [
|
||||
'name' => 'external_id',
|
||||
'title' => E::ts('Twingle ID'),
|
||||
'type' => CRM_Utils_Type::T_INT,
|
||||
'api.required' => 1,
|
||||
'description' => E::ts('External product ID in Twingle database'),
|
||||
];
|
||||
$spec['project_id'] = [
|
||||
'name' => 'project_id',
|
||||
'title' => E::ts('Twingle Shop ID'),
|
||||
'type' => CRM_Utils_Type::T_INT,
|
||||
'api.required' => 1,
|
||||
'description' => E::ts('ID of the corresponding Twingle Shop'),
|
||||
];
|
||||
$spec['name'] = [
|
||||
'name' => 'name',
|
||||
'title' => E::ts('Product Name'),
|
||||
'type' => CRM_Utils_Type::T_STRING,
|
||||
'api.required' => 1,
|
||||
'description' => E::ts('Name of the product'),
|
||||
];
|
||||
$spec['is_active'] = [
|
||||
'name' => 'is_active',
|
||||
'title' => E::ts('Is active?'),
|
||||
'type' => CRM_Utils_Type::T_BOOLEAN,
|
||||
'api.required' => 0,
|
||||
'api.default' => 1,
|
||||
'description' => E::ts('Is the product active?'),
|
||||
];
|
||||
$spec['description'] = [
|
||||
'name' => 'description',
|
||||
'title' => E::ts('Product Description'),
|
||||
'type' => CRM_Utils_Type::T_TEXT,
|
||||
'api.required' => 0,
|
||||
'description' => E::ts('Short description of the product'),
|
||||
];
|
||||
$spec['price'] = [
|
||||
'name' => 'price',
|
||||
'title' => E::ts('Product Price'),
|
||||
'type' => CRM_Utils_Type::T_FLOAT,
|
||||
'api.required' => 0,
|
||||
'description' => E::ts('Price of the product'),
|
||||
];
|
||||
$spec['sort'] = [
|
||||
'name' => 'sort',
|
||||
'title' => E::ts('Sort'),
|
||||
'type' => CRM_Utils_Type::T_INT,
|
||||
'api.required' => 0,
|
||||
'description' => E::ts('Sort order of the product'),
|
||||
];
|
||||
$spec['financial_type_id'] = [
|
||||
'name' => 'financial_type_id',
|
||||
'title' => E::ts('Financial Type ID'),
|
||||
'type' => CRM_Utils_Type::T_INT,
|
||||
'api.required' => 1,
|
||||
'description' => E::ts('ID of the financial type of the product'),
|
||||
];
|
||||
$spec['twingle_shop_id'] = [
|
||||
'name' => 'twingle_shop_id',
|
||||
'title' => E::ts('FK to TwingleShop'),
|
||||
'type' => CRM_Utils_Type::T_INT,
|
||||
'api.required' => 1,
|
||||
'description' => E::ts('FK to TwingleShop'),
|
||||
];
|
||||
$spec['tw_updated_at'] = [
|
||||
'name' => 'tw_updated_at',
|
||||
'title' => E::ts('Twingle timestamp'),
|
||||
'type' => CRM_Utils_Type::T_INT,
|
||||
'api.required' => 1,
|
||||
'description' => E::ts('Timestamp of last update in Twingle db'),
|
||||
];
|
||||
$spec['price_field_id'] = [
|
||||
'name' => 'price_field_id',
|
||||
'title' => E::ts('FK to PriceField'),
|
||||
'type' => CRM_Utils_Type::T_INT,
|
||||
'api.required' => 0,
|
||||
'description' => E::ts('FK to PriceField'),
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* TwingleProduct.Create API
|
||||
*
|
||||
* @param array $params
|
||||
*
|
||||
* @return array
|
||||
* API result descriptor
|
||||
*
|
||||
* @see civicrm_api3_create_success
|
||||
*
|
||||
* @throws API_Exception
|
||||
* @throws \Exception
|
||||
*/
|
||||
function civicrm_api3_twingle_product_Create($params): array {
|
||||
// Filter for allowed params
|
||||
$allowed_params = [];
|
||||
_civicrm_api3_twingle_product_Create_spec($allowed_params);
|
||||
$params = array_intersect_key($params, $allowed_params);
|
||||
|
||||
try {
|
||||
// Create TwingleProduct and load params
|
||||
$product = new TwingleProduct();
|
||||
$product->load($params);
|
||||
|
||||
// Save TwingleProduct
|
||||
$product->add();
|
||||
$result = $product->getAttributes();
|
||||
return civicrm_api3_create_success($result, $params, 'TwingleProduct', 'Create');
|
||||
}
|
||||
catch (ProductException $e) {
|
||||
return civicrm_api3_create_error($e->getMessage(), [
|
||||
'error_code' => $e->getCode(),
|
||||
'params' => $params,
|
||||
]);
|
||||
}
|
||||
}
|
||||
72
api/v3/TwingleProduct/Delete.php
Normal file
72
api/v3/TwingleProduct/Delete.php
Normal file
|
|
@ -0,0 +1,72 @@
|
|||
<?php
|
||||
|
||||
use CRM_Twingle_ExtensionUtil as E;
|
||||
use Civi\Twingle\Shop\BAO\TwingleProduct;
|
||||
|
||||
/**
|
||||
* TwingleProduct.Delete API specification (optional)
|
||||
* This is used for documentation and validation.
|
||||
*
|
||||
* @param array $spec description of fields supported by this API call
|
||||
*
|
||||
* @see https://docs.civicrm.org/dev/en/latest/framework/api-architecture/
|
||||
*/
|
||||
function _civicrm_api3_twingle_product_Delete_spec(&$spec) {
|
||||
$spec['id'] = [
|
||||
'name' => 'id',
|
||||
'title' => E::ts('TwingleProduct ID'),
|
||||
'type' => CRM_Utils_Type::T_INT,
|
||||
'api.required' => 0,
|
||||
'description' => E::ts('The TwingleProduct ID in CiviCRM'),
|
||||
];
|
||||
$spec['external_id'] = [
|
||||
'name' => 'external_id',
|
||||
'title' => E::ts('External TwingleProduct ID'),
|
||||
'type' => CRM_Utils_Type::T_INT,
|
||||
'api.required' => 0,
|
||||
'description' => E::ts('Twingle\'s ID of the product'),
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* TwingleProduct.Delete API
|
||||
*
|
||||
* @param array $params
|
||||
*
|
||||
* @return array
|
||||
* API result descriptor
|
||||
*
|
||||
* @throws API_Exception*@throws \Exception
|
||||
* @throws \Exception
|
||||
* @see civicrm_api3_create_success
|
||||
*
|
||||
*/
|
||||
function civicrm_api3_twingle_product_Delete($params) {
|
||||
// Filter for allowed params
|
||||
$allowed_params = [];
|
||||
_civicrm_api3_twingle_product_Delete_spec($allowed_params);
|
||||
$params = array_intersect_key($params, $allowed_params);
|
||||
|
||||
// Find TwingleProduct via getsingle API
|
||||
$product_data = civicrm_api3('TwingleProduct', 'getsingle', $params);
|
||||
if ($product_data['is_error']) {
|
||||
return civicrm_api3_create_error($product_data['error_message'],
|
||||
['error_code' => $product_data['error_code'], 'params' => $params]
|
||||
);
|
||||
}
|
||||
|
||||
// Get TwingleProduct object
|
||||
$product = TwingleProduct::findById($product_data['id']);
|
||||
|
||||
// Delete TwingleProduct and associated PriceField and PriceFieldValue
|
||||
$result = $product->delete();
|
||||
if ($result) {
|
||||
return civicrm_api3_create_success(1, $params, 'TwingleProduct', 'Delete');
|
||||
}
|
||||
else {
|
||||
return civicrm_api3_create_error(
|
||||
E::ts('TwingleProduct could not be deleted.'),
|
||||
['error_code' => 'delete_failed', 'params' => $params]
|
||||
);
|
||||
}
|
||||
}
|
||||
137
api/v3/TwingleProduct/Get.php
Normal file
137
api/v3/TwingleProduct/Get.php
Normal file
|
|
@ -0,0 +1,137 @@
|
|||
<?php
|
||||
|
||||
use CRM_Twingle_ExtensionUtil as E;
|
||||
use Civi\Twingle\Shop\BAO\TwingleProduct;
|
||||
|
||||
/**
|
||||
* TwingleProduct.Get API specification (optional)
|
||||
* This is used for documentation and validation.
|
||||
*
|
||||
* @param array $spec description of fields supported by this API call
|
||||
*
|
||||
* @see https://docs.civicrm.org/dev/en/latest/framework/api-architecture/
|
||||
*/
|
||||
function _civicrm_api3_twingle_product_Get_spec(&$spec) {
|
||||
$spec['id'] = [
|
||||
'name' => 'id',
|
||||
'title' => E::ts('TwingleProduct ID'),
|
||||
'type' => CRM_Utils_Type::T_INT,
|
||||
'api.required' => 0,
|
||||
'description' => E::ts('The TwingleProduct ID in CiviCRM'),
|
||||
];
|
||||
$spec['external_id'] = [
|
||||
'name' => 'external_id',
|
||||
'title' => E::ts('External TwingleProduct ID'),
|
||||
'type' => CRM_Utils_Type::T_INT,
|
||||
'api.required' => 0,
|
||||
'description' => E::ts('Twingle\'s ID of the product'),
|
||||
];
|
||||
$spec['price_field_id'] = [
|
||||
'name' => 'Price Field ID',
|
||||
'title' => E::ts('Price Field ID'),
|
||||
'type' => CRM_Utils_Type::T_INT,
|
||||
'api.required' => 0,
|
||||
'description' => E::ts('FK to civicrm_price_field'),
|
||||
];
|
||||
$spec['twingle_shop_id'] = [
|
||||
'name' => 'twingle_shop_id',
|
||||
'title' => E::ts('TwingleShop ID'),
|
||||
'type' => CRM_Utils_Type::T_INT,
|
||||
'api.required' => 0,
|
||||
'description' => E::ts('The TwingleShop ID in CiviCRM'),
|
||||
];
|
||||
$spec['project_identifier'] = [
|
||||
'name' => 'project_identifier',
|
||||
'title' => E::ts('Project Identifier'),
|
||||
'type' => CRM_Utils_Type::T_STRING,
|
||||
'api.required' => 0,
|
||||
'description' => E::ts('Twingle project identifier'),
|
||||
];
|
||||
$spec['numerical_project_id'] = [
|
||||
'name' => 'numerical_project_id',
|
||||
'title' => E::ts('Numerical Project Identifier'),
|
||||
'type' => CRM_Utils_Type::T_INT,
|
||||
'api.required' => 0,
|
||||
'description' => E::ts('Twingle numerical project identifier'),
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* TwingleProduct.Get API
|
||||
*
|
||||
* @param array $params
|
||||
*
|
||||
* @return array
|
||||
* API result descriptor
|
||||
*
|
||||
* @throws API_Exception
|
||||
* @see civicrm_api3_create_success
|
||||
*
|
||||
*/
|
||||
function civicrm_api3_twingle_product_Get($params) {
|
||||
// Filter for allowed params
|
||||
$allowed_params = [];
|
||||
_civicrm_api3_twingle_product_Get_spec($allowed_params);
|
||||
$params = array_intersect_key($params, $allowed_params);
|
||||
|
||||
// Build query
|
||||
$query = 'SELECT ctp.* FROM civicrm_twingle_product ctp
|
||||
INNER JOIN civicrm_twingle_shop cts ON ctp.twingle_shop_id = cts.id';
|
||||
$query_params = [];
|
||||
|
||||
if (!empty($params)) {
|
||||
$query = $query . ' WHERE';
|
||||
$possible_params = [];
|
||||
_civicrm_api3_twingle_product_Get_spec($possible_params);
|
||||
$param_count = 1;
|
||||
$altered_params = [];
|
||||
|
||||
// Specify product fields to define table prefix
|
||||
$productFields = array_keys(TwingleProduct::fields());
|
||||
|
||||
// Alter params (prefix with table name)
|
||||
foreach ($possible_params as $param) {
|
||||
if (!empty($params[$param['name']])) {
|
||||
// Prefix with table name
|
||||
$table_prefix = in_array($param['name'], $productFields) ? 'ctp.' : 'cts.';
|
||||
$altered_params[] = [
|
||||
'name' => $table_prefix . $param['name'],
|
||||
'value' => $params[$param['name']],
|
||||
'type' => $param['type'],
|
||||
];
|
||||
}
|
||||
}
|
||||
|
||||
// Add altered params to query
|
||||
foreach ($altered_params as $param) {
|
||||
$query = $query . ' ' . $param['name'] . " = %$param_count AND";
|
||||
$query_params[$param_count] = [
|
||||
$param['value'],
|
||||
$param['type'] == CRM_Utils_Type::T_INT ? 'Integer' : 'String',
|
||||
];
|
||||
$param_count++;
|
||||
}
|
||||
}
|
||||
|
||||
// Cut away last 'AND'
|
||||
$query = substr($query, 0, -4);
|
||||
|
||||
// Execute query
|
||||
try {
|
||||
$dao = TwingleProduct::executeQuery($query, $query_params);
|
||||
}
|
||||
catch (Exception $e) {
|
||||
return civicrm_api3_create_error($e->getMessage(), [
|
||||
'error_code' => $e->getCode(),
|
||||
'params' => $params,
|
||||
]);
|
||||
}
|
||||
|
||||
// Prepare return values
|
||||
$returnValues = [];
|
||||
while ($dao->fetch()) {
|
||||
$returnValues[] = $dao->toArray();
|
||||
}
|
||||
|
||||
return civicrm_api3_create_success($returnValues, $params, 'TwingleProduct', 'Get');
|
||||
}
|
||||
54
api/v3/TwingleProduct/Getsingle.php
Normal file
54
api/v3/TwingleProduct/Getsingle.php
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
<?php
|
||||
use CRM_Twingle_ExtensionUtil as E;
|
||||
|
||||
/**
|
||||
* TwingleProduct.Getsingle API specification (optional)
|
||||
* This is used for documentation and validation.
|
||||
*
|
||||
* @param array $spec description of fields supported by this API call
|
||||
*
|
||||
* @see https://docs.civicrm.org/dev/en/latest/framework/api-architecture/
|
||||
*/
|
||||
function _civicrm_api3_twingle_product_Getsingle_spec(&$spec) {
|
||||
_civicrm_api3_twingle_product_Get_spec($spec);
|
||||
}
|
||||
|
||||
/**
|
||||
* TwingleProduct.Getsingle API
|
||||
*
|
||||
* @param array $params
|
||||
*
|
||||
* @return array
|
||||
* API result descriptor
|
||||
*
|
||||
* @see civicrm_api3_create_success
|
||||
*
|
||||
* @throws API_Exception
|
||||
*/
|
||||
function civicrm_api3_twingle_product_Getsingle($params) {
|
||||
// Filter for allowed params
|
||||
$allowed_params = [];
|
||||
_civicrm_api3_twingle_product_Getsingle_spec($allowed_params);
|
||||
$params = array_intersect_key($params, $allowed_params);
|
||||
|
||||
// Check whether any parameters are set
|
||||
if (empty($params)) {
|
||||
return civicrm_api3_create_error(
|
||||
"At least one parameter must be set",
|
||||
['error_code' => 'missing_parameter', 'params' => $params]
|
||||
);
|
||||
}
|
||||
|
||||
// Find TwingleProduct via get API
|
||||
$returnValues = civicrm_api3('TwingleProduct', 'get', $params);
|
||||
$count = $returnValues['count'];
|
||||
|
||||
// Check whether only a single TwingleProduct is found
|
||||
if ($count != 1) {
|
||||
return civicrm_api3_create_error(
|
||||
"Expected one TwingleProduct but found $count",
|
||||
['error_code' => 'not_found', 'params' => $params]
|
||||
);
|
||||
}
|
||||
return $returnValues['values'][$returnValues['id']];
|
||||
}
|
||||
80
api/v3/TwingleShop/Create.php
Normal file
80
api/v3/TwingleShop/Create.php
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
<?php
|
||||
use CRM_Twingle_ExtensionUtil as E;
|
||||
use Civi\Twingle\Shop\BAO\TwingleShop;
|
||||
use Civi\Twingle\Shop\Exceptions\ShopException;
|
||||
|
||||
/**
|
||||
* TwingleShop.Create API specification (optional)
|
||||
* This is used for documentation and validation.
|
||||
*
|
||||
* @param array $spec description of fields supported by this API call
|
||||
*
|
||||
* @see https://docs.civicrm.org/dev/en/latest/framework/api-architecture/
|
||||
*/
|
||||
function _civicrm_api3_twingle_shop_Create_spec(&$spec) {
|
||||
$spec['project_identifier'] = [
|
||||
'name' => 'project_identifier',
|
||||
'title' => E::ts('Project Identifier'),
|
||||
'type' => CRM_Utils_Type::T_STRING,
|
||||
'api.required' => 1,
|
||||
'description' => E::ts('Twingle project identifier'),
|
||||
];
|
||||
$spec['numerical_project_id'] = [
|
||||
'name' => 'numerical_project_id',
|
||||
'title' => E::ts('Numerical Project Identifier'),
|
||||
'type' => CRM_Utils_Type::T_INT,
|
||||
'api.required' => 1,
|
||||
'description' => E::ts('Numerical Twingle project identifier'),
|
||||
];
|
||||
$spec['name'] = [
|
||||
'name' => 'name',
|
||||
'title' => E::ts('Shop Name'),
|
||||
'type' => CRM_Utils_Type::T_STRING,
|
||||
'api.required' => 1,
|
||||
'description' => E::ts('Name of the shop'),
|
||||
];
|
||||
$spec['financial_type_id'] = [
|
||||
'name' => 'financial_type_id',
|
||||
'title' => E::ts('Financial Type ID'),
|
||||
'type' => CRM_Utils_Type::T_INT,
|
||||
'api.required' => 1,
|
||||
'description' => E::ts('FK to civicrm_financial_type'),
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* TwingleShop.Create API
|
||||
*
|
||||
* @param array $params
|
||||
*
|
||||
* @return array
|
||||
* API result descriptor
|
||||
*
|
||||
* @see civicrm_api3_create_success
|
||||
*
|
||||
* @throws API_Exception
|
||||
*/
|
||||
function civicrm_api3_twingle_shop_Create($params) {
|
||||
// Filter for allowed params
|
||||
$allowed_params = [];
|
||||
_civicrm_api3_twingle_shop_Create_spec($allowed_params);
|
||||
$params = array_intersect_key($params, $allowed_params);
|
||||
|
||||
try {
|
||||
// Create TwingleShop and load params
|
||||
$shop = new TwingleShop();
|
||||
$shop->load($params);
|
||||
|
||||
// Save TwingleShop
|
||||
$result = $shop->add();
|
||||
|
||||
// Return success
|
||||
return civicrm_api3_create_success($result, $params, 'TwingleShop', 'Create');
|
||||
}
|
||||
catch (ShopException $e) {
|
||||
return civicrm_api3_create_error($e->getMessage(), [
|
||||
'error_code' => $e->getErrorCode(),
|
||||
'params' => $params,
|
||||
]);
|
||||
}
|
||||
}
|
||||
79
api/v3/TwingleShop/Delete.php
Normal file
79
api/v3/TwingleShop/Delete.php
Normal file
|
|
@ -0,0 +1,79 @@
|
|||
<?php
|
||||
use CRM_Twingle_ExtensionUtil as E;
|
||||
use Civi\Twingle\Shop\BAO\TwingleShop;
|
||||
|
||||
/**
|
||||
* TwingleShop.Delete API specification (optional)
|
||||
* This is used for documentation and validation.
|
||||
*
|
||||
* @param array $spec description of fields supported by this API call
|
||||
*
|
||||
* @see https://docs.civicrm.org/dev/en/latest/framework/api-architecture/
|
||||
*/
|
||||
function _civicrm_api3_twingle_shop_Delete_spec(&$spec) {
|
||||
$spec['id'] = [
|
||||
'name' => 'id',
|
||||
'title' => E::ts('TwingleShop ID'),
|
||||
'type' => CRM_Utils_Type::T_INT,
|
||||
'api.required' => 0,
|
||||
'description' => E::ts('The TwingleShop ID in CiviCRM'),
|
||||
];
|
||||
$spec['project_identifier'] = [
|
||||
'name' => 'project_identifier',
|
||||
'title' => E::ts('Project Identifier'),
|
||||
'type' => CRM_Utils_Type::T_STRING,
|
||||
'api.required' => 0,
|
||||
'description' => E::ts('Twingle project identifier'),
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* TwingleShop.Delete API
|
||||
*
|
||||
* @param array $params
|
||||
*
|
||||
* @return array
|
||||
* API result descriptor
|
||||
*
|
||||
* @throws \API_Exception
|
||||
* @throws \Civi\Twingle\Shop\Exceptions\ShopException
|
||||
* @throws \Exception
|
||||
* @see civicrm_api3_create_success
|
||||
*
|
||||
*/
|
||||
function civicrm_api3_twingle_shop_Delete($params) {
|
||||
// Filter for allowed params
|
||||
$allowed_params = [];
|
||||
_civicrm_api3_twingle_shop_Delete_spec($allowed_params);
|
||||
$params = array_intersect_key($params, $allowed_params);
|
||||
|
||||
// Find TwingleShop via getsingle API
|
||||
$shop_data = civicrm_api3('TwingleShop', 'getsingle', $params);
|
||||
if ($shop_data['is_error']) {
|
||||
return civicrm_api3_create_error($shop_data['error_message'],
|
||||
['error_code' => $shop_data['error_code'], 'params' => $params]
|
||||
);
|
||||
}
|
||||
|
||||
// Get TwingleShop object
|
||||
$shop = TwingleShop::findById($shop_data['id']);
|
||||
|
||||
// Delete TwingleShop
|
||||
/* @var \Civi\Twingle\Shop\BAO\TwingleShop $shop */
|
||||
$result = $shop->deleteByConstraint();
|
||||
if ($result) {
|
||||
return civicrm_api3_create_success(1, $params, 'TwingleShop', 'Delete');
|
||||
}
|
||||
elseif ($result === 0) {
|
||||
return civicrm_api3_create_error(
|
||||
E::ts('TwingleShop could not be found.'),
|
||||
['error_code' => 'not_found', 'params' => $params]
|
||||
);
|
||||
}
|
||||
else {
|
||||
return civicrm_api3_create_error(
|
||||
E::ts('TwingleShop could not be deleted.'),
|
||||
['error_code' => 'delete_failed', 'params' => $params]
|
||||
);
|
||||
}
|
||||
}
|
||||
97
api/v3/TwingleShop/Fetch.php
Normal file
97
api/v3/TwingleShop/Fetch.php
Normal file
|
|
@ -0,0 +1,97 @@
|
|||
<?php
|
||||
|
||||
use CRM_Twingle_ExtensionUtil as E;
|
||||
use Civi\Twingle\Shop\BAO\TwingleShop;
|
||||
use Civi\Twingle\Shop\Exceptions\ApiCallError;
|
||||
use Civi\Twingle\Shop\Exceptions\ProductException;
|
||||
use Civi\Twingle\Shop\Exceptions\ShopException;
|
||||
|
||||
/**
|
||||
* TwingleShop.Fetch API specification (optional)
|
||||
* This is used for documentation and validation.
|
||||
*
|
||||
* @param array $spec description of fields supported by this API call
|
||||
*
|
||||
* @see https://docs.civicrm.org/dev/en/latest/framework/api-architecture/
|
||||
*/
|
||||
function _civicrm_api3_twingle_shop_Fetch_spec(&$spec) {
|
||||
$spec['project_identifiers'] = [
|
||||
'name' => 'project_identifiers',
|
||||
'title' => E::ts('Project Identifiers'),
|
||||
'type' => CRM_Utils_Type::T_STRING,
|
||||
'api.required' => 1,
|
||||
'description' => E::ts('Comma separated list of Twingle project identifiers.'),
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* TwingleShop.Fetch API
|
||||
*
|
||||
* @param array $params
|
||||
*
|
||||
* @return array
|
||||
* API result descriptor
|
||||
*
|
||||
* @see civicrm_api3_create_success
|
||||
*
|
||||
* @throws API_Exception
|
||||
*/
|
||||
function civicrm_api3_twingle_shop_Fetch($params) {
|
||||
// Filter for allowed params
|
||||
$allowed_params = [];
|
||||
_civicrm_api3_twingle_shop_Fetch_spec($allowed_params);
|
||||
$params = array_intersect_key($params, $allowed_params);
|
||||
|
||||
$returnValues = [];
|
||||
|
||||
// Explode string with project IDs and trim
|
||||
$projectIds = array_map(
|
||||
function ($projectId) {
|
||||
return trim($projectId);
|
||||
},
|
||||
explode(',', $params['project_identifiers'])
|
||||
);
|
||||
|
||||
// Get products for all projects of type 'shop'
|
||||
foreach ($projectIds as $projectId) {
|
||||
try {
|
||||
$shop = TwingleShop::findByProjectIdentifier($projectId);
|
||||
$products = $shop->fetchProducts();
|
||||
$returnValues[$projectId] = [];
|
||||
$returnValues[$projectId] += $shop->getAttributes();
|
||||
$returnValues[$projectId]['products'] = array_map(function ($product) {
|
||||
return $product->getAttributes();
|
||||
}, $products);
|
||||
}
|
||||
catch (ShopException|ApiCallError|ProductException $e) {
|
||||
// If this project identifier doesn't belong to a project of type
|
||||
// 'shop', just skip it
|
||||
if ($e->getErrorCode() == ShopException::ERROR_CODE_NOT_A_SHOP) {
|
||||
$returnValues[$projectId] = "project is not of type 'shop'";
|
||||
continue;
|
||||
}
|
||||
// Else, log error and throw exception
|
||||
else {
|
||||
Civi::log()->error(
|
||||
$e->getMessage(),
|
||||
[
|
||||
'project_identifier' => $projectId,
|
||||
'params' => $params,
|
||||
]
|
||||
);
|
||||
return civicrm_api3_create_error($e->getMessage(), [
|
||||
'error_code' => $e->getErrorCode(),
|
||||
'project_identifier' => $projectId,
|
||||
'params' => $params,
|
||||
]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return civicrm_api3_create_success(
|
||||
$returnValues,
|
||||
$params,
|
||||
'TwingleShop',
|
||||
'Fetch'
|
||||
);
|
||||
}
|
||||
111
api/v3/TwingleShop/Get.php
Normal file
111
api/v3/TwingleShop/Get.php
Normal file
|
|
@ -0,0 +1,111 @@
|
|||
<?php
|
||||
use CRM_Twingle_ExtensionUtil as E;
|
||||
use Civi\Twingle\Shop\BAO\TwingleShop;
|
||||
|
||||
/**
|
||||
* TwingleShop.Get API specification (optional)
|
||||
* This is used for documentation and validation.
|
||||
*
|
||||
* @param array $spec description of fields supported by this API call
|
||||
*
|
||||
* @see https://docs.civicrm.org/dev/en/latest/framework/api-architecture/
|
||||
*/
|
||||
function _civicrm_api3_twingle_shop_Get_spec(&$spec) {
|
||||
$spec['id'] = [
|
||||
'name' => 'id',
|
||||
'title' => E::ts('TwingleShop ID'),
|
||||
'type' => CRM_Utils_Type::T_INT,
|
||||
'api.required' => 0,
|
||||
'description' => E::ts('The TwingleShop ID in CiviCRM'),
|
||||
];
|
||||
$spec['project_identifier'] = [
|
||||
'name' => 'project_identifier',
|
||||
'title' => E::ts('Project Identifier'),
|
||||
'type' => CRM_Utils_Type::T_STRING,
|
||||
'api.required' => 0,
|
||||
'description' => E::ts('Twingle project identifier'),
|
||||
];
|
||||
$spec['numerical_project_id'] = [
|
||||
'name' => 'numerical_project_id',
|
||||
'title' => E::ts('Numerical Project Identifier'),
|
||||
'type' => CRM_Utils_Type::T_INT,
|
||||
'api.required' => 0,
|
||||
'description' => E::ts('Twingle numerical project identifier'),
|
||||
];
|
||||
$spec['name'] = [
|
||||
'name' => 'name',
|
||||
'title' => E::ts('Name'),
|
||||
'type' => CRM_Utils_Type::T_STRING,
|
||||
'api.required' => 0,
|
||||
'description' => E::ts('Name of the TwingleShop'),
|
||||
];
|
||||
$spec['price_set_id'] = [
|
||||
'name' => 'price_set_id',
|
||||
'title' => E::ts('Price Set ID'),
|
||||
'type' => CRM_Utils_Type::T_INT,
|
||||
'api.required' => 0,
|
||||
'description' => E::ts('FK to civicrm_price_set'),
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* TwingleShop.Get API
|
||||
*
|
||||
* @param array $params
|
||||
*
|
||||
* @return array
|
||||
* API result descriptor
|
||||
*
|
||||
* @see civicrm_api3_create_success
|
||||
*
|
||||
* @throws API_Exception
|
||||
*/
|
||||
function civicrm_api3_twingle_shop_Get($params) {
|
||||
// Filter for allowed params
|
||||
$allowed_params = [];
|
||||
_civicrm_api3_twingle_shop_Get_spec($allowed_params);
|
||||
$params = array_intersect_key($params, $allowed_params);
|
||||
|
||||
// Build query
|
||||
$query = 'SELECT * FROM civicrm_twingle_shop';
|
||||
$query_params = [];
|
||||
|
||||
if (!empty($params)) {
|
||||
$query = $query . ' WHERE';
|
||||
$possible_params = [];
|
||||
_civicrm_api3_twingle_shop_Get_spec($possible_params);
|
||||
$param_count = 1;
|
||||
|
||||
foreach ($possible_params as $param) {
|
||||
if (!empty($params[$param['name']])) {
|
||||
$query = $query . ' ' . $param['name'] . " = %$param_count AND";
|
||||
$query_params[$param_count] = [
|
||||
$params[$param['name']],
|
||||
$param['type'] == CRM_Utils_Type::T_INT ? 'Integer' : 'String'
|
||||
];
|
||||
$param_count++;
|
||||
}
|
||||
}
|
||||
// Cut away last 'AND'
|
||||
$query = substr($query, 0, -4);
|
||||
}
|
||||
|
||||
// Execute query
|
||||
try {
|
||||
$dao = TwingleShop::executeQuery($query, $query_params);
|
||||
}
|
||||
catch (\Exception $e) {
|
||||
return civicrm_api3_create_error($e->getMessage(), [
|
||||
'error_code' => $e->getCode(),
|
||||
'params' => $params,
|
||||
]);
|
||||
}
|
||||
|
||||
// Prepare return values
|
||||
$returnValues = [];
|
||||
while ($dao->fetch()) {
|
||||
$returnValues[] = $dao->toArray();
|
||||
}
|
||||
|
||||
return civicrm_api3_create_success($returnValues, $params, 'TwingleShop', 'Get');
|
||||
}
|
||||
54
api/v3/TwingleShop/Getsingle.php
Normal file
54
api/v3/TwingleShop/Getsingle.php
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
<?php
|
||||
use CRM_Twingle_ExtensionUtil as E;
|
||||
|
||||
/**
|
||||
* TwingleShop.Getsingle API specification (optional)
|
||||
* This is used for documentation and validation.
|
||||
*
|
||||
* @param array $spec description of fields supported by this API call
|
||||
*
|
||||
* @see https://docs.civicrm.org/dev/en/latest/framework/api-architecture/
|
||||
*/
|
||||
function _civicrm_api3_twingle_shop_Getsingle_spec(&$spec) {
|
||||
_civicrm_api3_twingle_shop_Get_spec($spec);
|
||||
}
|
||||
|
||||
/**
|
||||
* TwingleShop.Getsingle API
|
||||
*
|
||||
* @param array $params
|
||||
*
|
||||
* @return array
|
||||
* API result descriptor
|
||||
*
|
||||
* @see civicrm_api3_create_success
|
||||
*
|
||||
* @throws API_Exception
|
||||
*/
|
||||
function civicrm_api3_twingle_shop_Getsingle($params) {
|
||||
// Filter for allowed params
|
||||
$allowed_params = [];
|
||||
_civicrm_api3_twingle_shop_Getsingle_spec($allowed_params);
|
||||
$params = array_intersect_key($params, $allowed_params);
|
||||
|
||||
// Check whether any parameters are set
|
||||
if (empty($params)) {
|
||||
return civicrm_api3_create_error(
|
||||
"At least one parameter must be set",
|
||||
['error_code' => 'missing_parameter', 'params' => $params]
|
||||
);
|
||||
}
|
||||
|
||||
// Find TwingleShop via get API
|
||||
$returnValues = civicrm_api3('TwingleShop', 'get', $params);
|
||||
$count = $returnValues['count'];
|
||||
|
||||
// Check whether only a single TwingleShop is found
|
||||
if ($count != 1) {
|
||||
return civicrm_api3_create_error(
|
||||
"Expected one TwingleShop but found $count",
|
||||
['error_code' => 'not_found', 'params' => $params]
|
||||
);
|
||||
}
|
||||
return $returnValues['values'][$returnValues['id']];
|
||||
}
|
||||
37
css/twingle_shop.css
Normal file
37
css/twingle_shop.css
Normal file
|
|
@ -0,0 +1,37 @@
|
|||
.twingle-shop-table-caption {
|
||||
font-weight: bold;
|
||||
font-size: 13px;
|
||||
padding: 6px;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
.twingle-shop-table-divider {
|
||||
border-top: 1px solid #ddd;
|
||||
margin-top: 20px;
|
||||
margin-bottom: 4px;
|
||||
}
|
||||
|
||||
#twingle-shop-spinner {
|
||||
animation: spin 2s linear infinite;
|
||||
}
|
||||
|
||||
.twingle-shop-table tbody tr {
|
||||
height: 32px;
|
||||
}
|
||||
|
||||
.twingle-shop-table-button {
|
||||
margin: 10px 15px 0 0 !important;
|
||||
}
|
||||
|
||||
.twingle-shop-cell-button {
|
||||
margin: 3px 5px 3px 5px;
|
||||
}
|
||||
|
||||
.strikethrough {
|
||||
text-decoration: line-through;
|
||||
}
|
||||
|
||||
@keyframes spin {
|
||||
0% { transform: rotate(0deg); }
|
||||
100% { transform: rotate(360deg); }
|
||||
}
|
||||
2
info.xml
2
info.xml
|
|
@ -18,7 +18,7 @@
|
|||
<version>1.5-dev</version>
|
||||
<develStage>dev</develStage>
|
||||
<compatibility>
|
||||
<ver>5.56</ver>
|
||||
<ver>5.58</ver>
|
||||
</compatibility>
|
||||
<comments/>
|
||||
<requires>
|
||||
|
|
|
|||
741
js/twingle_shop.js
Normal file
741
js/twingle_shop.js
Normal file
|
|
@ -0,0 +1,741 @@
|
|||
/**
|
||||
* This file contains the JavaScript code for the Twingle Shop integration.
|
||||
*/
|
||||
|
||||
/**
|
||||
* This function initializes the Twingle Shop integration.
|
||||
*/
|
||||
function twingleShopInit() {
|
||||
cj('#twingle-shop-spinner').hide();
|
||||
|
||||
// Run once on page load
|
||||
load_financial_types();
|
||||
twingle_shop_active_changed();
|
||||
twingle_map_products_changed();
|
||||
twingle_fetch_products();
|
||||
|
||||
// Add event listeners
|
||||
cj('#enable_shop_integration:checkbox').change(twingle_shop_active_changed);
|
||||
cj('#shop_map_products:checkbox').change(twingle_map_products_changed);
|
||||
cj('#btn_fetch_products').click(function (event) {
|
||||
event.preventDefault(); // Prevent the default form submission behavior
|
||||
twingle_fetch_products();
|
||||
});
|
||||
}
|
||||
|
||||
// Define financial types as global variable
|
||||
let financialTypes = {};
|
||||
|
||||
/**
|
||||
* Load financial types from CiviCRM
|
||||
*/
|
||||
function load_financial_types() {
|
||||
CRM.api3('FinancialType', 'get', {
|
||||
'sequential': 1,
|
||||
'options': { 'limit': 0 },
|
||||
}).then(function (result) {
|
||||
financialTypes = result.values.reduce((obj, item) => {
|
||||
obj[item.id] = item.name;
|
||||
return obj;
|
||||
}, {});
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetches the Twingle products for the given project identifiers.
|
||||
*/
|
||||
function twingle_fetch_products() {
|
||||
let active = cj('#shop_map_products:checkbox:checked').length;
|
||||
if (active) {
|
||||
cj('#twingle-shop-spinner').show();
|
||||
CRM.api3('TwingleShop', 'fetch', {
|
||||
'project_identifiers': cj('#selectors :input').val(),
|
||||
}).then(function (result) {
|
||||
if (result.is_error === 1) {
|
||||
cj('#btn_fetch_products').crmError(result.error_message, ts('Could not fetch products', []));
|
||||
cj('#twingle-shop-spinner').hide();
|
||||
return;
|
||||
}
|
||||
buildShopTables(result);
|
||||
cj('#twingle-shop-spinner').hide();
|
||||
}, function () {
|
||||
cj('#btn_fetch_products').crmError(ts('Could not fetch products. Please check your Twingle API key.', []));
|
||||
cj('#twingle-shop-spinner').hide();
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Update the form fields based on whether shop integration is currently active
|
||||
*/
|
||||
function twingle_shop_active_changed() {
|
||||
let active = cj('#enable_shop_integration:checkbox:checked').length;
|
||||
if (active) {
|
||||
cj('.twingle-shop-element').show();
|
||||
} else {
|
||||
cj('.twingle-shop-element').hide();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Display fetch button and product mapping when the corresponding option is active
|
||||
*/
|
||||
function twingle_map_products_changed() {
|
||||
let active = cj('#shop_map_products:checkbox:checked').length;
|
||||
if (active) {
|
||||
cj('.twingle-product-mapping').show();
|
||||
} else {
|
||||
cj('.twingle-product-mapping').hide();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* This function builds the shop tables.
|
||||
* @param shopData
|
||||
*/
|
||||
function buildShopTables(shopData) {
|
||||
|
||||
let productTables = [];
|
||||
|
||||
// Create table for each project (shop)
|
||||
for (const key in shopData.values) {
|
||||
productTables.push(new ProductsTable(shopData.values[key]));
|
||||
}
|
||||
|
||||
// Add table container to DOM
|
||||
const tableContainer = document.getElementById('tableContainer');
|
||||
|
||||
// Add tables to table container
|
||||
for (const productTable of productTables) {
|
||||
tableContainer.appendChild(productTable.table);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the value of the default financial type for the shops defined in this profile.
|
||||
* @returns {string|string}
|
||||
*/
|
||||
function getShopDefaultFinancialType() {
|
||||
const default_selection = document.getElementById('s2id_shop_financial_type');
|
||||
const selected = default_selection.getElementsByClassName('select2-chosen')[0];
|
||||
return selected ? selected.textContent : '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the value of the default financial type.
|
||||
* @returns {string}
|
||||
*/
|
||||
function getShopDefaultFinancialTypeValue() {
|
||||
const shopDefaultFinancialType = getShopDefaultFinancialType();
|
||||
return Object.keys(financialTypes).find(key => financialTypes[key] === shopDefaultFinancialType);
|
||||
}
|
||||
|
||||
/**
|
||||
* This class represents a Twingle Product.
|
||||
*/
|
||||
class Product {
|
||||
|
||||
/**
|
||||
* Creates a new Product object.
|
||||
* @param productData
|
||||
* @param parentTable
|
||||
*/
|
||||
constructor(productData, parentTable) {
|
||||
this.parentTable = parentTable;
|
||||
this.setProps(productData);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the properties of this product.
|
||||
* @param productData
|
||||
* @private
|
||||
*/
|
||||
setProps(productData) {
|
||||
this.id = productData.id;
|
||||
this.name = productData.name;
|
||||
this.isActive = productData.is_active;
|
||||
this.price = productData.price;
|
||||
this.sort = productData.sort;
|
||||
this.description = productData.description;
|
||||
this.projectId = productData.project_id;
|
||||
this.externalId = productData.external_id;
|
||||
this.isOutdated = productData.is_outdated;
|
||||
this.isOrphaned = productData.is_orphaned;
|
||||
// this.updatedAt = productData.updated_at;
|
||||
this.createdAt = productData.created_at;
|
||||
this.twUpdatedAt = productData.tw_updated_at;
|
||||
this.financialTypeId = productData.financial_type_id;
|
||||
this.priceFieldId = productData.price_field_id;
|
||||
}
|
||||
|
||||
/**
|
||||
* Dumps the product data.
|
||||
* @returns {{id, name, is_active, price, sort, description, project_id, external_id, financial_type_id, tw_updated_at, twingle_shop_id: *}}
|
||||
*/
|
||||
dumpData() {
|
||||
return {
|
||||
'id': this.id,
|
||||
'name': this.name,
|
||||
'is_active': this.isActive,
|
||||
'price': this.price,
|
||||
'sort': this.sort,
|
||||
'description': this.description,
|
||||
'project_id': this.projectId,
|
||||
'external_id': this.externalId,
|
||||
'financial_type_id': this.financialTypeId,
|
||||
'price_field_id': this.priceFieldId,
|
||||
'tw_updated_at': this.twUpdatedAt,
|
||||
'twingle_shop_id': this.parentTable.id,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a button for creating, updating or deleting the price field for
|
||||
* this product.
|
||||
* @param action
|
||||
* @param handler
|
||||
* @returns {HTMLButtonElement}
|
||||
* @private
|
||||
*/
|
||||
createProductButton(action, handler) {
|
||||
// Create button
|
||||
const button = document.createElement('button');
|
||||
button.id = action + '_twingle_product_tw_' + this.externalId;
|
||||
button.classList.add('twingle-shop-cell-button');
|
||||
|
||||
// Add button text
|
||||
let text = action === 'create' ? ts('Create', []) : action === 'update' ? ts('Update', []) : ts('Delete', []);
|
||||
button.textContent = ' ' + ts(text, []);
|
||||
|
||||
// Add button handler
|
||||
if (handler) {
|
||||
button.onclick = handler;
|
||||
} else {
|
||||
button.disabled = true;
|
||||
}
|
||||
|
||||
// Deactivate 'create' button if product hast no financial type
|
||||
if (action === 'create' && this.financialTypeId === null) {
|
||||
button.disabled = true;
|
||||
}
|
||||
|
||||
// Add icon
|
||||
const icon = document.createElement('i');
|
||||
const iconClass = action === 'create' ? 'fa-plus-circle' : action === 'update' ? 'fa-refresh' : 'fa-trash';
|
||||
icon.classList.add('crm-i', iconClass);
|
||||
button.insertBefore(icon, button.firstChild);
|
||||
|
||||
return button;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a handler for creating a price field for this product.
|
||||
* @returns {(function(*): void)|*}
|
||||
* @private
|
||||
*/
|
||||
createPriceFieldHandler() {
|
||||
const self = this;
|
||||
return function (event) {
|
||||
event.preventDefault();
|
||||
const action = event.target.innerText.includes('Update') ? 'updated' : 'created';
|
||||
CRM.api3('TwingleProduct', 'create', self.dumpData())
|
||||
.then(function (result) {
|
||||
if (result.is_error === 1) {
|
||||
cj('#create_twingle_product_tw_' + self.id).crmError(result.error_message, ts('Could not create Price Field for this product', []));
|
||||
} else {
|
||||
self.update(result.values);
|
||||
CRM.alert(ts(`The Price Field was ${action} successfully.`, []), ts(`Price Field ${action}`, []), 'success', {'expires': 5000});
|
||||
}
|
||||
}, function (error) {
|
||||
cj('#create_twingle_product_tw_' + self.id).crmError(error.message, ts('Could not create Price Field for this product', []));
|
||||
});
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a handler for creating a price field for this product.
|
||||
* @returns {(function(*): void)|*}
|
||||
* @private
|
||||
*/
|
||||
deletePriceFieldHandler() {
|
||||
let self = this;
|
||||
return function (event) {
|
||||
event.preventDefault();
|
||||
const options = {
|
||||
'title': ts('Delete Price Field', []),
|
||||
'message': ts('Are you sure you want to delete the price field associated with this product?', []),
|
||||
};
|
||||
CRM.confirm(options)
|
||||
.on('crmConfirm:yes', function () {
|
||||
CRM.api3('TwingleProduct', 'delete', { 'id': self.id })
|
||||
.then(function (result) {
|
||||
if (result.is_error === 1) {
|
||||
cj('#create_twingle_product_tw_' + self.id).crmError(result.error_message, ts('Could not delete Price Field', []));
|
||||
} else {
|
||||
self.update();
|
||||
}
|
||||
CRM.alert(ts('The Price Field was deleted successfully.', []), ts('Price Field deleted', []), 'success', {'expires': 5000});
|
||||
}, function (error) {
|
||||
cj('#create_twingle_product_tw_' + self.id).crmError(error.message, ts('Could not delete Price Field', []));
|
||||
});
|
||||
});
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new row with the product name and buttons for creating, updating
|
||||
* or deleting the price field for this product.
|
||||
* @returns {*}
|
||||
*/
|
||||
createRow() {
|
||||
let row;
|
||||
|
||||
// Clear row
|
||||
if (this.row) {
|
||||
for (let i = this.row.cells.length - 1; i >= 0; i--) {
|
||||
// Delete everything from row
|
||||
this.row.deleteCell(i);
|
||||
}
|
||||
row = this.row;
|
||||
} else {
|
||||
// Create new row element
|
||||
row = document.createElement('tr');
|
||||
|
||||
// Add id to row
|
||||
row.id = 'twingle_product_tw_' + this.externalId;
|
||||
}
|
||||
|
||||
// Add cell with product name
|
||||
const nameCell = document.createElement('td');
|
||||
if (this.isOrphaned) {
|
||||
nameCell.classList.add('strikethrough');
|
||||
}
|
||||
nameCell.textContent = this.name;
|
||||
row.appendChild(nameCell);
|
||||
|
||||
// Add cell for buttons
|
||||
let buttonCell = row.insertCell(1);
|
||||
|
||||
// Add product buttons which allow to create, update or delete the price
|
||||
// field for this product
|
||||
if (this.parentTable.id) {
|
||||
let buttons = this.createProductButtons();
|
||||
for (const button of buttons) {
|
||||
buttonCell.appendChild(button);
|
||||
}
|
||||
}
|
||||
|
||||
// Add financial type dropdown for each product if price set exists
|
||||
if (this.parentTable.id) {
|
||||
let dropdown = this.createFinancialTypeDropdown();
|
||||
const cell = document.createElement('td');
|
||||
cell.classList.add('twingle-shop-financial-type-select');
|
||||
cell.appendChild(dropdown);
|
||||
row.insertCell(2).appendChild(cell);
|
||||
}
|
||||
// else add default financial type
|
||||
else {
|
||||
const cell = document.createElement('td');
|
||||
cell.classList.add('twingle-shop-financial-type-default');
|
||||
cell.innerHTML = '<i>' + getShopDefaultFinancialType() + '</i>';
|
||||
row.insertCell(1).appendChild(cell);
|
||||
}
|
||||
|
||||
this.row = row;
|
||||
return this.row;
|
||||
}
|
||||
|
||||
/**
|
||||
* Determining which actions are available for this product and creating a
|
||||
* button for each of them.
|
||||
* @returns {Array} Array of buttons
|
||||
*/
|
||||
createProductButtons() {
|
||||
let actionsAndHandlers = [];
|
||||
let buttons = [];
|
||||
|
||||
// Determine actions; if product has price field id, it can be updated or
|
||||
// deleted, otherwise it can be created
|
||||
if (this.priceFieldId) {
|
||||
if (this.isOutdated) {
|
||||
actionsAndHandlers.push(['update', this.createPriceFieldHandler()]);
|
||||
} else if (!this.isOrphaned) {
|
||||
actionsAndHandlers.push(['update', null]);
|
||||
}
|
||||
actionsAndHandlers.push(['delete', this.deletePriceFieldHandler()]);
|
||||
} else {
|
||||
actionsAndHandlers.push(['create', this.createPriceFieldHandler()]);
|
||||
}
|
||||
|
||||
// Create button for each action
|
||||
for (const [action, handler] of actionsAndHandlers) {
|
||||
buttons.push(this.createProductButton(action, handler));
|
||||
}
|
||||
|
||||
return buttons;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a dropdown for selecting the financial type for this product.
|
||||
* @returns {HTMLSelectElement}
|
||||
* @private
|
||||
*/
|
||||
createFinancialTypeDropdown() {
|
||||
// Create new dropdown element
|
||||
const dropdown = document.createElement('select');
|
||||
dropdown.id = 'twingle_product_tw_' + this.externalId + '_financial_type';
|
||||
|
||||
// Add empty option if no price field exists
|
||||
if (!this.priceFieldId) {
|
||||
let option = document.createElement('option');
|
||||
option.value = '';
|
||||
option.innerHTML = '<' + ts('select financial type', []) + '>';
|
||||
option.selected = true;
|
||||
option.disabled = true;
|
||||
dropdown.appendChild(option);
|
||||
}
|
||||
|
||||
// Add options for each financial type available in CiviCRM
|
||||
for (const key in financialTypes) {
|
||||
let option = document.createElement('option');
|
||||
option.value = key;
|
||||
option.text = financialTypes[key]; // financialTypes is defined in twingle_shop.tpl as smarty variable
|
||||
if (this.financialTypeId !== null && this.financialTypeId.toString() === key) {
|
||||
option.selected = true;
|
||||
}
|
||||
dropdown.appendChild(option);
|
||||
}
|
||||
|
||||
// Add handlers
|
||||
let self = this;
|
||||
dropdown.onchange = function () {
|
||||
|
||||
// Enable 'create' button if financial type is selected
|
||||
const createButton = document.getElementById('twingle_product_tw_' + self.externalId).getElementsByClassName('twingle-shop-cell-button')[0];
|
||||
if (createButton.textContent.includes('Create')) {
|
||||
createButton.disabled = dropdown.value === '0';
|
||||
}
|
||||
|
||||
// Update financial type
|
||||
self.financialTypeId = dropdown.value;
|
||||
};
|
||||
|
||||
return dropdown;
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates the product properties and rebuilds the row.
|
||||
* @param productData
|
||||
*/
|
||||
update(productData = null) {
|
||||
if (productData) {
|
||||
this.setProps(productData);
|
||||
} else {
|
||||
this.reset();
|
||||
}
|
||||
this.createRow();
|
||||
}
|
||||
|
||||
/**
|
||||
* Resets the product properties.
|
||||
*/
|
||||
reset() {
|
||||
this.financialTypeId = null;
|
||||
this.priceFieldId = null;
|
||||
this.isOutdated = null;
|
||||
this.isOutdated = null;
|
||||
// this.updatedAt = null;
|
||||
this.createdAt = null;
|
||||
this.id = null;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* This class represents a Twingle Shop.
|
||||
*/
|
||||
class ProductsTable {
|
||||
|
||||
/**
|
||||
* Creates a new ProductsTable object.
|
||||
* @param projectData
|
||||
*/
|
||||
constructor(projectData) {
|
||||
this.setProps(projectData);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the properties of this project.
|
||||
* @param projectData
|
||||
* @private
|
||||
*/
|
||||
setProps(projectData) {
|
||||
this.id = projectData.id;
|
||||
this.name = projectData.name;
|
||||
this.numericalProjectId = projectData.numerical_project_id;
|
||||
this.projectIdentifier = projectData.project_identifier;
|
||||
this.products = projectData.products.map(productData => new Product(productData, this));
|
||||
this.priceSetId = projectData.price_set_id;
|
||||
this.table = this.buildTable();
|
||||
}
|
||||
|
||||
/**
|
||||
* Dumps the projects data.
|
||||
* @returns {{price_set_id, financial_type_id, numerical_project_id, name, id, project_identifier, products: *}}
|
||||
*/
|
||||
dumpData() {
|
||||
return {
|
||||
'id': this.id,
|
||||
'name': this.name,
|
||||
'numerical_project_id': this.numericalProjectId,
|
||||
'project_identifier': this.projectIdentifier,
|
||||
'price_set_id': this.priceSetId,
|
||||
'products': this.products.map(product => product.dumpData()),
|
||||
'financial_type_id': getShopDefaultFinancialTypeValue()
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds the table for this project (shop).
|
||||
* @returns {HTMLTableElement}
|
||||
* @private
|
||||
*/
|
||||
buildTable() {
|
||||
let table;
|
||||
|
||||
// Clear table body
|
||||
if (this.table) {
|
||||
this.clearTableHeader();
|
||||
this.clearTableBody();
|
||||
this.updateTableButtons();
|
||||
table = this.table;
|
||||
} else {
|
||||
// Create new table element
|
||||
table = document.createElement('table');
|
||||
table.classList.add('twingle-shop-table');
|
||||
table.id = this.projectIdentifier;
|
||||
|
||||
// Add caption
|
||||
const caption = table.createCaption();
|
||||
caption.textContent = this.name + ' (' + this.projectIdentifier + ')';
|
||||
caption.classList.add('twingle-shop-table-caption');
|
||||
|
||||
// Add table body
|
||||
const tbody = document.createElement('tbody');
|
||||
table.appendChild(tbody);
|
||||
|
||||
// Add table buttons
|
||||
this.addTableButtons(table);
|
||||
}
|
||||
|
||||
// Add header row
|
||||
const thead = table.createTHead();
|
||||
const headerRow = thead.insertRow();
|
||||
const headers = [ts('Product', []), ts('Financial Type', [])];
|
||||
|
||||
// Add price field column if price set exists
|
||||
if (this.priceSetId) {
|
||||
headers.splice(1, 0, ts('Price Field', []));
|
||||
}
|
||||
|
||||
for (const headerText of headers) {
|
||||
const headerCell = document.createElement('th');
|
||||
headerCell.textContent = headerText;
|
||||
headerRow.appendChild(headerCell);
|
||||
}
|
||||
|
||||
// Add products to table
|
||||
this.addProductsToTable(table);
|
||||
|
||||
return table;
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds buttons for creating, updating or deleting the price set for the
|
||||
* given project (shop).
|
||||
* @private
|
||||
*/
|
||||
addTableButtons(table) {
|
||||
table.appendChild(this.createTableButton('update', this.updatePriceSetHandler()));
|
||||
if (this.priceSetId === null) {
|
||||
table.appendChild(this.createTableButton('create', this.createPriceSetHandler()));
|
||||
} else {
|
||||
table.appendChild(this.createTableButton('delete', this.deletePriceSetHandler()));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a button for creating, updating or deleting the price set for the
|
||||
* given project (shop).
|
||||
* @param action
|
||||
* @param handler
|
||||
* @returns {HTMLButtonElement}
|
||||
* @private
|
||||
*/
|
||||
createTableButton(action, handler) {
|
||||
// Create button
|
||||
const button = document.createElement('button');
|
||||
button.id = 'btn_' + action + '_twingle_shop_' + this.projectIdentifier;
|
||||
button.classList.add('crm-button', 'twingle-shop-table-button');
|
||||
|
||||
// Add button text
|
||||
const text = action === 'create' ? ts('Create Price Set', []) : action === 'update' ? ts('Update Price Set', []) : ts('Delete Price Set', []);
|
||||
button.textContent = ' ' + ts(text, []);
|
||||
|
||||
// Add button handler
|
||||
button.onclick = handler;
|
||||
|
||||
// Add icon
|
||||
const icon = document.createElement('i');
|
||||
const iconClass = action === 'create' ? 'fa-plus-circle' : action === 'update' ? 'fa-refresh' : 'fa-trash';
|
||||
icon.classList.add('crm-i', iconClass);
|
||||
button.insertBefore(icon, button.firstChild);
|
||||
|
||||
return button;
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds products to table body.
|
||||
* @param table
|
||||
* @private
|
||||
*/
|
||||
addProductsToTable(table) {
|
||||
// Get table body
|
||||
const tbody = table.getElementsByTagName('tbody')[0];
|
||||
|
||||
// Add products to table body
|
||||
for (const product of this.products) {
|
||||
// Add row for product
|
||||
const row = product.createRow();
|
||||
// Add row to table
|
||||
tbody.appendChild(row);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates the table buttons.
|
||||
*/
|
||||
updateTableButtons() {
|
||||
const table_buttons = this.table.getElementsByClassName('twingle-shop-table-button');
|
||||
// Remove all price set buttons from table
|
||||
while (table_buttons.length > 0) {
|
||||
table_buttons[0].remove();
|
||||
}
|
||||
this.addTableButtons(this.table);
|
||||
}
|
||||
|
||||
/**
|
||||
* Clears the table header.
|
||||
* @private
|
||||
*/
|
||||
clearTableHeader() {
|
||||
const thead = this.table.getElementsByTagName('thead')[0];
|
||||
while (thead.firstChild) {
|
||||
thead.removeChild(thead.firstChild);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Clears the table body.
|
||||
*/
|
||||
clearTableBody() {
|
||||
const tbody = this.table.getElementsByTagName('tbody')[0];
|
||||
while (tbody.firstChild) {
|
||||
tbody.removeChild(tbody.firstChild);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a handler for creating the price set for the given project (shop).
|
||||
* @returns {(function(*): void)|*}
|
||||
*/
|
||||
createPriceSetHandler() {
|
||||
let self = this;
|
||||
return function (event) {
|
||||
event.preventDefault();
|
||||
CRM.api3('TwingleShop', 'create', self.dumpData())
|
||||
.then(function (result) {
|
||||
if (result.is_error === 1) {
|
||||
cj('#btn_create_price_set_' + self.projectIdentifier).crmError(result.error_message, ts('Could not create Twingle Shop', []));
|
||||
} else {
|
||||
self.update();
|
||||
CRM.alert(ts('The Price Set was created successfully.', []), ts('Price Field created', []), 'success', {'expires': 5000});
|
||||
}
|
||||
}, function (error) {
|
||||
cj('#btn_create_price_set_' + self.projectIdentifier).crmError(error.message, ts('Could not create TwingleShop', []));
|
||||
});
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a handler for deleting the price set for the given project (shop).
|
||||
* @returns {(function(*): void)|*}
|
||||
*/
|
||||
deletePriceSetHandler() {
|
||||
let self = this;
|
||||
return function (event) {
|
||||
event.preventDefault();
|
||||
const options = {
|
||||
'title': ts('Delete Price Set', []),
|
||||
'message': ts('Are you sure you want to delete the price set associated with this Twingle Shop?', []),
|
||||
};
|
||||
CRM.confirm(options)
|
||||
.on('crmConfirm:yes', function () {
|
||||
CRM.api3('TwingleShop', 'delete', {
|
||||
'project_identifier': self.projectIdentifier,
|
||||
}).then(function (result) {
|
||||
if (result.is_error === 1) {
|
||||
cj('#btn_create_price_set_' + self.projectIdentifier).crmError(result.error_message, ts('Could not delete Twingle Shop', []));
|
||||
} else {
|
||||
self.update();
|
||||
CRM.alert(ts('The Price Set was deleted successfully.', []), ts('Price Set deleted', []), 'success', {'expires': 5000});
|
||||
}
|
||||
}, function (error) {
|
||||
cj('#btn_delete_price_set_' + self.projectIdentifier).crmError(error.message, ts('Could not delete Twingle Shop', []));
|
||||
});
|
||||
});
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a handler for updating the price set for the given project (shop).
|
||||
* @returns {(function(*): void)|*}
|
||||
*/
|
||||
updatePriceSetHandler() {
|
||||
let self = this;
|
||||
return function (event) {
|
||||
cj('#twingle-shop-spinner').show();
|
||||
if (event) {
|
||||
event.preventDefault();
|
||||
}
|
||||
CRM.api3('TwingleShop', 'fetch', {
|
||||
'project_identifiers': self.projectIdentifier,
|
||||
}).then(function (result) {
|
||||
if (result.is_error === 1) {
|
||||
cj('#btn_create_price_set_' + self.projectIdentifier).crmError(result.error_message, ts('Could not delete Twingle Shop', []));
|
||||
cj('#twingle-shop-spinner').hide();
|
||||
} else {
|
||||
self.update(result.values[self.projectIdentifier]);
|
||||
cj('#twingle-shop-spinner').hide();
|
||||
}
|
||||
}, function (error) {
|
||||
cj('#btn_update_price_set_' + self.projectIdentifier).crmError(error.message, ts('Could not update Twingle Shop', []));
|
||||
cj('#twingle-shop-spinner').hide();
|
||||
});
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates the project properties and rebuilds the table.
|
||||
* @param projectData
|
||||
*/
|
||||
update(projectData) {
|
||||
if (!projectData) {
|
||||
const updatePriceSet = this.updatePriceSetHandler();
|
||||
updatePriceSet();
|
||||
} else {
|
||||
this.setProps(projectData);
|
||||
this.buildTable();
|
||||
}
|
||||
}
|
||||
}
|
||||
21
sql/auto_uninstall.sql
Normal file
21
sql/auto_uninstall.sql
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
-- +--------------------------------------------------------------------+
|
||||
-- | Copyright CiviCRM LLC. All rights reserved. |
|
||||
-- | |
|
||||
-- | This work is published under the GNU AGPLv3 license with some |
|
||||
-- | permitted exceptions and without any warranty. For full license |
|
||||
-- | and copyright information, see https://civicrm.org/licensing |
|
||||
-- +--------------------------------------------------------------------+
|
||||
--
|
||||
-- Generated from drop.tpl
|
||||
-- DO NOT EDIT. Generated by CRM_Core_CodeGen
|
||||
---- /*******************************************************
|
||||
-- *
|
||||
-- * Clean up the existing tables-- *
|
||||
-- *******************************************************/
|
||||
|
||||
SET FOREIGN_KEY_CHECKS=0;
|
||||
|
||||
DROP TABLE IF EXISTS `civicrm_twingle_product`;
|
||||
DROP TABLE IF EXISTS `civicrm_twingle_shop`;
|
||||
|
||||
SET FOREIGN_KEY_CHECKS=1;
|
||||
66
sql/civicrm_twingle_shop.sql
Normal file
66
sql/civicrm_twingle_shop.sql
Normal file
|
|
@ -0,0 +1,66 @@
|
|||
-- +--------------------------------------------------------------------+
|
||||
-- | Copyright CiviCRM LLC. All rights reserved. |
|
||||
-- | |
|
||||
-- | This work is published under the GNU AGPLv3 license with some |
|
||||
-- | permitted exceptions and without any warranty. For full license |
|
||||
-- | and copyright information, see https://civicrm.org/licensing |
|
||||
-- +--------------------------------------------------------------------+
|
||||
--
|
||||
-- Generated from schema.tpl
|
||||
-- DO NOT EDIT. Generated by CRM_Core_CodeGen
|
||||
--
|
||||
-- /*******************************************************
|
||||
-- *
|
||||
-- * Clean up the existing tables - this section generated from drop.tpl
|
||||
-- *
|
||||
-- *******************************************************/
|
||||
|
||||
SET FOREIGN_KEY_CHECKS=0;
|
||||
|
||||
DROP TABLE IF EXISTS `civicrm_twingle_product`;
|
||||
DROP TABLE IF EXISTS `civicrm_twingle_shop`;
|
||||
|
||||
SET FOREIGN_KEY_CHECKS=1;
|
||||
-- /*******************************************************
|
||||
-- *
|
||||
-- * Create new tables
|
||||
-- *
|
||||
-- *******************************************************/
|
||||
|
||||
-- /*******************************************************
|
||||
-- *
|
||||
-- * civicrm_twingle_shop
|
||||
-- *
|
||||
-- * This table contains the Twingle Shop data. Each Twingle Shop is linked to a corresponding Price Set.
|
||||
-- *
|
||||
-- *******************************************************/
|
||||
CREATE TABLE `civicrm_twingle_shop` (
|
||||
`id` int unsigned NOT NULL AUTO_INCREMENT COMMENT 'Unique TwingleShop ID',
|
||||
`project_identifier` varchar(32) NOT NULL COMMENT 'Twingle Project Identifier',
|
||||
`numerical_project_id` int unsigned NOT NULL COMMENT 'Numerical Twingle Project Identifier',
|
||||
`price_set_id` int unsigned COMMENT 'FK to Price Set',
|
||||
`name` varchar(64) NOT NULL COMMENT 'name of the shop',
|
||||
PRIMARY KEY (`id`),
|
||||
CONSTRAINT FK_civicrm_twingle_shop_price_set_id FOREIGN KEY (`price_set_id`) REFERENCES `civicrm_price_set`(`id`) ON DELETE CASCADE
|
||||
)
|
||||
ENGINE=InnoDB;
|
||||
|
||||
-- /*******************************************************
|
||||
-- *
|
||||
-- * civicrm_twingle_product
|
||||
-- *
|
||||
-- * This table contains the Twingle Product data.
|
||||
-- *
|
||||
-- *******************************************************/
|
||||
CREATE TABLE `civicrm_twingle_product` (
|
||||
`id` int unsigned NOT NULL AUTO_INCREMENT COMMENT 'Unique TwingleProduct ID',
|
||||
`external_id` int unsigned NOT NULL COMMENT 'The ID of this product in the Twingle database',
|
||||
`price_field_id` int unsigned NOT NULL COMMENT 'FK to Price Field',
|
||||
`twingle_shop_id` int unsigned COMMENT 'FK to Twingle Shop',
|
||||
`created_at` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT 'Timestamp of when the product was created in the database',
|
||||
`updated_at` datetime NOT NULL COMMENT 'Timestamp of when the product was last updated in the Twingle database',
|
||||
PRIMARY KEY (`id`),
|
||||
CONSTRAINT FK_civicrm_twingle_product_price_field_id FOREIGN KEY (`price_field_id`) REFERENCES `civicrm_price_field`(`id`) ON DELETE CASCADE,
|
||||
CONSTRAINT FK_civicrm_twingle_product_twingle_shop_id FOREIGN KEY (`twingle_shop_id`) REFERENCES `civicrm_twingle_shop`(`id`) ON DELETE CASCADE
|
||||
)
|
||||
ENGINE=InnoDB;
|
||||
|
|
@ -85,4 +85,13 @@
|
|||
{ts domain="de.systopia.twingle"}<p>Create a contact note for each field specified in this selection.</p>
|
||||
<p><i>Tip: You can enable or disable this fields in the TwingleMANAGER.</i></p>{/ts}
|
||||
{/htxt}
|
||||
|
||||
{htxt id='id-enable_shop_integration'}
|
||||
<p>{ts domain="de.systopia.twingle"}Enable the processing of orders via Twingle Shop for this profile. The ordered products will then appear as line items in the contribution.{/ts}</p>
|
||||
{/htxt}
|
||||
|
||||
{htxt id='id-shop_map_products'}
|
||||
<p>{ts domain="de.systopia.twingle"}If this option is enabled, all Twingle Shop products corresponding to the specified project IDs will be retrieved from Twingle and mapped as price sets and price fields. Each Twingle Shop is mapped as a price set with its products as price fields.</p>
|
||||
<p>This allows you to manually create contributions with the same line items for phone orders, for example, as would be the case for orders placed through the Twingle Shop.</p>
|
||||
{/htxt}
|
||||
{/crmScope}
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@
|
|||
class="helpicon"
|
||||
></a>
|
||||
</td>
|
||||
<td class="content">{$form.selector.html}</td>
|
||||
<td id="selectors" class="content">{$form.selector.html}</td>
|
||||
{/if}
|
||||
</tr>
|
||||
|
||||
|
|
@ -353,6 +353,71 @@
|
|||
|
||||
</table>
|
||||
|
||||
{if $twingle_use_shop eq 1}
|
||||
|
||||
<legend>{ts domain="de.systopia.twingle"}Shop Integration{/ts}</legend>
|
||||
|
||||
<table class="form-layout-compressed">
|
||||
<tr class="crm-section">
|
||||
<td class="label">
|
||||
{$form.enable_shop_integration.label}
|
||||
<a
|
||||
onclick='
|
||||
CRM.help(
|
||||
"{ts domain="de.systopia.twingle"}Enable Shop Integration{/ts}",
|
||||
{literal}{
|
||||
"id": "id-enable_shop_integration",
|
||||
"file": "CRM\/Twingle\/Form\/Profile"
|
||||
}{/literal}
|
||||
);
|
||||
return false;
|
||||
'
|
||||
href="#"
|
||||
title="{ts domain="de.systopia.twingle"}Help{/ts}"
|
||||
class="helpicon"
|
||||
></a>
|
||||
</td>
|
||||
<td class="content">{$form.enable_shop_integration.html}</td>
|
||||
</tr>
|
||||
|
||||
<tr class="crm-section twingle-shop-element">
|
||||
<td class="label">{$form.shop_financial_type.label}</td>
|
||||
<td class="content">{$form.shop_financial_type.html}</td>
|
||||
</tr>
|
||||
|
||||
<tr class="crm-section twingle-shop-element">
|
||||
<td class="label">{$form.shop_donation_financial_type.label}</td>
|
||||
<td class="content">{$form.shop_donation_financial_type.html}</td>
|
||||
</tr>
|
||||
|
||||
<tr class="crm-section twingle-shop-element">
|
||||
<td class="label">{$form.shop_map_products.label}
|
||||
<a
|
||||
onclick='
|
||||
CRM.help(
|
||||
"{ts domain="de.systopia.twingle"}Map Products as Price Fields{/ts}",
|
||||
{literal}{
|
||||
"id": "id-shop_map_products",
|
||||
"file": "CRM\/Twingle\/Form\/Profile"
|
||||
}{/literal}
|
||||
);
|
||||
return false;
|
||||
'
|
||||
href="#"
|
||||
title="{ts domain="de.systopia.twingle"}Help{/ts}"
|
||||
class="helpicon"
|
||||
></a></td>
|
||||
<td class="content">{$form.shop_map_products.html}
|
||||
<i id="twingle-shop-spinner" class="crm-i fa-spinner fa-spin"></i>
|
||||
<div class="twingle-product-mapping">
|
||||
<div id="tableContainer"></div>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
{/if}
|
||||
|
||||
</fieldset>
|
||||
|
||||
{elseif $op == 'delete'}
|
||||
|
|
@ -389,11 +454,18 @@
|
|||
}
|
||||
}
|
||||
|
||||
// register events and run once
|
||||
// register events
|
||||
cj(document).ready(function (){
|
||||
cj('#membership_type_id').change(twingle_membership_active_changed);
|
||||
cj('#membership_type_id_recur').change(twingle_membership_active_changed);
|
||||
|
||||
// init Twingle Shop integration
|
||||
if ({/literal}{if $twingle_use_shop eq 1}true{else}false{/if}{literal}) {
|
||||
twingleShopInit();
|
||||
}
|
||||
});
|
||||
|
||||
// run once
|
||||
twingle_membership_active_changed();
|
||||
</script>
|
||||
{/literal}
|
||||
|
|
|
|||
|
|
@ -27,3 +27,7 @@
|
|||
{htxt id='id-twingle_prefix'}
|
||||
{ts domain="de.systopia.twingle"}You can use this setting to add a prefix to the Twingle transaction ID, in order to avoid collisions with other transaction ids.{/ts}
|
||||
{/htxt}
|
||||
|
||||
{htxt id='id-twingle_use_shop'}
|
||||
{ts domain="de.systopia.twingle"}If you enable Twingle Shop integration, you can configure Twingle API profiles to include products ordered through Twingle Shop as line items in the created contribution.{/ts}
|
||||
{/htxt}
|
||||
|
|
|
|||
|
|
@ -37,7 +37,6 @@
|
|||
</td>
|
||||
</tr>
|
||||
|
||||
|
||||
<tr class="crm-twingle-form-block-prefix">
|
||||
<td class="label">{$form.twingle_prefix.label}
|
||||
{help id="id-twingle_prefix" title=$form.twingle_prefix.label}
|
||||
|
|
@ -86,6 +85,31 @@
|
|||
|
||||
</table>
|
||||
|
||||
<h3>Twingle Shop Integration</h3>
|
||||
|
||||
<table class="form-layout-compressed">
|
||||
<tr class="crm-twingle-form-block-use-shop">
|
||||
<td class="label">{$form.twingle_use_shop.label} <a onclick='CRM.help("{$form.twingle_use_shop.label}", {literal}{"id":"id-{/literal}{$form.twingle_use_shop.name}{literal}","file":"CRM\/Twingle\/Form\/Settings"}{/literal}); return false;' href="#" title="{ts domain="de.systopia.twingle"}Help{/ts}" class="helpicon"></a></td>
|
||||
<td>
|
||||
{$form.twingle_use_shop.html}
|
||||
<br />
|
||||
<span class="description">
|
||||
{$formElements.twingle_use_shop.description}
|
||||
</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="crm-twingle-form-block-access-key twingle-shop-element">
|
||||
<td class="label">{$form.twingle_access_key.label} <a onclick='CRM.help("{$form.twingle_access_key.label}", {literal}{"id":"id-{/literal}{$form.twingle_access_key.name}{literal}","file":"CRM\/Twingle\/Form\/Settings"}{/literal}); return false;' href="#" title="{ts domain="de.systopia.twingle"}Help{/ts}" class="helpicon"></a></td>
|
||||
<td>
|
||||
{$form.twingle_access_key.html}
|
||||
<br />
|
||||
<span class="description">
|
||||
{$formElements.twingle_access_key.description}
|
||||
</span>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<div class="crm-submit-buttons">
|
||||
{include file="CRM/common/formButtons.tpl" location="bottom"}
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -26,6 +26,9 @@
|
|||
<tr>
|
||||
<th>{ts domain="de.systopia.twingle"}Profile name{/ts}</th>
|
||||
<th>{ts domain="de.systopia.twingle"}Selectors{/ts}</th>
|
||||
{if $twingle_use_shop eq 1}
|
||||
<th>{ts domain="de.systopia.twingle"}Shop Integration{/ts}</th>
|
||||
{/if}
|
||||
<th>{ts domain="de.systopia.twingle"}Used{/ts}</th>
|
||||
<th>{ts domain="de.systopia.twingle"}Last Used{/ts}</th>
|
||||
<th>{ts domain="de.systopia.twingle"}Operations{/ts}</th>
|
||||
|
|
@ -46,6 +49,9 @@
|
|||
</ul>
|
||||
{/if}
|
||||
</td>
|
||||
{if $twingle_use_shop eq 1}
|
||||
<td>{if $profile.enable_shop_integration}<span style="color:green">{ts domain="de.systopia.twingle"}enabled{/ts}</span>{else}<span>{ts domain="de.systopia.twingle"}disabled{/ts}</span>{/if}</td>
|
||||
{/if}
|
||||
<td>{ts domain="de.systopia.twingle"}{$profile_stats.$profile_name.access_counter_txt}{/ts}</td>
|
||||
<td>{ts domain="de.systopia.twingle"}{$profile_stats.$profile_name.last_access_txt}{/ts}</td>
|
||||
<td>
|
||||
|
|
@ -56,7 +62,6 @@
|
|||
{else}
|
||||
<a href="{crmURL p="civicrm/admin/settings/twingle/profile" q="op=delete&id=$profile_id"}" title="{ts domain="de.systopia.twingle" 1=$profile.name}Delete profile %1{/ts}" class="action-item crm-hover-button">{ts domain="de.systopia.twingle"}Delete{/ts}</a>
|
||||
{/if}
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
{/foreach}
|
||||
|
|
|
|||
54
tests/phpunit/api/v3/TwingleProduct/CreateTest.php
Normal file
54
tests/phpunit/api/v3/TwingleProduct/CreateTest.php
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
<?php
|
||||
|
||||
use Civi\Test\CiviEnvBuilder;
|
||||
use Civi\Test\HeadlessInterface;
|
||||
use Civi\Test\HookInterface;
|
||||
use Civi\Test\TransactionalInterface;
|
||||
|
||||
/**
|
||||
* TwingleProduct.Create API Test Case
|
||||
* This is a generic test class implemented with PHPUnit.
|
||||
* @group headless
|
||||
*/
|
||||
class api_v3_TwingleProduct_CreateTest extends \PHPUnit\Framework\TestCase implements HeadlessInterface, HookInterface, TransactionalInterface {
|
||||
use \Civi\Test\Api3TestTrait;
|
||||
|
||||
/**
|
||||
* Set up for headless tests.
|
||||
*
|
||||
* Civi\Test has many helpers, like install(), uninstall(), sql(), and sqlFile().
|
||||
*
|
||||
* See: https://docs.civicrm.org/dev/en/latest/testing/phpunit/#civitest
|
||||
*/
|
||||
public function setUpHeadless(): CiviEnvBuilder {
|
||||
return \Civi\Test::headless()
|
||||
->installMe(__DIR__)
|
||||
->apply();
|
||||
}
|
||||
|
||||
/**
|
||||
* The setup() method is executed before the test is executed (optional).
|
||||
*/
|
||||
public function setUp() {
|
||||
parent::setUp();
|
||||
}
|
||||
|
||||
/**
|
||||
* The tearDown() method is executed after the test was executed (optional)
|
||||
* This can be used for cleanup.
|
||||
*/
|
||||
public function tearDown() {
|
||||
parent::tearDown();
|
||||
}
|
||||
|
||||
/**
|
||||
* Simple example test case.
|
||||
*
|
||||
* Note how the function name begins with the word "test".
|
||||
*/
|
||||
public function testApiExample() {
|
||||
$result = civicrm_api3('TwingleProduct', 'create', array('magicword' => 'sesame'));
|
||||
$this->assertEquals('Twelve', $result['values'][12]['name']);
|
||||
}
|
||||
|
||||
}
|
||||
54
tests/phpunit/api/v3/TwingleProduct/DeleteTest.php
Normal file
54
tests/phpunit/api/v3/TwingleProduct/DeleteTest.php
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
<?php
|
||||
|
||||
use Civi\Test\CiviEnvBuilder;
|
||||
use Civi\Test\HeadlessInterface;
|
||||
use Civi\Test\HookInterface;
|
||||
use Civi\Test\TransactionalInterface;
|
||||
|
||||
/**
|
||||
* TwingleProduct.Delete API Test Case
|
||||
* This is a generic test class implemented with PHPUnit.
|
||||
* @group headless
|
||||
*/
|
||||
class api_v3_TwingleProduct_DeleteTest extends \PHPUnit\Framework\TestCase implements HeadlessInterface, HookInterface, TransactionalInterface {
|
||||
use \Civi\Test\Api3TestTrait;
|
||||
|
||||
/**
|
||||
* Set up for headless tests.
|
||||
*
|
||||
* Civi\Test has many helpers, like install(), uninstall(), sql(), and sqlFile().
|
||||
*
|
||||
* See: https://docs.civicrm.org/dev/en/latest/testing/phpunit/#civitest
|
||||
*/
|
||||
public function setUpHeadless(): CiviEnvBuilder {
|
||||
return \Civi\Test::headless()
|
||||
->installMe(__DIR__)
|
||||
->apply();
|
||||
}
|
||||
|
||||
/**
|
||||
* The setup() method is executed before the test is executed (optional).
|
||||
*/
|
||||
public function setUp() {
|
||||
parent::setUp();
|
||||
}
|
||||
|
||||
/**
|
||||
* The tearDown() method is executed after the test was executed (optional)
|
||||
* This can be used for cleanup.
|
||||
*/
|
||||
public function tearDown() {
|
||||
parent::tearDown();
|
||||
}
|
||||
|
||||
/**
|
||||
* Simple example test case.
|
||||
*
|
||||
* Note how the function name begins with the word "test".
|
||||
*/
|
||||
public function testApiExample() {
|
||||
$result = civicrm_api3('TwingleProduct', 'delete', array('magicword' => 'sesame'));
|
||||
$this->assertEquals('Twelve', $result['values'][12]['name']);
|
||||
}
|
||||
|
||||
}
|
||||
54
tests/phpunit/api/v3/TwingleProduct/GetTest.php
Normal file
54
tests/phpunit/api/v3/TwingleProduct/GetTest.php
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
<?php
|
||||
|
||||
use Civi\Test\CiviEnvBuilder;
|
||||
use Civi\Test\HeadlessInterface;
|
||||
use Civi\Test\HookInterface;
|
||||
use Civi\Test\TransactionalInterface;
|
||||
|
||||
/**
|
||||
* TwingleProduct.Get API Test Case
|
||||
* This is a generic test class implemented with PHPUnit.
|
||||
* @group headless
|
||||
*/
|
||||
class api_v3_TwingleProduct_GetTest extends \PHPUnit\Framework\TestCase implements HeadlessInterface, HookInterface, TransactionalInterface {
|
||||
use \Civi\Test\Api3TestTrait;
|
||||
|
||||
/**
|
||||
* Set up for headless tests.
|
||||
*
|
||||
* Civi\Test has many helpers, like install(), uninstall(), sql(), and sqlFile().
|
||||
*
|
||||
* See: https://docs.civicrm.org/dev/en/latest/testing/phpunit/#civitest
|
||||
*/
|
||||
public function setUpHeadless(): CiviEnvBuilder {
|
||||
return \Civi\Test::headless()
|
||||
->installMe(__DIR__)
|
||||
->apply();
|
||||
}
|
||||
|
||||
/**
|
||||
* The setup() method is executed before the test is executed (optional).
|
||||
*/
|
||||
public function setUp() {
|
||||
parent::setUp();
|
||||
}
|
||||
|
||||
/**
|
||||
* The tearDown() method is executed after the test was executed (optional)
|
||||
* This can be used for cleanup.
|
||||
*/
|
||||
public function tearDown() {
|
||||
parent::tearDown();
|
||||
}
|
||||
|
||||
/**
|
||||
* Simple example test case.
|
||||
*
|
||||
* Note how the function name begins with the word "test".
|
||||
*/
|
||||
public function testApiExample() {
|
||||
$result = civicrm_api3('TwingleProduct', 'get', array('magicword' => 'sesame'));
|
||||
$this->assertEquals('Twelve', $result['values'][12]['name']);
|
||||
}
|
||||
|
||||
}
|
||||
54
tests/phpunit/api/v3/TwingleProduct/GetsingleTest.php
Normal file
54
tests/phpunit/api/v3/TwingleProduct/GetsingleTest.php
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
<?php
|
||||
|
||||
use Civi\Test\CiviEnvBuilder;
|
||||
use Civi\Test\HeadlessInterface;
|
||||
use Civi\Test\HookInterface;
|
||||
use Civi\Test\TransactionalInterface;
|
||||
|
||||
/**
|
||||
* TwingleProduct.Getsingle API Test Case
|
||||
* This is a generic test class implemented with PHPUnit.
|
||||
* @group headless
|
||||
*/
|
||||
class api_v3_TwingleProduct_GetsingleTest extends \PHPUnit\Framework\TestCase implements HeadlessInterface, HookInterface, TransactionalInterface {
|
||||
use \Civi\Test\Api3TestTrait;
|
||||
|
||||
/**
|
||||
* Set up for headless tests.
|
||||
*
|
||||
* Civi\Test has many helpers, like install(), uninstall(), sql(), and sqlFile().
|
||||
*
|
||||
* See: https://docs.civicrm.org/dev/en/latest/testing/phpunit/#civitest
|
||||
*/
|
||||
public function setUpHeadless(): CiviEnvBuilder {
|
||||
return \Civi\Test::headless()
|
||||
->installMe(__DIR__)
|
||||
->apply();
|
||||
}
|
||||
|
||||
/**
|
||||
* The setup() method is executed before the test is executed (optional).
|
||||
*/
|
||||
public function setUp() {
|
||||
parent::setUp();
|
||||
}
|
||||
|
||||
/**
|
||||
* The tearDown() method is executed after the test was executed (optional)
|
||||
* This can be used for cleanup.
|
||||
*/
|
||||
public function tearDown() {
|
||||
parent::tearDown();
|
||||
}
|
||||
|
||||
/**
|
||||
* Simple example test case.
|
||||
*
|
||||
* Note how the function name begins with the word "test".
|
||||
*/
|
||||
public function testApiExample() {
|
||||
$result = civicrm_api3('TwingleProduct', 'getsingle', array('magicword' => 'sesame'));
|
||||
$this->assertEquals('Twelve', $result['values'][12]['name']);
|
||||
}
|
||||
|
||||
}
|
||||
54
tests/phpunit/api/v3/TwingleShop/CreateTest.php
Normal file
54
tests/phpunit/api/v3/TwingleShop/CreateTest.php
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
<?php
|
||||
|
||||
use Civi\Test\CiviEnvBuilder;
|
||||
use Civi\Test\HeadlessInterface;
|
||||
use Civi\Test\HookInterface;
|
||||
use Civi\Test\TransactionalInterface;
|
||||
|
||||
/**
|
||||
* TwingleShop.Create API Test Case
|
||||
* This is a generic test class implemented with PHPUnit.
|
||||
* @group headless
|
||||
*/
|
||||
class api_v3_TwingleShop_CreateTest extends \PHPUnit\Framework\TestCase implements HeadlessInterface, HookInterface, TransactionalInterface {
|
||||
use \Civi\Test\Api3TestTrait;
|
||||
|
||||
/**
|
||||
* Set up for headless tests.
|
||||
*
|
||||
* Civi\Test has many helpers, like install(), uninstall(), sql(), and sqlFile().
|
||||
*
|
||||
* See: https://docs.civicrm.org/dev/en/latest/testing/phpunit/#civitest
|
||||
*/
|
||||
public function setUpHeadless(): CiviEnvBuilder {
|
||||
return \Civi\Test::headless()
|
||||
->installMe(__DIR__)
|
||||
->apply();
|
||||
}
|
||||
|
||||
/**
|
||||
* The setup() method is executed before the test is executed (optional).
|
||||
*/
|
||||
public function setUp() {
|
||||
parent::setUp();
|
||||
}
|
||||
|
||||
/**
|
||||
* The tearDown() method is executed after the test was executed (optional)
|
||||
* This can be used for cleanup.
|
||||
*/
|
||||
public function tearDown() {
|
||||
parent::tearDown();
|
||||
}
|
||||
|
||||
/**
|
||||
* Simple example test case.
|
||||
*
|
||||
* Note how the function name begins with the word "test".
|
||||
*/
|
||||
public function testApiExample() {
|
||||
$result = civicrm_api3('TwingleShop', 'create', array('magicword' => 'sesame'));
|
||||
$this->assertEquals('Twelve', $result['values'][12]['name']);
|
||||
}
|
||||
|
||||
}
|
||||
54
tests/phpunit/api/v3/TwingleShop/DeleteTest.php
Normal file
54
tests/phpunit/api/v3/TwingleShop/DeleteTest.php
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
<?php
|
||||
|
||||
use Civi\Test\CiviEnvBuilder;
|
||||
use Civi\Test\HeadlessInterface;
|
||||
use Civi\Test\HookInterface;
|
||||
use Civi\Test\TransactionalInterface;
|
||||
|
||||
/**
|
||||
* TwingleShop.Delete API Test Case
|
||||
* This is a generic test class implemented with PHPUnit.
|
||||
* @group headless
|
||||
*/
|
||||
class api_v3_TwingleShop_DeleteTest extends \PHPUnit\Framework\TestCase implements HeadlessInterface, HookInterface, TransactionalInterface {
|
||||
use \Civi\Test\Api3TestTrait;
|
||||
|
||||
/**
|
||||
* Set up for headless tests.
|
||||
*
|
||||
* Civi\Test has many helpers, like install(), uninstall(), sql(), and sqlFile().
|
||||
*
|
||||
* See: https://docs.civicrm.org/dev/en/latest/testing/phpunit/#civitest
|
||||
*/
|
||||
public function setUpHeadless(): CiviEnvBuilder {
|
||||
return \Civi\Test::headless()
|
||||
->installMe(__DIR__)
|
||||
->apply();
|
||||
}
|
||||
|
||||
/**
|
||||
* The setup() method is executed before the test is executed (optional).
|
||||
*/
|
||||
public function setUp() {
|
||||
parent::setUp();
|
||||
}
|
||||
|
||||
/**
|
||||
* The tearDown() method is executed after the test was executed (optional)
|
||||
* This can be used for cleanup.
|
||||
*/
|
||||
public function tearDown() {
|
||||
parent::tearDown();
|
||||
}
|
||||
|
||||
/**
|
||||
* Simple example test case.
|
||||
*
|
||||
* Note how the function name begins with the word "test".
|
||||
*/
|
||||
public function testApiExample() {
|
||||
$result = civicrm_api3('TwingleShop', 'delete', array('magicword' => 'sesame'));
|
||||
$this->assertEquals('Twelve', $result['values'][12]['name']);
|
||||
}
|
||||
|
||||
}
|
||||
54
tests/phpunit/api/v3/TwingleShop/GetTest.php
Normal file
54
tests/phpunit/api/v3/TwingleShop/GetTest.php
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
<?php
|
||||
|
||||
use Civi\Test\CiviEnvBuilder;
|
||||
use Civi\Test\HeadlessInterface;
|
||||
use Civi\Test\HookInterface;
|
||||
use Civi\Test\TransactionalInterface;
|
||||
|
||||
/**
|
||||
* TwingleShop.Get API Test Case
|
||||
* This is a generic test class implemented with PHPUnit.
|
||||
* @group headless
|
||||
*/
|
||||
class api_v3_TwingleShop_GetTest extends \PHPUnit\Framework\TestCase implements HeadlessInterface, HookInterface, TransactionalInterface {
|
||||
use \Civi\Test\Api3TestTrait;
|
||||
|
||||
/**
|
||||
* Set up for headless tests.
|
||||
*
|
||||
* Civi\Test has many helpers, like install(), uninstall(), sql(), and sqlFile().
|
||||
*
|
||||
* See: https://docs.civicrm.org/dev/en/latest/testing/phpunit/#civitest
|
||||
*/
|
||||
public function setUpHeadless(): CiviEnvBuilder {
|
||||
return \Civi\Test::headless()
|
||||
->installMe(__DIR__)
|
||||
->apply();
|
||||
}
|
||||
|
||||
/**
|
||||
* The setup() method is executed before the test is executed (optional).
|
||||
*/
|
||||
public function setUp() {
|
||||
parent::setUp();
|
||||
}
|
||||
|
||||
/**
|
||||
* The tearDown() method is executed after the test was executed (optional)
|
||||
* This can be used for cleanup.
|
||||
*/
|
||||
public function tearDown() {
|
||||
parent::tearDown();
|
||||
}
|
||||
|
||||
/**
|
||||
* Simple example test case.
|
||||
*
|
||||
* Note how the function name begins with the word "test".
|
||||
*/
|
||||
public function testApiExample() {
|
||||
$result = civicrm_api3('TwingleShop', 'get', array('magicword' => 'sesame'));
|
||||
$this->assertEquals('Twelve', $result['values'][12]['name']);
|
||||
}
|
||||
|
||||
}
|
||||
54
tests/phpunit/api/v3/TwingleShop/GetsingleTest.php
Normal file
54
tests/phpunit/api/v3/TwingleShop/GetsingleTest.php
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
<?php
|
||||
|
||||
use Civi\Test\CiviEnvBuilder;
|
||||
use Civi\Test\HeadlessInterface;
|
||||
use Civi\Test\HookInterface;
|
||||
use Civi\Test\TransactionalInterface;
|
||||
|
||||
/**
|
||||
* TwingleShop.Getsingle API Test Case
|
||||
* This is a generic test class implemented with PHPUnit.
|
||||
* @group headless
|
||||
*/
|
||||
class api_v3_TwingleShop_GetsingleTest extends \PHPUnit\Framework\TestCase implements HeadlessInterface, HookInterface, TransactionalInterface {
|
||||
use \Civi\Test\Api3TestTrait;
|
||||
|
||||
/**
|
||||
* Set up for headless tests.
|
||||
*
|
||||
* Civi\Test has many helpers, like install(), uninstall(), sql(), and sqlFile().
|
||||
*
|
||||
* See: https://docs.civicrm.org/dev/en/latest/testing/phpunit/#civitest
|
||||
*/
|
||||
public function setUpHeadless(): CiviEnvBuilder {
|
||||
return \Civi\Test::headless()
|
||||
->installMe(__DIR__)
|
||||
->apply();
|
||||
}
|
||||
|
||||
/**
|
||||
* The setup() method is executed before the test is executed (optional).
|
||||
*/
|
||||
public function setUp() {
|
||||
parent::setUp();
|
||||
}
|
||||
|
||||
/**
|
||||
* The tearDown() method is executed after the test was executed (optional)
|
||||
* This can be used for cleanup.
|
||||
*/
|
||||
public function tearDown() {
|
||||
parent::tearDown();
|
||||
}
|
||||
|
||||
/**
|
||||
* Simple example test case.
|
||||
*
|
||||
* Note how the function name begins with the word "test".
|
||||
*/
|
||||
public function testApiExample() {
|
||||
$result = civicrm_api3('TwingleShop', 'getsingle', array('magicword' => 'sesame'));
|
||||
$this->assertEquals('Twelve', $result['values'][12]['name']);
|
||||
}
|
||||
|
||||
}
|
||||
65
tests/phpunit/bootstrap.php
Normal file
65
tests/phpunit/bootstrap.php
Normal file
|
|
@ -0,0 +1,65 @@
|
|||
<?php
|
||||
|
||||
ini_set('memory_limit', '2G');
|
||||
|
||||
// phpcs:disable
|
||||
eval(cv('php:boot --level=classloader', 'phpcode'));
|
||||
// phpcs:enable
|
||||
// Allow autoloading of PHPUnit helper classes in this extension.
|
||||
$loader = new \Composer\Autoload\ClassLoader();
|
||||
$loader->add('CRM_', [__DIR__ . '/../..', __DIR__]);
|
||||
$loader->addPsr4('Civi\\', [__DIR__ . '/../../Civi', __DIR__ . '/Civi']);
|
||||
$loader->add('api_', [__DIR__ . '/../..', __DIR__]);
|
||||
$loader->addPsr4('api\\', [__DIR__ . '/../../api', __DIR__ . '/api']);
|
||||
|
||||
$loader->register();
|
||||
|
||||
/**
|
||||
* Call the "cv" command.
|
||||
*
|
||||
* @param string $cmd
|
||||
* The rest of the command to send.
|
||||
* @param string $decode
|
||||
* Ex: 'json' or 'phpcode'.
|
||||
* @return mixed
|
||||
* Response output (if the command executed normally).
|
||||
* For 'raw' or 'phpcode', this will be a string. For 'json', it could be any JSON value.
|
||||
* @throws \RuntimeException
|
||||
* If the command terminates abnormally.
|
||||
*/
|
||||
function cv(string $cmd, string $decode = 'json') {
|
||||
$cmd = 'cv ' . $cmd;
|
||||
$descriptorSpec = [0 => ['pipe', 'r'], 1 => ['pipe', 'w'], 2 => STDERR];
|
||||
$oldOutput = getenv('CV_OUTPUT');
|
||||
putenv('CV_OUTPUT=json');
|
||||
|
||||
// Execute `cv` in the original folder. This is a work-around for
|
||||
// phpunit/codeception, which seem to manipulate PWD.
|
||||
$cmd = sprintf('cd %s; %s', escapeshellarg(getenv('PWD')), $cmd);
|
||||
|
||||
$process = proc_open($cmd, $descriptorSpec, $pipes, __DIR__);
|
||||
putenv("CV_OUTPUT=$oldOutput");
|
||||
fclose($pipes[0]);
|
||||
$result = stream_get_contents($pipes[1]);
|
||||
fclose($pipes[1]);
|
||||
if (proc_close($process) !== 0) {
|
||||
throw new RuntimeException("Command failed ($cmd):\n$result");
|
||||
}
|
||||
switch ($decode) {
|
||||
case 'raw':
|
||||
return $result;
|
||||
|
||||
case 'phpcode':
|
||||
// If the last output is /*PHPCODE*/, then we managed to complete execution.
|
||||
if (substr(trim($result), 0, 12) !== '/*BEGINPHP*/' || substr(trim($result), -10) !== '/*ENDPHP*/') {
|
||||
throw new \RuntimeException("Command failed ($cmd):\n$result");
|
||||
}
|
||||
return $result;
|
||||
|
||||
case 'json':
|
||||
return json_decode($result, 1);
|
||||
|
||||
default:
|
||||
throw new RuntimeException("Bad decoder format ($decode)");
|
||||
}
|
||||
}
|
||||
|
|
@ -198,3 +198,25 @@ function _twingle_civix_fixNavigationMenuItems(&$nodes, &$maxNavID, $parentID) {
|
|||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* (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 _twingle_civix_civicrm_entityTypes(&$entityTypes) {
|
||||
$entityTypes = array_merge($entityTypes, [
|
||||
'Civi\Twingle\Shop\DAO\TwingleProduct' => [
|
||||
'name' => 'TwingleProduct',
|
||||
'class' => 'Civi\Twingle\Shop\DAO\TwingleProduct',
|
||||
'table' => 'civicrm_twingle_product',
|
||||
],
|
||||
'Civi\Twingle\Shop\DAO\TwingleShop' => [
|
||||
'name' => 'TwingleShop',
|
||||
'class' => 'Civi\Twingle\Shop\DAO\TwingleShop',
|
||||
'table' => 'civicrm_twingle_shop',
|
||||
],
|
||||
]);
|
||||
}
|
||||
|
|
|
|||
25
twingle.php
25
twingle.php
|
|
@ -5,11 +5,36 @@ use CRM_Twingle_ExtensionUtil as E;
|
|||
|
||||
/**
|
||||
* Implements hook_civicrm_pre().
|
||||
*
|
||||
* @throws \Civi\Twingle\Shop\Exceptions\ProductException
|
||||
* @throws \CRM_Core_Exception
|
||||
* @throws \Civi\Twingle\Shop\Exceptions\ShopException
|
||||
*/
|
||||
function twingle_civicrm_pre($op, $objectName, $id, &$params) {
|
||||
if ($objectName == 'ContributionRecur' && $op == 'edit') {
|
||||
CRM_Twingle_Tools::checkRecurringContributionChange((int) $id, $params);
|
||||
}
|
||||
|
||||
// Create/delete PriceField and PriceFieldValue for TwingleProduct
|
||||
elseif ($objectName == 'TwingleProduct') {
|
||||
$twingle_product = new \Civi\Twingle\Shop\BAO\TwingleProduct();
|
||||
$twingle_product->load($params);
|
||||
if ($op == 'create' || $op == 'edit') {
|
||||
$twingle_product->createPriceField();
|
||||
}
|
||||
elseif ($op == 'delete') {
|
||||
$twingle_product->deletePriceField();
|
||||
}
|
||||
$params = $twingle_product->getAttributes();
|
||||
}
|
||||
|
||||
// Create PriceSet for TwingleShop
|
||||
elseif ($objectName == 'TwingleShop' && ($op == 'create' || $op == 'edit')) {
|
||||
$twingle_shop = new \Civi\Twingle\Shop\BAO\TwingleShop();
|
||||
$twingle_shop->load($params);
|
||||
$twingle_shop->createPriceSet();
|
||||
$params = $twingle_shop->getAttributes();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
|
|||
10
xml/schema/CRM/Twingle/TwingleProduct.entityType.php
Normal file
10
xml/schema/CRM/Twingle/TwingleProduct.entityType.php
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
<?php
|
||||
// This file declares a new entity type. For more details, see "hook_civicrm_entityTypes" at:
|
||||
// https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes
|
||||
return [
|
||||
[
|
||||
'name' => 'TwingleProduct',
|
||||
'class' => 'Civi\Twingle\Shop\DAO\TwingleProduct',
|
||||
'table' => 'civicrm_twingle_product',
|
||||
],
|
||||
];
|
||||
75
xml/schema/CRM/Twingle/TwingleProduct.xml
Normal file
75
xml/schema/CRM/Twingle/TwingleProduct.xml
Normal file
|
|
@ -0,0 +1,75 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1" ?>
|
||||
|
||||
<table>
|
||||
<base>CRM/Twingle/Shop</base>
|
||||
<class>TwingleProduct</class>
|
||||
<name>civicrm_twingle_product</name>
|
||||
<comment>This table contains the Twingle Product data.</comment>
|
||||
<log>false</log>
|
||||
<!-- <add>1.5</add>-->
|
||||
|
||||
<field>
|
||||
<name>id</name>
|
||||
<type>int unsigned</type>
|
||||
<required>true</required>
|
||||
<unique>true</unique>
|
||||
<comment>Unique TwingleProduct ID</comment>
|
||||
<html>
|
||||
<type>Number</type>
|
||||
</html>
|
||||
</field>
|
||||
<primaryKey>
|
||||
<name>id</name>
|
||||
<autoincrement>true</autoincrement>
|
||||
</primaryKey>
|
||||
|
||||
<field>
|
||||
<name>external_id</name>
|
||||
<type>int unsigned</type>
|
||||
<required>true</required>
|
||||
<comment>The ID of this product in the Twingle database</comment>
|
||||
<html>
|
||||
<type>Number</type>
|
||||
</html>
|
||||
</field>
|
||||
|
||||
<field>
|
||||
<name>price_field_id</name>
|
||||
<type>int unsigned</type>
|
||||
<comment>FK to Price Field</comment>
|
||||
<required>true</required>
|
||||
</field>
|
||||
<foreignKey>
|
||||
<name>price_field_id</name>
|
||||
<table>civicrm_contact</table>
|
||||
<key>id</key>
|
||||
<onDelete>CASCADE</onDelete>
|
||||
</foreignKey>
|
||||
|
||||
<field>
|
||||
<name>twingle_shop_id</name>
|
||||
<type>int unsigned</type>
|
||||
<unique>true</unique>
|
||||
<comment>FK to Twingle Shop</comment>
|
||||
</field>
|
||||
<foreignKey>
|
||||
<name>twingle_shop_id</name>
|
||||
<table>civicrm_twingle_shop</table>
|
||||
<key>id</key>
|
||||
<onDelete>CASCADE</onDelete>
|
||||
</foreignKey>
|
||||
|
||||
<field>
|
||||
<name>created_at</name>
|
||||
<type>datetime</type>
|
||||
<required>true</required>
|
||||
<comment>Timestamp of when the product was created in the database</comment>
|
||||
</field>
|
||||
|
||||
<field>
|
||||
<name>updated_at</name>
|
||||
<type>datetime</type>
|
||||
<required>true</required>
|
||||
<comment>Timestamp of when the product was last updated in the database</comment>
|
||||
</field>
|
||||
</table>
|
||||
10
xml/schema/CRM/Twingle/TwingleShop.entityType.php
Normal file
10
xml/schema/CRM/Twingle/TwingleShop.entityType.php
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
<?php
|
||||
// This file declares a new entity type. For more details, see "hook_civicrm_entityTypes" at:
|
||||
// https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes
|
||||
return [
|
||||
[
|
||||
'name' => 'TwingleShop',
|
||||
'class' => 'Civi\Twingle\Shop\DAO\TwingleShop',
|
||||
'table' => 'civicrm_twingle_shop',
|
||||
],
|
||||
];
|
||||
73
xml/schema/CRM/Twingle/TwingleShop.xml
Normal file
73
xml/schema/CRM/Twingle/TwingleShop.xml
Normal file
|
|
@ -0,0 +1,73 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1" ?>
|
||||
|
||||
<table>
|
||||
<base>CRM/Twingle/Shop</base>
|
||||
<class>TwingleShop</class>
|
||||
<name>civicrm_twingle_shop</name>
|
||||
<comment>This table contains the Twingle Shop data. Each Twingle Shop is linked to a corresponding Price Set.</comment>
|
||||
<log>false</log>
|
||||
<!-- <add>1.5</add>-->
|
||||
|
||||
<field>
|
||||
<name>id</name>
|
||||
<type>int unsigned</type>
|
||||
<required>true</required>
|
||||
<unique>true</unique>
|
||||
<comment>Unique TwingleShop ID</comment>
|
||||
<html>
|
||||
<type>Number</type>
|
||||
</html>
|
||||
</field>
|
||||
<primaryKey>
|
||||
<name>id</name>
|
||||
<autoincrement>true</autoincrement>
|
||||
</primaryKey>
|
||||
|
||||
<field>
|
||||
<name>project_identifier</name>
|
||||
<type>varchar</type>
|
||||
<length>32</length>
|
||||
<required>true</required>
|
||||
<unique>true</unique>
|
||||
<comment>Twingle Project Identifier</comment>
|
||||
<html>
|
||||
<type>Text</type>
|
||||
</html>
|
||||
</field>
|
||||
|
||||
<field>
|
||||
<name>numerical_project_id</name>
|
||||
<type>int unsigned</type>
|
||||
<required>true</required>
|
||||
<unique>true</unique>
|
||||
<comment>Numerical Twingle Project Identifier</comment>
|
||||
<html>
|
||||
<type>Number</type>
|
||||
</html>
|
||||
</field>
|
||||
|
||||
<field>
|
||||
<name>price_set_id</name>
|
||||
<type>int unsigned</type>
|
||||
<unique>true</unique>
|
||||
<comment>FK to Price Set</comment>
|
||||
</field>
|
||||
<foreignKey>
|
||||
<name>price_set_id</name>
|
||||
<table>civicrm_price_set</table>
|
||||
<key>id</key>
|
||||
<onDelete>CASCADE</onDelete>
|
||||
</foreignKey>
|
||||
|
||||
<field>
|
||||
<name>name</name>
|
||||
<type>varchar</type>
|
||||
<unique>false</unique>
|
||||
<length>64</length>
|
||||
<required>true</required>
|
||||
<comment>name of the shop</comment>
|
||||
<html>
|
||||
<type>Text</type>
|
||||
</html>
|
||||
</field>
|
||||
</table>
|
||||
Loading…
Add table
Add a link
Reference in a new issue