Download the PHP package andydefer/php-records without Composer

On this page you can find all versions of the php package andydefer/php-records. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of andydefer/php-records

Informations about the package php-records

PHP Records

⚠️ DEPRECATED / ABANDONED

Ce package n'est plus maintenu.

Utilisez plutôt : andydefer/domain-structures

Une bibliothèque PHP complète pour les structures de domaine : Value Objects, Records, Data DTO, Typed Collections, hydratation automatique et normalisation.

Migration

Une bibliothèque de structures de données typées pour la communication interne entre les couches de votre application.

PHP Version

Introduction

PHP Records est une bibliothèque qui remplace les tableaux bruts (array) par des structures de données typées, immuables et prévisibles.

Le problème

La solution

Problème des tableaux Solution avec Record
On ne sait pas ce qu'ils contiennent Propriétés typées explicites
Pas de validation à l'ajout Types garantis à la construction
Documentation implicite Auto-documenté par le code
Refactoring dangereux Le compilateur guide les modifications

Installation

Prérequis

Concept fondamental

Qu'est-ce qu'un Record ?

Un Record est une structure de données typée utilisée pour la communication interne entre les couches de l'application (Services, Repositories, Tasks, Workers).

Philosophie

Un Record est un sac de données typé, sans aucune logique métier. Il ne fait que transporter des données d'un point A à un point B.

Séparation des responsabilités

Composant Rôle
Record Communication interne (Services, Repositories)
Service Logique métier
Data/Resource Réponse API (si nécessaire dans votre architecture)

Les Records

Définition d'un Record

Règles fondamentales

Règle Explication
Étendre AbstractRecord Tous les Records doivent hériter de la classe abstraite
Nommage {Description}Record Ex: UserRecord, PaymentResultRecord
Propriétés public La sérialisation automatique utilise la réflexion
readonly recommandé Immuabilité garantie
Pas de logique métier Ni isValid(), ni save(), ni autre méthode métier

Types autorisés dans un Record

Type Exemple Notes
int public readonly int $id Scalaire
string public readonly string $name Scalaire
float public readonly float $price Scalaire
bool public readonly bool $isActive Scalaire
null public readonly ?string $value Nullable
Enum public readonly UserRole $role Backed enum recommandé
Record public readonly AddressRecord $address Record imbriqué
TypedCollection public readonly TypedCollection $items Collection typée

Types à éviter (ou à convertir avant)

Type Alternative Pourquoi
array brut TypedCollection Perte d'information sur le contenu
Model (Eloquent) UserRecord, DoctorRecord Contient de la logique et des relations
Collection TypedCollection Non typée
Carbon / DateTime string ISO 8601 Contient des comportements

Le Record optionnel : EmptyRecord

Pour les cas où un paramètre Record est optionnel, utilisez EmptyRecord plutôt que null :

Avec null Avec EmptyRecord
$filters?->toArray() ?? [] $filters->toArray()
Condition ternaire partout Pas de condition
Risque d'erreur Type-safe garanti

Sérialisation automatique

AbstractRecord fournit trois méthodes de sérialisation :

Normalisation automatique

Type d'entrée Sortie
Record imbriqué array via toArray()
TypedCollection array typé
BackedEnum Valeur scalaire ($enum->value)
PureEnum Nom de l'enum ($enum->name)
DateTimeInterface Y-m-d\TH:i:s\Z
null null (conservé)

Conversion snake_case

Toutes les clés sont automatiquement converties en snake_case :

Les TypedCollection

Définition

TypedCollection est une collection type-safe qui remplace les tableaux bruts. Elle garantit que tous les éléments qu'elle contient sont du type déclaré à la construction.

Pourquoi remplacer les tableaux ?

Problème des tableaux Solution avec TypedCollection
On ne sait pas ce qu'ils contiennent Type explicite (TypedCollection<string>)
Pas de validation à l'ajout Validation automatique
Modification dangereuse Type-safe garanti
Pas de méthodes utilitaires Nombreuses méthodes disponibles

Types supportés

Type Description Exemple
'int' Entier new TypedCollection('int')
'string' Chaîne new TypedCollection('string')
'float' Décimal new TypedCollection('float')
'bool' Booléen new TypedCollection('bool')
'null' Null new TypedCollection('string', 'null')
Record::class Record new TypedCollection(UserRecord::class)
TypedCollection::class Collection imbriquée new TypedCollection(TypedCollection::class)
stdClass::class Objet simple new TypedCollection(stdClass::class)

