Hooks ()

Source file: app/src/Hooks.php

View source


Methods


Source

class Hooks
{

    /**
     *
     * @access public
     * @var object
     *
     */
    public $app;

    /**
     *
     * @access protected
     * @var string
     *
     */
    protected $_plugins_dir;

    /**
     *
     * @access protected
     * @var array
     *
     */
    protected $_filters = [];

    /**
     *
     * @access protected
     * @var string
     *
     */
    protected $_actions = [];

    /**
     *
     * @access protected
     * @var array
     *
     */
    protected $_merged_filters = [];

    /**
     *
     * @access protected
     * @var string
     *
     */
    protected $_current_filter = [];

    /**
     * all plugins header information in an array.
     *
     * @access protected
     * @var array
     */
    protected $_plugins_header = [];

    /**
     *
     * @access protected
     * @var string
     *
     */
    protected $_error = [];

    /**
     * __construct class constructor
     *
     * @access public
     * @since 1.0.1
     */
    public function __construct(\Liten\Liten $liten = null)
    {
        $this->app = !empty($liten) ? $liten : \Liten\Liten::getInstance();
    }

    /**
     * Returns the plugin header information
     *
     * @access public
     * @since 1.0.1
     * @param
     *            string (optional) $plugins_dir Loads plugins from specified folder
     * @return mixed
     *
     */
    public function get_plugins_header($plugins_dir = '')
    {
        if ($handle = opendir($plugins_dir)) {

            while ($file = readdir($handle)) {
                if (is_file($plugins_dir . $file)) {
                    if (strpos($plugins_dir . $file, '.plugin.php')) {
                        $fp = fopen($plugins_dir . $file, 'r');
                        // Pull only the first 8kiB of the file in.
                        $plugin_data = fread($fp, 8192);
                        fclose($fp);

                        preg_match('|Plugin Name:(.*)$|mi', $plugin_data, $name);
                        preg_match('|Plugin URI:(.*)$|mi', $plugin_data, $uri);
                        preg_match('|Version:(.*)|i', $plugin_data, $version);
                        preg_match('|Description:(.*)$|mi', $plugin_data, $description);
                        preg_match('|Author:(.*)$|mi', $plugin_data, $author_name);
                        preg_match('|Author URI:(.*)$|mi', $plugin_data, $author_uri);
                        preg_match('|Plugin Slug:(.*)$|mi', $plugin_data, $plugin_slug);

                        foreach (array(
                        'name',
                        'uri',
                        'version',
                        'description',
                        'author_name',
                        'author_uri',
                        'plugin_slug'
                        ) as $field) {
                            if (!empty(${$field}))
                                ${$field} = trim(${$field}[1]);
                            else
                                ${$field} = '';
                        }
                        $plugin_data = array(
                            'filename' => $file,
                            'Name' => $name,
                            'Title' => $name,
                            'PluginURI' => $uri,
                            'Description' => $description,
                            'Author' => $author_name,
                            'AuthorURI' => $author_uri,
                            'Version' => $version
                        );
                        $this->_plugins_header[] = $plugin_data;
                    }
                } else
                if ((is_dir($plugins_dir . $file)) && ($file != '.') && ($file != '..')) {
                    $this->get_plugins_header($plugins_dir . $file . '/');
                }
            }

            closedir($handle);
        }
        return $this->_plugins_header;
    }

    /**
     * Activates a specific plugin that is called by $_GET['id'] variable.
     *
     * @access public
     * @since 1.0.1
     * @param string $plugin
     *            ID of the plugin to activate
     * @return mixed
     *
     */
    public function activate_plugin($plugin)
    {
        try {
            $this->app->db->plugin()->insert([
                'location' => $plugin
            ]);
        } catch (NotFoundException $e) {
            Cascade::getLogger('error')->error(sprintf('SQLSTATE[%s]: Error: %s', $e->getCode(), $e->getMessage()));
            _etsis_flash()->error(_etsis_flash()->notice(409));
        } catch (ORMException $e) {
            Cascade::getLogger('error')->error(sprintf('SQLSTATE[%s]: Error: %s', $e->getCode(), $e->getMessage()));
            _etsis_flash()->error(_etsis_flash()->notice(409));
        } catch (Exception $e) {
            Cascade::getLogger('error')->error(sprintf('SQLSTATE[%s]: Error: %s', $e->getCode(), $e->getMessage()));
            _etsis_flash()->error(_etsis_flash()->notice(409));
        }
    }

