Documentation

EasyBlogModelBlog extends EasyBlogAdminModel
in package

Table of Contents

Properties

$_pagination  : mixed
$_total  : mixed
$searchables  : mixed

Methods

__construct()  : mixed
addBlogSubscription()  : mixed
aliasExists()  : mixed
Checks if
approveBlog()  : mixed
Use EasyBlogModelBlogs->approveBlog instead.
deleteUserPosts()  : mixed
Delete posts from particular user
getAssociationPosts()  : mixed
Retrieves a list of posts for post association
getBlogComment()  : mixed
Retrieves a list of comments from a blog post
getBlogNavigation()  : mixed
Generates the navigation data of a blog post
getBlogsBy()  : mixed
Get array of blogs defined by parameters
getCategoryName()  : mixed
getFeaturedBlog()  : mixed
Retrieves a list of featured posts from the site
getLatestPostByAuthor()  : mixed
Retrieves the latest post by author
getMetaId()  : mixed
Retrieves the meta id for a blog post
getMostCommentedPostByAuthor()  : mixed
Retrieves a list of most commented posts created by the author
getPagination()  : mixed
Method to get a pagination object for the categories
getPending()  : mixed
getPostNavigation()  : mixed
Retrieves the next post in line
getRelatedPosts()  : mixed
Retrieves posts that is related to the given blog post
getSearchableItems()  : mixed
Get searchable columns
getTaggedBlogs()  : mixed
Retrieves a list of blog posts associated with a particular tag
getTemplates()  : mixed
Retrieves a list of templates created by the user
getTotal()  : mixed
Method to get a pagination object for the categories
getTotalBlogs()  : mixed
Method to get total blogs post currently iregardless the status.
getTotalBlogSubscribers()  : mixed
getTotalHits()  : mixed
Computes the total number of hits for blog posts created by any specific user throughout the site.
getTotalModeration()  : mixed
Retrieves the total number of blog posts pending moderation
getTrackback()  : mixed
getTrashPosts()  : mixed
Retrieving posts in the trash
getUserPosts()  : mixed
Retrieves a list of posts created by the user
getUserStateFromRequest()  : mixed
Gets the value of a user state variable.
isBlogSubscribedEmail()  : mixed
isBlogSubscribedUser()  : mixed
isFeatured()  : mixed
Determines if the blog post is featured
normalizePermalink()  : mixed
Converts a string into a valid permalink
permalinkExists()  : mixed
Determines if the post's permalink exists on the site
updateBlogSubscriptionEmail()  : mixed
updateStreamContribution()  : mixed
Allow callers to update Easysocial stream contribution
updateStreamData()  : mixed
Update existing stream data if changed blog author and other
bindTable()  : mixed
implodeValues()  : mixed
populateState()  : void
Stock method to auto-populate the model state.

Properties

$_pagination

public mixed $_pagination = \null

$_total

public mixed $_total = \null

$searchables

public mixed $searchables = array()

Methods

__construct()

public __construct() : mixed

addBlogSubscription()

public addBlogSubscription(mixed $blogId, mixed $email[, mixed $userId = '0' ][, mixed $fullname = '' ]) : mixed
Parameters
$blogId : mixed
$email : mixed
$userId : mixed = '0'
$fullname : mixed = ''

aliasExists()

Checks if

public aliasExists(mixed $permalink, mixed $id) : mixed
Parameters
$permalink : mixed
$id : mixed
Tags
since
5.0
access

public

approveBlog()

Use EasyBlogModelBlogs->approveBlog instead.

public approveBlog(mixed $id) : mixed
Parameters
$id : mixed
Tags
access

public

deleteUserPosts()

Delete posts from particular user

public deleteUserPosts(mixed $userId) : mixed
Parameters
$userId : mixed
Tags
since
5.1.0
access

public

getAssociationPosts()

Retrieves a list of posts for post association

public getAssociationPosts([mixed $options = array() ]) : mixed
Parameters
$options : mixed = array()
Tags
since
5.4.5
access

public

getBlogComment()

Retrieves a list of comments from a blog post

public getBlogComment(mixed $id[, mixed $limitFrontEnd = 0 ][, mixed $sort = 'asc' ][, mixed $lite = false ][, mixed $options = array() ]) : mixed
Parameters
$id : mixed
$limitFrontEnd : mixed = 0
$sort : mixed = 'asc'
$lite : mixed = false
$options : mixed = array()
Tags
since
4.0
access

public

getBlogNavigation()

Generates the navigation data of a blog post

