\TriTan\Common\SiteSiteMapper

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\Site\TriTan\Common\Site\Site|null

Fetch a site object by ID

Parameters

string $id

Returns

\TriTan\Common\Site\TriTan\Common\Site\Site|null —

Returns site object if exist and NULL otherwise.

findBy()

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

Return only the main site fields.

Parameters

string $field

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

string|integer $value

The field value

Returns

object|false —

Raw site object

findAll()

findAll() 

create()

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

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

Parameters

array $data

Returns

\TriTan\Common\Site\TriTan\Common\Site\Site.

populate()

populate(\TriTan\Common\Site\Site  $site, array  $data) : \TriTan\Common\Site\TriTan\Common\Site\Site

Populate the Site object with the data array.

Parameters

\TriTan\Common\Site\Site $site

object.

array $data

Site data.

Returns

\TriTan\Common\Site\TriTan\Common\Site\Site

insert()

insert(\TriTan\Common\Site\Site  $site) : integer

Inserts a new site into the site document.

Parameters

\TriTan\Common\Site\Site $site

Site object.

Returns

integer —

Last insert id.

update()

update(\TriTan\Common\Site\Site  $site) : \TriTan\Common\Site\Site's

Updates a Site object.

Parameters

\TriTan\Common\Site\Site $site

Site object.

Returns

\TriTan\Common\Site\Site's —

id.

save()

save(\TriTan\Common\Site\Site  $site) 

Save the Site object.

Parameters

\TriTan\Common\Site\Site $site

Site object.

delete()

delete(\TriTan\Common\Site\Site  $site) : boolean

Deletes site object.

Parameters

\TriTan\Common\Site\Site $site

Site object.

Returns

boolean —

True if deleted, false otherwise.

__create()

__create() : \TriTan\Common\Site\TriTan\Common\Site\Site

Create a new Site object.

Returns

\TriTan\Common\Site\TriTan\Common\Site\Site