    /**
     * Deactivates a specific plugin that is called by $_GET['id'] variable.
     *
     * @access public
     * @since 1.0.1
     * @param string $plugin
     *            ID of the plugin to deactivate.
     *            
     */
    public function deactivate_plugin($plugin)
    {
        try {
            $this->app->db->plugin()
                ->where('location = ?', $plugin)
                ->delete();
        } catch (NotFoundException $e) {
            Cascade::getLogger('error')->error(sprintf('SQLSTATE[%s]: Error: %s', $e->getCode(), $e->getMessage()));
            _etsis_flash()->error(_etsis_flash()->notice(409));
        } catch (ORMException $e) {
            Cascade::getLogger('error')->error(sprintf('SQLSTATE[%s]: Error: %s', $e->getCode(), $e->getMessage()));
            _etsis_flash()->error(_etsis_flash()->notice(409));
        } catch (Exception $e) {
            Cascade::getLogger('error')->error(sprintf('SQLSTATE[%s]: Error: %s', $e->getCode(), $e->getMessage()));
            _etsis_flash()->error(_etsis_flash()->notice(409));
        }
    }

    /**
     * Loads all activated plugin for inclusion.
     *
     * @access public
     * @since 1.0.1
     * @param
     *            string (optional) $plugins_dir Loads plugins from specified folder
     * @return mixed
     */
    public function load_activated_plugins($plugins_dir)
    {
        try {
            $plugin = $this->app->db->plugin();
            $q = $plugin->find();

            foreach ($q as $v) {
                $pluginFile = _h($v->location);
                $plugin = str_replace('.plugin.php', '', $pluginFile);

                if (!etsis_file_exists($plugins_dir . $plugin . DS . $pluginFile, false)) {
                    $file = $plugins_dir . $pluginFile;
                } else {
                    $file = $plugins_dir . $plugin . DS . $pluginFile;
                }

                $error = etsis_php_check_syntax($file);
                if (is_etsis_exception($error)) {
                    $this->deactivate_plugin(_h($v->location));
                    _etsis_flash()->error(sprintf(_t('The plugin <strong>%s</strong> has been deactivated because your changes resulted in a <strong>fatal error</strong>. <br /><br />') . $error->getMessage(), _h($v->location)));
                    return false;
                }

                if (etsis_file_exists($file, false)) {
                    require_once ($file);
                } else {
                    $this->deactivate_plugin(_h($v->location));
                }
            }
        } catch (NotFoundException $e) {
            Cascade::getLogger('error')->error(sprintf('SQLSTATE[%s]: Error: %s', $e->getCode(), $e->getMessage()));
            _etsis_flash()->error(_etsis_flash()->notice(409));
        } catch (ORMException $e) {
            Cascade::getLogger('error')->error(sprintf('SQLSTATE[%s]: Error: %s', $e->getCode(), $e->getMessage()));
            _etsis_flash()->error(_etsis_flash()->notice(409));
        } catch (Exception $e) {
            Cascade::getLogger('error')->error(sprintf('SQLSTATE[%s]: Error: %s', $e->getCode(), $e->getMessage()));
            _etsis_flash()->error(_etsis_flash()->notice(409));
        }
    }

    /**
     * Checks if a particular plugin is activated
     *
     * @since 1.0.1
     * @return mixed
     *
     */
    public function is_plugin_activated($plugin)
    {
        try {
            $active = $this->app->db->plugin()->where('location = ?', $plugin);
            $q = $active->find(function ($data) {
                $array = [];
                foreach ($data as $d) {
                    $array[] = $d;
                }
                return $array;
            });

            if (count($q) > 0)
                return true;
            return false;
        } catch (NotFoundException $e) {
            Cascade::getLogger('error')->error(sprintf('SQLSTATE[%s]: Error: %s', $e->getCode(), $e->getMessage()));
            _etsis_flash()->error(_etsis_flash()->notice(409));
        } catch (ORMException $e) {
            Cascade::getLogger('error')->error(sprintf('SQLSTATE[%s]: Error: %s', $e->getCode(), $e->getMessage()));
            _etsis_flash()->error(_etsis_flash()->notice(409));
        } catch (Exception $e) {
            Cascade::getLogger('error')->error(sprintf('SQLSTATE[%s]: Error: %s', $e->getCode(), $e->getMessage()));
            _etsis_flash()->error(_etsis_flash()->notice(409));
        }
    }

