Sf TIC Bundles

ListItem extends TICEntity
in package

Entité de base disposant d'éventuelles méthodes utiles.

Tags
ORM\Table

(name="tic_list_listitem", uniqueConstraints={ @UniqueConstraint(name="ref_unique", columns={"list_ref", "ref"}) }, indexes={ @ORM\Index(name="value_search", columns={"list_ref", "value"}) } )

UniqueEntity

(fields={"list_ref", "ref"}, errorPath="ref")

ORM\Entity

(repositoryClass=EntityRepo::class)

Table of Contents

Properties

$enabled  : bool
$icon  : string
$id  : mixed
$info  : ListInfo
$label  : string
Libellé de l'élément à afficher (celui de la locale par défaut si translatable).
$ranking  : int
$ref  : string
Référence fixe de l'élément (par défaut: slug du libellé unique dans la liste).
$value  : string
Valeur/clé à associer au libellé (par défaut: index dans la liste).

Methods

__construct()  : mixed
__toString()  : mixed
export()  : mixed
generateDefaultData()  : mixed
Génération automatique pour les champs vides 'ref' et 'value'.
getEnabled()  : bool
Get enabled
getIcon()  : string
Get icon
getId()  : string
Get id
getInfo()  : ListInfo
Get info
getLabel()  : string
Get label Note: possibilité de spécifier une locale pour interroger la collection de translations Note: il est sans doute préférable d'éviter la création d'objet depuis une demande en lecture
getLabels()  : array<string|int, mixed>
Retourne la liste des libellés traduits (plutôt qu'une liste des traductions) Note: si aucune traduction une liste sera initialisée avec le libellé par défaut
getRanking()  : int
Get ranking
getRef()  : string
Get ref
getValue()  : string
Get value
import()  : mixed
makeRefFromLabel()  : mixed
Génération automatique de la référence du noeud (slug unique du label).
makeValueAutoIndex()  : mixed
Génération automatique de la valeur du noeud (index incrémental dans la liste).
setEnabled()  : ListItem
Set enabled
setIcon()  : ListItem
Set icon
setInfo()  : ListItem
Set info
setLabel()  : ListItem
Set label
setLabels()  : mixed
Enregistre une liste de libellés traduits dans la collection des translations.
setRanking()  : ListItem
Set ranking
setRef()  : ListItem
Set ref
setValue()  : ListItem
Set value
slugify()  : mixed
Compatibility
getDefaultLabel()  : mixed
Retourne le libellé par défaut d'une liste de traduction.

Properties

$enabled

protected bool $enabled
Tags
ORM\Column

(type="boolean", options={"default"=true})

Assert\NotNull

()

$icon

protected string $icon
Tags
ORM\Column

(type="string", length=50, nullable=true)

$id

protected mixed $id
Tags
ORM\Column

(type="string", length=201)

ORM\Id
ORM\GeneratedValue

(strategy="CUSTOM")

ORM\CustomIdGenerator

(class="\TIC\ListBundle\Doctrine\ReferencesIdGenerator")

$info

protected ListInfo $info
Tags
ORM\ManyToOne

(targetEntity="ListInfo", inversedBy="items")

ORM\JoinColumn

(name="list_ref", referencedColumnName="ref")

$label

Libellé de l'élément à afficher (celui de la locale par défaut si translatable).

protected string $label
Tags
ORM\Column

(type="string", length=255)

$ranking

protected int $ranking
Tags
ORM\Column

(type="smallint", options={"default"=0})

Assert\NotNull

()

$ref

Référence fixe de l'élément (par défaut: slug du libellé unique dans la liste).

protected string $ref
Tags
ORM\Column

(type="string", length=100)

$value

Valeur/clé à associer au libellé (par défaut: index dans la liste).

protected string $value
Tags
ORM\Column

(type="string", length=100)

Methods

__construct()

public __construct([ListInfo $info = null ][, mixed $label = null ][, mixed $value = null ][, mixed $ref = null ]) : mixed
Parameters
$info : ListInfo = null
$label : mixed = null
$value : mixed = null
$ref : mixed = null

__toString()

public __toString() : mixed

generateDefaultData()

Génération automatique pour les champs vides 'ref' et 'value'.

public generateDefaultData() : mixed

Note: l'usage d'events prePersist et preUpdate sur les entités ListItem ne permettrait pas de déterminer l'ordre des éléments traités (génant pour la génération des incréments et les priorités des slugs) d'où l'usage d'un event PreFlush au niveau de la liste ATTENTION: aucun event alors sur une opération d'ajout/édition isolée d'une entité ListItem (en dehors de l'édition via une liste) ?

getEnabled()

Get enabled

public getEnabled() : bool
Return values
bool

getIcon()

Get icon

public getIcon() : string
Return values
string

getId()

Get id

public getId() : string
Return values
string

getLabel()

Get label Note: possibilité de spécifier une locale pour interroger la collection de translations Note: il est sans doute préférable d'éviter la création d'objet depuis une demande en lecture

public getLabel([string $locale = null ]) : string
Parameters
$locale : string = null

La locale demandée pour récupérer les traductions

Return values
string

getLabels()

Retourne la liste des libellés traduits (plutôt qu'une liste des traductions) Note: si aucune traduction une liste sera initialisée avec le libellé par défaut

public getLabels() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Liste des libellés indexés par leur locale

getRanking()

Get ranking

public getRanking() : int
Return values
int

getRef()

Get ref

public getRef() : string
Return values
string

getValue()

Get value

public getValue() : string
Return values
string

import()

public import(mixed $data) : mixed
Parameters
$data : mixed

makeRefFromLabel()

Génération automatique de la référence du noeud (slug unique du label).

public makeRefFromLabel() : mixed

makeValueAutoIndex()

Génération automatique de la valeur du noeud (index incrémental dans la liste).

public makeValueAutoIndex() : mixed

setEnabled()

Set enabled

public setEnabled(bool $enabled) : ListItem
Parameters
$enabled : bool
Return values
ListItem

setLabels()

Enregistre une liste de libellés traduits dans la collection des translations.

public setLabels(array<string|int, mixed> $labels) : mixed

Note: mise à jour au passage du libellé par défaut (stocké dans l'entité hors translations)

Parameters
$labels : array<string|int, mixed>

Liste des libellés indexés par leur locale

slugify()

Compatibility

public static slugify(mixed $text) : mixed
Parameters
$text : mixed

getDefaultLabel()

Retourne le libellé par défaut d'une liste de traduction.

protected getDefaultLabel(mixed $labels[, mixed $default = '' ]) : mixed

(utile pour ListItemTranslation[] => ListItem->label)

Parameters
$labels : mixed
$default : mixed = '' 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results