nextcloud/lib/public/Defaults.php

218 lines
4.6 KiB
PHP
Raw Normal View History

2013-07-03 17:18:19 +04:00
<?php
/**
2016-07-21 18:07:57 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
2016-05-26 20:56:05 +03:00
* @author Björn Schießle <bjoern@schiessle.org>
2016-07-21 18:07:57 +03:00
* @author Joas Schilling <coding@schilljs.com>
2016-05-26 20:56:05 +03:00
* @author Lukas Reschke <lukas@statuscode.ch>
2015-03-26 13:44:34 +03:00
* @author Morris Jobke <hey@morrisjobke.de>
* @author Roeland Jago Douma <roeland@famdouma.nl>
2015-03-26 13:44:34 +03:00
* @author scolebrook <scolebrook@mac.com>
*
2015-03-26 13:44:34 +03:00
* @license AGPL-3.0
*
2015-03-26 13:44:34 +03:00
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
2015-03-26 13:44:34 +03:00
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
2015-03-26 13:44:34 +03:00
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
2015-03-26 13:44:34 +03:00
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
/**
* Public interface of ownCloud for apps to use.
* Defaults Class
*
*/
2013-11-03 16:38:25 +04:00
// use OCP namespace for all classes that are considered public.
// This means that they should be used by apps instead of the internal ownCloud classes
2013-07-03 17:18:19 +04:00
namespace OCP;
2013-11-25 17:26:26 +04:00
/**
2013-07-03 17:18:19 +04:00
* public api to access default strings and urls for your templates
* @since 6.0.0
2013-07-03 17:18:19 +04:00
*/
class Defaults {
2013-11-25 17:26:26 +04:00
/**
* \OC_Defaults instance to retrieve the defaults
* @since 6.0.0
2013-11-25 17:26:26 +04:00
*/
2013-07-03 17:18:19 +04:00
private $defaults;
2013-11-25 17:26:26 +04:00
/**
* creates a \OC_Defaults instance which is used in all methods to retrieve the
* actual defaults
2015-06-19 11:51:36 +03:00
* @since 6.0.0
2013-11-25 17:26:26 +04:00
*/
public function __construct(\OC_Defaults $defaults = null) {
if ($defaults === null) {
$defaults = \OC::$server->getThemingDefaults();
}
$this->defaults = $defaults;
2013-07-03 17:18:19 +04:00
}
/**
2013-11-25 17:26:26 +04:00
* get base URL for the organisation behind your ownCloud instance
2013-07-03 17:18:19 +04:00
* @return string
* @since 6.0.0
2013-07-03 17:18:19 +04:00
*/
public function getBaseUrl() {
return $this->defaults->getBaseUrl();
}
/**
2013-11-25 17:26:26 +04:00
* link to the desktop sync client
2013-07-03 17:18:19 +04:00
* @return string
* @since 6.0.0
2013-07-03 17:18:19 +04:00
*/
public function getSyncClientUrl() {
return $this->defaults->getSyncClientUrl();
}
/**
* link to the iOS client
* @return string
* @since 8.0.0
*/
public function getiOSClientUrl() {
return $this->defaults->getiOSClientUrl();
}
/**
* link to the Android client
* @return string
* @since 8.0.0
*/
public function getAndroidClientUrl() {
return $this->defaults->getAndroidClientUrl();
}
2013-07-03 17:18:19 +04:00
/**
2013-11-25 17:26:26 +04:00
* base URL to the documentation of your ownCloud instance
2013-07-03 17:18:19 +04:00
* @return string
* @since 6.0.0
2013-07-03 17:18:19 +04:00
*/
public function getDocBaseUrl() {
return $this->defaults->getDocBaseUrl();
}
/**
2013-11-25 17:26:26 +04:00
* name of your ownCloud instance
2013-07-03 17:18:19 +04:00
* @return string
* @since 6.0.0
2013-07-03 17:18:19 +04:00
*/
public function getName() {
return $this->defaults->getName();
}
2014-11-03 23:13:07 +03:00
/**
* name of your ownCloud instance containing HTML styles
* @return string
* @since 8.0.0
2014-11-03 23:13:07 +03:00
*/
public function getHTMLName() {
return $this->defaults->getHTMLName();
}
2013-07-03 17:18:19 +04:00
/**
2013-11-25 17:26:26 +04:00
* Entity behind your onwCloud instance
2013-07-03 17:18:19 +04:00
* @return string
* @since 6.0.0
2013-07-03 17:18:19 +04:00
*/
public function getEntity() {
return $this->defaults->getEntity();
}
/**
2013-11-25 17:26:26 +04:00
* ownCloud slogan
2013-07-03 17:18:19 +04:00
* @return string
* @since 6.0.0
2013-07-03 17:18:19 +04:00
*/
public function getSlogan(?string $lang = null) {
return $this->defaults->getSlogan($lang);
2013-07-03 17:18:19 +04:00
}
/**
2013-11-25 17:26:26 +04:00
* footer, short version
2013-07-03 17:18:19 +04:00
* @return string
* @since 6.0.0
2013-07-03 17:18:19 +04:00
*/
public function getShortFooter() {
return $this->defaults->getShortFooter();
}
/**
2013-11-25 17:26:26 +04:00
* footer, long version
2013-07-03 17:18:19 +04:00
* @return string
* @since 6.0.0
2013-07-03 17:18:19 +04:00
*/
public function getLongFooter() {
return $this->defaults->getLongFooter();
}
/**
* Returns the AppId for the App Store for the iOS Client
* @return string AppId
* @since 8.0.0
*/
public function getiTunesAppId() {
return $this->defaults->getiTunesAppId();
}
/**
* Themed logo url
*
* @param bool $useSvg Whether to point to the SVG image or a fallback
* @return string
* @since 12.0.0
*/
public function getLogo($useSvg = true) {
return $this->defaults->getLogo($useSvg);
}
/**
* Returns primary color
* @return string
* @since 12.0.0
*/
public function getColorPrimary() {
return $this->defaults->getColorPrimary();
}
/**
* @param string $key
* @return string URL to doc with key
* @since 12.0.0
*/
public function buildDocLinkToKey($key) {
return $this->defaults->buildDocLinkToKey($key);
}
/**
* Returns the title
* @return string title
* @since 12.0.0
*/
public function getTitle() {
return $this->defaults->getTitle();
}
/**
* Returns primary color
* @return string
* @since 13.0.0
*/
public function getTextColorPrimary() {
return $this->defaults->getTextColorPrimary();
}
2013-07-03 17:18:19 +04:00
}