Documentation

EasyBlogTableCategory extends EasyBlogTable
in package

Table of Contents

Properties

$alias  : mixed
$autopost  : mixed
$avatar  : mixed
$created  : mixed
$created_by  : mixed
$default  : mixed
$description  : mixed
$id  : mixed
$language  : mixed
$level  : mixed
$lft  : mixed
$ordering  : mixed
$params  : mixed
$parent_id  : mixed
$private  : mixed
$published  : mixed
$repost_autoposting  : mixed
$repost_autoposting_interval  : mixed
$rgt  : mixed
$status  : mixed
$theme  : mixed
$title  : mixed
$_supportNullValue  : mixed

Methods

__construct()  : mixed
addMeta()  : mixed
add / update meta for category
afterSave()  : mixed
Run tasks after saving a category
aliasExists()  : mixed
Determines if an alias already exists
bind()  : mixed
Overrides parent's bind method
bindCustomFieldGroup()  : mixed
Bind custom field group to the category
canDelete()  : mixed
Determine if the category can be deleted from the site
checkPrivacy()  : mixed
delete()  : bool
Overrides parent's delete method to add our own logic.
deleteACL()  : mixed
For categories acl to delete the category acl settings.
duplicate()  : mixed
Duplicate the current category
generateDefaultParams()  : mixed
Generates a default params for the category
getActiveAuthors()  : mixed
Retrieve a list of active authors for this category
getActiveAuthorsCount()  : mixed
Retrieve list of count on active authors for this category
getActiveBloggers()  : mixed
Deprecated. Use @getActiveAuthors() instead
getAlias()  : mixed
Retrieves alias for the category
getAtom()  : mixed
getAvatar()  : mixed
Retrieve categories avatar
getChildCount()  : mixed
Retrieves the total number of subcategories this category has.
getCount()  : mixed
Retrieves the total number of posts in this category
getCustomFieldGroup()  : mixed
Retrieves the custom field group for this category
getCustomFields()  : mixed
Retrieves custom fields for this category
getDBO()  : mixed
Retrieves the database object
getDefaultParams()  : mixed
Retrieve a list of tags that is associated with this category
getDefaultPostCover()  : mixed
Retrieve categories default post cover
getDefaultTags()  : mixed
Retrieve a list of tags that is associated with this category
getDescription()  : mixed
Retrieves description of the category
getEditPermalink()  : mixed
Retrieves category dashbaord edit link.
getExternalPermalink()  : mixed
Retrieves the external permalink for this blog post
getGroupAssignedACL()  : mixed
For categories acl that have group assigned permissions.
getInstance()  : mixed
Tired of fixing conflicts with JTable::getInstance . We'll overload their method here.
getLeft()  : mixed
getMenuParams()  : mixed
Retrieves the parameters for the menu
getMetaId()  : mixed
getOrdering()  : mixed
getParam()  : mixed
Retrieve a specific parameter value
getParams()  : mixed
Generic method to retrive raw json params from the table
getParent()  : mixed
Retrieves the parent category
getPermalink()  : mixed
Retrieves the permalink for this category
getPostCount()  : mixed
Use getCount instead
getRSS()  : mixed
Retrieve rss link for the category
getRssLink()  : mixed
Retrieves rss link for the category
getTitle()  : mixed
Retrieves the translated title
getUniqueAlias()  : mixed
Retrieves a unique alias for the category
getUserAssignedACL()  : mixed
For categories that have user assigned permissions instead of user groups
hasCustomFields()  : mixed
Determines if there are any fields binded to the category
isDefault()  : mixed
Determines if this category is the default category
isNotAssigned()  : mixed
Determines if this category is the public category
isPrimary()  : mixed
Determines if this category is the primary category for the blog post
isPublished()  : mixed
Determines if this category is published or not
move()  : mixed
moveLftToLastOf()  : bool
Update the lft value to a particular parent's lft
normalizeCatPermalink()  : mixed
Normalize the non sef link whether need to include the lang query string or not
rebuildOrdering()  : mixed
removeACL()  : bool
Remove associated ACL items for this category
removeAvatar()  : mixed
Removes a category avatar
removeFieldGroup()  : mixed
Bind custom field group to the category
removePostCover()  : mixed
Remove category default post cover
reset()  : void
Method to reset class properties to the defaults set in the class definition. It will ignore the primary key as well as any private class properties.
saveACL()  : mixed
For categories acl to resave the category acl settings.
saveDefaultPostCover()  : mixed
Method to save the default cover for the posts of the category
setDefault()  : mixed
Sets this category as the default category
store()  : mixed
Override parent's implementation of store
toArray()  : mixed
Converts a table layer into an array
updateLeft()  : mixed
updateOrdering()  : mixed
updateRight()  : mixed
uploadAvatar()  : mixed
Allows caller to upload an avatar

Properties

$autopost

public mixed $autopost = \null

$created_by

public mixed $created_by = \null

$description

public mixed $description = \null

$ordering

public mixed $ordering = \null

$parent_id

public mixed $parent_id = \null

$published

public mixed $published = \null

$repost_autoposting

