Nextcloud PHP API (master)

Defaults
in package

public api to access default strings and urls for your templates

Tags
since
6.0.0

Table of Contents

Properties

$defaults  : mixed
\OC_Defaults instance to retrieve the defaults

Methods

__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
getDefaultColorPrimary()  : string
Return the default color primary
getDefaultTextColorPrimary()  : string
Returns primary color
getDocBaseUrl()  : string
base URL to the documentation of your ownCloud instance
getEntity()  : string
Entity behind your onwCloud instance
getFDroidClientUrl()  : string
link to the Android client on F-Droid
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
getLongFooter()  : string
footer, long version
getName()  : string
name of your Nextcloud instance (e.g. MyPrivateCloud)
getProductName()  : string
Name of the software product (defaults to Nextcloud)
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
since
6.0.0

Methods

__construct()

creates a \OC_Defaults instance which is used in all methods to retrieve the actual defaults

public __construct([OC_Defaults|null $defaults = null ]) : mixed
Parameters
$defaults : OC_Defaults|null = null
Tags
since
6.0.0

buildDocLinkToKey()

public buildDocLinkToKey(string $key) : string
Parameters
$key : string
Tags
since
12.0.0
Return values
string —

URL to doc with key

getAndroidClientUrl()

link to the Android client

public getAndroidClientUrl() : string
Tags
since
8.0.0
Return values
string

getBaseUrl()

get base URL for the organisation behind your ownCloud instance

public getBaseUrl() : string
Tags
since
6.0.0
Return values
string

getColorPrimary()

Returns primary color

public getColorPrimary() : string
Tags
since
12.0.0
Return values
string

getDefaultColorPrimary()

Return the default color primary

public getDefaultColorPrimary() : string
Tags
since
25.0.4
Return values
string

getDefaultTextColorPrimary()

Returns primary color

public getDefaultTextColorPrimary() : string
Tags
since
25.0.4
Return values
string

getDocBaseUrl()

base URL to the documentation of your ownCloud instance

public getDocBaseUrl() : string
Tags
since
6.0.0
Return values
string

getEntity()

Entity behind your onwCloud instance

public getEntity() : string
Tags
since
6.0.0
Return values
string

getFDroidClientUrl()

link to the Android client on F-Droid

public getFDroidClientUrl() : string
Tags
since
23.0.0
Return values
string

getHTMLName()

name of your ownCloud instance containing HTML styles

public getHTMLName() : string
Tags
since
8.0.0
deprecated
22.0.0
Return values
string

getiOSClientUrl()

link to the iOS client

public getiOSClientUrl() : string
Tags
since
8.0.0
Return values
string

getiTunesAppId()

Returns the AppId for the App Store for the iOS Client

public getiTunesAppId() : string
Tags
since
8.0.0
Return values
string —

AppId

Themed logo url

public getLogo([bool $useSvg = true ]) : string
Parameters
$useSvg : bool = true

Whether to point to the SVG image or a fallback

Tags
since
12.0.0
Return values
string

getLongFooter()

footer, long version

public getLongFooter() : string
Tags
since
6.0.0
Return values
string

getName()

name of your Nextcloud instance (e.g. MyPrivateCloud)

public getName() : string
Tags
since
6.0.0
Return values
string

getProductName()

Name of the software product (defaults to Nextcloud)

public getProductName() : string
Tags
since
22.0.0
Return values
string

getShortFooter()

footer, short version

public getShortFooter() : string
Tags
since
6.0.0
Return values
string

getSlogan()

ownCloud slogan

public getSlogan([string|null $lang = null ]) : string
Parameters
$lang : string|null = null
Tags
since
6.0.0
Return values
string

getSyncClientUrl()

link to the desktop sync client

public getSyncClientUrl() : string
Tags
since
6.0.0
Return values
string

getTextColorPrimary()

Returns primary color

public getTextColorPrimary() : string
Tags
since
13.0.0
Return values
string

getTitle()

Returns the title

public getTitle() : string
Tags
since
12.0.0
Return values
string —

title


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results