PHP Класс Venturecraft\Revisionable\Revision

Base model to allow for revision history on any model that extends this model (c) Venture Craft
Наследование: extends Illuminate\Database\Eloquent\Model
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$table string

Защищенные свойства (Protected)

Свойство Тип Описание
$revisionFormattedFields array

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

Метод Описание
__construct ( array $attributes = [] )
fieldName ( ) : string Field Name
format ( $key, $value ) : string Format the value according to the $revisionFormattedFields array.
historyOf ( ) : Object | false Returns the object we have the history of
newValue ( ) : string New Value.
oldValue ( ) : string Old Value.
revisionable ( ) : array Revisionable.
userResponsible ( ) : User User Responsible.

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

Метод Описание
formatFieldName ( $key ) : boolean Format field name.
getRelatedModel ( ) : string Return the name of the related model.
getValue ( string $which = 'new' ) : string Responsible for actually doing the grunt work for getting the old or new value for the revision.
isRelated ( ) : boolean Return true if the key is for a related model.

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

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

public __construct ( array $attributes = [] )
$attributes array

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

Returns the field that was updated, in the case that it's a foreign key denoted by a suffix of "_id", then "_id" is simply stripped
public fieldName ( ) : string
Результат string field

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

Format the value according to the $revisionFormattedFields array.
public format ( $key, $value ) : string
$key
$value
Результат string formatted value

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

Returns the object we have the history of
public historyOf ( ) : Object | false
Результат Object | false

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

Grab the new value of the field, if it was a foreign key attempt to get an identifying name for the model.
public newValue ( ) : string
Результат string old value

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

Grab the old value of the field, if it was a foreign key attempt to get an identifying name for the model.
public oldValue ( ) : string
Результат string old value

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

Grab the revision history for the model that is calling
public revisionable ( ) : array
Результат array revision history

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

User Responsible.
public userResponsible ( ) : User
Результат User user responsible for the change

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

$revisionFormattedFields защищенное свойство

protected array $revisionFormattedFields
Результат array

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

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