Pivot Api Project
\
DebugBar
Bridge
SwiftMailer
Twig
DataCollector
PDO
DataFormatter
Storage
Pivot
Admin
Assemblers
Builders
Dtos
Factories
Managers
Resources
Http
Queue
Authentication
Adaptors
Assemblers
Dtos
Factories
Handlers
Identity
Interfaces
Keys
Managers
Models
Resources
Command
Http
Validators
Authorization
Factories
Client
Assemblers
Collections
Dtos
Entities
Factories
Handlers
Managers
Repositories
Resources
Http
Common
Assemblers
Collections
Dtos
Entities
Factories
Handlers
Repositories
Resources
Http
Core
App
Factories
Assemblers
Cache
Collections
Commands
Output
Setup
Util
Configuration
Debug
Dtos
Events
Exceptions
Factories
Handlers
Interfaces
Managers
Middleware
Cli
Http
Queue
Test
Models
Renderer
ReqRes
Interfaces
Resources
Commands
Services
Traits
Resource
Database
Assemblers
Commands
Entities
Events
Factories
Filters
Handlers
Interfaces
Managers
Repositories
Schema
SchemaAdaptors
Email
Commands
Factories
Events
Factories
Mediator
Import
Factories
Resources
Http
Queue
Validators
Interventions
Assemblers
Dtos
Entities
Factories
Handlers
Models
Repositories
Resources
Http
Logger
Factories
Logging
Queue
Assemblers
Dtos
Entities
Factories
Handlers
Repositories
ResourceGeneration
Builders
Commands
Test
Cases
Data

\Pivot\Client\HandlersGradingPeriodHandler

Abstract handler class

Summary

Methods
Properties
Constants
create()
makeEntity()
fetchAll()
fetch()
put()
patch()
update()
delete()
pushEntity()
deleteEntity()
assembleDto()
assembleDtoCollection()
getRepresentation()
getCollectionRepresentation()
verrifyEntity()
clear()
setEntityClass()
isProblem()
handlePossibleProblem()
apiProblemResponse()
makeIsoDate()
makeIsoTime()
makeDateTime()
makeTime()
modifyCollection()
setEntityManager()
getEntityManager()
setRepository()
getRepository()
setAssembler()
getAssembler()
__construct()
getGradingPeriods()
No public properties found
No constants found
mergeEntityDto()
$entityClass
$entityManager
$repository
$assembler
N/A
No private methods found
No private properties found
N/A

Properties

$entityClass

$entityClass : string

The entity that this class handles

Type

string

$entityManager

$entityManager : \Pivot\Core\Traits\An

Type

\Pivot\Core\Traits\An — entityManager

$repository

$repository : \Pivot\Core\Traits\Pivot\Core\Repository\

Type

\Pivot\Core\Traits\Pivot\Core\Repository\

$assembler

$assembler : \Pivot\Core\Traits\An

Type

\Pivot\Core\Traits\An — IsAssembler assembler

Methods

create()

create(object  $dto) : \Pivot\Core\Handlers\entity

Create an entity from data

Parameters

object $dto

data for entity

Returns

\Pivot\Core\Handlers\entity

makeEntity()

makeEntity(object  $dto) : \Pivot\Core\Handlers\Entity

Make an entity from a DTO

Parameters

object $dto

Returns

\Pivot\Core\Handlers\Entity

fetchAll()

fetchAll() : \Pivot\Core\Handlers\Entity

Get all entities (may have filters applied)

Returns

\Pivot\Core\Handlers\Entity

fetch()

fetch(integer  $id) : \Pivot\Core\Handlers\entity

Return one entity by Id

Parameters

integer $id

Returns

\Pivot\Core\Handlers\entity

put()

put(object  $dto) : \Pivot\Core\Handlers\entity

Full inplace update of the entity

Parameters

object $dto

Full object

Returns

\Pivot\Core\Handlers\entity

patch()

patch(object  $dto) : \Pivot\Core\Handlers\entity

partial update of entity

Parameters

object $dto

data

Returns

\Pivot\Core\Handlers\entity

update()

update(\Pivot\Core\Handlers\entity  $entity, object  $dto) : \Pivot\Core\Handlers\entity

partial update of pre-selected entity

Parameters

