Documentation for class menu (inherits from catalog):


Properties:

name type default params representant foreign foreign_prop position
id CO_INTEGER SEQUENCE READONLY=1;HIDDEN=1 0 0
version CO_INTEGER 0 READONLY=1;HIDDEN=1 0 0
deleted CO_INTEGER 0 READONLY=1;HIDDEN=1 0 0
inherits_acl CO_INTEGER 1 HIDDEN=1;READONLY=1 0 50
name CO_STRING '' 100 200
id_parent CO_INTEGER 0 0 menu id 300
id_type CO_STRING '' 0 400
id_menu_action CO_INTEGER 0 0 menu_action id 500
class_name CO_STRING '' 0 meta_class class_name 600
description CO_STRING '' SIZE=100 0 700
id_permission CO_INTEGER 0 0 800
menu_position CO_INTEGER 0 0 900
display_name CO_STRING '' 0 1000
menu_params CO_STRING '' ROWS=10; COLS=30; 0 1200
sec_type CO_INTEGER 0 VALUES=new Array(0,1); 0 1300

Methods:


method getDefault
description: this method retrieves menu items, that are allowed to execute for current users role and given object Objects are identified using: for_area::for_class::for_id
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

callback
type CO_STRING


method getByName
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

callback
type CO_STRING

menu_name
type CO_STRING


method getByNameAllowed
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

callback
type CO_STRING

menu_name
description: name for menu to retrieve
type CO_STRING

for_area
description: area for object that we use to check permissions
type CO_STRING

for_class
description: class for object that we use to check permissions
type CO_STRING

for_id
description: id for object that we use to check permissions
type CO_INTEGER


method getByNameAllowedWithParents
description: This method retrieves menu items, that are allowed to execute for current users role and given object Objects are identified using: for_area::for_class::for_id This method retrieves menus for given class and all inheritance path Name of menu is created by adding '#type@class_name' at the end, so if you want to retrieve menu 'default#single@catalog' as name you provide only 'default', and type 'single' You will get items from menus: 'default#single@catalog', 'default#single@generic_acl', 'default#single@generic'
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

callback
type CO_STRING

menu_name
description: name for menu to retrieve
type CO_STRING

for_area
description: area for object that we use to check permissions
type CO_STRING

for_class
description: class for object that we use to check permissions
type CO_STRING

for_id
description: Id for object that we use to check permissions. Default value is -1, so you do not have to pass this for multi and class methods
type CO_INTEGER

type
description: Type of catalog to be retrieved (like single, class, multi)
type CO_STRING