1. class
  2. A17
  3. \
  4. Twill
  5. \
  6. Repositories
  7. \
  8. ModuleRepository

ModuleRepository

abstract class ModuleRepository (View source)

Traits

HandleDates
HandleBrowsers
HandleRelatedBrowsers

Mimic HandleBrowsers, but when the relation uses HasRelated instead of being a proper model relation.

HandleRepeaters
HandleFieldsGroups
HandlePermissions

Properties

protected array $browsers

All browsers used in the model, as an array of browser names: [ 'books', 'publications' ].

 from  HandleBrowsers
protected string|array|(array)|mix|(string|array)) $relatedBrowsers

All related browsers used in the model, as an array of browser names: [ 'books', 'publications' ].

 from  HandleRelatedBrowsers
protected array $repeaters

All repeaters used in the model, as an array of repeater names: [ 'article_repeater', 'page_repeater' ].

 from  HandleRepeaters
protected TwillModelContract $model
protected string[] $ignoreFieldsBeforeSave
protected array $countScope
protected array $fieldsGroups
bool $fieldsGroupsFormFieldNamesAutoPrefix
string $fieldsGroupsFormFieldNameSeparator

Methods

array
prepareFieldsBeforeCreateHandleDates(array $fields)

No description

from  HandleDates
array
prepareFieldsBeforeSaveHandleDates(TwillModelContract|null $object, array $fields)

No description

from  HandleDates
array
prepareDatesField(array $fields, string $field)

No description

from  HandleDates
void
afterSaveHandleBrowsers(Model $object, array $fields)

No description

from  HandleBrowsers
array
getFormFieldsHandleBrowsers(Model $object, array $fields)

No description

from  HandleBrowsers
void
updateBrowser(TwillModelContract $object, array $fields, string $relationship, string $positionAttribute = 'position', string|null $browserName = null, array $pivotAttributes = [])

No description

from  HandleBrowsers
void
updateOrderedBelongsTomany(Model $object, array $fields, string $relationship, string $positionAttribute = 'position')

No description

from  HandleBrowsers
void
updateRelatedBrowser(Model $object, array $fields, string $browserName)

No description

from  HandleBrowsers
array
getFormFieldsForBrowser(TwillModelContract $object, string $relation, string|null $routePrefix = null, string $titleKey = 'title', string|null $moduleName = null)

No description

from  HandleBrowsers
array
getFormFieldsForRelatedBrowser(Model $object, string $relation, $titleKey = 'title')

No description

from  HandleBrowsers
Collection
getBrowsers()

Get all browser' detail info from the $browsers attribute.

from  HandleBrowsers
string
inferRelationFromBrowserName(string $browserName)

Guess the browser's relation name (shoud be lower camel case, ex. userGroup, contactOffice).

from  HandleBrowsers
string
inferModelFromModuleName(string $moduleName)

Guess the module's model name (should be singular upper camel case, ex. User, ArticleType).

from  HandleBrowsers
string
inferModuleNameFromBrowserName(string $browserName)

Guess the browser's module name (should be plural lower camel case, ex. userGroups, contactOffices).

from  HandleBrowsers
void
afterSaveHandleRelatedBrowsers(Model $object, array $fields)

No description

from  HandleRelatedBrowsers
array
getFormFieldsHandleRelatedBrowsers(Model $object, array $fields)

No description

from  HandleRelatedBrowsers
Collection
getRelatedBrowsers()

Get all related browser' detail info from the $relatedBrowsers attribute.

from  HandleRelatedBrowsers
void
afterDuplicateHandleRelatedBrowsers(TwillModelContract $old, TwillModelContract $new)

Called from afterReplicate in ModuleRepository.

from  HandleRelatedBrowsers
void
afterSaveHandleRepeaters(TwillModelContract $object, array $fields)

No description

from  HandleRepeaters
array
getFormFieldsHandleRepeaters(TwillModelContract $object, array $fields)

No description

from  HandleRepeaters
void
updateRepeaterMany(TwillModelContract $object, array $fields, string $relation, bool $keepExisting = true, string|null $model = null) deprecated

No description

from  HandleRepeaters
void
updateRepeaterMorphMany(TwillModelContract $object, array $fields, string $relation, string|null $morph = null, string|null $model = null, string|null $repeaterName = null)

