Craft Activity (2.x)

UserLocked extends UserLog
in package

Table of Contents

$changedFields  : array<string|int, mixed>
$data  : array<string|int, mixed>
$dateCreated  : DateTime
$id  : int
$ip  : string
$request  : string
$site_id  : int
$site_name  : string
$target_class  : string
$target_name  : string
$target_uid  : string
$user_id  : int
$user_name  : string
$_element  : Element
$_site  : Site
$_user  : User
getDescription()  : string
Description getter
getElement()  : Element|null
getElementSiteName()  : string
Get the site name the element was modified in
getElementTitle()  : string
Get element title
getHandle()  : string
Handle getter
getName()  : string
Name getter
getRequestName()  : string
Request name getter
getSite()  : Site|null
Site getter
getSiteName()  : string
Site name getter
getTitle()  : string
getUser()  : User|null
User getter
getUserName()  : string
User name getter
save()  : bool
Save this log in database
setAttempts()  : mixed
Attempts setter
setElement()  : mixed
Element setter
setSite()  : mixed
Site setter
setUser()  : mixed
User setter
_getTitle()  : string
Build the title from class name
getElementType()  : string
Get the element type (Asset, Entry etc)
getIncludeSiteNameInTitle()  : bool
Include the site name in the title
getTitleField()  : string
Get element title field name
loadElement()  : Element|null
Load the element

Properties

$changedFields

public array<string|int, mixed> $changedFields = []

Methods

getDescription()

Description getter

public getDescription() : string
Return values
string

getElement()

public getElement() : Element|null
Tags
inheritDoc
Return values
Element|null

getElementSiteName()

Get the site name the element was modified in

public getElementSiteName() : string
Return values
string

getElementTitle()

Get element title

public getElementTitle() : string
Return values
string

getHandle()

Handle getter

public getHandle() : string
Return values
string

getName()

Name getter

public getName() : string
Return values
string

getRequestName()

Request name getter

public getRequestName() : string
Tags
since
2.3.0
Return values
string

getSite()

Site getter

public getSite() : Site|null
Return values
Site|null

getSiteName()

Site name getter

public getSiteName() : string
Return values
string

getTitle()

public getTitle() : string
Tags
inheritDoc
Return values
string

getUser()

User getter

public getUser() : User|null
Return values
User|null

getUserName()

User name getter

public getUserName() : string
Return values
string

save()

Save this log in database

public save() : bool
Return values
bool

setAttempts()

Attempts setter

public setAttempts(int $attempts) : mixed
Parameters
$attempts : int
Return values
mixed

setElement()

Element setter

public setElement(Element $element) : mixed
Parameters
$element : Element
Return values
mixed

setSite()

Site setter

public setSite(Site $site) : mixed
Parameters
$site : Site
Return values
mixed

setUser()

User setter

public setUser(User|null $user) : mixed
Parameters
$user : User|null
Return values
mixed

_getTitle()

Build the title from class name

protected _getTitle() : string
Return values
string

getElementType()

Get the element type (Asset, Entry etc)

protected abstract getElementType() : string
Return values
string

getIncludeSiteNameInTitle()

Include the site name in the title

protected getIncludeSiteNameInTitle() : bool
Return values
bool

getTitleField()

Get element title field name

protected getTitleField() : string
Return values
string

loadElement()

Load the element

protected loadElement() : Element|null
Return values
Element|null

Search results