public getBlogNavigation(EasyBlogPost $post[, mixed $exclusion = [] ]) : mixed
Parameters
$post : EasyBlogPost
$exclusion : mixed = []
Tags
since
6.0.0
access

public

getBlogsBy()

Get array of blogs defined by parameters

public getBlogsBy(mixed $type[, mixed $typeId = 0 ][, mixed $sort = '' ][, mixed $max = 0 ][, mixed $published = EBLOG_FILTER_PUBLISHED ][, mixed $search = false ][, mixed $frontpage = false ][, mixed $excludeBlogs = array() ][, mixed $pending = false ][, mixed $dashboard = false ][, mixed $protected = true ][, mixed $excludeCats = array() ][, mixed $includeCats = array() ][, mixed $postType = null ][, mixed $limitType = 'listlength' ][, mixed $pinFeatured = true ][, mixed $includeAuthors = array() ][, mixed $excludeAuthors = array() ][, mixed $excludeFeatured = false ][, mixed $includeTags = array() ][, mixed $options = array() ]) : mixed
Parameters
$type : mixed

str

$typeId : mixed = 0

int

$sort : mixed = ''

str

$max : mixed = 0

int

$published : mixed = EBLOG_FILTER_PUBLISHED

str

$search : mixed = false

bool

$frontpage : mixed = false

bool

$excludeBlogs : mixed = array()

array

$pending : mixed = false

bool

$dashboard : mixed = false

bool

$protected : mixed = true

bool

$excludeCats : mixed = array()

array

$includeCats : mixed = array()

array

$postType : mixed = null
$limitType : mixed = 'listlength'
$pinFeatured : mixed = true
$includeAuthors : mixed = array()
$excludeAuthors : mixed = array()
$excludeFeatured : mixed = false
$includeTags : mixed = array()
$options : mixed = array()

getCategoryName()

public getCategoryName(mixed $category_id) : mixed
Parameters
$category_id : mixed

getFeaturedBlog()

Retrieves a list of featured posts from the site

public getFeaturedBlog([mixed $categories = array() ][, mixed $limit = null ]) : mixed
Parameters
$categories : mixed = array()
$limit : mixed = null
Tags
since
1.3
access

public

getLatestPostByAuthor()

Retrieves the latest post by author

public getLatestPostByAuthor([mixed $authorId = null ][, mixed $limit = 1 ]) : mixed
Parameters
$authorId : mixed = null
$limit : mixed = 1
Tags
since
4.0
access

public

getMetaId()

Retrieves the meta id for a blog post

public getMetaId(mixed $id) : mixed
Parameters
$id : mixed
Tags
since
5.0
access

public

getMostCommentedPostByAuthor()

Retrieves a list of most commented posts created by the author

public getMostCommentedPostByAuthor([mixed $authorId = null ][, mixed $limit = 5 ]) : mixed
Parameters
$authorId : mixed = null
$limit : mixed = 5
Tags
since
4.0
access

public

getPagination()

Method to get a pagination object for the categories

public getPagination() : mixed

getPending()

public getPending([mixed $typeId = 0 ][, mixed $sort = 'latest' ][, mixed $max = 0 ][, mixed $search = false ][, mixed $frontpage = false ]) : mixed
Parameters
$typeId : mixed = 0
$sort : mixed = 'latest'
$max : mixed = 0
$search : mixed = false
$frontpage : mixed = false

getPostNavigation()

Retrieves the next post in line

public getPostNavigation(EasyBlogPost $post, mixed $navigationType[, mixed $exclusion = array() ]) : mixed
Parameters
$post : EasyBlogPost
$navigationType : mixed
$exclusion : mixed = array()
Tags
since
5.0
access

public

getRelatedPosts()

Retrieves posts that is related to the given blog post

public getRelatedPosts(mixed $id[, mixed $max = 0 ][, mixed $behavior = 'tags' ][, mixed $categoryId = null ][, mixed $title = null ][, mixed $options = [] ]) : mixed
Parameters
$id : mixed
$max : mixed = 0
$behavior : mixed = 'tags'
$categoryId : mixed = null
$title : mixed = null
$options : mixed = []
Tags
since
5.0
access

public

getSearchableItems()

Get searchable columns

public getSearchableItems(mixed $query) : mixed
Parameters
$query : mixed
Tags
since
5.2.0
access

public

getTaggedBlogs()

Retrieves a list of blog posts associated with a particular tag

