Phossa2\Shared\Singleton\SingletonTrait

Complexity

Total Complexity

5

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	1
Bugs	0	Features	1

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getInstance()	0	8	2
A	__construct()	0	3	1
A	__clone()	0	4	1
A	__wakeup()	0	4	1

<?php
/**
 * Phossa Project
 *
 * PHP version 5.4
 *
 * @category  Library
 * @package   Phossa2\Shared
 * @copyright Copyright (c) 2016 phossa.com
 * @license   http://mit-license.org/ MIT License
 * @link      http://www.phossa.com/
 */
/*# declare(strict_types=1); */

namespace Phossa2\Shared\Singleton;

use Phossa2\Shared\Exception\LogicException;

/**
 * SingletonTrait
 *
 * @package Phossa2\Shared
 * @author  Hong Zhang <phossa@126.com>
 * @see     SingletonInterface
 * @version 2.0.28
 * @since   2.0.28 added
 */
trait SingletonTrait
{
    /**
     * Singletons' pool
     *
     * Use array here to make Singleton class INHERITABLE!
     *
     * @var    SingletonInstance[]
     * @access private
     * @static
     */
    private static $singletons = [];

    /**
     * {@inheritDoc}
     */
    public static function getInstance()/*# : SingletonInterface */
    {
        $class = get_called_class();
        if (!isset(self::$singletons[$class])) {
            self::$singletons[$class] = new static();
        }
        return self::$singletons[$class];
    }

    /**
     * no instantiation from outside
     *
     * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     * @access protected
     * @final
     */
    protected function __construct()
    {
    }

    /**
     * prevent from being cloned.
     *
     * @return void
     * @access public
     * @final
     */
    final public function __clone()
    {
        throw new LogicException('SINGLETON CAN NOT BE CLONED');
    }

    /**
     * prevent from being unserialized.
     *
     * @return void
     * @access public
     * @final
     */
    final public function __wakeup()
    {
        throw new LogicException('SINGLETON CAN NOT BE WAKEUP');
    }
}