Documentation

EasyBlogPost extends EasyBlog
in package

Table of Contents

Properties

$_methodsToPort  : mixed
$_propsToPort  : mixed
$access  : mixed
$acl  : mixed
$address  : mixed
$allowcomment  : mixed
$app  : mixed
$assets  : mixed
$association  : mixed
$associations  : mixed
$author  : mixed
$author_alias  : mixed
$autopost_date  : mixed
$autoposting  : mixed
$blank  : mixed
$blogger  : mixed
$blogpassword  : mixed
$canonical  : mixed
$categories  : mixed
$category  : mixed
$category_id  : mixed
$catid  : mixed
$commentCount  : mixed
$commentCounts  : mixed
$comments  : mixed
$config  : mixed
$content  : mixed
$contentImage  : mixed
$contributionDisplay  : mixed
$copyrights  : mixed
$cover  : mixed
$created  : mixed
$created_by  : mixed
$creator  : mixed
$custom_title  : mixed
$customFields  : mixed
$date  : mixed
$db  : mixed
$debug  : mixed
$defaultBindOptions  : mixed
$defaultSaveOptions  : mixed
$description  : mixed
$doc  : mixed
$doctype  : mixed
$document  : mixed
$enumerations  : mixed
$event  : mixed
$excerpt  : mixed
$featured  : mixed
$fields  : mixed
$fields_class  : mixed
$frontpage  : mixed
$hasPinterest  : mixed
$hits  : mixed
$id  : mixed
$image  : mixed
$input  : mixed
$intro  : mixed
$introtext  : mixed
$ip  : mixed
$isCoverImage  : mixed
$isfeatured  : mixed
$isFeatured  : mixed
$isnew  : mixed
$isUsingFirstImage  : mixed
$jcfields  : mixed
$jconfig  : mixed
$keywords  : mixed
$komentodisable  : mixed
$komentoenable  : mixed
$komentolock  : mixed
$lang  : mixed
$language  : mixed
$latitude  : mixed
$locked  : mixed
$login_to_read  : mixed
$longitude  : mixed
$lottie_files  : mixed
$media  : mixed
$meta  : mixed
$modified  : mixed
$my  : mixed
$ordering  : mixed
$original  : mixed
$params  : mixed
$permalink  : mixed
$polls  : mixed
$post  : mixed
$postMetas  : mixed
$posttype  : mixed
$postVotes  : mixed
$previewComments  : mixed
$protect  : mixed
$publish_down  : mixed
$publish_up  : mixed
$published  : mixed
$ratings  : mixed
$reactions  : mixed
$readmore  : mixed
$revision  : mixed
$revision_id  : mixed
$robots  : mixed
$send_notification_emails  : mixed
$showRating  : mixed
$source_id  : mixed
$source_type  : mixed
$state  : mixed
$string  : mixed
$subscription  : mixed
$summary  : mixed
$tags  : mixed
$team_id  : mixed
$text  : mixed
$title  : mixed
$totalComments  : mixed
$uid  : mixed
$user  : mixed
$version  : mixed
$videoCover  : mixed
$videoEmbedCover  : mixed
$vote  : mixed
$workbench  : mixed
$_debug  : mixed
$formattedContents  : mixed
$formattedIntros  : mixed
$saveOptions  : mixed

Methods