    /**
     * Registers a filtering function
     *
     * Typical use: hooks::add_filter('some_hook', 'function_handler_for_hook');
     *
     * @access public
     * @since 1.0.1
     * @global array $filters Storage for all of the filters
     * @param string $hook
     *            the name of the PM element to be filtered or PM action to be triggered
     * @param callback $function
     *            the name of the function that is to be called.
     * @param integer $priority
     *            optional. Used to specify the order in which the functions associated with a particular action are executed (default=10, lower=earlier execution, and functions with the same priority are executed in the order in which they were added to the filter)
     * @param int $accepted_args
     *            optional. The number of arguments the function accept (default is the number provided).
     */
    public function add_filter($hook, $function_to_add, $priority = 10, $accepted_args = 1)
    {

        // At this point, we cannot check if the function exists, as it may well be defined later (which is OK)
        $id = $this->filter_unique_id($hook, $function_to_add, $priority);

        $this->_filters[$hook][$priority][$id] = [
            'function' => $function_to_add,
            'accepted_args' => $accepted_args
        ];
        unset($this->_merged_filters[$hook]);
        return true;
    }

    /**
     * add_action
     * Adds a hook
     *
     * @access public
     * @since 1.0.1
     * @param string $hook            
     * @param string $function            
     * @param integer $priority
     *            (optional)
     * @param integer $accepted_args
     *            (optional)
     *            
     */
    public function add_action($hook, $function_to_add, $priority = 10, $accepted_args = 1)
    {
        return $this->add_filter($hook, $function_to_add, $priority, $accepted_args);
    }

    /**
     * remove_action Removes a function from a specified action hook.
     *
     * @access public
     * @since 1.0.1
     * @param string $hook
     *            The action hook to which the function to be removed is hooked.
     * @param callback $function_to_remove
     *            The name of the function which should be removed.
     * @param int $priority
     *            optional The priority of the function (default: 10).
     * @return boolean Whether the function is removed.
     */
    public function remove_action($hook, $function_to_remove, $priority = 10)
    {
        return $this->remove_filter($hook, $function_to_remove, $priority);
    }

    /**
     * remove_all_actions Remove all of the hooks from an action.
     *
     * @access public
     * @since 1.0.1
     * @param string $hook
     *            The action to remove hooks from.
     * @param int $priority
     *            The priority number to remove them from.
     * @return bool True when finished.
     */
    public function remove_all_actions($hook, $priority = false)
    {
        return $this->remove_all_filters($hook, $priority);
    }

    /**
     * Build Unique ID for storage and retrieval.
     *
     * Simply using a function name is not enough, as several functions can have the same name when they are enclosed in classes.
     *
     * @access public
     * @since 1.0.1
     * @param string $hook            
     * @param string|array $function
     *            used for creating unique id
     * @param int|bool $priority
     *            used in counting how many hooks were applied. If === false and $function is an object reference, we return the unique id only if it already has one, false otherwise.
     * @return string unique ID for usage as array key
     */
    public function filter_unique_id($hook, $function, $priority)
    {
        static $filter_id_count = 0;

        // If function then just skip all of the tests and not overwrite the following.
        if (is_string($function))
            return $function;
        if (is_object($function)) {
            // Closures are currently implemented as objects
            $function = array(
                $function,
                ''
            );
        } else {
            $function = (array) $function;
        }

        if (is_object($function[0])) {
            // Object Class Calling
            if (function_exists('spl_object_hash')) {
                return spl_object_hash($function[0]) . $function[1];
            } else {
                $obj_idx = get_class($function[0]) . $function[1];
                if (!isset($function[0]->_filters_id)) {
                    if (false === $priority)
                        return false;
                    $obj_idx .= isset($this->_filters[$hook][$priority]) ? count((array) $this->_filters[$hook][$priority]) : $filter_id_count;
                    $function[0]->_filters_id = $filter_id_count;
                    ++$filter_id_count;
                } else {
                    $obj_idx .= $function[0]->_filters_id;
                }

                return $obj_idx;
            }
        } else
        if (is_string($function[0])) {
            // Static Calling
            return $function[0] . '::' . $function[1];
        }
    }

