interface RepositoryInterface (View source)

Contract for a repository

Methods

string
getEntityClassName()

Returns the object type this repository is managing.

void
add(object $object)

Adds an object to this repository.

void
remove(object $object)

Removes an object from this repository.

findAll()

Returns all objects of this repository.

object|null
findByIdentifier(mixed $identifier)

Finds an object matching the given identifier.

createQuery()

Returns a query for objects of this repository

int
countAll()

Counts all objects of this repository

void
removeAll()

Removes all objects of this repository as if remove() was called for all of them.

void
setDefaultOrderings(array $defaultOrderings)

Sets the property names to order results by. Expected like this: array( 'foo' => \Neos\Flow\Persistence\QueryInterface::ORDER_ASCENDING, 'bar' => \Neos\Flow\Persistence\QueryInterface::ORDER_DESCENDING )

void
update(object $object)

Schedules a modified object for persistence.

mixed
__call(string $method, array $arguments)

Magic call method for repository methods.

Details

string getEntityClassName()

Returns the object type this repository is managing.

Return Value

string

void add(object $object)

Adds an object to this repository.

Parameters

object $object

The object to add

Return Value

void

void remove(object $object)

Removes an object from this repository.

Parameters

object $object

The object to remove

Return Value

void

QueryResultInterface findAll()

Returns all objects of this repository.

Return Value

QueryResultInterface

The query result

object|null findByIdentifier(mixed $identifier)

Finds an object matching the given identifier.

Parameters

mixed $identifier

The identifier of the object to find

Return Value

object|null

The matching object if found, otherwise NULL

QueryInterface createQuery()

Returns a query for objects of this repository

Return Value

QueryInterface

int countAll()

Counts all objects of this repository

Return Value

int

void removeAll()

Removes all objects of this repository as if remove() was called for all of them.

Return Value

void

void setDefaultOrderings(array $defaultOrderings)

Sets the property names to order results by. Expected like this: array( 'foo' => \Neos\Flow\Persistence\QueryInterface::ORDER_ASCENDING, 'bar' => \Neos\Flow\Persistence\QueryInterface::ORDER_DESCENDING )

Parameters

array $defaultOrderings

The property names to order by by default

Return Value

void

void update(object $object)

Schedules a modified object for persistence.

Parameters

object $object

The modified object

Return Value

void

mixed __call(string $method, array $arguments)

Magic call method for repository methods.

Provides three methods

  • findBy($value, $caseSensitive = true, $cacheResult = false)
  • findOneBy($value, $caseSensitive = true, $cacheResult = false)
  • countBy($value, $caseSensitive = true)

Parameters

string $method

Name of the method

array $arguments

The arguments

Return Value

mixed

The result of the repository method