SaferDataset

La classe SaferDataset représente un ensemble de données pouvant être utilisé pour demander des données depuis diverses sources, les stocker et appliquer des middlewares. Cette classe est gérée par la classe SaferDatasetManager.

Propriétés

  • public Dict $options : Options pour le SaferDataset.
  • public array $middlewares : Tableau des middlewares à appliquer.
  • public array $data : Données du dataset.
  • public array $rawData : Données brutes du dataset.

Méthodes

__construct($options, $data = null, $middlewares = [])

public function __construct($options, $data = null, $middlewares = [])

Description

Constructeur de la classe SaferDataset.

Paramètres

  • options (array|stdClass|Dict) : Tableau des options pour le SaferDataset.
  • data (array|null) : Données initiales (optionnelles).
  • middlewares (array) : Tableau des middlewares (optionnel).

requestStaticData()

public function requestStaticData()

Description

Demande des données à partir d'une source statique.

Retour

  • void : Les données sont stockées dans la propriété data.

requestSqlData()

public function requestSqlData()

Description

Demande des données à partir d'une requête SQL.

Retour

  • void|string : Renvoie un message d'erreur si une erreur se produit lors de l'exécution de la requête SQL.
  • Exceptions
    • Lance une exception si la requête SQL n'est pas définie.
    • Lance une exception si la requête SQL n'a pas pu être exécutée.
    • Lance une exception si la requête SQL a retourné une erreur.

requestUrlData()

public function requestUrlData()

Description

Demande des données à partir d'une URL.

Retour

  • void|string : Renvoie un message d'erreur si l'URL n'est pas définie.
  • Exceptions
    • Lance une exception si l'URL n'est pas définie.

requestFunctionData()

public function requestFunctionData()

Description

Demande des données à partir d'une fonction.

Retour

  • void : Les données sont stockées dans la propriété data.
  • Exceptions
    • Lance une exception si le nom de la fonction n'est pas défini.
    • Lance une exception si la fonction n'a pas pu être exécutée.

requestRequestData()

public function requestRequestData()

Description

Demande des données à partir d'une requête définie.

Retour

  • void : Les données sont stockées dans la propriété data.
  • Exceptions
    • Lance une exception si la requête n'est pas définie.

applyMiddlewares($middlewares = [])

public function applyMiddlewares($middlewares = [])

Description

Applique les middlewares au dataset actuel.

Paramètres

  • middlewares (array) : Tableau des middlewares à appliquer (optionnel).

Retour

  • void : Les données sont modifiées en appliquant les middlewares.

requestData($middlewares = []): array

public function requestData($middlewares = []): array

Description

Demande des données depuis la source définie et applique les middlewares. La source peut être statique, SQL, URL, fonction ou requête.

Paramètres

  • middlewares (array) : Tableau des middlewares à appliquer (optionnel).

Retour

  • array : Les données demandées depuis la source.

toArray(): array

public function toArray(): array

Description

Convertit l'objet dataset en tableau.

Retour

  • array : Le dataset sous forme de tableau.

clone($options): SaferDataset

public function clone($options): SaferDataset

Description

Clone le dataset avec les options données.

Paramètres

  • options (array) : Options pour cloner le dataset.

Retour

  • SaferDataset : Le dataset cloné.

fromData($data): SaferDataset

public static function fromData($data): SaferDataset

Description

Crée un nouvel objet dataset à partir des données données.

Paramètres

  • data (mixed) : Données pour créer le dataset.

Retour

  • SaferDataset : Le nouvel objet dataset.

fromOptions($options)

public static function fromOptions($options)

Description

Crée un nouvel objet dataset à partir des options données.

Paramètres

  • options (array) : Options pour initialiser le dataset.

Retour

  • SaferDataset : Le nouvel objet dataset.

extends($middlewares): SaferDataset

public function extends($middlewares): SaferDataset

Description

Étend le dataset avec des middlewares supplémentaires.

Paramètres

  • middlewares (array) : Tableau des middlewares à ajouter.

Retour

  • SaferDataset : Le dataset étendu.