Types multiples

Règle : Record vs Collection

Un Record représente un ÉLÉMENT UNIQUE. Une collection d'éléments utilise TypedCollection.

Situation Type à utiliser
Un seul utilisateur UserRecord $user
Plusieurs utilisateurs TypedCollection $users

Création d'une collection

Méthodes de base

Méthode Description Exemple
add(...$items) Ajoute des éléments $tags->add('a', 'b', 'c')
toArray(): array Retourne tous les éléments $tags->toArray()
count(): int Nombre d'éléments $tags->count()
isEmpty(): bool Collection vide ? $tags->isEmpty()
isNotEmpty(): bool Collection non vide ? $tags->isNotEmpty()
getAllowedTypes(): array Types autorisés $tags->getAllowedTypes()
firstItem(): mixed Premier élément $tags->firstItem()
first(int $limit): static N premiers éléments $tags->first(3)
lastItem(): mixed Dernier élément $tags->lastItem()
last(int $limit): static N derniers éléments $tags->last(3)

Transformation et requêtes

Méthode Description Exemple
every(Closure): bool Tous les éléments satisfont ? $collection->every(fn($i) => $i > 0)
some(Closure): bool Un élément satisfait ? $collection->some(fn($i) => $i > 10)
map(Closure): static Transforme chaque élément $tags->map(fn($t) => strtoupper($t))
filter(Closure): static Filtre les éléments $tags->filter(fn($t) => strlen($t) > 3)
reject(Closure): static Rejette les éléments $tags->reject(fn($t) => strlen($t) > 3)
each(Closure): static Action sur chaque élément $tags->each(fn($t) => echo $t)
sort(int): static Trie les éléments $numbers->sort()
sortBy(Closure|string, bool): static Trie par clé/fonction $products->sortBy('price')
reverse(): static Inverse l'ordre $collection->reverse()
shuffle(): static Mélange aléatoirement $collection->shuffle()

Calculs

Méthode Description Exemple
sum(?Closure): int|float Somme $numbers->sum() ou $orders->sum(fn($o) => $o->price)
avg(?Closure): ?float Moyenne $numbers->avg()
max(?Closure): mixed Valeur max $numbers->max()
min(?Closure): mixed Valeur min $numbers->min()

Filtrage par type

Méthode Description Exemple
ofType(string): static Filtrer par type $collection->ofType('string')
exceptType(string): static Exclure un type $collection->exceptType('int')
records(): static Filtrer les Records $collection->records()
scalars(): static Filtrer les scalaires $collection->scalars()
ofRecord(string): static Filtrer par classe Record $collection->ofRecord(UserRecord::class)
anyRecord(): static Tous les Records $collection->anyRecord()
getTypes(): static Types distincts présents $collection->getTypes()

Recherche et présence

Méthode Description Exemple
where(string, mixed): static Filtrer par propriété $products->where('price', 100)
whereNotNull(string): static Propriété non nulle $products->whereNotNull('price')
whereNull(string): static Propriété nulle $products->whereNull('price')
contains(mixed): bool Élément existe ? $tags->contains('laravel')
containsType(string): bool Type présent ? $collection->containsType('int')
isOnlyType(string): bool Tous du même type ? $collection->isOnlyType('int')

Slicing et pagination

Méthode Description Exemple
take(int): static N premiers $collection->take(10)
skip(int): static Ignorer N premiers $collection->skip(5)
slice(int, ?int): static Extraire une plage $collection->slice(2, 3)
nth(int, int): static Un élément sur N $collection->nth(2)
values(): static Réindexer les clés $filtered->values()

Manipulation avancée

Méthode Description Exemple
unique(?Closure): static Supprimer doublons $collection->unique()
merge(self): static Fusionner $c1->merge($c2)
intersect(self): static Éléments communs $c1->intersect($c2)
diff(self): static Éléments uniques $c1->diff($c2)
flatMap(Closure): static Aplatir $nested->flatMap(fn($i) => $i)
filterNull(): static Supprimer null $collection->filterNull()
random(int): static Éléments aléatoires $collection->random(3)

Validation et assertions

