php-basics/src/Traits/Singleton.php

77 lines
2.0 KiB
PHP

<?php
/**
* Useful PHP Traits
* Copyright (C) 2023 Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* 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. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
namespace OCC\Traits;
/**
* Allows just a single instance of a class.
*
* @author Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
* @package opencultureconsulting/traits
* @access public
*/
trait Singleton
{
/**
* Holds the singleton instances.
*
* @access protected
* @static
*
* @var array
*/
protected static $singleton = [];
/**
* Get a singleton instance of this class.
*
* @access public
* @final
* @static
*
* @return self
*/
final public static function getInstance(): self
{
if (!isset(self::$singleton[__CLASS__])) {
$reflectionClass = new \ReflectionClass(__CLASS__);
self::$instance[__CLASS__] = $reflectionClass->newInstanceArgs(func_get_args());
}
return self::$singleton[__CLASS__];
}
/**
* This is a singleton class, thus the constructor is protected.
* (Get an instance of this class by calling self::getInstance())
*
* @access protected
* @abstract
*/
abstract protected function __construct();
/**
* This is a singleton class, thus cloning is prohibited.
*
* @access protected
*/
final protected function __clone()
{
}
}