TYPO3\CMS\Core\Resource\MetaDataAspect Class Reference

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

Public Member Functions
	__construct (File $file)
self	add (array $metaData)
array	get ()
bool	offsetExists ($offset)
mixed	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)
int	count ()
	rewind ()
mixed	current ()
string	key ()
	next ()
bool	valid ()
	save ()
	remove ()

Protected Member Functions
MetaDataRepository	getMetaDataRepository ()
array	loadFromRepository ()

Private Attributes
File	$file
array	$metaData = array( )
bool	$loaded = false
int	$indexPosition = 0

Detailed Description

Aspect that takes care of a file's metadata

Definition at line 26 of file MetaDataAspect.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Core\Resource\MetaDataAspect::__construct

(

File

$file

)

Constructor

Parameters

File

$file

Definition at line 51 of file MetaDataAspect.php.

References TYPO3\CMS\Core\Resource\MetaDataAspect\$file.

Member Function Documentation

add()

self TYPO3\CMS\Core\Resource\MetaDataAspect::add

(

array

$metaData

)

Adds already known metadata to the aspect

Parameters

array

$metaData

Returns

‪self

Definition at line 63 of file MetaDataAspect.php.

References TYPO3\CMS\Core\Resource\MetaDataAspect\$metaData.

Referenced by TYPO3\CMS\Core\Resource\File\__construct(), TYPO3\CMS\Core\Resource\Index\Indexer\extractMetaData(), and TYPO3\CMS\Core\Resource\Index\Indexer\updateIndexEntry().

count()

int TYPO3\CMS\Core\Resource\MetaDataAspect::count

(

)

Returns

‪int

Definition at line 124 of file MetaDataAspect.php.

current()

mixed TYPO3\CMS\Core\Resource\MetaDataAspect::current

(

)

Gets the current value of iteration

Returns

‪mixed

Definition at line 142 of file MetaDataAspect.php.

References TYPO3\CMS\Core\Resource\MetaDataAspect\$indexPosition.

get()

array TYPO3\CMS\Core\Resource\MetaDataAspect::get

(

)

Gets the metadata of a file. If not metadata is loaded yet, the database gets queried

Returns

‪array

Definition at line 76 of file MetaDataAspect.php.

References TYPO3\CMS\Core\Resource\MetaDataAspect\$metaData, and TYPO3\CMS\Core\Resource\MetaDataAspect\loadFromRepository().

Referenced by TYPO3\CMS\Core\Resource\File\_getMetaData(), TYPO3\CMS\Core\Resource\Processing\FileDeletionAspect\cleanupCategoryReferences(), TYPO3\CMS\Core\Resource\Index\Indexer\extractMetaData(), and TYPO3\CMS\Filelist\FileList\linkWrapFile().

getMetaDataRepository()

MetaDataRepository TYPO3\CMS\Core\Resource\MetaDataAspect::getMetaDataRepository ( )

protected

Returns

‪MetaDataRepository

Definition at line 205 of file MetaDataAspect.php.

Referenced by TYPO3\CMS\Core\Resource\MetaDataAspect\loadFromRepository(), TYPO3\CMS\Core\Resource\MetaDataAspect\remove(), and TYPO3\CMS\Core\Resource\MetaDataAspect\save().

key()

string TYPO3\CMS\Core\Resource\MetaDataAspect::key

(

)

Returns the key of the current iteration

Returns

‪string

Definition at line 153 of file MetaDataAspect.php.

References TYPO3\CMS\Core\Resource\MetaDataAspect\$indexPosition.

loadFromRepository()

array TYPO3\CMS\Core\Resource\MetaDataAspect::loadFromRepository ( )

protected

Returns

‪array

Definition at line 213 of file MetaDataAspect.php.

References TYPO3\CMS\Core\Resource\Index\MetaDataRepository\findByFileUid(), and TYPO3\CMS\Core\Resource\MetaDataAspect\getMetaDataRepository().