No description

from  HandleRepeaters
void
updateRepeaterWithPivot(TwillModelContract $object, array $fields, string $relation, array $pivotFields, string|null $modelOrRepository = null, string|null $repeaterName = null)

No description

from  HandleRepeaters
void
updateRepeater(TwillModelContract $object, array $fields, string $relation, ModuleRepository $modelOrRepository = null, string|null $repeaterName = null)

Given relation, model and repeaterName, retrieve the repeater data from request and update the database record.

from  HandleRepeaters
array
getFormFieldForRepeaterWithPivot(TwillModelContract $object, array $fields, string $relation, array $pivotFields, ModuleRepository $modelOrRepository = null, string|null $repeaterName = null)

No description

from  HandleRepeaters
array
getFormFieldsForRepeater(TwillModelContract $object, array $fields, string $relation, ModuleRepository $modelOrRepository = null, string|null $repeaterName = null)

Given relation, model and repeaterName, get the necessary fields for rendering a repeater.

from  HandleRepeaters
Collection
getRepeaters()

Get all repeaters' model and relation from the $repeaters attribute.

from  HandleRepeaters
string
inferRelationFromRepeaterName(string $repeaterName)

Guess the relation name (should be lower camel case, ex. userGroup, contactOffice).

from  HandleRepeaters
string
inferModelFromRepeaterName(string $repeaterName)

Guess the model name (should be singular upper camel case, ex. User, ArticleType).

from  HandleRepeaters
Model
hydrateHandleFieldsGroups(Model $object, array|null $fields)

No description

from  HandleFieldsGroups
array
prepareFieldsBeforeSaveHandleFieldsGroups(Model|null $object, array $fields)

No description

from  HandleFieldsGroups
array
prepareFieldsBeforeCreateHandleFieldsGroups(array $fields)

No description

from  HandleFieldsGroups
array
getFormFieldsHandleFieldsGroups(Model $object, array $fields)

No description

from  HandleFieldsGroups
handleFieldsGroups($fields)

No description

from  HandleFieldsGroups
array
getModelCasts(Model $object)

No description

from  HandleFieldsGroups
array
getFormFieldsHandlePermissions(TwillModelContract $object, array $fields)

Retrieve user-item permissions fields

from  HandlePermissions
afterSaveHandlePermissions(Model $object, array $fields)

Function executed after save on module form

from  HandlePermissions
Collection
get(array $with = [], array $scopes = [], array $orders = [], int $perPage = 20, bool $forcePagination = false, array $appliedFilters = [])

No description

int
getCountByStatusSlug(string $slug, array $scope = [])

No description

TwillModelContract
getById(int $id, array $with = [], array $withCount = [])

No description

Collection
listAll(string $column = 'title', array $orders = [], int|string|null $exceptId = null, string $pluckBy = 'id')

No description

Collection
cmsSearch(string $search, array $fields = [])

No description

TwillModelContract
firstOrCreate(array $attributes, array $fields = [])

No description

TwillModelContract
create(array $fields)

No description

TwillModelContract
createForPreview(array $fields)

No description

TwillModelContract
updateOrCreate(array $attributes, array $fields)

No description

TwillModelContract
update(int|string $id, array $fields)

No description

bool
updateBasic(int|string|null|array $id, array $values, array $scopes = [])

No description

void
setNewOrder(array $ids)

No description

TwillModelContract|null
duplicate(int|string $id, string $titleColumnKey = 'title')

No description

bool
delete(int|string $id)

No description

bool
bulkDelete(array $ids)

No description

bool
forceDelete(int|string $id)

No description

bool
bulkForceDelete(array $ids)

No description

bool
restore(int|string $id)

No description

bool
bulkRestore(array $ids)

No description

array
cleanupFields(TwillModelContract|null $object, array $fields)

No description

array
prepareFieldsBeforeCreate(array $fields)

No description

array
prepareFieldsBeforeSave(TwillModelContract $object, array $fields)

No description

void
afterUpdateBasic(TwillModelContract $object, array $fields)

No description

void
beforeSave(TwillModelContract $object, array $fields)

No description

void
afterSaveOriginalData(TwillModelContract $model, array $fields)

No description

void
afterSave(TwillModelContract $model, array $fields)

No description

