PHPBoost Framework A.P.I.

CategoriesManager

Package: Content\Category Copyright: © 2005-2019 PHPBoost License: GNU/GPL-3.0 Author: Kevin MASSY reidlos@phpboost.com Version: PHPBoost 5.2 - last update: 2016 10 24 Since: PHPBoost 4.0 - 2013 01 29 Contributor: Julien BRISWALTER j1.seth@phpboost.com Contributor: Arnaud GENET elenwii@phpboost.com Located at: content/category/CategoriesManager.class.php

This class allows you to easily integrate a complete system of categories in its script. It needs to have its first instantiation of a parameter child object CategoriesCache and as the second parameter to have a CategoriesItemsParameters object.

Methods summary
`public`	# `__construct( CategoriesCache $categories_cache, CategoriesItemsParameters $categories_items_parameters )` Parameters `$categories_cache` A child object of the class CategoriesCache `$categories_items_parameters`
`public`	# `add( Category $category )` Parameters `$category`
`public`	# `update( Category $category )` Parameters `$category`
`public`	# `move_into_another( Category $category, integer $id_parent, integer $position = 0 )` Moves a category and items into another category. You can specify its future position in its future parent category. Moves a category and items into another category. You can specify its future position in its future parent category. Parameters `$category` `$id_parent` `$position`
`public`	# `move_items_into_another( Category $category, integer $id_parent )` Moves items into another category. Moves items into another category. Parameters `$category` `$id_parent`
`public`	# `update_position( Category $category, integer $id_parent, integer $position )` Update category and items position. Update category and items position. Parameters `$category` `$id_parent` `$position`
`public`	# `delete( integer $id )` Deletes a category and items. Deletes a category and items. Parameters `$id` Id of the category to delete.
`public`	# `get_children( integer $id_category, SearchCategoryChildrensOptions $search_category_children_options, $add_this = false )` Category[string] the children Categories map (id => category) for category id Category[string] the children Categories map (id => category) for category id Parameters `$id_category` `$search_category_children_options` `$add_this`
`public`	# `get_parents( integer $id_category, boolean $add_this = false )` Category[string] the parents Categories map (id => category) for category id Category[string] the parents Categories map (id => category) for category id Parameters `$id_category` `$add_this` Add category in the map
`public mixed[]`	# `get_heritated_authorizations( integer $id_category, integer $bit, integer $mode )` Computes the global authorization level of the whole parent categories. The result corresponds to all the category's parents merged. Computes the global authorization level of the whole parent categories. The result corresponds to all the category's parents merged. Parameters `$id_category` Id of the category for which you want to know what is the global authorization `$bit` The autorization bit you want to check `$mode` Merge mode. If it corresponds to a read autorization, use Authorizations::AUTH_PARENT_PRIORITY which will disallow for example all the subcategories of a category to which you can't access, or Authorizations::AUTH_CHILD_PRIORITY if you want to work in write mode, each child will be able to redifine the authorization. Returns mixed[] The merged array that you can use only for the bit $bit.
`public`	# `get_select_categories_form_field( $id, $label, $value, SearchCategoryChildrensOptions $search_category_children_options, array $field_options = array() )`
`public FeedsCategoriesModule`	# `get_feeds_categories_module( )` Returns `FeedsCategoriesModule`
`public`	# `regenerate_cache( )`
`public CategoriesCache`	# `get_categories_cache( )` Returns `CategoriesCache`
`public string`	# `get_module_id( )` Returns string module identifier.
`public CategoriesItemsParameters`	# `get_categories_items_parameters( )` Returns `CategoriesItemsParameters`

Constants summary
`string`	`STANDARD_CATEGORY_CLASS`	# `'Category'`
`string`	`RICH_CATEGORY_CLASS`	# `'RichCategory'`

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Returns

Returns

Returns

Returns