sebastian-meyer
/
php-basics
mirror of https://github.com/opencultureconsulting/php-basics.git
2
0
Fork 0
Code Issues

Add reference to Singleton documentation

This commit is contained in:
Sebastian Meyer 2024-02-11 22:48:57 +01:00
parent 0467b8bad9
commit 5b1572d259
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/Traits/Singleton.php
View File

@ -28,7 +28,7 @@ use LogicException;
/** /**
* Allows just a single instance of the class using this trait. * Allows just a single instance of the class using this trait.
* *
* Get the singleton object by calling the static method `getInstance()`. * Get the singleton by calling the static method `getInstance()`.
* *
* If there is no object yet, the constructor is called with the same arguments * If there is no object yet, the constructor is called with the same arguments
* as `getInstance()`. Any later call will just return the already instantiated * as `getInstance()`. Any later call will just return the already instantiated
@ -72,6 +72,8 @@ trait Singleton
* This is a singleton class, thus the constructor is private. * This is a singleton class, thus the constructor is private.
* *
* @return void * @return void
*
* @see Singleton::getInstance() to get an singleton object of the class
*/ */
abstract private function __construct(); abstract private function __construct();
@ -80,7 +82,7 @@ trait Singleton
* *
* @return void * @return void
* *
* @throws LogicException if trying to clone `$this` * @throws LogicException when trying to clone the singleton object
* *
* @internal * @internal
*/ */