Download the PHP package quatrebarbes/snow-driver without Composer
On this page you can find all versions of the php package quatrebarbes/snow-driver. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download quatrebarbes/snow-driver
More information about quatrebarbes/snow-driver
Files in quatrebarbes/snow-driver
Package snow-driver
Short Description Driver de base de données Laravel pour accéder aux objets d'une plateforme ServiceNow au travers de modèles Eloquent.
License MIT
FAQ
Example:
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 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.
Informations about the package snow-driver
snow-driver
Plug-in Laravel fournissant un driver de base de données pour accéder aux objets d'une plateforme ServiceNow au travers de modèles Eloquent (API Table ServiceNow).
Fonctionnalités
- Connexion et authentification Basic Auth vers une instance ServiceNow, avec abstraction
Credentialspour permettre l'ajout futur d'autres modes (OAuth2 client credentials) - Client HTTP interne (
TableApiClient) et hiérarchie d'exceptions dédiées (ServiceNowConnectionException,ServiceNowAuthenticationException,ServiceNowApiException,ServiceNowMalformedResponseException) - Modèle Eloquent de base (
ServiceNowModel) mappantsys_id(clé primaire string) etsys_created_on/sys_updated_onsur les timestamps natifs Eloquent - Query builder traduisant
where,whereIn,whereNull,whereBetween,orderBy,limit/offsetensysparm_queryet paramètressysparm_*de l'API Table, avec pagination automatique transparente pourall()/get() - Comptage (
count(),paginate()) via la fonction d'agrégation de l'API ServiceNow, sans rapatrier les enregistrements, et test d'existence (exists()) borné à un enregistrement - Introspection du schéma via
Schema::connection()(liste des tables, colonnes typées, clés étrangères déduites des champs de référence) lue dans le dictionnaire de l'instance, avec cache applicatif configurable (schéma, comptage, liste des tables) pour les tables déclarées en génération de modèles - Génération automatique de modèles Eloquent (
servicenow.models.tables) au démarrage de l'application hôte :$fillable/$castsdéduits du dictionnaire, relationsbelongsTo/hasManygénérées entre tables configurées ServiceNowUnsupportedQueryExceptionpour toute clause du query builder sans équivalent ServiceNow (join, groupBy, agrégats autres que le comptage, sous-requêtes, etc.)
Prérequis
- PHP ^8.2
- Laravel 11, 12 ou 13 (
illuminate/database,illuminate/http,illuminate/support) - Service Now Zurich
Installation
Le service provider Quatrebarbes\SnowDriver\ServiceNowServiceProvider est auto-découvert par Laravel.
Publier la configuration :
Configuration
La connexion ServiceNow se déclare comme une connexion Laravel classique dans config/servicenow.php (ou directement dans config/database.php) :
Variables d'environnement correspondantes :
| Variable | Description | Défaut |
|---|---|---|
SNOW_CONNECTION |
Nom de la connexion par défaut | servicenow |
SNOW_BASE_URL |
URL de base de l'instance ServiceNow | — |
SNOW_TIMEOUT |
Timeout HTTP en secondes | 30 |
SNOW_AUTH_MODE |
Mode d'authentification | basic |
SNOW_USERNAME / SNOW_PASSWORD |
Identifiants Basic Auth | — |
SNOW_PAGE_SIZE |
Taille de page pour la pagination automatique (all()/get() sans limite explicite) |
10000 |
SNOW_MODELS_NAMESPACE |
Namespace PHP des modèles générés (servicenow.models.tables) |
App\Models |
SNOW_SCHEMA_CACHE_TTL |
Durée de validité (secondes) du cache de schéma/comptage/liste des tables ; 0 désactive le cache |
3600 |
La connexion est paresseuse : aucune requête n'est effectuée au boot de l'application, seulement à la première interrogation.
Utilisation
Introspection du schéma
Une connexion ServiceNow répond aux mêmes interrogations de schéma qu'une connexion SQL, lues dans le dictionnaire de l'instance (sys_db_object, sys_dictionary) : un outil Laravel générique d'exploration de données fonctionne donc sur une connexion ServiceNow sans rien connaître du driver.
Les types internes ServiceNow sont exposés sous les noms de types que Laravel reconnaît (boolean, integer, decimal, date, datetime, time, json, text, varchar) ; un type inconnu est exposé comme chaîne plutôt que de faire échouer l'introspection. Un champ de type reference est exposé comme clé étrangère vers sys_id de la table référencée — mais ServiceNow n'appliquant aucune contrainte d'intégrité référentielle, cette clé est descriptive.
La structure d'une table ServiceNow se modifie côté instance : les opérations de modification de schéma (Schema::create(), drop(), table()...) lèvent ServiceNowUnsupportedQueryException.
Pour les tables déclarées dans servicenow.models.tables (voir Génération automatique de modèles ci-dessous), ainsi que pour la liste des tables de l'instance, le schéma et le comptage sont mis en cache (SNOW_SCHEMA_CACHE_TTL) : une entrée expirée est servie telle quelle et rafraîchie de façon asynchrone après la réponse en cours, sans pénaliser la lecture qui l'a déclenchée.
Génération automatique de modèles
Déclarer les tables ServiceNow à modéliser dans config/servicenow.php :
Au démarrage de l'application hôte, un fichier de modèle Eloquent est généré (s'il n'existe pas déjà) pour chaque table déclarée : $table, $fillable (champs modifiables, champ display puis mandatory en tête, virtuels exclus) et $casts déduits du dictionnaire ServiceNow, relations belongsTo()/hasMany() générées entre les tables configurées. Un fichier déjà présent n'est jamais réécrit (personnalisation manuelle préservée).
Application de démonstration
Le dossier demo/ contient une application Laravel de démonstration (Blade, sans front JS) illustrant l'usage du driver : menu des tables ServiceNow configurées, liste paginée, détail d'un enregistrement, page d'erreur illustrant la hiérarchie d'exceptions.
Lancement via Docker :
L'application est alors disponible sur http://localhost:8000. Voir demo/README.md pour la configuration détaillée.
Tests
Les tests sont organisés en tests/Unit (une fonction = un test) et tests/Feature (un test par comportement/endpoint), via Orchestra Testbench.
Documentation
- Spécifications fonctionnelles détaillées : introspection du schéma
- Plan de développement et avancement : docs/roadmap.md
Licence
MIT
All versions of snow-driver with dependencies
illuminate/database Version ^11.0|^12.0|^13.0
illuminate/http Version ^11.0|^12.0|^13.0
illuminate/support Version ^11.0|^12.0|^13.0