Objet flexible

Objet de rendu.

render().

render( [layout], [context] ): Block Rend l'objet.

Paramètres:

  • layout Nom de la mise en page (string).
  • context Variables supplémentaires pouvant être utilisées dans le fichier de modèle Twig (array)

Retour:

  • Block (object) Classe HtmlBlock contenant la sortie.
REMARQUE : dans twig, il existe une balise {% render %}, qui doit être utilisée au lieu d'appeler directement la méthode. Cela permettra aux ressources JS/CSS de l'objet de fonctionner correctement.

- Twig

{% set contact = grav.get('flex').object('gizwsvkyo5xtms2s', 'contacts') %}

{% render contact layout: 'details' with { my_variable: true } %}

- PHP

use Grav\Common\Grav;
use Grav\Framework\ContentBlock\HtmlBlock;
use Grav\Framework\Flex\Interfaces\FlexObjectInterface;

/** @var FlexObjectInterface|null $collection */
$object = Grav::instance()->get('flex')->getObject('gizwsvkyo5xtms2s', 'contacts');
if ($object) {

    /** @var HtmlBlock $block */
    $block = $object->render('details', ['my_variable' => true]);

}

Other.

getKey().

getKey() :string` Récupère la clé de l'objet.

Retour:

  • string Clé d'objet

hasKey()

hasKey() : bool Renvoie vrai si la clé de l'objet a été définie.

Retour:

  • true si l'objet a une clé, false sinon

getFlexType().

getFlexType() : string Récupère le type de l'objet.

Retour:

  • string Nom du répertoire Flex auquel appartient l'objet.

hasProperty()

hasProperty( property ): bool Renvoie vrai si la propriété de l'objet a été définie et a une valeur (non nulle).

Paramètres:

  • property Nom de la propriété (string).

Retour:

  • true si la propriété a une valeur, false sinon.

getProperty().

getProperty( property, default ): mixed Renvoie la valeur de la propriété de l'objet.

Paramètres:

  • property Nom de la propriété (string).

Retour:

  • `mixed Valeur du bien.
  • null si la propriété n'est pas définie ou n'a pas de valeur.

setProperty().

setProperty( property, value ): Object Définit une nouvelle valeur pour la propriété de l'objet.

Paramètres:

  • property Nom de la propriété (string).
  • value Nouvelle valeur (mixed).

Retour:

  • Object (object) L'objet pour enchaîner les appels de méthode.
ATTENTION : Cette méthode modifie l'instance d'objet partagée entre toutes les collections. Si ce n'est pas prévu, veuillez cloner clonel'objet avant d'utiliser cette méthode.

defProperty().

defProperty( property, default ): Object Définit la valeur par défaut de la propriété de l'objet.

Paramètres:

  • property Nom de la propriété (string).
  • default Valeur par défaut (mixed).

Retour:

  • Object (object) L'objet pour enchaîner les appels de méthode.
ATTENTION : Cette méthode modifie l'instance d'objet partagée entre toutes les collections. Si ce n'est pas prévu, veuillez cloner clonel'objet avant d'utiliser cette méthode.

unsetProperty().

unsetProperty( property ): Object Supprime la valeur de la propriété de l'objet.

Paramètres:

  • property Nom de la propriété (string).

Retour:

  • Object (object) L'objet pour enchaîner les appels de méthode.
ATTENTION : Cette méthode modifie l'instance d'objet partagée entre toutes les collections. Si ce n'est pas prévu, veuillez cloner clonel'objet avant d'utiliser cette méthode.

isAuthorized().

isAuthorized( action, [portée], [utilisateur] ): bool | null Vérifie si l'utilisateur est autorisé pour l'action.

Paramètres:

  • action (string)
    • L'un des suivants : create, read, update, delete, list.
  • scope Facultatif (string)
    • Généralement admin ou site.
  • user Objet utilisateur facultatif (object)

