1. class
  2. A17
  3. \
  4. Twill
  5. \
  6. Models
  7. \
  8. Role

Role

class Role extends Model implements Sortable, TwillModelContract (View source)

Traits

HasMedias
SoftDeletes
HasPermissions
IsTranslatable
HasPosition

Properties

protected $cropParamsKeys from  HasMedias
$translatedAttributes from  IsTranslatable
$timestamps
protected $fillable
$checkboxes
protected $casts

Methods

array
getMediasParams()

No description

from  HasMedias
static void
bootHasMedias()

No description

from  HasMedias
MorphToMany
medias()

Defines the many-to-many relationship for media objects.

from  HasMedias
bool
hasImage(string $role, string $crop = 'default')

Checks if an image has been attached for a role and crop.

from  HasMedias
string|null
image(string $role, string $crop = 'default', array $params = [], bool $has_fallback = false, bool $cms = false, Media|null|bool $media = null)

Returns the URL of the attached image for a role and crop.

from  HasMedias
array
images(string $role, string $crop = 'default', array $params = [])

Returns an array of URLs of all attached images for a role and crop.

from  HasMedias
array
imagesWithCrops(string $role, array $params = [])

Returns an array of URLs of all attached images for a role, including all crops.

from  HasMedias
array
imageAsArray(string $role, string $crop = 'default', array $params = [], Media|null $media = null)

Returns an array of meta information for the image attached for a role and crop.

from  HasMedias
array
imagesAsArrays(string $role, string $crop = 'default', array $params = [])

Returns an array of meta information for all images attached for a role and crop.

from  HasMedias
array
imagesAsArraysWithCrops(string $role, array $params = [])

Returns an array of meta information for all images attached for a role, including all crops.

from  HasMedias
string
imageAltText(string $role, Media|null $media = null)

Returns the alt text of the image attached for a role.

from  HasMedias
string
imageCaption(string $role, Media|null $media = null)

Returns the caption of the image attached for a role.

from  HasMedias
string
imageVideo(string $role, Media|null $media = null)

Returns the video URL of the image attached for a role.

from  HasMedias
Media|null
imageObject(string $role, string $crop = 'default')

Returns the media object attached for a role and crop.

from  HasMedias
string|null
lowQualityImagePlaceholder(string $role, string $crop = 'default', array $params = [], bool $has_fallback = false)

Returns the LQIP base64 encoded string for a role.

from  HasMedias
string|null
socialImage(string $role, string $crop = 'default', array $params = [], bool $has_fallback = false)

Returns the URL of the social image for a role and crop.

from  HasMedias
string
cmsImage(string $role, string $crop = 'default', array $params = [])

Returns the URL of the CMS image for a role and crop.

from  HasMedias
string
defaultCmsImage(array $params = [])

Returns the URL of the default CMS image for this model.

from  HasMedias
Collection
imageObjects(string $role, string $crop = 'default')

Returns the media objects associated with a role and crop.

from  HasMedias
BelongsToMany
permissions()

This method should be clean of checks, the checks should happen earlier on.

from  HasPermissions
void
grantGlobalPermission(string $name)

Add global permission to item, after making sure the permission is valid

from  HasPermissions
void
revokeGlobalPermission(string $name)

Revoke global permission from the item, after making sure the permission is valid

from  HasPermissions
void
grantModulePermission(string $name, string|object $permissionableType)

Add module permission to item, after making sure the permission is valid

from  HasPermissions
void
revokeModulePermission(string $name, string|object $permissionableType)

Revoke module permission from the item, after making sure the permission is valid

from  HasPermissions
void
revokeAllModulePermission(string|object $permissionableType)

Revoke all module permissions from the item

from  HasPermissions
void
grantModuleItemPermission(string $name, object $permissionableItem)

Add module item permission, after making sure the permission is valid

from  HasPermissions
void
revokeModuleItemPermission(string $name, object $permissionableItem)

Revoke module item permissions, after making sure the permission is valid

from  HasPermissions
void
revokeModuleItemAllPermissions(object $permissionableItem)

Revoke all module item permissions

from  HasPermissions
void
revokeAllPermissions()

Revoke all permissions

from  HasPermissions
void
removePermissions(int[] $permissionableIds)

Revoke all permissions from a list of permission ids

from  HasPermissions
void
checkPermissionAvailable(string $name, string $scope)

Check if a permission is available for a particular scope

from  HasPermissions
bool
isTranslatable(null|array|string $columns = null)

Checks if this model is translatable.

from  IsTranslatable
static 
bootHasPosition()

No description

from  HasPosition
setToLastPosition()

No description

from  HasPosition
getCurrentLastPosition()

No description

from  HasPosition
Builder
scopeOrdered(Builder $query)

No description

from  HasPosition
static void
setNewOrder(array $ids, int $startOrder = 1)

No description

from  HasPosition
__construct(array $attributes = [])

