chromed

Back Back Up Advanced Editor

<?php

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

/**
 * Abstract base for all services
 *
 * @method AAM_Framework_Service_Urls urls(mixed $access_level = null, array $settings = [])
 * @method AAM_Framework_Service_ApiRoutes api_routes(mixed $access_level = null, array $settings = [])
 * @method AAM_Framework_Service_Jwts jwts(mixed $access_level = null, array $settings = [])
 * @method AAM_Framework_Service_LoginRedirect login_redirect(mixed $access_level = null, array $settings = [])
 * @method AAM_Framework_Service_LogoutRedirect logout_redirect(mixed $access_level = null, array $settings = [])
 * @method AAM_Framework_Service_NotFoundRedirect not_found_redirect(mixed $access_level = null, array $settings = [])
 * @method AAM_Framework_Service_BackendMenu backend_menu(mixed $access_level = null, array $settings = [])
 * @method AAM_Framework_Service_AdminToolbar admin_toolbar(mixed $access_level = null, array $settings = [])
 * @method AAM_Framework_Service_Metaboxes metaboxes(mixed $access_level = null, array $settings = [])
 * @method AAM_Framework_Service_Widgets widgets(mixed $access_level = null, array $settings = [])
 * @method AAM_Framework_Service_AccessDeniedRedirect access_denied_redirect(mixed $access_level = null, array $settings = [])
 * @method AAM_Framework_Service_Roles roles(mixed $access_level = null, array $settings = [])
 * @method AAM_Framework_Service_Users users(mixed $access_level = null, array $settings = [])
 * @method AAM_Framework_Service_Posts posts(mixed $access_level = null, array $settings = [])
 * @method AAM_Framework_Service_Terms terms(mixed $access_level = null, array $settings = [])
 * @method AAM_Framework_Service_PostTypes post_types(mixed $access_level = null, array $settings = [])
 * @method AAM_Framework_Service_Taxonomies taxonomies(mixed $access_level = null, array $settings = [])
 * @method AAM_Framework_Service_Capabilities capabilities(mixed $access_level = null, array $settings = [])
 * @method AAM_Framework_Service_Capabilities caps(mixed $access_level = null, array $settings = [])
 * @method AAM_Framework_Service_Settings settings(mixed $access_level = null, array $settings = [])
 * @method AAM_Framework_Service_Policies policies(mixed $access_level = null, array $settings = [])
 * @method AAM_Framework_Service_Hooks hooks(mixed $access_level = null, array $settings = [])
 *
 * @property AAM_Framework_Utility_Cache $cache
 * @property AAM_Framework_Utility_ObjectCache $object_cache
 * @property AAM_Framework_Utility_Capabilities $caps
 * @property AAM_Framework_Utility_Capabilities $capabilities
 * @property AAM_Framework_Utility_Config $config
 * @property AAM_Framework_Utility_Misc $misc
 * @property AAM_Framework_Utility_Redirect $redirect
 * @property AAM_Framework_Utility_Roles $roles
 * @property AAM_Framework_Utility_Users $users
 * @property AAM_Framework_Utility_Db $db
 * @property AAM_Framework_Utility_AccessLevels $access_levels
 * @property AAM_Framework_Utility_Jwt $jwt
 * @property AAM_Framework_Utility_Policy $policy
 * @property AAM_Framework_Utility_Content $content
 * @property AAM_Framework_Utility_Rest $rest
 *
 * @package AAM
 * @version 7.0.0
 */
trait AAM_Framework_Service_BaseTrait
{

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

/**
     * Service's access level
     *
     * @var AAM_Framework_AccessLevel_Interface
     * @access private
     *
     * @version 7.0.0
     */
    private $_access_level = null;

/**
     * Service's runtime settings
     *
     * @var array
     * @access private
     *
     * @version 7.0.0
     */
    private $_settings = null;

/**
     * Instantiate the service
     *
     * @param AAM_Framework_AccessLevel_Interface $access_level
     * @param array                               $settings
     *
     * @return void
     * @access protected
     *
     * @version 7.0.0
     */
    protected function __construct($access_level, $settings)
    {
        $this->_access_level = $access_level;
        $this->_settings     = $settings;

// Extend the service instance with additional methods
        $closures = apply_filters(
            'aam_framework_service_methods_filter', [], $this
        );

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

$this->_extended_methods = $closures;
        }

if (method_exists($this, 'initialize_hooks')) {
            $this->initialize_hooks();
        };
    }

/**
     * Call any extended methods
     *
     * @param string $name
     * @param array  $args
     *
     * @return mixed
     * @access public
     *
     * @version 7.0.0
     */
    public function __call($name, $args)
    {
        try {
            if ($this->_extended_method_exists($name)) {
                $result = call_user_func_array(
                    $this->_extended_methods[$name], $args
                );
            } elseif (AAM_Framework_Manager::_()->has_service($name)) {
                $result = AAM_Framework_Manager::_()->{$name}(...$args);
            } else {
                throw new BadMethodCallException(
                    "Method {$name} does not exist"
                );
            }
        } catch (Exception $e) {
            $result = $this->_handle_error($e);
        }

return $result;
    }

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

try {
            if ($name === 'access_level') {
                $result = $this->_access_level;
            } elseif (AAM_Framework_Manager::_()->has_utility($name)) {
                $result = AAM_Framework_Manager::_()->{$name};
            }
        } catch (Exception $e) {
            $result = $this->_handle_error($e);
        }

return $result;
    }

/**
     * Are permissions customized for current access level
     *
     * Determine if permissions for the resource are customized for the current
     * access level. Permissions are considered customized if there is at least one
     * permission explicitly allowed or denied.
     *
     * @return bool
     * @access public
     *
     * @version 7.0.0
     * @todo Consider to remove
     */
    public function is_customized()
    {
        try {
            $result = $this->_get_resource()->is_customized();
        } catch (Exception $e) {
            $result = $this->_handle_error($e);
        }

return $result;
    }

/**
     * Normalize resource identifier
     *
     * Convert resource identifier into proper shape for resource layer to consume
     *
     * @param mixed $resource_identifier
     *
     * @return mixed
     * @access private
     *
     * @version 7.0.0
     */
    private function _normalize_resource_identifier($resource_identifier)
    {
        return $resource_identifier;
    }

/**
     * Get current subject
     *
     * @return AAM_Framework_AccessLevel_Interface
     * @access private
     *
     * @version 7.0.0
     */
    private function _get_access_level()
    {
        return $this->_access_level;
    }

/**
     * Check if extended method exists
     *
     * @param string $name
     *
     * @return boolean
     * @access private
     *
     * @version 7.0.0
     */
    private function _extended_method_exists($name)
    {
        return isset($this->_extended_methods[$name])
            && is_callable($this->_extended_methods[$name]);
    }

/**
     * Handle error
     *
     * @param Exception $exception
     *
     * @return mixed
     * @access private
     *
     * @version 7.0.1
     */
    private function _handle_error($exception)
    {
        return $this->misc->handle_error($exception, $this->_settings);
    }

/**
     * Bootstrap and return an instance of the service
     *
     * @param AAM_Framework_AccessLevel_Interface $access_level
     * @param array                               $settings
     *
     * @return static::class
     *
     * @access public
     * @static
     *
     * @version 7.0.0
     */
    public static function get_instance(
        AAM_Framework_AccessLevel_Interface$access_level,
        $settings
    ) {
        return new self($access_level, $settings);
    }

}