void
afterDelete(TwillModelContract $object)

No description

void
afterDuplicate(TwillModelContract $old, TwillModelContract $new)

No description

void
afterRestore(TwillModelContract $object)

No description

TwillModelContract
hydrate(TwillModelContract $model, array $fields)

No description

array
getFormFields(TwillModelContract $object)

No description

Builder
filter(Builder $query, array $scopes = [])

No description

Builder
order(Builder $builder, array $orders = [])

No description

void
updateOneToMany(TwillModelContract $object, array $fields, string $relationship, string $formField, string $attribute)

No description

void
updateMultiSelect(TwillModelContract $object, array $fields, string $relationship)

No description

void
addRelationFilterScope(Builder $query, array $scopes, string $scopeField, string $scopeRelation)

No description

void
addLikeFilterScope(Builder $query, array $scopes, string $scopeField)

No description

bool
isUniqueFeature()

No description

void
addIgnoreFieldsBeforeSave(array $ignore = [])

No description

bool
shouldIgnoreFieldBeforeSave(string $ignore)

No description

array
getReservedFields()

No description

ModuleRepository
getModelRepository(string $relation, ModuleRepository|null $modelOrRepository = null)

No description

array
traitsMethods(string|null $method = null)

No description

string
getLikeOperator() deprecated

No description

mixed
__call(string $method, array $parameters)

No description

bool
hasBehavior(string $behavior)

No description

bool
isTranslatable($column)

No description

TwillModelContract
getBaseModel()

No description

Details

in HandleDates at line 10
array prepareFieldsBeforeCreateHandleDates(array $fields)

No description

Parameters

array $fields

Return Value

array

in HandleDates at line 15
array prepareFieldsBeforeSaveHandleDates(TwillModelContract|null $object, array $fields)

No description

Parameters

TwillModelContract|null $object
array $fields

Return Value

array

in HandleDates at line 30
array prepareDatesField(array $fields, string $field)

No description

Parameters

array $fields
string $field

Return Value

array

in HandleBrowsers at line 42
void afterSaveHandleBrowsers(Model $object, array $fields)

No description

Parameters

Model $object
array $fields

Return Value

void

in HandleBrowsers at line 60
array getFormFieldsHandleBrowsers(Model $object, array $fields)

No description

Parameters

Model $object
array $fields

Return Value

array

in HandleBrowsers at line 87
void updateBrowser(TwillModelContract $object, array $fields, string $relationship, string $positionAttribute = 'position', string|null $browserName = null, array $pivotAttributes = [])

No description

Parameters

TwillModelContract $object
array $fields
string $relationship
string $positionAttribute
string|null $browserName
array $pivotAttributes

Return Value

void

in HandleBrowsers at line 158
void updateOrderedBelongsTomany(Model $object, array $fields, string $relationship, string $positionAttribute = 'position')

No description

Parameters

Model $object
array $fields
string $relationship
string $positionAttribute

Return Value

void

in HandleBrowsers at line 169
void updateRelatedBrowser(Model $object, array $fields, string $browserName)

No description

Parameters

Model $object
array $fields
string $browserName

Return Value

void

in HandleBrowsers at line 182
array getFormFieldsForBrowser(TwillModelContract $object, string $relation, string|null $routePrefix = null, string $titleKey = 'title', string|null $moduleName = null)

No description

Parameters

TwillModelContract $object
string $relation
string|null $routePrefix
string $titleKey
string|null $moduleName

Return Value

array

in HandleBrowsers at line 226
array getFormFieldsForRelatedBrowser(Model $object, string $relation, $titleKey = 'title')

No description

Parameters

Model $object
string $relation
$titleKey

Return Value

array

in HandleBrowsers at line 249
protected Collection getBrowsers()

Get all browser' detail info from the $browsers attribute.

The missing information will be inferred by convention of Twill.

Return Value

Collection

in HandleBrowsers at line 274
protected string inferRelationFromBrowserName(string $browserName)

Guess the browser's relation name (shoud be lower camel case, ex. userGroup, contactOffice).

Parameters

string $browserName

Return Value

string

in HandleBrowsers at line 282
protected string inferModelFromModuleName(string $moduleName)

Guess the module's model name (should be singular upper camel case, ex. User, ArticleType).

Parameters

string $moduleName

