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

Setting

class Setting extends Model (View source)

Traits

HasTranslation
HasMedias
Translatable
HasPresenter
SoftDeletes
TaggableTrait
IsTranslatable

Properties

protected $presenterInstance from  HasPresenter
$translatedAttributes
$timestamps from  Model
protected $cropParamsKeys from  HasMedias
$useTranslationFallback
protected $fillable

Methods

object
present(string $presenter = 'presenter')

No description

from  HasPresenter
object
presentAdmin()

No description

from  HasPresenter
$this
setPresenter(string $presenter, string $presenterProperty = 'presenter')

No description

from  HasPresenter
$this
setPresenterAdmin(string $presenter)

No description

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

Checks if this model is translatable.

from  IsTranslatable
bool
isTranslationModel()

No description

from  Model
Builder
scopePublished(Builder $query)

No description

from  Model
Builder
scopeAccessible(Builder $query)

No description

from  Model
Builder
scopePublishedInListings(Builder $query)

No description

from  Model
Builder
scopeVisible(Builder $query)

No description

from  Model
void
setPublishStartDateAttribute($value)

No description

from  Model
Builder
scopeDraft(Builder $query)

No description

from  Model
Builder
scopeOnlyTrashed(Builder $query)

No description

from  Model
array
getFillable()

No description

from  Model
array
getTranslatedAttributes()

No description

from  Model
static void
bootTaggableTrait()

No description

from  Model
MorphToMany
tags()

No description

from  Model
string
getFullUrl()

This method should return the full url. By default this will be based on the controller slug or urlWithoutSlug. But it can be overwritten in order to fully customize the link.

from  Model
getTranslationModelNameDefault()

No description

Builder
scopeWithActiveTranslations(Builder $query, string|null $locale = null)

No description

from  HasTranslation
Builder
scopeOrderByTranslation(Builder $query, string $orderField, string $orderType = 'ASC', string|null $locale = null)

No description

from  HasTranslation
Builder
scopeOrderByRawByTranslation(Builder $query, string $orderRawString, string $groupByField, string|null $locale = null)

No description

from  HasTranslation
bool
hasActiveTranslation(string|null $locale = null)

Checks if this model has active translations.

from  HasTranslation
Collection
getActiveLanguages()

No description

from  HasTranslation
Collection
translatedAttribute(string $key)

Returns all translations for a given attribute.

from  HasTranslation
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
getTable()

No description

string
getTranslationRelationKey()

No description

Details

in HasPresenter at line 13
object present(string $presenter = 'presenter')

No description

Parameters

string $presenter

Return Value

object

in HasPresenter at line 29
object presentAdmin()

No description

Return Value

object

in HasPresenter at line 39
$this setPresenter(string $presenter, string $presenterProperty = 'presenter')

No description

Parameters

string $presenter
string $presenterProperty

Return Value

$this

in HasPresenter at line 52
$this setPresenterAdmin(string $presenter)

No description

Parameters

string $presenter

Return Value

$this

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 Model at line 31
protected bool isTranslationModel()

No description

Return Value

bool

in Model at line 36
Builder scopePublished(Builder $query)

No description

Parameters

Builder $query

Return Value

Builder

in Model at line 41
Builder scopeAccessible(Builder $query)

No description

Parameters

Builder $query

Return Value

Builder

in Model at line 78
Builder scopePublishedInListings(Builder $query)

No description

Parameters

Builder $query

Return Value

Builder

in Model at line 91
Builder scopeVisible(Builder $query)

No description

Parameters

Builder $query

Return Value

Builder

in Model at line 116
void setPublishStartDateAttribute($value)

No description

Parameters

$value

Return Value

void

in Model at line 121
Builder scopeDraft(Builder $query)

No description

Parameters

Builder $query

Return Value

Builder

in Model at line 126
Builder scopeOnlyTrashed(Builder $query)

No description

Parameters

Builder $query

Return Value

Builder

in Model at line 131
array getFillable()

No description

Return Value

array

in Model at line 159
array getTranslatedAttributes()

No description

Return Value

array

in Model at line 166
static protected void bootTaggableTrait()

No description

Return Value

void

in Model at line 174
MorphToMany tags()

No description

Return Value

MorphToMany

in Model at line 185
string getFullUrl()

This method should return the full url. By default this will be based on the controller slug or urlWithoutSlug. But it can be overwritten in order to fully customize the link.

This link is used by for example TwillUtil::parseInternalLinks

Return Value

string

at line 26
getTranslationModelNameDefault()

No description

in HasTranslation at line 32
Builder scopeWithActiveTranslations(Builder $query, string|null $locale = null)

No description

Parameters

Builder $query
string|null $locale

Return Value

Builder

in HasTranslation at line 66
Builder scopeOrderByTranslation(Builder $query, string $orderField, string $orderType = 'ASC', string|null $locale = null)

No description

Parameters

Builder $query
string $orderField
string $orderType
string|null $locale

Return Value

Builder

in HasTranslation at line 93
Builder scopeOrderByRawByTranslation(Builder $query, string $orderRawString, string $groupByField, string|null $locale = null)

No description

Parameters

Builder $query
string $orderRawString
string $groupByField
string|null $locale

Return Value

Builder

in HasTranslation at line 114
bool hasActiveTranslation(string|null $locale = null)

Checks if this model has active translations.

Parameters

string|null $locale

Return Value

bool

in HasTranslation at line 132
Collection getActiveLanguages()

No description

Return Value

Collection

in HasTranslation at line 152
Collection translatedAttribute(string $key)

Returns all translations for a given attribute.

Parameters

string $key

Return Value

Collection

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

at line 31
getTable()

No description

at line 36
protected string getTranslationRelationKey()

No description

Return Value

string