1. class
  2. Bolt
  3. \
  4. Entity
  5. \
  6. Content

Content

class Content (View source)

Traits

ContentLocalizeTrait
ContentExtrasTrait

Methods

Collection
getLocales()

No description

from  ContentLocalizeTrait
string
getDefaultLocale()

No description

from  ContentLocalizeTrait
void
setContentExtension(ContentExtension $contentExtension)

No description

from  ContentExtrasTrait
array
getExtras()

No description

from  ContentExtrasTrait
string
sanitise(string $string)

No description

from  ContentExtrasTrait
__construct(ContentType|null $contentTypeDefinition = null)

No description

string
__toString()

No description

void
setId(int|null $id = null)

No description

int|null
getId()

No description

void
setDefinitionFromContentTypesConfig(Collection $contentTypesConfig)

No description

void
setTwig(Environment $twig)

No description

Environment|null
getTwig()

No description

void
setDefinition(ContentType $contentType)

No description

ContentType|null
getDefinition()

No description

string|null
getSlug($locale = null)

No description

string|null
getContentType()

No description

void
setContentType(string $contentType)

No description

string
getContentTypeSlug()

No description

string
getContentTypeSingularSlug()

No description

string
getContentTypeName()

No description

string
getContentTypeSingularName()

No description

bool
hasContentTypeLocales()

No description

string
getContentTypeDefaultLocale()

No description

string|null
getIcon()

No description

User|null
getAuthor()

No description

void
setAuthor(User|null $author)

No description

string
getStatus()

No description

Content
setStatus(string $status)

No description

DateTime|null
getCreatedAt()

No description

Content
setCreatedAt(DateTime|null $createdAt)

No description

DateTime|null
getModifiedAt()

No description

Content
setModifiedAt(DateTime|null $modifiedAt)

No description

void
updateModifiedAt()

No description

DateTime|null
getPublishedAt()

No description

Content
setPublishedAt(DateTime|null $publishedAt)

No description

DateTime|null
getDepublishedAt()

No description

Content
setDepublishedAt(DateTime|null $depublishedAt)

No description

Collection
getRawFields()

No description

Collection
getFields()

No description

array
getFieldValues()

No description

array
getTaxonomyValues()

No description

array|mixed|null
getFieldValue(string $fieldName)

No description

void
setFieldValue(string $fieldName, $value, string|null $locale = null)

No description

Field
getField(string $fieldName)

No description

bool
hasField(string $fieldName, $matchTypes = false)

No description

bool
hasFieldDefined(string $fieldName)

No description

Content
addField(Field $field)

No description

void
addFieldByName(string $fieldName)

No description

Content
removeField(Field $field)

No description

string|null
getAuthorName()

No description

array
getStatuses()

No description

bool
hasTaxonomyDefined(string $taxonomyName)

No description

Collection
getTaxonomies(string|null $type = null)

No description

Content
addTaxonomy(Taxonomy $taxonomy)

No description

Content
removeTaxonomy(Taxonomy $taxonomy)

No description

__call(string $name, array $arguments = [])

Generic getter for a record fields. Will return the field with $name.

array
toArray()

No description

Details

in ContentLocalizeTrait at line 14
Collection getLocales()

Return Value

Collection

in ContentLocalizeTrait at line 25
string getDefaultLocale()

Return Value

string

in ContentExtrasTrait at line 18
void setContentExtension(ContentExtension $contentExtension)

Parameters

ContentExtension $contentExtension

Return Value

void

in ContentExtrasTrait at line 28
array getExtras()

Return Value

array

in ContentExtrasTrait at line 49
string sanitise(string $string)

Parameters

string $string

Return Value

string

at line 142
__construct(ContentType|null $contentTypeDefinition = null)

Parameters

ContentType|null $contentTypeDefinition

at line 156
string __toString()

Return Value

string

at line 166
void setId(int|null $id = null)

Parameters

int|null $id

Return Value

void

at line 171
int|null getId()

Return Value

int|null

at line 179
void setDefinitionFromContentTypesConfig(Collection $contentTypesConfig)

Parameters

Collection $contentTypesConfig

Return Value

void

See also

ContentFillListener

at line 202
void setTwig(Environment $twig)

Parameters

Environment $twig

Return Value

void

at line 207
Environment|null getTwig()

Return Value

Environment|null

at line 212
void setDefinition(ContentType $contentType)

Parameters

ContentType $contentType

Return Value

void

at line 220
ContentType|null getDefinition()