Return Value

string

in HandleBrowsers at line 290
protected string inferModuleNameFromBrowserName(string $browserName)

Guess the browser's module name (should be plural lower camel case, ex. userGroups, contactOffices).

Parameters

string $browserName

Return Value

string

in HandleRelatedBrowsers at line 43
void afterSaveHandleRelatedBrowsers(Model $object, array $fields)

No description

Parameters

Model $object
array $fields

Return Value

void

in HandleRelatedBrowsers at line 55
array getFormFieldsHandleRelatedBrowsers(Model $object, array $fields)

No description

Parameters

Model $object
array $fields

Return Value

array

in HandleRelatedBrowsers at line 74
protected Collection getRelatedBrowsers()

Get all related browser' detail info from the $relatedBrowsers attribute.

The missing information will be inferred by convention of Twill.

Return Value

Collection

in HandleRelatedBrowsers at line 96
void afterDuplicateHandleRelatedBrowsers(TwillModelContract $old, TwillModelContract $new)

Called from afterReplicate in ModuleRepository.

Parameters

TwillModelContract $old
TwillModelContract $new

Return Value

void

in HandleRepeaters at line 39
void afterSaveHandleRepeaters(TwillModelContract $object, array $fields)

No description

Parameters

TwillModelContract $object
array $fields

Return Value

void

in HandleRepeaters at line 52
array getFormFieldsHandleRepeaters(TwillModelContract $object, array $fields)

No description

Parameters

TwillModelContract $object
array $fields

Return Value

array

in HandleRepeaters at line 70
void updateRepeaterMany(TwillModelContract $object, array $fields, string $relation, bool $keepExisting = true, string|null $model = null) deprecated

deprecated use updateRepeaterWithPivot

No description

Parameters

TwillModelContract $object
array $fields
string $relation
bool $keepExisting
string|null $model

Return Value

void

in HandleRepeaters at line 92
void updateRepeaterMorphMany(TwillModelContract $object, array $fields, string $relation, string|null $morph = null, string|null $model = null, string|null $repeaterName = null)

No description

Parameters

TwillModelContract $object
array $fields
string $relation
string|null $morph
string|null $model
string|null $repeaterName

Return Value

void

in HandleRepeaters at line 156
void updateRepeaterWithPivot(TwillModelContract $object, array $fields, string $relation, array $pivotFields, string|null $modelOrRepository = null, string|null $repeaterName = null)

No description

Parameters

TwillModelContract $object
array $fields
string $relation
array $pivotFields
string|null $modelOrRepository
string|null $repeaterName

Return Value

void

in HandleRepeaters at line 268
void updateRepeater(TwillModelContract $object, array $fields, string $relation, ModuleRepository $modelOrRepository = null, string|null $repeaterName = null)

Given relation, model and repeaterName, retrieve the repeater data from request and update the database record.

Parameters

TwillModelContract $object
array $fields
string $relation
ModuleRepository $modelOrRepository
string|null $repeaterName

Return Value

void

in HandleRepeaters at line 364
array getFormFieldForRepeaterWithPivot(TwillModelContract $object, array $fields, string $relation, array $pivotFields, ModuleRepository $modelOrRepository = null, string|null $repeaterName = null)

No description

Parameters

TwillModelContract $object
array $fields
string $relation
array $pivotFields
ModuleRepository $modelOrRepository
string|null $repeaterName

Return Value

array

in HandleRepeaters at line 518
array getFormFieldsForRepeater(TwillModelContract $object, array $fields, string $relation, ModuleRepository $modelOrRepository = null, string|null $repeaterName = null)

Given relation, model and repeaterName, get the necessary fields for rendering a repeater.

Parameters

TwillModelContract $object
array $fields
string $relation
ModuleRepository $modelOrRepository
string|null $repeaterName

Return Value

array

in HandleRepeaters at line 671
protected Collection getRepeaters()

Get all repeaters' model and relation from the $repeaters attribute.

The missing information will be inferred by convention of Twill.

Return Value

Collection

in HandleRepeaters at line 691
protected string inferRelationFromRepeaterName(string $repeaterName)

Guess the relation name (should be lower camel case, ex. userGroup, contactOffice).

Parameters

string $repeaterName

Return Value

string

