TYPO3 CMS  TYPO3_6-2
TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection Class Reference
Inheritance diagram for TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection:
TYPO3\CMS\Core\Collection\AbstractRecordCollection TYPO3\CMS\Core\Collection\RecordCollectionInterface TYPO3\CMS\Core\Collection\PersistableCollectionInterface TYPO3\CMS\Core\Collection\SortableCollectionInterface TYPO3\CMS\Core\Collection\CollectionInterface TYPO3\CMS\Core\Collection\NameableCollectionInterface TYPO3\CMS\Core\Resource\Collection\CategoryBasedFileCollection TYPO3\CMS\Core\Resource\Collection\FolderBasedFileCollection TYPO3\CMS\Core\Resource\Collection\StaticFileCollection

Public Member Functions

 setDescription ($description)
 
 setTitle ($title)
 
 fromArray (array $array)
 
 getItemsCriteria ()
 
 setItemsCriteria ($itemsCriteria)
 
 add (\TYPO3\CMS\Core\Resource\FileInterface $data)
 
 removeAll ()
 
- Public Member Functions inherited from TYPO3\CMS\Core\Collection\AbstractRecordCollection
 __construct ()
 
 current ()
 
 next ()
 
 key ()
 
 valid ()
 
 rewind ()
 
 serialize ()
 
 unserialize ($serialized)
 
 count ()
 
 getTitle ()
 
 getUid ()
 
 getDescription ()
 
 setTitle ($title)
 
 setDescription ($desc)
 
 getItemTableName ()
 
 setItemTableName ($tableName)
 
 usort ($callbackFunction)
 
 moveItemAt ($currentPosition, $newPosition=0)
 
 getIdentifier ()
 
 setIdentifier ($id)
 
 toArray ()
 
 fromArray (array $array)
 
- Public Member Functions inherited from TYPO3\CMS\Core\Collection\PersistableCollectionInterface
 persist ()
 
 loadContents ()
 

Protected Member Functions

 getPersistableDataArray ()
 
- Protected Member Functions inherited from TYPO3\CMS\Core\Collection\AbstractRecordCollection
 getPersistableDataArray ()
 
 getItemUidList ($includeTableName=TRUE)
 

Protected Attributes

 $itemsCriteria
 
 $itemTableName = 'sys_file'
 
- Protected Attributes inherited from TYPO3\CMS\Core\Collection\AbstractRecordCollection
 $uid = 0
 
 $title
 
 $description
 
 $itemTableName
 
 $storage
 

Static Protected Attributes

static $storageTableName = 'sys_file_collection'
 
static $type
 
static $itemsCriteriaField
 
- Static Protected Attributes inherited from TYPO3\CMS\Core\Collection\AbstractRecordCollection
static $storageTableName = 'sys_collection'
 
static $storageItemsField = 'items'
 

Additional Inherited Members

- Static Public Member Functions inherited from TYPO3\CMS\Core\Collection\AbstractRecordCollection
static load ($id, $fillItems=FALSE)
 
static create (array $collectionRecord, $fillItems=FALSE)
 

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! Abstract collection.

Author
Steffen Ritter steff.nosp@m.en.r.nosp@m.itter.nosp@m.@typ.nosp@m.o3.or.nosp@m.g

Definition at line 21 of file AbstractFileCollection.php.

Member Function Documentation

◆ add()

TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection::add ( \TYPO3\CMS\Core\Resource\FileInterface  $data)

Adds a file to this collection.

Parameters
\TYPO3\CMS\Core\Resource\FileInterface$data

Definition at line 191 of file AbstractFileCollection.php.

Referenced by TYPO3\CMS\Core\Resource\Collection\CategoryBasedFileCollection\loadContents(), and TYPO3\CMS\Core\Resource\Collection\FolderBasedFileCollection\loadContents().

◆ fromArray()

TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection::fromArray ( array  $array)

Similar to method in , but without $this->itemTableName= $array['table_name'], but with $this->storageItemsFieldContent = $array[self::$storageItemsField];

Parameters
array$array

Definition at line 161 of file AbstractFileCollection.php.

Referenced by TYPO3\CMS\Core\Resource\Collection\FolderBasedFileCollection\getPersistableDataArray().

◆ getItemsCriteria()

TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection::getItemsCriteria ( )

◆ getPersistableDataArray()

TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection::getPersistableDataArray ( )
protected

◆ removeAll()

TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection::removeAll ( )

Removes all elements of the current collection.

Definition at line 227 of file AbstractFileCollection.php.

◆ setDescription()

TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection::setDescription (   $description)

Sets the description.

Parameters
string$description

Implements TYPO3\CMS\Core\Collection\NameableCollectionInterface.

Definition at line 66 of file AbstractFileCollection.php.

References TYPO3\CMS\Core\Collection\AbstractRecordCollection\$description.

◆ setItemsCriteria()

TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection::setItemsCriteria (   $itemsCriteria)

Sets the items criteria.

Parameters
mixed$itemsCriteria

Definition at line 182 of file AbstractFileCollection.php.

References TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection\$itemsCriteria.

◆ setTitle()

Member Data Documentation

◆ $itemsCriteria

TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection::$itemsCriteria
protected

◆ $itemsCriteriaField

TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection::$itemsCriteriaField
staticprotected

Definition at line 44 of file AbstractFileCollection.php.

◆ $itemTableName

TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection::$itemTableName = 'sys_file'
protected

Definition at line 59 of file AbstractFileCollection.php.

◆ $storageTableName

TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection::$storageTableName = 'sys_file_collection'
staticprotected

Definition at line 28 of file AbstractFileCollection.php.

◆ $type

TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection::$type
staticprotected

Definition at line 36 of file AbstractFileCollection.php.