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.
__construct(\CategoriesCache $categories_cache, \CategoriesItemsParameters $categories_items_parameters)
| \CategoriesCache | $categories_cache | A child object of the class CategoriesCache |
| \CategoriesItemsParameters | $categories_items_parameters |
| None found |
add(\Category $category)
| \Category | $category |
| None found |
update(\Category $category)
| \Category | $category |
| None found |
move_into_another(\Category $category, integer $id_parent, integer $position) Moves a category and items into another category. You can specify its future position in its future parent category.
| \Category | $category | |
| integer | $id_parent | |
| integer | $position |
| None found |
move_items_into_another(\Category $category, integer $id_parent) Moves items into another category.
| \Category | $category | |
| integer | $id_parent |
| None found |
update_position(\Category $category, integer $id_parent, integer $position) Update category and items position.
| \Category | $category | |
| integer | $id_parent | |
| integer | $position |
| None found |
delete(integer $id) Deletes a category and items.
| integer | $id | Id of the category to delete. |
| None found |
get_children(integer $id_category, \SearchCategoryChildrensOptions $search_category_children_options, $add_this = false) Category[string] the children Categories map (id => category) for category id
| integer | $id_category | |
| \SearchCategoryChildrensOptions | $search_category_children_options | |
| $add_this |
| None found |
get_parents(integer $id_category, boolean $add_this = false) Category[string] the parents Categories map (id => category) for category id
| integer | $id_category | |
| boolean | $add_this | Add category in the map |
| None found |
get_heritated_authorizations(integer $id_category, integer $bit, integer $mode) : array<mixed,mixed>Computes the global authorization level of the whole parent categories. The result corresponds to all the category's parents merged.
| integer | $id_category | Id of the category for which you want to know what is the global authorization |
| integer | $bit | The autorization bit you want to check |
| integer | $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. |
The merged array that you can use only for the bit $bit.
| None found |
get_select_categories_form_field( $id, $label, $value, \SearchCategoryChildrensOptions $search_category_children_options, array $field_options = array())
| $id | ||
| $label | ||
| $value | ||
| \SearchCategoryChildrensOptions | $search_category_children_options | |
| array | $field_options |
| None found |
get_feeds_categories_module() : \FeedsCategoriesModule
| None found |
regenerate_cache()
| None found |
get_categories_cache() : \CategoriesCache
| None found |
get_module_id() : string
module identifier.
| None found |
get_categories_items_parameters() : \CategoriesItemsParameters
| None found |
build_children_map( $id_category, $categories, $id_parent, $search_category_children_options, $children_categories = array(), $node = 1)
| $id_category | ||
| $categories | ||
| $id_parent | ||
| $search_category_children_options | ||
| $children_categories | ||
| $node |
| None found |
$module_id : string
| None found |
$table_name : string
| None found |
$categories_cache : \CategoriesCache
| None found |
$categories_items_parameters : \CategoriesItemsParameters
| None found |
$db_querier : \DBQuerier
| None found |