HelpList

Navigation:  Development > Architecture and Standard > App Factory > __Def >

HelpList

Previous pageReturn to chapter overviewNext page

Return Help Information
 
App::__Def()->HelpList([Helper Id]);

 

 

Parameter

Type

Description

Help Id

Optional

Help id to get a particular help info.

 

All help data available in : /development/cache/data/apphelp.xml

 

See below example:

 
// Return all help info
$info = App::__Def()->HelpList();
 
// Return single help info$info = App::__Def()->HelpList('page-manager-page-name');
 
/*
Return 
Array

(

    [id] => page-manager-page-name

    [title] => Page Name

    [shortdesc] => An unique identifier of a page.

    [description] => 

 

Page Name is an identifier of a Page that used to retrieve, update and to generate Page URL.

 

 

Note: Please avoid special characters in page name, Use only alpha-numeric format. For example: HomePage, customer-profile.

 

 

)
*/