Méthode Description
isHomogeneous(): bool Tous les éléments du même type ?
isHeterogeneous(): bool Types différents ?
assertAllOfType(string): self Vérifie que tous sont d'un type
assertNotEmpty(): self Vérifie non vide
assertContainsType(string): self Vérifie qu'un type est présent
assertAllImplement(string): self Vérifie l'implémentation
assertScalar(): self Vérifie que tous sont scalaires
assertRecords(): self Vérifie que tous sont des Records
validate(Closure): self Validation personnalisée

Les collections utilitaires

Le package fournit des collections pré-typées pour les cas d'usage les plus courants.

StringTypedCollection

Collection spécialisée pour les chaînes de caractères.

Méthodes disponibles

Méthode Description Exemple
toLowercase(): self Convertit en minuscules $strings->toLowercase()
toUppercase(): self Convertit en majuscules $strings->toUppercase()
containsSubstring(string): self Filtre par sous-chaîne $strings->containsSubstring('ell')
startsWith(string): self Filtre par préfixe $strings->startsWith('he')
endsWith(string): self Filtre par suffixe $strings->endsWith('lo')
filterEmpty(): self Supprime les chaînes vides $strings->filterEmpty()
trim(string): self Supprime les espaces $strings->trim()
truncate(int, string): self Limite la longueur $strings->truncate(5, '...')
matchingRegex(string): self Filtre par regex $strings->matchingRegex('/^\d+$/')
join(string): string Joint toutes les chaînes $strings->join(', ')
lengths(): TypedCollection<int> Longueurs des chaînes $strings->lengths()
pad(int, string, int): self Padde les chaînes $strings->pad(10, '-')
replace(string|array, string|array): self Remplace des valeurs $strings->replace('hello', 'hi')
firstCharacter(): self Premier caractère $strings->firstCharacter()
lastCharacter(): self Dernier caractère $strings->lastCharacter()
substring(int, ?int): self Extrait une sous-chaîne $strings->substring(0, 3)
countMatchingRegex(string): int Compte les regex $strings->countMatchingRegex('/\d/')
hasMatchingRegex(string): bool Vérifie si match $strings->hasMatchingRegex('/\d/')
uniqueCaseInsensitive(): self Valeurs uniques (insensible) $strings->uniqueCaseInsensitive()
sortCaseInsensitive(bool): self Tri insensible $strings->sortCaseInsensitive()
removeWhitespace(): self Supprime les espaces $strings->removeWhitespace()
slugify(): self Convertit en slug URL $strings->slugify()
wrap(string, ?string): self Encadre les chaînes $strings->wrap('[', ']')
removePrefix(string): self Supprime un préfixe $strings->removePrefix('pre_')
removeSuffix(string): self Supprime un suffixe $strings->removeSuffix('_suf')

Exemples d'utilisation

IntTypedCollection

Collection spécialisée pour les entiers.

Méthodes disponibles

Méthode Description Exemple
even(): self Nombres pairs $numbers->even() → [2, 4, 6, 8, 10]
odd(): self Nombres impairs $numbers->odd() → [1, 3, 5, 7, 9]
zero(): self Zéros $numbers->zero()
nonNegative(): self Non négatifs $numbers->nonNegative()
median(): float Médiane $numbers->median() → 5.5

Exemples d'utilisation

FloatTypedCollection

Collection spécialisée pour les nombres décimaux.

Méthodes disponibles

Méthode Description Exemple
round(int): self Arrondit à une précision $floats->round(2) → [1.23, 2.57, 3.89]
ceil(): self Entier supérieur $floats->ceil() → [2.0, 3.0, 4.0]
floor(): self Entier inférieur $floats->floor() → [1.0, 2.0, 3.0]
format(int): self Arrondit (alias de round) $floats->format(1) → [1.2, 2.6, 3.9]

BoolTypedCollection

Collection spécialisée pour les booléens.

Méthodes disponibles

Méthode Description Exemple
trueOnly(): self Uniquement true $bools->trueOnly() → [true, true, true]
falseOnly(): self Uniquement false $bools->falseOnly() → [false, false]
countTrue(): int Nombre de true $bools->countTrue() → 3
countFalse(): int Nombre de false $bools->countFalse() → 2
allTrue(): bool Tous true ? $bools->allTrue() → false
allFalse(): bool Tous false ? $bools->allFalse() → false
anyTrue(): bool Au moins un true ? $bools->anyTrue() → true
anyFalse(): bool Au moins un false ? $bools->anyFalse() → true