Retour:

  • true Autoriser l'action.
  • false Refuser l'action.
  • `nullè Non défini (agit comme un refus)
NOTE : Il existe deux valeurs de refus : refusé (faux), non défini (null). Cela permet d'enchaîner plusieurs règles lorsque les règles précédentes ne correspondent pas.

getFlexDirectory().

getFlexDirectory() : Directory

Retour:

getTimestamp().

getTimestamp() : int Récupère le dernier horodatage modifié pour l'objet.

Retour:

  • int Horodatage.

search().

search(string, [properties], [options] ): float Recherche une chaîne à partir de l'objet, renvoie un poids compris entre 0 et 1.

Paramètres:

  • string Chaîne de recherche (string)
  • property Propriétés à rechercher, si null (ou non fournies), utilisez les valeurs par défaut * options Options supplémentaires utilisées lors de la recherche (tableau)
    • commence_par : bool
    • se termine par : bool
    • contient : bool
    • sensible à la casse : bool

Retour:

  • float Poids de la recherche entre 0 et 1, utilisé pour ordonner les résultats
  • 0 L'objet ne correspond pas à la recherche.
NOTE : Si vous remplacez cette fonction, assurez-vous de renvoyer une valeur comprise entre 0 et 1 !

getFlexKey().

getFlexKey() : string Récupère une clé unique pour l'objet.

Retour:

  • string Clé flexible de l'objet

Les clés flexibles peuvent être utilisées sans connaître le répertoire auquel appartient l'objet.

getStorageKey().

getStorageKey() : string Récupère une clé de stockage unique (dans le répertoire) utilisée pour déterminer le nom du fichier ou l'identifiant de la base de données.

Retour:

  • string Clé de stockage de l'objet.

exist().

exists() : bool Renvoie vrai si l'objet existe dans le stockage.

Retour:

  • true L'objet existe dans le stockage.
  • false L'objet n'a pas été enregistré.

update().

update( data, files ): Object Met à jour l'objet dans la mémoire.

Paramètres:

  • data (array) Tableaux imbriqués de propriétés avec leurs valeurs.
  • files (array) Tableau d'objets Psr\Http\Message\UploadedFileInterface.

Retour:

  • Object (object) L'objet pour enchaîner les appels de méthode.
NOTE : Vous devez enregistrer l'objet après avoir appelé cette méthode.

create().

create( [key] ): Object Crée un nouvel objet dans le stockage.

Paramètres:

  • key (string) Clé facultative.

Retour:

  • Object (object) Objet enregistré.

createCopy().

createCopy( [key] ): Object Crée un nouvel objet à partir de l'actuel et enregistre-le dans le stockage.

  • key (string) Clé facultative.

Retour:

  • Object (object) Objet enregistré.

save().

save() : Object Enregistrer l'objet dans le stockage.

Retour:

  • Object (object) Objet enregistré.

delete().

delete() : Object Supprime l'objet du stockage.

Retour:

  • Object (object) Objet supprimé.

getBlueprint().

getBlueprint( [name] ): Blueprint Renvoie le plan de l'objet.

Paramètres:

  • name (string) Nom facultatif du blueprint.

Retour:

  • Blueprint (object)

getForm().

getForm( [name], [options] ): Form Renvoie une instance de formulaire pour l'objet.

Paramètres:

  • name (string) Nom facultatif du formulaire.
  • options (array) Options facultatives du formulaire.

Retour:

  • Form (object)

getDefaultValue().

getDefaultValue( name, [separator] ): mixed Renvoie la valeur par défaut pouvant être utilisée dans un formulaire pour la propriété donnée.

Paramètres:

  • name (string) Nom de la propriété.
  • separator (string) Caractère séparateur facultatif pour les propriétés imbriquées, par défaut . (dot)

Retour:

  • mixed Valeur par défaut de la propriété.

getDefaultValues().

getDefaultValues() : array Renvoie les valeurs par défaut pouvant être utilisées dans un formulaire pour la propriété donnée.

Retour:

  • array Toutes les valeurs par défaut.

getFormValue().

getFormValue( name, [default], [separator] ): mixed Renvoie une valeur brute pouvant être utilisée dans un formulaire pour la propriété donnée.

Paramètres:

  • name (string) Nom de la propriété.
  • default (mixed) Valeur optionnelle par défaut du champ, null si non renseigné.
  • separator (string) Caractère séparateur facultatif pour les propriétés imbriquées, par défaut . (dot)

Retour:

  • |mixed` Valeur du champ du formulaire.

triggerEvent().

triggerEvent( name, [Event] ): Object Déclenche un événement de votre choix.

Paramètres:

  • name (string) Nom de l'événement.
  • Event (object) Classe d'événement facultative.

Retour:

  • Object (object) L'objet pour enchaîner les appels de méthode.