in HandleRepeaters at line 699
protected string inferModelFromRepeaterName(string $repeaterName)

Guess the model name (should be singular upper camel case, ex. User, ArticleType).

Parameters

string $repeaterName

Return Value

string

in HandleFieldsGroups at line 15
Model hydrateHandleFieldsGroups(Model $object, array|null $fields)

No description

Parameters

Model $object
array|null $fields

Return Value

Model

in HandleFieldsGroups at line 34
array prepareFieldsBeforeSaveHandleFieldsGroups(Model|null $object, array $fields)

No description

Parameters

Model|null $object
array $fields

Return Value

array

in HandleFieldsGroups at line 43
array prepareFieldsBeforeCreateHandleFieldsGroups(array $fields)

No description

Parameters

array $fields

Return Value

array

in HandleFieldsGroups at line 53
array getFormFieldsHandleFieldsGroups(Model $object, array $fields)

No description

Parameters

Model $object
array $fields

Return Value

array

in HandleFieldsGroups at line 85
protected handleFieldsGroups($fields)

No description

Parameters

$fields

in HandleFieldsGroups at line 132
protected array getModelCasts(Model $object)

No description

Parameters

Model $object

Return Value

array

in HandlePermissions at line 21
array getFormFieldsHandlePermissions(TwillModelContract $object, array $fields)

Retrieve user-item permissions fields

Parameters

TwillModelContract $object
array $fields

Return Value

array

in HandlePermissions at line 105
afterSaveHandlePermissions(Model $object, array $fields)

Function executed after save on module form

Parameters

Model $object
array $fields

at line 55
Collection get(array $with = [], array $scopes = [], array $orders = [], int $perPage = 20, bool $forcePagination = false, array $appliedFilters = [])

No description

Parameters

array $with
array $scopes
array $orders
int $perPage
bool $forcePagination
array $appliedFilters

Return Value

Collection

at line 83
int getCountByStatusSlug(string $slug, array $scope = [])

No description

Parameters

string $slug
array $scope

Return Value

int

at line 120
TwillModelContract getById(int $id, array $with = [], array $withCount = [])

No description

Parameters

int $id
array $with
array $withCount

Return Value

TwillModelContract

Exceptions

ModelNotFoundException

at line 130
Collection listAll(string $column = 'title', array $orders = [], int|string|null $exceptId = null, string $pluckBy = 'id')

No description

Parameters

string $column
array $orders
int|string|null $exceptId
string $pluckBy

Return Value

Collection

at line 155
Collection cmsSearch(string $search, array $fields = [])

No description

Parameters

string $search
array $fields

Return Value

Collection

at line 172
TwillModelContract firstOrCreate(array $attributes, array $fields = [])

No description

Parameters

array $attributes
array $fields

Return Value

TwillModelContract

at line 177
TwillModelContract create(array $fields)

No description

Parameters

array $fields

Return Value

TwillModelContract

at line 202
TwillModelContract createForPreview(array $fields)

No description

Parameters

array $fields

Return Value

TwillModelContract

at line 211
TwillModelContract updateOrCreate(array $attributes, array $fields)

No description

Parameters

array $attributes
array $fields

Return Value

TwillModelContract

at line 224
TwillModelContract update(int|string $id, array $fields)

No description

Parameters

int|string $id
array $fields

Return Value

TwillModelContract

at line 247
bool updateBasic(int|string|null|array $id, array $values, array $scopes = [])

No description

Parameters

int|string|null|array $id
array $values
array $scopes

Return Value

bool

at line 291
void setNewOrder(array $ids)

No description

Parameters

array $ids

Return Value

void

at line 298
TwillModelContract|null duplicate(int|string $id, string $titleColumnKey = 'title')

No description

Parameters

int|string $id
string $titleColumnKey

Return Value

TwillModelContract|null

at line 320
bool delete(int|string $id)

No description

Parameters

int|string $id

Return Value

bool

at line 336
bool bulkDelete(array $ids)

No description

Parameters

array $ids

Return Value

bool

at line 356
bool forceDelete(int|string $id)

No description

Parameters

int|string $id

Return Value

bool

at line 370
bool bulkForceDelete(array $ids)

No description

Parameters

array $ids

Return Value

bool

at line 392
bool restore(int|string $id)

No description

Parameters

int|string $id