NumberTypedCollection

Collection pour les nombres mixtes (int + float).

Méthodes disponibles

Méthode Description Exemple
positive(): self Nombres positifs (> 0) Hérité de AbstractNumberTypedCollection
negative(): self Nombres négatifs (< 0) Hérité de AbstractNumberTypedCollection
between(int\|float, int\|float): self Intervalle Hérité de AbstractNumberTypedCollection
average(): float Moyenne Hérité de AbstractNumberTypedCollection
zero(): self Zéros (0 ou 0.0) $numbers->zero()
nonNegative(): self Non négatifs (>= 0) $numbers->nonNegative()
areAllIntegers(): bool Tous entiers ? $numbers->areAllIntegers() → false
hasAnyFloat(): bool Au moins un float ? $numbers->hasAnyFloat() → true
toFloats(): FloatTypedCollection Convertit en floats $numbers->toFloats() → [1.0, 2.5, 3.0, 4.7, 5.0]
toIntegers(): IntTypedCollection Convertit en ints $numbers->toIntegers() → [1, 2, 3, 4, 5]
separateTypes(): array Sépare ints et floats $numbers->separateTypes()

Exemples d'utilisation

AbstractNumberTypedCollection

Classe de base pour les collections numériques.

Méthodes statiques

Méthode Description Exemple
range(start, end, step): static Génère une séquence IntTypedCollection::range(1, 10, 2) → [1, 3, 5, 7, 9]

Création de collections personnalisées

L'interface Recordable

Tous les Records implémentent automatiquement cette interface via AbstractRecord.

Utilisation dans une signature

Le trait Enumable

Le trait Enumable ajoute des méthodes utilitaires à vos énumérations PHP 8.1+.

Méthodes disponibles

Méthode Description Exemple
values(): array Retourne toutes les valeurs UserRole::values() → ['admin', 'user', 'guest']
names(): array Retourne tous les noms UserRole::names() → ['ADMIN', 'USER', 'GUEST']
typesInOrder(): array Retourne les cas dans l'ordre UserRole::typesInOrder()
isValid(string\|int): bool Vérifie si une valeur existe UserRole::isValid('admin') → true
fromValue(string\|int): ?self Récupère un cas par sa valeur UserRole::fromValue('admin') → UserRole::ADMIN

Exemple complet

Bonnes pratiques

1. Toujours typer explicitement les TypedCollection

2. Utiliser EmptyRecord plutôt que null

3. Préférer les BackedEnum

4. Ne pas mettre de logique métier dans un Record

5. Convertir avant la construction

6. Valeur par défaut pour les collections

7. Un Record = un élément, TypedCollection = plusieurs

8. Utiliser every() et some() pour les validations

Exemples complets

Record simple

Record avec Enum et TypedCollection

Service qui utilise un Record

Repository avec Record

Appel API externe avec Record

Record avec d'autres Records

Manipulation de TypedCollection dans un Service

Utilisation avancée des StringTypedCollection

API Reference

AbstractRecord

Méthode Retour Description
toArray() array<string, mixed> Convertit en tableau (conserve null)
toDatabase() array<string, mixed> Convertit en tableau (exclut null)
toJson() string Convertit en JSON

TypedCollection

