Documentation

Package extends BaseMapper
in package

Mappers for package.

Tags
template

T0 of object

template-extends

BaseMapper<T0>

Table of Contents

Properties

$em  : EntityManager

Methods

__construct()  : mixed
count()  : int
createPackage()  : CompanyPackage
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>
findEditablePackage()  : CompanyPackage|null
Find all packages, and returns an editable version of them.
findFuturePackageExpirationsBeforeDate()  : array<string|int, T0>
Will return a list of published packages that will expire between now and $date.
findFuturePackageStartsBeforeDate()  : array<string|int, T0>
Will return a list of published packages that will expire between now and $date.
findJobPackagesByCompany()  : array<string|int, CompanyJobPackage>
Get all job packages for a specific company.
findNonExpiredPackages()  : array<string|int, T0>
Get non-expired packages for a specific company.
findOneBy()  : T|null
findVisiblePackages()  : array<string|int, T0>
Find all packages that should be visible, and returns an editable version of them.
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
getVisiblePackagesQueryBuilder()  : QueryBuilder

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

findEditablePackage()

Find all packages, and returns an editable version of them.

public findEditablePackage(int $packageId) : CompanyPackage|null
Parameters
$packageId : int
Return values
CompanyPackage|null

findFuturePackageExpirationsBeforeDate()

Will return a list of published packages that will expire between now and $date.

public findFuturePackageExpirationsBeforeDate(DateTime $date) : array<string|int, T0>
Parameters
$date : DateTime

The date until where to search

Return values
array<string|int, T0>

findFuturePackageStartsBeforeDate()

Will return a list of published packages that will expire between now and $date.

public findFuturePackageStartsBeforeDate(DateTime $date) : array<string|int, T0>
Parameters
$date : DateTime

The date until where to search

Return values
array<string|int, T0>

findNonExpiredPackages()

Get non-expired packages for a specific company.

public findNonExpiredPackages(Company $company) : array<string|int, T0>
Parameters
$company : Company
Return values
array<string|int, T0>

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

findVisiblePackages()

Find all packages that should be visible, and returns an editable version of them.

public findVisiblePackages() : array<string|int, T0>
Return values
array<string|int, T0>

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"

getVisiblePackagesQueryBuilder()

protected getVisiblePackagesQueryBuilder() : QueryBuilder
Return values
QueryBuilder 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results