Documentation

File extends AbstractAdapter
in package

Auditor file class

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

Copyright (c) 2009-2024 NOLA Interactive, LLC. (http://www.nolainteractive.com)

license

http://www.popphp.org/license New BSD License

version
2.0.0

Table of Contents

Constants

CREATED  = 'created'
Constants for action states
DELETED  = 'deleted'
UPDATED  = 'updated'

Properties

$action  : string|null
Action (created, updated, deleted)
$domain  : string|null
Domain
$folder  : string|null
Folder to store the audit results
$metadata  : array<string|int, mixed>
Metadata
$method  : string|null
Method
$model  : string|null
Model name
$modelId  : int|string|null
Model ID
$modified  : array<string|int, mixed>
Modified model state differences
$original  : array<string|int, mixed>
Original model state differences
$prefix  : string
File prefix
$route  : string|null
Route
$stateData  : array<string|int, mixed>
Final state data
$userId  : int|string|null
User ID
$username  : string|null
Username

Methods

__construct()  : mixed
Constructor
addMetadata()  : AbstractAdapter
Add to the metadata
decode()  : array<string|int, mixed>|false|null
Decode the audit file
getAction()  : string|null
Get the action
getDomain()  : string|null
Get the domain
getFolder()  : string
Get the folder
getId()  : string
Get ID from filename
getMetadata()  : mixed
Get the metadata
getMethod()  : string|null
Get the method
getModel()  : string|null
Get the model name
getModelId()  : int|string|null
Get the model ID
getModified()  : array<string|int, mixed>
Get the modified model state differences
getOriginal()  : array<string|int, mixed>
Get the original model state differences
getPrefix()  : string
Get the prefix
getRoute()  : string|null
Get the route
getSnapshot()  : array<string|int, mixed>
Get model snapshot by ID
getStateByDate()  : array<string|int, mixed>
Get model state by date
getStateById()  : array<string|int, mixed>
Get model state by ID
getStateByModel()  : array<string|int, mixed>
Get model state by model
getStateByTimestamp()  : array<string|int, mixed>
Get model state by timestamp
getStateData()  : mixed
Get the final state
getStates()  : array<string|int, mixed>
Get model states
getUserId()  : int|string|null
Get the user ID
getUsername()  : string|null
Get the username
hasDiff()  : bool
Check if the model states are different
hasMetadata()  : bool
Determine if there is metadata
hasStateData()  : bool
Determine if there is final state data
prepareData()  : array<string|int, mixed>
Prepare data
resolveDiff()  : AbstractAdapter
Resolve the differences in values between the model states
send()  : string
Send the results of the audit
setDiff()  : AbstractAdapter
Set the differences in values between the model states (that have already been processed)
setDomain()  : AbstractAdapter
Set the domain
setMetadata()  : AbstractAdapter
Set the metadata
setMethod()  : AbstractAdapter
Set the method
setModel()  : AbstractAdapter
Set the model name
setModelId()  : AbstractAdapter
Set the model ID
setRoute()  : AbstractAdapter
Set the route
setStateData()  : AbstractAdapter
Set the final state data
setUserId()  : AbstractAdapter
Set the user ID
setUsername()  : AbstractAdapter
Set the username

Constants

Properties

$action

Action (created, updated, deleted)

protected string|null $action = null

$folder

Folder to store the audit results

protected string|null $folder = null

$metadata

Metadata

protected array<string|int, mixed> $metadata = []

$modified

Modified model state differences

protected array<string|int, mixed> $modified = []

$original

Original model state differences

protected array<string|int, mixed> $original = []

$prefix

File prefix

protected string $prefix = 'pop-audit-'

$stateData

Final state data

protected array<string|int, mixed> $stateData = []

Methods

__construct()

Constructor

public __construct(string $folder[, string $prefix = 'pop-audit-' ]) : mixed

Instantiate the file adapter object

Parameters
$folder : string
$prefix : string = 'pop-audit-'
Tags
throws
Exception

decode()

Decode the audit file

public decode(string $filename) : array<string|int, mixed>|false|null
Parameters
$filename : string
Tags
throws
Exception
Return values
array<string|int, mixed>|false|null

getAction()

Get the action

public getAction() : string|null
Return values
string|null

getDomain()

Get the domain

public getDomain() : string|null
Return values
string|null

getFolder()

Get the folder

public getFolder() : string
Return values
string

getId()

Get ID from filename

public getId(string $filename) : string
Parameters
$filename : string
Return values
string

getMetadata()

Get the metadata

public getMetadata([string|null $name = null ]) : mixed
Parameters
$name : string|null = null

getMethod()

Get the method

public getMethod() : string|null
Return values
string|null

getModel()

Get the model name

public getModel() : string|null
Return values
string|null

getModelId()

Get the model ID

public getModelId() : int|string|null
Return values
int|string|null

getModified()

Get the modified model state differences

public getModified() : array<string|int, mixed>
Return values
array<string|int, mixed>

getOriginal()

Get the original model state differences

public getOriginal() : array<string|int, mixed>
Return values
array<string|int, mixed>

getPrefix()

Get the prefix

public getPrefix() : string
Return values
string

getRoute()

Get the route

public getRoute() : string|null
Return values
string|null

getSnapshot()

Get model snapshot by ID

public getSnapshot(int|string $id[, bool $post = false ]) : array<string|int, mixed>
Parameters
$id : int|string
$post : bool = false
Return values
array<string|int, mixed>

getStateByDate()

Get model state by date

public getStateByDate(string $from[, string|null $backTo = null ]) : array<string|int, mixed>
Parameters
$from : string
$backTo : string|null = null
Return values
array<string|int, mixed>

getStateById()

Get model state by ID

public getStateById(int|string $id) : array<string|int, mixed>
Parameters
$id : int|string
Return values
array<string|int, mixed>

getStateByModel()

Get model state by model

public getStateByModel(string $model[, int|string|null $modelId = null ]) : array<string|int, mixed>
Parameters
$model : string
$modelId : int|string|null = null
Tags
throws
Exception
Return values
array<string|int, mixed>

getStateByTimestamp()

Get model state by timestamp

public getStateByTimestamp(string $from[, string|null $backTo = null ]) : array<string|int, mixed>
Parameters
$from : string
$backTo : string|null = null
Return values
array<string|int, mixed>

getStateData()

Get the final state

public getStateData([string|null $name = null ]) : mixed
Parameters
$name : string|null = null

getStates()

Get model states

public getStates([string $sort = 'DESC' ][, int|null $limit = null ][, int|null $offset = null ]) : array<string|int, mixed>
Parameters
$sort : string = 'DESC'
$limit : int|null = null
$offset : int|null = null
Return values
array<string|int, mixed>

getUserId()

Get the user ID

public getUserId() : int|string|null
Return values
int|string|null

getUsername()

Get the username

public getUsername() : string|null
Return values
string|null

hasDiff()

Check if the model states are different

public hasDiff() : bool
Return values
bool

hasMetadata()

Determine if there is metadata

public hasMetadata([string|null $name = null ]) : bool
Parameters
$name : string|null = null
Return values
bool

hasStateData()

Determine if there is final state data

public hasStateData([string|null $name = null ]) : bool
Parameters
$name : string|null = null
Return values
bool

prepareData()

Prepare data

public prepareData([bool $jsonEncode = true ]) : array<string|int, mixed>
Parameters
$jsonEncode : bool = true
Return values
array<string|int, mixed>

resolveDiff()

Resolve the differences in values between the model states

public resolveDiff([array<string|int, mixed> $old = [] ][, array<string|int, mixed> $new = [] ][, bool $state = true ]) : AbstractAdapter
Parameters
$old : array<string|int, mixed> = []
$new : array<string|int, mixed> = []
$state : bool = true
Return values
AbstractAdapter

send()

Send the results of the audit

public send() : string
Tags
throws
Exception
Return values
string

setDiff()

Set the differences in values between the model states (that have already been processed)

public setDiff([array<string|int, mixed> $old = [] ][, array<string|int, mixed> $new = [] ]) : AbstractAdapter
Parameters
$old : array<string|int, mixed> = []
$new : array<string|int, mixed> = []
Return values
AbstractAdapter 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results