}
/**
- * @param $message
- * @param $level
+ * @param string $message
+ * @param string $level
* @return mixed
*/
function log($message, $level) {
protected $headers;
/**
- * @param $_SERVER $server
+ * @param array $server $_SERVER
* @param string $protocolVersion the http version to use defaults to HTTP/1.1
*/
public function __construct($server, $protocolVersion='HTTP/1.1') {
/**
* Creates one route base on the give configuration
- * @param $routes
+ * @param array $routes
* @throws \UnexpectedValueException
*/
private function processSimpleRoutes($routes)
* - update
* - destroy
*
- * @param $routes
+ * @param array $routes
*/
private function processResources($routes)
{
/**
* Based on a given route name the controller name is generated
- * @param $controller
+ * @param string $controller
* @return string
*/
private function buildControllerName($controller)
/**
* Based on the action part of the route name the controller method name is generated
- * @param $action
+ * @param string $action
* @return string
*/
private function buildActionName($action) {
/**
* Generates the id used in the url part o the route url
- * @param $resource
+ * @param string $resource
* @return string
*/
private function buildResourceId($resource) {
/**
* Underscored strings are converted to camel case strings
- * @param $str string
+ * @param string $str
* @return string
*/
private function underScoreToCamelCase($str) {
}
/**
* get the last modified time of a file in the archive
- * @param string path
+ * @param string $path
* @return int
*/
function mtime($path) {
/**
* @brief constructor
- * @param $user string user to do avatar-management with
+ * @param string $user user to do avatar-management with
*/
public function __construct ($user) {
$this->view = new \OC\Files\View('/'.$user);
/**
* @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
*/
public function get ($size = 64) {
/**
* @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 image is not valid
* @throws \OC\NotSquareException if the image is not square
/**
* @brief return a user specific instance of \OCP\IAvatar
* @see \OCP\IAvatar
- * @param $user string the ownCloud user id
+ * @param string $user the ownCloud user id
* @return \OCP\IAvatar
*/
function getAvatar($user) {
}
/**
- * @param \Test\BackgroundJob\TestJob $job
+ * @param Job|string $job
* @param mixed $argument
*/
public function add($job, $argument = null) {
}
/**
- * @param Job $job
+ * @param Job|string $job
* @param mixed $argument
*/
public function remove($job, $argument = null) {
/**
* check if a job is in the list
*
- * @param $job
+ * @param Job|string $job
* @param mixed $argument
* @return bool
*/
/**
* @param int $id
- * @return Job
+ * @return Job|null
*/
public function getById($id) {
$query = $this->conn->prepare('SELECT `id`, `class`, `last_run`, `argument` FROM `*PREFIX*jobs` WHERE `id` = ?');
/**
* Returns the size of the stored/cached data
*
- * @param $key
+ * @param string $key
* @return int
*/
public function size($key) {
* even if there are no HTTP Basic Auth headers.
* In other case, just fallback to the parent implementation.
*
+ * @param Sabre_DAV_Server $server
+ * @param $realm
* @return bool
*/
public function authenticate(Sabre_DAV_Server $server, $realm) {
}
/**
- * @param $filePath
+ * @param string $filePath
* @param Sabre_DAV_INode $node
* @throws Sabre_DAV_Exception_BadRequest
*/
}
/**
- * @param $parentUri
+ * @param string $parentUri
* @return mixed
*/
public function getFreeSpace($parentUri) {
/**
* @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 ) {
$schemaManager = self::getMDB2SchemaManager();
/**
* Insert a row if a matching row doesn't exists.
- * @param string The table name (will replace *PREFIX*) to perform the replace on.
- * @param array
+ * @param string $table The table name (will replace *PREFIX*) to perform the replace on.
+ * @param array $input
*
* The input array if in the form:
*
/**
* @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 ) {
$apps = \OC_App::getAllApps();
}
/**
- * @param\Doctrine\DBAL\Schema\Schema $schema
+ * @param \Doctrine\DBAL\Schema\Schema $schema
* @param \SimpleXMLElement $xml
* @throws \DomainException
*/
/**
* Returns mail header color
- * @return mail header color
+ * @return string
*/
public function getMailHeaderColor() {
if ($this->themeExist('getMailHeaderColor')) {
/**
* fallback function when a proxy operation is not implemented
* @param string $function the name of the proxy operation
- * @param mixed
+ * @param mixed $arguments
*
* this implements a dummy proxy for all operations
*/
/**
* normalize the given path
- * @param $path
+ * @param string $path
* @return string
*/
public function normalize($path) {
* @brief check if the file should be ignored when scanning
* NOTE: files with a '.part' extension are ignored as well!
* prevents unfinished put requests to be scanned
- * @param String $file
+ * @param string $file
* @return boolean
*/
public static function isPartialFile($file) {
}
/**
- * @param $id
+ * @param string $id
* @return Mount\Mount[]
*/
public static function getMountByStorageId($id) {
}
/**
- * @param $id
+ * @param int $id
* @return Mount\Mount[]
*/
public static function getMountByNumericId($id) {
}
/**
- * @param $path
- * @param $root
+ * @param string $path
+ * @param string $root
* @return false|string
*/
public function stripRootFolder($path, $root) {
/**
* Find the mount for $path
*
- * @param $path
+ * @param string $path
* @return Mount
*/
public function find($path) {
/**
* Find all mounts in $path
*
- * @param $path
+ * @param string $path
* @return Mount[]
*/
public function findIn($path) {
/**
* Find mounts by numeric storage id
*
- * @param string $id
+ * @param int $id
* @return Mount[]
*/
public function findByNumericId($id) {
}
/**
- * @param $id
+ * @param int $id
* @return \OC\Files\Node\Node[]
*/
public function getById($id) {
* clean a path, i.e. remove all redundant '.' and '..'
* 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
*/
public function cleanPath($path) {
/**
* get the free space in the storage
*
- * @param $path
+ * @param string $path
* @return int
*/
public function free_space($path) {
}
/**
- * @return quota value
+ * @return int quota value
*/
public function getQuota() {
return $this->quota;
class OC_Geo{
/**
* @brief returns the closest timezone to coordinates
- * @param $latitude
- * @param $longitude
+ * @param float $latitude
+ * @param float $longitude
* @return mixed Closest timezone
*/
public static function timezone($latitude, $longitude) {
/**
* @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
*/
public static function useBackend($backend) {
/**
* @brief Try to create a new group
* @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
* be returned.
/**
* @brief delete a group
- * @param $gid gid of the group to delete
- * @return true/false
+ * @param string $gid gid of the group to delete
+ * @return bool
*
* Deletes a group and removes it from the group_user-table
*/
/**
* @brief is user in group?
- * @param $uid uid of the user
- * @param $gid gid of the group
- * @return true/false
+ * @param string $uid uid of the user
+ * @param string $gid gid of the group
+ * @return bool
*
* Checks whether the user is member of a group or not.
*/
/**
* @brief Add a user to a group
- * @param $uid Name of the user to add to group
- * @param $gid Name of the group in which add the user
- * @return true/false
+ * @param string $uid Name of the user to add to group
+ * @param string $gid Name of the group in which add the user
+ * @return bool
*
* Adds a user to a group.
*/
/**
* @brief Removes a user from a group
- * @param $uid NameUSER of the user to remove from group
- * @param $gid Name of the group from which remove the user
- * @return true/false
+ * @param string $uid Name of the user to remove from group
+ * @param string $gid Name of the group from which remove the user
+ * @return bool
*
* removes the user from a group.
*/
/**
* @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
*
* This function fetches all groups a user belongs to. It does not check
abstract class OC_Group_Example {
/**
* @brief Try to create a new group
- * @param $gid The name of the group to create
- * @return true/false
+ * @param string $gid The name of the group to create
+ * @return bool
*
* Trys to create a new group. If the group name already exists, false will
* be returned.
/**
* @brief delete a group
- * @param $gid gid of the group to delete
- * @return true/false
+ * @param string $gid gid of the group to delete
+ * @return bool
*
* Deletes a group and removes it from the group_user-table
*/
/**
* @brief is user in group?
- * @param $uid uid of the user
- * @param $gid gid of the group
- * @return true/false
+ * @param string $uid uid of the user
+ * @param string $gid gid of the group
+ * @return bool
*
* Checks whether the user is member of a group or not.
*/
/**
* @brief Add a user to a group
- * @param $uid Name of the user to add to group
- * @param $gid Name of the group in which add the user
- * @return true/false
+ * @param string $uid Name of the user to add to group
+ * @param string $gid Name of the group in which add the user
+ * @return bool
*
* Adds a user to a group.
*/
/**
* @brief Removes a user from a group
- * @param $uid NameUSER of the user to remove from group
- * @param $gid Name of the group from which remove the user
- * @return true/false
+ * @param string $uid Name of the user to remove from group
+ * @param string $gid Name of the group from which remove the user
+ * @return bool
*
* removes the user from a group.
*/
/**
* @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
*
* This function fetches all groups a user belongs to. It does not check
/**
* @brief Creates an url using a defined route
- * @param $route
+ * @param string $route
* @param array $parameters
* @return
* @internal param array $args with param=>value, will be appended to the returned url
/**
* detect if a given program is found in the search PATH
*
- * @param $name
+ * @param string $name
* @param bool $path
* @internal param string $program name
* @internal param string $optional search path, defaults to $PATH
/**
* Adds a suffix to the name in case the file exists
*
- * @param $path
- * @param $filename
+ * @param string $path
+ * @param string $filename
* @return string
*/
public static function buildNotExistingFileName($path, $filename) {
/**
* Adds a suffix to the name in case the file exists
*
- * @param $path
- * @param $filename
+ * @param string $path
+ * @param string $filename
* @return string
*/
public static function buildNotExistingFileNameForView($path, $filename, \OC\Files\View $view) {
/**
* @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 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
* @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.
* @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) {
OC_Log::write('core', __METHOD__.'(): Trying', OC_Log::DEBUG);
/**
* @brief checks whether or not an app is installed
* @param string $app app
- * @return true/false
+ * @return bool
*
* Checks whether or not an app is installed, i.e. registered in apps table.
*/
/**
* @brief Removes an app
* @param string $name name of the application to remove
- * @param $options array with options
+ * @param array $options options
* @return boolean|null
*
* This function removes an app. $options is an associative array. The
*
* Parts of the code is copied from Habari:
* https://github.com/habari/system/blob/master/classes/locale.php
- * @param $string string
+ * @param string $string
* @return string
*/
protected function createPluralFormFunction($string){
/**
* get an L10N instance
- * @param $app string
- * @param $lang string|null
+ * @param string $app
+ * @param string|null $lang
* @return \OC_L10N
*/
public function get($app) {
/**
* @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
*/
static private function extractZip( $path ) {
/**
* @brief imports a new user
* @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
* @return array an array of apps with import statuses, or false on failure.
*/
/**
* @brief sets up the
* @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
*/
public function __construct( $zip, $db=null ) {
}
- // @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 ) {
/**
* @brief copys rows to migration.db from the main database
- * @param $options array of options.
+ * @param array $options array of options.
* @return bool
*/
public function copyRows( $options ) {
/**
* @brief saves a sql data set into migration.db
* @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
*/
private function insertData( $data, $options ) {
/**
* @brief adds a directory to the zip object
* @param boolean|string $dir string path of the directory to add
- * @param $recursive bool
- * @param $internaldir string path of folder to add dir to in zip
+ * @param bool $recursive
+ * @param string $internaldir path of folder to add dir to in zip
* @return bool
*/
public function addDir( $dir, $recursive=true, $internaldir='' ) {
}
/**
- * @param $writer
- * @param $data
+ * @param resource $writer
+ * @param array $data
* @param string $node
*/
public static function toXml($writer, $data, $node) {
* </quota>
* </data>
*
- * @param $parameters object should contain parameter 'userid' which identifies
- * the user from whom the information will be returned
+ * @param array $parameters should contain parameter 'userid' which identifies
+ * the user from whom the information will be returned
*/
public static function getUser($parameters) {
$return = array();
/**
* 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) {
if ($data === null) {
/**
* optionally set the total number of items available
- * @param $items int
+ * @param int $items
*/
public function setTotalItems(int $items) {
$this->items = $items;
/**
* optionally set the the number of items per page
- * @param $items int
+ * @param int $items
*/
public function setItemsPerPage(int $items) {
$this->perPage = $items;
* @return array an array of application data
*
* This function returns a list of all the applications on the OCS server
- * @param $categories
+ * @param array|string $categories
* @param int $page
* @param string $filter
*/
/**
* @brief set the path of the file you want a thumbnail from
* @param string $file
- * @return $this
+ * @return object $this
*/
public function setFile($file) {
$this->file = $file;
* @brief set the the max width of the preview
* @param int $maxX
* @throws \Exception
- * @return $this
+ * @return \OC\Preview $this
*/
public function setMaxX($maxX = 1) {
if ($maxX <= 0) {
* @brief set the the max height of the preview
* @param int $maxY
* @throws \Exception
- * @return $this
+ * @return \OC\Preview $this
*/
public function setMaxY($maxY = 1) {
if ($maxY <= 0) {
/**
* @brief set whether or not scalingup is enabled
* @param bool $scalingUp
- * @return $this
+ * @return \OC\Preview $this
*/
public function setScalingup($scalingUp) {
if ($this->getMaxScaleFactor() === 1) {
}
/**
- * @param $fileId
+ * @param int $fileId
* @return string
*/
private function buildCachePath($fileId) {
/**
* @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
* DateTime object when to expire response
*/
/**
* Checks and set ETag header, when the request matches sends a
* '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) {
if (empty($etag)) {
/**
* Checks and set Last-Modified header, when the request matches sends a
* '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) {
if (empty($lastModified)) {
/**
* The action to execute when this route matches, includes a file like
* it is called directly
- * @param $file
+ * @param string $file
* @return void
*/
public function actionInclude($file) {
/**
* 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) {
require_once $file;
/**
* Generate a unique target for the item
- * @param string Item type
- * @param string Item source
- * @param int SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK
- * @param string User or group the item is being shared with
- * @param string User that is the owner of shared item
- * @param string The suggested target originating from a reshare (optional)
- * @param int The id of the parent group share (optional)
+ * @param string $itemType
+ * @param string $itemSource
+ * @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK
+ * @param string $shareWith User or group the item is being shared with
+ * @param string $uidOwner User that is the owner of shared item
+ * @param string $suggestedTarget The suggested target originating from a reshare (optional)
+ * @param int $groupParent The id of the parent group share (optional)
* @return string Item target
*/
public static function generateTarget($itemType, $itemSource, $shareType, $shareWith, $uidOwner,
/**
* Delete all reshares of an item
- * @param int Id of item to delete
- * @param bool If true, exclude the parent from the delete (optional)
- * @param string The user that the parent was shared with (optinal)
+ * @param int $parent Id of item to delete
+ * @param bool $excludeParent If true, exclude the parent from the delete (optional)
+ * @param string $uidOwner The user that the parent was shared with (optinal)
*/
public static function delete($parent, $excludeParent = false, $uidOwner = null) {
$ids = array($parent);
namespace OC\Share;
class Hooks extends \OC\Share\Constants {
- /**
+ /**
* 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) {
// Delete any items shared with the deleted user
/**
* Function that is called after a user is added to a group.
* TODO what does it do?
- * @param array arguments
+ * @param array $arguments
*/
public static function post_addToGroup($arguments) {
// Find the group shares and check if the user needs a unique target
/**
* 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) {
$sql = 'SELECT `id`, `share_type` FROM `*PREFIX*share`'
/**
* 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) {
$sql = 'SELECT `id` FROM `*PREFIX*share` WHERE `share_type` = ? AND `share_with` = ?';
* @brief inform users if a file was shared with them
*
* @param array $recipientList list of recipients
- * @param type $itemSource shared item source
- * @param type $itemType shared item type
+ * @param string $itemSource shared item source
+ * @param string $itemType shared item type
* @return array list of user to whom the mail send operation failed
*/
public function sendInternalShareMail($recipientList, $itemSource, $itemType) {
* @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
* against
- * @param $encoding optional, encoding to use, defaults to UTF-8
- * @param $log optional, an \OC\Log instance
+ * @param string $encoding optional, encoding to use, defaults to UTF-8
+ * @param \OC\Log $log optional
*/
public function __construct($search, $key, \OC\Log $log = null, $encoding = 'UTF-8') {
$this->encoding = $encoding;
/**
* Get the items of item type shared with a user
- * @param string Item type
- * @param sting user id for which user we want the shares
- * @param int Format (optional) Format type must be defined by the backend
- * @param mixed Parameters (optional)
- * @param int Number of items to return (optional) Returns all by default
- * @param boolean include collections (optional)
+ * @param string $itemType
+ * @param string $user id for which user we want the shares
+ * @param int $format (optional) Format type must be defined by the backend
+ * @param mixed $parameters (optional)
+ * @param int $limit Number of items to return (optional) Returns all by default
+ * @param boolean $includeCollections (optional)
* @return Return depends on format
*/
public static function getItemsSharedWithUser($itemType, $user, $format = self::FORMAT_NONE,
/**
* resolves reshares down to the last real share
- * @param $linkItem
- * @return $fileOwner
+ * @param array $linkItem
+ * @return array file owner
*/
public static function resolveReShare($linkItem)
{
* @param string $uidOwner
* @param boolean $includeCollections
* @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) {
/**
* Get shared items from the database
* @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 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 mixed $parameters to pass to formatItems() (optional)
* @param int $limit Number of items to return, -1 to return all matches (optional)
/**
* @brief delete all SubAdmins by uid
- * @param $parameters
+ * @param array $parameters
* @return boolean
*/
public static function post_deleteUser($parameters) {
/**
* @brief delete all SubAdmins by gid
- * @param $parameters
+ * @param array $parameters
* @return boolean
*/
public static function post_deleteGroup($parameters) {
*
* For hooking up on post_deleteUser
*
- * @param array
+ * @param array $arguments
*/
public static function post_deleteUser($arguments) {
// Find all objectid/tagId pairs.
/**
* @brief make preview_icon available as a simple function
* 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
*
* For further information have a look at OC_Helper::previewIcon
/*
* @brief append the $file resource if exist at $root
- * @param $root path to check
- * @param $file the filename
- * @param $web base for path, default map $root to $webroot
- */
- /**
- * @param string $file
- * @param string|false $webroot
+ * @param string $root path to check
+ * @param string $file the filename
+ * @param string|null $webroot base for path, default map $root to $webroot
*/
protected function appendIfExist($root, $file, $webroot = null) {
if (is_file($root.'/'.$file)) {
}
/**
- * @param $styles
+ * @param array $styles
* @return array
*/
static public function findStylesheetFiles($styles) {
}
/**
- * @param $scripts
+ * @param array $scripts
* @return array
*/
static public function findJavascriptFiles($scripts) {
}
/**
- * @param $files
+ * @param array $files
* @return string
*/
private static function hashScriptNames($files)
/**
* @brief Creates an url using a defined route
- * @param $route
+ * @param string $route
* @param array $parameters
* @internal param array $args with param=>value, will be appended to the returned url
* @return string the url
/**
* @brief Create a new user
- * @param $uid The username of the user to create
- * @param $password The password of the new user
- * @return true/false
+ * @param string $uid The username of the user to create
+ * @param string $password The password of the new user
+ * @return bool
*
* Creates a new user. Basic checking of username is done in OC_User
* itself, not in its subclasses.
/**
* @brief delete a user
- * @param $uid The username of the user to delete
- * @return true/false
+ * @param string $uid The username of the user to delete
+ * @return bool
*
* Deletes a user
*/
/**
* @brief Set password
- * @param $uid The username
- * @param $password The new password
- * @return true/false
+ * @param string $uid The username
+ * @param string $password The new password
+ * @return bool
*
* Change the password of a user
*/
/**
* @brief Set display name
- * @param $uid The username
- * @param $displayName The new display name
- * @return true/false
+ * @param string $uid The username
+ * @param string $displayName The new display name
+ * @return bool
*
* Change the display name of a 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
*/
public function getDisplayName($uid) {
/**
* @brief Check if the password is correct
- * @param $uid The username
- * @param $password The password
+ * @param string $uid The username
+ * @param string $password The password
* @return string
*
* Check if the password is correct without logging in the user
abstract class OC_User_Example extends OC_User_Backend {
/**
* @brief Create a new user
- * @param $uid The username of the user to create
- * @param $password The password of the new user
- * @return true/false
+ * @param string $uid The username of the user to create
+ * @param string $password The password of the new user
+ * @return bool
*
* Creates a new user. Basic checking of username is done in OC_User
* itself, not in its subclasses.
/**
* @brief Set password
- * @param $uid The username
- * @param $password The new password
- * @return true/false
+ * @param string $uid The username
+ * @param string $password The new password
+ * @return bool
*
* Change the password of a user
*/
/**
* @brief Check if the password is correct
- * @param $uid The username
- * @param $password The password
+ * @param string $uid The username
+ * @param string $password The password
* @return string
*
* Check if the password is correct without logging in the user
/**
* @brief get the user's home directory
- * @param $uid The username
+ * @param string $uid The username
* @return string
*
* get the user's home directory
class OC_User_HTTP extends OC_User_Backend {
/**
* split http://user@host/path into a user and url part
- * @param string path
+ * @param string $url
* @return array
*/
private function parseUrl($url) {
/**
* check if an url is a valid login
- * @param string url
+ * @param string $url
* @return boolean
*/
private function matchUrl($url) {
/**
* @brief Check if the password is correct
- * @param $uid The username
- * @param $password The password
+ * @param string $uid The username
+ * @param string $password The password
* @return string
*
* Check if the password is correct without logging in the user
*
* Returns the supported actions as int to be
* compared with OC_USER_BACKEND_CREATE_USER etc.
- * @return boolean
*/
public function implementsActions($actions);
/**
* @brief delete a user
- * @param $uid The username of the user to delete
- * @return true/false
- *
- * Deletes a user
- * @return boolean
+ * @param string $uid The username of the user to delete
+ * @return bool
*/
public function deleteUser($uid);
/**
* @brief get display name of the user
- * @param $uid user ID of the user
- * @return display name
+ * @param string $uid user ID of the user
+ * @return string display name
*/
public function getDisplayName($uid);
* 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.
*
- * @param string|array of strings
- * @return array an array of sanitized strings or a single sanitized string, depends on the input parameter.
+ * @param string|array &$value
+ * @return string|array an array of sanitized strings or a single sanitized string, depends on the input parameter.
*/
public static function sanitizeHTML( &$value ) {
if (is_array($value)) {
/**
* @brief Generates a cryptographic secure pseudo-random string
- * @param Int $length of the random string
- * @return String
+ * @param int $length of the random string
+ * @return string
* Please also update secureRNGAvailable if you change something here
*/
public static function generateRandomBytes($length = 30) {
/**
* 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
*/
public static function isValidFileName($file) {
/**
* Constructor
- * @param Sabre\VObject\Component or string
+ * @param Sabre\VObject\Component|string $vobject_or_name
*/
public function __construct($vobject_or_name) {
if (is_object($vobject_or_name)) {
/**
* @todo Write documentation
- * @param $item
+ * @param \OC_VObject|\Sabre\VObject\Component $item
* @param null $itemValue
*/
public function add($item, $itemValue = null) {
/**
* @todo Write documentation
- * @param mixed $name
+ * @param mixed $name
* @param string $string
*/
public function setString($name, $string) {
/**
* @todo Write documentation
- * @param $name
+ * @param string $name
* @return string
*/
public function getAsString($name) {
/**
* @todo Write documentation
- * @param $name
+ * @param string $name
* @return array
*/
public function getAsArray($name) {
/**
* @todo Write documentation
- * @param $name
+ * @param string $name
* @return array|OC_VObject|\Sabre\VObject\Property
*/
public function &__get($name) {
/**
* @todo Write documentation
- * @param $function
- * @param $arguments
+ * @param callable $function
+ * @param array $arguments
* @return mixed
*/
public function __call($function, $arguments) {
class App {
/**
* Makes ownCloud aware of this app
- * @param array with all information
+ * @param array $data with all information
* @return boolean
*
* @deprecated This method is deprecated. Do not call it anymore.
/**
* Adds an entry to the navigation
- * @param array containing the data
+ * @param array $data containing the data
* @return boolean
*
* This function adds a new entry to the navigation visible to users. $data
/**
* Marks a navigation entry as active
- * @param string id of the entry
+ * @param string $id id of the entry
* @return boolean
*
* This function sets a navigation entry as active and removes the 'active'
/**
* Register a Configuration Screen that should appear in the personal settings section.
- * @param $app string appid
- * @param $page string page to be included
+ * @param string $app appid
+ * @param string $page page to be included
* @return void
*/
public static function registerPersonal( $app, $page ) {
/**
* @deprecated
* gets all regular tasks
- * @return associative array
+ * @return array
*
* key is string "$klass-$method", value is array( $klass, $method )
*/
* @deprecated
* Gets one queued task
* @param int $id ID of the task
- * @return BackgroundJob\IJob array
+ * @return BackgroundJob\IJob|null
*/
public static function findQueuedTask($id) {
$jobList = \OC::$server->getJobList();
/**
* 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 string $job
* @return void
/**
* Remove a job from the list
*
- * @param IJob $job
+ * @param \OCP\BackgroundJob\IJob|string $job
* @param mixed $argument
* @return void
*/
/**
* check if a job is in the list
*
- * @param $job
+ * @param \OCP\BackgroundJob\IJob|string $job
* @param mixed $argument
* @return bool
*/
* This function can be used to delete the contact identified by the given id
*
* @param object $id the unique identifier to a contact
- * @param $address_book_key
+ * @param string $address_book_key
* @return bool successful or not
*/
public static function delete($id, $address_book_key) {
* 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 $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
*/
public static function createOrUpdate($properties, $address_book_key) {
/**
* 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 $input array
+ * @param array $input
*
* The input array if in the form:
*
/**
* @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
*/
function get($size = 64);
/**
* @brief return a user specific instance of \OCP\IAvatar
* @see \OCP\IAvatar
- * @param $user string the ownCloud user id
+ * @param string $user the ownCloud user id
* @return \OCP\IAvatar
*/
function getAvatar($user);
/**
* Insert a row if a matching row doesn't exists.
- * @param string The table name (will replace *PREFIX*) to perform the replace on.
- * @param array
+ * @param string $table The table name (will replace *PREFIX*) to perform the replace on.
+ * @param array $input
*
* The input array if in the form:
*
* Localization
* @param string $type Type of localization
* @param array $data parameters for this localization
- * @return String or false
+ * @return string|false
*
* Returns the localized data.
*
* The action to execute when this route matches, includes a file like
* it is called directly
*
- * @param $file
+ * @param string $file
* @return void
*/
public function actionInclude($file);
/**
* Get the items of item type shared with a user
- * @param string Item type
- * @param sting user id for which user we want the shares
- * @param int Format (optional) Format type must be defined by the backend
- * @param mixed Parameters (optional)
- * @param int Number of items to return (optional) Returns all by default
- * @param bool include collections (optional)
- * @return Return depends on format
+ * @param string $itemType
+ * @param string $user for which user we want the shares
+ * @param int $format (optional) Format type must be defined by the backend
+ * @param mixed $parameters (optional)
+ * @param int $limit Number of items to return (optional) Returns all by default
+ * @param bool $includeCollections (optional)
+ * @return mixed Return depends on format
*/
public static function getItemsSharedWithUser($itemType, $user, $format = self::FORMAT_NONE,
$parameters = null, $limit = -1, $includeCollections = false) {
* @param string $itemType
* @param string $itemTarget
* @param int $format (optional) Format type must be defined by the backend
- * @param mixed Parameters (optional)
- * @param bool include collections (optional)
+ * @param mixed $parameters (optional)
+ * @param bool $includeCollections (optional)
* @return mixed Return depends on format
*/
public static function getItemSharedWith($itemType, $itemTarget, $format = self::FORMAT_NONE,
/**
* resolves reshares down to the last real share
- * @param $linkItem
- * @return $fileOwner
+ * @param array $linkItem
+ * @return array file owner
*/
public static function resolveReShare($linkItem) {
return \OC\Share\Share::resolveReShare($linkItem);
* @param string $uidOwner
* @param bool $includeCollections
* @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) {
return \OC\Share\Share::getUsersItemShared($itemType, $itemSource, $uidOwner, $includeCollections, $checkExpireDate);
/**
* Make OC_Helper::imagePath available as a simple function
- * @param string app
- * @param string image
+ * @param string $app
+ * @param string $image
* @return string to the image
*
* @see OC_Helper::imagePath
/**
* Make OC_Helper::mimetypeIcon available as a simple function
- * @param string mimetype
+ * @param string $mimetype
* @return string to the image of this file type.
*/
function mimetype_icon( $mimetype ) {
/**
* 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
*/
function preview_icon( $path ) {
/**
* Make OC_Helper::humanFileSize available as a simple function
* Example: 2048 to 2 kB.
- * @param int size in bytes
+ * @param int $size in bytes
* @return string size as string
*/
function human_file_size( $bytes ) {
/**
* Return the relative date in relation to today. Returns something like "last hour" or "two month ago"
- * @param int unix timestamp
- * @param boolean date only
+ * @param int $timestamp unix timestamp
+ * @param boolean $dateOnly
* @return OC_L10N_String human readable interpretation of the timestamp
*/
function relative_modified_date( $timestamp, $dateOnly = false ) {
/**
* Return a human readable outout for a file size.
* @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
*/
function simple_file_size($bytes) {
/**
* Generate html code for an options block.
- * @param $options the options
- * @param $selected which one is selected?
- * @param array the parameters
+ * @param array $options the options
+ * @param mixed $selected which one is selected?
+ * @param array $params the parameters
* @return string html options
*/
function html_select_options($options, $selected, $params=array()) {
/**
* Get a list of all users
- * @param string search pattern
- * @param integer $limit
- * @param integer $offset
+ * @param string $search search pattern
+ * @param int|null $limit
+ * @param int|null $offset
* @return array an array of all uids
*/
public static function getUsers( $search = '', $limit = null, $offset = null ) {
/**
* 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
*/
public static function getDisplayName( $user = null ) {
/**
* Get a list of all display names and user ids.
- * @param string search pattern
- * @param int limit
- * @param int offset
+ * @param string $search search pattern
+ * @param int|null $limit
+ * @param int|null $offset
* @return array an array of all display names (value) and the correspondig uids (key)
*/
public static function getDisplayNames( $search = '', $limit = null, $offset = null ) {
/**
* Creates an url using a defined route
- * @param $route
+ * @param string $route
* @param array $parameters
* @internal param array $args with param=>value, will be appended to the returned url
* @return string the url
* 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.
*
- * @param string|array of strings
- * @return array an array of sanitized strings or a single sinitized string, depends on the input parameter.
+ * @param string|array $value
+ * @return string|array an array of sanitized strings or a single sinitized string, depends on the input parameter.
*/
public static function sanitizeHTML( $value ) {
return(\OC_Util::sanitizeHTML($value));
*
* @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
- * @return number of bytes representing
+ * @return int number of bytes representing
*/
public static function maxUploadFilesize($dir, $free = null) {
return \OC_Helper::maxUploadFilesize($dir, $free);
/**
* Calculate PHP upload limit
*
- * @return number of bytes representing
+ * @return int number of bytes representing
*/
public static function uploadLimit() {
return \OC_Helper::uploadLimit();
/**
* 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
*/
public static function isValidFileName($file) {
/**
* @brief Generates a cryptographic secure pseudo-random string
- * @param Int $length of the random string
- * @return String
+ * @param int $length of the random string
+ * @return string
*/
public static function generateRandomBytes($length = 30) {
return \OC_Util::generateRandomBytes($length);
projects / nextcloud-server.git / commitdiff