\OCPIURLGenerator

Class to generate URLs

Summary

Methods
Constants
linkToRoute()
linkToRouteAbsolute()
linkTo()
imagePath()
getAbsoluteURL()
linkToDocs()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

linkToRoute()

linkToRoute(string  $routeName, array  $arguments = array()) : string

Returns the URL for a route

Parameters

string $routeName

the name of the route

array $arguments

an array with arguments which will be filled into the url

Returns

string —

the url

linkToRouteAbsolute()

linkToRouteAbsolute(string  $routeName, array  $arguments = array()) : string

Returns the absolute URL for a route

Parameters

string $routeName

the name of the route

array $arguments

an array with arguments which will be filled into the url

Returns

string —

the absolute url

linkTo()

linkTo(string  $appName, string  $file, array  $args = array()) : string

Returns an URL for an image or file

Parameters

string $appName

the name of the app

string $file

the name of the file

array $args

array with param=>value, will be appended to the returned url The value of $args will be urlencoded

Returns

string —

the url

imagePath()

imagePath(string  $appName, string  $file) : string

Returns the link to an image, like linkTo but only with prepending img/

Parameters

string $appName

the name of the app

string $file

the name of the file

Returns

string —

the url

getAbsoluteURL()

getAbsoluteURL(string  $url) : string

Makes an URL absolute

Parameters

string $url

the url in the ownCloud host

Returns

string —

the absolute version of the url

linkToDocs()

linkToDocs(string  $key) : string

Parameters

string $key

Returns

string —

url to the online documentation