No description

Builder
scopeAccessible(Builder $query)

No description

Builder
scopePublished(Builder $query)

No description

Builder
scopeDraft(Builder $query)

No description

Builder
scopeOnlyTrashed(Builder $query)

No description

HasMany
users()

No description

string
getCreatedAtAttribute($value)

No description

string
getUsersCountAttribute($value)

Return the formatted number of users in this group

Collection
getAccessibleRolesAttribute()

Return the roles that are considered accessible for this role

array
getTranslatedAttributes()

No description

Details

in HasMedias at line 19
array getMediasParams()

No description

Return Value

array

in HasMedias at line 26
static void bootHasMedias()

No description

Return Value

void

in HasMedias at line 41
MorphToMany medias()

Defines the many-to-many relationship for media objects.

Return Value

MorphToMany

in HasMedias at line 87
bool hasImage(string $role, string $crop = 'default')

Checks if an image has been attached for a role and crop.

Parameters

string $role

Role name.
string $crop

Crop name.

Return Value

bool

in HasMedias at line 105
string|null image(string $role, string $crop = 'default', array $params = [], bool $has_fallback = false, bool $cms = false, Media|null|bool $media = null)

Returns the URL of the attached image for a role and crop.

Parameters

string $role

Role name.
string $crop

Crop name.
array $params

Parameters compatible with the current image service, like w or h.
bool $has_fallback

Indicate that you can provide a fallback. Will return null instead of the default image fallback.
bool $cms

Indicate that you are displaying this image in the CMS views.
Media|null|bool $media

Provide a media object if you already retrieved one to prevent more SQL queries.

Return Value

string|null

in HasMedias at line 142
array images(string $role, string $crop = 'default', array $params = [])

Returns an array of URLs of all attached images for a role and crop.

Parameters

string $role

Role name.
string $crop

Crop name.
array $params

Parameters compatible with the current image service, like w or h.

Return Value

array

in HasMedias at line 164
array imagesWithCrops(string $role, array $params = [])

Returns an array of URLs of all attached images for a role, including all crops.

Parameters

string $role

Role name.
array $params

Parameters compatible with the current image service, like w or h.

Return Value

array

in HasMedias at line 196
array imageAsArray(string $role, string $crop = 'default', array $params = [], Media|null $media = null)

Returns an array of meta information for the image attached for a role and crop.

Parameters

string $role

Role name.
string $crop

Crop name.
array $params

Parameters compatible with the current image service, like w or h.
Media|null $media

Provide a media object if you already retrieved one to prevent more SQL queries.

Return Value

array

in HasMedias at line 224
array imagesAsArrays(string $role, string $crop = 'default', array $params = [])

Returns an array of meta information for all images attached for a role and crop.

Parameters

string $role

Role name.
string $crop

Crop name.
array $params

Parameters compatible with the current image service, like w or h.

Return Value

array

in HasMedias at line 246
array imagesAsArraysWithCrops(string $role, array $params = [])

Returns an array of meta information for all images attached for a role, including all crops.

Parameters

string $role

Role name.
array $params

Parameters compatible with the current image service, like w or h.

Return Value

array

in HasMedias at line 274
string imageAltText(string $role, Media|null $media = null)

Returns the alt text of the image attached for a role.

Parameters

string $role

Role name.
Media|null $media

Provide a media object if you already retrieved one to prevent more SQL queries.

Return Value

string

in HasMedias at line 300
string imageCaption(string $role, Media|null $media = null)

Returns the caption of the image attached for a role.

Parameters

string $role

Role name.
Media|null $media

Provide a media object if you already retrieved one to prevent more SQL queries.

Return Value

string

in HasMedias at line 326
string imageVideo(string $role, Media|null $media = null)

Returns the video URL of the image attached for a role.

Parameters

string $role

Role name.
Media|null $media

Provide a media object if you already retrieved one to prevent more SQL queries.

Return Value

string

in HasMedias at line 355
Media|null imageObject(string $role, string $crop = 'default')

Returns the media object attached for a role and crop.

Parameters

string $role

Role name.
string $crop

Crop name.

Return Value

Media|null

in HasMedias at line 371
string|null lowQualityImagePlaceholder(string $role, string $crop = 'default', array $params = [], bool $has_fallback = false)

Returns the LQIP base64 encoded string for a role.

Use this in conjunction with the RefreshLQIP Artisan command.

Parameters

string $role

Role name.
string $crop

Crop name.
array $params

Parameters compatible with the current image service, like w or h.
bool $has_fallback

Indicate that you can provide a fallback. Will return null instead of the default image fallback.

Return Value

string|null

See also

RefreshLQIP

in HasMedias at line 395
string|null socialImage(string $role, string $crop = 'default', array $params = [], bool $has_fallback = false)

Returns the URL of the social image for a role and crop.

Parameters

string $role

Role name.
string $crop

