Sf TIC Bundles

ListInfo extends TICEntity
in package

Application

Uses EntityTimestampable, EntityEnabled, EntityBlameable

Entité représentant une liste administrable (conteneur d'éléments avec capacités).

Properties

$capacities : mixed
$deactivatable : bool: Utilisation des champs 'enabled' des éléments (activation/désactivation) ?
$description : string
$editable : bool: Gestion des élements possible par l'interface web (sinon lecture seule pour sync par import/export) ?
$iconable : bool: Utilisation des champs 'icon' des éléments (référence glyphicon/font-awesome) ?
$items : ArrayCollection
$ref : string
$referable : bool: Utilisation des champs 'ref' des éléments (fixe pour import/export, par défaut slug du label) ?
$sortable : bool: Utilisation des champs 'ranking' des éléments (tri pondéré modifiable) ?
$title : string
$valuable : bool: Utilisation des champs 'value' des éléments (clé des options, par défaut index auto) ?
$createdAt : mixed
$createdBy : mixed
$enabled : mixed
$isTimestampable : mixed: Flag permettant de désactiver les actions des méthodes en prePersist et preSave
$updatedAt : mixed
$updatedBy : mixed

Methods

__construct() : mixed
__toString() : mixed
addItem() : ListInfo: Add item
countItems() : int: Retourne le nombre d'éléments dans la liste (avec filtre d'activation optionnel).
createTimestampableValues() : void: Actions automatiques si l'entité dispose de "@ORM\HasLifecycleCallbacks"
doTimestampable() : bool: Gestion de l'activation des actions en prePersist et preSave
export() : mixed
exportItems() : mixed
generateDefaultItemsData() : mixed: A déclencher manuellement avant d'enregistrer les éléments de la liste.
getActiveItems() : mixed: Retourne la liste des éléments activés (filtrage sur la collection).
getCapacities() : mixed: Getter de la propriété virtuelle pour regrouper l'édition des capacités dans le formulaire
getCapacityChoices() : mixed: Retourne les choix d'options sélectionnables dans la propriété virtuelle des capacités
getCreatedAt() : DateTimeInterface|null: Get the creation date.
getCreatedBy() : string|null: Get the creation author.
getDeactivatable() : bool: Get deactivatable
getDescription() : string: Get description
getEditable() : bool: Get editable
getEnabled() : bool|null: Get the enabled state.
getIconable() : bool: Get iconable
getId() : string: Get id
getItemById() : ListItem|null: Get the item by his generated id.
getItemByLabel() : ListItem|null: Get the item by his default label.
getItemByRef() : ListItem|null: Get the item by his internal value.
getItemByValue() : ListItem|null: Get the item by his external value.
getItems() : Collection: Get items
getRef() : string: Get ref
getReferable() : bool: Get referable
getSortable() : bool: Get sortable
getTitle() : string: Get title
getUpdatedAt() : DateTimeInterface|null: Get the modification date.
getUpdatedBy() : string|null: Get the modification author.
getValuable() : bool: Get valuable
import() : mixed
importItems() : mixed
isEnabled() : bool: Get the enabled state.
removeItem() : mixed: Remove item
setCapacities() : mixed: Setter de la propriété virtuelle pour regrouper l'édition des capacités dans le formulaire
setCreatedAt() : self: Set the creation date.
setCreatedBy() : self: Set the creation author.
setDeactivatable() : ListInfo: Set deactivatable
setDescription() : ListInfo: Set description
setEditable() : ListInfo: Set editable
setEnabled() : self: Set the enabled state.
setIconable() : ListInfo: Set iconable
setItems() : ListInfo: Set items
setRef() : ListInfo: Set ref Note: format forcé avec transformation automatique des caractères non autorisés
setReferable() : ListInfo: Set referable
setSortable() : ListInfo: Set sortable
setTitle() : ListInfo: Set title Note: si valeur vide, composition d'un titre par défaut à partir de la référence.
setUpdatedAt() : self: Set the modification date.
setUpdatedBy() : self: Set the modification author.
setValuable() : ListInfo: Set valuable
updateTimestampableValues() : void: Actions automatiques si l'entité dispose de "@ORM\HasLifecycleCallbacks"

$capacities


    protected
        mixed
    $capacities
     = array('editable', 'valuable', 'referable', 'deactivatable', 'sortable', 'iconable')

$deactivatable

Utilisation des champs 'enabled' des éléments (activation/désactivation) ?


    protected
        bool
    $deactivatable

$description


    protected
        string
    $description

$editable

Gestion des élements possible par l'interface web (sinon lecture seule pour sync par import/export) ?


    protected
        bool
    $editable

$iconable

Utilisation des champs 'icon' des éléments (référence glyphicon/font-awesome) ?


    protected
        bool
    $iconable

$items


    protected
        ArrayCollection
    $items

