\TriTan\Common\UserUserMapper

Summary

Methods
Properties
Constants
__construct()
findById()
findBy()
findAll()
create()
populate()
insert()
update()
save()
delete()
$db
$context
No constants found
__create()
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$db

$db : 

Type

$context

$context : 

Type

Methods

findById()

findById(string  $id) : \TriTan\Common\User\TriTan\Common\User\User|null

Fetch a user object by ID

Parameters

string $id

Returns

\TriTan\Common\User\TriTan\Common\User\User|null —

Returns user object if exist and NULL otherwise.

findBy()

findBy(string  $field, string|integer  $value) : object|false

Return only the main user fields.

Parameters

string $field

The field to query against: 'id', 'ID', 'email' or 'login'.

string|integer $value

The field value

Returns

object|false —

Raw user object

findAll()

findAll() : \TriTan\Common\User\User

Fetch all users.

Returns

\TriTan\Common\User\User

User data object.

create()

create(array  $data = null) : \TriTan\Common\User\TriTan\Common\User\User.

Create a new instance of User. Optionally populating it from a data array.

Parameters

array $data

Returns

\TriTan\Common\User\TriTan\Common\User\User.

populate()

populate(\TriTan\Common\User\User  $user, array  $data) : \TriTan\Common\User\TriTan\Common\User\User

Populate the User object with the data array.

Parameters

\TriTan\Common\User\User $user

object.

array $data

User data.

Returns

\TriTan\Common\User\TriTan\Common\User\User

insert()

insert(\TriTan\Common\User\User  $user) : integer

Inserts a new user into the user document.

Parameters

\TriTan\Common\User\User $user

User object.

Returns

integer —

Last insert id.

update()

update(\TriTan\Common\User\User  $user) : \TriTan\Common\User\The

Updates a User object.

Parameters

\TriTan\Common\User\User $user

User object.

Returns

\TriTan\Common\User\The —

user's id.

save()

save(\TriTan\Common\User\User  $user) 

Save the User object.

Parameters

\TriTan\Common\User\User $user

User object.

delete()

delete(\TriTan\Common\User\User  $user) : boolean

Deletes user object.

Parameters

\TriTan\Common\User\User $user

User object.

Returns

boolean —

True if deleted, false otherwise.

__create()

__create() : \TriTan\Common\User\TriTan\Common\User\User

Create a new User object.

Returns

\TriTan\Common\User\TriTan\Common\User\User