mbk-lab
/
nextcloud
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fix all PHPDoc types and variable names, in /lib

This commit is contained in:
Robin McCorkell 2014-05-11 21:51:30 +01:00
parent a7ae2e874a
commit 87b548ed91
75 changed files with 255 additions and 263 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
lib/private/appframework/dependencyinjection/dicontainer.php
View File

@ -190,8 +190,8 @@ class DIContainer extends SimpleContainer implements IAppContainer{
} }
/** /**
* @param $message * @param string $message
* @param $level * @param string $level
* @return mixed * @return mixed
*/ */
function log($message, $level) { function log($message, $level) {

2
lib/private/appframework/http.php
View File

@ -33,7 +33,7 @@ class Http extends BaseHttp {
protected $headers; protected $headers;
/** /**
* @param $_SERVER $server * @param array $server $_SERVER
* @param string $protocolVersion the http version to use defaults to HTTP/1.1 * @param string $protocolVersion the http version to use defaults to HTTP/1.1
*/ */
public function __construct($server, $protocolVersion='HTTP/1.1') { public function __construct($server, $protocolVersion='HTTP/1.1') {

12
lib/private/appframework/routing/routeconfig.php
View File

@ -61,7 +61,7 @@ class RouteConfig {
/** /**
* Creates one route base on the give configuration * Creates one route base on the give configuration
* @param $routes * @param array $routes
* @throws \UnexpectedValueException * @throws \UnexpectedValueException
*/ */
private function processSimpleRoutes($routes) private function processSimpleRoutes($routes)
@ -105,7 +105,7 @@ class RouteConfig {
* - update * - update
* - destroy * - destroy
* *
* @param $routes * @param array $routes
*/ */
private function processResources($routes) private function processResources($routes)
{ {
@ -151,7 +151,7 @@ class RouteConfig {
/** /**
* Based on a given route name the controller name is generated * Based on a given route name the controller name is generated
* @param $controller * @param string $controller
* @return string * @return string
*/ */
private function buildControllerName($controller) private function buildControllerName($controller)
@ -161,7 +161,7 @@ class RouteConfig {
/** /**
* Based on the action part of the route name the controller method name is generated * Based on the action part of the route name the controller method name is generated
* @param $action * @param string $action
* @return string * @return string
*/ */
private function buildActionName($action) { private function buildActionName($action) {
@ -170,7 +170,7 @@ class RouteConfig {
/** /**
* Generates the id used in the url part o the route url * Generates the id used in the url part o the route url
* @param $resource * @param string $resource
* @return string * @return string
*/ */
private function buildResourceId($resource) { private function buildResourceId($resource) {
@ -179,7 +179,7 @@ class RouteConfig {
/** /**
* Underscored strings are converted to camel case strings * Underscored strings are converted to camel case strings
* @param $str string * @param string $str
* @return string * @return string
*/ */
private function underScoreToCamelCase($str) { private function underScoreToCamelCase($str) {

2
lib/private/archive/tar.php
View File

@ -154,7 +154,7 @@ class OC_Archive_TAR extends OC_Archive{
} }
/** /**
* get the last modified time of a file in the archive * get the last modified time of a file in the archive
* @param string path * @param string $path
* @return int * @return int
*/ */
function mtime($path) { function mtime($path) {

6
lib/private/avatar.php
View File

@ -16,7 +16,7 @@ class OC_Avatar implements \OCP\IAvatar {
/** /**
* @brief constructor * @brief constructor
* @param $user string user to do avatar-management with * @param string $user user to do avatar-management with
*/ */
public function __construct ($user) { public function __construct ($user) {
$this->view = new \OC\Files\View('/'.$user); $this->view = new \OC\Files\View('/'.$user);
@ -24,7 +24,7 @@ class OC_Avatar implements \OCP\IAvatar {
/** /**
* @brief get the users avatar * @brief get the users avatar
* @param $size integer size in px of the avatar, avatars are square, defaults to 64 * @param int $size size in px of the avatar, avatars are square, defaults to 64
* @return boolean|\OC_Image containing the avatar or false if there's no image * @return boolean|\OC_Image containing the avatar or false if there's no image
*/ */
public function get ($size = 64) { public function get ($size = 64) {
@ -44,7 +44,7 @@ class OC_Avatar implements \OCP\IAvatar {
/** /**
* @brief sets the users avatar * @brief sets the users avatar
* @param $data mixed OC_Image, imagedata or path to set a new avatar * @param \OC_Image|resource|string $data OC_Image, imagedata or path to set a new avatar
* @throws Exception if the provided file is not a jpg or png image * @throws Exception if the provided file is not a jpg or png image
* @throws Exception if the provided image is not valid * @throws Exception if the provided image is not valid
* @throws \OC\NotSquareException if the image is not square * @throws \OC\NotSquareException if the image is not square

2
lib/private/avatarmanager.php
View File

@ -17,7 +17,7 @@ class AvatarManager implements IAvatarManager {
/** /**
* @brief return a user specific instance of \OCP\IAvatar * @brief return a user specific instance of \OCP\IAvatar
* @see \OCP\IAvatar * @see \OCP\IAvatar
* @param $user string the ownCloud user id * @param string $user the ownCloud user id
* @return \OCP\IAvatar * @return \OCP\IAvatar
*/ */
function getAvatar($user) { function getAvatar($user) {

8
lib/private/backgroundjob/joblist.php
View File

@ -31,7 +31,7 @@ class JobList implements IJobList {
} }
/** /**
* @param \Test\BackgroundJob\TestJob $job * @param Job|string $job
* @param mixed $argument * @param mixed $argument
*/ */
public function add($job, $argument = null) { public function add($job, $argument = null) {
@ -48,7 +48,7 @@ class JobList implements IJobList {
} }
/** /**
* @param Job $job * @param Job|string $job
* @param mixed $argument * @param mixed $argument
*/ */
public function remove($job, $argument = null) { public function remove($job, $argument = null) {
@ -70,7 +70,7 @@ class JobList implements IJobList {
/** /**
* check if a job is in the list * check if a job is in the list
* *
* @param $job * @param Job|string $job
* @param mixed $argument * @param mixed $argument
* @return bool * @return bool
*/ */
@ -126,7 +126,7 @@ class JobList implements IJobList {
/** /**
* @param int $id * @param int $id
* @return Job * @return Job|null
*/ */
public function getById($id) { public function getById($id) {
$query = $this->conn->prepare('SELECT `id`, `class`, `last_run`, `argument` FROM `*PREFIX*jobs` WHERE `id` = ?'); $query = $this->conn->prepare('SELECT `id`, `class`, `last_run`, `argument` FROM `*PREFIX*jobs` WHERE `id` = ?');

2
lib/private/cache/file.php vendored
View File

@ -48,7 +48,7 @@ class File {
/** /**
* Returns the size of the stored/cached data * Returns the size of the stored/cached data
* *
* @param $key * @param string $key
* @return int * @return int
*/ */
public function size($key) { public function size($key) {

2
lib/private/connector/sabre/auth.php
View File

@ -69,6 +69,8 @@ class OC_Connector_Sabre_Auth extends Sabre_DAV_Auth_Backend_AbstractBasic {
* even if there are no HTTP Basic Auth headers. * even if there are no HTTP Basic Auth headers.
* In other case, just fallback to the parent implementation. * In other case, just fallback to the parent implementation.
* *
* @param Sabre_DAV_Server $server
* @param $realm
* @return bool * @return bool
*/ */
public function authenticate(Sabre_DAV_Server $server, $realm) { public function authenticate(Sabre_DAV_Server $server, $realm) {

2
lib/private/connector/sabre/filesplugin.php
View File

@ -73,7 +73,7 @@ class OC_Connector_Sabre_FilesPlugin extends Sabre_DAV_ServerPlugin
} }
/** /**
* @param $filePath * @param string $filePath
* @param Sabre_DAV_INode $node * @param Sabre_DAV_INode $node
* @throws Sabre_DAV_Exception_BadRequest * @throws Sabre_DAV_Exception_BadRequest
*/ */

2
lib/private/connector/sabre/quotaplugin.php
View File

@ -97,7 +97,7 @@ class OC_Connector_Sabre_QuotaPlugin extends Sabre_DAV_ServerPlugin {
} }
/** /**
* @param $parentUri * @param string $parentUri
* @return mixed * @return mixed
*/ */
public function getFreeSpace($parentUri) { public function getFreeSpace($parentUri) {

2
lib/private/db.php
View File

@ -401,7 +401,7 @@ class OC_DB {
/** /**
* @brief replaces the ownCloud tables with a new set * @brief replaces the ownCloud tables with a new set
* @param $file string path to the MDB2 xml db export file * @param string $file path to the MDB2 xml db export file
*/ */
public static function replaceDB( $file ) { public static function replaceDB( $file ) {
$schemaManager = self::getMDB2SchemaManager(); $schemaManager = self::getMDB2SchemaManager();

4
lib/private/db/connectionwrapper.php
View File

@ -41,8 +41,8 @@ class ConnectionWrapper implements \OCP\IDBConnection {
/** /**
* Insert a row if a matching row doesn't exists. * Insert a row if a matching row doesn't exists.
* @param string The table name (will replace *PREFIX*) to perform the replace on. * @param string $table The table name (will replace *PREFIX*) to perform the replace on.
* @param array * @param array $input
* *
* The input array if in the form: * The input array if in the form:
* *

2
lib/private/db/mdb2schemamanager.php
View File

@ -126,7 +126,7 @@ class MDB2SchemaManager {
/** /**
* @brief replaces the ownCloud tables with a new set * @brief replaces the ownCloud tables with a new set
* @param $file string path to the MDB2 xml db export file * @param string $file path to the MDB2 xml db export file
*/ */
public function replaceDB( $file ) { public function replaceDB( $file ) {
$apps = \OC_App::getAllApps(); $apps = \OC_App::getAllApps();

2
lib/private/db/mdb2schemareader.php
View File

@ -66,7 +66,7 @@ class MDB2SchemaReader {
} }
/** /**
* @param\Doctrine\DBAL\Schema\Schema $schema * @param \Doctrine\DBAL\Schema\Schema $schema
* @param \SimpleXMLElement $xml * @param \SimpleXMLElement $xml
* @throws \DomainException * @throws \DomainException
*/ */

2
lib/private/defaults.php
View File

@ -185,7 +185,7 @@ class OC_Defaults {
/** /**
* Returns mail header color * Returns mail header color
* @return mail header color * @return string
*/ */
public function getMailHeaderColor() { public function getMailHeaderColor() {
if ($this->themeExist('getMailHeaderColor')) { if ($this->themeExist('getMailHeaderColor')) {

2
lib/private/fileproxy.php
View File

@ -47,7 +47,7 @@ class OC_FileProxy{
/** /**
* fallback function when a proxy operation is not implemented * fallback function when a proxy operation is not implemented
* @param string $function the name of the proxy operation * @param string $function the name of the proxy operation
* @param mixed * @param mixed $arguments
* *
* this implements a dummy proxy for all operations * this implements a dummy proxy for all operations
*/ */

2
lib/private/files/cache/cache.php vendored
View File

@ -640,7 +640,7 @@ class Cache {
/** /**
* normalize the given path * normalize the given path
* @param $path * @param string $path
* @return string * @return string
*/ */
public function normalize($path) { public function normalize($path) {

2
lib/private/files/cache/scanner.php vendored
View File

@ -273,7 +273,7 @@ class Scanner extends BasicEmitter {
* @brief check if the file should be ignored when scanning * @brief check if the file should be ignored when scanning
* NOTE: files with a '.part' extension are ignored as well! * NOTE: files with a '.part' extension are ignored as well!
* prevents unfinished put requests to be scanned * prevents unfinished put requests to be scanned
* @param String $file * @param string $file
* @return boolean * @return boolean
*/ */
public static function isPartialFile($file) { public static function isPartialFile($file) {

4
lib/private/files/filesystem.php
View File

@ -245,7 +245,7 @@ class Filesystem {
} }
/** /**
* @param $id * @param string $id
* @return Mount\Mount[] * @return Mount\Mount[]
*/ */
public static function getMountByStorageId($id) { public static function getMountByStorageId($id) {
@ -256,7 +256,7 @@ class Filesystem {
} }
/** /**
* @param $id * @param int $id
* @return Mount\Mount[] * @return Mount\Mount[]
*/ */
public static function getMountByNumericId($id) { public static function getMountByNumericId($id) {

4
lib/private/files/mapper.php
View File

@ -97,8 +97,8 @@ class Mapper
} }
/** /**
* @param $path * @param string $path
* @param $root * @param string $root
* @return false|string * @return false|string
*/ */
public function stripRootFolder($path, $root) { public function stripRootFolder($path, $root) {

6
lib/private/files/mount/manager.php
View File

@ -33,7 +33,7 @@ class Manager {
/** /**
* Find the mount for $path * Find the mount for $path
* *
* @param $path * @param string $path
* @return Mount * @return Mount
*/ */
public function find($path) { public function find($path) {
@ -61,7 +61,7 @@ class Manager {
/** /**
* Find all mounts in $path * Find all mounts in $path
* *
* @param $path * @param string $path
* @return Mount[] * @return Mount[]
*/ */
public function findIn($path) { public function findIn($path) {
@ -112,7 +112,7 @@ class Manager {
/** /**
* Find mounts by numeric storage id * Find mounts by numeric storage id
* *
* @param string $id * @param int $id
* @return Mount[] * @return Mount[]
*/ */
public function findByNumericId($id) { public function findByNumericId($id) {

2
lib/private/files/node/folder.php
View File

@ -296,7 +296,7 @@ class Folder extends Node implements \OCP\Files\Folder {
} }
/** /**
* @param $id * @param int $id
* @return \OC\Files\Node\Node[] * @return \OC\Files\Node\Node[]
*/ */
public function getById($id) { public function getById($id) {

4
lib/private/files/storage/common.php
View File

@ -317,7 +317,7 @@ abstract class Common implements \OC\Files\Storage\Storage {
* clean a path, i.e. remove all redundant '.' and '..' * clean a path, i.e. remove all redundant '.' and '..'
* making sure that it can't point to higher than '/' * making sure that it can't point to higher than '/'
* *
* @param $path The path to clean * @param string $path The path to clean
* @return string cleaned path * @return string cleaned path
*/ */
public function cleanPath($path) { public function cleanPath($path) {
@ -347,7 +347,7 @@ abstract class Common implements \OC\Files\Storage\Storage {
/** /**
* get the free space in the storage * get the free space in the storage
* *
* @param $path * @param string $path
* @return int * @return int
*/ */
public function free_space($path) { public function free_space($path) {

2
lib/private/files/storage/wrapper/quota.php
View File

@ -30,7 +30,7 @@ class Quota extends Wrapper {
} }
/** /**
* @return quota value * @return int quota value
*/ */
public function getQuota() { public function getQuota() {
return $this->quota; return $this->quota;

4
lib/private/geo.php
View File

@ -8,8 +8,8 @@
class OC_Geo{ class OC_Geo{
/** /**
* @brief returns the closest timezone to coordinates * @brief returns the closest timezone to coordinates
* @param $latitude * @param float $latitude
* @param $longitude * @param float $longitude
* @return mixed Closest timezone * @return mixed Closest timezone
*/ */
public static function timezone($latitude, $longitude) { public static function timezone($latitude, $longitude) {

2
lib/private/group.php
View File

@ -58,7 +58,7 @@ class OC_Group {
/** /**
* @brief set the group backend * @brief set the group backend
* @param \OC_Group_Backend $backend The backend to use for user managment * @param \OC_Group_Backend $backend The backend to use for user managment
* @return bool * @return bool
*/ */
public static function useBackend($backend) { public static function useBackend($backend) {

26
lib/private/group/dummy.php
View File

@ -29,7 +29,7 @@ class OC_Group_Dummy extends OC_Group_Backend {
/** /**
* @brief Try to create a new group * @brief Try to create a new group
* @param string $gid The name of the group to create * @param string $gid The name of the group to create
* @return true/false * @return bool
* *
* Trys to create a new group. If the group name already exists, false will * Trys to create a new group. If the group name already exists, false will
* be returned. * be returned.
@ -45,8 +45,8 @@ class OC_Group_Dummy extends OC_Group_Backend {
/** /**
* @brief delete a group * @brief delete a group
* @param $gid gid of the group to delete * @param string $gid gid of the group to delete
* @return true/false * @return bool
* *
* Deletes a group and removes it from the group_user-table * Deletes a group and removes it from the group_user-table
*/ */
@ -61,9 +61,9 @@ class OC_Group_Dummy extends OC_Group_Backend {
/** /**
* @brief is user in group? * @brief is user in group?
* @param $uid uid of the user * @param string $uid uid of the user
* @param $gid gid of the group * @param string $gid gid of the group
* @return true/false * @return bool
* *
* Checks whether the user is member of a group or not. * Checks whether the user is member of a group or not.
*/ */
@ -77,9 +77,9 @@ class OC_Group_Dummy extends OC_Group_Backend {
/** /**
* @brief Add a user to a group * @brief Add a user to a group
* @param $uid Name of the user to add to group * @param string $uid Name of the user to add to group
* @param $gid Name of the group in which add the user * @param string $gid Name of the group in which add the user
* @return true/false * @return bool
* *
* Adds a user to a group. * Adds a user to a group.
*/ */
@ -98,9 +98,9 @@ class OC_Group_Dummy extends OC_Group_Backend {
/** /**
* @brief Removes a user from a group * @brief Removes a user from a group
* @param $uid NameUSER of the user to remove from group * @param string $uid Name of the user to remove from group
* @param $gid Name of the group from which remove the user * @param string $gid Name of the group from which remove the user
* @return true/false * @return bool
* *
* removes the user from a group. * removes the user from a group.
*/ */
@ -118,7 +118,7 @@ class OC_Group_Dummy extends OC_Group_Backend {
/** /**
* @brief Get all groups a user belongs to * @brief Get all groups a user belongs to
* @param $uid Name of the user * @param string $uid Name of the user
* @return array an array of group names * @return array an array of group names
* *
* This function fetches all groups a user belongs to. It does not check * This function fetches all groups a user belongs to. It does not check

28
lib/private/group/example.php
View File

@ -28,8 +28,8 @@
abstract class OC_Group_Example { abstract class OC_Group_Example {
/** /**
* @brief Try to create a new group * @brief Try to create a new group
* @param $gid The name of the group to create * @param string $gid The name of the group to create
* @return true/false * @return bool
* *
* Trys to create a new group. If the group name already exists, false will * Trys to create a new group. If the group name already exists, false will
* be returned. * be returned.
@ -38,8 +38,8 @@ abstract class OC_Group_Example {
/** /**
* @brief delete a group * @brief delete a group
* @param $gid gid of the group to delete * @param string $gid gid of the group to delete
* @return true/false * @return bool
* *
* Deletes a group and removes it from the group_user-table * Deletes a group and removes it from the group_user-table
*/ */
@ -47,9 +47,9 @@ abstract class OC_Group_Example {
/** /**
* @brief is user in group? * @brief is user in group?
* @param $uid uid of the user * @param string $uid uid of the user
* @param $gid gid of the group * @param string $gid gid of the group
* @return true/false * @return bool
* *
* Checks whether the user is member of a group or not. * Checks whether the user is member of a group or not.
*/ */
@ -57,9 +57,9 @@ abstract class OC_Group_Example {
/** /**
* @brief Add a user to a group * @brief Add a user to a group
* @param $uid Name of the user to add to group * @param string $uid Name of the user to add to group
* @param $gid Name of the group in which add the user * @param string $gid Name of the group in which add the user
* @return true/false * @return bool
* *
* Adds a user to a group. * Adds a user to a group.
*/ */
@ -67,9 +67,9 @@ abstract class OC_Group_Example {
/** /**
* @brief Removes a user from a group * @brief Removes a user from a group
* @param $uid NameUSER of the user to remove from group * @param string $uid Name of the user to remove from group
* @param $gid Name of the group from which remove the user * @param string $gid Name of the group from which remove the user
* @return true/false * @return bool
* *
* removes the user from a group. * removes the user from a group.
*/ */
@ -77,7 +77,7 @@ abstract class OC_Group_Example {
/** /**
* @brief Get all groups a user belongs to * @brief Get all groups a user belongs to
* @param $uid Name of the user * @param string $uid Name of the user
* @return array an array of group names * @return array an array of group names
* *
* This function fetches all groups a user belongs to. It does not check * This function fetches all groups a user belongs to. It does not check

14
lib/private/helper.php
View File

@ -32,7 +32,7 @@ class OC_Helper {
/** /**
* @brief Creates an url using a defined route * @brief Creates an url using a defined route
* @param $route * @param string $route
* @param array $parameters * @param array $parameters
* @return * @return
* @internal param array $args with param=>value, will be appended to the returned url * @internal param array $args with param=>value, will be appended to the returned url
@ -495,7 +495,7 @@ class OC_Helper {
/** /**
* detect if a given program is found in the search PATH * detect if a given program is found in the search PATH
* *
* @param $name * @param string $name
* @param bool $path * @param bool $path
* @internal param string $program name * @internal param string $program name
* @internal param string $optional search path, defaults to $PATH * @internal param string $optional search path, defaults to $PATH
@ -670,8 +670,8 @@ class OC_Helper {
/** /**
* Adds a suffix to the name in case the file exists * Adds a suffix to the name in case the file exists
* *
* @param $path * @param string $path
* @param $filename * @param string $filename
* @return string * @return string
*/ */
public static function buildNotExistingFileName($path, $filename) { public static function buildNotExistingFileName($path, $filename) {
@ -682,8 +682,8 @@ class OC_Helper {
/** /**
* Adds a suffix to the name in case the file exists * Adds a suffix to the name in case the file exists
* *
* @param $path * @param string $path
* @param $filename * @param string $filename
* @return string * @return string
*/ */
public static function buildNotExistingFileNameForView($path, $filename, \OC\Files\View $view) { public static function buildNotExistingFileNameForView($path, $filename, \OC\Files\View $view) {
@ -775,7 +775,7 @@ class OC_Helper {
/** /**
* @brief replaces a copy of string delimited by the start and (optionally) length parameters with the string given in replacement. * @brief replaces a copy of string delimited by the start and (optionally) length parameters with the string given in replacement.
* *
* @param $string * @param string $string
* @param string $replacement The replacement string. * @param string $replacement The replacement string.
* @param int $start If start is positive, the replacing will begin at the start'th offset into string. If start is negative, the replacing will begin at the start'th character from the end of string. * @param int $start If start is positive, the replacing will begin at the start'th offset into string. If start is negative, the replacing will begin at the start'th character from the end of string.
* @param int $length Length of the part to be replaced * @param int $length Length of the part to be replaced

2
lib/private/image.php
View File

@ -424,7 +424,7 @@ class OC_Image {
* @brief Loads an image from an open file handle. * @brief Loads an image from an open file handle.
* It is the responsibility of the caller to position the pointer at the correct place and to close the handle again. * It is the responsibility of the caller to position the pointer at the correct place and to close the handle again.
* @param resource $handle * @param resource $handle
* @return An image resource or false on error * @return resource|false An image resource or false on error
*/ */
public function loadFromFileHandle($handle) { public function loadFromFileHandle($handle) {
OC_Log::write('core', __METHOD__.'(): Trying', OC_Log::DEBUG); OC_Log::write('core', __METHOD__.'(): Trying', OC_Log::DEBUG);

4
lib/private/installer.php
View File

@ -221,7 +221,7 @@ class OC_Installer{
/** /**
* @brief checks whether or not an app is installed * @brief checks whether or not an app is installed
* @param string $app app * @param string $app app
* @return true/false * @return bool
* *
* Checks whether or not an app is installed, i.e. registered in apps table. * Checks whether or not an app is installed, i.e. registered in apps table.
*/ */
@ -313,7 +313,7 @@ class OC_Installer{
/** /**
* @brief Removes an app * @brief Removes an app
* @param string $name name of the application to remove * @param string $name name of the application to remove
* @param $options array with options * @param array $options options
* @return boolean|null * @return boolean|null
* *
* This function removes an app. $options is an associative array. The * This function removes an app. $options is an associative array. The

2
lib/private/l10n.php
View File

@ -183,7 +183,7 @@ class OC_L10N implements \OCP\IL10N {
* *
* Parts of the code is copied from Habari: * Parts of the code is copied from Habari:
* https://github.com/habari/system/blob/master/classes/locale.php * https://github.com/habari/system/blob/master/classes/locale.php
* @param $string string * @param string $string
* @return string * @return string
*/ */
protected function createPluralFormFunction($string){ protected function createPluralFormFunction($string){

4
lib/private/l10n/factory.php
View File

@ -20,8 +20,8 @@ class Factory {
/** /**
* get an L10N instance * get an L10N instance
* @param $app string * @param string $app
* @param $lang string|null * @param string|null $lang
* @return \OC_L10N * @return \OC_L10N
*/ */
public function get($app) { public function get($app) {

4
lib/private/migrate.php
View File

@ -333,7 +333,7 @@ class OC_Migrate{
/** /**
* @brief tries to extract the import zip * @brief tries to extract the import zip
* @param $path string path to the zip * @param string $path path to the zip
* @return string path to extract location (with a trailing slash) or false on failure * @return string path to extract location (with a trailing slash) or false on failure
*/ */
static private function extractZip( $path ) { static private function extractZip( $path ) {
@ -536,7 +536,7 @@ class OC_Migrate{
/** /**
* @brief imports a new user * @brief imports a new user
* @param string $db string path to migration.db * @param string $db string path to migration.db
* @param $info object of migration info * @param object $info object of migration info
* @param string|null|int $uid uid to use * @param string|null|int $uid uid to use
* @return array an array of apps with import statuses, or false on failure. * @return array an array of apps with import statuses, or false on failure.
*/ */

16
lib/private/migration/content.php
View File

@ -35,7 +35,7 @@ class OC_Migration_Content{
/** /**
* @brief sets up the * @brief sets up the
* @param ZipArchive $zip ZipArchive object * @param ZipArchive $zip ZipArchive object
* @param $db a database object (required for exporttype user) * @param object $db a database object (required for exporttype user)
* @return bool|null * @return bool|null
*/ */
public function __construct( $zip, $db=null ) { public function __construct( $zip, $db=null ) {
@ -45,11 +45,9 @@ class OC_Migration_Content{
} }
// @brief prepares the db
// @param $query the sql query to prepare
/** /**
* @param string $query * @brief prepares the db
* @param string $query the sql query to prepare
*/ */
public function prepare( $query ) { public function prepare( $query ) {
@ -88,7 +86,7 @@ class OC_Migration_Content{
/** /**
* @brief copys rows to migration.db from the main database * @brief copys rows to migration.db from the main database
* @param $options array of options. * @param array $options array of options.
* @return bool * @return bool
*/ */
public function copyRows( $options ) { public function copyRows( $options ) {
@ -131,7 +129,7 @@ class OC_Migration_Content{
/** /**
* @brief saves a sql data set into migration.db * @brief saves a sql data set into migration.db
* @param OC_DB_StatementWrapper $data a sql data set returned from self::prepare()->query() * @param OC_DB_StatementWrapper $data a sql data set returned from self::prepare()->query()
* @param $options array of copyRows options * @param array $options array of copyRows options
* @return void * @return void
*/ */
private function insertData( $data, $options ) { private function insertData( $data, $options ) {
@ -170,8 +168,8 @@ class OC_Migration_Content{
/** /**
* @brief adds a directory to the zip object * @brief adds a directory to the zip object
* @param boolean|string $dir string path of the directory to add * @param boolean|string $dir string path of the directory to add
* @param $recursive bool * @param bool $recursive
* @param $internaldir string path of folder to add dir to in zip * @param string $internaldir path of folder to add dir to in zip
* @return bool * @return bool
*/ */
public function addDir( $dir, $recursive=true, $internaldir='' ) { public function addDir( $dir, $recursive=true, $internaldir='' ) {

4
lib/private/ocs.php
View File

@ -213,8 +213,8 @@ class OC_OCS {
} }
/** /**
* @param $writer * @param resource $writer
* @param $data * @param array $data
* @param string $node * @param string $node
*/ */
public static function toXml($writer, $data, $node) { public static function toXml($writer, $data, $node) {

4
lib/private/ocs/cloud.php
View File

@ -57,8 +57,8 @@ class OC_OCS_Cloud {
* </quota> * </quota>
* </data> * </data>
* *
* @param $parameters object should contain parameter 'userid' which identifies * @param array $parameters should contain parameter 'userid' which identifies
* the user from whom the information will be returned * the user from whom the information will be returned
*/ */
public static function getUser($parameters) { public static function getUser($parameters) {
$return = array(); $return = array();

6
lib/private/ocs/result.php
View File

@ -26,7 +26,7 @@ class OC_OCS_Result{
/** /**
* create the OCS_Result object * create the OCS_Result object
* @param $data mixed the data to return * @param mixed $data the data to return
*/ */
public function __construct($data=null, $code=100, $message=null) { public function __construct($data=null, $code=100, $message=null) {
if ($data === null) { if ($data === null) {
@ -42,7 +42,7 @@ class OC_OCS_Result{
/** /**
* optionally set the total number of items available * optionally set the total number of items available
* @param $items int * @param int $items
*/ */
public function setTotalItems(int $items) { public function setTotalItems(int $items) {
$this->items = $items; $this->items = $items;
@ -50,7 +50,7 @@ class OC_OCS_Result{
/** /**
* optionally set the the number of items per page * optionally set the the number of items per page
* @param $items int * @param int $items
*/ */
public function setItemsPerPage(int $items) { public function setItemsPerPage(int $items) {
$this->perPage = $items; $this->perPage = $items;

2
lib/private/ocsclient.php
View File

@ -95,7 +95,7 @@ class OC_OCSClient{
* @return array an array of application data * @return array an array of application data
* *
* This function returns a list of all the applications on the OCS server * This function returns a list of all the applications on the OCS server
* @param $categories * @param array|string $categories
* @param int $page * @param int $page
* @param string $filter * @param string $filter
*/ */

10
lib/private/preview.php
View File

@ -191,7 +191,7 @@ class Preview {
/** /**
* @brief set the path of the file you want a thumbnail from * @brief set the path of the file you want a thumbnail from
* @param string $file * @param string $file
* @return $this * @return object $this
*/ */
public function setFile($file) { public function setFile($file) {
$this->file = $file; $this->file = $file;
@ -217,7 +217,7 @@ class Preview {
* @brief set the the max width of the preview * @brief set the the max width of the preview
* @param int $maxX * @param int $maxX
* @throws \Exception * @throws \Exception
* @return $this * @return \OC\Preview $this
*/ */
public function setMaxX($maxX = 1) { public function setMaxX($maxX = 1) {
if ($maxX <= 0) { if ($maxX <= 0) {
@ -238,7 +238,7 @@ class Preview {
* @brief set the the max height of the preview * @brief set the the max height of the preview
* @param int $maxY * @param int $maxY
* @throws \Exception * @throws \Exception
* @return $this * @return \OC\Preview $this
*/ */
public function setMaxY($maxY = 1) { public function setMaxY($maxY = 1) {
if ($maxY <= 0) { if ($maxY <= 0) {
@ -258,7 +258,7 @@ class Preview {
/** /**
* @brief set whether or not scalingup is enabled * @brief set whether or not scalingup is enabled
* @param bool $scalingUp * @param bool $scalingUp
* @return $this * @return \OC\Preview $this
*/ */
public function setScalingup($scalingUp) { public function setScalingup($scalingUp) {
if ($this->getMaxScaleFactor() === 1) { if ($this->getMaxScaleFactor() === 1) {
@ -750,7 +750,7 @@ class Preview {
} }
/** /**
* @param $fileId * @param int $fileId
* @return string * @return string
*/ */
private function buildCachePath($fileId) { private function buildCachePath($fileId) {

6
lib/private/response.php
View File

@ -93,7 +93,7 @@ class OC_Response {
/** /**
* @brief Set reponse expire time * @brief Set reponse expire time
* @param $expires date-time when the response expires * @param string|DateTime $expires date-time when the response expires
* string for DateInterval from now * string for DateInterval from now
* DateTime object when to expire response * DateTime object when to expire response
*/ */
@ -113,7 +113,7 @@ class OC_Response {
/** /**
* Checks and set ETag header, when the request matches sends a * Checks and set ETag header, when the request matches sends a
* 'not modified' response * 'not modified' response
* @param $etag token to use for modification check * @param string $etag token to use for modification check
*/ */
static public function setETagHeader($etag) { static public function setETagHeader($etag) {
if (empty($etag)) { if (empty($etag)) {
@ -131,7 +131,7 @@ class OC_Response {
/** /**
* Checks and set Last-Modified header, when the request matches sends a * Checks and set Last-Modified header, when the request matches sends a
* 'not modified' response * 'not modified' response
* @param $lastModified time when the reponse was last modified * @param int|DateTime|string $lastModified time when the reponse was last modified
*/ */
static public function setLastModifiedHeader($lastModified) { static public function setLastModifiedHeader($lastModified) {
if (empty($lastModified)) { if (empty($lastModified)) {

2
lib/private/route/route.php
View File

@ -124,7 +124,7 @@ class Route extends SymfonyRoute implements IRoute {
/** /**
* The action to execute when this route matches, includes a file like * The action to execute when this route matches, includes a file like
* it is called directly * it is called directly
* @param $file * @param string $file
* @return void * @return void
*/ */
public function actionInclude($file) { public function actionInclude($file) {

2
lib/private/route/router.php
View File

@ -239,7 +239,7 @@ class Router implements IRouter {
/** /**
* To isolate the variable scope used inside the $file it is required in it's own method * To isolate the variable scope used inside the $file it is required in it's own method
* @param $file * @param string $file
*/ */
private function requireRouteFile($file) { private function requireRouteFile($file) {
require_once $file; require_once $file;

20
lib/private/share/helper.php
View File

@ -25,13 +25,13 @@ class Helper extends \OC\Share\Constants {
/** /**
* Generate a unique target for the item * Generate a unique target for the item
* @param string Item type * @param string $itemType
* @param string Item source * @param string $itemSource
* @param int SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK * @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK
* @param string User or group the item is being shared with * @param string $shareWith User or group the item is being shared with
* @param string User that is the owner of shared item * @param string $uidOwner User that is the owner of shared item
* @param string The suggested target originating from a reshare (optional) * @param string $suggestedTarget The suggested target originating from a reshare (optional)
* @param int The id of the parent group share (optional) * @param int $groupParent The id of the parent group share (optional)
* @return string Item target * @return string Item target
*/ */
public static function generateTarget($itemType, $itemSource, $shareType, $shareWith, $uidOwner, public static function generateTarget($itemType, $itemSource, $shareType, $shareWith, $uidOwner,
@ -142,9 +142,9 @@ class Helper extends \OC\Share\Constants {
/** /**
* Delete all reshares of an item * Delete all reshares of an item
* @param int Id of item to delete * @param int $parent Id of item to delete
* @param bool If true, exclude the parent from the delete (optional) * @param bool $excludeParent If true, exclude the parent from the delete (optional)
* @param string The user that the parent was shared with (optinal) * @param string $uidOwner The user that the parent was shared with (optinal)
*/ */
public static function delete($parent, $excludeParent = false, $uidOwner = null) { public static function delete($parent, $excludeParent = false, $uidOwner = null) {
$ids = array($parent); $ids = array($parent);

10
lib/private/share/hooks.php
View File

@ -22,9 +22,9 @@
namespace OC\Share; namespace OC\Share;
class Hooks extends \OC\Share\Constants { class Hooks extends \OC\Share\Constants {
/** /**
* Function that is called after a user is deleted. Cleans up the shares of that user. * Function that is called after a user is deleted. Cleans up the shares of that user.
* @param array arguments * @param array $arguments
*/ */
public static function post_deleteUser($arguments) { public static function post_deleteUser($arguments) {
// Delete any items shared with the deleted user // Delete any items shared with the deleted user
@ -42,7 +42,7 @@ class Hooks extends \OC\Share\Constants {
/** /**
* Function that is called after a user is added to a group. * Function that is called after a user is added to a group.
* TODO what does it do? * TODO what does it do?
* @param array arguments * @param array $arguments
*/ */
public static function post_addToGroup($arguments) { public static function post_addToGroup($arguments) {
// Find the group shares and check if the user needs a unique target // Find the group shares and check if the user needs a unique target
@ -76,7 +76,7 @@ class Hooks extends \OC\Share\Constants {
/** /**
* Function that is called after a user is removed from a group. Shares are cleaned up. * Function that is called after a user is removed from a group. Shares are cleaned up.
* @param array arguments * @param array $arguments
*/ */
public static function post_removeFromGroup($arguments) { public static function post_removeFromGroup($arguments) {
$sql = 'SELECT `id`, `share_type` FROM `*PREFIX*share`' $sql = 'SELECT `id`, `share_type` FROM `*PREFIX*share`'
@ -95,7 +95,7 @@ class Hooks extends \OC\Share\Constants {
/** /**
* Function that is called after a group is removed. Cleans up the shares to that group. * Function that is called after a group is removed. Cleans up the shares to that group.
* @param array arguments * @param array $arguments
*/ */
public static function post_deleteGroup($arguments) { public static function post_deleteGroup($arguments) {
$sql = 'SELECT `id` FROM `*PREFIX*share` WHERE `share_type` = ? AND `share_with` = ?'; $sql = 'SELECT `id` FROM `*PREFIX*share` WHERE `share_type` = ? AND `share_with` = ?';

4
lib/private/share/mailnotifications.php
View File

@ -50,8 +50,8 @@ class MailNotifications {
* @brief inform users if a file was shared with them * @brief inform users if a file was shared with them
* *
* @param array $recipientList list of recipients * @param array $recipientList list of recipients
* @param type $itemSource shared item source * @param string $itemSource shared item source
* @param type $itemType shared item type * @param string $itemType shared item type
* @return array list of user to whom the mail send operation failed * @return array list of user to whom the mail send operation failed
*/ */
public function sendInternalShareMail($recipientList, $itemSource, $itemType) { public function sendInternalShareMail($recipientList, $itemSource, $itemType) {

4
lib/private/share/searchresultsorter.php
View File

@ -18,8 +18,8 @@ class SearchResultSorter {
* @param string $search the search term as was given by the user * @param string $search the search term as was given by the user
* @param string $key the array key containing the value that should be compared * @param string $key the array key containing the value that should be compared
* against * against
* @param $encoding optional, encoding to use, defaults to UTF-8 * @param string $encoding optional, encoding to use, defaults to UTF-8
* @param $log optional, an \OC\Log instance * @param \OC\Log $log optional
*/ */
public function __construct($search, $key, \OC\Log $log = null, $encoding = 'UTF-8') { public function __construct($search, $key, \OC\Log $log = null, $encoding = 'UTF-8') {
$this->encoding = $encoding; $this->encoding = $encoding;

22
lib/private/share/share.php
View File

@ -254,12 +254,12 @@ class Share extends \OC\Share\Constants {
/** /**
* Get the items of item type shared with a user * Get the items of item type shared with a user
* @param string Item type * @param string $itemType
* @param sting user id for which user we want the shares * @param string $user id for which user we want the shares
* @param int Format (optional) Format type must be defined by the backend * @param int $format (optional) Format type must be defined by the backend
* @param mixed Parameters (optional) * @param mixed $parameters (optional)
* @param int Number of items to return (optional) Returns all by default * @param int $limit Number of items to return (optional) Returns all by default
* @param boolean include collections (optional) * @param boolean $includeCollections (optional)
* @return Return depends on format * @return Return depends on format
*/ */
public static function getItemsSharedWithUser($itemType, $user, $format = self::FORMAT_NONE, public static function getItemsSharedWithUser($itemType, $user, $format = self::FORMAT_NONE,
@ -388,8 +388,8 @@ class Share extends \OC\Share\Constants {
/** /**
* resolves reshares down to the last real share * resolves reshares down to the last real share
* @param $linkItem * @param array $linkItem
* @return $fileOwner * @return array file owner
*/ */
public static function resolveReShare($linkItem) public static function resolveReShare($linkItem)
{ {
@ -446,7 +446,7 @@ class Share extends \OC\Share\Constants {
* @param string $uidOwner * @param string $uidOwner
* @param boolean $includeCollections * @param boolean $includeCollections
* @param boolean $checkExpireDate * @param boolean $checkExpireDate
* @return Return array of users * @return array Return array of users
*/ */
public static function getUsersItemShared($itemType, $itemSource, $uidOwner, $includeCollections = false, $checkExpireDate = true) { public static function getUsersItemShared($itemType, $itemSource, $uidOwner, $includeCollections = false, $checkExpireDate = true) {
@ -1000,10 +1000,10 @@ class Share extends \OC\Share\Constants {
/** /**
* Get shared items from the database * Get shared items from the database
* @param string $itemType * @param string $itemType
* @param string Item source or target (optional) * @param string $item Item source or target (optional)
* @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, SHARE_TYPE_LINK, $shareTypeUserAndGroups, or $shareTypeGroupUserUnique * @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, SHARE_TYPE_LINK, $shareTypeUserAndGroups, or $shareTypeGroupUserUnique
* @param string $shareWith User or group the item is being shared with * @param string $shareWith User or group the item is being shared with
* @param string uidOwner User that is the owner of shared items (optional) * @param string $uidOwner User that is the owner of shared items (optional)
* @param int $format Format to convert items to with formatItems() (optional) * @param int $format Format to convert items to with formatItems() (optional)
* @param mixed $parameters to pass to formatItems() (optional) * @param mixed $parameters to pass to formatItems() (optional)
* @param int $limit Number of items to return, -1 to return all matches (optional) * @param int $limit Number of items to return, -1 to return all matches (optional)

4
lib/private/subadmin.php
View File

@ -167,7 +167,7 @@ class OC_SubAdmin{
/** /**
* @brief delete all SubAdmins by uid * @brief delete all SubAdmins by uid
* @param $parameters * @param array $parameters
* @return boolean * @return boolean
*/ */
public static function post_deleteUser($parameters) { public static function post_deleteUser($parameters) {
@ -178,7 +178,7 @@ class OC_SubAdmin{
/** /**
* @brief delete all SubAdmins by gid * @brief delete all SubAdmins by gid
* @param $parameters * @param array $parameters
* @return boolean * @return boolean
*/ */
public static function post_deleteGroup($parameters) { public static function post_deleteGroup($parameters) {

2
lib/private/tags.php
View File

@ -393,7 +393,7 @@ class Tags implements \OCP\ITags {
* *
* For hooking up on post_deleteUser * For hooking up on post_deleteUser
* *
* @param array * @param array $arguments
*/ */
public static function post_deleteUser($arguments) { public static function post_deleteUser($arguments) {
// Find all objectid/tagId pairs. // Find all objectid/tagId pairs.

2
lib/private/template/functions.php
View File

@ -70,7 +70,7 @@ function mimetype_icon( $mimetype ) {
/** /**
* @brief make preview_icon available as a simple function * @brief make preview_icon available as a simple function
* Returns the path to the preview of the image. * Returns the path to the preview of the image.
* @param $path path of file * @param string $path path of file
* @return link to the preview * @return link to the preview
* *
* For further information have a look at OC_Helper::previewIcon * For further information have a look at OC_Helper::previewIcon

10
lib/private/template/resourcelocator.php
View File

@ -53,13 +53,9 @@ abstract class ResourceLocator {
/* /*
* @brief append the $file resource if exist at $root * @brief append the $file resource if exist at $root
* @param $root path to check * @param string $root path to check
* @param $file the filename * @param string $file the filename
* @param $web base for path, default map $root to $webroot * @param string|null $webroot base for path, default map $root to $webroot
*/
/**
* @param string $file
* @param string|false $webroot
*/ */
protected function appendIfExist($root, $file, $webroot = null) { protected function appendIfExist($root, $file, $webroot = null) {
if (is_file($root.'/'.$file)) { if (is_file($root.'/'.$file)) {

6
lib/private/templatelayout.php
View File

@ -98,7 +98,7 @@ class OC_TemplateLayout extends OC_Template {
} }
/** /**
* @param $styles * @param array $styles
* @return array * @return array
*/ */
static public function findStylesheetFiles($styles) { static public function findStylesheetFiles($styles) {
@ -116,7 +116,7 @@ class OC_TemplateLayout extends OC_Template {
} }
/** /**
* @param $scripts * @param array $scripts
* @return array * @return array
*/ */
static public function findJavascriptFiles($scripts) { static public function findJavascriptFiles($scripts) {
@ -175,7 +175,7 @@ class OC_TemplateLayout extends OC_Template {
} }
/** /**
* @param $files * @param array $files
* @return string * @return string
*/ */
private static function hashScriptNames($files) private static function hashScriptNames($files)

2
lib/private/urlgenerator.php
View File

@ -30,7 +30,7 @@ class URLGenerator implements IURLGenerator {
/** /**
* @brief Creates an url using a defined route * @brief Creates an url using a defined route
* @param $route * @param string $route
* @param array $parameters * @param array $parameters
* @internal param array $args with param=>value, will be appended to the returned url * @internal param array $args with param=>value, will be appended to the returned url
* @return string the url * @return string the url

28
lib/private/user/database.php
View File

@ -57,9 +57,9 @@ class OC_User_Database extends OC_User_Backend {
/** /**
* @brief Create a new user * @brief Create a new user
* @param $uid The username of the user to create * @param string $uid The username of the user to create
* @param $password The password of the new user * @param string $password The password of the new user
* @return true/false * @return bool
* *
* Creates a new user. Basic checking of username is done in OC_User * Creates a new user. Basic checking of username is done in OC_User
* itself, not in its subclasses. * itself, not in its subclasses.
@ -79,8 +79,8 @@ class OC_User_Database extends OC_User_Backend {
/** /**
* @brief delete a user * @brief delete a user
* @param $uid The username of the user to delete * @param string $uid The username of the user to delete
* @return true/false * @return bool
* *
* Deletes a user * Deletes a user
*/ */
@ -98,9 +98,9 @@ class OC_User_Database extends OC_User_Backend {
/** /**
* @brief Set password * @brief Set password
* @param $uid The username * @param string $uid The username
* @param $password The new password * @param string $password The new password
* @return true/false * @return bool
* *
* Change the password of a user * Change the password of a user
*/ */
@ -119,9 +119,9 @@ class OC_User_Database extends OC_User_Backend {
/** /**
* @brief Set display name * @brief Set display name
* @param $uid The username * @param string $uid The username
* @param $displayName The new display name * @param string $displayName The new display name
* @return true/false * @return bool
* *
* Change the display name of a user * Change the display name of a user
*/ */
@ -139,7 +139,7 @@ class OC_User_Database extends OC_User_Backend {
/** /**
* @brief get display name of the user * @brief get display name of the user
* @param $uid user ID of the user * @param string $uid user ID of the user
* @return string display name * @return string display name
*/ */
public function getDisplayName($uid) { public function getDisplayName($uid) {
@ -169,8 +169,8 @@ class OC_User_Database extends OC_User_Backend {
/** /**
* @brief Check if the password is correct * @brief Check if the password is correct
* @param $uid The username * @param string $uid The username
* @param $password The password * @param string $password The password
* @return string * @return string
* *
* Check if the password is correct without logging in the user * Check if the password is correct without logging in the user

18
lib/private/user/example.php
View File

@ -28,9 +28,9 @@
abstract class OC_User_Example extends OC_User_Backend { abstract class OC_User_Example extends OC_User_Backend {
/** /**
* @brief Create a new user * @brief Create a new user
* @param $uid The username of the user to create * @param string $uid The username of the user to create
* @param $password The password of the new user * @param string $password The password of the new user
* @return true/false * @return bool
* *
* Creates a new user. Basic checking of username is done in OC_User * Creates a new user. Basic checking of username is done in OC_User
* itself, not in its subclasses. * itself, not in its subclasses.
@ -39,9 +39,9 @@ abstract class OC_User_Example extends OC_User_Backend {
/** /**
* @brief Set password * @brief Set password
* @param $uid The username * @param string $uid The username
* @param $password The new password * @param string $password The new password
* @return true/false * @return bool
* *
* Change the password of a user * Change the password of a user
*/ */
@ -49,8 +49,8 @@ abstract class OC_User_Example extends OC_User_Backend {
/** /**
* @brief Check if the password is correct * @brief Check if the password is correct
* @param $uid The username * @param string $uid The username
* @param $password The password * @param string $password The password
* @return string * @return string
* *
* Check if the password is correct without logging in the user * Check if the password is correct without logging in the user
@ -60,7 +60,7 @@ abstract class OC_User_Example extends OC_User_Backend {
/** /**
* @brief get the user's home directory * @brief get the user's home directory
* @param $uid The username * @param string $uid The username
* @return string * @return string
* *
* get the user's home directory * get the user's home directory

8
lib/private/user/http.php
View File

@ -27,7 +27,7 @@
class OC_User_HTTP extends OC_User_Backend { class OC_User_HTTP extends OC_User_Backend {
/** /**
* split http://user@host/path into a user and url part * split http://user@host/path into a user and url part
* @param string path * @param string $url
* @return array * @return array
*/ */
private function parseUrl($url) { private function parseUrl($url) {
@ -46,7 +46,7 @@ class OC_User_HTTP extends OC_User_Backend {
/** /**
* check if an url is a valid login * check if an url is a valid login
* @param string url * @param string $url
* @return boolean * @return boolean
*/ */
private function matchUrl($url) { private function matchUrl($url) {
@ -55,8 +55,8 @@ class OC_User_HTTP extends OC_User_Backend {
/** /**
* @brief Check if the password is correct * @brief Check if the password is correct
* @param $uid The username * @param string $uid The username
* @param $password The password * @param string $password The password
* @return string * @return string
* *
* Check if the password is correct without logging in the user * Check if the password is correct without logging in the user

12
lib/private/user/interface.php
View File

@ -30,17 +30,13 @@ interface OC_User_Interface {
* *
* Returns the supported actions as int to be * Returns the supported actions as int to be
* compared with OC_USER_BACKEND_CREATE_USER etc. * compared with OC_USER_BACKEND_CREATE_USER etc.
* @return boolean
*/ */
public function implementsActions($actions); public function implementsActions($actions);
/** /**
* @brief delete a user * @brief delete a user
* @param $uid The username of the user to delete * @param string $uid The username of the user to delete
* @return true/false * @return bool
*
* Deletes a user
* @return boolean
*/ */
public function deleteUser($uid); public function deleteUser($uid);
@ -61,8 +57,8 @@ interface OC_User_Interface {
/** /**
* @brief get display name of the user * @brief get display name of the user
* @param $uid user ID of the user * @param string $uid user ID of the user
* @return display name * @return string display name
*/ */
public function getDisplayName($uid); public function getDisplayName($uid);

10
lib/private/util.php
View File

@ -818,8 +818,8 @@ class OC_Util {
* This function is used to sanitize HTML and should be applied on any * This function is used to sanitize HTML and should be applied on any
* string or array of strings before displaying it on a web page. * string or array of strings before displaying it on a web page.
* *
* @param string|array of strings * @param string|array &$value
* @return array an array of sanitized strings or a single sanitized string, depends on the input parameter. * @return string|array an array of sanitized strings or a single sanitized string, depends on the input parameter.
*/ */
public static function sanitizeHTML( &$value ) { public static function sanitizeHTML( &$value ) {
if (is_array($value)) { if (is_array($value)) {
@ -1028,8 +1028,8 @@ class OC_Util {
/** /**
* @brief Generates a cryptographic secure pseudo-random string * @brief Generates a cryptographic secure pseudo-random string
* @param Int $length of the random string * @param int $length of the random string
* @return String * @return string
* Please also update secureRNGAvailable if you change something here * Please also update secureRNGAvailable if you change something here
*/ */
public static function generateRandomBytes($length = 30) { public static function generateRandomBytes($length = 30) {
@ -1287,7 +1287,7 @@ class OC_Util {
/** /**
* Returns whether the given file name is valid * Returns whether the given file name is valid
* @param $file string file name to check * @param string $file file name to check
* @return bool true if the file name is valid, false otherwise * @return bool true if the file name is valid, false otherwise
*/ */
public static function isValidFileName($file) { public static function isValidFileName($file) {

16
lib/private/vobject.php
View File

@ -89,7 +89,7 @@ class OC_VObject{
/** /**
* Constructor * Constructor
* @param Sabre\VObject\Component or string * @param Sabre\VObject\Component|string $vobject_or_name
*/ */
public function __construct($vobject_or_name) { public function __construct($vobject_or_name) {
if (is_object($vobject_or_name)) { if (is_object($vobject_or_name)) {
@ -101,7 +101,7 @@ class OC_VObject{
/** /**
* @todo Write documentation * @todo Write documentation
* @param $item * @param \OC_VObject|\Sabre\VObject\Component $item
* @param null $itemValue * @param null $itemValue
*/ */
public function add($item, $itemValue = null) { public function add($item, $itemValue = null) {
@ -138,7 +138,7 @@ class OC_VObject{
/** /**
* @todo Write documentation * @todo Write documentation
* @param mixed $name * @param mixed $name
* @param string $string * @param string $string
*/ */
public function setString($name, $string) { public function setString($name, $string) {
@ -175,7 +175,7 @@ class OC_VObject{
/** /**
* @todo Write documentation * @todo Write documentation
* @param $name * @param string $name
* @return string * @return string
*/ */
public function getAsString($name) { public function getAsString($name) {
@ -186,7 +186,7 @@ class OC_VObject{
/** /**
* @todo Write documentation * @todo Write documentation
* @param $name * @param string $name
* @return array * @return array
*/ */
public function getAsArray($name) { public function getAsArray($name) {
@ -200,7 +200,7 @@ class OC_VObject{
/** /**
* @todo Write documentation * @todo Write documentation
* @param $name * @param string $name
* @return array|OC_VObject|\Sabre\VObject\Property * @return array|OC_VObject|\Sabre\VObject\Property
*/ */
public function &__get($name) { public function &__get($name) {
@ -242,8 +242,8 @@ class OC_VObject{
/** /**
* @todo Write documentation * @todo Write documentation
* @param $function * @param callable $function
* @param $arguments * @param array $arguments
* @return mixed * @return mixed
*/ */
public function __call($function, $arguments) { public function __call($function, $arguments) {

10
lib/public/app.php
View File

@ -36,7 +36,7 @@ namespace OCP;
class App { class App {
/** /**
* Makes ownCloud aware of this app * Makes ownCloud aware of this app
* @param array with all information * @param array $data with all information
* @return boolean * @return boolean
* *
* @deprecated This method is deprecated. Do not call it anymore. * @deprecated This method is deprecated. Do not call it anymore.
@ -49,7 +49,7 @@ class App {
/** /**
* Adds an entry to the navigation * Adds an entry to the navigation
* @param array containing the data * @param array $data containing the data
* @return boolean * @return boolean
* *
* This function adds a new entry to the navigation visible to users. $data * This function adds a new entry to the navigation visible to users. $data
@ -70,7 +70,7 @@ class App {
/** /**
* Marks a navigation entry as active * Marks a navigation entry as active
* @param string id of the entry * @param string $id id of the entry
* @return boolean * @return boolean
* *
* This function sets a navigation entry as active and removes the 'active' * This function sets a navigation entry as active and removes the 'active'
@ -83,8 +83,8 @@ class App {
/** /**
* Register a Configuration Screen that should appear in the personal settings section. * Register a Configuration Screen that should appear in the personal settings section.
* @param $app string appid * @param string $app appid
* @param $page string page to be included * @param string $page page to be included
* @return void * @return void
*/ */
public static function registerPersonal( $app, $page ) { public static function registerPersonal( $app, $page ) {

4
lib/public/backgroundjob.php
View File

@ -94,7 +94,7 @@ class BackgroundJob {
/** /**
* @deprecated * @deprecated
* gets all regular tasks * gets all regular tasks
* @return associative array * @return array
* *
* key is string "$klass-$method", value is array( $klass, $method ) * key is string "$klass-$method", value is array( $klass, $method )
*/ */
@ -115,7 +115,7 @@ class BackgroundJob {
* @deprecated * @deprecated
* Gets one queued task * Gets one queued task
* @param int $id ID of the task * @param int $id ID of the task
* @return BackgroundJob\IJob array * @return BackgroundJob\IJob|null
*/ */
public static function findQueuedTask($id) { public static function findQueuedTask($id) {
$jobList = \OC::$server->getJobList(); $jobList = \OC::$server->getJobList();

6
lib/public/backgroundjob/ijoblist.php
View File

@ -12,7 +12,7 @@ interface IJobList {
/** /**
* Add a job to the list * Add a job to the list
* *
* @param \OCP\BackgroundJob\IJob |string $job * @param \OCP\BackgroundJob\IJob|string $job
* @param mixed $argument The argument to be passed to $job->run() when the job is exectured * @param mixed $argument The argument to be passed to $job->run() when the job is exectured
* @param string $job * @param string $job
* @return void * @return void
@ -22,7 +22,7 @@ interface IJobList {
/** /**
* Remove a job from the list * Remove a job from the list
* *
* @param IJob $job * @param \OCP\BackgroundJob\IJob|string $job
* @param mixed $argument * @param mixed $argument
* @return void * @return void
*/ */
@ -31,7 +31,7 @@ interface IJobList {
/** /**
* check if a job is in the list * check if a job is in the list
* *
* @param $job * @param \OCP\BackgroundJob\IJob|string $job
* @param mixed $argument * @param mixed $argument
* @return bool * @return bool
*/ */

4
lib/public/contacts.php
View File

@ -98,7 +98,7 @@ namespace OCP {
* This function can be used to delete the contact identified by the given id * This function can be used to delete the contact identified by the given id
* *
* @param object $id the unique identifier to a contact * @param object $id the unique identifier to a contact
* @param $address_book_key * @param string $address_book_key
* @return bool successful or not * @return bool successful or not
*/ */
public static function delete($id, $address_book_key) { public static function delete($id, $address_book_key) {
@ -111,7 +111,7 @@ namespace OCP {
* Otherwise the contact will be updated by replacing the entire data set. * Otherwise the contact will be updated by replacing the entire data set.
* *
* @param array $properties this array if key-value-pairs defines a contact * @param array $properties this array if key-value-pairs defines a contact
* @param $address_book_key string to identify the address book in which the contact shall be created or updated * @param string $address_book_key identifier of the address book in which the contact shall be created or updated
* @return array an array representing the contact just created or updated * @return array an array representing the contact just created or updated
*/ */
public static function createOrUpdate($properties, $address_book_key) { public static function createOrUpdate($properties, $address_book_key) {

2
lib/public/db.php
View File

@ -50,7 +50,7 @@ class DB {
/** /**
* Insert a row if a matching row doesn't exists. * Insert a row if a matching row doesn't exists.
* @param string $table The optional table name (will replace *PREFIX*) and add sequence suffix * @param string $table The optional table name (will replace *PREFIX*) and add sequence suffix
* @param $input array * @param array $input
* *
* The input array if in the form: * The input array if in the form:
* *

2
lib/public/iavatar.php
View File

@ -15,7 +15,7 @@ interface IAvatar {
/** /**
* @brief get the users avatar * @brief get the users avatar
* @param $size integer size in px of the avatar, avatars are square, defaults to 64 * @param int $size size in px of the avatar, avatars are square, defaults to 64
* @return boolean|\OC_Image containing the avatar or false if there's no image * @return boolean|\OC_Image containing the avatar or false if there's no image
*/ */
function get($size = 64); function get($size = 64);

2
lib/public/iavatarmanager.php
View File

@ -16,7 +16,7 @@ interface IAvatarManager {
/** /**
* @brief return a user specific instance of \OCP\IAvatar * @brief return a user specific instance of \OCP\IAvatar
* @see \OCP\IAvatar * @see \OCP\IAvatar
* @param $user string the ownCloud user id * @param string $user the ownCloud user id
* @return \OCP\IAvatar * @return \OCP\IAvatar
*/ */
function getAvatar($user); function getAvatar($user);

4
lib/public/idbconnection.php
View File

@ -52,8 +52,8 @@ interface IDBConnection {
/** /**
* Insert a row if a matching row doesn't exists. * Insert a row if a matching row doesn't exists.
* @param string The table name (will replace *PREFIX*) to perform the replace on. * @param string $table The table name (will replace *PREFIX*) to perform the replace on.
* @param array * @param array $input
* *
* The input array if in the form: * The input array if in the form:
* *

2
lib/public/il10n.php
View File

@ -53,7 +53,7 @@ interface IL10N {
* Localization * Localization
* @param string $type Type of localization * @param string $type Type of localization
* @param array $data parameters for this localization * @param array $data parameters for this localization
* @return String or false * @return string|false
* *
* Returns the localized data. * Returns the localized data.
* *

2
lib/public/route/iroute.php
View File

@ -26,7 +26,7 @@ interface IRoute {
* The action to execute when this route matches, includes a file like * The action to execute when this route matches, includes a file like
* it is called directly * it is called directly
* *
* @param $file * @param string $file
* @return void * @return void
*/ */
public function actionInclude($file); public function actionInclude($file);

24
lib/public/share.php
View File

@ -92,13 +92,13 @@ class Share extends \OC\Share\Constants {
/** /**
* Get the items of item type shared with a user * Get the items of item type shared with a user
* @param string Item type * @param string $itemType
* @param sting user id for which user we want the shares * @param string $user for which user we want the shares
* @param int Format (optional) Format type must be defined by the backend * @param int $format (optional) Format type must be defined by the backend
* @param mixed Parameters (optional) * @param mixed $parameters (optional)
* @param int Number of items to return (optional) Returns all by default * @param int $limit Number of items to return (optional) Returns all by default
* @param bool include collections (optional) * @param bool $includeCollections (optional)
* @return Return depends on format * @return mixed Return depends on format
*/ */
public static function getItemsSharedWithUser($itemType, $user, $format = self::FORMAT_NONE, public static function getItemsSharedWithUser($itemType, $user, $format = self::FORMAT_NONE,
$parameters = null, $limit = -1, $includeCollections = false) { $parameters = null, $limit = -1, $includeCollections = false) {
@ -111,8 +111,8 @@ class Share extends \OC\Share\Constants {
* @param string $itemType * @param string $itemType
* @param string $itemTarget * @param string $itemTarget
* @param int $format (optional) Format type must be defined by the backend * @param int $format (optional) Format type must be defined by the backend
* @param mixed Parameters (optional) * @param mixed $parameters (optional)
* @param bool include collections (optional) * @param bool $includeCollections (optional)
* @return mixed Return depends on format * @return mixed Return depends on format
*/ */
public static function getItemSharedWith($itemType, $itemTarget, $format = self::FORMAT_NONE, public static function getItemSharedWith($itemType, $itemTarget, $format = self::FORMAT_NONE,
@ -168,8 +168,8 @@ class Share extends \OC\Share\Constants {
/** /**
* resolves reshares down to the last real share * resolves reshares down to the last real share
* @param $linkItem * @param array $linkItem
* @return $fileOwner * @return array file owner
*/ */
public static function resolveReShare($linkItem) { public static function resolveReShare($linkItem) {
return \OC\Share\Share::resolveReShare($linkItem); return \OC\Share\Share::resolveReShare($linkItem);
@ -213,7 +213,7 @@ class Share extends \OC\Share\Constants {
* @param string $uidOwner * @param string $uidOwner
* @param bool $includeCollections * @param bool $includeCollections
* @param bool $checkExpireDate * @param bool $checkExpireDate
* @return Return array of users * @return array Return array of users
*/ */
public static function getUsersItemShared($itemType, $itemSource, $uidOwner, $includeCollections = false, $checkExpireDate = true) { public static function getUsersItemShared($itemType, $itemSource, $uidOwner, $includeCollections = false, $checkExpireDate = true) {
return \OC\Share\Share::getUsersItemShared($itemType, $itemSource, $uidOwner, $includeCollections, $checkExpireDate); return \OC\Share\Share::getUsersItemShared($itemType, $itemSource, $uidOwner, $includeCollections, $checkExpireDate);

22
lib/public/template.php
View File

@ -33,8 +33,8 @@ namespace OCP;
/** /**
* Make OC_Helper::imagePath available as a simple function * Make OC_Helper::imagePath available as a simple function
* @param string app * @param string $app
* @param string image * @param string $image
* @return string to the image * @return string to the image
* *
* @see OC_Helper::imagePath * @see OC_Helper::imagePath
@ -46,7 +46,7 @@ function image_path( $app, $image ) {
/** /**
* Make OC_Helper::mimetypeIcon available as a simple function * Make OC_Helper::mimetypeIcon available as a simple function
* @param string mimetype * @param string $mimetype
* @return string to the image of this file type. * @return string to the image of this file type.
*/ */
function mimetype_icon( $mimetype ) { function mimetype_icon( $mimetype ) {
@ -55,7 +55,7 @@ function mimetype_icon( $mimetype ) {
/** /**
* Make preview_icon available as a simple function * Make preview_icon available as a simple function
* @param string path of file * @param string $path path to file
* @return string to the preview of the image * @return string to the preview of the image
*/ */
function preview_icon( $path ) { function preview_icon( $path ) {
@ -76,7 +76,7 @@ function publicPreview_icon ( $path, $token ) {
/** /**
* Make OC_Helper::humanFileSize available as a simple function * Make OC_Helper::humanFileSize available as a simple function
* Example: 2048 to 2 kB. * Example: 2048 to 2 kB.
* @param int size in bytes * @param int $size in bytes
* @return string size as string * @return string size as string
*/ */
function human_file_size( $bytes ) { function human_file_size( $bytes ) {
@ -86,8 +86,8 @@ function human_file_size( $bytes ) {
/** /**
* Return the relative date in relation to today. Returns something like "last hour" or "two month ago" * Return the relative date in relation to today. Returns something like "last hour" or "two month ago"
* @param int unix timestamp * @param int $timestamp unix timestamp
* @param boolean date only * @param boolean $dateOnly
* @return OC_L10N_String human readable interpretation of the timestamp * @return OC_L10N_String human readable interpretation of the timestamp
*/ */
function relative_modified_date( $timestamp, $dateOnly = false ) { function relative_modified_date( $timestamp, $dateOnly = false ) {
@ -98,7 +98,7 @@ function relative_modified_date( $timestamp, $dateOnly = false ) {
/** /**
* Return a human readable outout for a file size. * Return a human readable outout for a file size.
* @deprecated human_file_size() instead * @deprecated human_file_size() instead
* @param integer size of a file in byte * @param integer $bytes size of a file in byte
* @return string human readable interpretation of a file size * @return string human readable interpretation of a file size
*/ */
function simple_file_size($bytes) { function simple_file_size($bytes) {
@ -108,9 +108,9 @@ function simple_file_size($bytes) {
/** /**
* Generate html code for an options block. * Generate html code for an options block.
* @param $options the options * @param array $options the options
* @param $selected which one is selected? * @param mixed $selected which one is selected?
* @param array the parameters * @param array $params the parameters
* @return string html options * @return string html options
*/ */
function html_select_options($options, $selected, $params=array()) { function html_select_options($options, $selected, $params=array()) {

14
lib/public/user.php
View File

@ -45,9 +45,9 @@ class User {
/** /**
* Get a list of all users * Get a list of all users
* @param string search pattern * @param string $search search pattern
* @param integer $limit * @param int|null $limit
* @param integer $offset * @param int|null $offset
* @return array an array of all uids * @return array an array of all uids
*/ */
public static function getUsers( $search = '', $limit = null, $offset = null ) { public static function getUsers( $search = '', $limit = null, $offset = null ) {
@ -56,7 +56,7 @@ class User {
/** /**
* Get the user display name of the user currently logged in. * Get the user display name of the user currently logged in.
* @param string user id or null for current user * @param string|null $user user id or null for current user
* @return string display name * @return string display name
*/ */
public static function getDisplayName( $user = null ) { public static function getDisplayName( $user = null ) {
@ -65,9 +65,9 @@ class User {
/** /**
* Get a list of all display names and user ids. * Get a list of all display names and user ids.
* @param string search pattern * @param string $search search pattern
* @param int limit * @param int|null $limit
* @param int offset * @param int|null $offset
* @return array an array of all display names (value) and the correspondig uids (key) * @return array an array of all display names (value) and the correspondig uids (key)
*/ */
public static function getDisplayNames( $search = '', $limit = null, $offset = null ) { public static function getDisplayNames( $search = '', $limit = null, $offset = null ) {

16
lib/public/util.php
View File

@ -203,7 +203,7 @@ class Util {
/** /**
* Creates an url using a defined route * Creates an url using a defined route
* @param $route * @param string $route
* @param array $parameters * @param array $parameters
* @internal param array $args with param=>value, will be appended to the returned url * @internal param array $args with param=>value, will be appended to the returned url
* @return string the url * @return string the url
@ -380,8 +380,8 @@ class Util {
* This function is used to sanitize HTML and should be applied on any * This function is used to sanitize HTML and should be applied on any
* string or array of strings before displaying it on a web page. * string or array of strings before displaying it on a web page.
* *
* @param string|array of strings * @param string|array $value
* @return array an array of sanitized strings or a single sinitized string, depends on the input parameter. * @return string|array an array of sanitized strings or a single sinitized string, depends on the input parameter.
*/ */
public static function sanitizeHTML( $value ) { public static function sanitizeHTML( $value ) {
return(\OC_Util::sanitizeHTML($value)); return(\OC_Util::sanitizeHTML($value));
@ -458,7 +458,7 @@ class Util {
* *
* @param string $dir the current folder where the user currently operates * @param string $dir the current folder where the user currently operates
* @param int $free the number of bytes free on the storage holding $dir, if not set this will be received from the storage directly * @param int $free the number of bytes free on the storage holding $dir, if not set this will be received from the storage directly
* @return number of bytes representing * @return int number of bytes representing
*/ */
public static function maxUploadFilesize($dir, $free = null) { public static function maxUploadFilesize($dir, $free = null) {
return \OC_Helper::maxUploadFilesize($dir, $free); return \OC_Helper::maxUploadFilesize($dir, $free);
@ -476,7 +476,7 @@ class Util {
/** /**
* Calculate PHP upload limit * Calculate PHP upload limit
* *
* @return number of bytes representing * @return int number of bytes representing
*/ */
public static function uploadLimit() { public static function uploadLimit() {
return \OC_Helper::uploadLimit(); return \OC_Helper::uploadLimit();
@ -484,7 +484,7 @@ class Util {
/** /**
* Returns whether the given file name is valid * Returns whether the given file name is valid
* @param $file string file name to check * @param string $file file name to check
* @return bool true if the file name is valid, false otherwise * @return bool true if the file name is valid, false otherwise
*/ */
public static function isValidFileName($file) { public static function isValidFileName($file) {
@ -493,8 +493,8 @@ class Util {
/** /**
* @brief Generates a cryptographic secure pseudo-random string * @brief Generates a cryptographic secure pseudo-random string
* @param Int $length of the random string * @param int $length of the random string
* @return String * @return string
*/ */
public static function generateRandomBytes($length = 30) { public static function generateRandomBytes($length = 30) {
return \OC_Util::generateRandomBytes($length); return \OC_Util::generateRandomBytes($length);