[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/components/com_contact/src/Model/ -> CategoryModel.php (summary)

(no description)

Copyright: (C) 2006 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 481 lines (15 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

CategoryModel:: (11 methods):
  __construct()
  getItems()
  getListQuery()
  populateState()
  getCategory()
  getParent()
  getLeftSibling()
  getRightSibling()
  getChildren()
  getSlugColumn()
  hit()


Class: CategoryModel  - X-Ref

Single item model for a contact

__construct($config = array()   X-Ref
Constructor.

param: array  $config  An optional associative array of configuration settings.

getItems()   X-Ref
Method to get a list of items.

return: mixed  An array of objects on success, false on failure.

getListQuery()   X-Ref
Method to build an SQL query to load the list data.

return: \Joomla\Database\DatabaseQuery    An SQL query

populateState($ordering = null, $direction = null)   X-Ref
Method to auto-populate the model state.

Note. Calling getState in this method will result in recursion.

param: string  $ordering   An optional ordering field.
param: string  $direction  An optional direction (asc|desc).
return: void

getCategory()   X-Ref
Method to get category data for the current category

return: object  The category object

getParent()   X-Ref
Get the parent category.

return: mixed  An array of categories or false if an error occurs.

getLeftSibling()   X-Ref
Get the sibling (adjacent) categories.

return: mixed  An array of categories or false if an error occurs.

getRightSibling()   X-Ref
Get the sibling (adjacent) categories.

return: mixed  An array of categories or false if an error occurs.

getChildren()   X-Ref
Get the child categories.

return: mixed  An array of categories or false if an error occurs.

getSlugColumn($query, $id, $alias)   X-Ref
Generate column expression for slug or catslug.

param: \Joomla\Database\DatabaseQuery  $query  Current query instance.
param: string                          $id     Column id name.
param: string                          $alias  Column alias name.
return: string

hit($pk = 0)   X-Ref
Increment the hit counter for the category.

param: integer  $pk  Optional primary key of the category to increment.
return: boolean  True if successful; false otherwise and internal error set.



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer