You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/dev/modules/base/_index.md
+36Lines changed: 36 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -59,14 +59,50 @@ There are also a number of helper methods to get some of the most common module
59
59
60
60
### getTitle
61
61
62
+
This gets the title for the Module.
63
+
64
+
It looks for defines with suffixes in an array of ['TITLE', 'TEXT_TITLE', 'CATALOG_TITLE']
65
+
66
+
If your module uses a different define for the title then you should override the getTitle method.
67
+
62
68
### getAdminTitle
63
69
70
+
This returns a title to display on the Admin interface. In general this would be the same as the getTitle as above, but sometimes you may want it to be different.
71
+
It expects to be passed a default title, which would normally be what the getTitle function returns, ans will use this if it does not find a define related to the admin title.
72
+
73
+
This function looks for defines with a suffix in an array ['TITLE_ADMIN', 'TEXT_TITLE_ADMIN', 'ADMIN_TITLE']
74
+
75
+
If your admin title is defined through other means, them you will need to override this method in your module.
76
+
64
77
### getDescription
65
78
79
+
returns a module define with the suffix `DESCRIPTION`
80
+
66
81
### getSortOrder
67
82
83
+
returns a module define with the suffix `SORT_ORDER`
84
+
68
85
### getZone
69
86
87
+
returns a module define with the suffix `ZONE`
88
+
89
+
### getDebugMode#
90
+
91
+
returns a module define with the suffix `DEBUG_MODE`
92
+
93
+
### isEnabled
94
+
95
+
This function checks to see if the module is enabled.
96
+
97
+
it first checks to see if the module has any missing configuraitions and then check the module define suffix `STATUS`
98
+
99
+
### moduleAutoloadSupportClasses
100
+
101
+
This function is only called if it exists.
102
+
103
+
It allows a module to add autoload classes using the psr4autoaload Aura autoload.
0 commit comments