# Interfaces

# NelsonMartell\Collections\ICollection

Define métodos para manipular colecciones de objetos.

# Constants

This interface has not constants.

# \NelsonMartell\Collections\ICollection Methods

public function add( mixed $item ) : void

public function clear(  ) : void

public function contains( mixed $item ) : boolean

public function getCount(  ) : integer

public function remove( mixed $item ) : boolean

# NelsonMartell\Collections\IList

Representa una colección de objetos a los que se puede tener acceso por un índice.

# Constants

This interface has not constants.

# \NelsonMartell\Collections\IList Methods

public function indexOf( mixed $item ) : integer

public function insert( integer $index, mixed $item ) : void

public function removeAt( integer $index ) : boolean

# NelsonMartell\IComparable

Provides a generalized comparison method useful for sorting objects.

# Constants

This interface has not constants.

# \NelsonMartell\IComparable Methods

public function compareTo( mixed $other ) : integer|null

# NelsonMartell\IComparer

Exposes a method that compares two objects

# Constants

This interface has not constants.

# \NelsonMartell\IComparer Methods

public static function compare( mixed $left, mixed $right ) : integer|null

# NelsonMartell\IConvertibleToJson

Provides methods to convert objets into JSON string.

# Constants

This interface has not constants.

# \NelsonMartell\IConvertibleToJson Methods

public function toJson(  ) : string

# NelsonMartell\IConvertibleToString

Provides methods to convert objets into string representations.

# Constants

This interface has not constants.

# \NelsonMartell\IConvertibleToString Methods

public function __toString(  ) : string

public function toString(  ) : string

# NelsonMartell\ICustomPrefixedPropertiesContainer

Allows use custom getter/setter prefixes in a class in addition to default "get*" and "set*".

Access type of method should be marked as final since currently do not allows using multiple custom properties.

• Notes
• Avoid the use of custom prefixes. If you need to, maybe you could try to rename methods instead first.

# Constants

This interface has not constants.

# \NelsonMartell\ICustomPrefixedPropertiesContainer Methods

public static function getCustomGetterPrefix(  ) : string

public static function getCustomSetterPrefix(  ) : string

# NelsonMartell\IEquatable

Provides a generalized method to compare equality of a class instance with a compatible object.

# Constants

This interface has not constants.

# \NelsonMartell\IEquatable Methods

public function equals( mixed $other ) : boolean

# NelsonMartell\IMagicPropertiesContainer

Mark a class that defines (some of) its properties as DocBlock by using @property, @property-read or @property-write tags.

\NelsonMartell\PropertiesHandler trait will search for property definition in class DocBlock comment. They must be valid, containing at least the type and name: @<property|property-read|property-write> <types> <name>.

Examples:

This will be detected:

// ...
// * @property-write string  $name  Some description
// * @property-read float    $age   Another description
// * @property int[]|float[] $items

This will not be detected:

// ...
// * @property int| string   $invalidTypesSeparation
// * @property int|string    $ invalid name

# Constants

This interface has not constants.

# \NelsonMartell\IMagicPropertiesContainer Methods

This interface has not methods.

# NelsonMartell\IStrictPropertiesContainer

Mark a class as implementing strict properties only.

All classes using PropertiesHandler trait should be marked with this interface.

# Constants

This interface has not constants.

# \NelsonMartell\IStrictPropertiesContainer Methods

public function __get( string $name ) : mixed

public function __set( string $name, mixed $value ) : void

This document was automatically generated, from source code comments, using phpDocumentor (opens new window) with the VuePress template (opens new window).