Méthode Retour Description
add(...$items) self Ajoute des éléments
toArray() array Tous les éléments
count() int Nombre d'éléments
isEmpty() bool Collection vide ?
isNotEmpty() bool Collection non vide ?
getAllowedTypes() array<string> Types autorisés
firstItem() mixed|null Premier élément
first(int $limit) self N premiers éléments
lastItem() mixed|null Dernier élément
last(int $limit) self N derniers éléments
every(Closure) bool Tous satisfont ?
some(Closure) bool Un satisfait ?
map(Closure) self Transforme chaque élément
filter(Closure) self Filtre les éléments
reject(Closure) self Rejette les éléments
each(Closure) self Exécute une action
sort(int) self Trie les éléments
sortBy(Closure\|string, bool) self Trie par clé/fonction
reverse() self Inverse l'ordre
shuffle() self Mélange aléatoirement
sum(?Closure) int\|float Somme
avg(?Closure) ?float Moyenne
max(?Closure) mixed Valeur max
min(?Closure) mixed Valeur min
ofType(string) self Filtrer par type
exceptType(string) self Exclure un type
records() self Filtrer les Records
scalars() self Filtrer les scalaires
ofRecord(string) self Filtrer par classe Record
anyRecord() self Tous les Records
getTypes() self Types distincts
where(string, mixed) self Filtrer par propriété
whereNotNull(string) self Propriété non nulle
whereNull(string) self Propriété nulle
contains(mixed) bool Élément existe ?
containsType(string) bool Type présent ?
isOnlyType(string) bool Tous du même type ?
take(int) self N premiers
skip(int) self Ignorer N premiers
slice(int, ?int) self Extraire une plage
nth(int, int) self Un élément sur N
values() self Réindexer
unique(?Closure) self Supprimer doublons
merge(self) self Fusionner
intersect(self) self Éléments communs
diff(self) self Éléments uniques
flatMap(Closure) self Aplatir
filterNull() self Supprimer null
random(int) self Éléments aléatoires
isHomogeneous() bool Tous du même type ?
isHeterogeneous() bool Types différents ?
assertAllOfType(string) self Vérifie le type
assertNotEmpty() self Vérifie non vide
assertContainsType(string) self Vérifie présence type
assertAllImplement(string) self Vérifie interface
assertScalar() self Vérifie scalaire
assertRecords() self Vérifie Record
validate(Closure) self Validation

StringTypedCollection

Méthode Retour Description
toLowercase() self Convertit en minuscules
toUppercase() self Convertit en majuscules
containsSubstring(string) self Filtre par sous-chaîne
startsWith(string) self Filtre par préfixe
endsWith(string) self Filtre par suffixe
filterEmpty() self Supprime les chaînes vides
trim(string) self Supprime les espaces
truncate(int, string) self Limite la longueur
matchingRegex(string) self Filtre par regex
join(string) string Joint toutes les chaînes
lengths() TypedCollection<int> Longueurs des chaînes
pad(int, string, int) self Padde les chaînes
replace(string\|array, string\|array) self Remplace des valeurs
firstCharacter() self Premier caractère
lastCharacter() self Dernier caractère
substring(int, ?int) self Extrait une sous-chaîne
countMatchingRegex(string) int Compte les regex
hasMatchingRegex(string) bool Vérifie si match
uniqueCaseInsensitive() self Valeurs uniques (insensible)
sortCaseInsensitive(bool) self Tri insensible à la casse
removeWhitespace() self Supprime les espaces
slugify() self Convertit en slug URL
wrap(string, ?string) self Encadre les chaînes
removePrefix(string) self Supprime un préfixe
removeSuffix(string) self Supprime un suffixe

IntTypedCollection

Méthode Retour Description
even() self Nombres pairs
odd() self Nombres impairs
median() float Médiane
zero() self Zéros
nonNegative() self Non négatifs

FloatTypedCollection

Méthode Retour Description
round(int) self Arrondit à une précision
ceil() self Entier supérieur
floor() self Entier inférieur
format(int) self Arrondit (alias)

BoolTypedCollection

Méthode Retour Description
trueOnly() self Uniquement true
falseOnly() self Uniquement false
countTrue() int Nombre de true
countFalse() int Nombre de false
allTrue() bool Tous true ?
allFalse() bool Tous false ?
anyTrue() bool Au moins un true ?
anyFalse() bool Au moins un false ?

NumberTypedCollection

Méthode Retour Description
positive() self Nombres positifs (> 0)
negative() self Nombres négatifs (< 0)
between(int\|float, int\|float) self Intervalle
average() float Moyenne
zero() self Zéros (0 ou 0.0)
nonNegative() self Non négatifs (>= 0)
areAllIntegers() bool Tous entiers ?
hasAnyFloat() bool Au moins un float ?
toFloats() FloatTypedCollection Convertit en floats
toIntegers() IntTypedCollection Convertit en ints
separateTypes() array Sépare ints et floats

AbstractNumberTypedCollection

Méthode Retour Description
positive() self Nombres positifs (> 0)
negative() self Nombres négatifs (< 0)
between(int\|float, int\|float) self Intervalle
average() float Moyenne
range(start, end, step) static Génère une séquence

Licence

MIT © Andy Defer

All versions of php-records with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package andydefer/php-records contains the following files

Loading the files please wait ...