ホーム>PHPソースコード>その他のカテゴリー
ダウンロード

PHP タイプのツール

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 変数とデータ構造の一意の ID とハッシュを抽出するツール。

厳密と非厳密の 2 つのモードで動作します。

厳密モードの場合:

  • スカラー: タイプによって厳密に一意。
  • オブジェクト: インスタンスごとに一意。
  • 配列: シリアル化された値によって一意。
  • リソース: 結果はインスタンスごとに一意です。

非厳密モードの場合:

  • スカラー: 値によって一意。
  • オブジェクト: シリアル化された値によって一意。
  • 配列: シリアル化された値によって一意。
  • リソース: 結果はインスタンスごとに一意です。

文字列の取得

指定された変数の一意の文字列を返します。

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

地図アクセス

文字列キーによってさまざまなコンテナにマップのようにアクセスするためのツール。

アクセスできるもの:

  • オブジェクトのプロパティ (名前またはゲッターによる)。
  • 配列および ArrayAccess オブジェクトの要素 (キーごと)。

得る

キーごとにコンテナから値を返します。キーが存在しないかアクセスできない場合はデフォルト値を返します。

キーにアクセスして読み取ることができない場合は、 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 ライセンスに基づいてライセンスされています。

拡大する
追加情報
関連アプリ
おすすめ
関連情報 すべて