Defaults

class OCP\Defaults
public api to access default strings and urls for your templates
Source:lib/public/Defaults.php#41

Properties

Methods

public OCP\Defaults::__construct($defaults=null)
creates a \OC_Defaults instance which is used in all methods to retrieve the
actual defaults
Source:lib/public/Defaults.php#54
Since:6.0.0
public OCP\Defaults::getBaseUrl()
get base URL for the organisation behind your ownCloud instance
Source:lib/public/Defaults.php#66
Returns:string
Since:6.0.0
public OCP\Defaults::getSyncClientUrl()
link to the desktop sync client
Source:lib/public/Defaults.php#75
Returns:string
Since:6.0.0
public OCP\Defaults::getiOSClientUrl()
link to the iOS client
Source:lib/public/Defaults.php#84
Returns:string
Since:8.0.0
public OCP\Defaults::getAndroidClientUrl()
link to the Android client
Source:lib/public/Defaults.php#93
Returns:string
Since:8.0.0
public OCP\Defaults::getDocBaseUrl()
base URL to the documentation of your ownCloud instance
Source:lib/public/Defaults.php#102
Returns:string
Since:6.0.0
public OCP\Defaults::getName()
name of your ownCloud instance
Source:lib/public/Defaults.php#111
Returns:string
Since:6.0.0
public OCP\Defaults::getHTMLName()
name of your ownCloud instance containing HTML styles
Source:lib/public/Defaults.php#120
Returns:string
Since:8.0.0
public OCP\Defaults::getEntity()
Entity behind your onwCloud instance
Source:lib/public/Defaults.php#129
Returns:string
Since:6.0.0
public OCP\Defaults::getSlogan()
ownCloud slogan
Source:lib/public/Defaults.php#138
Returns:string
Since:6.0.0
public OCP\Defaults::getLogoClaim()
logo claim
Source:lib/public/Defaults.php#148
Returns:string
Since:6.0.0
Deprecated:13.0.0
public OCP\Defaults::getShortFooter()
footer, short version
Source:lib/public/Defaults.php#157
Returns:string
Since:6.0.0
public OCP\Defaults::getLongFooter()
footer, long version
Source:lib/public/Defaults.php#166
Returns:string
Since:6.0.0
public OCP\Defaults::getiTunesAppId()
Returns the AppId for the App Store for the iOS Client
Source:lib/public/Defaults.php#175
Returns:string AppId
Since:8.0.0
Themed logo url
Source:

lib/public/Defaults.php#186

Parameters:
  • $useSvg (bool) Whether to point to the SVG image or a fallback
Returns:

string

Since:

12.0.0

public OCP\Defaults::getColorPrimary()
Returns primary color
Source:lib/public/Defaults.php#195
Returns:string
Since:12.0.0
public OCP\Defaults::buildDocLinkToKey($key)
Source:

lib/public/Defaults.php#204

Parameters:
  • $key (string)
Returns:

string URL to doc with key

Since:

12.0.0

public OCP\Defaults::getTitle()
Returns the title
Source:lib/public/Defaults.php#213
Returns:string title
Since:12.0.0
public OCP\Defaults::getTextColorPrimary()
Returns primary color
Source:lib/public/Defaults.php#222
Returns:string
Since:13.0.0