TYPO3\CMS\Core\Resource\FileRepository Class Reference

Inheritance diagram for TYPO3\CMS\Core\Resource\FileRepository:

Public Member Functions
	findByUid ($uid)
	addToIndex (File $fileObject)
	getFileIndexStatus (File $fileObject)
	getFileIndexRecord (File $fileObject)
	getFileIndexRecordsForFolder (Folder $folder)
	findBySha1Hash ($hash)
	findFileReferenceByUid ($uid)
	update ($modifiedObject)
Public Member Functions inherited from TYPO3\CMS\Core\Resource\AbstractRepository
	__construct ()
	add ($object)
	remove ($object)
	replace ($existingObject, $newObject)
	update ($modifiedObject)
	getAddedObjects ()
	getRemovedObjects ()
	findAll ()
	countAll ()
	removeAll ()
	findByUid ($uid)
	setDefaultOrderings (array $defaultOrderings)
	setDefaultQuerySettings (\TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface $defaultQuerySettings)
	createQuery ()
	findByIdentifier ($identifier)
	__call ($method, $arguments)
	getEntityClassName ()

Protected Member Functions
	getIndexerService ()
	createDomainObject (array $databaseRow)
	createFileReferenceObject (array $databaseRow)
	getFileIndexRepository ()
Protected Member Functions inherited from TYPO3\CMS\Core\Resource\AbstractRepository
	createDomainObject (array $databaseRow)
	getWhereClauseForEnabledFields ()
	getEnvironmentMode ()
	getDatabaseConnection ()

Protected Attributes
	$objectType = 'TYPO3\\CMS\\Core\\Resource\\File'
	$table = 'sys_file'
	$indexerService = NULL
Protected Attributes inherited from TYPO3\CMS\Core\Resource\AbstractRepository
	$table = ''
	$factory
	$typeField = ''
	$type = ''

Detailed Description

Repository for accessing files it also serves as the public API for the indexing part of files in general

Author

Andreas Wolf andre.nosp@m.as.w.nosp@m.olf@i.nosp@m.kt-w.nosp@m.erk.d.nosp@m.e

Ingmar Schlecht ingma.nosp@m.r@ty.nosp@m.po3.o.nosp@m.rg

Definition at line 28 of file FileRepository.php.

Member Function Documentation

addToIndex()

TYPO3\CMS\Core\Resource\FileRepository::addToIndex

(

File

$fileObject

)

Index a file object given as parameter

Parameters

File

$fileObject

Returns

array The indexed file data

Deprecated:

since TYPO3 6.2, will be removed two versions later - indexing should be handled transparently, not only upon request

Definition at line 93 of file FileRepository.php.

References TYPO3\CMS\Core\Resource\FileRepository\getIndexerService(), and TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction().

createDomainObject()

TYPO3\CMS\Core\Resource\FileRepository::createDomainObject ( array  $databaseRow )

protected

Creates an object managed by this repository.

Parameters

array

$databaseRow

Returns

File

Definition at line 82 of file FileRepository.php.

Referenced by TYPO3\CMS\Core\Resource\FileRepository\findBySha1Hash().

createFileReferenceObject()

TYPO3\CMS\Core\Resource\FileRepository::createFileReferenceObject ( array  $databaseRow )

protected

Creates a FileReference object

Parameters

array

$databaseRow

Returns

FileReference

Deprecated:

Use $this->factory->getFileReferenceObject() directly

Definition at line 257 of file FileRepository.php.

findBySha1Hash()

TYPO3\CMS\Core\Resource\FileRepository::findBySha1Hash

(

$hash

)

Returns all files with the corresponding SHA-1 hash. This is queried against the database, so only indexed files will be found

Parameters

string

$hash

A SHA1 hash of a file

Returns

array

Deprecated:

since TYPO3 6.2, will be removed two versions later - use FileIndexRepository::findByContentHash

Definition at line 146 of file FileRepository.php.

