Inicio>código fuente PHP>Otras categorias
Descargar

Herramientas de tipo PHP

Ayudantes para diferentes operaciones con tipos de datos, variables y contenedores PHP.

Cómo instalar en su proyecto 

 composer require smoren/type-tools

Referencia rápida

Extractor único

Método Descripción Fragmento de código
getString Devuelve una cadena única de la variable dada UniqueExtractor::getString($var, $strict)
getHash Devuelve una cadena hash md5 única de la variable dada UniqueExtractor::getHash($var, $strict)

Tipo de objeto

Método Descripción Fragmento de código
cast Objeto fundido a otro tipo relativo ObjectTypeCaster::cast($sourceObject, $destinationClass)

Acceso a objetos

Método Descripción Fragmento de código
getPropertyValue Devuelve el valor de la propiedad del objeto. ObjectAccess::getPropertyValue($object, $propertyName)
setPropertyValue Establece el valor de la propiedad del objeto. ObjectAccess::setPropertyValue($object, $propertyName, $value)
hasReadableProperty Devuelve verdadero si el objeto tiene una propiedad legible por nombre o por captador ObjectAccess::hasReadableProperty($object, $propertyName)
hasWritableProperty Devuelve verdadero si el objeto tiene propiedad de escritura por nombre o por captador ObjectAccess::hasWritableProperty($object, $propertyName)
hasPublicProperty Devuelve verdadero si el objeto tiene propiedad pública ObjectAccess::hasPublicProperty($object, $propertyName)
hasPublicMethod Devuelve verdadero si el objeto tiene un método público ObjectAccess::hasPublicMethod($object, $methodName)
hasProperty Devuelve verdadero si el objeto tiene propiedad ObjectAccess::hasProperty($object, $propertyName)
hasMethod Devuelve verdadero si el objeto tiene método ObjectAccess::hasMethod($object, $methodName)

Acceso al mapa

Método Descripción Fragmento de código
get Devuelve valor del contenedor por clave MapAccess::get($container, $key, $defaultValue)
set Establece el valor del contenedor por clave MapAccess::set($container, $key, $value)
exists Devuelve verdadero si existe una clave accesible en el contenedor MapAccess::exists($container, $key)

Uso

Extractor único

Herramienta para extraer ID y hashes únicos de cualquier variable y estructura de datos de PHP.

Funciona en dos modos: estricto y no estricto.

En modo estricto:

  • escalares: únicos estrictamente por tipo;
  • objetos: únicos por instancia;
  • matrices: únicas por valor serializado;
  • recursos: el resultado es único por instancia.

En modo no estricto:

  • escalares: únicos por valor;
  • objetos: únicos por valor serializado;
  • matrices: únicas por valor serializado;
  • recursos: el resultado es único por instancia.

Obtener cadena

Devuelve una cadena única de la variable dada.

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

Obtener hachís

Devuelve una cadena hash md5 única de la variable dada.

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

Tipo de objeto

Herramienta para fundir tipos de objetos.

Elenco

Convertir objeto a otro tipo relativo (hacia arriba o hacia abajo).

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

Acceso a objetos

Herramienta para reflexionar y acceder a propiedades y métodos de objetos.

Obtener valor de propiedad

Devuelve el valor de la propiedad del objeto.

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

Puede acceder a la propiedad por su nombre o por captador.

Lanza SmorenTypeToolsExceptionsKeyError si no se puede acceder a la propiedad para su lectura. 

 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

Establecer valor de propiedad

Establece el valor de la propiedad del objeto.

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

Puede acceder a la propiedad por su nombre o por setter.

Lanza SmorenTypeToolsExceptionsKeyError si no se puede acceder a la propiedad para escribir. 

 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]

Tiene propiedad legible

Devuelve verdadero si el objeto tiene una propiedad que se puede leer por nombre o por captador.

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

Tiene propiedad grabable

Devuelve verdadero si el objeto tiene una propiedad que se puede escribir por nombre o por definidor.

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

Tiene propiedad pública

Devuelve verdadero si el objeto tiene propiedad 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

Tiene método público

Devuelve verdadero si el objeto tiene un 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

Tiene propiedad

Devuelve verdadero si el objeto tiene propiedad.

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

Tiene método

Devuelve verdadero si el objeto tiene 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

Acceso al mapa

Herramienta para acceder en forma de mapa a diferentes contenedores mediante claves de cadena.

Puede acceder a:

  • propiedades de los objetos (por nombre o por captador);
  • elementos de matrices y objetos ArrayAccess (por clave).

Conseguir

Devuelve el valor del contenedor por clave o valor predeterminado si la clave no existe o no es accesible.

Lanza SmorenTypeToolsExceptionsKeyError si no se puede acceder a la clave para leerla.

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

Colocar

Establece el valor del contenedor por clave.

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

Lanza SmorenTypeToolsExceptionsKeyError si no se puede acceder a la clave para escribir. 

 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

Devuelve verdadero si existe una clave accesible en el contenedor.

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

Pruebas unitarias 

 composer install
composer test-init
composer test

Licencia

PHP Type Tools tiene la licencia MIT.

Expandir
Información adicional
Aplicaciones relacionadas
Recomendado para ti
Información relacionada Todo