Documentation

UsersTable extends Table
in package

Users Model

Tags
mixin

Table of Contents

Properties

$Comments  : CommentsTable|HasMany
$FavoritePlaces  : FavoritePlacesTable|HasMany
$Favorites  : FavoritesTable|HasMany
$Friendships  : FriendshipsTable|HasMany
$Histories  : HistoriesTable|HasMany
$NotificationPreferences  : NotificationPreferencesTable|HasOne
$PointsOfInterests  : PointsOfInterestsTable|HasMany
$Roadtrips  : RoadtripsTable|HasMany
$UserTokens  : UserTokensTable|HasMany

Methods

beforeSave()  : void
CallBack beforeSave Handles the profile picture upload before saving the user to the database.
buildRules()  : RulesChecker
Returns a rules checker object that will be used for validating application integrity.
deleteMany()  : iterable<string|int, User>|ResultSetInterface<string|int, User>|false
deleteManyOrFail()  : iterable<string|int, User>|ResultSetInterface<string|int, User>
findOrCreate()  : User
get()  : User
initialize()  : void
Initialize method
newEmptyEntity()  : User
newEntities()  : array<string|int, User>
newEntity()  : User
patchEntities()  : array<string|int, User>
patchEntity()  : User
save()  : User|false
saveMany()  : iterable<string|int, User>|ResultSetInterface<string|int, User>|false
saveManyOrFail()  : iterable<string|int, User>|ResultSetInterface<string|int, User>
saveOrFail()  : User
validationDefault()  : Validator
Default validation rules.

Properties

$UserTokens

public UserTokensTable|HasMany $UserTokens

Methods

beforeSave()

CallBack beforeSave Handles the profile picture upload before saving the user to the database.

public beforeSave(EventInterface $event, EntityInterface $entity, ArrayObject $options) : void
Parameters
$event : EventInterface
$entity : EntityInterface
$options : ArrayObject

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

deleteManyOrFail()

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

findOrCreate()

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

get()

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

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

newEntity()

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

patchEntities()

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

patchEntity()

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

save()

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

saveMany()

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

saveManyOrFail()

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

saveOrFail()

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

validationDefault()

Default validation rules.

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

Validator instance.

Return values
Validator 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results