Referenced by TYPO3\CMS\Core\Resource\MetaDataAspect\get(), and TYPO3\CMS\Core\Resource\MetaDataAspect\save().

next()

TYPO3\CMS\Core\Resource\MetaDataAspect::next

(

)

Increases the index for iteration

Definition at line 161 of file MetaDataAspect.php.

References TYPO3\CMS\Core\Resource\MetaDataAspect\$indexPosition.

offsetExists()

bool TYPO3\CMS\Core\Resource\MetaDataAspect::offsetExists

(

$offset

)

Parameters

mixed

$offset

Returns

‪bool

Definition at line 89 of file MetaDataAspect.php.

offsetGet()

mixed TYPO3\CMS\Core\Resource\MetaDataAspect::offsetGet

(

$offset

)

Parameters

mixed

$offset

Returns

‪mixed

Definition at line 98 of file MetaDataAspect.php.

offsetSet()

TYPO3\CMS\Core\Resource\MetaDataAspect::offsetSet	(		$offset,
			$value
	)

Parameters

mixed	$offset
mixed	$value

Definition at line 107 of file MetaDataAspect.php.

offsetUnset()

TYPO3\CMS\Core\Resource\MetaDataAspect::offsetUnset

(

$offset

)

Parameters

mixed

$offset

Definition at line 116 of file MetaDataAspect.php.

remove()

TYPO3\CMS\Core\Resource\MetaDataAspect::remove

(

)

Removes a meta data record

Definition at line 196 of file MetaDataAspect.php.

References TYPO3\CMS\Core\Resource\MetaDataAspect\getMetaDataRepository(), and TYPO3\CMS\Core\Resource\Index\MetaDataRepository\removeByFileUid().

rewind()

TYPO3\CMS\Core\Resource\MetaDataAspect::rewind

(

)

Resets the internal iterator counter

Definition at line 132 of file MetaDataAspect.php.

save()

TYPO3\CMS\Core\Resource\MetaDataAspect::save

(

)

Creates new or updates existing meta data

Definition at line 180 of file MetaDataAspect.php.

References TYPO3\CMS\Core\Resource\Index\MetaDataRepository\createMetaDataRecord(), TYPO3\CMS\Core\Resource\MetaDataAspect\getMetaDataRepository(), TYPO3\CMS\Core\Resource\MetaDataAspect\loadFromRepository(), and TYPO3\CMS\Core\Resource\Index\MetaDataRepository\update().

valid()

bool TYPO3\CMS\Core\Resource\MetaDataAspect::valid

(

)

Returns

‪bool

Definition at line 169 of file MetaDataAspect.php.

References TYPO3\CMS\Core\Resource\MetaDataAspect\$indexPosition.

Member Data Documentation

$file

File TYPO3\CMS\Core\Resource\MetaDataAspect::$file

private

Definition at line 30 of file MetaDataAspect.php.

Referenced by TYPO3\CMS\Core\Resource\MetaDataAspect\__construct().

$indexPosition

int TYPO3\CMS\Core\Resource\MetaDataAspect::$indexPosition = 0

private

Definition at line 44 of file MetaDataAspect.php.

Referenced by TYPO3\CMS\Core\Resource\MetaDataAspect\current(), TYPO3\CMS\Core\Resource\MetaDataAspect\key(), TYPO3\CMS\Core\Resource\MetaDataAspect\next(), and TYPO3\CMS\Core\Resource\MetaDataAspect\valid().

$loaded

bool TYPO3\CMS\Core\Resource\MetaDataAspect::$loaded = false

private

This flag is used to treat a possible recursion between $this->get() and $this->file->getUid()

Definition at line 40 of file MetaDataAspect.php.

$metaData

array TYPO3\CMS\Core\Resource\MetaDataAspect::$metaData = array( )

private

Definition at line 34 of file MetaDataAspect.php.

Referenced by TYPO3\CMS\Core\Resource\MetaDataAspect\add(), and TYPO3\CMS\Core\Resource\MetaDataAspect\get().