Don't mark public methods as internal

This commit is contained in:
Sebastian Meyer 2024-02-12 11:31:48 +01:00
parent 5b1572d259
commit 4bb4d531a3
5 changed files with 11 additions and 29 deletions

View File

@ -34,8 +34,8 @@ use InvalidArgumentException;
* first letter). * first letter).
* *
* > Example: If the property is named `$fooBar`, the "magic" method has to be * > Example: If the property is named `$fooBar`, the "magic" method has to be
* > `_magicGetFooBar()`. This method is then called when `$fooBar` is read * > `_magicGetFooBar()`. This method is then called when `$fooBar` is read in
* > from outside the class context. * > a context where it normally would not be accessible.
* *
* @author Sebastian Meyer <sebastian.meyer@opencultureconsulting.com> * @author Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
* @package Basics\Traits * @package Basics\Traits
@ -49,9 +49,7 @@ trait Getter
* *
* @return mixed The class property's current value * @return mixed The class property's current value
* *
* @throws InvalidArgumentException if the property does not exist * @throws InvalidArgumentException if the property or getter method do not exist
*
* @internal
*/ */
public function __get(string $property): mixed public function __get(string $property): mixed
{ {
@ -75,8 +73,6 @@ trait Getter
* @param string $property The class property to check * @param string $property The class property to check
* *
* @return bool Whether the class property is set and not empty * @return bool Whether the class property is set and not empty
*
* @internal
*/ */
public function __isset(string $property): bool public function __isset(string $property): bool
{ {

View File

@ -29,7 +29,7 @@ namespace OCC\Basics\Traits;
* Internally it reads the protected `$_data` array whose keys are interpreted * Internally it reads the protected `$_data` array whose keys are interpreted
* as property names. * as property names.
* *
* > Example: Reading `Foo->bar` will return the value of `Foo->_data['bar']`. * > Example: Reading `Foo->bar` will return the value of `$_data['bar']`.
* *
* @author Sebastian Meyer <sebastian.meyer@opencultureconsulting.com> * @author Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
* @package Basics\Traits * @package Basics\Traits
@ -46,13 +46,11 @@ trait OverloadingGetter
protected array $_data = []; protected array $_data = [];
/** /**
* Read data from an inaccessible property. * Read data from an overloaded property.
* *
* @param string $property The class property to get * @param string $property The class property to get
* *
* @return mixed The property's current value or NULL if not set * @return mixed The property's current value or NULL if not set
*
* @internal
*/ */
public function __get(string $property): mixed public function __get(string $property): mixed
{ {
@ -60,13 +58,11 @@ trait OverloadingGetter
} }
/** /**
* Check if an inaccessible property is set and not empty. * Check if an overloaded property is set and not empty.
* *
* @param string $property The class property to check * @param string $property The class property to check
* *
* @return bool Whether the class property is set and not empty * @return bool Whether the class property is set and not empty
*
* @internal
*/ */
public function __isset(string $property): bool public function __isset(string $property): bool
{ {

View File

@ -29,7 +29,7 @@ namespace OCC\Basics\Traits;
* Internally it writes the protected `$_data` array whose keys are interpreted * Internally it writes the protected `$_data` array whose keys are interpreted
* as property names. * as property names.
* *
* > Example: `Foo->bar = 42` will set `Foo->_data['bar']` to `42`. * > Example: `Foo->bar = 42;` will set `$_data['bar']` to `42`.
* *
* @author Sebastian Meyer <sebastian.meyer@opencultureconsulting.com> * @author Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
* @package Basics\Traits * @package Basics\Traits
@ -46,14 +46,12 @@ trait OverloadingSetter
protected array $_data = []; protected array $_data = [];
/** /**
* Write data to an inaccessible property. * Write data to an overloaded property.
* *
* @param string $property The class property to set * @param string $property The class property to set
* @param mixed $value The new value of the property * @param mixed $value The new value of the property
* *
* @return void * @return void
*
* @internal
*/ */
public function __set(string $property, mixed $value): void public function __set(string $property, mixed $value): void
{ {
@ -61,13 +59,11 @@ trait OverloadingSetter
} }
/** /**
* Unset an inaccessible property. * Unset an overloaded property.
* *
* @param string $property The class property to unset * @param string $property The class property to unset
* *
* @return void * @return void
*
* @internal
*/ */
public function __unset(string $property): void public function __unset(string $property): void
{ {

View File

@ -35,7 +35,7 @@ use InvalidArgumentException;
* *
* > Example: If the property is named `$fooBar`, the "magic" method has to be * > Example: If the property is named `$fooBar`, the "magic" method has to be
* > `_magicSetFooBar()`. This method is then called when `$fooBar` is written * > `_magicSetFooBar()`. This method is then called when `$fooBar` is written
* > to from outside the class context. * > to in a context where it normally would not be accessible.
* *
* @author Sebastian Meyer <sebastian.meyer@opencultureconsulting.com> * @author Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
* @package Basics\Traits * @package Basics\Traits
@ -50,9 +50,7 @@ trait Setter
* *
* @return void * @return void
* *
* @throws InvalidArgumentException if the property does not exist * @throws InvalidArgumentException if the property or setter method do not exist
*
* @internal
*/ */
public function __set(string $property, mixed $value): void public function __set(string $property, mixed $value): void
{ {
@ -76,8 +74,6 @@ trait Setter
* @param string $property The class property to unset * @param string $property The class property to unset
* *
* @return void * @return void
*
* @internal
*/ */
public function __unset(string $property): void public function __unset(string $property): void
{ {

View File

@ -83,8 +83,6 @@ trait Singleton
* @return void * @return void
* *
* @throws LogicException when trying to clone the singleton object * @throws LogicException when trying to clone the singleton object
*
* @internal
*/ */
final public function __clone() final public function __clone()
{ {