Skip to content
Snippets Groups Projects
stripe.civix.php 8.44 KiB
Newer Older
  • Learn to ignore specific revisions
  • drastik's avatar
    drastik committed
    // AUTO-GENERATED FILE -- Civix may overwrite any changes made to this file
    
    mattwire's avatar
    mattwire committed
    /**
     * The ExtensionUtil class provides small stubs for accessing resources of this
     * extension.
     */
    class CRM_Stripe_ExtensionUtil {
    
      const SHORT_NAME = 'stripe';
      const LONG_NAME = 'com.drastikbydesign.stripe';
      const CLASS_PREFIX = 'CRM_Stripe';
    
    mattwire's avatar
    mattwire committed
    
      /**
       * Translate a string using the extension's domain.
       *
       * If the extension doesn't have a specific translation
       * for the string, fallback to the default translations.
       *
       * @param string $text
       *   Canonical message text (generally en_US).
       * @param array $params
       * @return string
       *   Translated text.
       * @see ts
       */
    
      public static function ts($text, $params = []) {
    
    mattwire's avatar
    mattwire committed
        if (!array_key_exists('domain', $params)) {
    
          $params['domain'] = [self::LONG_NAME, NULL];
    
    mattwire's avatar
    mattwire committed
        }
        return ts($text, $params);
      }
    
      /**
       * Get the URL of a resource file (in this extension).
       *
       * @param string|NULL $file
       *   Ex: NULL.
       *   Ex: 'css/foo.css'.
       * @return string
       *   Ex: 'http://example.org/sites/default/ext/org.example.foo'.
       *   Ex: 'http://example.org/sites/default/ext/org.example.foo/css/foo.css'.
       */
      public static function url($file = NULL) {
        if ($file === NULL) {
          return rtrim(CRM_Core_Resources::singleton()->getUrl(self::LONG_NAME), '/');
        }
        return CRM_Core_Resources::singleton()->getUrl(self::LONG_NAME, $file);
      }
    
      /**
       * Get the path of a resource file (in this extension).
       *
       * @param string|NULL $file
       *   Ex: NULL.
       *   Ex: 'css/foo.css'.
       * @return string
       *   Ex: '/var/www/example.org/sites/default/ext/org.example.foo'.
       *   Ex: '/var/www/example.org/sites/default/ext/org.example.foo/css/foo.css'.
       */
      public static function path($file = NULL) {
        // return CRM_Core_Resources::singleton()->getPath(self::LONG_NAME, $file);
        return __DIR__ . ($file === NULL ? '' : (DIRECTORY_SEPARATOR . $file));
      }
    
      /**
       * Get the name of a class within this extension.
       *
       * @param string $suffix
       *   Ex: 'Page_HelloWorld' or 'Page\\HelloWorld'.
       * @return string
       *   Ex: 'CRM_Foo_Page_HelloWorld'.
       */
      public static function findClass($suffix) {
        return self::CLASS_PREFIX . '_' . str_replace('\\', '_', $suffix);
      }
    
    }
    
    use CRM_Stripe_ExtensionUtil as E;
    
    
     * (Delegated) Implements hook_civicrm_config().
    
     * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config
    
     */
    function _stripe_civix_civicrm_config(&$config = NULL) {
      static $configured = FALSE;
    
      $configured = TRUE;
    
    
    mattwire's avatar
    mattwire committed
      $template = CRM_Core_Smarty::singleton();
    
    mattwire's avatar
    mattwire committed
      $extRoot = __DIR__ . DIRECTORY_SEPARATOR;
    
      $extDir = $extRoot . 'templates';
    
    
    mattwire's avatar
    mattwire committed
      if (is_array($template->template_dir)) {
        array_unshift($template->template_dir, $extDir);
    
        $template->template_dir = [$extDir, $template->template_dir];
    
    mattwire's avatar
    mattwire committed
      $include_path = $extRoot . PATH_SEPARATOR . get_include_path();
    
     * Implements hook_civicrm_install().
    
     * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install
    
     */
    function _stripe_civix_civicrm_install() {
      _stripe_civix_civicrm_config();
      if ($upgrader = _stripe_civix_upgrader()) {
    
    drastik's avatar
    drastik committed
        $upgrader->onInstall();
    
    mattwire's avatar
    mattwire committed
    /**
     * Implements hook_civicrm_postInstall().
     *
    
     * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall
    
    mattwire's avatar
    mattwire committed
     */
    function _stripe_civix_civicrm_postInstall() {
      _stripe_civix_civicrm_config();
      if ($upgrader = _stripe_civix_upgrader()) {
    
        if (is_callable([$upgrader, 'onPostInstall'])) {
    
    mattwire's avatar
    mattwire committed
          $upgrader->onPostInstall();
        }
      }
    }
    
    
     * Implements hook_civicrm_uninstall().
    
     * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall
    
     */
    function _stripe_civix_civicrm_uninstall() {
      _stripe_civix_civicrm_config();
      if ($upgrader = _stripe_civix_upgrader()) {
    
    drastik's avatar
    drastik committed
        $upgrader->onUninstall();
    
     * (Delegated) Implements hook_civicrm_enable().
    
     * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable
    
     */
    function _stripe_civix_civicrm_enable() {
      _stripe_civix_civicrm_config();
      if ($upgrader = _stripe_civix_upgrader()) {
    
        if (is_callable([$upgrader, 'onEnable'])) {
    
    drastik's avatar
    drastik committed
          $upgrader->onEnable();
    
     * (Delegated) Implements hook_civicrm_disable().
    
     * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable
    
    drastik's avatar
    drastik committed
     * @return mixed
    
     */
    function _stripe_civix_civicrm_disable() {
      _stripe_civix_civicrm_config();
      if ($upgrader = _stripe_civix_upgrader()) {
    
        if (is_callable([$upgrader, 'onDisable'])) {
    
    drastik's avatar
    drastik committed
          $upgrader->onDisable();
    
     * (Delegated) Implements hook_civicrm_upgrade().
    
     *
     * @param $op string, the type of operation being performed; 'check' or 'enqueue'
     * @param $queue CRM_Queue_Queue, (for 'enqueue') the modifiable list of pending up upgrade tasks
     *
    
    mattwire's avatar
    mattwire committed
     * @return mixed
     *   based on op. for 'check', returns array(boolean) (TRUE if upgrades are pending)
     *   for 'enqueue', returns void
    
     * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_upgrade
    
     */
    function _stripe_civix_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
      if ($upgrader = _stripe_civix_upgrader()) {
        return $upgrader->onUpgrade($op, $queue);
      }
    }
    
    
    drastik's avatar
    drastik committed
    /**
     * @return CRM_Stripe_Upgrader
     */
    
    function _stripe_civix_upgrader() {
    
    mattwire's avatar
    mattwire committed
      if (!file_exists(__DIR__ . '/CRM/Stripe/Upgrader.php')) {
    
        return NULL;
    
        return CRM_Stripe_Upgrader_Base::instance();
      }
    }
    
    
    drastik's avatar
    drastik committed
    /**
    
     * Inserts a navigation menu item at a given place in the hierarchy.
    
     * @param array $menu - menu hierarchy
    
     * @param string $path - path to parent of this item, e.g. 'my_extension/submenu'
     *    'Mailing', or 'Administer/System Settings'
     * @param array $item - the item to insert (parent/child attributes will be
     *    filled for you)
    
     *
     * @return bool
    
    mattwire's avatar
    mattwire committed
    function _stripe_civix_insert_navigation_menu(&$menu, $path, $item) {
    
    drastik's avatar
    drastik committed
      // If we are done going down the path, insert menu
      if (empty($path)) {
    
        $menu[] = [
          'attributes' => array_merge([
    
    drastik's avatar
    drastik committed
            'label'      => CRM_Utils_Array::value('name', $item),
            'active'     => 1,
    
          ], $item),
        ];
    
    mattwire's avatar
    mattwire committed
        return TRUE;
    
    drastik's avatar
    drastik committed
        // Find an recurse into the next level down
    
    mattwire's avatar
    mattwire committed
        $found = FALSE;
    
    drastik's avatar
    drastik committed
        $path = explode('/', $path);
        $first = array_shift($path);
        foreach ($menu as $key => &$entry) {
          if ($entry['attributes']['name'] == $first) {
    
    mattwire's avatar
    mattwire committed
            if (!isset($entry['child'])) {
    
              $entry['child'] = [];
    
            $found = _stripe_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item);
    
    mattwire's avatar
    mattwire committed
    /**
     * (Delegated) Implements hook_civicrm_navigationMenu().
     */
    function _stripe_civix_navigationMenu(&$nodes) {
    
      if (!is_callable(['CRM_Core_BAO_Navigation', 'fixNavigationMenu'])) {
    
    mattwire's avatar
    mattwire committed
        _stripe_civix_fixNavigationMenu($nodes);
      }
    }
    
    /**
     * Given a navigation menu, generate navIDs for any items which are
     * missing them.
     */
    function _stripe_civix_fixNavigationMenu(&$nodes) {
      $maxNavID = 1;
      array_walk_recursive($nodes, function($item, $key) use (&$maxNavID) {
        if ($key === 'navID') {
          $maxNavID = max($maxNavID, $item);
        }
      });
      _stripe_civix_fixNavigationMenuItems($nodes, $maxNavID, NULL);
    }
    
    function _stripe_civix_fixNavigationMenuItems(&$nodes, &$maxNavID, $parentID) {
      $origKeys = array_keys($nodes);
      foreach ($origKeys as $origKey) {
        if (!isset($nodes[$origKey]['attributes']['parentID']) && $parentID !== NULL) {
          $nodes[$origKey]['attributes']['parentID'] = $parentID;
        }
        // If no navID, then assign navID and fix key.
        if (!isset($nodes[$origKey]['attributes']['navID'])) {
          $newKey = ++$maxNavID;
          $nodes[$origKey]['attributes']['navID'] = $newKey;
          $nodes[$newKey] = $nodes[$origKey];
          unset($nodes[$origKey]);
          $origKey = $newKey;
        }
        if (isset($nodes[$origKey]['child']) && is_array($nodes[$origKey]['child'])) {
          _stripe_civix_fixNavigationMenuItems($nodes[$origKey]['child'], $maxNavID, $nodes[$origKey]['attributes']['navID']);
        }
      }
    }
    
    
    /**
     * (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 _stripe_civix_civicrm_entityTypes(&$entityTypes) {
    
    mattwire's avatar
    mattwire committed
      $entityTypes = array_merge($entityTypes, [
        'CRM_Stripe_DAO_StripePaymentintent' => [
    
          'name' => 'StripePaymentintent',
          'class' => 'CRM_Stripe_DAO_StripePaymentintent',
          'table' => 'civicrm_stripe_paymentintent',
    
    mattwire's avatar
    mattwire committed
        ],
      ]);