nextcloud/lib/public/defaults.php

140 lines
2.9 KiB
PHP
Raw Normal View History

2013-07-03 17:18:19 +04:00
<?php
/**
* ownCloud
*
* @author Björn Schießle
* @copyright 2013 Björn Schießle schiessle@owncloud.com
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
*
* You should have received a copy of the GNU Affero General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
2013-07-03 17:18:19 +04:00
2013-11-03 16:38:25 +04:00
/**
* Public interface of ownCloud for apps to use.
* Defaults Class
*
*/
// 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
*/
class Defaults {
2013-11-25 17:26:26 +04:00
/**
* \OC_Defaults instance to retrieve the defaults
* @return string
*/
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
*/
2013-07-03 17:18:19 +04:00
function __construct() {
$this->defaults = new \OC_Defaults();
}
/**
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
*/
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
*/
public function getSyncClientUrl() {
return $this->defaults->getSyncClientUrl();
}
/**
* link to the iOS client
* @return string
*/
public function getiOSClientUrl() {
return $this->defaults->getiOSClientUrl();
}
/**
* link to the Android client
* @return string
*/
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
*/
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
*/
public function getName() {
return $this->defaults->getName();
}
/**
2013-11-25 17:26:26 +04:00
* Entity behind your onwCloud instance
2013-07-03 17:18:19 +04:00
* @return string
*/
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
*/
public function getSlogan() {
return $this->defaults->getSlogan();
}
/**
2013-11-25 17:26:26 +04:00
* logo claim
2013-07-03 17:18:19 +04:00
* @return string
*/
public function getLogoClaim() {
return $this->defaults->getLogoClaim();
}
/**
2013-11-25 17:26:26 +04:00
* footer, short version
2013-07-03 17:18:19 +04:00
* @return string
*/
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
*/
public function getLongFooter() {
return $this->defaults->getLongFooter();
}
}