class Folder extends AbstractDateTimedPositioned implements FolderInterface (View source)

Folders entity represent a directory on server with datetime and naming.

Traits

Trait which describe a positioned entity
Trait which describe a positioned entity

Properties

protected $id from AbstractEntity
protected DateTime $createdAt from AbstractDateTimed
protected DateTime $updatedAt from AbstractDateTimed
protected $position from AbstractDateTimedPositioned
protected $parent
protected ArrayCollection $children
protected $documents

Methods

int
getId()

No description

setId(int $id)

No description

getCreatedAt()

No description

setCreatedAt(DateTime $createdAt)

No description

getUpdatedAt()

No description

setUpdatedAt(DateTime $updatedAt)

No description

preUpdate()

No description

prePersist()

No description

resetDates()

Set creation and update date to now.

float
getPosition()

No description

$this
setPosition(float $newPosition)

Set position as a float to enable increment and decrement by O.5 to insert a node between two others.

Collection
getChildren()

No description

from LeafTrait
$this
addChild(LeafInterface $child)

No description

from LeafTrait
$this
removeChild(LeafInterface $child)

No description

from LeafTrait
getParent()

No description

from LeafTrait
$this
setParent(LeafInterface $parent = null)

No description

from LeafTrait
getParents()

Return every tag’s parents.

from LeafTrait
int
getDepth()

Gets the nodes depth.

from LeafTrait
getIterator()

{@inheritdoc}

from LeafTrait
count()

{@inheritdoc}

from LeafTrait
Collection
getDocuments()

No description

addDocument(DocumentInterface $document)

No description

boolean
getVisible()

No description

setVisible(boolean $visible)

No description

__construct()

Create a new Folder.

mixed
getTranslatedFolders()

No description

Collection
getTranslatedFoldersByTranslation(Translation $translation)

No description

setTranslatedFolders(mixed $translatedFolders)

No description

string
getFolderName()

No description

string
getName() deprecated

No description

setFolderName(string $folderName)

No description

setName(string $folderName) deprecated

No description

string
getDirtyFolderName()

No description

setDirtyFolderName(string $dirtyFolderName)

No description

string
getFullPath()

Get folder full path using folder names.

Details

int getId()

Return Value

int

AbstractEntity setId(int $id)

Parameters

int $id

Return Value

AbstractEntity

DateTime getCreatedAt()

Return Value

DateTime

AbstractDateTimed setCreatedAt(DateTime $createdAt)

Parameters

DateTime $createdAt

Return Value

AbstractDateTimed

DateTime getUpdatedAt()

Return Value

DateTime

AbstractDateTimed setUpdatedAt(DateTime $updatedAt)

Parameters

DateTime $updatedAt

Return Value

AbstractDateTimed

preUpdate()

prePersist()

AbstractEntity resetDates()

Set creation and update date to now.

Return Value

AbstractEntity

float getPosition()

Return Value

float

$this setPosition(float $newPosition)

Set position as a float to enable increment and decrement by O.5 to insert a node between two others.

Parameters

float $newPosition

Return Value

$this

Collection getChildren()

Return Value

Collection

$this addChild(LeafInterface $child)

Parameters

LeafInterface $child

Return Value

$this

$this removeChild(LeafInterface $child)

Parameters

LeafInterface $child

Return Value

$this

LeafInterface getParent()

Return Value

LeafInterface parent

$this setParent(LeafInterface $parent = null)

Parameters

LeafInterface $parent

Return Value

$this

LeafInterface[] getParents()

Return every tag’s parents.

Return Value

LeafInterface[]

int getDepth()

Gets the nodes depth.

Return Value

int

getIterator()

{@inheritdoc}

count()

{@inheritdoc}

Collection getDocuments()

Return Value

Collection

FolderInterface addDocument(DocumentInterface $document)

Parameters

DocumentInterface $document

Return Value

FolderInterface

FolderInterface removeDocument(DocumentInterface $document)

Parameters

DocumentInterface $document

Return Value

FolderInterface

boolean getVisible()

Return Value

boolean

FolderInterface setVisible(boolean $visible)

Parameters

boolean $visible

Return Value

FolderInterface

__construct()

Create a new Folder.

mixed getTranslatedFolders()

Return Value

mixed

Collection getTranslatedFoldersByTranslation(Translation $translation)

Parameters

Translation $translation

Return Value

Collection

Folder setTranslatedFolders(mixed $translatedFolders)

Parameters

mixed $translatedFolders

Return Value

Folder

string getFolderName()

Return Value

string

string getName() deprecated

deprecated Use getFolderName() method instead to differenciate from FolderTranslation’ name.

Return Value

string

FolderInterface setFolderName(string $folderName)

Parameters

string $folderName

Return Value

FolderInterface

FolderInterface setName(string $folderName) deprecated

deprecated Use setFolderName() method instead to differenciate from FolderTranslation’ name.

Parameters

string $folderName

Return Value

FolderInterface

string getDirtyFolderName()

Return Value

string

FolderInterface setDirtyFolderName(string $dirtyFolderName)

Parameters

string $dirtyFolderName

Return Value

FolderInterface

string getFullPath()

Get folder full path using folder names.

Return Value

string