Documentation

Activity 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

BaseMapper<ActivityModel>

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>
findAllActivitiesApprovedByMember()  : array<string|int, Activity>
Get all activities that were approved or rejected by a member.
findAllActivitiesCreatedByMember()  : array<string|int, Activity>
Get all activities that were created by a member.
findBy()  : array<string|int, T>
findOneBy()  : T|null
flush()  : void
getAllUpcomingActivities()  : array<string|int, Activity>
Gets upcoming activities of the given organs or user, sorted by date.
getArchivedActivitiesInRange()  : array<string|int, Activity>
getConnection()  : Connection
Get the entity manager connection.
getEntityManager()  : EntityManager
Get the entity manager.
getOldActivityPaginatorAdapterByOrganizer()  : DoctrinePaginator
Gets a paginator of old activities of the given organs, sorted by date.
getOldestActivity()  : Activity|null
Returns the oldest activity that has taken place.
getUpcomingActivities()  : array<string|int, Activity>
Get upcoming activities sorted by date.
getUpcomingActivitiesByOrgan()  : array<string|int, Activity>
Get upcoming activities sorted by date that an organ created.
getUpcomingActivitiesCreatedBy()  : array<string|int, Activity>
Get upcoming activities sorted by date that a user created.
getUpcomingActivitiesForMember()  : array<string|int, Activity>
Get upcoming activities sorted by date for member.
getUpcomingActivitiesSubscribedBy()  : array<string|int, Activity>
Get upcoming activities sorted by date that a user is subscribed to.
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.
activityByOrganizerQuery()  : QueryBuilder
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

findAllActivitiesApprovedByMember()

Get all activities that were approved or rejected by a member.

public findAllActivitiesApprovedByMember(Member $member) : array<string|int, Activity>
Parameters
$member : Member
Return values
array<string|int, Activity>

findAllActivitiesCreatedByMember()

Get all activities that were created by a member.

public findAllActivitiesCreatedByMember(Member $member) : array<string|int, Activity>
Parameters
$member : Member
Return values
array<string|int, Activity>

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

getAllUpcomingActivities()

Gets upcoming activities of the given organs or user, sorted by date.

public getAllUpcomingActivities([array<string|int, Organ>|null $organs = null ][, User|null $user = null ][, int|null $status = null ]) : array<string|int, Activity>
Parameters
$organs : array<string|int, Organ>|null = null
$user : User|null = null
$status : int|null = null

An optional filter for activity status

Return values
array<string|int, Activity>

getArchivedActivitiesInRange()

public getArchivedActivitiesInRange(DateTime $start, DateTime $end) : array<string|int, Activity>
Parameters
$start : DateTime
$end : DateTime
Return values
array<string|int, Activity>

getConnection()

Get the entity manager connection.

public getConnection() : Connection
Return values
Connection

getEntityManager()

Get the entity manager.

public getEntityManager() : EntityManager
Return values
EntityManager

getOldActivityPaginatorAdapterByOrganizer()

Gets a paginator of old activities of the given organs, sorted by date.

public getOldActivityPaginatorAdapterByOrganizer([array<string|int, Organ>|null $organs = null ][, User|null $user = null ][, int|null $status = null ]) : DoctrinePaginator

Supplying 'null' to all arguments gets all activities.

Parameters
$organs : array<string|int, Organ>|null = null
$user : User|null = null
$status : int|null = null

An optional filter for activity status

Return values
DoctrinePaginator

getOldestActivity()

Returns the oldest activity that has taken place.

public getOldestActivity() : Activity|null
Return values
Activity|null

getUpcomingActivities()

Get upcoming activities sorted by date.

public getUpcomingActivities([int|null $count = null ][, Organ|null $organ = null ][, string|null $category = null ]) : array<string|int, Activity>
Parameters
$count : int|null = null

optional number of activities to retrieve

$organ : Organ|null = null

option organ by whom the activities are organized

$category : string|null = null
Return values
array<string|int, Activity>

getUpcomingActivitiesByOrgan()

Get upcoming activities sorted by date that an organ created.

public getUpcomingActivitiesByOrgan(Organ $organ) : array<string|int, Activity>
Parameters
$organ : Organ

Option organ that should relate to activity

Return values
array<string|int, Activity>

getUpcomingActivitiesCreatedBy()

Get upcoming activities sorted by date that a user created.

public getUpcomingActivitiesCreatedBy(User $user) : array<string|int, Activity>
Parameters
$user : User

Option user that should relate to activity

Return values
array<string|int, Activity>

getUpcomingActivitiesForMember()

Get upcoming activities sorted by date for member.

public getUpcomingActivitiesForMember(User $user) : array<string|int, Activity>
Parameters
$user : User

Option user that should relate to activity

Return values
array<string|int, Activity>

getUpcomingActivitiesSubscribedBy()

Get upcoming activities sorted by date that a user is subscribed to.

public getUpcomingActivitiesSubscribedBy(User $user) : array<string|int, Activity>
Parameters
$user : User

Option user that should relate to activity

Return values
array<string|int, Activity>

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

activityByOrganizerQuery()

protected activityByOrganizerQuery([Comparison|null $filter = null ][, array<string|int, Organ>|null $organs = null ][, User|null $user = null ][, int|null $status = null ]) : QueryBuilder
Parameters
$filter : Comparison|null = null
$organs : array<string|int, Organ>|null = null
$user : User|null = null
$status : int|null = null
Return values
QueryBuilder

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