Sf TIC Bundles

SendNotificationCommand extends TICCommand
in package
Uses ManagerTrait

Commande de génération et d'envoi de notification par email.

Table of Contents

Properties

$ctxBundle  : mixed
nom du sous-dossier du controlleur (ex: '', 'Admin', 'Front', ...)
$ctxClass  : mixed
$ctxForm  : mixed
nom dans les tokens génériques (ex: 'item', 'user', 'book", 'foobar')
$ctxMesg  : mixed
préfixe utilisé pour les tokens (ex: 'app.foobar.', 'admin.foobar.', 'ticdemo.foobar.')
$ctxName  : mixed
espace de nommage de base du bundle (ex: 'App', 'TIC\DemoBundle')
$ctxPath  : mixed
nom du controlleur en camel case (ex: 'Default', 'User', 'Book', 'FooBar', ...)
$ctxRoot  : mixed
type de la classe courante (ex: 'Controller', 'Command')
$ctxRoute  : mixed
nom du controlleur en snake case (ex: 'default', 'book', 'foo_bar')
$ctxSnake  : mixed
alias du bundle pour repo, views... (ex: null, '@TICDemo')
$ctxTrans  : mixed
préfixe utilisé pour les routes (ex: 'app_foobar_', 'admin_foobar_', 'ticdemo_foobar_')
$ctxType  : mixed
nom complet de la classe courante (ex: 'App\Controller\Admin\FooBarController')
$defaultDescription  : mixed
$defaultName  : mixed
$em  : EntityManagerInterface
$io  : mixed
$mailer  : mixed
$out  : mixed
$params  : mixed
$router  : mixed
$test  : mixed
$translator  : mixed

Methods

__construct()  : mixed
{@inheritDoc}
EmDisableFilter()  : bool
Désactivation d'un filtre de l'ORM (seulement si l'extension est activée).
EmDisableLogger()  : void
Désactivation du journal de l'ORM (optimisation en cas de nombreuses requêtes).
EmEnableFilter()  : bool
Activation d'un filtre de l'ORM (seulement si l'extension est désactivée).
setContextProperties()  : void
DI avec auto-wiring (inutile de définir le "call" sur le service grace à l'attribut @required).
setEntityManager()  : void
DI avec auto-wiring (inutile de définir le "call" sur le service grace à l'attribut @required).
setMailer()  : void
DI avec auto-wiring (inutile de définir le "call" sur le service grace à l'attribut @required).
configure()  : void
{@inheritDoc}
deleteEntity()  : string|null
Exécution de la suppression d'une entité en BdD.
execute()  : int
{@inheritDoc}
exitError()  : mixed
Méthode utile pour afficher un message d'erreur, suivi du synopsis de la commande, puis exit 1.
getContextProperties()  : array<string|int, mixed>
Retourne la liste des propriétés définies dans un tableaux (utile pour du debug).
getItem()  : object|null
Raccourci pour rechercher dans la BdD l'instance de l'entité correspondant à la clé donnée.
getRepo()  : EntityRepository
Raccourci pour obtenir le repository d'une entité (en utilisant le contexte de la classe).
harddeleteEntity()  : string|null
Exécution de la suppression d'une entité en BdD en coupant si possible le softdelete.
initialize()  : mixed
{@inheritDoc}
isAlreadyRunning()  : bool|null
Méthode testant si un autre processus pour la même commande est déjà en cours d'exécution.
listrefs()  : int
Retourne la liste des modèles de notification disponibles.
saveEntity()  : string|null
Exécution de l'enregistrement d'une entité en BdD.
sendmail()  : int
Génère et envoi par email un message de notification.
trans()  : string

Properties

$ctxBundle

nom du sous-dossier du controlleur (ex: '', 'Admin', 'Front', ...)

protected mixed $ctxBundle

$ctxForm

nom dans les tokens génériques (ex: 'item', 'user', 'book", 'foobar')

protected mixed $ctxForm

$ctxMesg

préfixe utilisé pour les tokens (ex: 'app.foobar.', 'admin.foobar.', 'ticdemo.foobar.')

protected mixed $ctxMesg = 'item'

$ctxName

espace de nommage de base du bundle (ex: 'App', 'TIC\DemoBundle')

protected mixed $ctxName

$ctxPath

nom du controlleur en camel case (ex: 'Default', 'User', 'Book', 'FooBar', ...)

protected mixed $ctxPath

$ctxRoot

type de la classe courante (ex: 'Controller', 'Command')

protected mixed $ctxRoot

$ctxRoute

nom du controlleur en snake case (ex: 'default', 'book', 'foo_bar')

protected mixed $ctxRoute

$ctxSnake

alias du bundle pour repo, views... (ex: null, '@TICDemo')

protected mixed $ctxSnake

$ctxTrans

préfixe utilisé pour les routes (ex: 'app_foobar_', 'admin_foobar_', 'ticdemo_foobar_')

protected mixed $ctxTrans

$ctxType

nom complet de la classe courante (ex: 'App\Controller\Admin\FooBarController')

protected mixed $ctxType

$defaultDescription

protected static mixed $defaultDescription = null

$defaultName

protected static mixed $defaultName = null

Methods

__construct()

{@inheritDoc}

public __construct(RouterInterface $router, TranslatorInterface $translator, ParameterBagInterface $params) : mixed
Parameters
$router : RouterInterface
$translator : TranslatorInterface
$params : ParameterBagInterface

EmDisableFilter()

Désactivation d'un filtre de l'ORM (seulement si l'extension est activée).

public EmDisableFilter(string $filter) : bool
Parameters
$filter : string
Return values
bool

EmDisableLogger()

Désactivation du journal de l'ORM (optimisation en cas de nombreuses requêtes).

public EmDisableLogger() : void

EmEnableFilter()

Activation d'un filtre de l'ORM (seulement si l'extension est désactivée).

public EmEnableFilter(string $filter) : bool
Parameters
$filter : string
Return values
bool

setContextProperties()

DI avec auto-wiring (inutile de définir le "call" sur le service grace à l'attribut @required).

public setContextProperties([string|null $classType = null ]) : void
Parameters
$classType : string|null = null
Tags
see
https://symfony.com/doc/current/service_container/injection_types.html#setter-injection
see
https://symfony.com/doc/current/service_container/autowiring.html#autowiring-other-methods-e-g-setters-and-public-typed-properties
required

deleteEntity()

Exécution de la suppression d'une entité en BdD.

protected deleteEntity(object $entity) : string|null
Parameters
$entity : object

Entité à supprimer

Return values
string|null —

Message d'erreur ou null en cas de succès

execute()

{@inheritDoc}

protected execute(InputInterface $input, OutputInterface $output) : int
Parameters
$input : InputInterface
$output : OutputInterface
Return values
int

exitError()

Méthode utile pour afficher un message d'erreur, suivi du synopsis de la commande, puis exit 1.

protected exitError(string $message[, int $code = 1 ]) : mixed
Parameters
$message : string
$code : int = 1

getContextProperties()

Retourne la liste des propriétés définies dans un tableaux (utile pour du debug).

protected getContextProperties() : array<string|int, mixed>
Return values
array<string|int, mixed>

getItem()

Raccourci pour rechercher dans la BdD l'instance de l'entité correspondant à la clé donnée.

protected getItem([mixed $primary = null ][, bool $no_exception = false ]) : object|null
Parameters
$primary : mixed = null

Clé primaire (id) ou null pour création d'une instance

$no_exception : bool = false

Ne pas lancer d'exception si l'entité n'est pas trouvée (retourne null)

Return values
object|null —

Instance de l'entité créée ou récupérée selon la clé primaire

getRepo()

Raccourci pour obtenir le repository d'une entité (en utilisant le contexte de la classe).

protected getRepo([string|null $itemName = null ]) : EntityRepository
Parameters
$itemName : string|null = null

Nom court de l'entité (par défaut celle associée à la classe courante) ou nom complet (si besoin d'un repository provenant d'un autre bundle)

Return values
EntityRepository

harddeleteEntity()

Exécution de la suppression d'une entité en BdD en coupant si possible le softdelete.

protected harddeleteEntity(object $entity) : string|null
Parameters
$entity : object

Entité à supprimer

Return values
string|null —

Message d'erreur ou null en cas de succès

initialize()

{@inheritDoc}

protected initialize(InputInterface $input, OutputInterface $output) : mixed
Parameters
$input : InputInterface
$output : OutputInterface

listrefs()

Retourne la liste des modèles de notification disponibles.

protected listrefs() : int
Return values
int

saveEntity()

Exécution de l'enregistrement d'une entité en BdD.

protected saveEntity(object $entity) : string|null
Parameters
$entity : object

Entité à enregistrer

Return values
string|null —

Message d'erreur ou null en cas de succès

sendmail()

Génère et envoi par email un message de notification.

protected sendmail(string $ref, string|array<string|int, mixed> $to[, array<string|int, mixed> $data = [] ][, string $locale = null ][, string|array<string|int, mixed> $pjs = [] ]) : int
Parameters
$ref : string

Référence du modèle de notification (cf mailer_templates dans parameters.yml)

$to : string|array<string|int, mixed>

Adresses mail des destinataires (chaine avec virgule en séparateur acceptée)

$data : array<string|int, mixed> = []

Liste clé/valeur pour les substitutions des templates

$locale : string = null

Spécifie la locale à utiliser pour les templates

$pjs : string|array<string|int, mixed> = []

Pièces-jointes (chemin ou structure {'name':, 'type':, 'data':}, seul ou en liste)

Return values
int

trans()

protected trans(string $token[, array<string|int, mixed> $parameters = [] ]) : string
Parameters
$token : string
$parameters : array<string|int, mixed> = []
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results