    /**
     * Performs a filtering operation on a PM element or event.
     *
     * Typical use:
     *
     * 1) Modify a variable if a function is attached to hook 'hook'
     * $var = "default value";
     * $var = hooks::apply_filter( 'hook', $var );
     *
     * 2) Trigger functions is attached to event 'pm_event'
     * hooks::apply_filter( 'event' );
     * (see hooks::do_action() )
     *
     * Returns an element which may have been filtered by a filter.
     *
     * @access public
     * @since 1.0.1
     * @global array $filters storage for all of the filters
     * @param string $hook
     *            the name of the the element or action
     * @param mixed $value
     *            the value of the element before filtering
     * @return mixed
     */
    public function apply_filter($hook, $value)
    {
        $args = [];

        if (isset($this->_filters['all'])) {
            $this->_current_filter[] = $hook;
            $args = func_get_args();
            $this->_call_all_hook($args);
        }

        if (!isset($this->_filters[$hook])) {
            if (isset($this->_filters['all']))
                array_pop($this->_current_filter);
            return $value;
        }

        if (!isset($this->_filters['all'])) {
            $this->_current_filter[] = $hook;
        }

        if (!isset($this->_merged_filters[$hook])) {
            ksort($this->_filters[$hook]);
            $this->_merged_filters[$hook] = true;
        }

        // Loops through each filter
        reset($this->_filters[$hook]);

        if (empty($args)) {
            $args = func_get_args();
        }

        do {
            foreach ((array) current($this->_filters[$hook]) as $the_)
                if (!is_null($the_['function'])) {
                    $args[1] = $value;
                    $value = call_user_func_array($the_['function'], array_slice($args, 1, (int) $the_['accepted_args']));
                }
        } while (next($this->_filters[$hook]) !== false);

        array_pop($this->_current_filter);

        return $value;
    }

    public function do_action($hook, $arg = '')
    {
        if (!isset($this->_actions))
            $this->_actions = [];

        if (!isset($this->_actions[$hook]))
            $this->_actions[$hook] = 1;
        else
            ++$this->_actions[$hook];

        // Do 'all' actions first
        if (isset($this->_filters['all'])) {
            $this->_current_filter[] = $hook;
            $all_args = func_get_args();
            $this->_call_all_hook($all_args);
        }

        if (!isset($this->_filters[$hook])) {
            if (isset($this->_filters['all']))
                array_pop($this->_current_filter);
            return;
        }

        if (!isset($this->_filters['all']))
            $this->_current_filter[] = $hook;

        $args = [];
        if (is_array($arg) && 1 == count($arg) && isset($arg[0]) && is_object($arg[0])) // array(&$this)
            $args[] = & $arg[0];
        else
            $args[] = $arg;
        for ($a = 2; $a < func_num_args(); $a ++)
            $args[] = func_get_arg($a);

        // Sort
        if (!isset($this->_merged_filters[$hook])) {
            ksort($this->_filters[$hook]);
            $this->_merged_filters[$hook] = true;
        }

        reset($this->_filters[$hook]);

        do {
            foreach ((array) current($this->_filters[$hook]) as $the_)
                if (!is_null($the_['function']))
                    call_user_func_array($the_['function'], array_slice($args, 0, (int) $the_['accepted_args']));
        } while (next($this->_filters[$hook]) !== false);

        array_pop($this->_current_filter);
    }

    public function _call_all_hook($args)
    {
        reset($this->_filters['all']);
        do {
            foreach ((array) current($this->_filters['all']) as $the_)
                if (!is_null($the_['function']))
                    call_user_func_array($the_['function'], $args);
        } while (next($this->_filters['all']) !== false);
    }

    public function do_action_array($hook, $args)
    {
        if (!isset($this->_actions))
            $this->_actions = [];

        if (!isset($this->_actions[$hook]))
            $this->_actions[$hook] = 1;
        else
            ++$this->_actions[$hook];

        // Do 'all' actions first
        if (isset($this->_filters['all'])) {
            $this->_current_filter[] = $hook;
            $all_args = func_get_args();
            $this->_call_all_hook($all_args);
        }

        if (!isset($this->_filters[$hook])) {
            if (isset($this->_filters['all']))
                array_pop($this->_current_filter);
            return;
        }

        if (!isset($this->_filters['all']))
            $this->_current_filter[] = $hook;

        // Sort
        if (!isset($this->_merged_filters[$hook])) {
            ksort($this->_filters[$hook]);
            $this->_merged_filters[$hook] = true;
        }

        reset($this->_filters[$hook]);

        do {
            foreach ((array) current($this->_filters[$hook]) as $the_)
                if (!is_null($the_['function']))
                    call_user_func_array($the_['function'], array_slice($args, 0, (int) $the_['accepted_args']));
        } while (next($this->_filters[$hook]) !== false);

        array_pop($this->_current_filter);
    }