\Pivot\Core\Handlers\entity $entity

entity
object $dto

data

Returns

\Pivot\Core\Handlers\entity

delete()

delete(integer  $id) : void

Deletes an entity

Parameters

integer $id

pushEntity()

pushEntity(  $entity,   $flush = true)

Doing this through a function like this would solve the need for the precreate hooks

Parameters

$entity
$flush

deleteEntity()

deleteEntity(  $entity,   $flush = true)

Doing this through a function like this would solve the need for the predelete hooks

Parameters

$entity
$flush

assembleDto()

assembleDto(\Pivot\Core\Handlers\entity  $entity) : \Pivot\Core\Handlers\addembled

Creates the DTO from an entity

Parameters

\Pivot\Core\Handlers\entity $entity

Returns

\Pivot\Core\Handlers\addembled —

DTO

assembleDtoCollection()

assembleDtoCollection(  $entities) : \Pivot\Core\Handlers\addembled

Creates the DTO from an entity

Parameters

$entities

Returns

\Pivot\Core\Handlers\addembled —

DTO

getRepresentation()

getRepresentation(\Pivot\Core\Handlers\int/object/array  $mixed, string  $className) : \Pivot\Core\Handlers\Entity

Gets a representation of an entity

Parameters

\Pivot\Core\Handlers\int/object/array $mixed

id value
string $className

Classname of the entity

Returns

\Pivot\Core\Handlers\Entity —

Representation/Null

getCollectionRepresentation()

getCollectionRepresentation(  $arrayMixed, string  $className) : \Pivot\Core\Handlers\collection

Gets a representation of a collection

Parameters

$arrayMixed
string $className

Classname of the entity

Returns

\Pivot\Core\Handlers\collection

verrifyEntity()

verrifyEntity(  $entity,   $throwError = false)

Parameters

$entity
$throwError

clear()

clear()

setEntityClass()

setEntityClass(  $class)

Parameters

$class

isProblem()

isProblem(  $object,   $strict = true)

Parameters

$object
$strict

handlePossibleProblem()

handlePossibleProblem(object  $object)

Check for problem and return response to apigility

Parameters

object $object

[description]

apiProblemResponse()

apiProblemResponse(  $code,   $message)

Parameters

$code
$message

makeIsoDate()

makeIsoDate(  $date)

Parameters

$date

makeIsoTime()

makeIsoTime(  $time)

Parameters

$time

makeDateTime()

makeDateTime(  $string,   $returnProblem = false)

Parameters

$string
$returnProblem

makeTime()

makeTime(  $string,   $returnProblem = false)

Parameters

$string
$returnProblem

modifyCollection()

modifyCollection(\Pivot\Core\Traits\Entity  $entityWithCollection, array  $submittedArray, string  $param, string  $className,   $getOverride = null) : \Pivot\Core\Traits\Entity

Remove missing relations, add new relations, and ignore non-changed

Parameters

\Pivot\Core\Traits\Entity $entityWithCollection
array $submittedArray

Array to calculate changes from
string $param

param of the entity that has the collection
string $className

Class of the assoicated collection entity
$getOverride

Returns

\Pivot\Core\Traits\Entity —

with modified collection

setEntityManager()

setEntityManager(\Doctrine\ORM\EntityManager  $entityManager)

Parameters

\Doctrine\ORM\EntityManager $entityManager

getEntityManager()

getEntityManager() : \Pivot\Core\Traits\entityManager

[getAssembler description]

Returns

\Pivot\Core\Traits\entityManager

setRepository()

setRepository(  $repository)

Parameters

$repository

getRepository()

getRepository()

getAssembler()

getAssembler(  $assembler = null) : \Pivot\Core\Traits\assembler

[getAssembler description]

Parameters

$assembler

Returns

\Pivot\Core\Traits\assembler

__construct()

__construct()

getGradingPeriods()

getGradingPeriods(  $params)

Parameters

$params

mergeEntityDto()

mergeEntityDto(\Pivot\Core\Handlers\entity  $entity, object  $dto) : \Pivot\Core\Handlers\entity

Merges supplied data into the entity

Parameters

\Pivot\Core\Handlers\entity $entity
object $dto

Returns

\Pivot\Core\Handlers\entity