class ReadOnlyFileSerializationObjectRepository extends AbstractFilesystemObjectRepository implements PropertyMappingProviderInterface (View source)

Object repository that load objects from structured text files.

Traits

Trait for objects that holds a file serialization system
Trait for objects that define an object filename mapping strategy
ObjectManagerReferenceTrait

Constants

FETCH_USE_CACHED

FETCH_CACHE_OBJECT

Properties

protected FilenameMapperInterface $filenameMapper from FilenameStrategyTrait
protected string|NULL $extension from FilenameStrategyTrait
protected string $basePath from AbstractFilesystemObjectRepository
protected MediaTypeInterface|NULL $mediaType from SerializationStrategyTrait

Methods

setFilenameMapper(FilenameMapperInterface $filenameMapper = null)

No description

setFileExtension(string $extension)

No description

__construct(ClassMetadata $classMetadata, FileUnserializerInterface $serializer, $basePath, FilenameMapperInterface $filenameMapper = null, MediaTypeInterface $mediaType = null, $extension = null)

No description

find($id)

{@inheritdoc}

findBy(array $criteria, array|null $orderBy = null, $limit = null, $offset = null)

{@inheritdoc}

findOneBy(array $criteria)

No description

matching(Criteria $criteria)

No description

contains(object $object)

No description

attach(object $object)

No description

detach($object)

No description

boolean
isNaturalSort(array $orderBy)

Tell if ORDER BY rules corresponds to the natural sorting order of entries returned by getObjectFiles()

ClassMetadata
getClassMetadata()

No description

string[]
getObjectFiles()

No description

object
fetchObjectFromFile(string $filename, integer $flags = 0)

No description

ObjectSorterInterface
getObjectSorter()

Get object sorter.

setObjectSorter(ObjectSorterInterface $sorter)

No description

getObjectFile($object)

No description

string
getBasePath()

No description

setFilesystemStrategy(string $basePath, FilenameMapperInterface $filenameMapper = null, string $extension = null)

No description

getCachedObject($id, $normalized = false)

No description

cacheObject($object)

No description

uncacheObject($objectOrId)

No description

array
normalizeSortedBy(string|Traversable $orderBy)

No description

callable
createFilter(Expression $expression)

No description

FileSerializerInterface|FileUnserializerInterface|NULL
getSerializationManager()

No description

setSerializationManager(FileSerializerInterface|FileUnserializerInterface|NULL $serializationManager)

No description

MediaTypeInterface|NULL
getFileMediaType()

No description

setFileMediaType(MediaTypeInterface $mediaType)

No description

FileUnserializerInterface
getSerializer()

No description

Instantiator
getInstantiator()

No description

PropertyMappingInterface
getPropertyMapper()

No description

setObjectManager(ObjectManager $objectManager)

No description

Details

setFilenameMapper(FilenameMapperInterface $filenameMapper = null)

Parameters

FilenameMapperInterface $filenameMapper

getFileExtension()

string

setFileExtension(string $extension)

Parameters

string $extension Filename extension

__construct(ClassMetadata $classMetadata, FileUnserializerInterface $serializer, $basePath, FilenameMapperInterface $filenameMapper = null, MediaTypeInterface $mediaType = null, $extension = null)

Parameters

ClassMetadata $classMetadata
FileUnserializerInterface $serializer
$basePath
FilenameMapperInterface $filenameMapper
MediaTypeInterface $mediaType
$extension

Exceptions

InvalidArgumentException

find($id)

{@inheritdoc}

Parameters

$id

See also

\Doctrine\Persistence\ObjectRepository::find()

findBy(array $criteria, array|null $orderBy = null, $limit = null, $offset = null)

{@inheritdoc}

Parameters

array $criteria
array|null $orderBy
$limit
$offset

See also

\Doctrine\Persistence\ObjectRepository::findBy()

findOneBy(array $criteria)

Parameters

array $criteria

matching(Criteria $criteria)

Parameters

Criteria $criteria

contains(object $object)

Parameters

object $object

attach(object $object)

Parameters

object $object

detach($object)

Parameters

$object

boolean isNaturalSort(array $orderBy)

Tell if ORDER BY rules corresponds to the natural sorting order of entries returned by getObjectFiles()

Parameters

array $orderBy

Return Value

boolean

getClassName()

{@inheritdoc}

See also

\Doctrine\Persistence\ObjectRepository::getClassName()

ClassMetadata getClassMetadata()

Return Value

ClassMetadata

string[] getObjectFiles()

Return Value

string[] List of object files indexed by identifiers

object fetchObjectFromFile(string $filename, integer $flags = 0)

Parameters

string $filename File system file path.
integer $flags Option flags

Return Value

object Object

ObjectSorterInterface getObjectSorter()

Get object sorter.

A default one is created if none was set before.

Return Value

ObjectSorterInterface

setObjectSorter(ObjectSorterInterface $sorter)

Parameters

ObjectSorterInterface $sorter The sorter

getObjectFile($object)

Parameters

$object

getObjectIdentifierFile($id)

Parameters

$id

string getBasePath()

Return Value

string Storage base path

setFilesystemStrategy(string $basePath, FilenameMapperInterface $filenameMapper = null, string $extension = null)

Parameters

string $basePath Storage base path
FilenameMapperInterface $filenameMapper
string $extension File extension

getCachedObject($id, $normalized = false)

Parameters

$id
$normalized

cacheObject($object)

Parameters

$object

uncacheObject($objectOrId)

Parameters

$objectOrId

protected array normalizeSortedBy(string|Traversable $orderBy)

Parameters

string|Traversable $orderBy Parameter to normalize

Return Value

array

protected callable createFilter(Expression $expression)

Parameters

Expression $expression

Return Value

callable

FileSerializerInterface|FileUnserializerInterface|NULL getSerializationManager()

Return Value

FileSerializerInterface|FileUnserializerInterface|NULL

setSerializationManager(FileSerializerInterface|FileUnserializerInterface|NULL $serializationManager)

Parameters

FileSerializerInterface|FileUnserializerInterface|NULL $serializationManager Serializer

Exceptions

InvalidArgumentException

MediaTypeInterface|NULL getFileMediaType()

Return Value

MediaTypeInterface|NULL

setFileMediaType(MediaTypeInterface $mediaType)

Parameters

MediaTypeInterface $mediaType Media type of the generated file

FileUnserializerInterface getSerializer()

Return Value

FileUnserializerInterface

Instantiator getInstantiator()

Return Value

Instantiator

PropertyMappingInterface getPropertyMapper()

Return Value

PropertyMappingInterface

setObjectManager(ObjectManager $objectManager)

Parameters

ObjectManager $objectManager