CSAppScreen
extends CSAppObject
in package
This class represents the base class of all app related objects.
Tags
Table of Contents
- SIZE_LARGE = \AppRestservice::APPLICATION_SIZE_LARGE
- SIZE_MEDIUM = \AppRestservice::APPLICATION_SIZE_MEDIUM
- SIZE_SMALL = \AppRestservice::APPLICATION_SIZE_SMALL
- createForNameFromApp() : CSAppScreen
- Creates a screen instance for an app context.
- getLabel() : string
- Return the label (nice name) of the screen.
- getLabelForSize() : string
- Return the label (nice name) of the screen for size.
- getName() : string
- Returns the name of the screen.
- getParameters() : array<string|int, mixed>
- Returns all parameters defined for the screen.
- getParametersForSize() : array<string|int, mixed>
- Returns all parameters defined for the screen in the specified size.
- getPath() : string
- returns the screen's file path.
- getSizesWithEntryPoint() : int
- Returns supported sizes for particular Screen. The Size of the screen is decided from the versions of "Details.json".
- getTranslations() : array<string|int, mixed>
- returns an array of translations available for the current screen.
- importTranslations() : void
- imports a translation array in the format that getTranslations is returning into the screens's translation files.
- isEntryPoint() : bool
- Returns whether the screen can be used as entry point to the application or not.
Constants
SIZE_LARGE
public
mixed
SIZE_LARGE
= \AppRestservice::APPLICATION_SIZE_LARGE
Tags
SIZE_MEDIUM
public
mixed
SIZE_MEDIUM
= \AppRestservice::APPLICATION_SIZE_MEDIUM
Tags
SIZE_SMALL
public
mixed
SIZE_SMALL
= \AppRestservice::APPLICATION_SIZE_SMALL
Tags
Methods
createForNameFromApp()
Creates a screen instance for an app context.
public
static createForNameFromApp(string $sName, CSApp $oApp) : CSAppScreen
Parameters
- $sName : string
-
The name of the screen.
- $oApp : CSApp
-
The application context.
Tags
Return values
CSAppScreen —The created screen instance.
getLabel()
Return the label (nice name) of the screen.
public
getLabel() : string
Tags
Return values
string —The label (nice name) of the screen.
getLabelForSize()
Return the label (nice name) of the screen for size.
public
getLabelForSize(mixed $iSize) : string
Parameters
- $iSize : mixed
Tags
Return values
string —The label (nice name) of the screen.
getName()
Returns the name of the screen.
public
getName() : string
Tags
Return values
string —The name of the screen.
getParameters()
Returns all parameters defined for the screen.
public
getParameters() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —The list of parameters defined for the screen.
getParametersForSize()
Returns all parameters defined for the screen in the specified size.
public
getParametersForSize(int $iSize) : array<string|int, mixed>
Parameters
- $iSize : int
-
The app size for which the parameter should be returned as one of the SIZE_*-constant.
Tags
Return values
array<string|int, mixed> —The list of parameters defined for the screen in the specified size.
getPath()
returns the screen's file path.
public
getPath() : string
Tags
Return values
string —The file path to the current screen.
getSizesWithEntryPoint()
Returns supported sizes for particular Screen. The Size of the screen is decided from the versions of "Details.json".
public
getSizesWithEntryPoint() : int
Tags
Return values
int —Supported sizes for a Screen.
getTranslations()
returns an array of translations available for the current screen.
public
getTranslations() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —Array containing all translations for the current screen.
importTranslations()
imports a translation array in the format that getTranslations is returning into the screens's translation files.
public
importTranslations(array<string|int, mixed> $aTranslations) : void
Parameters
- $aTranslations : array<string|int, mixed>
-
The translations to import.
Tags
Return values
void —isEntryPoint()
Returns whether the screen can be used as entry point to the application or not.
public
isEntryPoint() : bool
Tags
Return values
bool —True, if the screen is an entry point, otherwise false.