Crop name.
array $params

Parameters compatible with the current image service, like w or h.
bool $has_fallback

Indicate that you can provide a fallback. Will return null instead of the default image fallback.

Return Value

string|null

in HasMedias at line 420
string cmsImage(string $role, string $crop = 'default', array $params = [])

Returns the URL of the CMS image for a role and crop.

Parameters

string $role

Role name.
string $crop

Crop name.
array $params

Parameters compatible with the current image service, like w or h.

Return Value

string

in HasMedias at line 431
string defaultCmsImage(array $params = [])

Returns the URL of the default CMS image for this model.

Parameters

array $params

Parameters compatible with the current image service, like w or h.

Return Value

string

in HasMedias at line 449
Collection imageObjects(string $role, string $crop = 'default')

Returns the media objects associated with a role and crop.

Parameters

string $role

Role name.
string $crop

Crop name.

Return Value

Collection

in HasPermissions at line 16
BelongsToMany permissions()

This method should be clean of checks, the checks should happen earlier on.

Return Value

BelongsToMany

in HasPermissions at line 38
void grantGlobalPermission(string $name)

Add global permission to item, after making sure the permission is valid

Parameters

string $name

Return Value

void

in HasPermissions at line 57
void revokeGlobalPermission(string $name)

Revoke global permission from the item, after making sure the permission is valid

Parameters

string $name

Return Value

void

in HasPermissions at line 72
void grantModulePermission(string $name, string|object $permissionableType)

Add module permission to item, after making sure the permission is valid

Parameters

string $name
string|object $permissionableType

Return Value

void

in HasPermissions at line 92
void revokeModulePermission(string $name, string|object $permissionableType)

Revoke module permission from the item, after making sure the permission is valid

Parameters

string $name
string|object $permissionableType

Return Value

void

in HasPermissions at line 107
void revokeAllModulePermission(string|object $permissionableType)

Revoke all module permissions from the item

Parameters

string|object $permissionableType

Return Value

void

in HasPermissions at line 122
void grantModuleItemPermission(string $name, object $permissionableItem)

Add module item permission, after making sure the permission is valid

Parameters

string $name
object $permissionableItem

Return Value

void

in HasPermissions at line 147
void revokeModuleItemPermission(string $name, object $permissionableItem)

Revoke module item permissions, after making sure the permission is valid

Parameters

string $name
object $permissionableItem

Return Value

void

in HasPermissions at line 163
void revokeModuleItemAllPermissions(object $permissionableItem)

Revoke all module item permissions

Parameters

object $permissionableItem

Return Value

void

in HasPermissions at line 174
void revokeAllPermissions()

Revoke all permissions

Return Value

void

in HasPermissions at line 185
void removePermissions(int[] $permissionableIds)

Revoke all permissions from a list of permission ids

Parameters

int[] $permissionableIds

Return Value

void

in HasPermissions at line 203
protected void checkPermissionAvailable(string $name, string $scope)

Check if a permission is available for a particular scope

Parameters

string $name
string $scope

Return Value

void

See also

Permission::SCOPE_GLOBAL
Permission::SCOPE_MODULE
Permission::SCOPE_ITEM

in IsTranslatable at line 17
bool isTranslatable(null|array|string $columns = null)

Checks if this model is translatable.

If no columns/column is provided it will return true if the model itself is translatable.

Parameters

null|array|string $columns

Return Value

bool

in HasPosition at line 7
static protected bootHasPosition()

No description

in HasPosition at line 14
protected setToLastPosition()

No description

in HasPosition at line 19
protected getCurrentLastPosition()

No description

in HasPosition at line 28
Builder scopeOrdered(Builder $query)

No description

Parameters

Builder $query

Return Value

Builder

in HasPosition at line 38
static void setNewOrder(array $ids, int $startOrder = 1)

No description

Parameters

array $ids
int $startOrder

Return Value

void

at line 41
__construct(array $attributes = [])

No description

Parameters

array $attributes

at line 47
Builder scopeAccessible(Builder $query)

No description

Parameters

Builder $query

Return Value

Builder

at line 60
Builder scopePublished(Builder $query)

No description

Parameters

Builder $query

Return Value

Builder

at line 65
Builder scopeDraft(Builder $query)

No description

Parameters

Builder $query

Return Value

Builder

at line 70
Builder scopeOnlyTrashed(Builder $query)

No description

Parameters

Builder $query

Return Value

Builder

at line 75
HasMany users()

No description

Return Value

HasMany

at line 80
string getCreatedAtAttribute($value)

No description

Parameters

$value

Return Value

string

at line 88
string getUsersCountAttribute($value)

Return the formatted number of users in this group

Parameters

$value

Return Value

string

at line 96
Collection getAccessibleRolesAttribute()

Return the roles that are considered accessible for this role

Return Value

Collection

at line 101
array getTranslatedAttributes()

No description

Return Value

array