TYPO3 CMS  TYPO3_6-2
TYPO3\CMS\Core\Collection\NameableCollectionInterface Interface Reference
Inheritance diagram for TYPO3\CMS\Core\Collection\NameableCollectionInterface:
t3lib_collection_Nameable TYPO3\CMS\Core\Collection\RecordCollectionInterface t3lib_collection_RecordCollection TYPO3\CMS\Core\Collection\AbstractRecordCollection t3lib_collection_AbstractRecordCollection TYPO3\CMS\Core\Category\Collection\CategoryCollection TYPO3\CMS\Core\Collection\StaticRecordCollection TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection TYPO3\CMS\Frontend\Category\Collection\CategoryCollection t3lib_collection_StaticRecordCollection TYPO3\CMS\Core\Resource\Collection\CategoryBasedFileCollection TYPO3\CMS\Core\Resource\Collection\FolderBasedFileCollection TYPO3\CMS\Core\Resource\Collection\StaticFileCollection

Public Member Functions

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

Detailed Description

This file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! 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 an collection, allowing every collection implementing Nameable being display by the same logic.

Author
Steffen Ritter <typo3steffen-ritter.net>

Definition at line 26 of file NameableCollectionInterface.php.

Member Function Documentation

◆ getDescription()

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

Getter for the description

Returns
void

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

◆ getTitle()

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
Returns
void

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

◆ setTitle()

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

Setter for the title

Parameters
string$title
Returns
void

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