__construct()  : mixed
allowComments()  : mixed
Determines if this post allows comments
ampCleanup()  : mixed
Cleaning up amp content to follow google standard
applyDateOffset()  : mixed
Applies date offset to the post
approve()  : mixed
Allows moderator to approve this post
archive()  : mixed
Archives a blog post on the site.
autopost()  : mixed
Auto posts this post into social network sites
bind()  : mixed
Binds a posted data
bindParams()  : mixed
Bind params in the post
canApprove()  : mixed
Determine if user can approve the blog post
canAutopost()  : mixed
Auto posts this post into social network sites
canCreate()  : mixed
Determines if the current user can create a new post
canDelete()  : mixed
Determines if the current viewer can delete this post
canDeleteRevision()  : mixed
Determines if user has the rights to delete revision for this blog post.
canEdit()  : mixed
Determines if the current viewer can edit this post.
canFavourite()  : mixed
Determine if user is able to favourite this post
canModerate()  : mixed
Determines if the user can moderate the post
canPublish()  : mixed
Determines if the current viewer is allowed to publish this post.
canPurgeRevisions()  : mixed
Determines if this post has any revisions to purge or not
checkout()  : mixed
Checkout from a specific revision
checkoutFromPost()  : mixed
Checkout from a specific post
checkoutFromRevision()  : mixed
Checkout from a specific revision
checkTeamPrivacy()  : mixed
Determines if the user is allowed to view this post if this post is associated with a team.
checkView()  : mixed
Determines if the current user can view this post or not.
checkViewPreview()  : mixed
Determines if the current user can preview this post or not.
clearCache()  : mixed
Clears the cache in Joomla for EasyBlog related items
clearUnnecessaryLottie()  : mixed
Clear the unnecessary lottie files that are no longer associated with this blog post
create()  : mixed
Creates a new post whenever the editor is initialized
createNewRevision()  : mixed
Creates a new revision for the post
createNewWorkbench()  : mixed
Creates a new workbench object of itself.
debug()  : mixed
Sets a debug status
delete()  : mixed
Deletes a post from the site
deleteAssets()  : mixed
Delete assets that are related to the post
deleteBlogTags()  : mixed
Delete any tags associated with the post
deleteCategoryRelations()  : mixed
Delete category relations
deleteComments()  : mixed
Delete comments related to this post
deleteFeatured()  : mixed
Remove any featured items for this post
deleteFeedHistory()  : mixed
Deletes any association with the feed history table
deleteLottieFiles()  : mixed
Delete the Lottie files that have been uploaded for this blog post
deleteMetas()  : mixed
Delete meta tags associated with this post
deleteOtherRelations()  : mixed
Delete all other relations with the post
deletePending()  : mixed
Allows moderator delete post under moderation.
deleteRatings()  : mixed
Delete ratings associated with this post
deleteReactions()  : mixed
Delete reactions related to this post
deleteReports()  : mixed
Delete reports associated with this post
deleteRevisions()  : mixed
Delete revisions associated with this post
deleteSubscribers()  : mixed
Delete subscribers for this post
deleteTeamContribution()  : mixed
Delete team associations with this current post
displayCommentCount()  : mixed
Use @allowComments instead
duplicate()  : mixed
Duplicates a post
exportMedia()  : mixed
extract media into post->media for easy reference.
extractLegacyMedia()  : mixed
favourite()  : mixed
Add this post into user's favourites list
formatEmailContent()  : mixed
Format content to suit the layout of email notifications
formatPolls()  : mixed
Format the polls from the content of the post
formatRssContent()  : mixed
generatePermalink()  : mixed
Generate an alias for the blog post
getAlias()  : mixed
Retrieves the alias of a post
getAMPContent()  : mixed
Retrieves the content for the AMP page
getAsset()  : mixed
Retrieves asset associated with the post
getAssets()  : mixed
Retrieves assets associated with the blog post
getAssociation()  : mixed
Retrieves a list of language associations for posts
getAuthor()  : mixed
Retrieves the author of the item
getAuthorName()  : mixed
Get author name for this post
getAuthorPermalink()  : mixed
Get author permalink for this post
getAvailableChildBlocks()  : mixed
Get available child block in the post
getBlocks()  : mixed
Retrieve a list of blocks in this block post
getBlogContribution()  : mixed
Retrieves the blog contribution
getCategories()  : mixed
Retrieves a list of categories associated with this blog post
getCategoryDefaultPostCover()  : mixed
Retrieve the default cover by its primary category
getComments()  : mixed
Retrieves comments for this post
getCommentsPermalink()  : mixed
getContent()  : mixed
Retrieves the content of the blog post
getContentImage()  : mixed
getContentWithoutIntro()  : mixed
Prepares the content without intro text.
getCoverDimension()  : mixed
Get cover image dimension for the schema markup
getCoverImageAlt()  : mixed
Get the alternative text of the post cover
getCoverType()  : mixed
Retrieves the type of the post cover
getCreationDate()  : EasyBlogDate
Retrieves the creation date of the item
getCurrentRevisionId()  : mixed
Retrieves the current revision that is being displayed on the site
getCustomFields()  : mixed
Retrieves a list of custom fields associated to this blog post
getDisplayDate()  : mixed
Displays the display date
getEditLink()  : mixed
Retrieves the edit link of the post
getEmbedCover()  : mixed
Retrieve embed cover of the post
getError()  : mixed
getErrors()  : mixed
getExternalBlogLink()  : mixed
Get external permalink to the blog post which xhtml is pass to false or can pass a blog link with comment anchor tag
getExternalPermalink()  : mixed
Retrieves the external permalink for this blog post
getFactCheckerLink()  : mixed
Retrieve the fact checker's profile link of this blog post
getFactCheckerName()  : mixed
Retrieve the fact checker's name of this blog post
getFirstImage()  : mixed
Get the first image from the content
getFormDateValue()  : mixed
Retrieves the date time value
getIcon()  : mixed
Deprecated. Use post.list.icon helper instead
getImage()  : mixed
Retrieves the blog image url for this blog post
getImageCaption()  : mixed
Retrieve image caption
getImageTitle()  : mixed
Retrieve image title
getInstantContent()  : mixed
Retrieves the content of the Instant Article
getIntro()  : mixed
Get the intro text of the blog post
getKeywords()  : mixed
Retrieves a list of seo keywords for this post
getLatestDraftRevision()  : mixed
Retrieves latest draft revision that are associated with this post
getLocationImage()  : mixed
Retrieve the location image
getMedia()  : mixed
retrieve media into post->media for easy reference.
getMenuParams()  : mixed
This method will intelligently determine which menu params this post should be inheriting from
getModifiedDate()  : EasyBlogDate
Retrieves the modified date of the item
getPagePostTitle()  : mixed
Get the page post title
getParams()  : mixed
Get params data
getPermalink()  : mixed
Retrieves the permalink for this blog post
getPlainContent()  : mixed
Retrieves the content of the blog post
getPostTemplateId()  : mixed
Get its post template id
getPreviewComments()  : mixed
Retrieves preview comments for this post
getPreviewLink()  : mixed
Retrieves the preview link of the post
getPrimaryCategory()  : mixed
Retrieves the primary category for this post
getPrintLink()  : mixed
Retrieves the print link for a post
getPublishDate()  : mixed
Retrieves the published date of the item
getRatings()  : mixed
Retrieves the rating of the post
getReactions()  : mixed
Retrieves reaction data related to the current post
getReadingTime()  : mixed
Get estimate reading time for this blog
getRegisteredSubscribers()  : mixed
Retrieves a list of users that subscribed to this post
getReviewerLink()  : mixed
Retrieve the reviewer's profile link of this blog post
getReviewerName()  : mixed
Retrieve the reviewer's name of this blog post
getRevisionCount()  : mixed
Retrieves a list of categories associated with this blog post
getRevisions()  : mixed
Retrieves all revisions that are associated with this post
getSchemaLogo()  : mixed
Retrieve logo for schema
getSubscribers()  : mixed
Retrieves a list of subscribers for this particular post
getTags()  : array<string|int, mixed>
Get a list of tag objects that are associated with this blog post.
getTeamAssociation()  : mixed
Determines if the blog post is associated with a team
getTitle()  : mixed
Retrieves the title of the post
getTotalComments()  : mixed
Get total number of comments for this blog post
getTotalWords()  : mixed
Get total word use in this post
getType()  : mixed
Retrieves the post type
getUid()  : mixed
Retrieves the uid for this post
getUnpublishDate()  : EasyBlogDate
Retrieves the unpublished date of the item
getVersion()  : mixed
reassign blog author only.
getWorkingRevision()  : mixed
Retrieves the active revision for this post
hasAuthorAlias()  : mixed
Determines if the post has author alias
hasBlockType()  : mixed
Determine the blog post has the type of block being mentioned
hasChanged()  : mixed
Determines if a property of the item has changed or not.
hasChanges()  : mixed
Used in autosave and to determine if this post has changes or not before submit for saving.
hasError()  : mixed
hasErrors()  : mixed
hasImage()  : mixed
Determines if this post has an image associated
hasLocation()  : mixed
Determines if the post has location
hasPinterest()  : mixed
Determine if the blog content has pinterest block
hasReadmore()  : mixed
Determines if there is a readmore tag in this content
hasRevisionWaitingForApproval()  : mixed
Determines if this post has any revisions that is waiting for approval
hasVoted()  : mixed
Determines if the current visitor has voted on this item
hit()  : mixed
Override functionality of JTable's hit method as we want to limit the hits based on the session.
initSaveOptions()  : mixed
Init save options
isAccessible()  : mixed
Determines if the post is accessible by the current user viewing the post
isArchived()  : mixed
Determines if the item is archived
isAvailable()  : mixed
Determines if the post is available or in other words, visible on the site.
isBackDated()  : mixed
Determine if this is a backdate post
isBeingApproved()  : mixed
Determines if this item is being approved by a moderator.
isBeingArchived()  : mixed
Determines if the post is being archived
isBeingCreated()  : mixed
Determines if the item is being created.
isBeingDrafted()  : mixed
Determines if this post is being drafted
isBeingPublished()  : mixed
Determines if the post is being published on the site
isBeingRejected()  : mixed
Determines if the post is being rejected
isBeingRepublished()  : mixed
Determines if the post is being republished again.
isBeingRestored()  : mixed
Determines if the post is being trashed
isBeingScheduledForPublishing()  : mixed
isBeingScheduledFromPending()  : mixed
Determines if this item is being approved by a moderator if the original publish state is pending then become schedule state.
isBeingSubmittedForApproval()  : mixed
Determines if this current item is being submitted for approval
isBeingTrashed()  : mixed
Determines if the post is being trashed
isBeingUnpublished()  : mixed
Determines if the post is being unpublished
isBlank()  : mixed
When initiating a new post on the site the current publishing state of the blog post is blank
isCurrent()  : mixed
Determines if the current item that is being saved is on the same revision
isDraft()  : mixed
Determines when a blog post is on the draft state
isEB51()  : mixed
isEbd()  : mixed
Determines if this is an 'ebd' post type
isEmbedCover()  : mixed
Determine if this has embed cover
isExternalImageCover()  : mixed
Determine if this is an external image cover
isFavourited()  : mixed
Determine if user already favourited this post
isFeatured()  : mixed
Determines if this post is featured
isFinalized()  : mixed
Determines if the post is either published, scheduled or unpublished.
isFromFeed()  : mixed
Determines if this post is from a feed
isImageCover()  : mixed
Determines if the cover for this post is an image
isLegacy()  : mixed
Determines if this is a legacy post
isMine()  : mixed
Determines if this post belongs to the current logged in user
isMobile()  : mixed
Determines if this is a mobile layout
isNew()  : mixed
Determines if this is a new post
isNoLongerNew()  : mixed
Determines if this post is no longer a new post.
isPasswordProtected()  : mixed
Determines if this post is password protected
isPending()  : mixed
Detmermines if the blog post is pending
isPostPublished()  : mixed
Determines if the post item is published
isPostTemplateLocked()  : mixed
Determine whether its post template is locked or not
isPostUnpublished()  : mixed
Determines if the post item is published
isPublished()  : mixed
Determines if the blog post is published
isReady()  : mixed
Determines if the post's revision is finalized and also being used by the current post table.
isScheduled()  : mixed
Determines if the blog post is scheduled to be published
isStandardSource()  : mixed
Checks if this is a normal posting and is not related to an external or team source
isTablet()  : mixed
Determines if this is a tablet layout
isTeamBlog()  : mixed
check if this post is a teamblog post or not
isTeamBlogAdmin()  : mixed
Determines if this post belongs to teamblog and the current logged in user is team admin
isTrashed()  : mixed
Determines if the item is trashed
isUnderScheduled()  : mixed
Determines if the blog post is scheduled to be published
isUnpublished()  : mixed
Determines if the blog post is unpublished on the site
isVideoCover()  : mixed
Determines if the cover for this post is a video
load()  : mixed
Loads a post item given the uid of the item.
loadByPermalink()  : mixed
Given a permalink, find the post id and load the post.
loadFields()  : mixed
Retrieves a list of fields
loadLanguage()  : mixed
Helper method to load language
loadMeta()  : mixed
Loads meta data about the post
loadPost()  : mixed
Loads the JTable Post object
loadRevision()  : mixed
Loads a JTable Revision object
lock()  : mixed
Allows caller to lock a blog post
move()  : mixed
Moves the current blog post to a new category
normalize()  : mixed
Normalize all posted / binded data.
normalizeAlias()  : mixed
Normalize the alias of the blog post
normalizeAuthor()  : mixed
Ensures that the author is set correctly.
normalizeAutopostContent()  : mixed
Normalize the autopost content
normalizeBlogImage()  : mixed
Ensures that the blog image data is appropriate
normalizeBlogPermalink()  : mixed
Normalize the non sef link whether need to include the lang query string or not
normalizeCategories()  : mixed
Normalize categories
normalizeContent()  : mixed
Normalizes the content of the post by cleaning and filtering the html codes
normalizeContentImage()  : mixed
Process any base64 images within the content to actual image
normalizeDate()  : mixed
Ensures that all the dates associated with the post is set
normalizeDocument()  : mixed
Normalizes the document type.
normalizeFrontpage()  : mixed
Ensures that the front page state is set correctly
normalizeNewState()  : mixed
Normalizes the new state of the post
normalizeOthers()  : mixed
Normalize other properties of the post
normalizePrivacy()  : mixed
Normalizes the privacy state
normalizePublishingState()  : mixed
Normalizes the publishing states
normalizeSource()  : mixed
Normalize the source
normalizeState()  : mixed
Normalizes the state column
normalizeTags()  : mixed
Ensures that all of the default tags are being assigned to the blog.
normalizeTitle()  : mixed
Normalizes the blog post's title.
notify()  : mixed
Notify subscribers when a new blog post is published
parseUid()  : mixed
Parses the UID <postId>.<revisionId> into an object
postSave()  : mixed
Post processing when a blog post is saved
prepareContent()  : mixed
Prepares the content before displaying it out.
preSave()  : mixed
Before a blog post is stored, we want to perform specific operations here
processPostIntroContent()  : mixed
publish()  : mixed
Publishes a blog post on the site.
purgeRevisions()  : mixed
Delete revisions other than the current associated revision.
reassignAuthor()  : mixed
reassign blog author only.
reject()  : mixed
Allows moderator to reject this post
relocateMediaFiles()  : mixed
Relocate media files into "My Media"
remove3rdPartyTags()  : mixed
Remove known 3rd party tags from the content
removeFeatured()  : mixed
Removes this post as a featured post
removeFrontpage()  : mixed
Remove the post from the frontpage.
removeLoadmodulesTags()  : mixed
Remove loadposition and loadmodules from the content
renderClassnames()  : mixed
Generates a list of class names for composer
renderEditorContent()  : mixed
Used during post editing so we can render the necessary blocks
renderHeaders()  : mixed
Initializes the header of the html page
requiresLoginToRead()  : mixed
Determines if the user needs to login to read the post.
resetHits()  : mixed
Reset post hits
restore()  : mixed
Restore a blog post from the trash.
restoreFromPost()  : mixed
A special function used to bind various data from the form post.
save()  : mixed
Saves a blog post on the site. This method ensures that all saving process goes through the same routine.
saveAssociation()  : mixed
Saves the posts association
saveCategories()  : mixed
Save the categories associated with the post.
saveFields()  : mixed
Saves the fields that are related to the blog post
saveMeta()  : mixed
Saves the meta data of the blog post.
saveParam()  : mixed
Saves a key / value in the parameters of the post
savePost()  : mixed
Saves the blog post
saveRelation()  : mixed
Associates the post with a different source.
saveRevision()  : mixed
Determines if the revision should be created as a new revision or update on existing revision.
saveTags()  : mixed
Saves the tags when the blog post is stored.
setError()  : mixed
setFeatured()  : mixed
Sets this post as a featured post
setFrontpage()  : mixed
Set's the post to be available on the front page.
setWorkbench()  : mixed
Sets the workbench for this current instance
toData()  : mixed
Exports the post library to a standard object that can be sent back to the javascripts.
toEmailData()  : mixed
Exports the post library to email data
toParamsData()  : mixed
Returns formatted params data
toPostData()  : mixed
Returns the data of a post in a standard object
toRevisionData()  : mixed
Exports current properties of the post that should be inserted into the revision data.
trash()  : mixed
Archives a blog post on the site.
triggerAfterSave()  : mixed
Triggers plugins after a blog post is saved
triggerBeforeSave()  : mixed
Triggers plugins before a blog post is saved
unarchive()  : bool
Unarchives a blog post on the site.
unfavourite()  : mixed
Remove this post from user's favourites list
unlock()  : mixed
Allows caller to lock a blog post
unpublish()  : mixed
Unpublishes a post
updateFeatured()  : mixed
update post featured.
updateParams()  : mixed
Update neccessary params for this post.
updateToRevision()  : mixed
Switches the post to the revision
usePostImage()  : mixed
Determines if this post has an post's image in the content or not
useRevision()  : mixed
Sets the revision id for the post
validate()  : mixed
Validates the current blog post
validateAcl()  : mixed
Check if user have permission to save the post
validateCategory()  : mixed
Ensures that the post's category is accessible by category acl.
validateContent()  : mixed
Validates the content and ensures that the content contains valid data.
validateFields()  : mixed
Validates the custom fields for this post
validateMultilingualPostAccess()  : mixed
Validate whether the current viewer can able to access this blog post under current site language
validatePostCover()  : mixed
Validate the post cover
validatePostMenuItemAccess()  : mixed
Validate if the current menu item is associated with the correct post.
validateTitle()  : mixed
Ensures that the post title is valid
verifyPassword()  : mixed
Verifies a password
renderPreviews()  : mixed
process previews

