KMP PHP API Reference

DocumentsTable extends Table
in package

Documents Model

Generic polymorphic document storage. Follows the same pattern as Notes.

Table of Contents

Properties

$Creators  : MembersTable|BelongsTo
$Modifiers  : MembersTable|BelongsTo
$Uploaders  : MembersTable|BelongsTo

Methods

buildRules()  : RulesChecker
Returns a rules checker object that will be used for validating application integrity.
deleteMany()  : iterable<string|int, Document>|ResultSetInterface<string|int, Document>|false
deleteManyOrFail()  : iterable<string|int, Document>|ResultSetInterface<string|int, Document>
findByEntity()  : SelectQuery
Find documents by entity type and ID
findOrCreate()  : Document
get()  : Document
initialize()  : void
Initialize method
newEmptyEntity()  : Document
newEntities()  : array<string|int, Document>
newEntity()  : Document
patchEntities()  : array<string|int, Document>
patchEntity()  : Document
save()  : Document|false
saveMany()  : iterable<string|int, Document>|ResultSetInterface<string|int, Document>|false
saveManyOrFail()  : iterable<string|int, Document>|ResultSetInterface<string|int, Document>
saveOrFail()  : Document
validationDefault()  : Validator
Default validation rules.

Properties

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, Document>|ResultSetInterface<string|int, Document>|false
Parameters
$entities : iterable<string|int, mixed>
$options : array<string|int, mixed> = = '[]'
Return values
iterable<string|int, Document>|ResultSetInterface<string|int, Document>|false

deleteManyOrFail()

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

findByEntity()

Find documents by entity type and ID

public findByEntity(SelectQuery $query, array<string|int, mixed> $options) : SelectQuery
Parameters
$query : SelectQuery

Query object

$options : array<string|int, mixed>

Options including 'entity_type' and 'entity_id'

Return values
SelectQuery

findOrCreate()

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

get()

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

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, Document>
Parameters
$data : array<string|int, mixed>
$options : array<string|int, mixed> = = '[]'
Return values
array<string|int, Document>

newEntity()

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

patchEntities()

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

patchEntity()

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

save()

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

saveMany()

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

saveManyOrFail()

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

saveOrFail()

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

validationDefault()

Default validation rules.

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

Validator instance.

Return values
Validator 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results