type tools php Download - type tools php Download do código-fonte

Ferramentas de tipo PHP

Auxiliares para diferentes operações com tipos de dados, variáveis e contêineres PHP.

Como instalar no seu projeto

 composer require smoren/type-tools

Referência rápida

Extrator Único

Método	Descrição	Trecho de código
`getString`	Retorna uma string exclusiva da variável fornecida	`UniqueExtractor::getString($var, $strict)`
`getHash`	Retorna uma string hash md5 exclusiva da variável fornecida	`UniqueExtractor::getHash($var, $strict)`

Rodízio de tipo de objeto

Método	Descrição	Trecho de código
`cast`	Converter objeto para outro tipo relativo	`ObjectTypeCaster::cast($sourceObject, $destinationClass)`

Acesso a objetos

Método	Descrição	Trecho de código
`getPropertyValue`	Retorna o valor da propriedade do objeto	`ObjectAccess::getPropertyValue($object, $propertyName)`
`setPropertyValue`	Define o valor da propriedade do objeto	`ObjectAccess::setPropertyValue($object, $propertyName, $value)`
`hasReadableProperty`	Retorna verdadeiro se o objeto tiver propriedade legível por nome ou por getter	`ObjectAccess::hasReadableProperty($object, $propertyName)`
`hasWritableProperty`	Retorna verdadeiro se o objeto tiver propriedade gravável por nome ou por getter	`ObjectAccess::hasWritableProperty($object, $propertyName)`
`hasPublicProperty`	Retorna verdadeiro se o objeto tiver propriedade pública	`ObjectAccess::hasPublicProperty($object, $propertyName)`
`hasPublicMethod`	Retorna verdadeiro se o objeto tiver método público	`ObjectAccess::hasPublicMethod($object, $methodName)`
`hasProperty`	Retorna verdadeiro se o objeto tiver propriedade	`ObjectAccess::hasProperty($object, $propertyName)`
`hasMethod`	Retorna verdadeiro se o objeto tiver método	`ObjectAccess::hasMethod($object, $methodName)`

Acesso ao mapa

Método	Descrição	Trecho de código
`get`	Retorna o valor do contêiner por chave	`MapAccess::get($container, $key, $defaultValue)`
`set`	Define o valor do contêiner por chave	`MapAccess::set($container, $key, $value)`
`exists`	Retorna verdadeiro se existir chave acessível no contêiner	`MapAccess::exists($container, $key)`

Uso

Extrator Único

Ferramenta para extrair IDs e hashes exclusivos de quaisquer variáveis e estruturas de dados PHP.

Funciona em dois modos: estrito e não estrito.

No modo estrito:

escalares: únicos estritamente por tipo;
objetos: únicos por instância;
matrizes: exclusivas por valor serializado;
recursos: o resultado é único por instância.

No modo não estrito:

escalares: únicos por valor;
objetos: únicos por valor serializado;
matrizes: exclusivas por valor serializado;
recursos: o resultado é único por instância.

Obter corda

Retorna uma string exclusiva da variável fornecida.

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

Obter hash

Retorna uma string hash md5 exclusiva da variável fornecida.

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

Rodízio de tipo de objeto

Ferramenta para lançar tipos de objetos.

Elenco

Converte o objeto para outro tipo relativo (upcast ou downcast).

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

Acesso a objetos

Ferramenta para refletir e acessar propriedades e métodos de objetos.

Obtenha o valor da propriedade

Retorna o valor da propriedade do objeto.

ObjectAccess::getPropertyValue(object $object, string $propertyName): mixed

Pode acessar a propriedade pelo nome ou pelo getter.

Lança SmorenTypeToolsExceptionsKeyError se a propriedade não estiver acessível para leitura.

 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

Definir valor da propriedade

Define o valor da propriedade do objeto.

ObjectAccess::setPropertyValue(object $object, string $propertyName, mixed $value): void

Pode acessar a propriedade pelo nome ou pelo setter.

Lança SmorenTypeToolsExceptionsKeyError se a propriedade não estiver acessível para gravação.

 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]

Possui propriedade legível

Retorna verdadeiro se o objeto tiver uma propriedade legível por nome ou por 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

Possui propriedade gravável

Retorna verdadeiro se o objeto tiver uma propriedade que possa ser escrita por nome ou por setter.

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

Possui propriedade pública

Retorna verdadeiro se o objeto tiver propriedade pública.

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

Possui método público

Retorna verdadeiro se o objeto tiver método público.

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

Tem propriedade

Retorna verdadeiro se o objeto tiver propriedade.

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

Tem método

Retorna verdadeiro se o objeto tiver método.

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

Acesso ao mapa

Ferramenta para acesso semelhante a um mapa de diferentes contêineres por meio de chaves de string.

Pode acessar:

propriedades de objetos (por nome ou por getter);
elementos de arrays e objetos ArrayAccess (por chave).

Pegar

Retorna o valor do contêiner por chave ou valor padrão se a chave não existir ou não estiver acessível.

Lança SmorenTypeToolsExceptionsKeyError se a chave não estiver acessível para leitura.

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

Definir

Define o valor do contêiner por chave.

MapAccess::set(mixed $container, string $key, mixed $value): void

Lança SmorenTypeToolsExceptionsKeyError se a chave não estiver acessível para gravação.

 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]

Existe

Retorna verdadeiro se existir uma chave acessível no contêiner.

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

Teste de unidade

 composer install
composer test-init
composer test

Licença

PHP Type Tools está licenciado sob a licença MIT.

Expandir