File "BaseTrait.php"

Full Path: /home/rubycabfbt/www/wp-content/plugins/advanced-access-manager/application/Framework/Preference/BaseTrait.php
File size: 8.79 KB
MIME-type: text/x-php
Charset: utf-8

<?php

/**
 * ======================================================================
 * LICENSE: This file is subject to the terms and conditions defined in *
 * file 'license.txt', which is part of this source code package.       *
 * ======================================================================
 */

/**
 * Base trait to represents AAM preference concept
 *
 * @package AAM
 * @version 7.0.0
 */
trait AAM_Framework_Preference_BaseTrait
{

    /**
     * Reference to the access level
     *
     * @var AAM_Framework_AccessLevel_Interface
     * @access private
     *
     * @version 7.0.0
     */
    private $_access_level = null;

    /**
     * Collection of extended methods
     *
     * @var array
     * @access private
     *
     * @version 7.0.0
     */
    private $_extended_methods = [];

    /**
     * Preferences
     *
     * Array of final preferences. The final preferences are those that have been
     * properly inherited and merged.
     *
     * @var array
     * @access private
     *
     * @version 7.0.0
     */
    private $_preferences = [];

    /**
     * Explicit preferences (not inherited from parent access level)
     *
     * @var array
     * @access private
     *
     * @version 7.0.0
     */
    private $_explicit_preferences = [];

    /**
     * Constructor
     *
     * Initialize the preference container
     *
     * @param AAM_Framework_AccessLevel_Interface $access_level
     *
     * @return void
     * @access public
     *
     * @version 7.0.0
     */
    public function __construct($access_level)
    {
        $this->_access_level = $access_level;

        // Extend access level with more methods
        $closures = apply_filters(
            'aam_framework_preference_methods_filter',
            $this->_extended_methods,
            $this
        );

        if (is_array($closures)) {
            foreach($closures as $name => $closure) {
                $closures[$name] = $closure->bindTo($this, $this);
            }

            $this->_extended_methods = $closures;
        }

        // Initialize preferences
        $this->_init_preferences();
    }

    /**
     * Property overload
     *
     * @param string $name
     *
     * @return string
     * @access public
     *
     * @version 7.0.0
     */
    public function __get($name)
    {
        $result = null;

        if ($name === 'type') {
            $result = $this->type;
        } else {
            _doing_it_wrong(
                static::class . '::' . $name,
                'Property does not exist',
                AAM_VERSION
            );
        }

        return $result;
    }

    /**
     * Get access level this resource is tight to
     *
     * @return AAM_Framework_AccessLevel_Interface
     * @access public
     *
     * @version 7.0.0
     */
    public function get_access_level()
    {
        return $this->_access_level;
    }

    /**
     * @inheritDoc
     */
    public function is_customized($offset = null)
    {
        if (!is_null($offset)) {
            $result = !empty($this->_explicit_preferences[$offset]);
        } else {
            $result = !empty($this->_explicit_preferences);
        }

        return $result;
    }

    /**
     * @inheritDoc
     */
    public function reset()
    {
        $this->_explicit_preferences = [];

        return AAM_Framework_Manager::_()->settings(
            $this->get_access_level()
        )->delete_setting($this->_get_settings_ns());
    }

    /**
     * @inheritDoc
     */
    public function get_preferences($offset = null)
    {
        if (is_null($offset)) {
            $result = $this->_preferences;
        } elseif (isset($this->_preferences[$offset])) {
            $result = $this->_preferences[$offset];
        } else {
            $result = [];
        }

        return $this->_remove_sys_attributes($result);
    }

    /**
     * @inheritDoc
     */
    public function set_preferences(array $preferences, $offset = null)
    {
        if (is_null($offset)) {
            $this->_explicit_preferences = $preferences;
        } else {
            $this->_explicit_preferences[$offset] = $preferences;
        }

        // Sync with preferences
        $this->_preferences = array_replace(
            $this->_preferences,
            $this->_explicit_preferences
        );

        return $this->_save($this->_explicit_preferences);
    }