$ref


    protected
        string
    $ref

$referable

Utilisation des champs 'ref' des éléments (fixe pour import/export, par défaut slug du label) ?


    protected
        bool
    $referable

$sortable

Utilisation des champs 'ranking' des éléments (tri pondéré modifiable) ?


    protected
        bool
    $sortable

$title


    protected
        string
    $title

$valuable

Utilisation des champs 'value' des éléments (clé des options, par défaut index auto) ?


    protected
        bool
    $valuable

$createdAt


    private
        mixed
    $createdAt

$createdBy


    private
        mixed
    $createdBy

$enabled


    private
        mixed
    $enabled
     = true

$isTimestampable

Flag permettant de désactiver les actions des méthodes en prePersist et preSave


    private
        mixed
    $isTimestampable
     = true

$updatedAt


    private
        mixed
    $updatedAt

$updatedBy


    private
        mixed
    $updatedBy

__construct()


    public
                    __construct([mixed $nbItems = 0 ][, mixed $ref = null ]) : mixed

Parameters

$nbItems : mixed = 0
$ref : mixed = null

__toString()


    public
                    __toString() : mixed

addItem()

Add item


    public
                    addItem(ListItem $item) : ListInfo

Parameters

$item : ListItem

Return values

ListInfo

countItems()

Retourne le nombre d'éléments dans la liste (avec filtre d'activation optionnel).


    public
                    countItems([bool|null $enabled = null ]) : int

Parameters

$enabled : bool|null = null: Filtre sur l'état activé si true, sur l'état désactivé si false

Return values

int —

Nombre d'éléments total ou activés ou désactivés

createTimestampableValues()

Actions automatiques si l'entité dispose de "@ORM\HasLifecycleCallbacks"


    public
                    createTimestampableValues() : void

doTimestampable()

Gestion de l'activation des actions en prePersist et preSave


    public
                    doTimestampable([bool $state = null ]) : bool

Parameters

$state : bool = null: Nouvel état d'activation (true=actif / false=inactif)

Return values

bool —

Retourne l'état d'activation en cours

export()


    public
                    export([mixed $withItems = false ]) : mixed

Parameters

$withItems : mixed = false

exportItems()


    public
                    exportItems() : mixed

generateDefaultItemsData()

A déclencher manuellement avant d'enregistrer les éléments de la liste.


    public
                    generateDefaultItemsData() : mixed

getActiveItems()

Retourne la liste des éléments activés (filtrage sur la collection).


    public
                    getActiveItems() : mixed

getCapacities()

Getter de la propriété virtuelle pour regrouper l'édition des capacités dans le formulaire


    public
                    getCapacities() : mixed

getCapacityChoices()

Retourne les choix d'options sélectionnables dans la propriété virtuelle des capacités


    public
                    getCapacityChoices() : mixed

getCreatedAt()

Get the creation date.


    public
                    getCreatedAt() : DateTimeInterface|null

Return values

DateTimeInterface|null

getCreatedBy()

Get the creation author.


    public
                    getCreatedBy() : string|null

Return values

string|null

getDeactivatable()

Get deactivatable


    public
                    getDeactivatable() : bool

Return values

bool

getDescription()

Get description


    public
                    getDescription() : string

Return values

string

getEditable()

Get editable


    public
                    getEditable() : bool

Return values

bool

getEnabled()

Get the enabled state.


    public
                    getEnabled() : bool|null

Return values

bool|null

getIconable()

Get iconable


    public
                    getIconable() : bool

Return values

bool

getId()

Get id


    public
                    getId() : string

Return values

string

getItemById()

Get the item by his generated id.


    public
                    getItemById(mixed $id) : ListItem|null

Parameters

$id : mixed

Return values

ListItem|null

getItemByLabel()

Get the item by his default label.


    public
                    getItemByLabel(mixed $label[, mixed $createIt = false ]) : ListItem|null

Parameters

$label : mixed
$createIt : mixed = false

Return values

ListItem|null

getItemByRef()

Get the item by his internal value.


    public
                    getItemByRef(mixed $ref[, mixed $createIt = false ]) : ListItem|null

Parameters

$ref : mixed
$createIt : mixed = false

Return values

ListItem|null

getItemByValue()

Get the item by his external value.


    public
                    getItemByValue(mixed $value[, mixed $createIt = false ]) : ListItem|null

Parameters

$value : mixed
$createIt : mixed = false

Return values

ListItem|null

getItems()

Get items


    public
                    getItems() : Collection

Return values

Collection

getRef()

Get ref


    public
                    getRef() : string

Return values

string

getReferable()

Get referable


    public
                    getReferable() : bool

Return values

bool

getSortable()

Get sortable


    public
                    getSortable() : bool

Return values

bool

getTitle()

Get title


    public
                    getTitle() : string

Return values

string

getUpdatedAt()

