Documentation

Meeting extends BaseMapper
in package

The base mapper to be used for all other mappers. It helps with preventing duplicate Doctrine code. It uses special types to ensure that the returned values are as expected. As {@link LocalisedTextModel} does not have its own mapper, any of such objects can be persisted and/or removed from the base mapper.

Tags
template-extends
psalm-type

MeetingArrayType = array<array-key, array{ 0: MeetingModel, 1: int, }>

Table of Contents

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>
findAllMeetings()  : MeetingArrayType
Find all meetings.
findBy()  : array<string|int, T>
findByType()  : array<string|int, Meeting>
Find all meetings which have the given type.
findLatestALV()  : Meeting|null
Returns the latest upcoming ALV or null if there is none.
findMaxDocumentPosition()  : int|null
Returns the maximum document position for the given meeting.
findMeeting()  : Meeting|null
Find a meeting with all decisions.
findOneBy()  : T|null
findPast()  : array<string|int, Meeting>
Find all meetings that have taken place.
findUpcomingAnnouncedMeetings()  : array<string|int, Meeting>
flush()  : void
getConnection()  : Connection
Get the entity manager connection.
getEntityManager()  : EntityManager
Get the entity manager.
persist()  : void
persistMultiple()  : void
Persist multiple studies.
remove()  : void
removeById()  : void
Remove an entity by its ID using find
removeMultiple()  : void
Removes multiple studies.
transactional()  : mixed
Transactional Doctrine wrapper.
getRepository()  : EntityRepository
Get the repository for this mapper.
getRepositoryName()  : string

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

findAllMeetings()

Find all meetings.

public findAllMeetings([int|null $limit = null ][, MeetingTypes|null $type = null ]) : MeetingArrayType
Parameters
$limit : int|null = null

The amount of results, default is all

$type : MeetingTypes|null = null
Return values
MeetingArrayType

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

findLatestALV()

Returns the latest upcoming ALV or null if there is none.

public findLatestALV() : Meeting|null

Note that if multiple ALVs are planned, the one that is planned furthest away is returned.

Tags
throws
NonUniqueResultException
Return values
Meeting|null

findMaxDocumentPosition()

Returns the maximum document position for the given meeting.

public findMaxDocumentPosition(Meeting $meeting) : int|null
Parameters
$meeting : Meeting
Tags
throws
NoResultException
throws
NonUniqueResultException
Return values
int|null —

NULL if no documents are associated to the meeting

findMeeting()

Find a meeting with all decisions.

public findMeeting(MeetingTypes $type, int $number) : Meeting|null
Parameters
$type : MeetingTypes
$number : int
Tags
throws
NonUniqueResultException
Return values
Meeting|null

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

findPast()

Find all meetings that have taken place.

public findPast(int $limit, MeetingTypes $type) : array<string|int, Meeting>
Parameters
$limit : int

The amount of results

$type : MeetingTypes
Return values
array<string|int, Meeting> —

Meetings that have taken place

findUpcomingAnnouncedMeetings()

public findUpcomingAnnouncedMeetings() : array<string|int, Meeting>
Return values
array<string|int, Meeting>

flush()

public flush() : void
Tags
throws
ORMException
throws
OptimisticLockException

getConnection()

Get the entity manager connection.

public getConnection() : Connection
Return values
Connection

getEntityManager()

Get the entity manager.

public getEntityManager() : EntityManager
Return values
EntityManager

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

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