Documentation

EasyBlogModelCategories extends EasyBlogAdminModel
in package

Table of Contents

Properties

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

Methods

__construct()  : mixed
_buildQuery()  : mixed
Method to build the query for the tags
_buildQueryByBlogger()  : mixed
Get categories for the dashboard
_buildQueryOrderBy()  : mixed
Internal function to build query
_buildQueryWhere()  : mixed
Internal function to build query's where condition
deleteAssociation()  : mixed
Removes any association of a blog post with a category
getBlogCategories()  : mixed
Retrieves the list of categories associated with a particular blog post
getCategoriesByBlogger()  : mixed
Retrieves a list of categories created by a specific author.
getCategoriesForFilters()  : mixed
Retrieves a list of categories used for search filter
getCategoriesHierarchy()  : mixed
Retrieve category hierachy
getCategoriesUsedByBlogger()  : mixed
Retrieves a list of categories created by a specific author.
getCategoryTree()  : mixed
Retrieve categories hierary
getChildCategories()  : mixed
Retrieves the child categories of a parent category
getChildCount()  : mixed
Retrieve category child count.
getCustomFieldGroup()  : mixed
Retrieves the custom field group properties
getCustomFields()  : mixed
Retrieves the custom fields
getData()  : mixed
Method to get categories item data
getImmediateChildCategories()  : mixed
Retrieve the immediate category hierary of a parent category
getMissingMetaCategories()  : mixed
Method to retrive those category which missing category meta data.
getPagination()  : mixed
Method to get a pagination object for the categories
getPaginationByBlogger()  : mixed
Retrieves the pagination by blogger
getParams()  : mixed
Retrieves the category params
getParentCategories()  : mixed
Retrieves a list of parent categories from the site
getPrimaryCategory()  : mixed
Retrieves the primary category for the blog post
getPrivateCategories()  : mixed
Retrieve all private categories.
getSearchableItems()  : mixed
Get searchable columns
getTotal()  : mixed
Method to get the total nr of the categories
getTotalByBlogger()  : mixed
Retrieves the total category by blogger
getUsedCount()  : mixed
Returns the number of blog entries created within this category.
getUserStateFromRequest()  : mixed
Gets the value of a user state variable.
preload()  : mixed
This method reduces the number of query hit on the server
preloadActiveAuthors()  : mixed
Preload authors
preloadActiveAuthorsCount()  : mixed
Preload authors count
preloadCategoryChilds()  : mixed
This method reduces the number of query hit on the server
preloadPosts()  : mixed
This method reduces the number of query hit on the server
preloadUserSubscription()  : mixed
This method reduces the number of query hit on the server
publish()  : mixed
Method to publish or unpublish categories
searchCategories()  : mixed
Search category
bindTable()  : mixed
implodeValues()  : mixed
populateState()  : void
Stock method to auto-populate the model state.

Properties

$searchables

public mixed $searchables = array()

$_pagination

protected mixed $_pagination = \null

Methods

_buildQuery()

Method to build the query for the tags

public _buildQuery() : mixed
Tags
since
4.0
access

public

_buildQueryByBlogger()

Get categories for the dashboard

public _buildQueryByBlogger([mixed $bloggerId = 0 ][, mixed $ordering = '' ][, mixed $search = '' ][, mixed $limit = null ]) : mixed
Parameters
$bloggerId : mixed = 0
$ordering : mixed = ''
$search : mixed = ''
$limit : mixed = null
Tags
since
5.1
access

public

_buildQueryOrderBy()

Internal function to build query

public _buildQueryOrderBy() : mixed
Tags
since
4.0
access

public

_buildQueryWhere()

Internal function to build query's where condition

public _buildQueryWhere() : mixed
Tags
since
4.0
access

public

deleteAssociation()

Removes any association of a blog post with a category

public deleteAssociation(mixed $blogId) : mixed
Parameters
$blogId : mixed
Tags
since
4.0
access

public

getBlogCategories()

Retrieves the list of categories associated with a particular blog post

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

public

getCategoriesByBlogger()

Retrieves a list of categories created by a specific author.

public getCategoriesByBlogger([mixed $id = 0 ][, mixed $ordering = '' ][, mixed $search = '' ][, mixed $limit = null ]) : mixed
Parameters
$id : mixed = 0
$ordering : mixed = ''
$search : mixed = ''
$limit : mixed = null
Tags
since
4.0
access

public

getCategoriesForFilters()

Retrieves a list of categories used for search filter

public getCategoriesForFilters([mixed $parentId = null ]) : mixed
Parameters
$parentId : mixed = null
Tags
since
6.0
access

public

getCategoriesHierarchy()

Retrieve category hierachy

public getCategoriesHierarchy([mixed $useLimit = true ]) : mixed
Parameters
$useLimit : mixed = true
Tags
since
5.0
access

public

getCategoriesUsedByBlogger()

Retrieves a list of categories created by a specific author.

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

public

getCategoryTree()

Retrieve categories hierary