    /**
     * Removes a function from a specified filter hook.
     *
     * This function removes a function attached to a specified filter hook. This
     * method can be used to remove default functions attached to a specific filter
     * hook and possibly replace them with a substitute.
     *
     * To remove a hook, the $function_to_remove and $priority arguments must match
     * when the hook was added.
     *
     * @global array $filters storage for all of the filters
     * @param string $hook
     *            The filter hook to which the function to be removed is hooked.
     * @param callback $function_to_remove
     *            The name of the function which should be removed.
     * @param int $priority
     *            optional. The priority of the function (default: 10).
     * @param int $accepted_args
     *            optional. The number of arguments the function accepts (default: 1).
     * @return boolean Whether the function was registered as a filter before it was removed.
     */
    public function remove_filter($hook, $function_to_remove, $priority = 10)
    {
        $function_to_remove = $this->filter_unique_id($hook, $function_to_remove, $priority);

        $remove = isset($this->_filters[$hook][$priority][$function_to_remove]);

        if (true === $remove) {
            unset($this->_filters[$hook][$priority][$function_to_remove]);
            if (empty($this->_filters[$hook][$priority]))
                unset($this->_filters[$hook][$priority]);
            unset($this->_merged_filters[$hook]);
        }
        return $remove;
    }

    /**
     * remove_all_filters Remove all of the hooks from a filter.
     *
     * @access public
     * @since 1.0.1
     * @param string $hook
     *            The filter to remove hooks from.
     * @param int $priority
     *            The priority number to remove.
     * @return bool True when finished.
     */
    public function remove_all_filters($hook, $priority = false)
    {
        if (isset($this->_filters[$hook])) {
            if (false !== $priority && isset($this->_filters[$hook][$priority]))
                unset($this->_filters[$hook][$priority]);
            else
                unset($this->_filters[$hook]);
        }

        if (isset($this->_merged_filters[$hook]))
            unset($this->_merged_filters[$hook]);

        return true;
    }

    /**
     * Check if any filter has been registered for a hook.
     *
     * @global array $filters storage for all of the filters
     * @param string $hook
     *            The name of the filter hook.
     * @param callback $function_to_check
     *            optional. If specified, return the priority of that function on this hook or false if not attached.
     * @return int|boolean Optionally returns the priority on that hook for the specified function.
     */
    public function has_filter($hook, $function_to_check = false)
    {
        $has = !empty($this->_filters[$hook]);
        if (false === $function_to_check || false == $has) {
            return $has;
        }
        if (!$idx = $this->filter_unique_id($hook, $function_to_check, false)) {
            return false;
        }

        foreach ((array) array_keys($this->_filters[$hook]) as $priority) {
            if (isset($this->_filters[$hook][$priority][$idx]))
                return $priority;
        }
        return false;
    }

    public function has_action($hook, $function_to_check = false)
    {
        return $this->has_filter($hook, $function_to_check);
    }

    /**
     * Display list of links to plugin admin pages, if any
     */
    public function list_plugin_admin_pages($url)
    {
        if (!property_exists($this->app->hook, 'plugin_pages') || !$this->app->hook->plugin_pages)
            return;

        foreach ((array) $this->app->hook->plugin_pages as $page) {
            echo '<li><a href="' . $url . '?page=' . $page['slug'] . '">' . $page['title'] . '</a></li>' . "\n";
        }
    }

    /**
     * Register a plugin administration page
     *
     * @param string $slug            
     * @param string $title            
     * @param string $function            
     */
    public function register_admin_page($slug, $title, $function)
    {
        if (!property_exists($this->app->hook, 'plugin_pages') || !$this->app->hook->plugin_pages)
            $this->app->hook->plugin_pages = [];

        $this->app->hook->plugin_pages[$slug] = [
            'slug' => $slug,
            'title' => $title,
            'function' => $function
        ];
    }

