Download the PHP package andydefer/push-notifier without Composer
On this page you can find all versions of the php package andydefer/push-notifier. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download andydefer/push-notifier
More information about andydefer/push-notifier
Files in andydefer/push-notifier
Package push-notifier
Short Description A robust PHP package for sending push notifications via Firebase Cloud Messaging (FCM)
License MIT
Informations about the package push-notifier
PushNotifier
PushNotifier est un package PHP puissant et flexible (compatible avec tout framework ou application brute) pour l'envoi de notifications push via Firebase Cloud Messaging (FCM) v1. Construit avec une architecture robuste et orientée contrat (interfaces), il simplifie l'authentification et l'envoi de notifications, vous permettant d'intégrer des notifications fiables en quelques minutes.
📦 Installation
🚀 Démarrage Rapide
1. Obtenir les identifiants Firebase
- Allez dans la Console Firebase.
- Sélectionnez votre projet.
- Allez dans Paramètres du projet > Comptes de service.
- Cliquez sur Générer une nouvelle clé privée pour télécharger le fichier JSON du compte de service.
- Placez ce fichier dans un endroit sécurisé de votre projet (par exemple,
storage/app/firebase-credentials.json).
2. Envoyer votre première notification
🔗 Architecture et Concepts Clés
Le package est construit autour de plusieurs concepts puissants pour garantir flexibilité, testabilité et fiabilité dans n'importe quel environnement PHP.
1. La Factory comme Point d'Entrée Unique
La classe NotificationFactory est le point d'entrée principal. Elle centralise la création de vos services et vous permet d'injecter vos propres implémentations des composants de bas niveau (client HTTP, fournisseur d'auth). C'est le cœur de l'injection de dépendances du package.
2. Contrats pour la Flexibilité (Interfaces)
Le package est défini par des contrats (interfaces). Cela vous permet de remplacer n'importe quel composant interne par votre propre logique sans modifier le cœur du package.
HttpClientInterface: Pour utiliser un client HTTP différent.AuthProviderInterface: Pour gérer l'authentification Firebase d'une manière différente.PayloadBuilderInterface: Pour construire le payload FCM selon vos propres besoins (optionnel, une implémentation par défaut est fournie).
3. DTOs pour la Clarté et la Cohérence
Toutes les données manipulées par le package sont encapsulées dans des DTOs (Data Transfer Objects).
FirebaseConfigData: Contient la configuration Firebase.FcmMessageData: Représente le message à envoyer, avec une structure simple :type(string en SCREAMING_SNAKE_CASE) etdata(array avec clés en camelCase, valeurs must be strings).FcmResponseData: Représente la réponse de l'API FCM.HttpResponseData: Encapsule une réponse HTTP brute.
4. Exceptions Spécifiques
Le package lance des exceptions spécifiques pour chaque type d'erreur.
FcmSendException: Levée lors d'un échec d'envoi.FirebaseAuthException: Levée en cas de problème d'authentification.InvalidConfigurationException: Levée si la configuration Firebase est invalide.
📧 Création de Messages
Le DTO FcmMessageData a une structure simple et flexible :
type: string en SCREAMING_SNAKE_CASE (libre choix)data: array avec clés en camelCase (valeurs must be strings)
Types de Notifications Prédéfinis
Messages Personnalisés
Pour tous les autres types, utilisez la méthode make() :
🛠️ Utilisation Avancée
Envoyer à plusieurs appareils
Valider un token
Analyser les réponses d'erreur
⚙️ Configuration
Méthodes de Configuration
🧪 Tests
📚 API Complète
NotificationFactory
| Méthode | Description |
|---|---|
__construct(?HttpClientInterface, ?AuthProviderInterface) |
Constructeur avec injection optionnelle. |
makeFirebaseServiceFromJsonFile(string $path): FirebaseService |
Crée un service depuis un fichier JSON. |
makeFirebaseServiceFromJsonString(string $json): FirebaseService |
Crée un service depuis une chaîne JSON. |
makeFirebaseServiceFromArray(array $config): FirebaseService |
Crée un service depuis un tableau. |
makeFirebaseServiceFromEnv(array $env): FirebaseService |
Crée un service depuis les variables d'env. |
makeFirebaseService(FirebaseConfigData $config): FirebaseService |
Crée un service depuis un DTO. |
FirebaseService
| Méthode | Description |
|---|---|
send(string $token, FcmMessageData $message): FcmResponseData |
Envoie une notification. |
sendMulticast(array $tokens, FcmMessageData $message): array |
Envoie à plusieurs appareils. |
sendInfo(string $token, string $title, string $body): FcmResponseData |
Envoie une notification "INFO". |
ping(string $token): FcmResponseData |
Envoie une notification silencieuse "PING". |
validateToken(string $token): bool |
Vérifie si un token est valide. |
FcmMessageData
| Méthode Statique | Description |
|---|---|
make(string $type, array $data = []): self |
Crée un message personnalisé. |
info(string $title, string $body): self |
Crée un message "INFO". |
ping(): self |
Crée un message "PING" avec ['connected' => 'true']. |
FcmResponseData
| Méthode | Description |
|---|---|
fromFcmResponse(array $response, int $statusCode): self |
Crée depuis une réponse FCM. |
fromError(string $code, string $message, ?int $statusCode): self |
Crée depuis une erreur. |
isInvalidToken(): bool |
Vérifie si le token est invalide. |
isQuotaExceeded(): bool |
Vérifie si le quota est dépassé. |
isAuthError(): bool |
Vérifie s'il s'agit d'une erreur d'authentification. |
🤝 Contribution
Les contributions sont les bienvenues !
- Forkez le projet
- Créez une branche (
git checkout -b feature/ma-fonctionnalite) - Commitez (
git commit -m 'Ajoute une fonctionnalité') - Poussez (
git push origin feature/ma-fonctionnalite) - Ouvrez une Pull Request
📄 Licence
MIT
PushNotifier - Des notifications push simples et fiables avec PHP et Firebase. 🚀
All versions of push-notifier with dependencies
nesbot/carbon Version ^3.0
php Version ^8.1
spatie/laravel-data Version ^4.0