References $GLOBALS, $uid, TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), TYPO3\CMS\Core\Resource\FileRepository\createDomainObject(), TYPO3\CMS\Core\Resource\AbstractRepository\getDatabaseConnection(), TYPO3\CMS\Core\Resource\AbstractRepository\getEnvironmentMode(), TYPO3\CMS\Core\Resource\FileRepository\getFileIndexRepository(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

findByUid()

TYPO3\CMS\Core\Resource\FileRepository::findByUid

(

$uid

)

Parameters

int

$uid

Returns

File

Deprecated:

since TYPO3 6.2 CMS, will be removed 2 versions later

Implements TYPO3\CMS\Extbase\Persistence\RepositoryInterface.

Definition at line 57 of file FileRepository.php.

References $uid, TYPO3\CMS\Core\Resource\ResourceFactory\getInstance(), and TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction().

findFileReferenceByUid()

TYPO3\CMS\Core\Resource\FileRepository::findFileReferenceByUid

(

$uid

)

Find FileReference objects by uid

Parameters

integer

$uid

The UID of the sys_file_reference record

Returns

FileReference|boolean

Exceptions

Definition at line 224 of file FileRepository.php.

References $uid, and TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger().

getFileIndexRecord()

TYPO3\CMS\Core\Resource\FileRepository::getFileIndexRecord

(

File

$fileObject

)

Returns an index record of a file, or FALSE if the file is not indexed.

Parameters

File

$fileObject

Returns

bool|array

Deprecated:

since TYPO3 6.2, will be removed two versions later - use FileIndexRepository instead

Definition at line 121 of file FileRepository.php.

References TYPO3\CMS\Core\Resource\FileRepository\getFileIndexRepository(), and TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction().

getFileIndexRecordsForFolder()

TYPO3\CMS\Core\Resource\FileRepository::getFileIndexRecordsForFolder

(

Folder

$folder

)

Returns the index-data of all files within that folder

Parameters

Folder

$folder

Returns

array

Deprecated:

since 6.2 - will be removed 2 versions later

Definition at line 133 of file FileRepository.php.

References TYPO3\CMS\Core\Resource\FileRepository\getFileIndexRepository(), and TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction().

getFileIndexRepository()

TYPO3\CMS\Core\Resource\FileRepository::getFileIndexRepository ( )

protected

Return a file index repository

Returns

FileIndexRepository

Definition at line 266 of file FileRepository.php.

References TYPO3\CMS\Core\Resource\Index\FileIndexRepository\getInstance().

Referenced by TYPO3\CMS\Core\Resource\FileRepository\findBySha1Hash(), TYPO3\CMS\Core\Resource\FileRepository\getFileIndexRecord(), TYPO3\CMS\Core\Resource\FileRepository\getFileIndexRecordsForFolder(), TYPO3\CMS\Core\Resource\FileRepository\getFileIndexStatus(), and TYPO3\CMS\Core\Resource\FileRepository\update().

getFileIndexStatus()

TYPO3\CMS\Core\Resource\FileRepository::getFileIndexStatus

(

File

$fileObject

)

Checks the index status of a file and returns FALSE if the file is not indexed, the uid otherwise.

Parameters

File

$fileObject

Returns

boolean|integer

Deprecated:

since TYPO3 6.2, will be removed two versions later - use FileIndexRepository::isIndexed

Definition at line 106 of file FileRepository.php.

References TYPO3\CMS\Core\Resource\FileRepository\getFileIndexRepository(), TYPO3\CMS\Core\Resource\AbstractFile\getIdentifier(), TYPO3\CMS\Core\Resource\AbstractFile\getStorage(), and TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction().

getIndexerService()

TYPO3\CMS\Core\Resource\FileRepository::getIndexerService ( )

protected

Internal function to retrieve the indexer service, if it does not exist, an instance will be created

Returns

Service

Definition at line 69 of file FileRepository.php.

References TYPO3\CMS\Core\Resource\FileRepository\$indexerService, and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\Core\Resource\FileRepository\addToIndex().

update()

TYPO3\CMS\Core\Resource\FileRepository::update

(

$modifiedObject

)

Updates an existing file object in the database

Parameters

AbstractFile

$modifiedObject

Returns

void

Deprecated:

since TYPO3 6.2 LTS, will be removed two versions later - use FileIndexRepository::update

Implements TYPO3\CMS\Extbase\Persistence\RepositoryInterface.

Definition at line 243 of file FileRepository.php.

References TYPO3\CMS\Core\Resource\FileRepository\getFileIndexRepository(), and TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction().

Member Data Documentation

$indexerService

TYPO3\CMS\Core\Resource\FileRepository::$indexerService = NULL

protected

Definition at line 50 of file FileRepository.php.

Referenced by TYPO3\CMS\Core\Resource\FileRepository\getIndexerService().

$objectType

TYPO3\CMS\Core\Resource\FileRepository::$objectType = 'TYPO3\\CMS\\Core\\Resource\\File'

protected

Definition at line 37 of file FileRepository.php.

$table

TYPO3\CMS\Core\Resource\FileRepository::$table = 'sys_file'

protected

Definition at line 45 of file FileRepository.php.