public mixed $repost_autoposting = \null

$repost_autoposting_interval

public mixed $repost_autoposting_interval = \null

$_supportNullValue

protected mixed $_supportNullValue = true

Methods

__construct()

public __construct(mixed &$db) : mixed
Parameters
$db : mixed

addMeta()

add / update meta for category

public addMeta() : mixed
Tags
since
5.4
access

public

afterSave()

Run tasks after saving a category

public afterSave() : mixed
Tags
since
6.0.0
access

public

aliasExists()

Determines if an alias already exists

public aliasExists([mixed $alias = '' ]) : mixed
Parameters
$alias : mixed = ''
Tags
since
5.1
access

public

bind()

Overrides parent's bind method

public bind(mixed $data[, mixed $ignore = [] ]) : mixed
Parameters
$data : mixed
$ignore : mixed = []
Tags
since
5.0
access

public

bindCustomFieldGroup()

Bind custom field group to the category

public bindCustomFieldGroup([mixed $groupId = '' ]) : mixed
Parameters
$groupId : mixed = ''
Tags
since
4.0
access

public

canDelete()

Determine if the category can be deleted from the site

public canDelete() : mixed
Tags
since
5.1
access

public

checkPrivacy()

public checkPrivacy() : mixed

delete()

Overrides parent's delete method to add our own logic.

public delete([mixed $pk = null ]) : bool
Parameters
$pk : mixed = null
Return values
bool

deleteACL()

For categories acl to delete the category acl settings.

public deleteACL([mixed $aclId = '' ]) : mixed
Parameters
$aclId : mixed = ''
Tags
since
5.4.0
access

public

duplicate()

Duplicate the current category

public duplicate() : mixed
Tags
since
5.1
access

public

generateDefaultParams()

Generates a default params for the category

public generateDefaultParams([mixed $additionalParams = [] ]) : mixed
Parameters
$additionalParams : mixed = []
Tags
since
6.0.0
access

public

getActiveAuthors()

Retrieve a list of active authors for this category

public getActiveAuthors() : mixed
Tags
since
4.0
access

public

getActiveAuthorsCount()

Retrieve list of count on active authors for this category

public getActiveAuthorsCount() : mixed
Tags
since
5.2
access

public

getActiveBloggers()

Deprecated. Use @getActiveAuthors() instead

public getActiveBloggers() : mixed

getAlias()

Retrieves alias for the category

public getAlias() : mixed
Tags
since
5.0
access

public

getAvatar()

Retrieve categories avatar

public getAvatar() : mixed
Tags
since
4.0
access

public

getChildCount()

Retrieves the total number of subcategories this category has.

public getChildCount([mixed $includePermission = false ]) : mixed
Parameters
$includePermission : mixed = false
Tags
since
5.0
access

public

getCount()

Retrieves the total number of posts in this category

public getCount([mixed $bloggerId = '' ]) : mixed
Parameters
$bloggerId : mixed = ''
Tags
since
4.0
access

public

getCustomFieldGroup()

Retrieves the custom field group for this category

public getCustomFieldGroup() : mixed
Tags
since
4.0
access

public

Return values
mixed —

false if category is not associated with the group

getCustomFields()

Retrieves custom fields for this category

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

public

getDBO()

Retrieves the database object

public getDBO() : mixed
Tags
since
6.0.0
access

public

getDefaultParams()

Retrieve a list of tags that is associated with this category

public getDefaultParams() : mixed
Tags
since
5.0
access

public

getDefaultPostCover()

Retrieve categories default post cover

public getDefaultPostCover([mixed $root = true ][, mixed $preventCache = false ]) : mixed
Parameters
$root : mixed = true
$preventCache : mixed = false
Tags
since
6.0.0
access

public

getDefaultTags()

Retrieve a list of tags that is associated with this category

public getDefaultTags() : mixed
Tags
since
5.0
access

public

getDescription()

Retrieves description of the category

public getDescription() : mixed
Tags
since
5.4.9
access

public

getEditPermalink()

Retrieves category dashbaord edit link.

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

public

getExternalPermalink()

Retrieves the external permalink for this blog post

public getExternalPermalink([mixed $format = null ][, mixed $withlimitstart = false ]) : mixed
Parameters
$format : mixed = null
$withlimitstart : mixed = false
Tags
since
5.1
access

public

getGroupAssignedACL()

For categories acl that have group assigned permissions.

public getGroupAssignedACL() : mixed
Tags
since
5.4.0
access

public

getInstance()

Tired of fixing conflicts with JTable::getInstance . We'll overload their method here.

public static getInstance(string $type[, string $prefix = 'JTable' ][, array<string|int, mixed> $config = [] ]) : mixed
Parameters
$type : string

The type (name) of the JTable class to get an instance of.

$prefix : string = 'JTable'

An optional prefix for the table class name.

$config : array<string|int, mixed> = []

An optional array of configuration values for the JTable object.

Tags
link
http://docs.joomla.org/JTable/getInstance
since
11.1
Return values
mixed —

A JTable object if found or boolean false if one could not be found.

getLeft()

