Помощники для различных операций с типами данных PHP, переменными и контейнерами.
composer require smoren/type-tools
Метод | Описание | Фрагмент кода |
---|---|---|
getString | Возвращает уникальную строку заданной переменной | UniqueExtractor::getString($var, $strict) |
getHash | Возвращает уникальную хеш-строку md5 заданной переменной. | UniqueExtractor::getHash($var, $strict) |
Метод | Описание | Фрагмент кода |
---|---|---|
cast | Привести объект к другому относительному типу | ObjectTypeCaster::cast($sourceObject, $destinationClass) |
Метод | Описание | Фрагмент кода |
---|---|---|
getPropertyValue | Возвращает значение свойства объекта | ObjectAccess::getPropertyValue($object, $propertyName) |
setPropertyValue | Устанавливает значение свойства объекта | ObjectAccess::setPropertyValue($object, $propertyName, $value) |
hasReadableProperty | Возвращает true, если объект имеет читаемое свойство по имени или по методу получения. | ObjectAccess::hasReadableProperty($object, $propertyName) |
hasWritableProperty | Возвращает true, если объект имеет свойство, доступное для записи, по имени или по методу получения. | ObjectAccess::hasWritableProperty($object, $propertyName) |
hasPublicProperty | Возвращает true, если объект имеет общедоступную собственность | ObjectAccess::hasPublicProperty($object, $propertyName) |
hasPublicMethod | Возвращает true, если объект имеет общедоступный метод | ObjectAccess::hasPublicMethod($object, $methodName) |
hasProperty | Возвращает true, если объект имеет свойство | ObjectAccess::hasProperty($object, $propertyName) |
hasMethod | Возвращает true, если у объекта есть метод | ObjectAccess::hasMethod($object, $methodName) |
Метод | Описание | Фрагмент кода |
---|---|---|
get | Возвращает значение из контейнера по ключу | MapAccess::get($container, $key, $defaultValue) |
set | Устанавливает значение в контейнер по ключу | MapAccess::set($container, $key, $value) |
exists | Возвращает true, если в контейнере существует доступный ключ. | MapAccess::exists($container, $key) |
Инструмент для извлечения уникальных идентификаторов и хешей любых переменных PHP и структур данных.
Работает в двух режимах: строгом и нестрогом.
В строгом режиме:
В нестрогом режиме:
Возвращает уникальную строку заданной переменной.
UniqueExtractor::getString(mixed $var, bool $strict): string
use Smoren TypeTools UniqueExtractor ;
$ intValue = 5 ;
$ floatValue = 5.0 ;
$ intValueStrictUniqueId = UniqueExtractor:: getString ( $ intValue , true );
$ floatValueStrictUniqueId = UniqueExtractor:: getString ( $ floatValue , true );
var_dump ( $ intValueStrictUniqueId === $ floatValueStrictUniqueId );
// false
$ intValueNonStrictUniqueId = UniqueExtractor:: getString ( $ intValue , false );
$ floatValueNonStrictUniqueId = UniqueExtractor:: getString ( $ floatValue , false );
var_dump ( $ intValueNonStrictUniqueId === $ floatValueNonStrictUniqueId );
// true
Возвращает уникальную хеш-строку md5 заданной переменной.
UniqueExtractor::getHash(mixed $var, bool $strict): string
use Smoren TypeTools UniqueExtractor ;
$ intValue = 5 ;
$ floatValue = 5.0 ;
$ intValueStrictHash = UniqueExtractor:: getHash ( $ intValue , true );
$ floatValueStrictHash = UniqueExtractor:: getHash ( $ floatValue , true );
var_dump ( $ intValueStrictHash === $ floatValueStrictHash );
// false
$ intValueNonStrictHash = UniqueExtractor:: getHash ( $ intValue , false );
$ floatValueNonStrictHash = UniqueExtractor:: getHash ( $ floatValue , false );
var_dump ( $ intValueNonStrictHash === $ floatValueNonStrictHash );
// true
Инструмент для приведения типов объектов.
Приведите объект к другому относительному типу (восходящему приведению или нисходящему приведению).
ObjectTypeCaster::cast(object $sourceObject, string $destinationClass): mixed
use Smoren TypeTools ObjectTypeCaster ;
class ParentClass
{
public int $ a ;
protected int $ b ;
public function __construct ( int $ a , int $ b )
{
$ this -> a = $ a ;
$ this -> b = $ b ;
}
public function toArray (): array
{
return [ $ this -> a , $ this -> b ];
}
}
class ChildClass extends ParentClass
{
private $ c = null ;
public function __construct ( int $ a , int $ b , int $ c )
{
parent :: __construct ( $ a , $ b );
$ this -> c = $ c ;
}
public function toArray (): array
{
return [ $ this -> a , $ this -> b , $ this -> c ];
}
}
/* Downcast */
$ parentClassObject = new ParentClass ( 1 , 2 );
print_r ( $ parentClassObject -> toArray ());
// [1, 2]
$ castedToChildClass = ObjectTypeCaster:: cast ( $ parentClassObject , ChildClass::class);
print_r ( $ castedToChildClass -> toArray ());
// [1, 2, null]
var_dump ( get_class ( $ castedToChildClass ));
// ChildClass
/* Upcast */
$ childClassObject = new ChildClass ( 1 , 2 , 3 );
print_r ( $ childClassObject -> toArray ());
// [1, 2, 3]
$ castedToParentClass = ObjectTypeCaster:: cast ( $ childClassObject , ParentClass::class);
print_r ( $ castedToParentClass -> toArray ());
// [1, 2]
var_dump ( get_class ( $ castedToParentClass ));
// ParentClass
Инструмент для отражения и доступа к свойствам и методам объекта.
Возвращает значение свойства объекта.
ObjectAccess::getPropertyValue(object $object, string $propertyName): mixed
Может получить доступ к свойству по его имени или по методу получения.
Выдает SmorenTypeToolsExceptionsKeyError
если свойство недоступно для чтения.
use Smoren TypeTools ObjectAccess ;
class MyClass {
public int $ publicProperty = 1 ;
private int $ privateProperty = 2 ;
public function getPrivateProperty (): int
{
return $ this -> privateProperty ;
}
}
$ myObject = new MyClass ();
// Getting by name:
var_dump (ObjectAccess:: getPropertyValue ( $ myObject , ' publicProperty ' ));
// 1
// Getting by getter (getPrivateProperty()):
var_dump (ObjectAccess:: getPropertyValue ( $ myObject , ' privateProperty ' ));
// 2
Устанавливает значение свойства объекта.
ObjectAccess::setPropertyValue(object $object, string $propertyName, mixed $value): void
Доступ к свойству можно получить по его имени или с помощью установщика.
Выдает SmorenTypeToolsExceptionsKeyError
если свойство недоступно для записи.
use Smoren TypeTools ObjectAccess ;
class MyClass {
public int $ publicProperty = 1 ;
private int $ privateProperty = 2 ;
public function setPrivateProperty ( int $ value ): void
{
$ this -> privateProperty = $ value ;
}
public function toArray (): array
{
return [ $ this -> publicProperty , $ this -> privateProperty ];
}
}
$ myObject = new MyClass ();
// Setting by name:
ObjectAccess:: setPropertyValue ( $ myObject , ' publicProperty ' , 11 );
// Setting by setter (setPrivateProperty()):
ObjectAccess:: getPropertyValue ( $ myObject , ' privateProperty ' , 22 );
print_r ( $ myObject -> toArray ());
// [11, 22]
Возвращает true, если объект имеет свойство, которое можно прочитать по имени или методом получения.
ObjectAccess::hasReadableProperty(object $object, string $propertyName): bool
use Smoren TypeTools ObjectAccess ;
class MyClass {
public int $ publicProperty = 1 ;
private int $ privateProperty = 2 ;
private int $ notAccessibleProperty = 3 ;
public function getPrivateProperty (): int
{
return $ this -> privateProperty ;
}
}
$ myObject = new MyClass ();
// Accessible by name:
var_dump (ObjectAccess:: hasReadableProperty ( $ myObject , ' publicProperty ' ));
// true
// Accessible by getter:
var_dump (ObjectAccess:: hasReadableProperty ( $ myObject , ' privateProperty ' ));
// true
// Not accessible:
var_dump (ObjectAccess:: hasReadableProperty ( $ myObject , ' notAccessibleProperty ' ));
// false
Возвращает true, если объект имеет свойство, доступное для записи по имени или установщику.
ObjectAccess::hasWritableProperty(object $object, string $propertyName): bool
use Smoren TypeTools ObjectAccess ;
class MyClass {
public int $ publicProperty = 1 ;
private int $ privateProperty = 2 ;
private int $ notAccessibleProperty = 3 ;
public function setPrivateProperty ( int $ value ): void
{
$ this -> privateProperty = $ value ;
}
}
$ myObject = new MyClass ();
// Accessible by name:
var_dump (ObjectAccess:: hasWritableProperty ( $ myObject , ' publicProperty ' ));
// true
// Accessible by setter:
var_dump (ObjectAccess:: hasWritableProperty ( $ myObject , ' privateProperty ' ));
// true
// Not accessible:
var_dump (ObjectAccess:: hasWritableProperty ( $ myObject , ' notAccessibleProperty ' ));
// false
Возвращает true, если объект имеет общедоступное свойство.
ObjectAccess::hasPublicProperty(object $object, string $propertyName): bool
use Smoren TypeTools ObjectAccess ;
class MyClass {
public int $ publicProperty = 1 ;
private int $ privateProperty = 2 ;
}
$ myObject = new MyClass ();
var_dump (ObjectAccess:: hasPublicProperty ( $ myObject , ' publicProperty ' ));
// true
var_dump (ObjectAccess:: hasPublicProperty ( $ myObject , ' privateProperty ' ));
// false
Возвращает true, если объект имеет общедоступный метод.
ObjectAccess::hasPublicMethod(object $object, string $methodName): bool
use Smoren TypeTools ObjectAccess ;
class MyClass {
public function publicMethod (): int
{
return 1 ;
}
private function privateMethod (): int
{
return 2 ;
}
}
$ myObject = new MyClass ();
var_dump (ObjectAccess:: hasPublicMethod ( $ myObject , ' publicMethod ' ));
// true
var_dump (ObjectAccess:: hasPublicMethod ( $ myObject , ' privateMethod ' ));
// false
Возвращает true, если объект имеет свойство.
ObjectAccess::hasProperty(object $object, string $propertyName): bool
use Smoren TypeTools ObjectAccess ;
class MyClass {
public int $ publicProperty = 1 ;
private int $ privateProperty = 2 ;
}
$ myObject = new MyClass ();
var_dump (ObjectAccess:: hasProperty ( $ myObject , ' publicProperty ' ));
// true
var_dump (ObjectAccess:: hasProperty ( $ myObject , ' privateProperty ' ));
// true
var_dump (ObjectAccess:: hasProperty ( $ myObject , ' anotherProperty ' ));
// false
Возвращает true, если у объекта есть метод.
ObjectAccess::hasMethod(object $object, string $methodName): bool
use Smoren TypeTools ObjectAccess ;
class MyClass {
public function publicMethod (): int
{
return 1 ;
}
private function privateMethod (): int
{
return 2 ;
}
}
$ myObject = new MyClass ();
var_dump (ObjectAccess:: hasMethod ( $ myObject , ' publicMethod ' ));
// true
var_dump (ObjectAccess:: hasMethod ( $ myObject , ' privateMethod ' ));
// true
Инструмент для доступа к различным контейнерам в виде карты с помощью строковых ключей.
Может получить доступ:
Возвращает значение из контейнера по ключу или значению по умолчанию, если ключ не существует или недоступен.
Выдает SmorenTypeToolsExceptionsKeyError
если ключ недоступен для чтения.
MapAccess::get(mixed $container, string $key, mixed $defaultValue = null): mixed
use Smoren TypeTools MapAccess ;
$ array = [
' a ' => 1 ,
];
var_dump (MapAccess:: get ( $ array , ' a ' , 0 ));
// 1
var_dump (MapAccess:: get ( $ array , ' b ' , 0 ));
// 0
var_dump (MapAccess:: get ( $ array , ' b ' ));
// null
class MyClass {
public int $ publicProperty = 1 ;
private int $ privateProperty = 2 ;
private int $ notAccessibleProperty = 3 ;
public function getPrivateProperty (): int
{
return $ this -> privateProperty ;
}
}
$ myObject = new MyClass ();
// Accessible by name:
var_dump (MapAccess:: get ( $ myObject , ' publicProperty ' , 0 ));
// 1
// Accessible by getter:
var_dump (MapAccess:: get ( $ myObject , ' privateProperty ' ));
// 2
// Not accessible:
var_dump (MapAccess:: get ( $ myObject , ' notAccessibleProperty ' , - 1 ));
// -1
var_dump (MapAccess:: get ( $ myObject , ' notAccessibleProperty ' ));
// null
// Nonexistent:
var_dump (MapAccess:: get ( $ myObject , ' nonexistentProperty ' , - 1 ));
// -1
var_dump (MapAccess:: get ( $ myObject , ' nonexistentProperty ' ));
// null
Устанавливает значение в контейнер по ключу.
MapAccess::set(mixed $container, string $key, mixed $value): void
Выдает SmorenTypeToolsExceptionsKeyError
если ключ недоступен для записи.
use Smoren TypeTools MapAccess ;
$ array = [
' a ' => 1 ,
];
MapAccess:: set ( $ array , ' a ' , 11 );
MapAccess:: set ( $ array , ' b ' , 22 );
print_r ( $ array );
// ['a' => 11, 'b' => 22]
class MyClass {
public int $ publicProperty = 1 ;
private int $ privateProperty = 2 ;
public function setPrivateProperty ( int $ value ): void
{
$ this -> privateProperty = $ value ;
}
public function toArray (): array
{
return [ $ this -> publicProperty , $ this -> privateProperty ];
}
}
$ myObject = new MyClass ();
// Accessible by name:
MapAccess:: get ( $ myObject , ' publicProperty ' , 11 );
// Accessible by getter:
MapAccess:: get ( $ myObject , ' privateProperty ' , 22 );
print_r ( $ myObject -> toArray ());
// [11, 22]
Возвращает true, если в контейнере существует доступный ключ.
MapAccess::exists(mixed $container, string $key): bool
use Smoren TypeTools MapAccess ;
$ array = [
' a ' => 1 ,
];
var_dump (MapAccess:: exists ( $ array , ' a ' ));
// true
var_dump (MapAccess:: exists ( $ array , ' b ' ));
// false
class MyClass {
public int $ publicProperty = 1 ;
private int $ privateProperty = 2 ;
private int $ notAccessibleProperty = 3 ;
public function getPrivateProperty (): int
{
return $ this -> privateProperty ;
}
}
$ myObject = new MyClass ();
// Accessible by name:
var_dump (MapAccess:: exists ( $ myObject , ' publicProperty ' ));
// true
// Accessible by getter:
var_dump (MapAccess:: exists ( $ myObject , ' privateProperty ' ));
// true
// Not accessible:
var_dump (MapAccess:: get ( $ myObject , ' notAccessibleProperty ' ));
// false
// Nonexistent:
var_dump (MapAccess:: get ( $ myObject , ' nonexistentProperty ' , - 1 ));
// false
composer install
composer test-init
composer test
PHP Type Tools лицензируется по лицензии MIT.