مساعدين لعمليات مختلفة مع أنواع بيانات 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 | يُرجع صحيحًا إذا كان الكائن يحتوي على خاصية قابلة للقراءة بالاسم أو بواسطة getter | ObjectAccess::hasReadableProperty($object, $propertyName) |
hasWritableProperty | يُرجع صحيحًا إذا كان الكائن يحتوي على خاصية قابلة للكتابة بالاسم أو بواسطة getter | ObjectAccess::hasWritableProperty($object, $propertyName) |
hasPublicProperty | يُرجع صحيحًا إذا كان الكائن له ملكية عامة | ObjectAccess::hasPublicProperty($object, $propertyName) |
hasPublicMethod | يُرجع صحيحًا إذا كان الكائن له طريقة عامة | ObjectAccess::hasPublicMethod($object, $methodName) |
hasProperty | يُرجع صحيحًا إذا كان الكائن له خاصية | ObjectAccess::hasProperty($object, $propertyName) |
hasMethod | يُرجع صحيحًا إذا كان الكائن له طريقة | ObjectAccess::hasMethod($object, $methodName) |
طريقة | وصف | مقتطف الكود |
---|---|---|
get | إرجاع القيمة من الحاوية عن طريق المفتاح | MapAccess::get($container, $key, $defaultValue) |
set | يضبط القيمة على الحاوية حسب المفتاح | MapAccess::set($container, $key, $value) |
exists | يُرجع صحيحًا في حالة وجود مفتاح يمكن الوصول إليه في الحاوية | 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
يمكن الوصول إلى الممتلكات باسمها أو عن طريق getter.
يلقي 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]
يُرجع صحيحًا إذا كان الكائن يحتوي على خاصية يمكن قراءتها بالاسم أو بواسطة getter.
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
يُرجع صحيحًا إذا كان الكائن يحتوي على خاصية قابلة للكتابة بالاسم أو بواسطة أداة الضبط.
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
يُرجع صحيحًا إذا كان الكائن له ملكية عامة.
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
يُرجع صحيحًا إذا كان الكائن له طريقة عامة.
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
يُرجع صحيحًا إذا كان الكائن له خاصية.
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
يُرجع صحيحًا إذا كان الكائن له طريقة.
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]
يُرجع صحيحًا في حالة وجود مفتاح يمكن الوصول إليه في الحاوية.
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.