Frontend | Backend | Api

Blogs\Models\Backend\Blog

Blog

Method Description Returns
getTotalPostsCount() Get the total number of posts.
In the backend, this is calculated on the fly based on user access permissions.
int
getTotalCommentsCount() Get the total number of comments.
In the backend, this is calculated on the fly based on user access permissions.
int
getText() Get the description for this blog. Also parses image and link placeholders in the process. string
getImageRootTargetFolderPath() Retrieves the root target folder path for uploaded images. string
getFullSlug() Get the full slug of the blog string
getFullPath() Get the full path for the blog including the module route string
getOriginalPath() Get the original path for the blog without custom urls applied string
getAreas() Collection
getAreaGroups() Gets the layout area groups Collection
getPostsByCategoryNames(array $names) Gets all posts of the current blog by given category names. It uses 'OR' condition for every passed value. Collection
getPostsByCategorySlugs(array $slugs) Gets all posts of the current blog by given category slugs. It uses 'OR' condition for every passed value. Collection
getPostsByTagNames(array $names) Gets all posts of the current blog by given tag names. It uses 'OR' condition for every passed value. Collection
getPostsByTagSlugs(array $slugs) Gets all posts of the current blog by given tag slugs. It uses 'OR' condition for every passed value. Collection
getAreaContent(string $areaName) Get the content of the layout area Content
getAreaDefaultContent(string $areaName) Get the default content of the layout area Content
getAreaContentOrDefault(string $areaName) Get the content of the layout area, or the default content if no content exists Content
getAreaAttributesContent(string $areaName) Gets the content of every layout area attribute. If layout area does not have attributes, returns empty array. array
getAreaAttributesDefaultContent(string $areaName) Gets the default content of every layout area attribute. If layout area does not have attributes, returns empty array. array
getAreaAttributesContentOrDefault(string $areaName) Gets the content (or the default content if no content exists) of every layout area attribute. If layout area does not have attributes, returns empty array. array
getEntityAreaByLayoutArea(LayoutArea $area) Get the link record between the layout area and content for the designated layout area Model
hasAreaWithName(string $areaName) Check if an area with the specified name exists for the container bool
getAreaType(string $areaName) Get the input type for the specified layout area. Returns null if the area with the specified name could not be found. InputType
getAreaCategory(string $areaName) Get the category for the specified layout area. Returns null if the area with the specified name could not be found. string
getAreaEditor(string $areaName) Get the editor for the specified layout area. Returns null if the area with the specified name could not be found. string
getAreaImage(string $areaName) Get the image for the layout area with the specified name Image
getAreaFile(string $areaName) Get the file for the layout area with the specified name File
getAreaRecord(string $areaName) Get the record for the layout area with the specified name Model
getAreaRecords(string $areaName) Get the records for the layout area with the specified name Collection
getAreaText(string $areaName) Get the text for the layout area with the specified name string
getAreaValues(string $areaName) Get the values for the layout area with the specified name array
getAreaDate(string $areaName) Get a date for the layout area with the specified name DateTime
getAreaWidget(string $areaName) Get the widget for the layout area with the specified name Widget
getAreaComponent(string $areaName) Get the component for the layout area with the specified name Component
getAreaCollectionElements(string $areaName) Get the component collection elements for the layout area with the specified name Collection
getAreaHtml(string $areaName) Get the rendered HTML for the component area with the specified name. Adds live preview tags, if enabled. string
getImageTargetFolderPath() Retrieves the target folder path for uploaded images. Images will be moved to this path after the upload has been processed. string
getId() int
getName() string
getSlug() string
getPublishedPostsCount() int
getPublishedCommentsCount() int
getCreated() Get the date the record was created. DateTime
getModified() Get the last modification date for the record. DateTime
getPublished() Get the date the record was published or is scheduled to be published. DateTime
isPublished() Check if the record is published. bool
getAuthor() Author
getSite() Site
getImage() Image
getLayout() Layout
getPostsLayout() Layout
getAllowRss() bool
getLockComments() bool
getAutoPublishPosts() bool
getAutoPublishComments() bool
getRequireCommentatorEmail() bool
getTags() Collection (Tag)
getCategories() Collection (Category)
getPosts() Collection (Post)
getSeoSettings() SeoSettings
getLanguage() Language
getSourceBlog() Blog
getRelatedBlogs() Collection (Blog)
getOwner() User
getBlogAreas() Collection (BlogArea)
getCustomUrl() Get the custom url used for the page. This will take precedence over the slugs of this page, parent page and the module. CustomUrl
isNewRecord() Check if the record is a new record bool
isHierarchicalModel() Check whether a model is a hierarchical model, i.e. can have children bool
isVersionedModel() Check whether a model is versioned bool
getRootCategories() Get the root categories Collection
getAvailableUsers() Get the available users Collection
getAvailableLayouts() Get the available blog layouts Collection
getAvailablePostLayouts() Get the available post layouts Collection
getAvailableSourceBlogs() Get the available source blogs for this blog Collection
getCreateChildUrl() Get the url for creating a child record. string
getDisplayProperty() Get the display property to use string
getHateoasLinks() Get the HATEOAS links for the record array
getEditUrl() Get the url for editing the record. string
getDeleteUrl() Get the url for deleting the record. string
getPermissionsUrl() Get the url for editing the permissions of the record. string
getCheckPermissionsUrl() Get the url for checking user permissions for this record. string
getPublishUrl() Get the url for publishing the record. string
getManageUrl() Get the url for managing records. string
getShowFrontendUrl() Get the url showing the record in the frontend string