Provider.php

Go to the documentation of this file.

<?php
/*
 You may not change or alter any portion of this comment or credits
 of supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit authors.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*/

namespace Xoops\Core\Service;

use Xoops\Core\Service\Manager;
use Xoops\Core\Service\Response;

class Provider
{
    protected $manager = null;

    protected $service = null;

    protected $providers = array();

    public function __construct(Manager $manager, $service)
    {
        $this->manager = $manager;
        $this->service = $service;
    }

    public function getProviderMode()
    {
        static $ret = null;

        if ($ret===null) {
            if (count($this->providers)) {
                $ret = reset($this->providers)->getMode();
            } else {
                return Manager::MODE_EXCLUSIVE;
            }
        }
        return $ret;
    }

    public function register($object)
    {
        // verify this is the proper type of object
        $contract = '\Xoops\Core\Service\Contract\\' . $this->service . 'Interface';

        if (is_a($object, '\Xoops\Core\Service\AbstractContract')
            && $object instanceof $contract
        ) {
            $this->providers[] = $object;
        }
    }

    public function &getRegistered()
    {
        return $this->providers;
    }

    public function sortProviders()
    {
        $sortable = $this->providers;
        $s = usort($sortable, function ($a, $b) {
            if ($a->getPriority() != $b->getPriority()) {
                return ($a->getPriority() > $b->getPriority()) ? 1 : -1;
            } else {
                return 0;
            }
        });
        $this->providers = $sortable;
    }

    public function isAvailable()
    {
        return true;
    }

    public function __call($name, $arguments)
    {
        $mode = $this->getProviderMode();

        // for right now only one provider will be called, and it should be at the top
        $object = reset($this->providers);
        $method = array($object, $name);
        $response = new Response();
        if (is_callable($method)) {
            try {
                //$object->$name($response, $arguments);
                array_unshift($arguments, $response);
                call_user_func_array($method, $arguments);
            } catch (\Exception $e) {
                \XoopsPreload::getInstance()->triggerEvent('core.exception', $e);
                $response->setSuccess(false)->addErrorMessage($e->getMessage());
            }
        } else {
            $response->setSuccess(false)->addErrorMessage(sprintf('No method %s', $name));
        }
        return $response;
    }

    public static function __callStatic($name, $arguments)
    {
        return null;
    }
}