diff --git a/modules/backend/facades/Backend.php b/modules/backend/facades/Backend.php index 4ca59f641..1a1ae24bd 100644 --- a/modules/backend/facades/Backend.php +++ b/modules/backend/facades/Backend.php @@ -2,12 +2,24 @@ use October\Rain\Support\Facade; +/** + * @method static string uri() + * @method static string url(string $path = null, array $parameters = [], bool $secure = null) + * @method static string baseUrl(string $path = null) + * @method static string skinAsset(string $path = null) + * @method static \Illuminate\Http\RedirectResponse redirect(string $path, int $status = 302, array $headers = [], bool $secure = null) + * @method static \Illuminate\Http\RedirectResponse redirectGuest(string $path, int $status = 302, array $headers = [], bool $secure = null) + * @method static \Illuminate\Http\RedirectResponse redirectIntended(string $path, int $status = 302, array $headers = [], bool $secure = null) + * @method static string date($dateTime, array $options = []) + * @method static string dateTime($dateTime, array $options = []) + * + * @see \Backend\Helpers\Backend + */ class Backend extends Facade { /** * Get the registered name of the component. * - * @see \Backend\Helpers\Backend * @return string */ protected static function getFacadeAccessor() diff --git a/modules/backend/facades/BackendAuth.php b/modules/backend/facades/BackendAuth.php index 99dde86f3..6c3cfc078 100644 --- a/modules/backend/facades/BackendAuth.php +++ b/modules/backend/facades/BackendAuth.php @@ -2,14 +2,22 @@ use October\Rain\Support\Facade; +/** + * @method static void registerCallback(callable $callback) + * @method static void registerPermissions(string $owner, array $definitions) + * @method static void removePermission(string $owner, string $code) + * @method static array listPermissions() + * @method static array listTabbedPermissions() + * @method static array listPermissionsForRole(string $role, bool $includeOrphans = true) + * @method static boolean hasPermissionsForRole(string $role) + * + * @see \Backend\Classes\AuthManager + */ class BackendAuth extends Facade { /** * Get the registered name of the component. * - * Resolves to: - * - Backend\Classes\AuthManager - * * @return string */ protected static function getFacadeAccessor() diff --git a/modules/backend/facades/BackendMenu.php b/modules/backend/facades/BackendMenu.php index eb93dff9a..9b305c188 100644 --- a/modules/backend/facades/BackendMenu.php +++ b/modules/backend/facades/BackendMenu.php @@ -2,14 +2,36 @@ use October\Rain\Support\Facade; +/** + * @method static void registerCallback(callable $callback) + * @method static void registerMenuItems(string $owner, array $definitions) + * @method static void addMainMenuItems(string $owner, array $definitions) + * @method static void addMainMenuItem(string $owner, $code, array $definition) + * @method static \Backend\Classes\MainMenuItem getMainMenuItem(string $owner, string $code) + * @method static void removeMainMenuItem(string $owner, string $code) + * @method static void addSideMenuItems(string $owner, string $code, array $definitions) + * @method static bool addSideMenuItem(string $owner, string $code, string $sideCode, array $definition) + * @method static bool removeSideMenuItem(string $owner, string $code, string $sideCode) + * @method static \Backend\Classes\MainMenuItem[] listMainMenuItems() + * @method static \Backend\Classes\SideMenuItem[] listSideMenuItems(string|null $owner = null, string|null $code = null) + * @method static void setContext(string $owner, string $mainMenuItemCode, string|null $sideMenuItemCode = null) + * @method static void setContextOwner(string $owner) + * @method static void setContextMainMenu(string $mainMenuItemCode) + * @method static object getContext() + * @method static void setContextSideMenu(string $sideMenuItemCode) + * @method static bool isMainMenuItemActive(\Backend\Classes\MainMenuItem $item) + * @method static \Backend\Classes\MainMenuItem|null getActiveMainMenuItem() + * @method static bool isSideMenuItemActive(\Backend\Classes\SideMenuItem $item) + * @method static void registerContextSidenavPartial(string $owner, string $mainMenuItemCode, string $partial) + * @method static mixed getContextSidenavPartial(string $owner, string $mainMenuItemCode) + * + * @see \Backend\Classes\NavigationManager + */ class BackendMenu extends Facade { /** * Get the registered name of the component. * - * Resolves to: - * - Backend\Classes\NavigationManager - * * @return string */ protected static function getFacadeAccessor() diff --git a/modules/cms/facades/Cms.php b/modules/cms/facades/Cms.php index 81931d80b..4657595e4 100644 --- a/modules/cms/facades/Cms.php +++ b/modules/cms/facades/Cms.php @@ -2,12 +2,16 @@ use October\Rain\Support\Facade; +/** + * @method static string url(string $path = null) + * + * @see \Cms\Helpers\Cms + */ class Cms extends Facade { /** * Get the registered name of the component. * - * @see \Cms\Helpers\Cms * @return string */ protected static function getFacadeAccessor()