Properties

$_methodsToPort

public static mixed $_methodsToPort = []

$_propsToPort

public static mixed $_propsToPort = []

$access

public mixed $access

$address

public mixed $address = ''

$allowcomment

public mixed $allowcomment

$assets

public mixed $assets

$association

public mixed $association

$associations

public mixed $associations

$author

public mixed $author

$author_alias

public mixed $author_alias = ''

$autopost_date

public mixed $autopost_date

$autoposting

public mixed $autoposting

$blank

public static mixed $blank

$blogger

public mixed $blogger

$blogpassword

public mixed $blogpassword

$canonical

public mixed $canonical

$categories

public mixed $categories

$category

public mixed $category

$category_id

public mixed $category_id

$catid

public mixed $catid

$commentCount

public mixed $commentCount

$commentCounts

public static mixed $commentCounts = array()

$comments

public static mixed $comments = array()

$config

public mixed $config

$content

public mixed $content = ''

$contentImage

public mixed $contentImage

$contributionDisplay

public mixed $contributionDisplay

$copyrights

public mixed $copyrights = ''

$cover

public mixed $cover

$created

public mixed $created

$created_by

public mixed $created_by

$creator

public mixed $creator

$custom_title

public mixed $custom_title = ''

$customFields

public static mixed $customFields = array()

$date

public mixed $date

$db

public mixed $db = \null

$debug

public mixed $debug = \false

$defaultBindOptions