public getLeft([mixed $parent = 0 ]) : mixed
Parameters
$parent : mixed = 0

getMenuParams()

Retrieves the parameters for the menu

public getMenuParams() : mixed
Tags
since
5.0
access

public

getMetaId()

public getMetaId() : mixed

getOrdering()

public getOrdering([mixed $parent = 0 ]) : mixed
Parameters
$parent : mixed = 0

getParam()

Retrieve a specific parameter value

public getParam(mixed $key[, mixed $default = null ]) : mixed
Parameters
$key : mixed
$default : mixed = null
Tags
since
4.0
access

public

getParams()

Generic method to retrive raw json params from the table

public final getParams() : mixed
Tags
since
1.1.0
access

public

getParent()

Retrieves the parent category

public getParent() : mixed
Tags
since
5.4.7
access

public

getPermalink()

Retrieves the permalink for this category

public getPermalink([mixed $xhtml = true ]) : mixed
Parameters
$xhtml : mixed = true
Tags
since
4.0
access

public

getPostCount()

Use getCount instead

public getPostCount() : mixed
Tags
access

public

getRSS()

Retrieve rss link for the category

public getRSS() : mixed

getRssLink()

Retrieves rss link for the category

public getRssLink() : mixed
Tags
since
4.0
access

public

getTitle()

Retrieves the translated title

public getTitle() : mixed
Tags
since
1.1.0
access

public

getUniqueAlias()

Retrieves a unique alias for the category

public getUniqueAlias([mixed $alias = '' ]) : mixed
Parameters
$alias : mixed = ''
Tags
since
5.1
access

public

getUserAssignedACL()

For categories that have user assigned permissions instead of user groups

public getUserAssignedACL() : mixed
Tags
since
5.4.0
access

public

hasCustomFields()

Determines if there are any fields binded to the category

public hasCustomFields() : mixed
Tags
since
5.0
access

public

isDefault()

Determines if this category is the default category

public isDefault() : mixed
Tags
since
5.0
access

public

isNotAssigned()

Determines if this category is the public category

public isNotAssigned() : mixed
Tags
since
5.0
access

public

isPrimary()

Determines if this category is the primary category for the blog post

public isPrimary() : mixed
Tags
since
4.0
access

public

isPublished()

Determines if this category is published or not

public isPublished() : mixed
Tags
since
5.4.7
access

public

move()

public move(mixed $direction[, mixed $where = '' ]) : mixed
Parameters
$direction : mixed
$where : mixed = ''

moveLftToLastOf()

Update the lft value to a particular parent's lft

public moveLftToLastOf(mixed $parentId) : bool
Parameters
$parentId : mixed
Return values
bool

normalizeCatPermalink()

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

public normalizeCatPermalink() : mixed
Tags
since
5.4.9
access

public

rebuildOrdering()

public rebuildOrdering([mixed $parentId = null ][, mixed $leftId = 0 ]) : mixed
Parameters
$parentId : mixed = null
$leftId : mixed = 0

removeACL()

Remove associated ACL items for this category

public removeACL() : bool
Tags
since
5.0
Return values
bool

removeAvatar()

Removes a category avatar

public removeAvatar([mixed $update = false ]) : mixed
Parameters
$update : mixed = false
Tags
since
5.0
access

public

removeFieldGroup()

Bind custom field group to the category

public removeFieldGroup() : mixed
Tags
since
4.0
access

public

removePostCover()

Remove category default post cover

public removePostCover([mixed $update = false ]) : mixed
Parameters
$update : mixed = false
Tags
since
6.0.0
access

public

reset()

Method to reset class properties to the defaults set in the class definition. It will ignore the primary key as well as any private class properties.

public reset() : void
Tags
link
http://docs.joomla.org/JTable/reset
since
11.1

saveACL()

For categories acl to resave the category acl settings.

public saveACL(mixed $post) : mixed
Parameters
$post : mixed
Tags
since
5.4.0
access

public

saveDefaultPostCover()

Method to save the default cover for the posts of the category

public saveDefaultPostCover(mixed $file) : mixed
Parameters
$file : mixed
Tags
since
6.0.0
access

public

setDefault()

Sets this category as the default category

public setDefault() : mixed
Tags
since
5.0
access

public

store()

Override parent's implementation of store

public store([mixed $updateNulls = false ]) : mixed
Parameters
$updateNulls : mixed = false
Tags
since
4.0
access

public

toArray()

Converts a table layer into an array

public toArray() : mixed
Tags
since
1.1.0
access

public

updateLeft()

public updateLeft(mixed $left[, mixed $limit = 0 ]) : mixed
Parameters
$left : mixed
$limit : mixed = 0

updateOrdering()

public updateOrdering() : mixed

updateRight()

public updateRight(mixed $right[, mixed $limit = 0 ]) : mixed
Parameters
$right : mixed
$limit : mixed = 0

uploadAvatar()

Allows caller to upload an avatar

public uploadAvatar([mixed $inputName = 'Filedata' ]) : mixed
Parameters
$inputName : mixed = 'Filedata'
Tags
since
6.0.0
access

public


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results