2013-09-26 16:41:19 +00:00
|
|
|
<?php
|
|
|
|
/**
|
2013-11-03 12:51:39 +00:00
|
|
|
* ownCloud
|
|
|
|
*
|
|
|
|
* @author Bart Visscher
|
|
|
|
* @copyright 2013 Bart Visscher bartv@thisnet.nl
|
|
|
|
*
|
|
|
|
* 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-09-26 16:41:19 +00:00
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
2013-11-03 12:38:25 +00:00
|
|
|
/**
|
|
|
|
* Public interface of ownCloud for apps to use.
|
|
|
|
* URL generator interface
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
// 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-09-26 16:41:19 +00:00
|
|
|
namespace OCP;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Class to generate URLs
|
|
|
|
*/
|
|
|
|
interface IURLGenerator {
|
|
|
|
/**
|
|
|
|
* Returns the URL for a route
|
|
|
|
* @param string $routeName the name of the route
|
|
|
|
* @param array $arguments an array with arguments which will be filled into the url
|
|
|
|
* @return string the url
|
|
|
|
*/
|
|
|
|
public function linkToRoute($routeName, $arguments = array());
|
|
|
|
|
2014-09-08 12:43:14 +00:00
|
|
|
/**
|
|
|
|
* Returns the absolute URL for a route
|
|
|
|
* @param string $routeName the name of the route
|
|
|
|
* @param array $arguments an array with arguments which will be filled into the url
|
|
|
|
* @return string the absolute url
|
|
|
|
*/
|
|
|
|
public function linkToRouteAbsolute($routeName, $arguments = array());
|
|
|
|
|
2013-09-26 16:41:19 +00:00
|
|
|
/**
|
|
|
|
* Returns an URL for an image or file
|
|
|
|
* @param string $appName the name of the app
|
|
|
|
* @param string $file the name of the file
|
|
|
|
* @return string the url
|
|
|
|
*/
|
|
|
|
public function linkTo($appName, $file);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the link to an image, like linkTo but only with prepending img/
|
|
|
|
* @param string $appName the name of the app
|
|
|
|
* @param string $file the name of the file
|
|
|
|
* @return string the url
|
|
|
|
*/
|
|
|
|
public function imagePath($appName, $file);
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Makes an URL absolute
|
|
|
|
* @param string $url the url in the owncloud host
|
|
|
|
* @return string the absolute version of the url
|
|
|
|
*/
|
|
|
|
public function getAbsoluteURL($url);
|
|
|
|
}
|