Return Value

bool

at line 406
bool bulkRestore(array $ids)

No description

Parameters

array $ids

Return Value

bool

at line 428
array cleanupFields(TwillModelContract|null $object, array $fields)

No description

Parameters

TwillModelContract|null $object
array $fields

Return Value

array

at line 464
array prepareFieldsBeforeCreate(array $fields)

No description

Parameters

array $fields

Return Value

array

at line 478
array prepareFieldsBeforeSave(TwillModelContract $object, array $fields)

No description

Parameters

TwillModelContract $object
array $fields

Return Value

array

at line 489
void afterUpdateBasic(TwillModelContract $object, array $fields)

No description

Parameters

TwillModelContract $object
array $fields

Return Value

void

at line 496
void beforeSave(TwillModelContract $object, array $fields)

No description

Parameters

TwillModelContract $object
array $fields

Return Value

void

at line 503
void afterSaveOriginalData(TwillModelContract $model, array $fields)

No description

Parameters

TwillModelContract $model
array $fields

Return Value

void

at line 510
void afterSave(TwillModelContract $model, array $fields)

No description

Parameters

TwillModelContract $model
array $fields

Return Value

void

at line 517
void afterDelete(TwillModelContract $object)

No description

Parameters

TwillModelContract $object

Return Value

void

at line 524
void afterDuplicate(TwillModelContract $old, TwillModelContract $new)

No description

Parameters

TwillModelContract $old
TwillModelContract $new

Return Value

void

at line 531
void afterRestore(TwillModelContract $object)

No description

Parameters

TwillModelContract $object

Return Value

void

at line 538
TwillModelContract hydrate(TwillModelContract $model, array $fields)

No description

Parameters

TwillModelContract $model
array $fields

Return Value

TwillModelContract

at line 547
array getFormFields(TwillModelContract $object)

No description

Parameters

TwillModelContract $object

Return Value

array

at line 558
Builder filter(Builder $query, array $scopes = [])

No description

Parameters

Builder $query
array $scopes

Return Value

Builder

at line 594
Builder order(Builder $builder, array $orders = [])

No description

Parameters

Builder $builder
array $orders

Return Value

Builder

at line 612
void updateOneToMany(TwillModelContract $object, array $fields, string $relationship, string $formField, string $attribute)

No description

Parameters

TwillModelContract $object
array $fields
string $relationship
string $formField
string $attribute

Return Value

void

at line 634
void updateMultiSelect(TwillModelContract $object, array $fields, string $relationship)

No description

Parameters

TwillModelContract $object
array $fields
string $relationship

Return Value

void

at line 678
void addRelationFilterScope(Builder $query, array $scopes, string $scopeField, string $scopeRelation)

No description

Parameters

Builder $query
array $scopes
string $scopeField
string $scopeRelation

Return Value

void

at line 693
void addLikeFilterScope(Builder $query, array $scopes, string $scopeField)

No description

Parameters

Builder $query
array $scopes
string $scopeField

Return Value

void

at line 701
bool isUniqueFeature()

No description

Return Value

bool

at line 706
void addIgnoreFieldsBeforeSave(array $ignore = [])

No description

Parameters

array $ignore

Return Value

void

at line 713
bool shouldIgnoreFieldBeforeSave(string $ignore)

No description

Parameters

string $ignore

Return Value

bool

at line 721
array getReservedFields()

No description

Return Value

array

at line 731
protected ModuleRepository getModelRepository(string $relation, ModuleRepository|null $modelOrRepository = null)

No description

Parameters

string $relation
ModuleRepository|null $modelOrRepository

Return Value

ModuleRepository

at line 771
protected array traitsMethods(string|null $method = null)

No description

Parameters

string|null $method

Return Value

array

at line 791
protected string getLikeOperator() deprecated

deprecated use the helper getLikeOperator directly.

No description

Return Value

string

at line 796
mixed __call(string $method, array $parameters)

No description

Parameters

string $method
array $parameters

Return Value

mixed

at line 801
bool hasBehavior(string $behavior)

No description

Parameters

string $behavior

Return Value

bool

at line 812
bool isTranslatable($column)

No description

Parameters

$column

Return Value

bool

at line 817
TwillModelContract getBaseModel()

No description

Return Value

TwillModelContract