Documentation

Album extends BaseMapper
in package

Mappers for Album.

Tags
template-extends

Table of Contents

Properties

$em  : EntityManager

Methods

__construct()  : mixed
count()  : int
detach()  : void
Detaches an entity from the entity manager causing any changed to be made to the object to be unsaved
find()  : T|null
findAll()  : array<string|int, T>
findBy()  : array<string|int, T>
findOneBy()  : T|null
flush()  : void
getAlbumsInDateRange()  : array<string|int, Album>
Gets all root albums with a start date between the specified dates.
getAlbumsWithoutDate()  : array<string|int, Album>
Retrieves all root albums which do not have a startDateTime specified.
getConnection()  : Connection
Get the entity manager connection.
getEntityManager()  : EntityManager
Get the entity manager.
getNewestAlbum()  : Album|null
Returns the root album containing the most recent photos.
getOldestAlbum()  : Album|null
Returns the root album containing the oldest photos.
persist()  : void
persistMultiple()  : void
Persist multiple studies.
remove()  : void
removeById()  : void
Remove an entity by its ID using find
removeMultiple()  : void
Removes multiple studies.
search()  : array<string|int, Album>
Gets all root albums based on their name.
transactional()  : mixed
Transactional Doctrine wrapper.
getRepository()  : EntityRepository
Get the repository for this mapper.
getRepositoryName()  : string

Properties

Methods

__construct()

public __construct(EntityManager $em) : mixed
Parameters
$em : EntityManager

count()

public count(mixed $criteria) : int
Parameters
$criteria : mixed

The criteria the objects to be counted should satisfy

Return values
int —

The number of entities satisfying the criteria

detach()

Detaches an entity from the entity manager causing any changed to be made to the object to be unsaved

public detach(object $entity) : void
Parameters
$entity : object
Tags
psalm-param

T $entity

find()

public find(mixed $id) : T|null
Parameters
$id : mixed

The ID of the entity to be retrieved using the primary key

Return values
T|null —

The entity corresponding to the provided ID or null of the entity cannot be found

findAll()

public findAll() : array<string|int, T>
Return values
array<string|int, T> —

All entities in the repository

findBy()

public findBy(mixed $criteria) : array<string|int, T>
Parameters
$criteria : mixed

The criteria that describe the entity to be retrieved

Return values
array<string|int, T> —

The entities corresponding to the provided criteria

findOneBy()

public findOneBy(array<string|int, mixed> $criteria) : T|null
Parameters
$criteria : array<string|int, mixed>

The criteria that describe the entity to be retrieved

Tags
phpcsSuppress

SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingTraversableTypeHintSpecification

Return values
T|null —

The entity corresponding to the provided criteria or null of the entity cannot be found

flush()

public flush() : void
Tags
throws
ORMException
throws
OptimisticLockException

getAlbumsInDateRange()

Gets all root albums with a start date between the specified dates.

public getAlbumsInDateRange(DateTime $start, DateTime $end[, bool $onlyPublished = true ]) : array<string|int, Album>
Parameters
$start : DateTime

start date and time

$end : DateTime

end date and time

$onlyPublished : bool = true
Return values
array<string|int, Album>

getAlbumsWithoutDate()

Retrieves all root albums which do not have a startDateTime specified.

public getAlbumsWithoutDate() : array<string|int, Album>

This is in most cases analogous to returning all empty albums.

Return values
array<string|int, Album>

getConnection()

Get the entity manager connection.

public getConnection() : Connection
Return values
Connection

getEntityManager()

Get the entity manager.

public getEntityManager() : EntityManager
Return values
EntityManager

getNewestAlbum()

Returns the root album containing the most recent photos.

public getNewestAlbum([bool $onlyPublished = true ]) : Album|null
Parameters
$onlyPublished : bool = true
Return values
Album|null

getOldestAlbum()

Returns the root album containing the oldest photos.

public getOldestAlbum([bool $onlyPublished = true ]) : Album|null
Parameters
$onlyPublished : bool = true
Return values
Album|null

persist()

public persist(object $entity) : void
Parameters
$entity : object
Tags
psalm-param

T|LocalisedTextModel $entity

throws
ORMException

persistMultiple()

Persist multiple studies.

public persistMultiple(array<string|int, mixed> $entities) : void
Parameters
$entities : array<string|int, mixed>
Tags
psalm-param

T[] $entities

throws
ORMException

remove()

public remove(object $entity) : void
Parameters
$entity : object
Tags
psalm-param

T|LocalisedTextModel $entity

throws
ORMException

removeById()

Remove an entity by its ID using find

public removeById(mixed $id) : void
Parameters
$id : mixed
Tags
throws
EntityNotFoundException
throws
OptimisticLockException
throws
ORMException

removeMultiple()

Removes multiple studies.

public removeMultiple(array<string|int, mixed> $entities) : void
Parameters
$entities : array<string|int, mixed>
Tags
psalm-param

T[] $entities

throws
ORMException

search()

Gets all root albums based on their name.

public search(string $query) : array<string|int, Album>

Only returns published albums and grouping has to happen downstream at the consumers.

Parameters
$query : string
Return values
array<string|int, Album>

transactional()

Transactional Doctrine wrapper.

public transactional(Closure $func) : mixed

Instead of the EntityManager, this inserts this Mapper into the function.

Parameters
$func : Closure

getRepository()

Get the repository for this mapper.

protected getRepository() : EntityRepository
Tags
psalm-return

EntityRepository<T>

Return values
EntityRepository

getRepositoryName()

protected getRepositoryName() : string
Return values
string —

the name of the entity repository e.g. "User/Model/User"


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results