    /**
     * Handle plugin administration page
     *
     * @param string $plugin_page            
     */
    public function plugin_admin_page($plugin_page)
    {

        // Check the plugin page is actually registered
        if (!isset($this->app->hook->plugin_pages[$plugin_page])) {
            die('This page does not exist. Maybe a plugin you thought was activated is inactive?');
        }

        // Draw the page itself
        $this->do_action('load-' . $plugin_page);

        call_user_func($this->app->hook->plugin_pages[$plugin_page]['function']);
    }

    /**
     * Read an option from options_meta.
     * Return value or $default if not found
     */
    public function get_option($meta_key, $default = false)
    {
        $meta_key = trim($meta_key);
        if (empty($meta_key)) {
            return false;
        }

        /**
         * Filter the value of an existing option before it is retrieved.
         *
         * The dynamic portion of the hook name, `$meta_key`, refers to the meta_key name.
         *
         * Passing a truthy value to the filter will short-circuit retrieving
         * the option value, returning the passed value instead.
         *
         * @since 1.0.0
         *       
         * @param bool|mixed $pre_option
         *            Value to return instead of the option value.
         *            Default false to skip it.
         * @param string $meta_key
         *            Meta key name.
         */
        $pre = $this->apply_filter('pre_option_' . $meta_key, false);

        if (false !== $pre) {
            return $pre;
        }

        if (!isset($this->app->db->option[$meta_key])) {
            try {
                $meta = $this->app->db->options_meta();
                $q = $meta->select('meta_value')->where('meta_key = ?', $meta_key);

                $results = etsis_cache_get($meta_key, 'option');
                if (empty($results)) {
                    $results = $q->find(function ($data) {
                        foreach ($data as $d) {
                            return $d['meta_value'];
                        }
                    });
                    etsis_cache_add($meta_key, $results, 'option');
                }

                if (is_object($q)) {
                    $value = $results;
                    return $value;
                } else { // option does not exist, so we must cache its non-existence
                    $value = $default;
                    return $value;
                }
                $this->app->db->option[$meta_key] = $this->maybe_unserialize($value);
            } catch (NotFoundException $e) {
                Cascade::getLogger('error')->error(sprintf('SQLSTATE[%s]: Error: %s', $e->getCode(), $e->getMessage()));
                _etsis_flash()->error(_etsis_flash()->notice(409));
            } catch (Exception $e) {
                Cascade::getLogger('error')->error(sprintf('SQLSTATE[%s]: Error: %s', $e->getCode(), $e->getMessage()));
                _etsis_flash()->error(_etsis_flash()->notice(409));
            } catch (ORMException $e) {
                Cascade::getLogger('error')->error(sprintf('SQLSTATE[%s]: Error: %s', $e->getCode(), $e->getMessage()));
                _etsis_flash()->error(_etsis_flash()->notice(409));
            }
        }
        /**
         * Filter the value of an existing option.
         *
         * The dynamic portion of the hook name, `$meta_key`, refers to the option name.
         *
         * @since 1.0.0 As 'get_option_' . $setting
         *       
         * @param mixed $value
         *            Value of the option. If stored serialized, it will be
         *            unserialized prior to being returned.
         * @param string $this->app->db->option[$meta_key]
         *            Option name.
         */
        return $this->apply_filter('get_option_' . $meta_key, $this->app->db->option[$meta_key]);
    }

    /**
     * Update (add if doesn't exist) an option to options_meta
     */
    public function update_option($meta_key, $newvalue)
    {
        $oldvalue = $this->get_option($meta_key);

        // If the new and old values are the same, no need to update.
        if ($newvalue === $oldvalue) {
            return false;
        }

        if (null === $oldvalue) {
            $this->add_option($meta_key, $newvalue);
            return true;
        }

        $_newvalue = $this->maybe_serialize($newvalue);

        etsis_cache_delete($meta_key, 'option');
        
        $this->do_action('update_option', $meta_key, $oldvalue, $newvalue);
        try {            
            $key = $this->app->db->options_meta();
            $key->meta_value = $_newvalue;
            $key->where('meta_key = ?', $meta_key)->update();

            if (count($key) > 0) {
                $this->app->db->option[$meta_key] = $newvalue;
            }
        } catch (NotFoundException $e) {
            Cascade::getLogger('error')->error(sprintf('SQLSTATE[%s]: Error: %s', $e->getCode(), $e->getMessage()));
            _etsis_flash()->error(_etsis_flash()->notice(409));
        } catch (ORMException $e) {
            Cascade::getLogger('error')->error(sprintf('SQLSTATE[%s]: Error: %s', $e->getCode(), $e->getMessage()));
            _etsis_flash()->error(_etsis_flash()->notice(409));
        } catch (Exception $e) {
            Cascade::getLogger('error')->error(sprintf('SQLSTATE[%s]: Error: %s', $e->getCode(), $e->getMessage()));
            _etsis_flash()->error(_etsis_flash()->notice(409));
        }
    }

