Encapsulation for Hubleto app.
\Hubleto\Framework\App
Parent class | \Hubleto\Framework\Core |
Implements | \Hubleto\Framework\Interfaces\AppInterface |
Constants
Constant | Visibility | Type | Value |
---|---|---|---|
DEFAULT_INSTALLATION_CONFIG |
public | ['sidebarOrder' => 500] | |
APP_TYPE_COMMUNITY |
public | 'community' | |
APP_TYPE_PREMIUM |
public | 'premium' | |
APP_TYPE_EXTERNAL |
public | 'external' |
Properties
manifest
public array $manifest
enabled
public bool $enabled
canBeDisabled
public bool $canBeDisabled
permittedForAllUsers
public bool $permittedForAllUsers
srcFolder
public string $srcFolder
viewNamespace
public string $viewNamespace
namespace
public string $namespace
fullName
public string $fullName
shortName
public string $shortName
isActivated
public bool $isActivated
hasCustomSettings
public bool $hasCustomSettings
settings
private array $settings
searchSwitches
public array $searchSwitches
Methods
__construct
public __construct(): mixed
validateManifest
[Description for validateManifest]
public validateManifest(): mixed
init
[Description for init]
public init(): void
onBeforeRender
[Description for onBeforeRender]
public onBeforeRender(): void
hook
[Description for hook]
public hook(string $hook): void
Parameters:
Parameter | Type | Description |
---|---|---|
$hook |
string |
getRootUrlSlug
[Description for getRootUrlSlug]
public getRootUrlSlug(): string
getNotificationsCount
[Description for getNotificationsCount]
public getNotificationsCount(): int
translate
[Description for translate]
public translate(string $string, array $vars = [], string $context = 'root'): string
Parameters:
Parameter | Type | Description |
---|---|---|
$string |
string | |
$vars |
array | |
$context |
string |
installTables
[Description for installTables]
public installTables(int $round): void
Parameters:
Parameter | Type | Description |
---|---|---|
$round |
int |
getAvailableControllerClasses
[Description for getAvailableControllerClasses]
public getAvailableControllerClasses(): array
getAvailableModelClasses
[Description for getAvailableModelClasses]
public getAvailableModelClasses(): array
installDefaultPermissions
[Description for installDefaultPermissions]
public installDefaultPermissions(): void
assignPermissionsToRoles
[Description for assignPermissionsToRoles]
public assignPermissionsToRoles(): void
generateDemoData
[Description for generateDemoData]
public generateDemoData(): void
renderSecondSidebar
[Description for renderSecondSidebar]
public renderSecondSidebar(): string
search
[Description for search]
public search(array $expressions): array
Parameters:
Parameter | Type | Description |
---|---|---|
$expressions |
array |
addSetting
[Description for addSetting]
public addSetting(\Hubleto\Framework\Interfaces\AppInterface $app, array $setting): void
Parameters:
Parameter | Type | Description |
---|---|---|
$app |
\Hubleto\Framework\Interfaces\AppInterface | |
$setting |
array |
getSettings
[Description for getSettings]
public getSettings(): array
getFullConfigPath
[Description for getFullConfigPath]
public getFullConfigPath(string $path): string
Parameters:
Parameter | Type | Description |
---|---|---|
$path |
string |
saveConfig
[Description for saveConfig]
public saveConfig(string $path, string $value = ''): void
Parameters:
Parameter | Type | Description |
---|---|---|
$path |
string | |
$value |
string |
saveConfigForUser
[Description for saveConfigForUser]
public saveConfigForUser(string $path, string $value = ''): void
Parameters:
Parameter | Type | Description |
---|---|---|
$path |
string | |
$value |
string |
configAsString
[Description for configAsString]
public configAsString(string $path, string $defaultValue = ''): string
Parameters:
Parameter | Type | Description |
---|---|---|
$path |
string | |
$defaultValue |
string |
configAsInteger
[Description for configAsInteger]
public configAsInteger(string $path, int $defaultValue): int
Parameters:
Parameter | Type | Description |
---|---|---|
$path |
string | |
$defaultValue |
int |
configAsFloat
[Description for configAsFloat]
public configAsFloat(string $path, float $defaultValue): float
Parameters:
Parameter | Type | Description |
---|---|---|
$path |
string | |
$defaultValue |
float |
configAsBool
[Description for configAsBool]
public configAsBool(string $path, bool $defaultValue = false): bool
Parameters:
Parameter | Type | Description |
---|---|---|
$path |
string | |
$defaultValue |
bool |
configAsArray
[Description for configAsArray]
public configAsArray(string $path, array $defaultValue = []): array
Parameters:
Parameter | Type | Description |
---|---|---|
$path |
string | |
$defaultValue |
array |
setConfigAsString
[Description for setConfigAsString]
public setConfigAsString(string $path, string $value = ''): void
Parameters:
Parameter | Type | Description |
---|---|---|
$path |
string | |
$value |
string |
setConfigAsInteger
[Description for setConfigAsInteger]
public setConfigAsInteger(string $path, int $value): void
Parameters:
Parameter | Type | Description |
---|---|---|
$path |
string | |
$value |
int |
setConfigAsFloat
[Description for setConfigAsFloat]
public setConfigAsFloat(string $path, float $value): void
Parameters:
Parameter | Type | Description |
---|---|---|
$path |
string | |
$value |
float |
setConfigAsBool
[Description for setConfigAsBool]
public setConfigAsBool(string $path, bool $value = false): void
Parameters:
Parameter | Type | Description |
---|---|---|
$path |
string | |
$value |
bool |
setConfigAsArray
[Description for setConfigAsArray]
public setConfigAsArray(string $path, array $value = []): void
Parameters:
Parameter | Type | Description |
---|---|---|
$path |
string | |
$value |
array |
dangerouslyInjectDesktopHtmlContent
[Description for dangerouslyInjectDesktopHtmlContent]
public dangerouslyInjectDesktopHtmlContent(string $where): string
Parameters:
Parameter | Type | Description |
---|---|---|
$where |
string |
addSearchSwitch
[Description for addSearchSwitch]
public addSearchSwitch(string $switch, string $name): void
Parameters:
Parameter | Type | Description |
---|---|---|
$switch |
string | |
$name |
string |
canHandleSearchSwith
[Description for canHandleSearchSwith]
public canHandleSearchSwith(string $switch): bool
Parameters:
Parameter | Type | Description |
---|---|---|
$switch |
string |
collectExtendibles
[Description for collectExtendibles]
public collectExtendibles(string $extendibleName): array
Parameters:
Parameter | Type | Description |
---|---|---|
$extendibleName |
string |
Inherited methods
__construct
public __construct(): mixed
getServiceStatic
Shortcut for the dependency injection.
public static getServiceStatic(string $service): mixed
- This method is static. Parameters:
Parameter | Type | Description |
---|---|---|
$service |
string |
getService
[Description for getService]
public getService(string $service): mixed
Parameters:
Parameter | Type | Description |
---|---|---|
$service |
string |
env
Shortcut for the env service.
public env(): \Hubleto\Framework\Env
authProvider
Shortcut for the authentication service.
public authProvider(): \Hubleto\Framework\Interfaces\AuthInterface
db
Shortcut for the database service.
public db(): \Hubleto\Framework\Db
appManager
Shortcut for the app manager service.
public appManager(): \Hubleto\Framework\Interfaces\AppManagerInterface
router
Shortcut for the router service.
public router(): \Hubleto\Framework\Router
hookManager
Shortcut for the hook manager service.
public hookManager(): \Hubleto\Framework\HookManager
sessionManager
Shortcut for the session manager service.
public sessionManager(): \Hubleto\Framework\SessionManager
permissionsManager
Shortcut for the permissions manager service.
public permissionsManager(): \Hubleto\Framework\PermissionsManager
cronManager
Shortcut for the cron manager service.
public cronManager(): \Hubleto\Framework\CronManager
emailProvider
Shortcut for the email provider service.
public emailProvider(): \Hubleto\Framework\EmailProvider
config
Shortcut for the config service.
public config(): \Hubleto\Framework\Interfaces\ConfigManagerInterface
logger
Shortcut for the logger service.
public logger(): \Hubleto\Framework\Logger
locale
Shortcut for the locale service.
public locale(): \Hubleto\Framework\Locale
renderer
Shortcut for the renderer service.
public renderer(): \Hubleto\Framework\Renderer
translator
Shortcut for the translator service.
public translator(): \Hubleto\Framework\Interfaces\TranslatorInterface
getModel
[Description for getModel]
public getModel(string $model): \Hubleto\Framework\Models\Model
Parameters:
Parameter | Type | Description |
---|---|---|
$model |
string |
getController
[Description for getController]
public getController(string $controller): \Hubleto\Framework\Controller
Parameters:
Parameter | Type | Description |
---|---|---|
$controller |
string |
translate
Shorthand for core translate() function. Uses own language dictionary.
public translate(string $string, array $vars = []): string
Parameters:
Parameter | Type | Description |
---|---|---|
$string |
string | String to be translated |
$vars |
array |
Return Value:
Translated string.