file = str_replace('\\', '/', __FILE__);
}
/**
* Setup the environment for the plugin
*/
public function bootstrap() {
// Install/uninstall actions.
register_activation_hook($this->file, array($this, 'activate'));
register_deactivation_hook($this->file, array($this, 'deactivate'));
register_uninstall_hook($this->file, array('Acumulus', 'uninstall'));
// Actions:
// - Backend actions we use.
add_action('admin_notices', array($this, 'showAdminNotices'));
add_action('admin_menu', array($this, 'addMenuLinks'), 900);
// - Meta box and ajax request for invoice status overview form.
add_action('wp_ajax_acumulus_ajax_action', array($this, 'handleAjaxRequest'));
add_action('add_meta_boxes_shop_order', array($this, 'addShopOrderMetaBox'));
// - Our own forms.
add_action('admin_post_acumulus_config', array($this, 'processConfigForm'));
add_action('admin_post_acumulus_advanced', array($this, 'processAdvancedForm'));
add_action('admin_post_acumulus_batch', array($this, 'processBatchForm'));
// - WooCommerce order/refund events.
add_action('woocommerce_order_status_changed', array($this, 'woocommerceOrderStatusChanged'), 10, 3);
add_action('woocommerce_order_refunded', array($this, 'woocommerceOrderRefunded'), 10, 2);
// - Our own invoice related events.
add_filter('acumulus_invoice_created', array($this, 'acumulusInvoiceCreated'), 10, 3);
}
/**
* Helper method for the ConfigStore object to get the version number from the
* comment at the top of this file, as is the official location for WordPress
* plugins.
*
* @return string
* The version number of this plugin.
*/
public function getVersionNumber() {
if (function_exists('get_plugin_data')) {
$plugin_data = get_plugin_data($this->file);
$version = $plugin_data['Version'];
}
else {
$version = get_option('acumulus_version');
}
return $version;
}
/**
* Helper method to translate strings.
*
* @param string $key
* The key to get a translation for.
*
* @return string
* The translation for the given key or the key itself if no translation
* could be found.
*/
protected function t($key) {
return $this->container->getTranslator()->get($key);
}
/**
* Loads our library and creates a configuration object.
*/
public function init() {
if ($this->container === NULL) {
// Load autoloader
require_once __DIR__ . '/lib/siel/acumulus/SielAcumulusAutoloader.php';
SielAcumulusAutoloader::register();
// Get language
$languageCode = get_bloginfo('language');
if (empty($languageCode)) {
$languageCode = 'nl';
}
$languageCode = substr($languageCode, 0, 2);
// Get WC version to set the shop namespace.
/** @var \WooCommerce $woocommerce */
global $woocommerce;
if (version_compare($woocommerce->version, '3', '>=')) {
$shopNamespace = 'WooCommerce';
}
else {
$shopNamespace = 'WooCommerce\WooCommerce2';
// Show message about stopping support for WC2
$lastShown = get_transient('acumulus_stop_support_woocommerce2');
// Show the message if we did not already show it or if it has been
// more than 7 days.
if (empty($lastShown) || (is_numeric($lastShown) && time() > (int) $lastShown + 7 * 24 * 60 * 60)) {
set_transient('acumulus_stop_support_woocommerce2', 'show now');
}
}
$this->container = new Container($shopNamespace, $languageCode);
$this->container->getTranslator()->add(new ModuleTranslations());
// Check for any updates to perform.
$this->upgrade();
}
}
/**
* Show planned admin notices.
*
* Due to the order of execution and the habit of redirecting at the end of
* an action, just adding a notice may not work. Therefore we work with
* transients.
*/
public function showAdminNotices() {
// Check the transient to see if we should display a notice.
if(get_transient('acumulus_stop_support_woocommerce2') === 'show now') {
echo '' . $this->t('wc2_end_support') . '
';
$output .= $this->showNotices($form);
$output .= '';
$output .= '
';
break;
case 'invoice':
$output .= '';
$output .= $formOutput;
$output .= $this->showNotices($form);
$output .= '
';
break;
}
return $output;
}
/**
* Action method that renders any notices coming from the form(s).
*
* @param \Siel\Acumulus\Helpers\Form $form
*
* @return string
*/
public function showNotices($form) {
$output = '';
if (isset($form)) {
foreach ($form->getErrorMessages() as $message) {
$output .= $this->renderNotice($message, 'error');
}
foreach ($form->getWarningMessages() as $message) {
$output .= $this->renderNotice($message, 'warning');
}
foreach ($form->getSuccessMessages() as $message) {
$output .= $this->renderNotice($message, 'success');
}
}
return $output;
}
/**
* Renders a notice.
*
* @param string $message
* @param string $type
*
* @return string
* The rendered notice.
*/
protected function renderNotice($message, $type) {
return sprintf('', $type, $message);
}
/**
* Checks access to the current form/page.
*
* @param string $capability
* The access right to check for.
*/
protected function checkCapability($capability)
{
if (!empty($capability) && !current_user_can($capability)) {
wp_die(__('You do not have sufficient permissions to access this page.'));
}
}
/**
* Filter function for the 'woocommerce_order_status_changed' action,
*
* This action gets called when the status of an order changes.
*
* @param int $orderId
* param int $status
* param int $newStatus
*/
public function woocommerceOrderStatusChanged($orderId/*, $status, $newStatus*/) {
$this->init();
// WC 3.x: we use WC_Order::is_paid() to determine the payment status,
// but the default states as returned by wc_get_is_paid_statuses() are
// not as we define "is paid".
add_action('woocommerce_order_is_paid_statuses', array($this, 'woocommerceOrderIsPaidStatuses'), 10, 2);
// WC 2.x: we use WC_Order::needs_payment()
add_action('woocommerce_valid_order_statuses_for_payment', array($this, 'woocommerceValidOrderStatusesForPayment'), 10, 2);
$source = $this->container->getSource(Source::Order, $orderId);
$this->container->getInvoiceManager()->sourceStatusChange($source);
remove_action('woocommerce_order_is_paid_statuses', array($this, 'woocommerceOrderIsPaidStatuses'));
remove_action('woocommerce_valid_order_statuses_for_payment', array($this, 'woocommerceValidOrderStatusesForPayment'));
}
/**
* Filter function that gets called when the status of an order changes.
*
* @param int $orderId
* @param int $refundId
*/
public function woocommerceOrderRefunded(/** @noinspection PhpUnusedParameterInspection */ $orderId, $refundId) {
$this->init();
$source = $this->container->getSource(Source::CreditNote, $refundId);
$this->container->getInvoiceManager()->sourceStatusChange($source);
}
/**
* Hook to correct the behaviour of WC_Order::is_paid().
*
* Note: this is used when running with WC 3.x.
*
* WooCommerce thinks that only orders in the processing or completed statuses
* are to be seen as paid, whereas for Acumulus, refunded orders are also
* paid. (if an order is refunded, a separate credit note invoice will be
* created in Acumulus and thus the invoice for the original order remains
* "paid".)
*
* @param array $statuses
* param WC_Order $order
*
* @return array
*/
public function woocommerceOrderIsPaidStatuses(array $statuses/*, WC_Order $order*/) {
return array_merge($statuses, array('refunded'));
}
/**
* Hook to correct the behaviour of WC_Order::needs_payment().
*
* Note: this is only used when running with WC 2.x.
*
* WooCommerce thinks that orders in the on-hold status are to be seen as
* paid, whereas for Acumulus they are seen as due. (On-hold means waiting for
* bank transfer to be booked on our account.)
*
* We also add the the cancelled and failed statuses, although for a cancelled
* no invoice should be created. But if 1 gets created, mark it as due.
*
* @param array $statuses
* param WC_Order $order
*
* @return array
*/
public function woocommerceValidOrderStatusesForPayment(array $statuses/*, WC_Order $order*/) {
return array_merge($statuses, array('on-hold', 'cancelled', 'failed'));
}
/**
* Processes the filter triggered before an invoice will be sent to Acumulus.
*
* @param array|null $invoice
* The invoice in Acumulus format as will be sent to Acumulus or null if
* another filter already decided that the invoice should not be sent to
* Acumulus.
* @param \Siel\Acumulus\Invoice\Source $invoiceSource
* Wrapper around the original WooCommerce order or refund for which the
* invoice has been created.
* @param \Siel\Acumulus\Invoice\Result $localResult
* Any local error or warning messages that were created locally.
*
* @return array|null
* The changed invoice or null if you do not want the invoice to be sent
* to Acumulus.
*/
public function acumulusInvoiceCreated($invoice, Source $invoiceSource, Result $localResult) {
if ($invoice !== null) {
$this->init();
// Get WC version: only for WC 3+ do we support the other plugins.
/** @var \WooCommerce $woocommerce */
global $woocommerce;
if (version_compare($woocommerce->version, '3', '>=')) {
/** @var \Siel\Acumulus\WooCommerce\Invoice\CreatorPluginSupport $pluginSupport */
$pluginSupport = $this->container->getInstance('CreatorPluginSupport', 'Invoice');
$invoice = $pluginSupport->acumulusInvoiceCreated($invoice, $invoiceSource, $localResult);
}
}
return $invoice;
}
/**
* Forwards the call to an instance of the setup class.
*/
public function activate() {
$this->init();
require_once 'AcumulusSetup.php';
$setup = new AcumulusSetup($this->container, $this->getVersionNumber());
$setup->activate();
}
/**
* Forwards the call to an instance of the setup class.
*
* To keep the lazy loading we do check the version number here.
*
* @return bool
*/
public function upgrade() {
$dbVersion = get_option('acumulus_version');
if (empty($dbVersion) || version_compare($dbVersion, $this->getVersionNumber(), '<')) {
require_once 'AcumulusSetup.php';
$setup = new AcumulusSetup($this->container, $this->getVersionNumber());
return $setup->upgrade($dbVersion);
}
return true;
}
/**
* Forwards the call to an instance of the setup class.
*
* @return bool
*/
public function deactivate() {
$this->init();
require_once 'AcumulusSetup.php';
$setup = new AcumulusSetup($this->container);
return $setup->deactivate();
}
/**
* Forwards the call to an instance of the setup class.
*
* @return bool
*/
public static function uninstall() {
$acumulus = static::create();
$acumulus->init();
require_once 'AcumulusSetup.php';
$setup = new AcumulusSetup($acumulus->container);
return $setup->uninstall();
}
}
// Entry point for WP: create and bootstrap our module.
Acumulus::create()->bootstrap();