Get the modification date.


    public
                    getUpdatedAt() : DateTimeInterface|null

Return values

DateTimeInterface|null

getUpdatedBy()

Get the modification author.


    public
                    getUpdatedBy() : string|null

Return values

string|null

getValuable()

Get valuable


    public
                    getValuable() : bool

Return values

bool

import()


    public
                    import(mixed $data) : mixed

Parameters

$data : mixed

importItems()


    public
                    importItems(mixed $data) : mixed

Parameters

$data : mixed

isEnabled()

Get the enabled state.


    public
                    isEnabled() : bool

Return values

bool

removeItem()

Remove item


    public
                    removeItem(ListItem $item) : mixed

Parameters

$item : ListItem

setCapacities()

Setter de la propriété virtuelle pour regrouper l'édition des capacités dans le formulaire


    public
                    setCapacities(mixed $capacities) : mixed

Parameters

$capacities : mixed

setCreatedAt()

Set the creation date.


    public
                    setCreatedAt(DateTimeInterface|null $createdAt) : self

Parameters

$createdAt : DateTimeInterface|null

Return values

self

setCreatedBy()

Set the creation author.


    public
                    setCreatedBy(string|null $createdBy) : self

Parameters

$createdBy : string|null

Return values

self

setDeactivatable()

Set deactivatable


    public
                    setDeactivatable(bool $deactivatable) : ListInfo

Parameters

$deactivatable : bool

Return values

ListInfo

setDescription()

Set description


    public
                    setDescription(string $description) : ListInfo

Parameters

$description : string

Return values

ListInfo

setEditable()

Set editable


    public
                    setEditable(bool $editable) : ListInfo

Parameters

$editable : bool

Return values

ListInfo

setEnabled()

Set the enabled state.


    public
                    setEnabled(bool|null $enabled) : self

Parameters

$enabled : bool|null

Return values

self

setIconable()

Set iconable


    public
                    setIconable(bool $iconable) : ListInfo

Parameters

$iconable : bool

Return values

ListInfo

setItems()

Set items


    public
                    setItems(array<string|int, ListItem> $items) : ListInfo

Parameters

$items : array<string|int, ListItem>: Liste des éléments (array ou ArrayCollection)

Return values

ListInfo

setRef()

Set ref Note: format forcé avec transformation automatique des caractères non autorisés


    public
                    setRef(string $ref) : ListInfo

Parameters

$ref : string

Return values

ListInfo

setReferable()

Set referable


    public
                    setReferable(bool $referable) : ListInfo

Parameters

$referable : bool

Return values

ListInfo

setSortable()

Set sortable


    public
                    setSortable(bool $sortable) : ListInfo

Parameters

$sortable : bool

Return values

ListInfo

setTitle()

Set title Note: si valeur vide, composition d'un titre par défaut à partir de la référence.


    public
                    setTitle(string $title) : ListInfo

Parameters

$title : string

Return values

ListInfo

setUpdatedAt()

Set the modification date.


    public
                    setUpdatedAt(DateTimeInterface|null $updatedAt) : self

Parameters

$updatedAt : DateTimeInterface|null

Return values

self

setUpdatedBy()

Set the modification author.


    public
                    setUpdatedBy(string|null $updatedBy) : self

Parameters

$updatedBy : string|null

Return values

self

setValuable()

Set valuable


    public
                    setValuable(bool $valuable) : ListInfo

Parameters

$valuable : bool

Return values

ListInfo

updateTimestampableValues()

Actions automatiques si l'entité dispose de "@ORM\HasLifecycleCallbacks"


    public
                    updateTimestampableValues() : void

ListInfo extends TICEntity in package Application Uses EntityTimestampable, EntityEnabled, EntityBlameable

Tags

Table of Contents

Properties

Methods

Properties

$capacities

$deactivatable

Tags

$description

Tags

$editable

Tags

$iconable

Tags

$items

Tags

$ref

Tags

$referable

Tags

$sortable

Tags

$title

Tags

$valuable

Tags

$createdAt

Tags

$createdBy

Tags

$enabled

Tags

$isTimestampable

$updatedAt

Tags

$updatedBy

Tags

Methods

__construct()

Parameters

__toString()

addItem()

Parameters

Return values

countItems()

Parameters

Return values

createTimestampableValues()

Tags

doTimestampable()

Parameters

Return values

export()

Parameters

exportItems()

generateDefaultItemsData()

Tags

getActiveItems()

getCapacities()

getCapacityChoices()

getCreatedAt()

Return values

getCreatedBy()

Return values

getDeactivatable()

Return values

getDescription()

Return values

getEditable()

Return values

getEnabled()

Return values

getIconable()

Return values

getId()

Return values

getItemById()

Parameters

Return values

ListInfo extends TICEntity
in package

Application

Uses EntityTimestampable, EntityEnabled, EntityBlameable