    /**
     * Initialize preferences
     *
     * @return void
     * @access private
     *
     * @version 7.0.0
     */
    private function _init_preferences()
    {
        // Read explicitly defined settings from DB
        $preferences = AAM_Framework_Manager::_()->settings(
            $this->_access_level
        )->get_setting($this->_get_settings_ns(), []);

        if (!is_array($preferences)) { // Deal with corrupted data
            $preferences = [];
        } else {
            $preferences = $this->_add_sys_attributes($preferences);
        }

        $this->_explicit_preferences = $preferences;

        // JSON Access Policy is deeply embedded in the framework, thus take it into
        // consideration during resource initialization
        if (AAM_Framework_Manager::_()->config->get('service.policies.enabled', true)) {
            $preferences = array_replace(
                $this->_add_sys_attributes($this->_apply_policy()),
                $preferences
            );
        }

        // Allow other implementations to influence set of preferences
        $preferences = apply_filters(
            'aam_init_preferences_filter',
            $preferences,
            $this
        );

        // Trigger inheritance mechanism
        $this->_preferences = array_replace(
            $this->_add_sys_attributes(
                $this->_inherit_from_parent(),
                [ '__inherited' => true ]
            ),
            $preferences
        );
    }

    /**
     * Get settings namespace
     *
     * @return string
     * @access private
     *
     * @version 7.0.0
     */
    private function _get_settings_ns()
    {
        return $this->type;
    }

    /**
     * Inherit preferences from parent access level (if any)
     *
     * @return array
     * @access private
     *
     * @version 7.0.0
     */
    private function _inherit_from_parent()
    {
        $parent = $this->get_access_level()->get_parent();
        $result = [];

        if (is_a($parent, AAM_Framework_AccessLevel_Interface::class)) {
            if ($parent->has_siblings()) {
                $siblings = $parent->get_siblings();
            } else {
                $siblings = [];
            }

            // Getting preference from the parent access level
            $result  = $parent->get_preference($this->type)->get_preferences();
            $manager = AAM_Framework_Manager::_();

            foreach ($siblings as $sibling) {
                $sibling_preferences = $sibling->get_preference(
                    $this->type
                )->get_preferences();

                $result = $manager->misc->merge_preferences(
                    $sibling_preferences,
                    $result
                );
            }
        }

        return $result;
    }

    /**
     * Apply preferences extracted from policies
     *
     * @return array
     * @access private
     *
     * @version 7.0.0
     */
    private function _apply_policy()
    {
        return apply_filters('aam_apply_policy_filter', [], $this);
    }

    /**
     * Save preferences
     *
     * @param array $preferences
     *
     * @return bool
     * @access private
     *
     * @version 7.0.0
     */
    private function _save($preferences)
    {
        return AAM_Framework_Manager::_()->settings(
            $this->get_access_level()
        )->set_setting(
            $this->_get_settings_ns(),
            $this->_remove_sys_attributes($preferences)
        );
    }

    /**
     * Add some system attributes to each permission
     *
     * @param array $data
     * @param array $additional [Optional]
     *
     * @return array
     * @access private
     *
     * @version 7.0.0
     */
    private function _add_sys_attributes($data, $additional = [])
    {
        if (!empty($data)) {
            $acl    = $this->get_access_level();
            $acl_id = $acl->get_id();

            $to_merge = [ '__access_level' => $acl->type ];

            if (!empty($acl_id)) {
                $to_merge['__access_level_id'] = $acl_id;
            }

            $result = array_merge($data, $to_merge, $additional);
        } else {
            $result = [];
        }

        return $result;
    }

    /**
     * Add system attributes
     *
     * @param array $data
     *
     * @return array
     * @access private
     *
     * @version 7.0.0
     */
    private function _remove_sys_attributes($data)
    {
        return array_filter($data, function($k) {
            return strpos($k, '__') !== 0;
        }, ARRAY_FILTER_USE_KEY);
    }

}