public static mixed $defaultBindOptions = [ // If true, allow binding even from non-bindable properties. // This is useful for migrators. 'force' => \false, // TODO: Rename blog_contribute to isssitewide in composer form. 'remap' => array(array('eb_language', 'language')), ]

$defaultSaveOptions

public static mixed $defaultSaveOptions = [ 'normalizeData' => \true, 'validateData' => \true, 'updateModifiedTime' => \true, 'applyDateOffset' => \false, 'checkEmptyTitle' => \true, 'checkBlockedWords' => \true, 'checkMinContentLength' => \true, 'logUserIpAddress' => \true, 'skipCreateRevision' => \false, 'useAuthorAsRevisionOwner' => \false, 'skipCustomFields' => \false, 'skipNotifications' => \false, 'triggerPlugins' => \true, 'triggerStateChangeOnly' => \false, 'processAutopost' => \true, 'skipCategoriesUpdate' => \false, 'skipTagsUpdate' => \false, 'skipAssociationUpdate' => \false, 'silent' => \false, // Quietly save into db without executing postSave. 'copyPost' => \false, 'isArchiveProcess' => \false, 'isScheduleProcess' => \false, // Allow caller to specify reject message 'rejectMessage' => '', ]

$description

public mixed $description

$doctype

public mixed $doctype

$document

public mixed $document

$enumerations

public static mixed $enumerations = array( 'id' => array('bindable' => \false, 'linked' => \false), 'created_by' => array('bindable' => \true, 'linked' => \false), 'created' => array('bindable' => \true, 'linked' => \false), 'modified' => array('bindable' => \false, 'linked' => \false), 'title' => array('bindable' => \true, 'linked' => \false), 'permalink' => array('bindable' => \true, 'linked' => \false), 'content' => array('bindable' => \true, 'linked' => \false), 'intro' => array('bindable' => \true, 'linked' => \false), 'excerpt' => array('bindable' => \true, 'linked' => \false), 'category_id' => array('bindable' => \true, 'linked' => \false), 'published' => array('bindable' => \true, 'linked' => \false), 'state' => array('bindable' => \false, 'linked' => \false), // 5.0 'publish_up' => array('bindable' => \true, 'linked' => \false), 'publish_down' => array('bindable' => \true, 'linked' => \false), 'autopost_date' => array('bindable' => \true, 'linked' => \false), 'ordering' => array('bindable' => \true, 'linked' => \false), 'vote' => array('bindable' => \false, 'linked' => \false), 'hits' => array('bindable' => \false, 'linked' => \false), 'access' => array('bindable' => \true, 'linked' => \false), 'allowcomment' => array('bindable' => \true, 'linked' => \false), 'login_to_read' => ['bindable' => \true, 'linked' => \false], 'lottie_files' => ['bindable' => \true, 'linked' => \false], 'polls' => ['bindable' => \true, 'linked' => \false], 'subscription' => array('bindable' => \true, 'linked' => \false), 'frontpage' => array('bindable' => \true, 'linked' => \false), 'isnew' => array('bindable' => \false, 'linked' => \false), 'blogpassword' => array('bindable' => \true, 'linked' => \false), 'latitude' => array('bindable' => \true, 'linked' => \false), 'longitude' => array('bindable' => \true, 'linked' => \false), 'address' => array('bindable' => \true, 'linked' => \false), 'posttype' => array('bindable' => \true, 'linked' => \false), // This is microblog. 'source_id' => array('bindable' => \true, 'linked' => \false), // 5.0 'source_type' => array('bindable' => \true, 'linked' => \false), // 5.0 'reactions' => array('bindable' => \false, 'linked' => \false), // 5.1 'robots' => array('bindable' => \true, 'linked' => \false), 'copyrights' => array('bindable' => \true, 'linked' => \false), 'image' => array('bindable' => \true, 'linked' => \false), 'language' => array('bindable' => \true, 'linked' => \false), 'locked' => array('bindable' => \false, 'linked' => \false), 'ip' => array('bindable' => \false, 'linked' => \false), 'doctype' => array('bindable' => \true, 'linked' => \false), // 5.0 'document' => array('bindable' => \true, 'linked' => \false), // 5.0 'revision_id' => array('bindable' => \true, 'linked' => \false), // 5.0 'autoposting' => array('bindable' => \true, 'linked' => \false), 'categories' => array('bindable' => \true, 'linked' => \true), 'tags' => array('bindable' => \true, 'linked' => \true), 'fields' => array('bindable' => \true, 'linked' => \true), // 5.0 'fields_class' => array('bindable' => \true, 'linked' => \true), // 5.2 'keywords' => array('bindable' => \true, 'linked' => \true), 'description' => array('bindable' => \true, 'linked' => \true), 'canonical' => array('bindable' => \true, 'linked' => \true), 'custom_title' => array('bindable' => \true, 'linked' => \true), 'send_notification_emails' => array('bindable' => \true, 'linked' => \false), 'association' => array('bindable' => \false, 'linked' => \false), 'author_alias' => array('bindable' => \true, 'linked' => \false), 'isfeatured' => array('bindable' => \true, 'linked' => \false), 'version' => array('bindable' => \true, 'linked' => \false), 'media' => array('bindable' => \true, 'linked' => \false), )

$event

public mixed $event = ''

$excerpt

public mixed $excerpt
public mixed $featured

$fields

public mixed $fields

$fields_class

public mixed $fields_class

$frontpage

public mixed $frontpage

$hasPinterest

public mixed $hasPinterest

$hits

public mixed $hits

$id

public mixed $id = 0

$image

public mixed $image = ''

$input

public mixed $input

$intro

public mixed $intro = ''

$introtext

public mixed $introtext

$isCoverImage

public mixed $isCoverImage

$isfeatured

public mixed $isfeatured

$isFeatured

public mixed $isFeatured

$isnew

public mixed $isnew

$isUsingFirstImage

public mixed $isUsingFirstImage = \false

$jcfields

public mixed $jcfields

$jconfig

public mixed $jconfig = \null

$keywords

public mixed $keywords

$komentodisable

public mixed $komentodisable

$komentoenable

public mixed $komentoenable

$komentolock

public mixed $komentolock

$lang

public mixed $lang = \null

$language

public mixed $language

$latitude

public mixed $latitude

$locked

public mixed $locked

$login_to_read

public mixed $login_to_read

$longitude

public mixed $longitude

$lottie_files

public mixed $lottie_files

$media

public mixed $media

$meta

public mixed $meta

$modified

public mixed $modified

$ordering

public mixed $ordering

$original

public mixed $original

$params

public mixed $params
public mixed $permalink

$polls

public mixed $polls

$post

public mixed $post

$postMetas

public static mixed $postMetas = array()

$posttype

public mixed $posttype

$postVotes

public static mixed $postVotes = array()

$previewComments

public static mixed $previewComments = array()

$protect

public mixed $protect

$publish_down

public mixed $publish_down

$publish_up

public mixed $publish_up

$published

public mixed $published

$ratings

public static mixed $ratings = array()

$reactions

public mixed $reactions

$readmore

public mixed $readmore = ''

$revision

public mixed $revision

$revision_id

public mixed $revision_id

$robots

public mixed $robots = ''

$send_notification_emails

public mixed $send_notification_emails

$showRating

public mixed $showRating

$source_id

public mixed $source_id

$source_type

public mixed $source_type

$state

public mixed $state

$string

public mixed $string = \null

$subscription

public mixed $subscription

$summary

public mixed $summary

$tags

public mixed $tags

$team_id

public mixed $team_id

$text

public mixed $text = ''

$title

public mixed $title = ''

$totalComments

public mixed $totalComments

$user

public mixed $user

$version

public mixed $version

$videoCover

public mixed $videoCover

$videoEmbedCover

public mixed $videoEmbedCover

$vote

public mixed $vote

$workbench

public mixed $workbench

$_debug

private mixed $_debug = \false

$formattedContents

private mixed $formattedContents = array()

$formattedIntros

private mixed $formattedIntros = array()

$saveOptions

private mixed $saveOptions = array()

Methods

__construct()

public __construct([mixed $uid = null ][, mixed $userId = null ]) : mixed
Parameters
$uid : mixed = null
$userId : mixed = null

allowComments()

Determines if this post allows comments

public allowComments() : mixed
Tags
since
5.1
access

public

ampCleanup()

Cleaning up amp content to follow google standard

public ampCleanup() : mixed
Tags
since
5.2.8
access

public

applyDateOffset()

Applies date offset to the post

public applyDateOffset([mixed $offset = null ]) : mixed
Parameters
$offset : mixed = null
Tags
since
6.0.0
access

public

approve()

Allows moderator to approve this post

public approve() : mixed
Tags
since
5.0
access

public

archive()

Archives a blog post on the site.

public archive() : mixed
Tags
since
5.0
access

public

autopost()

Auto posts this post into social network sites

public autopost(mixed $type[, mixed $force = false ]) : mixed
Parameters
$type : mixed
$force : mixed = false
Tags
since
5.0
access

public

bind()

Binds a posted data

public bind(mixed $data[, mixed $options = array() ][, mixed $debug = false ]) : mixed
Parameters
$data : mixed
$options : mixed = array()
$debug : mixed = false
Tags
since
5.0
access

public

bindParams()

Bind params in the post

public bindParams(mixed $newParams) : mixed
Parameters
$newParams : mixed
Tags
since
5.1
access

public

canApprove()

Determine if user can approve the blog post

public canApprove() : mixed
Tags
since
5.2
access

public

canAutopost()

Auto posts this post into social network sites

public canAutopost() : mixed
Tags
since
5.0
access

public

canCreate()

Determines if the current user can create a new post

public canCreate([mixed $sourceId = 0 ][, mixed $sourceType = '' ]) : mixed
Parameters
$sourceId : mixed = 0
$sourceType : mixed = ''
Tags
since
5.3.0
access

public

canDelete()

Determines if the current viewer can delete this post

public canDelete() : mixed
Tags
since
5.0
access

public

canDeleteRevision()

Determines if user has the rights to delete revision for this blog post.

public canDeleteRevision() : mixed
Tags
since
5.1
access

public

canEdit()

Determines if the current viewer can edit this post.

public canEdit() : mixed
Tags
since
5.0
access

public

canFavourite()

Determine if user is able to favourite this post

public canFavourite([mixed $userId = null ]) : mixed
Parameters
$userId : mixed = null
Tags
since
5.2
access

public

canModerate()

Determines if the user can moderate the post

public canModerate() : mixed
Tags
since
5.1
access

public

canPublish()

Determines if the current viewer is allowed to publish this post.

public canPublish() : mixed
Tags
since
5.0
access

public

canPurgeRevisions()

Determines if this post has any revisions to purge or not

public canPurgeRevisions() : mixed
Tags
since
5.1
access

public

checkout()

Checkout from a specific revision

public checkout() : mixed
Tags
since
5.0
access

public

checkoutFromPost()

Checkout from a specific post

public checkoutFromPost() : mixed
Tags
since
5.0
access

public

checkoutFromRevision()

Checkout from a specific revision

public checkoutFromRevision() : mixed
Tags
since
5.0
access

public

checkTeamPrivacy()

Determines if the user is allowed to view this post if this post is associated with a team.

public checkTeamPrivacy() : mixed
Tags
since
4.0
access

public

checkView()

Determines if the current user can view this post or not.

public checkView() : mixed
Tags
since
5.0
access

public

checkViewPreview()

Determines if the current user can preview this post or not.

public checkViewPreview() : mixed
Tags
since
5.4
access

public

clearCache()

Clears the cache in Joomla for EasyBlog related items

public clearCache() : mixed
Tags
since
5.0
access

public

clearUnnecessaryLottie()

Clear the unnecessary lottie files that are no longer associated with this blog post

public clearUnnecessaryLottie() : mixed
Tags
since
6.0.0
access

public

create()

Creates a new post whenever the editor is initialized

public create([mixed $options = array() ]) : mixed
Parameters
$options : mixed = array()
Tags
since
5.0
access

public

createNewRevision()

Creates a new revision for the post

public createNewRevision() : mixed
Tags
since
5.0
access

public

createNewWorkbench()

Creates a new workbench object of itself.

public createNewWorkbench() : mixed
Tags
since
5.0
access

public

debug()

Sets a debug status

public debug() : mixed
Tags
since
5.0
access

public

delete()

Deletes a post from the site

public delete() : mixed
Tags
since
5.1
access

public

deleteAssets()

Delete assets that are related to the post

public deleteAssets() : mixed
Tags
since
5.0
access

public

deleteBlogTags()

Delete any tags associated with the post

public deleteBlogTags() : mixed
Tags
since
5.0
access

public

deleteCategoryRelations()

Delete category relations

public deleteCategoryRelations() : mixed
Tags
since
5.0
access

public

deleteComments()

Delete comments related to this post

public deleteComments() : mixed
Tags
since
5.0
access

public

deleteFeatured()

Remove any featured items for this post

public deleteFeatured() : mixed
Tags
since
5.0
access

public

deleteFeedHistory()

Deletes any association with the feed history table

public deleteFeedHistory() : mixed
Tags
since
5.0
access

public

deleteLottieFiles()

Delete the Lottie files that have been uploaded for this blog post

public deleteLottieFiles() : mixed
Tags
since
6.0.0
access

public

deleteMetas()

Delete meta tags associated with this post

public deleteMetas() : mixed
Tags
since
5.0
access

public

deleteOtherRelations()

Delete all other relations with the post

public deleteOtherRelations() : mixed
Tags
since
5.0
access

public

deletePending()

Allows moderator delete post under moderation.

public deletePending() : mixed
Tags
since
5.4
access

public

deleteRatings()

Delete ratings associated with this post

public deleteRatings() : mixed
Tags
since
5.0
access

public

deleteReactions()

Delete reactions related to this post

public deleteReactions() : mixed
Tags
since
5.1
access

public

deleteReports()

Delete reports associated with this post

public deleteReports() : mixed
Tags
since
5.0
access

public

deleteRevisions()

Delete revisions associated with this post

public deleteRevisions() : mixed
Tags
since
5.0
access

public

deleteSubscribers()

Delete subscribers for this post

public deleteSubscribers() : mixed
Tags
since
5.0
access

public

deleteTeamContribution()

Delete team associations with this current post

public deleteTeamContribution() : mixed
Tags
since
5.0
access

public

displayCommentCount()

Use @allowComments instead

public displayCommentCount() : mixed

duplicate()

Duplicates a post

public duplicate() : mixed
Tags
since
5.0
access

public

exportMedia()

extract media into post->media for easy reference.

public exportMedia() : mixed
Tags
since
5.1
access

public

extractLegacyMedia()

public extractLegacyMedia() : mixed

favourite()

Add this post into user's favourites list

public favourite([mixed $userId = null ]) : mixed
Parameters
$userId : mixed = null
Tags
since
5.2
access

public

formatEmailContent()

Format content to suit the layout of email notifications

public formatEmailContent(mixed $content) : mixed
Parameters
$content : mixed
Tags
since
5.1
access

public

formatPolls()

Format the polls from the content of the post

public formatPolls(mixed $content[, mixed $options = [] ]) : mixed
Parameters
$content : mixed
$options : mixed = []
Tags
since
6.0.0
access

public

formatRssContent()

public formatRssContent(mixed $content) : mixed
Parameters
$content : mixed

Generate an alias for the blog post

public generatePermalink() : mixed
Tags
since
4.0
access

public

getAlias()

Retrieves the alias of a post

public getAlias() : mixed
Tags
since
5.0
access

public

getAMPContent()

Retrieves the content for the AMP page

public getAMPContent([mixed $triggerPlugin = true ]) : mixed
Parameters
$triggerPlugin : mixed = true
Tags
since
5.1
access

public

getAsset()

Retrieves asset associated with the post

public getAsset(mixed $key) : mixed
Parameters
$key : mixed
Tags
since
4.0
access

public

getAssets()

Retrieves assets associated with the blog post

public getAssets() : mixed
Tags
since
4.0
access

public

getAssociation()

Retrieves a list of language associations for posts

public getAssociation() : mixed
Tags
since
6.0.0
access

public

getAuthor()

Retrieves the author of the item

public getAuthor() : mixed
Tags
since
5.1
access

public

getAuthorName()

Get author name for this post

public getAuthorName() : mixed
Tags
since
5.1
access

public

Get author permalink for this post

public getAuthorPermalink() : mixed
Tags
since
5.1
access

public

getAvailableChildBlocks()

Get available child block in the post

public getAvailableChildBlocks(mixed $blockObj, mixed &$availableBlocks) : mixed
Parameters
$blockObj : mixed
$availableBlocks : mixed
Tags
since
5.2.5
access

public

getBlocks()

Retrieve a list of blocks in this block post

public getBlocks([mixed $limit = null ][, mixed $includeChildBlocks = false ]) : mixed
Parameters
$limit : mixed = null
$includeChildBlocks : mixed = false
Tags
since
4.0
access

public

getBlogContribution()

Retrieves the blog contribution

public getBlogContribution() : mixed
Tags
since
5.0
access

public

getCategories()

Retrieves a list of categories associated with this blog post

public getCategories() : mixed
Tags
since
4.0
access

public

getCategoryDefaultPostCover()

Retrieve the default cover by its primary category

public getCategoryDefaultPostCover([mixed $root = true ]) : mixed
Parameters
$root : mixed = true
Tags
since
6.0.0
access

public

getComments()

Retrieves comments for this post

public getComments([mixed $limit = null ]) : mixed
Parameters
$limit : mixed = null
Tags
since
5.0
access

public

public getCommentsPermalink([mixed $xhtml = true ][, mixed $external = false ][, mixed $format = null ]) : mixed
Parameters
$xhtml : mixed = true
$external : mixed = false
$format : mixed = null

getContent()

Retrieves the content of the blog post

public getContent([mixed $type = 'list' ][, mixed $triggerPlugin = true ][, mixed $fromRss = null ][, mixed $options = [] ]) : mixed
Parameters
$type : mixed = 'list'
$triggerPlugin : mixed = true
$fromRss : mixed = null
$options : mixed = []
Tags
since
5.1
access

public

getContentImage()

public getContentImage() : mixed

getContentWithoutIntro()

Prepares the content without intro text.

public getContentWithoutIntro([mixed $type = 'entry' ][, mixed $triggerPlugin = true ][, mixed $options = [] ]) : mixed
Parameters
$type : mixed = 'entry'
$triggerPlugin : mixed = true
$options : mixed = []
Tags
since
4.0
access

public

getCoverDimension()

Get cover image dimension for the schema markup

public getCoverDimension([mixed $size = 'original' ]) : mixed
Parameters
$size : mixed = 'original'
Tags
since
5.1
access

public

getCoverImageAlt()

Get the alternative text of the post cover

public getCoverImageAlt() : mixed
Tags
since
5.4.3
access

public

getCoverType()

Retrieves the type of the post cover

public getCoverType() : mixed
Tags
since
6.0.0
access

public

getCreationDate()

Retrieves the creation date of the item

public getCreationDate([mixed $withOffset = false ]) : EasyBlogDate
Parameters
$withOffset : mixed = false
Tags
since
5.0
access

public

Return values
EasyBlogDate

getCurrentRevisionId()

Retrieves the current revision that is being displayed on the site

public getCurrentRevisionId() : mixed
Tags
since
5.0
access

public

getCustomFields()

Retrieves a list of custom fields associated to this blog post

public getCustomFields() : mixed
Tags
since
4.0
access

public

getDisplayDate()

Displays the display date

public getDisplayDate([mixed $column = 'created' ][, mixed $withOffset = true ]) : mixed
Parameters
$column : mixed = 'created'
$withOffset : mixed = true
Tags
since
4.0
access

public

Retrieves the edit link of the post

public getEditLink([mixed $xhtml = true ][, mixed $explicitFrontEnd = false ]) : mixed
Parameters
$xhtml : mixed = true
$explicitFrontEnd : mixed = false
Tags
since
5.0
access

public

getEmbedCover()

Retrieve embed cover of the post

public getEmbedCover() : mixed
Tags
since
6.0
access

public

getError()

public getError() : mixed

getErrors()

public getErrors() : mixed

Get external permalink to the blog post which xhtml is pass to false or can pass a blog link with comment anchor tag

public getExternalBlogLink([mixed $commentId = '' ]) : mixed
Parameters
$commentId : mixed = ''
Tags
since
5.0
access

public

Retrieves the external permalink for this blog post

public getExternalPermalink() : mixed
Tags
since
5.1
access

public

Retrieve the fact checker's profile link of this blog post

public getFactCheckerLink() : mixed
Tags
since
6.0.10
access

public

getFactCheckerName()

Retrieve the fact checker's name of this blog post

public getFactCheckerName() : mixed
Tags
since
6.0.10
access

public

getFirstImage()

Get the first image from the content

public getFirstImage([mixed $size = 'original' ][, mixed $protocol = false ]) : mixed
Parameters
$size : mixed = 'original'
$protocol : mixed = false
Tags
since
5.1
access

public

getFormDateValue()

Retrieves the date time value

public getFormDateValue([mixed $column = 'created' ]) : mixed
Parameters
$column : mixed = 'created'
Tags
since
5.0
access

public

getIcon()

Deprecated. Use post.list.icon helper instead

public getIcon([mixed $classname = '' ]) : mixed
Parameters
$classname : mixed = ''

getImage()

Retrieves the blog image url for this blog post

public getImage([mixed $size = 'original' ][, mixed $showPlaceholder = true ][, mixed $protocol = false ][, mixed $useFirstImage = true ][, mixed $fallback = false ]) : mixed
Parameters
$size : mixed = 'original'
$showPlaceholder : mixed = true
$protocol : mixed = false
$useFirstImage : mixed = true
$fallback : mixed = false
Tags
since
5.0
access

public

getImageCaption()

Retrieve image caption

public getImageCaption() : mixed
Tags
since
5.2
access

public

getImageTitle()

Retrieve image title

public getImageTitle() : mixed
Tags
since
5.1
access

public

getInstantContent()

Retrieves the content of the Instant Article

public getInstantContent([mixed $triggerPlugin = true ]) : mixed
Parameters
$triggerPlugin : mixed = true
Tags
since
4.0
access

public

getIntro()

Get the intro text of the blog post

public getIntro([mixed $stripTags = false ][, mixed $truncate = null ][, mixed $source = 'intro' ][, mixed $limit = null ][, mixed $options = array() ]) : mixed
Parameters
$stripTags : mixed = false
$truncate : mixed = null
$source : mixed = 'intro'
$limit : mixed = null
$options : mixed = array()
Tags
since
5.1
access

public

getKeywords()

Retrieves a list of seo keywords for this post

public getKeywords() : mixed
Tags
since
5.0
access

public

getLatestDraftRevision()

Retrieves latest draft revision that are associated with this post

public getLatestDraftRevision() : mixed
Tags
since
5.1
access

public

getLocationImage()

Retrieve the location image

public getLocationImage() : mixed
Tags
since
5.0.37
access

public

getMedia()

retrieve media into post->media for easy reference.

public getMedia() : mixed
Tags
since
5.1
access

public

getMenuParams()

This method will intelligently determine which menu params this post should be inheriting from

public getMenuParams() : mixed
Tags
since
5.1
access

public

getModifiedDate()

Retrieves the modified date of the item

public getModifiedDate() : EasyBlogDate
Tags
since
5.0
access

public

Return values
EasyBlogDate

getPagePostTitle()

Get the page post title

public getPagePostTitle() : mixed
Tags
since
5.2.0
access

public

getParams()

Get params data

public getParams([mixed $useCache = true ]) : mixed
Parameters
$useCache : mixed = true
Tags
since
5.1
access

public

Retrieves the permalink for this blog post

public getPermalink([mixed $xhtml = true ][, mixed $external = false ][, mixed $format = null ][, mixed $routeSEF = true ]) : mixed
Parameters
$xhtml : mixed = true
$external : mixed = false
$format : mixed = null
$routeSEF : mixed = true
Tags
since
5.1.14
access

public

getPlainContent()

Retrieves the content of the blog post

public getPlainContent() : mixed
Tags
since
4.0
access

public

@return

getPostTemplateId()

Get its post template id

public getPostTemplateId() : mixed
Tags
since
5.4
access

public

getPreviewComments()

Retrieves preview comments for this post

public getPreviewComments([mixed $limit = null ]) : mixed
Parameters
$limit : mixed = null
Tags
since
5.0
access

public

Retrieves the preview link of the post

public getPreviewLink([mixed $xhtml = true ]) : mixed
Parameters
$xhtml : mixed = true
Tags
since
5.1
access

public

getPrimaryCategory()

Retrieves the primary category for this post

public getPrimaryCategory([mixed $forCurrentRevision = false ]) : mixed
Parameters
$forCurrentRevision : mixed = false
Tags
since
5.0
access

public

Retrieves the print link for a post

public getPrintLink() : mixed
Tags
since
5.0
access

public

getPublishDate()

Retrieves the published date of the item

public getPublishDate([mixed $withOffset = false ]) : mixed
Parameters
$withOffset : mixed = false
Tags
since
5.0
access

public

getRatings()

Retrieves the rating of the post

public getRatings() : mixed
Tags
since
5.0
access

public

getReactions()

Retrieves reaction data related to the current post

public getReactions() : mixed
Tags
since
5.1
access

public

getReadingTime()

Get estimate reading time for this blog

public getReadingTime([mixed $recalculate = null ]) : mixed
Parameters
$recalculate : mixed = null
Tags
since
5.2
access

public

getRegisteredSubscribers()

Retrieves a list of users that subscribed to this post

public getRegisteredSubscribers([mixed $type = 'new' ][, mixed $exclusion = array() ]) : mixed
Parameters
$type : mixed = 'new'
$exclusion : mixed = array()
Tags
since
5.0
access

public

Retrieve the reviewer's profile link of this blog post

public getReviewerLink() : mixed
Tags
since
6.0.10
access

public

getReviewerName()

Retrieve the reviewer's name of this blog post

public getReviewerName() : mixed
Tags
since
6.0.10
access

public

getRevisionCount()

Retrieves a list of categories associated with this blog post

public getRevisionCount([mixed $type = EASYBLOG_REVISION_DRAFT ]) : mixed
Parameters
$type : mixed = EASYBLOG_REVISION_DRAFT
Tags
since
4.0
access

public

getRevisions()

Retrieves all revisions that are associated with this post

public getRevisions([mixed $ordering = 'asc' ]) : mixed
Parameters
$ordering : mixed = 'asc'
Tags
since
5.1
access

public

Retrieve logo for schema

public getSchemaLogo() : mixed
Tags
since
5.2.7
access

public

getSubscribers()

Retrieves a list of subscribers for this particular post

public getSubscribers([mixed $excludeEmails = array() ]) : mixed
Parameters
$excludeEmails : mixed = array()
Tags
since
4.0
access

public

getTags()

Get a list of tag objects that are associated with this blog post.

public getTags() : array<string|int, mixed>
Tags
access

public

Return values
array<string|int, mixed>

An Array of TableTag objects.

getTeamAssociation()

Determines if the blog post is associated with a team

public getTeamAssociation() : mixed
Tags
since
4.0
access

public

getTitle()

Retrieves the title of the post

public getTitle() : mixed
Tags
since
5.1
access

public

getTotalComments()

Get total number of comments for this blog post

public getTotalComments() : mixed
Tags
since
5.1.8
access

public

getTotalWords()

Get total word use in this post

public getTotalWords([mixed $recalculate = null ]) : mixed
Parameters
$recalculate : mixed = null
Tags
since
5.2
access

public

getType()

Retrieves the post type

public getType() : mixed
Tags
since
5.0
access

public

getUid()

Retrieves the uid for this post

public getUid() : mixed
Tags
since
5.1
access

public

getUnpublishDate()

Retrieves the unpublished date of the item

public getUnpublishDate() : EasyBlogDate
Tags
since
5.0
access

public

Return values
EasyBlogDate

getVersion()

reassign blog author only.

public getVersion([mixed $format = 'short' ]) : mixed
Parameters
$format : mixed = 'short'
Tags
since
5.0
access

public

getWorkingRevision()

Retrieves the active revision for this post

public getWorkingRevision() : mixed
Tags
since
5.0
access

public

hasAuthorAlias()

Determines if the post has author alias

public hasAuthorAlias() : mixed
Tags
since
5.1
access

public

hasBlockType()

Determine the blog post has the type of block being mentioned

public hasBlockType(mixed $type) : mixed
Parameters
$type : mixed
Tags
since
5.4
access

public

hasChanged()

Determines if a property of the item has changed or not.

public hasChanged(mixed $prop) : mixed
Parameters
$prop : mixed
Tags
since
5.0
access

public

hasChanges()

Used in autosave and to determine if this post has changes or not before submit for saving.

public hasChanges(mixed $data) : mixed
Parameters
$data : mixed
Tags
since
5.0
access

public

hasError()

public hasError() : mixed

hasErrors()

public hasErrors() : mixed

hasImage()

Determines if this post has an image associated

public hasImage() : mixed
Tags
since
5.0
access

public

hasLocation()

Determines if the post has location

public hasLocation() : mixed
Tags
since
5.0
access

public

hasPinterest()

Determine if the blog content has pinterest block

public hasPinterest() : mixed
Tags
since
5.2.5
access

public

hasReadmore()

Determines if there is a readmore tag in this content

public hasReadmore() : mixed
Tags
since
5.0
access

public

hasRevisionWaitingForApproval()

Determines if this post has any revisions that is waiting for approval

public hasRevisionWaitingForApproval() : mixed
Tags
since
1.4
access

public

hasVoted()

Determines if the current visitor has voted on this item

public hasVoted([mixed $userId = null ]) : mixed
Parameters
$userId : mixed = null
Tags
since
5.0
access

public

hit()

Override functionality of JTable's hit method as we want to limit the hits based on the session.

public hit([mixed $pk = null ]) : mixed
Parameters
$pk : mixed = null
Tags
since
4.0
access

public

@return

initSaveOptions()

Init save options

public initSaveOptions([mixed $options = [] ]) : mixed
Parameters
$options : mixed = []
Tags
since
5.3
access

public

isAccessible()

Determines if the post is accessible by the current user viewing the post

public isAccessible() : mixed
Tags
since
5.0
access

public

isArchived()

Determines if the item is archived

public isArchived() : mixed
Tags
since
5.0
access

public

isAvailable()

Determines if the post is available or in other words, visible on the site.

public isAvailable() : mixed
Tags
since
5.0
access

public

isBackDated()

Determine if this is a backdate post

public isBackDated() : mixed
Tags
since
5.2
access

public

isBeingApproved()

Determines if this item is being approved by a moderator.

public isBeingApproved() : mixed
Tags
since
5.0
access

public

isBeingArchived()

Determines if the post is being archived

public isBeingArchived() : mixed
Tags
since
5.0
access

public

isBeingCreated()

Determines if the item is being created.

public isBeingCreated() : mixed
Tags
since
5.0
access

public

isBeingDrafted()

Determines if this post is being drafted

public isBeingDrafted() : mixed
Tags
since
5.0
access

public

isBeingPublished()

Determines if the post is being published on the site

public isBeingPublished() : mixed
Tags
since
5.0
access

public

isBeingRejected()

Determines if the post is being rejected

public isBeingRejected() : mixed
Tags
since
5.0
access

public

isBeingRepublished()

Determines if the post is being republished again.

public isBeingRepublished() : mixed
Tags
since
5.0
access

public

isBeingRestored()

Determines if the post is being trashed

public isBeingRestored() : mixed
Tags
since
5.0
access

public

isBeingScheduledForPublishing()

public isBeingScheduledForPublishing() : mixed
Tags
since
5.0
access

public

isBeingScheduledFromPending()

Determines if this item is being approved by a moderator if the original publish state is pending then become schedule state.

public isBeingScheduledFromPending() : mixed
Tags
since
5.0
access

public

isBeingSubmittedForApproval()

Determines if this current item is being submitted for approval

public isBeingSubmittedForApproval() : mixed
Tags
since
5.0
access

public

isBeingTrashed()

Determines if the post is being trashed

public isBeingTrashed() : mixed
Tags
since
5.0
access

public

isBeingUnpublished()

Determines if the post is being unpublished

public isBeingUnpublished() : mixed
Tags
since
5.0
access

public

isBlank()

When initiating a new post on the site the current publishing state of the blog post is blank

public isBlank() : mixed
Tags
since
5.0
access

public

isCurrent()

Determines if the current item that is being saved is on the same revision

public isCurrent() : mixed
Tags
since
5.0
access

public

isDraft()

Determines when a blog post is on the draft state

public isDraft() : mixed
Tags
since
5.0
access

public

isEB51()

public isEB51() : mixed

isEbd()

Determines if this is an 'ebd' post type

public isEbd() : mixed
Tags
since
5.0
access

public

isEmbedCover()

Determine if this has embed cover

public isEmbedCover() : mixed
Tags
since
6.0
access

public

isExternalImageCover()

Determine if this is an external image cover

public isExternalImageCover([mixed $cover = null ]) : mixed
Parameters
$cover : mixed = null
Tags
since
6.0.3
access

public

isFavourited()

Determine if user already favourited this post

public isFavourited([mixed $userId = null ]) : mixed
Parameters
$userId : mixed = null
Tags
since
5.2
access

public

isFeatured()

Determines if this post is featured

public isFeatured() : mixed
Tags
since
5.0
access

public

isFinalized()

Determines if the post is either published, scheduled or unpublished.

public isFinalized() : mixed
Tags
since
5.0
access

public

isFromFeed()

Determines if this post is from a feed

public isFromFeed() : mixed
Tags
since
5.0
access

public

isImageCover()

Determines if the cover for this post is an image

public isImageCover() : mixed
Tags
since
6.0.0
access

public

isLegacy()

Determines if this is a legacy post

public isLegacy() : mixed
Tags
since
5.0
access

public

isMine()

Determines if this post belongs to the current logged in user

public isMine() : mixed
Tags
since
5.0
access

public

isMobile()

Determines if this is a mobile layout

public isMobile() : mixed
Tags
since
5.1
access

public

isNew()

Determines if this is a new post

public isNew() : mixed
Tags
since
5.1
access

public

isNoLongerNew()

Determines if this post is no longer a new post.

public isNoLongerNew() : mixed
Tags
since
5.0
access

public

isPasswordProtected()

Determines if this post is password protected

public isPasswordProtected() : mixed
Tags
since
5.0
access

public

isPending()

Detmermines if the blog post is pending

public isPending() : mixed
Tags
since
5.0
access

public

isPostPublished()

Determines if the post item is published

public isPostPublished() : mixed
Tags
since
5.0
access

public

isPostTemplateLocked()

Determine whether its post template is locked or not

public isPostTemplateLocked() : mixed
Tags
since
5.4
access

public

isPostUnpublished()

Determines if the post item is published

public isPostUnpublished() : mixed
Tags
since
5.0
access

public

isPublished()

Determines if the blog post is published

public isPublished() : mixed
Tags
since
5.0
access

public

isReady()

Determines if the post's revision is finalized and also being used by the current post table.

public isReady() : mixed
Tags
since
5.0
access

public

isScheduled()

Determines if the blog post is scheduled to be published

public isScheduled() : mixed
Tags
since
5.0
access

public

isStandardSource()

Checks if this is a normal posting and is not related to an external or team source

public isStandardSource() : mixed
Tags
since
5.0
access

public

isTablet()

Determines if this is a tablet layout

public isTablet() : mixed
Tags
since
5.3
access

public

isTeamBlog()

check if this post is a teamblog post or not

public isTeamBlog() : mixed
Tags
since
5.0
access

public

isTeamBlogAdmin()

Determines if this post belongs to teamblog and the current logged in user is team admin

public isTeamBlogAdmin() : mixed
Tags
since
5.0
access

public

isTrashed()

Determines if the item is trashed

public isTrashed() : mixed
Tags
since
5.0
access

public

isUnderScheduled()

Determines if the blog post is scheduled to be published

public isUnderScheduled() : mixed
Tags
since
5.1
access

public

isUnpublished()

Determines if the blog post is unpublished on the site

public isUnpublished() : mixed
Tags
since
5.0
access

public

isVideoCover()

Determines if the cover for this post is a video

public isVideoCover() : mixed
Tags
since
6.0.0
access

public

load()

Loads a post item given the uid of the item.

public load(mixed $uid) : mixed

UID is a string representation of: <postId>.<revisionId>

Parameters
$uid : mixed
Tags
since
5.0
access

public

Given a permalink, find the post id and load the post.

public loadByPermalink(mixed $permalink) : mixed
Parameters
$permalink : mixed
Tags
since
5.0
access

public

loadFields()

Retrieves a list of fields

public loadFields() : mixed
Tags
since
5.0
access

public

loadLanguage()

Helper method to load language

public loadLanguage([mixed $admin = false ]) : mixed
Parameters
$admin : mixed = false
Tags
since
5.0
access

public

loadMeta()

Loads meta data about the post

public loadMeta() : mixed
Tags
since
5.0
access

public

loadPost()

Loads the JTable Post object

public loadPost(mixed $postId) : mixed
Parameters
$postId : mixed
Tags
since
5.0
access

public

loadRevision()

Loads a JTable Revision object

public static loadRevision(mixed $revisionId) : mixed
Parameters
$revisionId : mixed
Tags
since
5.0
access

public

lock()

Allows caller to lock a blog post

public lock() : mixed
Tags
since
4.0
access

public

move()

Moves the current blog post to a new category

public move(mixed $categoryId) : mixed
Parameters
$categoryId : mixed
Tags
since
5.0
access

public

normalize()

Normalize all posted / binded data.

public normalize() : mixed
Tags
since
5.0
access

public

normalizeAlias()

Normalize the alias of the blog post

public normalizeAlias() : mixed
Tags
since
5.0
access

public

normalizeAuthor()

Ensures that the author is set correctly.

public normalizeAuthor() : mixed
Tags
since
5.0
access

public

normalizeAutopostContent()

Normalize the autopost content

public normalizeAutopostContent(EasyBlogPost $post[, mixed $charLimit = 350 ][, mixed $contentSource = 'intro' ][, mixed $oauthClient = '' ]) : mixed
Parameters
$post : EasyBlogPost
$charLimit : mixed = 350
$contentSource : mixed = 'intro'
$oauthClient : mixed = ''
Tags
since
5.4.7
access

public

normalizeBlogImage()

Ensures that the blog image data is appropriate

public normalizeBlogImage() : mixed
Tags
since
5.0
access

public

Normalize the non sef link whether need to include the lang query string or not

public normalizeBlogPermalink() : mixed
Tags
since
5.4.5
access

public

normalizeCategories()

Normalize categories

public normalizeCategories() : mixed
Tags
since
5.0
access

public

normalizeContent()

Normalizes the content of the post by cleaning and filtering the html codes

public normalizeContent() : mixed
Tags
since
5.0
access

public

normalizeContentImage()

Process any base64 images within the content to actual image

public normalizeContentImage() : mixed
Tags
since
5.1
access

public

normalizeDate()

Ensures that all the dates associated with the post is set

public normalizeDate() : mixed
Tags
since
5.0
access

public

normalizeDocument()

Normalizes the document type.

public normalizeDocument() : mixed
Tags
since
5.0
access

public

normalizeFrontpage()

Ensures that the front page state is set correctly

public normalizeFrontpage() : mixed
Tags
since
5.0
access

public

normalizeNewState()

Normalizes the new state of the post

public normalizeNewState() : mixed
Tags
since
5.0
access

public

normalizeOthers()

Normalize other properties of the post

public normalizeOthers() : mixed
Tags
since
5.0
access

public

normalizePrivacy()

Normalizes the privacy state

public normalizePrivacy() : mixed
Tags
since
5.0
access

public

normalizePublishingState()

Normalizes the publishing states

public normalizePublishingState() : mixed
Tags
since
5.0
access

public

normalizeSource()

Normalize the source

public normalizeSource() : mixed
Tags
since
5.0
access

public

normalizeState()

Normalizes the state column

public normalizeState() : mixed
Tags
since
5.0
access

public

normalizeTags()

Ensures that all of the default tags are being assigned to the blog.

public normalizeTags() : mixed
Tags
since
5.0
access

public

normalizeTitle()

Normalizes the blog post's title.

public normalizeTitle() : mixed
Tags
since
5.0
access

public

notify()

Notify subscribers when a new blog post is published

public notify([mixed $underApproval = false ][, mixed $published = '1' ][, mixed $featured = false ][, mixed $approved = false ]) : mixed
Parameters
$underApproval : mixed = false
$published : mixed = '1'
$featured : mixed = false
$approved : mixed = false
Tags
since
5.1
access

public

parseUid()

Parses the UID <postId>.<revisionId> into an object

public static parseUid(mixed $uid) : mixed
Parameters
$uid : mixed
Tags
since
5.0
access

public

postSave()

Post processing when a blog post is saved

public postSave() : mixed
Tags
since
5.1
access

public

prepareContent()

Prepares the content before displaying it out.

public prepareContent([mixed $type = 'list' ][, mixed $source = 'content' ]) : mixed
Parameters
$type : mixed = 'list'
$source : mixed = 'content'
Tags
since
4.0
access

public

@return

preSave()

Before a blog post is stored, we want to perform specific operations here

public preSave() : mixed
Tags
since
5.0
access

public

processPostIntroContent()

public processPostIntroContent() : mixed

publish()

Publishes a blog post on the site.

public publish([mixed $options = [] ][, mixed $forceNotNew = false ]) : mixed
Parameters
$options : mixed = []
$forceNotNew : mixed = false
Tags
since
5.0
access

public

purgeRevisions()

Delete revisions other than the current associated revision.

public purgeRevisions([mixed $ignoreRevId = null ]) : mixed
Parameters
$ignoreRevId : mixed = null
Tags
since
5.1
access

public

reassignAuthor()

reassign blog author only.

public reassignAuthor(mixed $authorId) : mixed
Parameters
$authorId : mixed

reject()

Allows moderator to reject this post

public reject(mixed $message[, mixed $userId = null ]) : mixed
Parameters
$message : mixed
$userId : mixed = null
Tags
since
5.1
access

public

relocateMediaFiles()

Relocate media files into "My Media"

public relocateMediaFiles() : mixed
Tags
since
5.0
access

public

remove3rdPartyTags()

Remove known 3rd party tags from the content

public remove3rdPartyTags(mixed $content) : mixed
Parameters
$content : mixed
Tags
since
5.4.9
access

public

removeFeatured()

Removes this post as a featured post

public removeFeatured() : mixed
Tags
since
5.0
access

public

removeFrontpage()

Remove the post from the frontpage.

public removeFrontpage() : mixed
Tags
since
5.0
access

public

removeLoadmodulesTags()

Remove loadposition and loadmodules from the content

public removeLoadmodulesTags(mixed $content) : mixed
Parameters
$content : mixed
Tags
since
5.1
access

public

renderClassnames()

Generates a list of class names for composer

public renderClassnames([mixed $user = null ]) : mixed
Parameters
$user : mixed = null
Tags
since
5.0
access

public

renderEditorContent()

Used during post editing so we can render the necessary blocks

public renderEditorContent([mixed $postTemplateIsLocked = false ]) : mixed
Parameters
$postTemplateIsLocked : mixed = false
Tags
since
5.0
access

public

renderHeaders()

Initializes the header of the html page

public renderHeaders([mixed $options = array() ]) : mixed
Parameters
$options : mixed = array()
Tags
since
4.0
access

public

requiresLoginToRead()

Determines if the user needs to login to read the post.

public requiresLoginToRead() : mixed
Tags
since
5.0
access

public

resetHits()

Reset post hits

public resetHits() : mixed
Tags
since
5.0
access

public

restore()

Restore a blog post from the trash.

public restore([mixed $options = array() ]) : mixed
Parameters
$options : mixed = array()
Tags
since
5.1
access

public

restoreFromPost()

A special function used to bind various data from the form post.

public restoreFromPost(mixed $data) : mixed
Parameters
$data : mixed
Tags
since
5.1
access

public

save()

Saves a blog post on the site. This method ensures that all saving process goes through the same routine.

public save([mixed $options = [] ][, mixed $debug = false ]) : mixed
Parameters
$options : mixed = []
$debug : mixed = false
Tags
since
5.1
access

public

saveAssociation()

Saves the posts association

public saveAssociation() : mixed
Tags
since
5.0
access

public

saveCategories()

Save the categories associated with the post.

public saveCategories() : mixed
Tags
since
5.0
access

public

saveFields()

Saves the fields that are related to the blog post

public saveFields() : mixed
Tags
since
5.0
access

public

saveMeta()

Saves the meta data of the blog post.

public saveMeta() : mixed
Tags
since
5.0
access

public

saveParam()

Saves a key / value in the parameters of the post

public saveParam(mixed $key, mixed $value) : mixed
Parameters
$key : mixed
$value : mixed
Tags
since
5.4.7
access

public

savePost()

Saves the blog post

public savePost() : mixed
Tags
since
5.0
access

public

saveRelation()

Associates the post with a different source.

public saveRelation() : mixed

E.g: team blog, jomsocial group, jomsocial event

Tags
since
5.0
access

public

saveRevision()

Determines if the revision should be created as a new revision or update on existing revision.

public saveRevision() : mixed
Tags
since
5.0
access

public

@return

saveTags()

Saves the tags when the blog post is stored.

public saveTags() : mixed
Tags
since
5.0
access

public

setError()

public setError(mixed $msg) : mixed
Parameters
$msg : mixed

setFeatured()

Sets this post as a featured post

public setFeatured() : mixed
Tags
since
5.0
access

public

setFrontpage()

Set's the post to be available on the front page.

public setFrontpage() : mixed
Tags
since
5.0
access

public

setWorkbench()

Sets the workbench for this current instance

public setWorkbench(mixed $workbench) : mixed
Parameters
$workbench : mixed
Tags
since
5.0
access

public

toData()

Exports the post library to a standard object that can be sent back to the javascripts.

public toData() : mixed
Tags
since
5.0
access

public

toEmailData()

Exports the post library to email data

public toEmailData() : mixed
Tags
since
5.0
access

public

toParamsData()

Returns formatted params data

public toParamsData() : mixed
Tags
since
5.1
access

public

toPostData()

Returns the data of a post in a standard object

public toPostData() : mixed
Tags
since
5.0
access

public

toRevisionData()

Exports current properties of the post that should be inserted into the revision data.

public toRevisionData() : mixed
Tags
since
5.0
access

public

trash()

Archives a blog post on the site.

public trash() : mixed
Tags
since
5.0
access

public

triggerAfterSave()

Triggers plugins after a blog post is saved

public triggerAfterSave() : mixed
Tags
since
5.0
access

public

triggerBeforeSave()

Triggers plugins before a blog post is saved

public triggerBeforeSave() : mixed
Tags
since
5.0
access

public

unarchive()

Unarchives a blog post on the site.

public unarchive() : bool
Tags
since
5.0
access

public

Return values
bool

Determines if the storing state is success

unfavourite()

Remove this post from user's favourites list

public unfavourite([mixed $userId = null ]) : mixed
Parameters
$userId : mixed = null
Tags
since
5.2
access

public

unlock()

Allows caller to lock a blog post

public unlock() : mixed
Tags
since
4.0
access

public

unpublish()

Unpublishes a post

public unpublish([mixed $options = [] ]) : mixed
Parameters
$options : mixed = []
Tags
since
4.0
access

public

updateFeatured()

update post featured.

public updateFeatured() : mixed
Tags
since
5.1
access

public

updateParams()

Update neccessary params for this post.

public updateParams() : mixed
Tags
since
5.2
access

public

updateToRevision()

Switches the post to the revision

public updateToRevision() : mixed
Tags
since
5.0
access

public

usePostImage()

Determines if this post has an post's image in the content or not

public usePostImage([mixed $respectTruncation = true ]) : mixed
Parameters
$respectTruncation : mixed = true
Tags
since
5.1
access

public

useRevision()

Sets the revision id for the post

public useRevision() : mixed
Tags
since
5.0
access

public

validate()

Validates the current blog post

public validate() : mixed
Tags
since
5.0
access

public

validateAcl()

Check if user have permission to save the post

public validateAcl() : mixed
Tags
since
5.1
access

public

validateCategory()

Ensures that the post's category is accessible by category acl.

public validateCategory() : mixed
Tags
since
5.4
access

public

validateContent()

Validates the content and ensures that the content contains valid data.

public validateContent() : mixed
Tags
since
5.0
access

public

validateFields()

Validates the custom fields for this post

public validateFields() : mixed
Tags
since
5.0
access

public

validateMultilingualPostAccess()

Validate whether the current viewer can able to access this blog post under current site language

public validateMultilingualPostAccess(EasyBlogPost $post[, mixed $returnMsg = true ]) : mixed
Parameters
$post : EasyBlogPost
$returnMsg : mixed = true
Tags
since
5.4.0
access

public

validatePostCover()

Validate the post cover

public validatePostCover() : mixed
Tags
since
6.0.0
access

public

validatePostMenuItemAccess()

Validate if the current menu item is associated with the correct post.

public validatePostMenuItemAccess(mixed $menuItemId) : mixed
Parameters
$menuItemId : mixed
Tags
since
6.0.7
access

public

validateTitle()

Ensures that the post title is valid

public validateTitle() : mixed
Tags
since
5.0
access

public

verifyPassword()

Verifies a password

public verifyPassword() : mixed
Tags
since
5.0
access

public

renderPreviews()

process previews

private renderPreviews(mixed $data) : mixed
Parameters
$data : mixed
Tags
since
5.1
access

public


        
On this page

Search results