PHP Class VersionPress\ChangeInfos\EntityChangeInfo

An entity is a database-tracked object that usually has a VPID (but not alwasy, see e.g. options). Derived ChangeInfos have these things in common: - The VP-Action tag value has the form of "entityName/action/entityId", e.g. "post/create/8F805A77ABC9485BA3F114E3E251E5FD" or "option/edit/blogname". Most commonly, the entityId is VPID. - Subclasses usually provide a set of VP tags to store additional info to commits, usually in the form of "VP-EntityType-Something: value", e.g. "VP-Post-Title: Hello world". These tags are used when the commit is read later and human-friendly message is rendered in the UI.

Inheritance: extends TrackedChangeInfo

Mostrar archivo Open project: versionpress/versionpress Class Usage Examples

Public Methods

Method	Description
__construct ( EntityInfo $entityInfo, ActionsInfo $actionsInfo, string $action, string $entityId, array $customTags = [], array $customFiles = [] )
getChangedFiles ( )
getParentId ( ) : string \| null	Used by meta-entity storages as a performance optimalization.
getScope ( )

Method Details

__construct() public method

public __construct ( EntityInfo $entityInfo, ActionsInfo $actionsInfo, string $action, string $entityId, array $customTags = [], array $customFiles = [] )
$entityInfo	VersionPress\Database\EntityInfo
$actionsInfo	VersionPress\Actions\ActionsInfo
$action	string
$entityId	string
$customTags	array
$customFiles	array

getChangedFiles() public method

public getChangedFiles ( )

getParentId() public method

For example EntityChangeInfo representing change in postmeta returns VPID of the related post.

public getParentId ( ) : string \| null
return	string \| null

getScope() public method

public getScope ( )