public getTaggedBlogs([mixed $tagId = 0 ][, mixed $limit = false ][, mixed $includeCatIds = '' ][, mixed $sorting = '' ][, mixed $excludeFeatured = false ][, mixed $options = array() ]) : mixed
Parameters
$tagId : mixed = 0
$limit : mixed = false
$includeCatIds : mixed = ''
$sorting : mixed = ''
$excludeFeatured : mixed = false
$options : mixed = array()
Tags
since
5.1
access

public

getTemplates()

Retrieves a list of templates created by the user

public getTemplates(mixed $userId) : mixed
Parameters
$userId : mixed
Tags
since
4.0
access

public

getTotal()

Method to get a pagination object for the categories

public getTotal() : mixed

getTotalBlogs()

Method to get total blogs post currently iregardless the status.

public getTotalBlogs([mixed $userId = 0 ]) : mixed
Parameters
$userId : mixed = 0

getTotalBlogSubscribers()

public getTotalBlogSubscribers([mixed $userId = 0 ]) : mixed
Parameters
$userId : mixed = 0

getTotalHits()

Computes the total number of hits for blog posts created by any specific user throughout the site.

public getTotalHits(mixed $userId) : mixed
Parameters
$userId : mixed
Tags
since
5.1
access

public

getTotalModeration()

Retrieves the total number of blog posts pending moderation

public getTotalModeration() : mixed
Tags
since
4.0
access

public

getTrackback()

public getTrackback(mixed $blogId) : mixed
Parameters
$blogId : mixed

getTrashPosts()

Retrieving posts in the trash

public getTrashPosts([mixed $userId = 0 ][, mixed $sort = 'latest' ][, mixed $max = 0 ][, mixed $search = false ][, mixed $frontpage = false ]) : mixed
Parameters
$userId : mixed = 0
$sort : mixed = 'latest'
$max : mixed = 0
$search : mixed = false
$frontpage : mixed = false
Tags
since
5.1
access

public

@return

getUserPosts()

Retrieves a list of posts created by the user

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

public

getUserStateFromRequest()

Gets the value of a user state variable.

public getUserStateFromRequest(mixed $key, mixed $request[, mixed $default = null ][, mixed $type = 'none' ]) : mixed
Parameters
$key : mixed
$request : mixed
$default : mixed = null
$type : mixed = 'none'

isBlogSubscribedEmail()

public isBlogSubscribedEmail(mixed $blogId, mixed $email) : mixed
Parameters
$blogId : mixed
$email : mixed

isBlogSubscribedUser()

public isBlogSubscribedUser(mixed $blogId, mixed $userId, mixed $email) : mixed
Parameters
$blogId : mixed
$userId : mixed
$email : mixed

isFeatured()

Determines if the blog post is featured

public isFeatured(mixed $id) : mixed
Parameters
$id : mixed
Tags
since
4.0
access

public

Converts a string into a valid permalink

public normalizePermalink(mixed $string[, mixed $postId = null ]) : mixed
Parameters
$string : mixed
$postId : mixed = null
Tags
since
5.0
access

public

permalinkExists()

Determines if the post's permalink exists on the site

public permalinkExists(mixed $permalink[, mixed $postId = null ]) : mixed
Parameters
$permalink : mixed
$postId : mixed = null
Tags
since
5.0
access

public

updateBlogSubscriptionEmail()

public updateBlogSubscriptionEmail(mixed $sid, mixed $userid, mixed $email) : mixed
Parameters
$sid : mixed
$userid : mixed
$email : mixed

updateStreamContribution()

Allow callers to update Easysocial stream contribution

public updateStreamContribution(mixed $streamIds, mixed $contribution, mixed $blog[, mixed $hasUpdatedAuthor = false ][, mixed $contextType = 'blog' ]) : mixed
Parameters
$streamIds : mixed
$contribution : mixed
$blog : mixed
$hasUpdatedAuthor : mixed = false
$contextType : mixed = 'blog'
Tags
since
5.2
access

public

updateStreamData()

Update existing stream data if changed blog author and other

public updateStreamData(mixed $streamIds, mixed $blog[, mixed $contextType = 'blog' ]) : mixed
Parameters
$streamIds : mixed
$blog : mixed
$contextType : mixed = 'blog'
Tags
since
5.2.10
access

public

bindTable()

protected bindTable(mixed $tableName, mixed $result) : mixed
Parameters
$tableName : mixed
$result : mixed

implodeValues()

protected implodeValues(mixed $data) : mixed
Parameters
$data : mixed

populateState()

Stock method to auto-populate the model state.

protected populateState() : void
Tags
since
12.2

        
On this page

Search results