Commit a4b7f515 authored by Bart Visscher's avatar Bart Visscher
Browse files

Fix PHPdoc in lib/private

using scrutinizer patch
parent d826f33f
......@@ -459,9 +459,11 @@ class OC_App{
return false;
}
/**
* Get the directory for the given app.
* If the app is defined in multiple directories, the first one is taken. (false if not found)
*/
* Get the directory for the given app.
* If the app is defined in multiple directories, the first one is taken. (false if not found)
* @param string $appid
* @return string|false
*/
public static function getAppPath($appid) {
if( ($dir = self::findAppInDirectories($appid)) != false) {
return $dir['path'].'/'.$appid;
......@@ -470,9 +472,11 @@ class OC_App{
}
/**
* Get the path for the given app on the access
* If the app is defined in multiple directories, the first one is taken. (false if not found)
*/
* Get the path for the given app on the access
* If the app is defined in multiple directories, the first one is taken. (false if not found)
* @param string $appid
* @return string|false
*/
public static function getAppWebPath($appid) {
if( ($dir = self::findAppInDirectories($appid)) != false) {
return OC::$WEBROOT.$dir['url'].'/'.$appid;
......@@ -482,6 +486,7 @@ class OC_App{
/**
* get the last version of the app, either from appinfo/version or from appinfo/info.xml
* @param string $appid
* @return string
*/
public static function getAppVersion($appid) {
......
......@@ -14,7 +14,7 @@ class File {
/**
* Returns the cache storage for the logged in user
* @return cache storage
* @return \OC\Files\View cache storage
*/
protected function getStorage() {
if (isset($this->storage)) {
......
......@@ -105,6 +105,7 @@ class OC_Connector_Sabre_Directory extends OC_Connector_Sabre_Node implements Sa
* Returns a specific child node, referenced by its name
*
* @param string $name
* @param OC\Files\FileInfo $info
* @throws Sabre_DAV_Exception_FileNotFound
* @return Sabre_DAV_INode
*/
......
......@@ -70,7 +70,7 @@ class OC_FileChunking {
*
* @param string $f target path
*
* @return assembled file size
* @return integer assembled file size
*
* @throws \OC\InsufficientStorageException when file could not be fully
* assembled due to lack of free space
......@@ -91,7 +91,7 @@ class OC_FileChunking {
/**
* Returns the size of the chunks already present
* @return size in bytes
* @return integer size in bytes
*/
public function getCurrentSize() {
$cache = $this->getCache();
......@@ -159,7 +159,7 @@ class OC_FileChunking {
*
* @param string $path target path
*
* @return assembled file size or false if file could not be created
* @return boolean assembled file size or false if file could not be created
*
* @throws \OC\InsufficientStorageException when file could not be fully
* assembled due to lack of free space
......@@ -216,5 +216,6 @@ class OC_FileChunking {
return false;
}
}
return false;
}
}
......@@ -363,6 +363,9 @@ abstract class Common implements \OC\Files\Storage\Storage {
return false;
}
/**
* @param string $path
*/
protected function getCachedFile($path) {
if (!isset($this->cachedFiles[$path])) {
$this->cachedFiles[$path] = $this->toTmpFile($path);
......
......@@ -360,6 +360,9 @@ class MappedLocal extends \OC\Files\Storage\Common{
$this->mapper->copy($fullPath1, $fullPath2);
}
/**
* @param string $path
*/
private function stripLeading($path) {
if(strpos($path, '/') === 0) {
$path = substr($path, 1);
......
......@@ -49,7 +49,7 @@ class OC_Image {
/**
* @brief Constructor.
* @param resource|string $imageref The path to a local file, a base64 encoded string or a resource created by
* @param resource|string $imageRef The path to a local file, a base64 encoded string or a resource created by
* an imagecreate* function.
* @return \OC_Image False on error
*/
......@@ -79,7 +79,7 @@ class OC_Image {
/**
* @brief Returns the MIME type of the image or an empty string if no image is loaded.
* @return int
* @return string
*/
public function mimeType() {
return $this->valid() ? $this->mimeType : '';
......@@ -397,7 +397,7 @@ class OC_Image {
/**
* @brief Loads an image from a local file, a base64 encoded string or a resource created by an imagecreate* function.
* @param resource|string $imageref The path to a local file, a base64 encoded string or a resource created by an imagecreate* function or a file resource (file handle ).
* @param resource|string $imageRef The path to a local file, a base64 encoded string or a resource created by an imagecreate* function or a file resource (file handle ).
* @return resource|false An image resource or false on error
*/
public function load($imageRef) {
......
......@@ -31,7 +31,7 @@ class OC_Request {
* of trusted domains. If no trusted domains have been configured, returns
* true.
* This is used to prevent Host Header Poisoning.
* @param string $host
* @param string $domain
* @return bool true if the given domain is trusted or if no trusted domains
* have been configured
*/
......@@ -76,7 +76,7 @@ class OC_Request {
/**
* Returns the overwritehost setting from the config if set and
* if the overwrite condition is met
* @return overwritehost value or null if not defined or the defined condition
* @return string|null overwritehost value or null if not defined or the defined condition
* isn't met
*/
public static function getOverwriteHost() {
......
......@@ -25,6 +25,7 @@ class Route extends SymfonyRoute implements IRoute {
/**
* Specify POST as the method to use with this route
* @return \OC\Route\Route
*/
public function post() {
$this->method('POST');
......@@ -33,6 +34,7 @@ class Route extends SymfonyRoute implements IRoute {
/**
* Specify GET as the method to use with this route
* @return \OC\Route\Route
*/
public function get() {
$this->method('GET');
......@@ -41,6 +43,7 @@ class Route extends SymfonyRoute implements IRoute {
/**
* Specify PUT as the method to use with this route
* @return \OC\Route\Route
*/
public function put() {
$this->method('PUT');
......@@ -49,6 +52,7 @@ class Route extends SymfonyRoute implements IRoute {
/**
* Specify DELETE as the method to use with this route
* @return \OC\Route\Route
*/
public function delete() {
$this->method('DELETE');
......@@ -57,6 +61,7 @@ class Route extends SymfonyRoute implements IRoute {
/**
* Specify PATCH as the method to use with this route
* @return \OC\Route\Route
*/
public function patch() {
$this->method('PATCH');
......@@ -120,6 +125,7 @@ class Route extends SymfonyRoute implements IRoute {
* The action to execute when this route matches, includes a file like
* it is called directly
* @param $file
* @return void
*/
public function actionInclude($file) {
$function = create_function('$param',
......
......@@ -81,6 +81,9 @@ class Router implements IRouter {
return $this->routingFiles;
}
/**
* @return string
*/
public function getCacheKey() {
if (!isset($this->cacheKey)) {
$files = $this->getRoutingFiles();
......@@ -94,6 +97,7 @@ class Router implements IRouter {
/**
* loads the api routes
* @return void
*/
public function loadRoutes($app = null) {
if ($this->loaded) {
......@@ -152,6 +156,7 @@ class Router implements IRouter {
* Sets the collection to use for adding routes
*
* @param string $name Name of the collection to use.
* @return void
*/
public function useCollection($name) {
$this->collection = $this->getCollection($name);
......@@ -177,6 +182,7 @@ class Router implements IRouter {
*
* @param string $url The url to find
* @throws \Exception
* @return void
*/
public function match($url) {
if (substr($url, 0, 6) === '/apps/') {
......@@ -207,6 +213,7 @@ class Router implements IRouter {
/**
* Get the url generator
* @return \Symfony\Component\Routing\Generator\UrlGenerator
*
*/
public function getGenerator() {
......
......@@ -32,9 +32,8 @@ class URLGenerator implements IURLGenerator {
* @brief Creates an url using a defined route
* @param $route
* @param array $parameters
* @return
* @internal param array $args with param=>value, will be appended to the returned url
* @returns string the url
* @return string the url
*
* Returns a url to the given app and file.
*/
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment