A17\Twill\Models\Block

class Block extends Model (View source)

Traits

HasMedias

HasFiles

HasPresenter

HasRelated

Properties

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

Methods

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 $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 $browser_name)

Returns the related items for a browser field.

from HasRelated

Collection

loadRelated(string $browser_name)

Eager load related items for a browser field.

from HasRelated

void

saveRelated(array $items, string $browser_name)

Attach items to the model for a browser field.

from HasRelated

void

clearRelated($browserName)

No description

from HasRelated

void

clearAllRelated()

No description

from HasRelated

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

No description

blockable()

No description

children()

No description

input($name)

No description

translatedInput($name, $forceLocale = null)

No description

browserIds($name)

No description

checkbox($name)

No description

getPresenterAttribute()

No description

getTable()

No description

Details

in HasMedias at line 20
`static void bootHasMedias()`

No description

Return Value

void

in HasMedias at line 35
`MorphToMany medias()`

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

Return Value

MorphToMany

in HasMedias at line 81
`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 99
`string|null image(string $role, string $crop = "default", array $params = [], bool $has_fallback = false, bool $cms = false, Media|null $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	$media	Provide a media object if you already retrieved one to prevent more SQL queries.

Return Value

string|null

in HasMedias at line 133
`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 155
`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 180
`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 208
`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 230
`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 253
`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 279
`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 305
`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 333
`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 349
`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

in HasMedias at line 374
`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 399
`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 410
`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 428
`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 51
`$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 29
`Collection getRelated(string $browser_name)`

Returns the related items for a browser field.

Parameters

string

$browser_name

Return Value

Collection

in HasRelated at line 44
`Collection loadRelated(string $browser_name)`

Eager load related items for a browser field.

Parameters

string

$browser_name

Return Value

Collection

in HasRelated at line 70
`void saveRelated(array $items, string $browser_name)`

Attach items to the model for a browser field.

Parameters

array	$items
string	$browser_name

Return Value

void

in HasRelated at line 91
`void clearRelated($browserName)`

No description

Parameters

$browserName

Return Value

void

in HasRelated at line 100
`void clearAllRelated()`

No description

Return Value

void

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

No description

Parameters

	$query
	$name

at line 41
`blockable()`

No description

at line 46
`children()`

No description

at line 55
`input($name)`

No description

Parameters

$name

at line 60
`translatedInput($name, $forceLocale = null)`

No description

Parameters

	$name
	$forceLocale

at line 73
`browserIds($name)`

No description

Parameters

$name

at line 78
`checkbox($name)`

No description

Parameters

$name

at line 83
`getPresenterAttribute()`

No description

at line 92
`getTable()`

No description

Block

Traits

Properties

Methods

Details

in HasMedias at line 20 static void bootHasMedias()

Return Value

in HasMedias at line 35 MorphToMany medias()

Return Value

in HasMedias at line 81 bool hasImage(string $role, string $crop = "default")

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

See also

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

in HasMedias at line 428 Collection imageObjects(string $role, string $crop = "default")

Parameters

Return Value

in HasFiles at line 15 MorphToMany files()

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

in HasPresenter at line 29 object presentAdmin()

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

in HasMedias at line 20
`static void bootHasMedias()`

in HasMedias at line 35
`MorphToMany medias()`

in HasMedias at line 81
`bool hasImage(string $role, string $crop = "default")`

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

in HasMedias at line 133
`array images(string $role, string $crop = "default", array $params = [])`

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

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

in HasMedias at line 208
`array imagesAsArrays(string $role, string $crop = "default", array $params = [])`

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

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

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

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

in HasMedias at line 333
`Media|null imageObject(string $role, string $crop = "default")`

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

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

in HasMedias at line 399
`string cmsImage(string $role, string $crop = "default", array $params = [])`

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

in HasMedias at line 428
`Collection imageObjects(string $role, string $crop = "default")`

in HasFiles at line 15
`MorphToMany files()`

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

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

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

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

in HasPresenter at line 29
`object presentAdmin()`

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

in HasPresenter at line 51
`$this setPresenterAdmin(string $presenter)`

in HasRelated at line 18
`MorphMany relatedItems()`

in HasRelated at line 29
`Collection getRelated(string $browser_name)`

in HasRelated at line 44
`Collection loadRelated(string $browser_name)`

in HasRelated at line 70
`void saveRelated(array $items, string $browser_name)`

in HasRelated at line 91
`void clearRelated($browserName)`

in HasRelated at line 100
`void clearAllRelated()`

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

at line 41
`blockable()`

at line 46
`children()`

at line 55
`input($name)`

at line 60
`translatedInput($name, $forceLocale = null)`

at line 73
`browserIds($name)`

at line 78
`checkbox($name)`

at line 83
`getPresenterAttribute()`

at line 92
`getTable()`