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

Block

class Block extends Model implements TwillModelContract (View source)

Traits

HasMedias
HasFiles
HasPresenter
HasRelated

Properties

protected $cropParamsKeys from  HasMedias
protected $presenterInstance from  HasPresenter
protected array $relatedCache from  HasRelated
$timestamps
protected $fillable
protected $casts
protected $with

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
MorphToMany
files()

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

from  HasFiles
string|null
file(string $role, string|null $locale = null, File|null $file = null)

Returns the URL of the attached file for a role.

from  HasFiles
array
filesList(string $role, string|null $locale = null)

Returns an array of URLs of all attached files for a role.

from  HasFiles
File|null
fileObject(string $role, string|null $locale = null)

Returns the file object attached for a role.

from  HasFiles
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
MorphMany
relatedItems()

Defines the one-to-many relationship for related items.

from  HasRelated
Collection
getRelated(string $browserName)

Returns the related items for a browser field.

from  HasRelated
mixed
getFirstRelated(string $browserName)

No description

from  HasRelated
Collection
loadRelated(string $browserName)

Eager load related items for a browser field.

from  HasRelated
void
saveRelated(Collection $items, string $browserName)

Attach items to the model for a browser field.

from  HasRelated
void
clearRelated(string $browserName)

No description

from  HasRelated
void
clearAllRelated()

No description

from  HasRelated
scopeEditor($query, $name = 'default')

No description

MorphTo
blockable()

No description

HasMany
children()

No description

string
wysiwyg(string $name)

No description

string
translatedWysiwyg(string $name)

No description

mixed
input(string $name)

No description

mixed
translatedInput(string $name, string $forceLocale = null)

No description

browserIds($name)

No description

checkbox($name)

No description

getPresenterAttribute()

No description

getTable()

No description

Builder
scopePublished(Builder $query)

No description

Builder
scopeAccessible(Builder $query)

No description

Builder
scopeOnlyTrashed(Builder $query)

No description

Builder
scopeDraft(Builder $query)

No description

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 HasFiles at line 15
MorphToMany files()

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

Return Value

MorphToMany

in HasFiles at line 50
string|null file(string $role, string|null $locale = null, File|null $file = null)

Returns the URL of the attached file for a role.

Parameters

string $role

Role name.
string|null $locale

Locale of the file if your site has multiple languages.
File|null $file

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

Return Value

string|null

in HasFiles at line 71
array filesList(string $role, string|null $locale = null)

Returns an array of URLs of all attached files for a role.

Parameters

string $role

Role name.
string|null $locale

Locale of the file if your site has multiple languages.

Return Value

array

in HasFiles at line 95
File|null fileObject(string $role, string|null $locale = null)

Returns the file object attached for a role.

Parameters

string $role

Role name.
string|null $locale

Locale of the file if your site has multiple languages.

Return Value

File|null

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 HasRelated at line 18
MorphMany relatedItems()

Defines the one-to-many relationship for related items.

Return Value

MorphMany

in HasRelated at line 26
Collection getRelated(string $browserName)

Returns the related items for a browser field.

Parameters

string $browserName

Return Value

Collection

in HasRelated at line 35
mixed getFirstRelated(string $browserName)

No description

Parameters

string $browserName

Return Value

mixed

in HasRelated at line 43
Collection loadRelated(string $browserName)

Eager load related items for a browser field.

Parameters

string $browserName

Return Value

Collection

in HasRelated at line 68
void saveRelated(Collection $items, string $browserName)

Attach items to the model for a browser field.

Parameters

Collection $items
string $browserName

Return Value

void

in HasRelated at line 107
void clearRelated(string $browserName)

No description

Parameters

string $browserName

Return Value

void

in HasRelated at line 116
void clearAllRelated()

No description

Return Value

void

at line 42
scopeEditor($query, $name = 'default')

No description

Parameters

$query
$name

at line 49
MorphTo blockable()

No description

Return Value

MorphTo

at line 54
HasMany children()

No description

Return Value

HasMany

at line 63
string wysiwyg(string $name)

No description

Parameters

string $name

Return Value

string

at line 68
string translatedWysiwyg(string $name)

No description

Parameters

string $name

Return Value

string

at line 73
mixed input(string $name)

No description

Parameters

string $name

Return Value

mixed

at line 78
mixed translatedInput(string $name, string $forceLocale = null)

No description

Parameters

string $name
string $forceLocale

Return Value

mixed

at line 94
browserIds($name)

No description

Parameters

$name

at line 99
checkbox($name)

No description

Parameters

$name

at line 104
getPresenterAttribute()

No description

at line 113
getTable()

No description

at line 118
Builder scopePublished(Builder $query)

No description

Parameters

Builder $query

Return Value

Builder

at line 124
Builder scopeAccessible(Builder $query)

No description

Parameters

Builder $query

Return Value

Builder

at line 130
Builder scopeOnlyTrashed(Builder $query)

No description

Parameters

Builder $query

Return Value

Builder

at line 136
Builder scopeDraft(Builder $query)

No description

Parameters

Builder $query

Return Value

Builder

at line 142
array getTranslatedAttributes()

No description

Return Value

array