TPS
/
ORIENT
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update module facade docblocks (#5273)

This commit is contained in:
serega-kasyanow 2020-09-11 06:49:16 +04:00 committed by GitHub
parent b407f26e02
commit 4c41eee1b3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 54 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
modules/backend/facades/Backend.php
View File

@ -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()

14
modules/backend/facades/BackendAuth.php
View File

@ -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()

28
modules/backend/facades/BackendMenu.php
View File

@ -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()

6
modules/cms/facades/Cms.php
View File

@ -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()