1. class
  2. NoreSources
  3. \
  4. OFM
  5. \
  6. Filesystem
  7. \
  8. AbstractFilesystemObjectRepository

AbstractFilesystemObjectRepository

abstract class AbstractFilesystemObjectRepository implements ObjectRepository, Selectable, ObjectManagerProviderInterface, ObjectManagerAwareInterface, ObjectContainerInterface (View source)

File-based object repository base implementation

Traits

FilenameStrategyTrait
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

Methods

FilenameMapperInterface
getFilenameMapper()

No description

from FilenameStrategyTrait
setFilenameMapper(FilenameMapperInterface $filenameMapper = null)

No description

from FilenameStrategyTrait
getFileExtension()

string

from FilenameStrategyTrait
setFileExtension(string $extension)

No description

from FilenameStrategyTrait
__construct(ClassMetadata $classMetadata, $basePath, FilenameMapperInterface $filenameMapper = 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

findAll()

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()

getClassName()

{@inheritdoc}

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

getObjectIdentifierFile($id)

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

Details

in FilenameStrategyTrait at line 23
FilenameMapperInterface getFilenameMapper()

Return Value

FilenameMapperInterface

in FilenameStrategyTrait at line 32
setFilenameMapper(FilenameMapperInterface $filenameMapper = null)

Parameters

FilenameMapperInterface $filenameMapper

in FilenameStrategyTrait at line 41
getFileExtension()

string

in FilenameStrategyTrait at line 51
setFileExtension(string $extension)

Parameters

string $extension Filename extension

at line 56
__construct(ClassMetadata $classMetadata, $basePath, FilenameMapperInterface $filenameMapper = null, $extension = null)

Parameters

ClassMetadata $classMetadata
$basePath
FilenameMapperInterface $filenameMapper
$extension

at line 71
find($id)

{@inheritdoc}

Parameters

$id

See also

\Doctrine\Persistence\ObjectRepository::find()

at line 93
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()

at line 183
findOneBy(array $criteria)

Parameters

array $criteria

at line 189
findAll()

at line 200
matching(Criteria $criteria)

Parameters

Criteria $criteria

at line 236
contains(object $object)

Parameters

object $object

at line 243
attach(object $object)

Parameters

object $object

at line 256
detach($object)

Parameters

$object

at line 274
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

at line 284
getClassName()

{@inheritdoc}

See also

\Doctrine\Persistence\ObjectRepository::getClassName()

at line 293
ClassMetadata getClassMetadata()

Return Value

ClassMetadata

at line 302
string[] getObjectFiles()

Return Value

string[] List of object files indexed by identifiers

at line 352
abstract object fetchObjectFromFile(string $filename, integer $flags = 0)

Parameters

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

Return Value

object Object

at line 368
ObjectSorterInterface getObjectSorter()

Get object sorter.

A default one is created if none was set before.

Return Value

ObjectSorterInterface

at line 380
setObjectSorter(ObjectSorterInterface $sorter)

Parameters

ObjectSorterInterface $sorter The sorter

at line 385
getObjectFile($object)

Parameters

$object

at line 392
getObjectIdentifierFile($id)

Parameters

$id

at line 406
string getBasePath()

Return Value

string Storage base path

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

Parameters

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

at line 431
getCachedObject($id, $normalized = false)

Parameters

$id
$normalized

at line 440
cacheObject($object)

Parameters

$object

at line 451
uncacheObject($objectOrId)

Parameters

$objectOrId

at line 465
protected array normalizeSortedBy(string|Traversable $orderBy)

Parameters

string|Traversable $orderBy Parameter to normalize

Return Value

array

at line 492
protected callable createFilter(Expression $expression)

Parameters

Expression $expression

Return Value

callable