    /**
     * Add an option to the table
     */
    public function add_option($name, $value = '')
    {
        // Make sure the option doesn't already exist
        if (null !== $this->get_option($name)) {
            return;
        }

        $_value = $this->maybe_serialize($value);
        
        etsis_cache_delete($name, 'option');

        $this->do_action('add_option', $name, $_value);
        try {            
            $this->app->db->options_meta()->insert([
                'meta_key' => $name,
                'meta_value' => $_value
            ]);
            $this->app->db->option[$name] = $value;
            return;
        } catch (NotFoundException $e) {
            Cascade::getLogger('error')->error(sprintf('SQLSTATE[%s]: Error: %s', $e->getCode(), $e->getMessage()));
            _etsis_flash()->error(_etsis_flash()->notice(409));
        } catch (ORMException $e) {
            Cascade::getLogger('error')->error(sprintf('SQLSTATE[%s]: Error: %s', $e->getCode(), $e->getMessage()));
            _etsis_flash()->error(_etsis_flash()->notice(409));
        } catch (Exception $e) {
            Cascade::getLogger('error')->error(sprintf('SQLSTATE[%s]: Error: %s', $e->getCode(), $e->getMessage()));
            _etsis_flash()->error(_etsis_flash()->notice(409));
        }
    }

    /**
     * Delete an option from the table
     */
    public function delete_option($name)
    {
        try {
            $key = $this->app->db->options_meta()->where('meta_key = ?', $name);
            $results = $key->find(function ($data) {
                $array = [];
                foreach ($data as $d) {
                    $array[] = $d;
                }
                return $array;
            });

            if (is_null($results) || !$results) {
                return false;
            }

            etsis_cache_delete($name, 'option');
            
            $this->do_action('delete_option', $name);

            $this->app->db->options_meta()
                ->where('meta_key', $name)
                ->delete();
            return true;
        } catch (NotFoundException $e) {
            Cascade::getLogger('error')->error(sprintf('SQLSTATE[%s]: Error: %s', $e->getCode(), $e->getMessage()));
            _etsis_flash()->error(_etsis_flash()->notice(409));
        } catch (ORMException $e) {
            Cascade::getLogger('error')->error(sprintf('SQLSTATE[%s]: Error: %s', $e->getCode(), $e->getMessage()));
            _etsis_flash()->error(_etsis_flash()->notice(409));
        } catch (Exception $e) {
            Cascade::getLogger('error')->error(sprintf('SQLSTATE[%s]: Error: %s', $e->getCode(), $e->getMessage()));
            _etsis_flash()->error(_etsis_flash()->notice(409));
        }
    }

    // Serialize data if needed. Stolen from WordPress
    public function maybe_serialize($data)
    {
        if (is_array($data) || is_object($data))
            return serialize($data);

        if ($this->is_serialized($data))
            return serialize($data);

        return $data;
    }

    // Check value to find if it was serialized. Stolen from WordPress
    public function is_serialized($data)
    {
        // if it isn't a string, it isn't serialized
        if (!is_string($data))
            return false;
        $data = trim($data);
        if ('N;' == $data)
            return true;
        if (!preg_match('/^([adObis]):/', $data, $badions))
            return false;
        switch ($badions[1]) {
            case 'a':
            case 'O':
            case 's':
                if (preg_match("/^{$badions[1]}:[0-9]+:.*[;}]\$/s", $data))
                    return true;
                break;
            case 'b':
            case 'i':
            case 'd':
                if (preg_match("/^{$badions[1]}:[0-9.E-]+;\$/", $data))
                    return true;
                break;
        }
        return false;
    }

    // Unserialize value only if it was serialized. Stolen from WP
    public function maybe_unserialize($original)
    {
        if ($this->is_serialized($original)) // don't attempt to unserialize data that wasn't serialized going in
            return unserialize($original);
        return $original;
    }
}

User Contributed Notes

You must log in before being able to contribute a note.