Function Standard_crud_module->get_entry_points
Definitions
sources/crud_module.php
- Find entry-points available within this module.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $check_perms | boolean | No | No | True | N/A | N/A | Whether to check permissions |
| $member_id | ?MEMBER | No | No | Null | N/A | N/A | The member to check permissions as (null: current user) |
| $support_crosslinks | boolean | No | No | True | N/A | N/A | Whether to allow cross links to other modules (identifiable via a full-page-link rather than a screen-name) |
| $be_deferential | boolean | No | No | False | N/A | N/A | Whether to avoid any entry-point (or even return null to disable the page in the Sitemap) if we know another module, or page_group, is going to link to that entry-point. Note that "!" and "browse" entry points are automatically merged with container page nodes (likely called by page-groupings) as appropriate. |
Returns
- A map of entry points (screen-name=>language-code/string or screen-name=>[language-code/string, icon-theme-image]) (null: disabled)
- Type: ?array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Find entry-points available within this module.
*
* @param boolean $check_perms Whether to check permissions
* @param ?MEMBER $member_id The member to check permissions as (null: current user)
* @param boolean $support_crosslinks Whether to allow cross links to other modules (identifiable via a full-page-link rather than a screen-name)
* @param boolean $be_deferential Whether to avoid any entry-point (or even return null to disable the page in the Sitemap) if we know another module, or page_group, is going to link to that entry-point. Note that "!" and "browse" entry points are automatically merged with container page nodes (likely called by page-groupings) as appropriate.
* @return ?array A map of entry points (screen-name=>language-code/string or screen-name=>[language-code/string, icon-theme-image]) (null: disabled)
*/
public function get_entry_points(bool $check_perms = true, ?int $member_id = null, bool $support_crosslinks = true, bool $be_deferential = false) : ?array
* Find entry-points available within this module.
*
* @param boolean $check_perms Whether to check permissions
* @param ?MEMBER $member_id The member to check permissions as (null: current user)
* @param boolean $support_crosslinks Whether to allow cross links to other modules (identifiable via a full-page-link rather than a screen-name)
* @param boolean $be_deferential Whether to avoid any entry-point (or even return null to disable the page in the Sitemap) if we know another module, or page_group, is going to link to that entry-point. Note that "!" and "browse" entry points are automatically merged with container page nodes (likely called by page-groupings) as appropriate.
* @return ?array A map of entry points (screen-name=>language-code/string or screen-name=>[language-code/string, icon-theme-image]) (null: disabled)
*/
public function get_entry_points(bool $check_perms = true, ?int $member_id = null, bool $support_crosslinks = true, bool $be_deferential = false) : ?array