Return Value

ContentType|null

at line 225
string|null getSlug($locale = null)

Parameters

$locale

Return Value

string|null

at line 252
string|null getContentType()

Return Value

string|null

at line 257
void setContentType(string $contentType)

Parameters

string $contentType

Return Value

void

at line 262
string getContentTypeSlug()

Return Value

string

at line 271
string getContentTypeSingularSlug()

Return Value

string

at line 280
string getContentTypeName()

Return Value

string

at line 289
string getContentTypeSingularName()

Return Value

string

at line 298
bool hasContentTypeLocales()

Return Value

bool

at line 307
string getContentTypeDefaultLocale()

Return Value

string

at line 320
string|null getIcon()

Return Value

string|null

at line 329
User|null getAuthor()

Return Value

User|null

at line 334
void setAuthor(User|null $author)

Parameters

User|null $author

Return Value

void

at line 339
string getStatus()

Return Value

string

at line 348
Content setStatus(string $status)

Parameters

string $status

Return Value

Content

at line 357
DateTime|null getCreatedAt()

Return Value

DateTime|null

at line 362
Content setCreatedAt(DateTime|null $createdAt)

Parameters

DateTime|null $createdAt

Return Value

Content

at line 369
DateTime|null getModifiedAt()

Return Value

DateTime|null

at line 374
Content setModifiedAt(DateTime|null $modifiedAt)

Parameters

DateTime|null $modifiedAt

Return Value

Content

at line 385
void updateModifiedAt()

Return Value

void

at line 390
DateTime|null getPublishedAt()

Return Value

DateTime|null

at line 395
Content setPublishedAt(DateTime|null $publishedAt)

Parameters

DateTime|null $publishedAt

Return Value

Content

at line 402
DateTime|null getDepublishedAt()

Return Value

DateTime|null

at line 407
Content setDepublishedAt(DateTime|null $depublishedAt)

Parameters

DateTime|null $depublishedAt

Return Value

Content

at line 417
Collection getRawFields()

Return Value

Collection

at line 425
Collection getFields()

Return Value

Collection

at line 433
array getFieldValues()

Return Value

array

at line 451
array getTaxonomyValues()

Return Value

array

at line 467
array|mixed|null getFieldValue(string $fieldName)

Parameters

string $fieldName

Return Value

array|mixed|null

at line 476
void setFieldValue(string $fieldName, $value, string|null $locale = null)

Parameters

string $fieldName
$value
string|null $locale

Return Value

void

at line 491
Field getField(string $fieldName)

Parameters

string $fieldName

Return Value

Field

at line 500
bool hasField(string $fieldName, $matchTypes = false)

Parameters

string $fieldName
$matchTypes

Return Value

bool

at line 521
bool hasFieldDefined(string $fieldName)

Parameters

string $fieldName

Return Value

bool

at line 526
Content addField(Field $field)

Parameters

Field $field

Return Value

Content

at line 538
void addFieldByName(string $fieldName)

Parameters

string $fieldName

Return Value

void

at line 551
Content removeField(Field $field)

Parameters

Field $field

Return Value

Content

at line 566
string|null getAuthorName()

Return Value

string|null

at line 575
array getStatuses()

Return Value

array

at line 580
bool hasTaxonomyDefined(string $taxonomyName)

Parameters

string $taxonomyName

Return Value

bool

at line 588
Collection getTaxonomies(string|null $type = null)

Parameters

string|null $type

Return Value

Collection

at line 601
Content addTaxonomy(Taxonomy $taxonomy)

Parameters

Taxonomy $taxonomy

Return Value

Content

at line 611
Content removeTaxonomy(Taxonomy $taxonomy)

Parameters

Taxonomy $taxonomy

Return Value

Content

at line 637
__call(string $name, array $arguments = [])

Generic getter for a record fields. Will return the field with $name.

If $name is not found, throw an exception if it's invoked from code, and return null if invoked from within a template. In templates we need to be more lenient, in order to do things like `{% if record.foo %}..{% endif %}

Note: We can not rely on {% if record.foo is defined %}, because it always returns true for object properties. See: https://craftcms.stackexchange.com/questions/2116/twig-is-defined-always-returning-true

  • {{ record.title }} => field named title
  • {{ record|title }} => value of guessed title field
  • {{ record.image }} => field named image
  • {{ record|image }} => value of guessed image field

Parameters

string $name
array $arguments

at line 700
array toArray()

Return Value

array