easy_opt_out.civix.php

<?php

// AUTO-GENERATED FILE -- Civix may overwrite any changes made to this file

/**
 * The ExtensionUtil class provides small stubs for accessing resources of this
 * extension.
 */
class CRM_EasyOptOut_ExtensionUtil
{
    const SHORT_NAME = 'easy_opt_out';
    const LONG_NAME = 'easy-opt-out';
    const CLASS_PREFIX = 'CRM_EasyOptOut';

    /**
     * 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 = [])
    {
        if (!array_key_exists('domain', $params)) {
            $params['domain'] = [self::LONG_NAME, null];
        }
        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_EasyOptOut_ExtensionUtil as E;

/**
 * (Delegated) Implements hook_civicrm_config().
 *
 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config
 */
function _easy_opt_out_civix_civicrm_config(&$config = null)
{
    static $configured = false;
    if ($configured) {
        return;
    }
    $configured = true;

    $template =& CRM_Core_Smarty::singleton();

    $extRoot = dirname(__FILE__) . DIRECTORY_SEPARATOR;
    $extDir = $extRoot . 'templates';

    if (is_array($template->template_dir)) {
        array_unshift($template->template_dir, $extDir);
    } else {
        $template->template_dir = [$extDir, $template->template_dir];
    }

    $include_path = $extRoot . PATH_SEPARATOR . get_include_path();
    set_include_path($include_path);
}

/**
 * (Delegated) Implements hook_civicrm_xmlMenu().
 *
 * @param $files array(string)
 *
 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_xmlMenu
 */
function _easy_opt_out_civix_civicrm_xmlMenu(&$files)
{
    foreach (_easy_opt_out_civix_glob(__DIR__ . '/xml/Menu/*.xml') as $file) {
        $files[] = $file;
    }
}

/**
 * Implements hook_civicrm_install().
 *
 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install
 */
function _easy_opt_out_civix_civicrm_install()
{
    _easy_opt_out_civix_civicrm_config();
    if ($upgrader = _easy_opt_out_civix_upgrader()) {
        $upgrader->onInstall();
    }
}

/**
 * Implements hook_civicrm_postInstall().
 *
 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall
 */
function _easy_opt_out_civix_civicrm_postInstall()
{
    _easy_opt_out_civix_civicrm_config();
    if ($upgrader = _easy_opt_out_civix_upgrader()) {
        if (is_callable([$upgrader, 'onPostInstall'])) {
            $upgrader->onPostInstall();
        }
    }
}

/**
 * Implements hook_civicrm_uninstall().
 *
 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall
 */
function _easy_opt_out_civix_civicrm_uninstall()
{
    _easy_opt_out_civix_civicrm_config();
    if ($upgrader = _easy_opt_out_civix_upgrader()) {
        $upgrader->onUninstall();
    }
}

/**
 * (Delegated) Implements hook_civicrm_enable().
 *
 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable
 */
function _easy_opt_out_civix_civicrm_enable()
{
    _easy_opt_out_civix_civicrm_config();
    if ($upgrader = _easy_opt_out_civix_upgrader()) {
        if (is_callable([$upgrader, 'onEnable'])) {
            $upgrader->onEnable();
        }
    }
}

/**
 * (Delegated) Implements hook_civicrm_disable().
 *
 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable
 * @return mixed
 */
function _easy_opt_out_civix_civicrm_disable()
{
    _easy_opt_out_civix_civicrm_config();
    if ($upgrader = _easy_opt_out_civix_upgrader()) {
        if (is_callable([$upgrader, 'onDisable'])) {
            $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
 *
 * @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 _easy_opt_out_civix_civicrm_upgrade($op, CRM_Queue_Queue $queue = null)
{
    if ($upgrader = _easy_opt_out_civix_upgrader()) {
        return $upgrader->onUpgrade($op, $queue);
    }
}

/**
 * @return CRM_EasyOptOut_Upgrader
 */
function _easy_opt_out_civix_upgrader()
{
    if (!file_exists(__DIR__ . '/CRM/EasyOptOut/Upgrader.php')) {
        return null;
    } else {
        return CRM_EasyOptOut_Upgrader_Base::instance();
    }
}

/**
 * Search directory tree for files which match a glob pattern.
 *
 * Note: Dot-directories (like "..", ".git", or ".svn") will be ignored.
 * Note: In Civi 4.3+, delegate to CRM_Utils_File::findFiles()
 *
 * @param string $dir base dir
 * @param string $pattern , glob pattern, eg "*.txt"
 *
 * @return array
 */
function _easy_opt_out_civix_find_files($dir, $pattern)
{
    if (is_callable(['CRM_Utils_File', 'findFiles'])) {
        return CRM_Utils_File::findFiles($dir, $pattern);
    }

    $todos = [$dir];
    $result = [];
    while (!empty($todos)) {
        $subdir = array_shift($todos);
        foreach (_easy_opt_out_civix_glob("$subdir/$pattern") as $match) {
            if (!is_dir($match)) {
                $result[] = $match;
            }
        }
        if ($dh = opendir($subdir)) {
            while (false !== ($entry = readdir($dh))) {
                $path = $subdir . DIRECTORY_SEPARATOR . $entry;
                if ($entry[0] == '.') {
                } elseif (is_dir($path)) {
                    $todos[] = $path;
                }
            }
            closedir($dh);
        }
    }
    return $result;
}

/**
 * (Delegated) Implements hook_civicrm_managed().
 *
 * Find any *.mgd.php files, merge their content, and return.
 *
 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_managed
 */
function _easy_opt_out_civix_civicrm_managed(&$entities)
{
    $mgdFiles = _easy_opt_out_civix_find_files(__DIR__, '*.mgd.php');
    sort($mgdFiles);
    foreach ($mgdFiles as $file) {
        $es = include $file;
        foreach ($es as $e) {
            if (empty($e['module'])) {
                $e['module'] = E::LONG_NAME;
            }
            if (empty($e['params']['version'])) {
                $e['params']['version'] = '3';
            }
            $entities[] = $e;
        }
    }
}

/**
 * (Delegated) Implements hook_civicrm_caseTypes().
 *
 * Find any and return any files matching "xml/case/*.xml"
 *
 * Note: This hook only runs in CiviCRM 4.4+.
 *
 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_caseTypes
 */
function _easy_opt_out_civix_civicrm_caseTypes(&$caseTypes)
{
    if (!is_dir(__DIR__ . '/xml/case')) {
        return;
    }

    foreach (_easy_opt_out_civix_glob(__DIR__ . '/xml/case/*.xml') as $file) {
        $name = preg_replace('/\.xml$/', '', basename($file));
        if ($name != CRM_Case_XMLProcessor::mungeCaseType($name)) {
            $errorMessage = sprintf("Case-type file name is malformed (%s vs %s)", $name, CRM_Case_XMLProcessor::mungeCaseType($name));
            throw new CRM_Core_Exception($errorMessage);
        }
        $caseTypes[$name] = [
      'module' => E::LONG_NAME,
      'name' => $name,
      'file' => $file,
    ];
    }
}

/**
 * (Delegated) Implements hook_civicrm_angularModules().
 *
 * Find any and return any files matching "ang/*.ang.php"
 *
 * Note: This hook only runs in CiviCRM 4.5+.
 *
 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_angularModules
 */
function _easy_opt_out_civix_civicrm_angularModules(&$angularModules)
{
    if (!is_dir(__DIR__ . '/ang')) {
        return;
    }

    $files = _easy_opt_out_civix_glob(__DIR__ . '/ang/*.ang.php');
    foreach ($files as $file) {
        $name = preg_replace(':\.ang\.php$:', '', basename($file));
        $module = include $file;
        if (empty($module['ext'])) {
            $module['ext'] = E::LONG_NAME;
        }
        $angularModules[$name] = $module;
    }
}

/**
 * (Delegated) Implements hook_civicrm_themes().
 *
 * Find any and return any files matching "*.theme.php"
 */
function _easy_opt_out_civix_civicrm_themes(&$themes)
{
    $files = _easy_opt_out_civix_glob(__DIR__ . '/*.theme.php');
    foreach ($files as $file) {
        $themeMeta = include $file;
        if (empty($themeMeta['name'])) {
            $themeMeta['name'] = preg_replace(':\.theme\.php$:', '', basename($file));
        }
        if (empty($themeMeta['ext'])) {
            $themeMeta['ext'] = E::LONG_NAME;
        }
        $themes[$themeMeta['name']] = $themeMeta;
    }
}

/**
 * Glob wrapper which is guaranteed to return an array.
 *
 * The documentation for glob() says, "On some systems it is impossible to
 * distinguish between empty match and an error." Anecdotally, the return
 * result for an empty match is sometimes array() and sometimes FALSE.
 * This wrapper provides consistency.
 *
 * @link http://php.net/glob
 * @param string $pattern
 *
 * @return array
 */
function _easy_opt_out_civix_glob($pattern)
{
    $result = glob($pattern);
    return is_array($result) ? $result : [];
}

/**
 * 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
 */
function _easy_opt_out_civix_insert_navigation_menu(&$menu, $path, $item)
{
    // If we are done going down the path, insert menu
    if (empty($path)) {
        $menu[] = [
      'attributes' => array_merge([
        'label'      => CRM_Utils_Array::value('name', $item),
        'active'     => 1,
      ], $item),
    ];
        return true;
    } else {
        // Find an recurse into the next level down
        $found = false;
        $path = explode('/', $path);
        $first = array_shift($path);
        foreach ($menu as $key => &$entry) {
            if ($entry['attributes']['name'] == $first) {
                if (!isset($entry['child'])) {
                    $entry['child'] = [];
                }
                $found = _easy_opt_out_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item);
            }
        }
        return $found;
    }
}

/**
 * (Delegated) Implements hook_civicrm_navigationMenu().
 */
function _easy_opt_out_civix_navigationMenu(&$nodes)
{
    if (!is_callable(['CRM_Core_BAO_Navigation', 'fixNavigationMenu'])) {
        _easy_opt_out_civix_fixNavigationMenu($nodes);
    }
}

/**
 * Given a navigation menu, generate navIDs for any items which are
 * missing them.
 */
function _easy_opt_out_civix_fixNavigationMenu(&$nodes)
{
    $maxNavID = 1;
    array_walk_recursive($nodes, function ($item, $key) use (&$maxNavID) {
        if ($key === 'navID') {
            $maxNavID = max($maxNavID, $item);
        }
    });
    _easy_opt_out_civix_fixNavigationMenuItems($nodes, $maxNavID, null);
}

function _easy_opt_out_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'])) {
            _easy_opt_out_civix_fixNavigationMenuItems($nodes[$origKey]['child'], $maxNavID, $nodes[$origKey]['attributes']['navID']);
        }
    }
}

/**
 * (Delegated) Implements hook_civicrm_alterSettingsFolders().
 *
 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_alterSettingsFolders
 */
function _easy_opt_out_civix_civicrm_alterSettingsFolders(&$metaDataFolders = null)
{
    $settingsDir = __DIR__ . DIRECTORY_SEPARATOR . 'settings';
    if (!in_array($settingsDir, $metaDataFolders) && is_dir($settingsDir)) {
        $metaDataFolders[] = $settingsDir;
    }
}

/**
 * (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 _easy_opt_out_civix_civicrm_entityTypes(&$entityTypes)
{
    $entityTypes = array_merge($entityTypes, []);
}