CoreAPI
[ class tree: CoreAPI ] [ index: CoreAPI ] [ all elements ]

Procedural File: project_hierarchy_api.php

Source Location: /core/project_hierarchy_api.php



Page Details:

Project Hierarchy API



Tags:

copyright:  Copyright (C) 2002 - 2010 MantisBT Team - mantisbt-dev@lists.sourceforge.net
copyright:  Copyright (C) 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
link:  http://www.mantisbt.org








project_hierarchy_add [line 38]

null project_hierarchy_add( int $p_child_id, int $p_parent_id, [bool $p_inherit_parent = true])

Add project to project hierarchy



Parameters

int   $p_child_id   Child project ID
int   $p_parent_id   Parent project ID
bool   $p_inherit_parent   Whether or not the child project inherits from the parent project
[ Top ]



project_hierarchy_cache [line 137]

bool project_hierarchy_cache( [bool $p_show_disabled = false])

Cache project hierarchy



Parameters

bool   $p_show_disabled   Whether or not to cache projects which are disabled
[ Top ]



project_hierarchy_get_all_subprojects [line 270]

array project_hierarchy_get_all_subprojects( int $p_project_id, [bool $p_show_disabled = false])

Get complete subproject hierarchy for a project



Parameters

int   $p_project_id   Project ID
bool   $p_show_disabled   Whether or not to consider projects which are disabled
[ Top ]



project_hierarchy_get_subprojects [line 252]

array project_hierarchy_get_subprojects( int $p_project_id, [bool $p_show_disabled = false])

Get subprojects for a project



Parameters

int   $p_project_id   Project ID
bool   $p_show_disabled   Whether or not to consider projects which are disabled
[ Top ]



project_hierarchy_inheritance [line 213]

array project_hierarchy_inheritance( int $p_project_id, [bool $p_show_disabled = false])

Generate an array of project's the given project inherits from, including the original project in the result.



Parameters

int   $p_project_id   Project ID
bool   $p_show_disabled   Whether or not to consider projects which are disabled
[ Top ]



project_hierarchy_inherit_parent [line 198]

bool project_hierarchy_inherit_parent( int $p_child_id, int $p_parent_id, [bool $p_show_disabled = false])

Returns true if the child project inherits categories from the parent.



Parameters

int   $p_child_id   Child project ID
int   $p_parent_id   Parent project ID
bool   $p_show_disabled   Whether or not to consider projects which are disabled
[ Top ]



project_hierarchy_is_toplevel [line 120]

bool project_hierarchy_is_toplevel( bool $p_project_id, [bool $p_show_disabled = false])

Returns true if project is at top of hierarchy



Parameters

bool   $p_project_id   Project ID
bool   $p_show_disabled   Whether or not to consider projects which are disabled
[ Top ]



project_hierarchy_remove [line 84]

null project_hierarchy_remove( int $p_child_id, int $p_parent_id)

Remove project from project hierarchy



Parameters

int   $p_child_id   Child project ID
int   $p_parent_id   Parent project ID
[ Top ]



project_hierarchy_remove_all [line 102]

null project_hierarchy_remove_all( int $p_project_id)

Remove any project hierarchy entries relating to project_id



Parameters

int   $p_project_id   Project ID
[ Top ]



project_hierarchy_update [line 64]

null project_hierarchy_update( int $p_child_id, int $p_parent_id, [bool $p_inherit_parent = true])

Update project hierarchy



Parameters

int   $p_child_id   Child project ID
int   $p_parent_id   Parent project ID
bool   $p_inherit_parent   Whether or not the child project inherits from the parent project
[ Top ]



Documentation generated on Sun, 12 Dec 2010 23:50:47 +0900 by phpDocumentor 1.4.3
inserted by FC2 system