Registering Events

Code: Select all

/public_html
   /extension
       /iocart_update_inventory
          /admin
             /controller/module
                iocart_update_inventory.php
             /language/en-gb/module
                iocart_update_inventory.php
             /view/template/module
                iocart_update_inventory.twig
          /catalog
             /controller
                 /iocart_update_inventory
                    update_inventory.php

Code: Select all

<?php
namespace Opencart\Admin\Controller\Extension\IocartUpdateInventory\Module;

class iocartupdateinventory extends \Opencart\System\Engine\Controller {
    public function index(): void {
      // lots of boring language stuff here
      ...
      $this->response->setOutput($this->load->view('extension/iocart_update_inventory/module/iocartupdateinventory', $data));
    }

    public function save(): void {
        // eh, same here because my extension doesn't really have any settings yet.
        ...
        $this->response->setOutput(json_encode($json));
    }

    public function install(): void {
        $this->load->model('setting/event');
        // Here's the good part. Notice I'm using the dot notation instead of the pipe because OC version 4.0.2.0. 
        // but not sure if I got the action path correct. I've tried all kinds of variations of casing, directory structure, and underscores/no underscores in the extension name.
        $this->model_setting_event->addEvent([
            'code'        => 'iocart_update_inventory',
            'description' => 'Update inventory in IOCart when an order is placed',
            'trigger'     => 'catalog/model/checkout/order/addOrder/after',
            'action'      => 'extension/iocartupdateinventory/iocartupdateinventory.updateInventory'
        ]);
    }

    public function uninstall(): void {
        $this->load->model('setting/event');
        $this->model_setting_event->deleteEventByCode('iocart_update_inventory');
    }
}

Code: Select all

<?php
namespace Opencart\Catalog\Controller\Extension\iocartupdateinventory\updateinventory;

class iocartupdateinventory extends \Opencart\System\Engine\Controller {
    private function getAccessToken() {
        // you'll just have to trust me that there's some access token logic here... removed for brevity.
        return $token_data['access_token'];
    }

    public function updateInventory(&$route, &$args, &$output) {
        $this->log->write('TEST TEST WHY U NO LOG NOTHING EVER');
	
        try {
            // Get OAuth token
            $access_token = $this->getAccessToken();
	    ...
            // $this->log->write('Successfully updated inventory for order ');
        } catch (\Exception $e) {
            // Log error
            $this->log->write('Failed to update inventory: ' . $e->getMessage());
        }
    }
}

Code: Select all

<?php
namespace Opencart\Catalog\Controller\Extension\iocartupdateinventory\updateinventory;

class iocartupdateinventory extends \Opencart\System\Engine\Controller {

Code: Select all

          /catalog
             /controller
                 /iocart_update_inventory
                    update_inventory.php

Code: Select all

<?php
namespace Opencart\Catalog\Controller\iocart_update_inventory\update_inventory;
class iocartupdateinventory extends \Opencart\System\Engine\Controller

Code: Select all

extension/iocart_update_inventory/iocart_update_inventory/update_inventory.updateInventory

Code: Select all

namespace Opencart\Catalog\Controller\Extension\IocartUpdateInventory\IocartUpdateInventory;

class UpdateInventory extends \Opencart\System\Engine\Controller {
  public function updateInventory(): void {
    // This should be triggered when addOrder is called
    $this->log->write('test test test');
  }
}

Code: Select all

<?php
namespace Opencart\Admin\Controller\Extension\IocartUpdateInventory\Module;

class iocartupdateinventory extends \Opencart\System\Engine\Controller {
    public function index(): void {
      // lots of boring language stuff here
      ...
      $this->response->setOutput($this->load->view('extension/iocartupdateinventory/module/iocartupdateinventory', $data));
    }

    public function save(): void {
        // eh, same here because my extension doesn't really have any settings yet.
        ...
        $this->response->setOutput(json_encode($json));
    }

    // Here I've begun testing four different action paths, and four different triggers
    // Also added status and sort_order to each.
    public function install(): void {
        $this->load->model('setting/event');
        
        // This first one is similar to the original
       $this->model_setting_event->addEvent([
            'code'        => 'iocartupdateinventory',
            'description' => 'Test trigger after an order is placed',
            'trigger'     => 'catalog/model/checkout/order/addOrder/after',
            'action'      => 'extension/iocartupdateinventory/iocartupdateinventory.updateInventory',
            'status'      => 1,
            'sort_order'  => 0
        ]);

        // base extension path + filename.function
        $this->model_setting_event->addEvent([
          'code'        => 'iocartupdateinventory2',
          'description' => 'Test trigger after an item is added to the cart',
          'trigger'     => 'catalog/controller/checkout/cart/add/after',
          'action'      => 'extension/iocartupdateinventory.updateInventory',
          'status'      => 1,
          'sort_order'  => 0
        ]);

        // Mimics the advice I got from @softmonke, but with the updated directory naming
        $this->model_setting_event->addEvent([
          'code'        => 'iocartupdateinventory3',
          'description' => 'Test triggered after the admin dashboard is loaded',
          'trigger'     => 'admin/controller/common/dashboard/after',
          'action'      => 'extension/iocartupdateinventory/iocartupdateinventory/iocartupdateinventory.updateInventory',
          'status'      => 1,
          'sort_order'  => 0
        ]);

        // here I'm even adding `catalog/controller`, which I noticed is not normally necessary in the docs. But... sanity check.
        $this->model_setting_event->addEvent([
          'code'        => 'iocartupdateinventory4',
          'description' => 'Test triggered when a user visits the home page',
          'trigger'     => 'catalog/controller/common/home/after',
          'action'      => 'extension/iocartupdateinventory/catalog/controller/iocartupdateinventory/iocartupdateinventory.updateInventory',
          'status'      => 1,
          'sort_order'  => 0
        ]);
    }

    public function uninstall(): void {
        $this->load->model('setting/event');
        $this->model_setting_event->deleteEventByCode('iocartupdateinventory');
        $this->model_setting_event->deleteEventByCode('iocartupdateinventory2');
        $this->model_setting_event->deleteEventByCode('iocartupdateinventory3');
        $this->model_setting_event->deleteEventByCode('iocartupdateinventory4');
    }
}

Code: Select all

<?php
// namespace assist from @softmonke
namespace Opencart\Catalog\Controller\Extension\IocartUpdateInventory\IocartUpdateInventory;

class IocartUpdateInventory extends \Opencart\System\Engine\Controller {
    public function updateInventory(&$route, &$args, &$output) {
        $this->log->write('Someday I will see this log in the output :(');
    }
}