PHP Класс bedezign\yii2\audit\AuditTrailBehavior

Наследование: extends yii\base\Behavior

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$active	boolean	Is the behavior is active or not
$allowed	array	Array with fields to save You don't need to configure both allowed and ignored
$dateFormat	string	Date format to use in stamp - set to "Y-m-d H:i:s" for datetime or "U" for timestamp
$ignored	array	Array with fields to ignore You don't need to configure both allowed and ignored
$ignoredClasses	array	Array with classes to ignore
$override	array	Array with fields you want to override before saving the row into audit_trail table

Открытые методы

Метод	Описание
afterDelete ( )
afterFind ( )
afterInsert ( )
afterUpdate ( )
audit ( $action )
events ( )
getOldAttributes ( ) : array
setOldAttributes ( $value )

Защищенные методы

Метод	Описание
auditAttributes ( string $action )
cleanAttributes ( $attributes ) : mixed	Clean attributes of fields that are not allowed or ignored.
cleanAttributesAllowed ( $attributes ) : mixed	Unset attributes which are not allowed
cleanAttributesIgnored ( $attributes ) : mixed	Unset attributes which are ignored
cleanAttributesOverride ( $attributes ) : mixed	attributes which need to get override with a new value
getAuditEntryId ( ) : AuditEntry \| null \| static
getNormalizedPk ( ) : string
getUserId ( ) : integer \| null \| string
saveAuditTrail ( $action, $newAttributes, $oldAttributes, $entry_id, $user_id, $model, $model_id, $created )	Save the audit trails for a create or update action
saveAuditTrailDelete ( )	Save the audit trails for a delete action

Приватные методы

Метод	Описание
getNewOverrideValues ( string $searchFieldValue, string $queryParams ) : mixed

Описание методов

afterDelete() публичный Метод

public afterDelete ( )

afterFind() публичный Метод

public afterFind ( )

afterInsert() публичный Метод

public afterInsert ( )

afterUpdate() публичный Метод

public afterUpdate ( )

audit() публичный Метод

public audit ( $action )
$action

auditAttributes() защищенный Метод

protected auditAttributes ( string $action )
$action	string

cleanAttributes() защищенный Метод

Clean attributes of fields that are not allowed or ignored.

protected cleanAttributes ( $attributes ) : mixed
$attributes
Результат	mixed

cleanAttributesAllowed() защищенный Метод

Unset attributes which are not allowed

protected cleanAttributesAllowed ( $attributes ) : mixed
$attributes
Результат	mixed

cleanAttributesIgnored() защищенный Метод

Unset attributes which are ignored

protected cleanAttributesIgnored ( $attributes ) : mixed
$attributes
Результат	mixed

cleanAttributesOverride() защищенный Метод

attributes which need to get override with a new value

protected cleanAttributesOverride ( $attributes ) : mixed
$attributes
Результат	mixed

events() публичный Метод

public events ( )

getAuditEntryId() защищенный Метод

protected getAuditEntryId ( ) : AuditEntry \| null \| static
Результат	bedezign\yii2\audit\models\AuditEntry \| null \| static

getNormalizedPk() защищенный Метод

protected getNormalizedPk ( ) : string
Результат	string

getOldAttributes() публичный Метод

public getOldAttributes ( ) : array
Результат	array

getUserId() защищенный Метод

protected getUserId ( ) : integer \| null \| string
Результат	integer \| null \| string

saveAuditTrail() защищенный Метод

Save the audit trails for a create or update action

protected saveAuditTrail ( $action, $newAttributes, $oldAttributes, $entry_id, $user_id, $model, $model_id, $created )
$action
$newAttributes
$oldAttributes
$entry_id
$user_id
$model
$model_id
$created

saveAuditTrailDelete() защищенный Метод

Save the audit trails for a delete action

protected saveAuditTrailDelete ( )

setOldAttributes() публичный Метод

public setOldAttributes ( $value )
$value

Описание свойств

$active публичное свойство

Is the behavior is active or not

public bool $active
Результат	boolean

$allowed публичное свойство

Array with fields to save You don't need to configure both allowed and ignored

public array $allowed
Результат	array

$dateFormat публичное свойство

Date format to use in stamp - set to "Y-m-d H:i:s" for datetime or "U" for timestamp

public string $dateFormat
Результат	string

$ignored публичное свойство

Array with fields to ignore You don't need to configure both allowed and ignored

public array $ignored
Результат	array

$ignoredClasses публичное свойство

Array with classes to ignore

public array $ignoredClasses
Результат	array

$override публичное свойство

Array with fields you want to override before saving the row into audit_trail table

public array $override
Результат	array