‪TYPO3CMS  ‪main
TYPO3\CMS\Core\Collection\NameableCollectionInterface Interface Reference
Inheritance diagram for TYPO3\CMS\Core\Collection\NameableCollectionInterface:
TYPO3\CMS\Core\Collection\RecordCollectionInterface TYPO3\CMS\Core\Collection\AbstractRecordCollection TYPO3\CMS\Core\Collection\AbstractRecordCollection TYPO3\CMS\Core\Category\Collection\CategoryCollection TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection TYPO3\CMS\Core\Category\Collection\CategoryCollection TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection TYPO3\CMS\Frontend\Category\Collection\CategoryCollection TYPO3\CMS\Core\Resource\Collection\CategoryBasedFileCollection TYPO3\CMS\Core\Resource\Collection\FolderBasedFileCollection TYPO3\CMS\Core\Resource\Collection\StaticFileCollection TYPO3\CMS\Core\Tests\Unit\Resource\Collection\Fixtures\OtherTestingFileCollection TYPO3\CMS\Core\Tests\Unit\Resource\Collection\Fixtures\TestingFileCollection TYPO3\CMS\Core\Resource\Collection\CategoryBasedFileCollection TYPO3\CMS\Core\Resource\Collection\FolderBasedFileCollection TYPO3\CMS\Core\Resource\Collection\StaticFileCollection TYPO3\CMS\Core\Tests\Unit\Resource\Collection\Fixtures\OtherTestingFileCollection TYPO3\CMS\Core\Tests\Unit\Resource\Collection\Fixtures\TestingFileCollection TYPO3\CMS\Frontend\Category\Collection\CategoryCollection TYPO3\CMS\Core\Resource\Collection\CategoryBasedFileCollection TYPO3\CMS\Core\Resource\Collection\FolderBasedFileCollection TYPO3\CMS\Core\Resource\Collection\StaticFileCollection TYPO3\CMS\Core\Tests\Unit\Resource\Collection\Fixtures\OtherTestingFileCollection TYPO3\CMS\Core\Tests\Unit\Resource\Collection\Fixtures\TestingFileCollection TYPO3\CMS\Core\Resource\Collection\CategoryBasedFileCollection TYPO3\CMS\Core\Resource\Collection\FolderBasedFileCollection TYPO3\CMS\Core\Resource\Collection\StaticFileCollection TYPO3\CMS\Core\Tests\Unit\Resource\Collection\Fixtures\OtherTestingFileCollection TYPO3\CMS\Core\Tests\Unit\Resource\Collection\Fixtures\TestingFileCollection

Public Member Functions

 setTitle ($title)
 
 setDescription ($description)
 
string getTitle ()
 
 getDescription ()
 

Detailed Description

Marker interface for a collection class with title and description

Collections might be used internally as well as being shown with the nameable interface a title and a description are added to a collection, allowing every collection implementing Nameable being displayed by the same logic.

Definition at line 26 of file NameableCollectionInterface.php.

Member Function Documentation

◆ getDescription()

TYPO3\CMS\Core\Collection\NameableCollectionInterface::getDescription ( )

Getter for the description

Implemented in TYPO3\CMS\Core\Collection\AbstractRecordCollection.

◆ getTitle()

string TYPO3\CMS\Core\Collection\NameableCollectionInterface::getTitle ( )

Getter for the title

Returns
‪string

Implemented in TYPO3\CMS\Core\Collection\AbstractRecordCollection.

◆ setDescription()

TYPO3\CMS\Core\Collection\NameableCollectionInterface::setDescription (   $description)

Setter for the description

Parameters
string$description

Implemented in TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection, and TYPO3\CMS\Core\Collection\AbstractRecordCollection.

◆ setTitle()

TYPO3\CMS\Core\Collection\NameableCollectionInterface::setTitle (   $title)

Setter for the title

Parameters
string$title

Implemented in TYPO3\CMS\Core\Collection\AbstractRecordCollection.