Defaults
public api to access default strings and urls for your templates
Tags
Table of Contents
- $defaults : mixed
- \OC_Defaults instance to retrieve the defaults
- __construct() : mixed
- creates a \OC_Defaults instance which is used in all methods to retrieve the actual defaults
- buildDocLinkToKey() : string
- getAndroidClientUrl() : string
- link to the Android client
- getBaseUrl() : string
- get base URL for the organisation behind your ownCloud instance
- getColorPrimary() : string
- Returns primary color
- getDocBaseUrl() : string
- base URL to the documentation of your ownCloud instance
- getEntity() : string
- Entity behind your onwCloud instance
- getHTMLName() : string
- name of your ownCloud instance containing HTML styles
- getiOSClientUrl() : string
- link to the iOS client
- getiTunesAppId() : string
- Returns the AppId for the App Store for the iOS Client
- getLogo() : string
- Themed logo url
- getLogoClaim() : string
- logo claim
- getLongFooter() : string
- footer, long version
- getName() : string
- name of your ownCloud instance
- getShortFooter() : string
- footer, short version
- getSlogan() : string
- ownCloud slogan
- getSyncClientUrl() : string
- link to the desktop sync client
- getTextColorPrimary() : string
- Returns primary color
- getTitle() : string
- Returns the title
Properties
$defaults
\OC_Defaults instance to retrieve the defaults
private
mixed
$defaults
Tags
Methods
__construct()
creates a \OC_Defaults instance which is used in all methods to retrieve the actual defaults
public
__construct([OC_Defaults $defaults = null ]) : mixed
Parameters
- $defaults : OC_Defaults = null
Tags
Return values
mixed —buildDocLinkToKey()
public
buildDocLinkToKey(string $key) : string
Parameters
- $key : string
Tags
Return values
string —URL to doc with key
getAndroidClientUrl()
link to the Android client
public
getAndroidClientUrl() : string
Tags
Return values
string —getBaseUrl()
get base URL for the organisation behind your ownCloud instance
public
getBaseUrl() : string
Tags
Return values
string —getColorPrimary()
Returns primary color
public
getColorPrimary() : string
Tags
Return values
string —getDocBaseUrl()
base URL to the documentation of your ownCloud instance
public
getDocBaseUrl() : string
Tags
Return values
string —getEntity()
Entity behind your onwCloud instance
public
getEntity() : string
Tags
Return values
string —getHTMLName()
name of your ownCloud instance containing HTML styles
public
getHTMLName() : string
Tags
Return values
string —getiOSClientUrl()
link to the iOS client
public
getiOSClientUrl() : string
Tags
Return values
string —getiTunesAppId()
Returns the AppId for the App Store for the iOS Client
public
getiTunesAppId() : string
Tags
Return values
string —AppId
getLogo()
Themed logo url
public
getLogo([bool $useSvg = true ]) : string
Parameters
- $useSvg : bool = true
-
Whether to point to the SVG image or a fallback
Tags
Return values
string —getLogoClaim()
logo claim
public
getLogoClaim() : string
Tags
Return values
string —getLongFooter()
footer, long version
public
getLongFooter() : string
Tags
Return values
string —getName()
name of your ownCloud instance
public
getName() : string
Tags
Return values
string —getShortFooter()
footer, short version
public
getShortFooter() : string
Tags
Return values
string —getSlogan()
ownCloud slogan
public
getSlogan([string|null $lang = null ]) : string
Parameters
- $lang : string|null = null
Tags
Return values
string —getSyncClientUrl()
link to the desktop sync client
public
getSyncClientUrl() : string
Tags
Return values
string —getTextColorPrimary()
Returns primary color
public
getTextColorPrimary() : string
Tags
Return values
string —getTitle()
Returns the title
public
getTitle() : string
Tags
Return values
string —title