KMP PHP API Reference

EmailTemplatesTable extends Table
in package

EmailTemplates Model

Tags
mixin

Table of Contents

Methods

buildRules()  : RulesChecker
Returns a rules checker object that will be used for validating application integrity.
deleteMany()  : iterable<string|int, EmailTemplate>|ResultSetInterface<string|int, EmailTemplate>|false
deleteManyOrFail()  : iterable<string|int, EmailTemplate>|ResultSetInterface<string|int, EmailTemplate>
findActive()  : SelectQuery
Get all active templates
findForMailer()  : EmailTemplate|null
Find template for a specific mailer class and action
findOrCreate()  : EmailTemplate
get()  : EmailTemplate
getSchema()  : TableSchemaInterface
Configure database schema with JSON field support
getTemplatesByMailer()  : array<string|int, mixed>
Get templates grouped by mailer class
initialize()  : void
Initialize method
newEmptyEntity()  : EmailTemplate
newEntities()  : array<string|int, EmailTemplate>
newEntity()  : EmailTemplate
patchEntities()  : array<string|int, EmailTemplate>
patchEntity()  : EmailTemplate
save()  : EmailTemplate|false
saveMany()  : iterable<string|int, EmailTemplate>|ResultSetInterface<string|int, EmailTemplate>|false
saveManyOrFail()  : iterable<string|int, EmailTemplate>|ResultSetInterface<string|int, EmailTemplate>
saveOrFail()  : EmailTemplate
validationDefault()  : Validator
Default validation rules.

Methods

buildRules()

Returns a rules checker object that will be used for validating application integrity.

public buildRules(RulesChecker $rules) : RulesChecker
Parameters
$rules : RulesChecker

The rules object to be modified.

Return values
RulesChecker

deleteMany()

public deleteMany(iterable<string|int, mixed> $entities[, array<string|int, mixed> $options = = '[]' ]) : iterable<string|int, EmailTemplate>|ResultSetInterface<string|int, EmailTemplate>|false
Parameters
$entities : iterable<string|int, mixed>
$options : array<string|int, mixed> = = '[]'
Return values
iterable<string|int, EmailTemplate>|ResultSetInterface<string|int, EmailTemplate>|false

deleteManyOrFail()

public deleteManyOrFail(iterable<string|int, mixed> $entities[, array<string|int, mixed> $options = = '[]' ]) : iterable<string|int, EmailTemplate>|ResultSetInterface<string|int, EmailTemplate>
Parameters
$entities : iterable<string|int, mixed>
$options : array<string|int, mixed> = = '[]'
Return values
iterable<string|int, EmailTemplate>|ResultSetInterface<string|int, EmailTemplate>

findActive()

Get all active templates

public findActive(SelectQuery $query) : SelectQuery
Parameters
$query : SelectQuery
Return values
SelectQuery

findForMailer()

Find template for a specific mailer class and action

public findForMailer(string $mailerClass, string $actionMethod) : EmailTemplate|null
Parameters
$mailerClass : string

Fully qualified mailer class name

$actionMethod : string

Action method name

Return values
EmailTemplate|null

findOrCreate()

public findOrCreate(mixed $search[, callable|null $callback = = 'null' ][, array<string|int, mixed> $options = = '[]' ]) : EmailTemplate
Parameters
$search : mixed
$callback : callable|null = = 'null'
$options : array<string|int, mixed> = = '[]'
Return values
EmailTemplate

get()

public get(mixed $primaryKey[, array<string|int, mixed>|string $finder = = '[]' ][, CacheInterface|string|null $cache = = 'null' ][, Closure|string|null $cacheKey = = 'null' ], mixed ...$args) : EmailTemplate
Parameters
$primaryKey : mixed
$finder : array<string|int, mixed>|string = = '[]'
$cache : CacheInterface|string|null = = 'null'
$cacheKey : Closure|string|null = = 'null'
$args : mixed
Return values
EmailTemplate

getSchema()

Configure database schema with JSON field support

public getSchema() : TableSchemaInterface

Extends the base schema configuration to properly handle JSON fields, specifically the available_vars field used for storing template variable metadata. This ensures proper data type handling and serialization for JSON content.

Return values
TableSchemaInterface —

Configured schema with JSON field types

getTemplatesByMailer()

Get templates grouped by mailer class

public getTemplatesByMailer() : array<string|int, mixed>
Return values
array<string|int, mixed>

initialize()

Initialize method

public initialize(array<string, mixed> $config) : void
Parameters
$config : array<string, mixed>

The configuration for the Table.

newEntities()

public newEntities(array<string|int, mixed> $data[, array<string|int, mixed> $options = = '[]' ]) : array<string|int, EmailTemplate>
Parameters
$data : array<string|int, mixed>
$options : array<string|int, mixed> = = '[]'
Return values
array<string|int, EmailTemplate>

newEntity()

public newEntity(array<string|int, mixed> $data[, array<string|int, mixed> $options = = '[]' ]) : EmailTemplate
Parameters
$data : array<string|int, mixed>
$options : array<string|int, mixed> = = '[]'
Return values
EmailTemplate

patchEntities()

public patchEntities(iterable<string|int, mixed> $entities, array<string|int, mixed> $data[, array<string|int, mixed> $options = = '[]' ]) : array<string|int, EmailTemplate>
Parameters
$entities : iterable<string|int, mixed>
$data : array<string|int, mixed>
$options : array<string|int, mixed> = = '[]'
Return values
array<string|int, EmailTemplate>

patchEntity()

public patchEntity(EntityInterface $entity, array<string|int, mixed> $data[, array<string|int, mixed> $options = = '[]' ]) : EmailTemplate
Parameters
$entity : EntityInterface
$data : array<string|int, mixed>
$options : array<string|int, mixed> = = '[]'
Return values
EmailTemplate

save()

public save(EntityInterface $entity[, array<string|int, mixed> $options = = '[]' ]) : EmailTemplate|false
Parameters
$entity : EntityInterface
$options : array<string|int, mixed> = = '[]'
Return values
EmailTemplate|false

saveMany()

public saveMany(iterable<string|int, mixed> $entities[, array<string|int, mixed> $options = = '[]' ]) : iterable<string|int, EmailTemplate>|ResultSetInterface<string|int, EmailTemplate>|false
Parameters
$entities : iterable<string|int, mixed>
$options : array<string|int, mixed> = = '[]'
Return values
iterable<string|int, EmailTemplate>|ResultSetInterface<string|int, EmailTemplate>|false

saveManyOrFail()

public saveManyOrFail(iterable<string|int, mixed> $entities[, array<string|int, mixed> $options = = '[]' ]) : iterable<string|int, EmailTemplate>|ResultSetInterface<string|int, EmailTemplate>
Parameters
$entities : iterable<string|int, mixed>
$options : array<string|int, mixed> = = '[]'
Return values
iterable<string|int, EmailTemplate>|ResultSetInterface<string|int, EmailTemplate>

saveOrFail()

public saveOrFail(EntityInterface $entity[, array<string|int, mixed> $options = = '[]' ]) : EmailTemplate
Parameters
$entity : EntityInterface
$options : array<string|int, mixed> = = '[]'
Return values
EmailTemplate

validationDefault()

Default validation rules.

public validationDefault(Validator $validator) : Validator
Parameters
$validator : Validator

Validator instance.

Return values
Validator 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results