public getCategoryTree([mixed $sort = 'latest' ]) : mixed
Parameters
$sort : mixed = 'latest'
Tags
since
5.0
access

public

getChildCategories()

Retrieves the child categories of a parent category

public getChildCategories(mixed $parentId[, mixed $isPublishedOnly = false ][, mixed $isFrontendWrite = false ][, mixed $exclusion = array() ]) : mixed
Parameters
$parentId : mixed
$isPublishedOnly : mixed = false
$isFrontendWrite : mixed = false
$exclusion : mixed = array()
Tags
since
4.0
access

public

getChildCount()

Retrieve category child count.

public getChildCount(mixed $categoryId[, mixed $published = false ]) : mixed
Parameters
$categoryId : mixed
$published : mixed = false
Tags
since
4.0
access

public

getCustomFieldGroup()

Retrieves the custom field group properties

public getCustomFieldGroup(mixed $id[, mixed $type = 'write' ]) : mixed
Parameters
$id : mixed
$type : mixed = 'write'
Tags
since
4.0
access

public

getCustomFields()

Retrieves the custom fields

public getCustomFields(mixed $id[, mixed $type = 'write' ]) : mixed
Parameters
$id : mixed
$type : mixed = 'write'
Tags
since
4.0
access

public

getData()

Method to get categories item data

public getData([mixed $usePagination = true ]) : mixed
Parameters
$usePagination : mixed = true
Tags
since
4.0
access

public

getImmediateChildCategories()

Retrieve the immediate category hierary of a parent category

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

public

getMissingMetaCategories()

Method to retrive those category which missing category meta data.

public getMissingMetaCategories() : mixed
Tags
since
6.0.7
access

public

getPagination()

Method to get a pagination object for the categories

public getPagination() : mixed
Tags
since
4.0
access

public

getPaginationByBlogger()

Retrieves the pagination by blogger

public getPaginationByBlogger([mixed $bloggerId = 0 ][, mixed $search = '' ]) : mixed
Parameters
$bloggerId : mixed = 0
$search : mixed = ''
Tags
since
4.0
access

public

getParams()

Retrieves the category params

public getParams() : mixed
Tags
since
4.0
access

public

getParentCategories()

Retrieves a list of parent categories from the site

public getParentCategories(mixed $contentId[, mixed $type = 'all' ][, mixed $isPublishedOnly = false ][, mixed $isFrontendWrite = false ][, mixed $exclusion = array() ][, mixed $debug = false ]) : mixed
Parameters
$contentId : mixed
$type : mixed = 'all'
$isPublishedOnly : mixed = false
$isFrontendWrite : mixed = false
$exclusion : mixed = array()
$debug : mixed = false
Tags
since
5.4.0
access

public

getPrimaryCategory()

Retrieves the primary category for the blog post

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

public

getPrivateCategories()

Retrieve all private categories.

public getPrivateCategories() : mixed
Tags
since
4.0
access

public

getSearchableItems()

Get searchable columns

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

public

getTotal()

Method to get the total nr of the categories

public getTotal() : mixed
Tags
since
4.0
access

public

getTotalByBlogger()

Retrieves the total category by blogger

public getTotalByBlogger([mixed $bloggerId = 0 ][, mixed $search = '' ]) : mixed
Parameters
$bloggerId : mixed = 0
$search : mixed = ''
Tags
since
4.0
access

public

getUsedCount()

Returns the number of blog entries created within this category.

public getUsedCount(mixed $categoryId[, mixed $published = false ]) : mixed
Parameters
$categoryId : mixed
$published : mixed = false
Tags
since
4.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'

preload()

This method reduces the number of query hit on the server

public preload([mixed $postIds = array() ]) : mixed
Parameters
$postIds : mixed = array()
Tags
since
5.0
access

public

preloadActiveAuthors()

Preload authors

public preloadActiveAuthors(mixed $catIds) : mixed
Parameters
$catIds : mixed
Tags
since
4.0
access

public

preloadActiveAuthorsCount()

Preload authors count

public preloadActiveAuthorsCount(mixed $catIds) : mixed
Parameters
$catIds : mixed
Tags
since
5.2
access

public

preloadCategoryChilds()

This method reduces the number of query hit on the server

public preloadCategoryChilds(mixed $catIds) : mixed
Parameters
$catIds : mixed
Tags
since
5.0
access

public

preloadPosts()

This method reduces the number of query hit on the server

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

public

preloadUserSubscription()

This method reduces the number of query hit on the server

public preloadUserSubscription(mixed $catIds, mixed $email) : mixed
Parameters
$catIds : mixed
$email : mixed
Tags
since
5.0
access

public

publish()

Method to publish or unpublish categories

public publish(mixed &$categories[, mixed $publish = 1 ]) : mixed
Parameters
$categories : mixed
$publish : mixed = 1
Tags
since
4.0
access

public

searchCategories()

Search category

public searchCategories(mixed $keyword[, mixed $options = array() ]) : mixed
Parameters
$keyword : mixed
$options : mixed = array()
Tags
since
5.0
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