Merge pull request #8542 from owncloud/phpdoc-improvements

PHPDoc Improvements
This commit is contained in:
Thomas Müller 2014-05-13 23:23:11 +02:00
commit 5fb94bf76f
121 changed files with 543 additions and 487 deletions

View File

@ -254,7 +254,7 @@ class Crypt {
* @brief Concatenate encrypted data with its IV and padding * @brief Concatenate encrypted data with its IV and padding
* @param string $content content to be concatenated * @param string $content content to be concatenated
* @param string $iv IV to be concatenated * @param string $iv IV to be concatenated
* @returns string concatenated content * @return string concatenated content
*/ */
private static function concatIv($content, $iv) { private static function concatIv($content, $iv) {
@ -267,7 +267,7 @@ class Crypt {
/** /**
* @brief Split concatenated data and IV into respective parts * @brief Split concatenated data and IV into respective parts
* @param string $catFile concatenated data to be split * @param string $catFile concatenated data to be split
* @returns array keys: encrypted, iv * @return array keys: encrypted, iv
*/ */
private static function splitIv($catFile) { private static function splitIv($catFile) {
@ -330,7 +330,7 @@ class Crypt {
* @internal param string $source * @internal param string $source
* @internal param string $target * @internal param string $target
* @internal param string $key the decryption key * @internal param string $key the decryption key
* @returns string decrypted content * @return string decrypted content
* *
* This function decrypts a file * This function decrypts a file
*/ */
@ -362,7 +362,7 @@ class Crypt {
* @brief Decrypt private key and check if the result is a valid keyfile * @brief Decrypt private key and check if the result is a valid keyfile
* @param string $encryptedKey encrypted keyfile * @param string $encryptedKey encrypted keyfile
* @param string $passphrase to decrypt keyfile * @param string $passphrase to decrypt keyfile
* @returns encrypted private key or false * @return encrypted private key or false
* *
* This function decrypts a file * This function decrypts a file
*/ */
@ -389,7 +389,7 @@ class Crypt {
* @brief Create asymmetrically encrypted keyfile content using a generated key * @brief Create asymmetrically encrypted keyfile content using a generated key
* @param string $plainContent content to be encrypted * @param string $plainContent content to be encrypted
* @param array $publicKeys array keys must be the userId of corresponding user * @param array $publicKeys array keys must be the userId of corresponding user
* @returns array keys: keys (array, key = userId), data * @return array keys: keys (array, key = userId), data
* @note symmetricDecryptFileContent() can decrypt files created using this method * @note symmetricDecryptFileContent() can decrypt files created using this method
*/ */
public static function multiKeyEncrypt($plainContent, array $publicKeys) { public static function multiKeyEncrypt($plainContent, array $publicKeys) {
@ -440,7 +440,7 @@ class Crypt {
* @param $privateKey * @param $privateKey
* @return false|string * @return false|string
* @internal param string $plainContent content to be encrypted * @internal param string $plainContent content to be encrypted
* @returns string $plainContent decrypted string * @return string $plainContent decrypted string
* @note symmetricDecryptFileContent() can be used to decrypt files created using this method * @note symmetricDecryptFileContent() can be used to decrypt files created using this method
* *
* This function decrypts a file * This function decrypts a file
@ -498,7 +498,7 @@ class Crypt {
/** /**
* @brief Generate a pseudo random 256-bit ASCII key, used as file key * @brief Generate a pseudo random 256-bit ASCII key, used as file key
* @returns $key Generated key * @return $key Generated key
*/ */
public static function generateKey() { public static function generateKey() {

View File

@ -145,7 +145,7 @@ class Session {
/** /**
* @brief Gets status if we already tried to initialize the encryption app * @brief Gets status if we already tried to initialize the encryption app
* @returns init status INIT_SUCCESSFUL, INIT_EXECUTED, NOT_INOITIALIZED * @return init status INIT_SUCCESSFUL, INIT_EXECUTED, NOT_INOITIALIZED
* *
* @note this doesn not indicate of the init was successful, we just remeber the try! * @note this doesn not indicate of the init was successful, we just remeber the try!
*/ */
@ -159,7 +159,7 @@ class Session {
/** /**
* @brief Gets user or public share private key from session * @brief Gets user or public share private key from session
* @returns string $privateKey The user's plaintext private key * @return string $privateKey The user's plaintext private key
* *
*/ */
public function getPrivateKey() { public function getPrivateKey() {
@ -190,7 +190,7 @@ class Session {
/** /**
* @brief Gets public share private key from session * @brief Gets public share private key from session
* @returns string $privateKey * @return string $privateKey
* *
*/ */
public function getPublicSharePrivateKey() { public function getPublicSharePrivateKey() {
@ -217,7 +217,7 @@ class Session {
/** /**
* @brief Gets user legacy key from session * @brief Gets user legacy key from session
* @returns string $legacyKey The user's plaintext legacy key * @return string $legacyKey The user's plaintext legacy key
* *
*/ */
public function getLegacyKey() { public function getLegacyKey() {

View File

@ -196,7 +196,7 @@ class Api {
} }
/** /**
* @breif create a new share * @brief create a new share
* @param array $params * @param array $params
* @return \OC_OCS_Result * @return \OC_OCS_Result
*/ */

View File

@ -36,7 +36,7 @@ class Shared extends \OC\Files\Storage\Common {
} }
/** /**
* @breif get id of the mount point * @brief get id of the mount point
* @return string * @return string
*/ */
public function getId() { public function getId() {
@ -44,7 +44,7 @@ class Shared extends \OC\Files\Storage\Common {
} }
/** /**
* @breif get file cache of the shared item source * @brief get file cache of the shared item source
* @return string * @return string
*/ */
public function getSourceId() { public function getSourceId() {

View File

@ -265,7 +265,7 @@ class Storage {
* @param string $uid user id from the owner of the file * @param string $uid user id from the owner of the file
* @param string $filename file to find versions of, relative to the user files dir * @param string $filename file to find versions of, relative to the user files dir
* @param string $userFullPath * @param string $userFullPath
* @returns array versions newest version first * @return array versions newest version first
*/ */
public static function getVersions($uid, $filename, $userFullPath = '') { public static function getVersions($uid, $filename, $userFullPath = '') {
$versions = array(); $versions = array();

View File

@ -175,7 +175,7 @@ class OC {
OC::$SERVERROOT . '/lib/private' . PATH_SEPARATOR . OC::$SERVERROOT . '/lib/private' . PATH_SEPARATOR .
OC::$SERVERROOT . '/config' . PATH_SEPARATOR . OC::$SERVERROOT . '/config' . PATH_SEPARATOR .
OC::$THIRDPARTYROOT . '/3rdparty' . PATH_SEPARATOR . OC::$THIRDPARTYROOT . '/3rdparty' . PATH_SEPARATOR .
implode($paths, PATH_SEPARATOR) . PATH_SEPARATOR . implode(PATH_SEPARATOR, $paths) . PATH_SEPARATOR .
get_include_path() . PATH_SEPARATOR . get_include_path() . PATH_SEPARATOR .
OC::$SERVERROOT OC::$SERVERROOT
); );

View File

@ -307,7 +307,7 @@ class OC_App{
/** /**
* @brief Get the navigation entries for the $app * @brief Get the navigation entries for the $app
* @param string $app app * @param string $app app
* @return array of the $data added with addNavigationEntry * @return array an array of the $data added with addNavigationEntry
* *
* Warning: destroys the existing entries * Warning: destroys the existing entries
*/ */
@ -660,7 +660,7 @@ class OC_App{
/** /**
* @brief: get a list of all apps in the apps folder * @brief: get a list of all apps in the apps folder
* @return array or app names (string IDs) * @return array an array of app names (string IDs)
* @todo: change the name of this method to getInstalledApps, which is more accurate * @todo: change the name of this method to getInstalledApps, which is more accurate
*/ */
public static function getAllApps() { public static function getAllApps() {

View File

@ -90,7 +90,7 @@ class AppConfig implements \OCP\IAppConfig {
/** /**
* @brief Get all apps using the config * @brief Get all apps using the config
* @return array with app ids * @return array an array of app ids
* *
* This function returns a list of all apps that have at least one * This function returns a list of all apps that have at least one
* entry in the appconfig table. * entry in the appconfig table.
@ -109,7 +109,7 @@ class AppConfig implements \OCP\IAppConfig {
/** /**
* @brief Get the available keys for an app * @brief Get the available keys for an app
* @param string $app the app we are looking for * @param string $app the app we are looking for
* @return array with key names * @return array an array of key names
* *
* This function gets all keys of an app. Please note that the values are * This function gets all keys of an app. Please note that the values are
* not returned. * not returned.

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) {

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') {

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) {

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) {

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

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) {

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` = ?');

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) {

View File

@ -65,7 +65,7 @@ class Config {
/** /**
* @brief Lists all available config keys * @brief Lists all available config keys
* @return array with key names * @return array an array of key names
* *
* This function returns all keys saved in config.php. Please note that it * This function returns all keys saved in config.php. Please note that it
* does not return the values. * does not return the values.
@ -77,8 +77,8 @@ class Config {
/** /**
* @brief Gets a value from config.php * @brief Gets a value from config.php
* @param string $key key * @param string $key key
* @param array|bool|string|null $default = null default value * @param mixed $default = null default value
* @return string the value or $default * @return mixed the value or $default
* *
* This function gets the value from config.php. If it does not exist, * This function gets the value from config.php. If it does not exist,
* $default will be returned. * $default will be returned.
@ -94,7 +94,7 @@ class Config {
/** /**
* @brief Sets a value * @brief Sets a value
* @param string $key key * @param string $key key
* @param string $value value * @param mixed $value value
* *
* This function sets the value and writes the config.php. * This function sets the value and writes the config.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) {

View File

@ -123,7 +123,7 @@ class OC_Connector_Sabre_File extends OC_Connector_Sabre_Node implements Sabre_D
/** /**
* Returns the data * Returns the data
* *
* @return string | resource * @return string|resource
*/ */
public function get() { public function get() {

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
*/ */

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) {

View File

@ -31,7 +31,7 @@ namespace OC {
* @param string $pattern which should match within the $searchProperties * @param string $pattern which should match within the $searchProperties
* @param array $searchProperties defines the properties within the query pattern should match * @param array $searchProperties defines the properties within the query pattern should match
* @param array $options - for future use. One should always have options! * @param array $options - for future use. One should always have options!
* @return array of contacts which are arrays of key-value-pairs * @return array an array of contacts which are arrays of key-value-pairs
*/ */
public function search($pattern, $searchProperties = array(), $options = array()) { public function search($pattern, $searchProperties = array(), $options = array()) {
$result = array(); $result = array();
@ -72,7 +72,7 @@ namespace OC {
* *
* @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 string $address_book_key identifier of 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 representing the contact just created or updated * @return array an array representing the contact just created or updated
*/ */
public function createOrUpdate($properties, $address_book_key) { public function createOrUpdate($properties, $address_book_key) {

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();

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:
* *

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();

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
*/ */
@ -303,7 +303,7 @@ class MDB2SchemaReader {
} }
/** /**
* @param \SimpleXMLElement | string $xml * @param \SimpleXMLElement|string $xml
* @return bool * @return bool
*/ */
private function asBool($xml) { private function asBool($xml) {

View File

@ -41,7 +41,7 @@ class OC_DB_StatementWrapper {
* make execute return the result instead of a bool * make execute return the result instead of a bool
* *
* @param array $input * @param array $input
* @return \OC_DB_StatementWrapper | int * @return \OC_DB_StatementWrapper|int
*/ */
public function execute($input=array()) { public function execute($input=array()) {
if(OC_Config::getValue( "log_query", false)) { if(OC_Config::getValue( "log_query", false)) {

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')) {

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
*/ */

View File

@ -225,7 +225,7 @@ class OC_Files {
* checks if the selected files are within the size constraint. If not, outputs an error page. * checks if the selected files are within the size constraint. If not, outputs an error page.
* *
* @param string $dir * @param string $dir
* @param array | string $files * @param array|string $files
*/ */
static function validateZipDownload($dir, $files) { static function validateZipDownload($dir, $files) {
if (!OC_Config::getValue('allowZipDownload', true)) { if (!OC_Config::getValue('allowZipDownload', true)) {

View File

@ -109,7 +109,7 @@ class Cache {
* get the stored metadata of a file or folder * get the stored metadata of a file or folder
* *
* @param string/int $file * @param string/int $file
* @return array | false * @return array|false
*/ */
public function get($file) { public function get($file) {
if (is_string($file) or $file == '') { if (is_string($file) or $file == '') {
@ -450,7 +450,7 @@ class Cache {
* search for files matching $pattern * search for files matching $pattern
* *
* @param string $pattern * @param string $pattern
* @return array of file data * @return array an array of file data
*/ */
public function search($pattern) { public function search($pattern) {
@ -597,7 +597,7 @@ class Cache {
* get the path of a file on this storage by it's id * get the path of a file on this storage by it's id
* *
* @param int $id * @param int $id
* @return string | null * @return string|null
*/ */
public function getPathById($id) { public function getPathById($id) {
$sql = 'SELECT `path` FROM `*PREFIX*filecache` WHERE `fileid` = ? AND `storage` = ?'; $sql = 'SELECT `path` FROM `*PREFIX*filecache` WHERE `fileid` = ? AND `storage` = ?';
@ -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) {

View File

@ -61,7 +61,7 @@ class Scanner extends BasicEmitter {
* * * *
* *
* @param string $path * @param string $path
* @return array with metadata of the file * @return array an array of metadata of the file
*/ */
public function getData($path) { public function getData($path) {
if (!$this->storage->isReadable($path)) { if (!$this->storage->isReadable($path)) {
@ -88,7 +88,7 @@ class Scanner extends BasicEmitter {
* @param string $file * @param string $file
* @param int $reuseExisting * @param int $reuseExisting
* @param bool $parentExistsInCache * @param bool $parentExistsInCache
* @return array with metadata of the scanned file * @return array an array of metadata of the scanned file
*/ */
public function scanFile($file, $reuseExisting = 0, $parentExistsInCache = false) { public function scanFile($file, $reuseExisting = 0, $parentExistsInCache = false) {
if (!self::isPartialFile($file) if (!self::isPartialFile($file)
@ -174,7 +174,7 @@ class Scanner extends BasicEmitter {
* @param string $path * @param string $path
* @param bool $recursive * @param bool $recursive
* @param int $reuse * @param int $reuse
* @return array with the meta data of the scanned file or folder * @return array an array of the meta data of the scanned file or folder
*/ */
public function scan($path, $recursive = self::SCAN_RECURSIVE, $reuse = -1) { public function scan($path, $recursive = self::SCAN_RECURSIVE, $reuse = -1) {
if ($reuse === -1) { if ($reuse === -1) {
@ -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) {

View File

@ -17,7 +17,7 @@ class Updater {
* resolve a path to a storage and internal path * resolve a path to a storage and internal path
* *
* @param string $path the relative path * @param string $path the relative path
* @return array consisting of the storage and the internal path * @return array an array consisting of the storage and the internal path
*/ */
static public function resolvePath($path) { static public function resolvePath($path) {
$view = \OC\Files\Filesystem::getView(); $view = \OC\Files\Filesystem::getView();

View File

@ -55,7 +55,7 @@ class Watcher {
* check $path for updates * check $path for updates
* *
* @param string $path * @param string $path
* @return boolean | array true if path was updated, otherwise the cached data is returned * @return boolean|array true if path was updated, otherwise the cached data is returned
*/ */
public function checkUpdate($path) { public function checkUpdate($path) {
if ($this->watchPolicy === self::CHECK_ALWAYS or ($this->watchPolicy === self::CHECK_ONCE and array_search($path, $this->checkedPaths) === false)) { if ($this->watchPolicy === self::CHECK_ALWAYS or ($this->watchPolicy === self::CHECK_ONCE and array_search($path, $this->checkedPaths) === false)) {

View File

@ -147,7 +147,7 @@ class FileInfo implements \OCP\Files\FileInfo, \ArrayAccess {
} }
/** /**
* @return \OCP\Files\FileInfo::TYPE_FILE | \OCP\Files\FileInfo::TYPE_FOLDER * @return \OCP\Files\FileInfo::TYPE_FILE|\OCP\Files\FileInfo::TYPE_FOLDER
*/ */
public function getType() { public function getType() {
if (isset($this->data['type'])) { if (isset($this->data['type'])) {

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) {
@ -270,7 +270,7 @@ class Filesystem {
* resolve a path to a storage and internal path * resolve a path to a storage and internal path
* *
* @param string $path * @param string $path
* @return array consisting of the storage and the internal path * @return array an array consisting of the storage and the internal path
*/ */
static public function resolvePath($path) { static public function resolvePath($path) {
if (!self::$mounts) { if (!self::$mounts) {

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) {

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) {

View File

@ -28,7 +28,7 @@ class Mount {
private $loader; private $loader;
/** /**
* @param string | \OC\Files\Storage\Storage $storage * @param string|\OC\Files\Storage\Storage $storage
* @param string $mountpoint * @param string $mountpoint
* @param array $arguments (optional)\ * @param array $arguments (optional)\
* @param \OC\Files\Storage\Loader $loader * @param \OC\Files\Storage\Loader $loader

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) {

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) {

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;

View File

@ -18,7 +18,15 @@ class OC {
static private $rootView; static private $rootView;
private $path; private $path;
/**
* @var resource
*/
private $dirSource; private $dirSource;
/**
* @var resource
*/
private $fileSource; private $fileSource;
private $meta; private $meta;

View File

@ -19,7 +19,7 @@ class TemplateManager {
* get the path of the template for a mimetype * get the path of the template for a mimetype
* *
* @param string $mimetype * @param string $mimetype
* @return string | null * @return string|null
*/ */
public function getTemplatePath($mimetype) { public function getTemplatePath($mimetype) {
if (isset($this->templates[$mimetype])) { if (isset($this->templates[$mimetype])) {

View File

@ -109,7 +109,7 @@ class View {
* resolve a path to a storage and internal path * resolve a path to a storage and internal path
* *
* @param string $path * @param string $path
* @return array consisting of the storage and the internal path * @return array an array consisting of the storage and the internal path
*/ */
public function resolvePath($path) { public function resolvePath($path) {
$a = $this->getAbsolutePath($path); $a = $this->getAbsolutePath($path);
@ -168,6 +168,10 @@ class View {
} }
} }
/**
* @param string $path
* @return resource
*/
public function opendir($path) { public function opendir($path) {
return $this->basicOperation('opendir', $path, array('read')); return $this->basicOperation('opendir', $path, array('read'));
} }
@ -552,6 +556,11 @@ class View {
} }
} }
/**
* @param string $path
* @param string $mode
* @return resource
*/
public function fopen($path, $mode) { public function fopen($path, $mode) {
$hooks = array(); $hooks = array();
switch ($mode) { switch ($mode) {
@ -796,7 +805,7 @@ class View {
* @param string $path * @param string $path
* @param boolean $includeMountPoints whether to add mountpoint sizes, * @param boolean $includeMountPoints whether to add mountpoint sizes,
* defaults to true * defaults to true
* @return \OC\Files\FileInfo | false * @return \OC\Files\FileInfo|false
*/ */
public function getFileInfo($path, $includeMountPoints = true) { public function getFileInfo($path, $includeMountPoints = true) {
$data = array(); $data = array();
@ -991,7 +1000,7 @@ class View {
* change file metadata * change file metadata
* *
* @param string $path * @param string $path
* @param array | \OCP\Files\FileInfo $data * @param array|\OCP\Files\FileInfo $data
* @return int * @return int
* *
* returns the fileid of the updated file * returns the fileid of the updated file

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) {

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) {
@ -179,7 +179,7 @@ class OC_Group {
/** /**
* @brief Get all groups a user belongs to * @brief Get all groups a user belongs to
* @param string $uid Name of the user * @param string $uid Name of the user
* @return array with 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
* if the user exists at all. * if the user exists at all.
@ -203,7 +203,7 @@ class OC_Group {
* @param string $search * @param string $search
* @param int|null $limit * @param int|null $limit
* @param int|null $offset * @param int|null $offset
* @returns array with group names * @return array an array of group names
* *
* Returns a list with all groups * Returns a list with all groups
*/ */
@ -232,7 +232,7 @@ class OC_Group {
* @param string $search * @param string $search
* @param int $limit * @param int $limit
* @param int $offset * @param int $offset
* @returns array with user ids * @return array an array of user ids
*/ */
public static function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) { public static function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) {
$group = self::getManager()->get($gid); $group = self::getManager()->get($gid);
@ -254,7 +254,7 @@ class OC_Group {
* @param string $search * @param string $search
* @param int $limit * @param int $limit
* @param int $offset * @param int $offset
* @return array with user ids * @return array an array of user ids
*/ */
public static function usersInGroups($gids, $search = '', $limit = -1, $offset = 0) { public static function usersInGroups($gids, $search = '', $limit = -1, $offset = 0) {
$users = array(); $users = array();
@ -271,7 +271,7 @@ class OC_Group {
* @param string $search * @param string $search
* @param int $limit * @param int $limit
* @param int $offset * @param int $offset
* @returns array with display names (value) and user ids(key) * @return array an array of display names (value) and user ids(key)
*/ */
public static function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) { public static function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) {
return self::getManager()->displayNamesInGroup($gid, $search, $limit, $offset); return self::getManager()->displayNamesInGroup($gid, $search, $limit, $offset);
@ -283,7 +283,7 @@ class OC_Group {
* @param string $search * @param string $search
* @param int $limit * @param int $limit
* @param int $offset * @param int $offset
* @return array with display names (Key) user ids (value) * @return array an array of display names (Key) user ids (value)
*/ */
public static function displayNamesInGroups($gids, $search = '', $limit = -1, $offset = 0) { public static function displayNamesInGroups($gids, $search = '', $limit = -1, $offset = 0) {
$displayNames = array(); $displayNames = array();

View File

@ -69,7 +69,7 @@ abstract class OC_Group_Backend implements OC_Group_Interface {
/** /**
* @brief Check if backend implements actions * @brief Check if backend implements actions
* @param int $actions bitwise-or'ed actions * @param int $actions bitwise-or'ed actions
* @return boolean * @return bool
* *
* Returns the supported actions as int to be * Returns the supported actions as int to be
* compared with OC_GROUP_BACKEND_CREATE_GROUP etc. * compared with OC_GROUP_BACKEND_CREATE_GROUP etc.
@ -93,7 +93,7 @@ abstract class OC_Group_Backend implements OC_Group_Interface {
/** /**
* @brief Get all groups a user belongs to * @brief Get all groups a user belongs to
* @param string $uid Name of the user * @param string $uid Name of the user
* @return array with 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
* if the user exists at all. * if the user exists at all.
@ -107,7 +107,7 @@ abstract class OC_Group_Backend implements OC_Group_Interface {
* @param string $search * @param string $search
* @param int $limit * @param int $limit
* @param int $offset * @param int $offset
* @return array with group names * @return array an array of group names
* *
* Returns a list with all groups * Returns a list with all groups
*/ */
@ -131,7 +131,7 @@ abstract class OC_Group_Backend implements OC_Group_Interface {
* @param string $search * @param string $search
* @param int $limit * @param int $limit
* @param int $offset * @param int $offset
* @return array with user ids * @return array an array of user ids
*/ */
public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) { public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) {
return array(); return array();

View File

@ -140,7 +140,7 @@ class OC_Group_Database extends OC_Group_Backend {
/** /**
* @brief Get all groups a user belongs to * @brief Get all groups a user belongs to
* @param string $uid Name of the user * @param string $uid Name of the user
* @return array with 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
* if the user exists at all. * if the user exists at all.
@ -163,7 +163,7 @@ class OC_Group_Database extends OC_Group_Backend {
* @param string $search * @param string $search
* @param int $limit * @param int $limit
* @param int $offset * @param int $offset
* @return array with group names * @return array an array of group names
* *
* Returns a list with all groups * Returns a list with all groups
*/ */
@ -197,7 +197,7 @@ class OC_Group_Database extends OC_Group_Backend {
* @param string $search * @param string $search
* @param int $limit * @param int $limit
* @param int $offset * @param int $offset
* @return array with user ids * @return array an array of user ids
*/ */
public function usersInGroup($gid, $search = '', $limit = null, $offset = null) { public function usersInGroup($gid, $search = '', $limit = null, $offset = null) {
$stmt = OC_DB::prepare('SELECT `uid` FROM `*PREFIX*group_user` WHERE `gid` = ? AND `uid` LIKE ?', $stmt = OC_DB::prepare('SELECT `uid` FROM `*PREFIX*group_user` WHERE `gid` = ? AND `uid` LIKE ?',
@ -215,9 +215,8 @@ class OC_Group_Database extends OC_Group_Backend {
* @brief get the number of all users matching the search string in a group * @brief get the number of all users matching the search string in a group
* @param string $gid * @param string $gid
* @param string $search * @param string $search
* @param int $limit * @return int|false
* @param int $offset * @throws DatabaseException
* @return int | false
*/ */
public function countUsersInGroup($gid, $search = '') { public function countUsersInGroup($gid, $search = '') {
$stmt = OC_DB::prepare('SELECT COUNT(`uid`) AS `count` FROM `*PREFIX*group_user` WHERE `gid` = ? AND `uid` LIKE ?'); $stmt = OC_DB::prepare('SELECT COUNT(`uid`) AS `count` FROM `*PREFIX*group_user` WHERE `gid` = ? AND `uid` LIKE ?');

View File

@ -29,9 +29,9 @@ 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
* @returns true/false * @return bool
* *
* Trys to create a new group. If the group name already exists, false will * Tries to create a new group. If the group name already exists, false will
* be returned. * be returned.
*/ */
public function createGroup($gid) { public function createGroup($gid) {
@ -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
* @returns 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
* @returns 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
* @returns 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
* @returns true/false * @return bool
* *
* removes the user from a group. * removes the user from a group.
*/ */
@ -118,8 +118,8 @@ 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
* @returns array with 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
* if the user exists at all. * if the user exists at all.
@ -136,18 +136,23 @@ class OC_Group_Dummy extends OC_Group_Backend {
} }
/** /**
* @brief get a list of all groups * @brief Get a list of all groups
* @returns array with group names * @param string $search
* * @param int $limit
* Returns a list with all groups * @param int $offset
* @return array an array of group names
*/ */
public function getGroups($search = '', $limit = -1, $offset = 0) { public function getGroups($search = '', $limit = -1, $offset = 0) {
return array_keys($this->groups); return array_keys($this->groups);
} }
/** /**
* @brief get a list of all users in a group * @brief Get a list of all users in a group
* @returns array with user ids * @param string $gid
* @param string $search
* @param int $limit
* @param int $offset
* @return array an array of user IDs
*/ */
public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) { public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) {
if(isset($this->groups[$gid])) { if(isset($this->groups[$gid])) {
@ -159,7 +164,11 @@ class OC_Group_Dummy extends OC_Group_Backend {
/** /**
* @brief get the number of all users in a group * @brief get the number of all users in a group
* @returns int | bool * @param string $gid
* @param string $search
* @param int $limit
* @param int $offset
* @return int
*/ */
public function countUsersInGroup($gid, $search = '', $limit = -1, $offset = 0) { public function countUsersInGroup($gid, $search = '', $limit = -1, $offset = 0) {
if(isset($this->groups[$gid])) { if(isset($this->groups[$gid])) {

View File

@ -28,18 +28,18 @@
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
* @returns true/false * @return bool
* *
* Trys to create a new group. If the group name already exists, false will * Tries to create a new group. If the group name already exists, false will
* be returned. * be returned.
*/ */
abstract public static function createGroup($gid); abstract public static function createGroup($gid);
/** /**
* @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
* @returns 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
* @returns 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
* @returns 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
* @returns true/false * @return bool
* *
* removes the user from a group. * removes the user from a group.
*/ */
@ -77,8 +77,8 @@ 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
* @returns array with 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
* if the user exists at all. * if the user exists at all.
@ -87,14 +87,15 @@ abstract class OC_Group_Example {
/** /**
* @brief get a list of all groups * @brief get a list of all groups
* @returns array with group names * @param string $search
* * @param int $limit
* Returns a list with all groups * @param int $offset
* @return array an array of group names
*/ */
abstract public static function getGroups($search = '', $limit = -1, $offset = 0); abstract public static function getGroups($search = '', $limit = -1, $offset = 0);
/** /**
* check if a group exists * @brief Check if a group exists
* @param string $gid * @param string $gid
* @return bool * @return bool
*/ */
@ -102,8 +103,11 @@ abstract class OC_Group_Example {
/** /**
* @brief get a list of all users in a group * @brief get a list of all users in a group
* @returns array with user ids * @param string $gid
* @param string $search
* @param int $limit
* @param int $offset
* @return array an array of user ids
*/ */
abstract public static function usersInGroup($gid, $search = '', $limit = -1, $offset = 0); abstract public static function usersInGroup($gid, $search = '', $limit = -1, $offset = 0);
} }

View File

@ -26,7 +26,7 @@ class Group {
private $usersLoaded; private $usersLoaded;
/** /**
* @var \OC_Group_Backend[] | \OC_Group_Database[] $backend * @var \OC_Group_Backend[]|\OC_Group_Database[] $backend
*/ */
private $backends; private $backends;
@ -184,7 +184,7 @@ class Group {
* returns the number of users matching the search string * returns the number of users matching the search string
* *
* @param string $search * @param string $search
* @return int | bool * @return int|bool
*/ */
public function count($search) { public function count($search) {
$users = false; $users = false;

View File

@ -45,7 +45,7 @@ interface OC_Group_Interface {
/** /**
* @brief Get all groups a user belongs to * @brief Get all groups a user belongs to
* @param string $uid Name of the user * @param string $uid Name of the user
* @return array with 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
* if the user exists at all. * if the user exists at all.
@ -57,7 +57,7 @@ interface OC_Group_Interface {
* @param string $search * @param string $search
* @param int $limit * @param int $limit
* @param int $offset * @param int $offset
* @return array with group names * @return array an array of group names
* *
* Returns a list with all groups * Returns a list with all groups
*/ */
@ -76,7 +76,7 @@ interface OC_Group_Interface {
* @param string $search * @param string $search
* @param int $limit * @param int $limit
* @param int $offset * @param int $offset
* @return array with user ids * @return array an array of user ids
*/ */
public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0); public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0);

View File

@ -28,7 +28,7 @@ use OC\Hooks\PublicEmitter;
*/ */
class Manager extends PublicEmitter { class Manager extends PublicEmitter {
/** /**
* @var \OC_Group_Backend[] | \OC_Group_Database[] $backends * @var \OC_Group_Backend[]|\OC_Group_Database[] $backends
*/ */
private $backends = array(); private $backends = array();
@ -165,7 +165,7 @@ class Manager extends PublicEmitter {
* @param string $search * @param string $search
* @param int $limit * @param int $limit
* @param int $offset * @param int $offset
* @return array with display names (value) and user ids (key) * @return array an array of display names (value) and user ids (key)
*/ */
public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) { public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) {
$group = $this->get($gid); $group = $this->get($gid);

View File

@ -32,11 +32,11 @@ 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
* @returns string the url * @return string the url
* *
* Returns a url to the given app and file. * Returns a url to the given app and file.
*/ */
@ -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

View File

@ -45,7 +45,7 @@ class OC_Hook{
* @brief emits a signal * @brief emits a signal
* @param string $signalclass class name of emitter * @param string $signalclass class name of emitter
* @param string $signalname name of signal * @param string $signalname name of signal
* @param array $params default: array() array with additional data * @param mixed $params default: array() array with additional data
* @return bool, true if slots exists or false if not * @return bool, true if slots exists or false if not
* *
* Emits a signal. To get data from the slot use references! * Emits a signal. To get data from the slot use references!

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);

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
* @returns 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

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){
@ -278,7 +278,7 @@ class OC_L10N implements \OCP\IL10N {
/** /**
* @brief getTranslations * @brief getTranslations
* @returns array Fetch all translations * @return array Fetch all translations
* *
* Returns an associative array with all translations * Returns an associative array with all translations
*/ */
@ -289,7 +289,7 @@ class OC_L10N implements \OCP\IL10N {
/** /**
* @brief getPluralFormString * @brief getPluralFormString
* @returns string containing the gettext "Plural-Forms"-string * @return string containing the gettext "Plural-Forms"-string
* *
* Returns a string like "nplurals=2; plural=(n != 1);" * Returns a string like "nplurals=2; plural=(n != 1);"
*/ */
@ -300,7 +300,7 @@ class OC_L10N implements \OCP\IL10N {
/** /**
* @brief getPluralFormFunction * @brief getPluralFormFunction
* @returns string the plural form function * @return string the plural form function
* *
* returned function accepts the argument $n * returned function accepts the argument $n
*/ */
@ -314,7 +314,7 @@ class OC_L10N implements \OCP\IL10N {
/** /**
* @brief get localizations * @brief get localizations
* @returns array Fetch all localizations * @return array Fetch all localizations
* *
* Returns an associative array with all localizations * Returns an associative array with all localizations
*/ */
@ -327,7 +327,7 @@ class OC_L10N implements \OCP\IL10N {
* @brief Localization * @brief Localization
* @param string $type Type of localization * @param string $type Type of localization
* @param array|int|string $data parameters for this localization * @param array|int|string $data parameters for this localization
* @returns String or false * @return String or false
* *
* Returns the localized data. * Returns the localized data.
* *
@ -381,7 +381,7 @@ class OC_L10N implements \OCP\IL10N {
/** /**
* @brief Choose a language * @brief Choose a language
* @param array $text Associative Array with possible strings * @param array $text Associative Array with possible strings
* @returns String * @return String
* *
* $text is an array 'de' => 'hallo welt', 'en' => 'hello world', ... * $text is an array 'de' => 'hallo welt', 'en' => 'hello world', ...
* *
@ -404,7 +404,7 @@ class OC_L10N implements \OCP\IL10N {
/** /**
* @brief find the best language * @brief find the best language
* @param array|string $app details below * @param array|string $app details below
* @returns string language * @return string language
* *
* If $app is an array, ownCloud assumes that these are the available * If $app is an array, ownCloud assumes that these are the available
* languages. Otherwise ownCloud tries to find the files in the l10n * languages. Otherwise ownCloud tries to find the files in the l10n
@ -477,7 +477,7 @@ class OC_L10N implements \OCP\IL10N {
/** /**
* @brief find the l10n directory * @brief find the l10n directory
* @param string $app App that needs to be translated * @param string $app App that needs to be translated
* @returns directory * @return directory
*/ */
protected static function findI18nDir($app) { protected static function findI18nDir($app) {
// find the i18n dir // find the i18n dir
@ -497,7 +497,7 @@ class OC_L10N implements \OCP\IL10N {
/** /**
* @brief find all available languages for an app * @brief find all available languages for an app
* @param string $app App that needs to be translated * @param string $app App that needs to be translated
* @returns array an array of available languages * @return array an array of available languages
*/ */
public static function findAvailableLanguages($app=null) { public static function findAvailableLanguages($app=null) {
$available=array('en');//english is always available $available=array('en');//english is always available
@ -517,7 +517,7 @@ class OC_L10N implements \OCP\IL10N {
/** /**
* @param string $app * @param string $app
* @param string $lang * @param string $lang
* @returns bool * @return bool
*/ */
public static function languageExists($app, $lang) { public static function languageExists($app, $lang) {
if ($lang == 'en') {//english is always available if ($lang == 'en') {//english is always available

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) {

View File

@ -35,7 +35,7 @@ class OC_Appconfig {
/** /**
* @brief Get all apps using the config * @brief Get all apps using the config
* @return array with app ids * @return array an array of app ids
* *
* This function returns a list of all apps that have at least one * This function returns a list of all apps that have at least one
* entry in the appconfig table. * entry in the appconfig table.
@ -47,7 +47,7 @@ class OC_Appconfig {
/** /**
* @brief Get the available keys for an app * @brief Get the available keys for an app
* @param string $app the app we are looking for * @param string $app the app we are looking for
* @return array with key names * @return array an array of key names
* *
* This function gets all keys of an app. Please note that the values are * This function gets all keys of an app. Please note that the values are
* not returned. * not returned.

View File

@ -51,7 +51,7 @@ class OC_Config {
/** /**
* @brief Lists all available config keys * @brief Lists all available config keys
* @return array with key names * @return array an array of key names
* *
* This function returns all keys saved in config.php. Please note that it * This function returns all keys saved in config.php. Please note that it
* does not return the values. * does not return the values.

View File

@ -29,7 +29,7 @@ class OC_Preferences{
public static $object; public static $object;
/** /**
* @brief Get all users using the preferences * @brief Get all users using the preferences
* @return array with user ids * @return array an array of user ids
* *
* This function returns a list of all users that have at least one entry * This function returns a list of all users that have at least one entry
* in the preferences table. * in the preferences table.
@ -54,7 +54,7 @@ class OC_Preferences{
* @brief Get the available keys for an app * @brief Get the available keys for an app
* @param string $user user * @param string $user user
* @param string $app the app we are looking for * @param string $app the app we are looking for
* @return array with key names * @return array an array of key names
* *
* This function gets all keys of an app of an user. Please note that the * This function gets all keys of an app of an user. Please note that the
* values are not returned. * values are not returned.

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,9 +536,9 @@ 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 of apps with import statuses, or false on failure. * @return array an array of apps with import statuses, or false on failure.
*/ */
public static function importAppData( $db, $info, $uid=null ) { public static function importAppData( $db, $info, $uid=null ) {
// Check if the db exists // Check if the db exists

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='' ) {

View File

@ -30,7 +30,7 @@ class NavigationManager implements \OCP\INavigationManager {
/** /**
* @brief returns all the added Menu entries * @brief returns all the added Menu entries
* @return array of the added entries * @return array an array of the added entries
*/ */
public function getAll() { public function getAll() {
return $this->entries; return $this->entries;

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) {

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();

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;

View File

@ -30,7 +30,7 @@ class OC_OCSClient{
/** /**
* @brief Get the url of the OCS AppStore server. * @brief Get the url of the OCS AppStore server.
* @returns string of the AppStore server * @return string of the AppStore server
* *
* This function returns the url of the OCS AppStore server. It´s possible * This function returns the url of the OCS AppStore server. It´s possible
* to set it in the config file or it will fallback to the default * to set it in the config file or it will fallback to the default
@ -48,7 +48,7 @@ class OC_OCSClient{
/** /**
* @brief Get the content of an OCS url call. * @brief Get the content of an OCS url call.
* @returns string of the response * @return string of the response
* This function calls an OCS server and returns the response. It also sets a sane timeout * This function calls an OCS server and returns the response. It also sets a sane timeout
* @param string $url * @param string $url
*/ */
@ -59,7 +59,7 @@ class OC_OCSClient{
/** /**
* @brief Get all the categories from the OCS server * @brief Get all the categories from the OCS server
* @returns array with category ids * @return array an array of category ids
* @note returns NULL if config value appstoreenabled is set to false * @note returns NULL if config value appstoreenabled is set to false
* This function returns a list of all the application categories on the OCS server * This function returns a list of all the application categories on the OCS server
*/ */
@ -92,10 +92,10 @@ class OC_OCSClient{
/** /**
* @brief Get all the applications from the OCS server * @brief Get all the applications from the OCS server
* @returns array with 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
*/ */
@ -150,7 +150,7 @@ class OC_OCSClient{
/** /**
* @brief Get an the applications from the OCS server * @brief Get an the applications from the OCS server
* @param string $id * @param string $id
* @returns array with application data * @return array an array of application data
* *
* This function returns an applications from the OCS server * This function returns an applications from the OCS server
*/ */
@ -192,7 +192,7 @@ class OC_OCSClient{
/** /**
* @brief Get the download url for an application from the OCS server * @brief Get the download url for an application from the OCS server
* @returns array with application data * @return array an array of application data
* *
* This function returns an download url for an applications from the OCS server * This function returns an download url for an applications from the OCS server
* @param string $id * @param string $id

View File

@ -69,7 +69,7 @@ class Preferences {
/** /**
* @brief Get all users using the preferences * @brief Get all users using the preferences
* @return array with user ids * @return array an array of user ids
* *
* This function returns a list of all users that have at least one entry * This function returns a list of all users that have at least one entry
* in the preferences table. * in the preferences table.
@ -125,7 +125,7 @@ class Preferences {
* @brief Get the available keys for an app * @brief Get the available keys for an app
* @param string $user user * @param string $user user
* @param string $app the app we are looking for * @param string $app the app we are looking for
* @return array with key names * @return array an array of key names
* *
* This function gets all keys of an app of an user. Please note that the * This function gets all keys of an app of an user. Please note that the
* values are not returned. * values are not returned.

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 \OC\Preview $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) {
@ -382,7 +382,7 @@ class Preview {
/** /**
* @brief get possible bigger thumbnails of the given image * @brief get possible bigger thumbnails of the given image
* @param int $fileId fileId of the original image * @param int $fileId fileId of the original image
* @return array of paths to bigger thumbnails * @return array an array of paths to bigger thumbnails
*/ */
private function getPossibleThumbnails($fileId) { private function getPossibleThumbnails($fileId) {
@ -750,7 +750,7 @@ class Preview {
} }
/** /**
* @param $fileId * @param int $fileId
* @return string * @return string
*/ */
private function buildCachePath($fileId) { private function buildCachePath($fileId) {

View File

@ -18,7 +18,7 @@ class OC_Request {
/** /**
* @brief Check overwrite condition * @brief Check overwrite condition
* @param string $type * @param string $type
* @returns bool * @return bool
*/ */
private static function isOverwriteCondition($type = '') { private static function isOverwriteCondition($type = '') {
$regex = '/' . OC_Config::getValue('overwritecondaddr', '') . '/'; $regex = '/' . OC_Config::getValue('overwritecondaddr', '') . '/';
@ -49,7 +49,7 @@ class OC_Request {
/** /**
* @brief Returns the unverified server host from the headers without checking * @brief Returns the unverified server host from the headers without checking
* whether it is a trusted domain * whether it is a trusted domain
* @returns string the server host * @return string the server host
* *
* Returns the server host, even if the website uses one or more * Returns the server host, even if the website uses one or more
* reverse proxies * reverse proxies
@ -89,7 +89,7 @@ class OC_Request {
/** /**
* @brief Returns the server host from the headers, or the first configured * @brief Returns the server host from the headers, or the first configured
* trusted domain if the host isn't in the trusted list * trusted domain if the host isn't in the trusted list
* @returns string the server host * @return string the server host
* *
* Returns the server host, even if the website uses one or more * Returns the server host, even if the website uses one or more
* reverse proxies * reverse proxies
@ -121,7 +121,7 @@ class OC_Request {
/** /**
* @brief Returns the server protocol * @brief Returns the server protocol
* @returns string the server protocol * @return string the server protocol
* *
* Returns the server protocol. It respects reverse proxy servers and load balancers * Returns the server protocol. It respects reverse proxy servers and load balancers
*/ */
@ -143,7 +143,7 @@ class OC_Request {
/** /**
* @brief Returns the request uri * @brief Returns the request uri
* @returns string the request uri * @return string the request uri
* *
* Returns the request uri, even if the website uses one or more * Returns the request uri, even if the website uses one or more
* reverse proxies * reverse proxies

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)) {

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) {

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;

View File

@ -25,13 +25,14 @@ 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)
* @throws \Exception
* @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 +143,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 (optional)
*/ */
public static function delete($parent, $excludeParent = false, $uidOwner = null) { public static function delete($parent, $excludeParent = false, $uidOwner = null) {
$ids = array($parent); $ids = array($parent);

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` = ?';

View File

@ -21,11 +21,30 @@
namespace OC\Share; namespace OC\Share;
use DateTime;
class MailNotifications { class MailNotifications {
private $senderId; // sender userId /**
private $from; // sender email address * sender userId
* @var null|string
*/
private $senderId;
/**
* sender email address
* @var string
*/
private $from;
/**
* @var string
*/
private $senderDisplayName; private $senderDisplayName;
/**
* @var \OC_L10N
*/
private $l; private $l;
/** /**
@ -50,8 +69,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) {
@ -136,7 +155,7 @@ class MailNotifications {
* @param string $filename the shared file * @param string $filename the shared file
* @param string $link link to the shared file * @param string $link link to the shared file
* @param int $expiration expiration date (timestamp) * @param int $expiration expiration date (timestamp)
* @return array with the html mail body and the plain text mail body * @return array an array of the html mail body and the plain text mail body
*/ */
private function createMailBody($filename, $link, $expiration) { private function createMailBody($filename, $link, $expiration) {

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;

View File

@ -254,13 +254,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 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 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) {
@ -352,7 +352,7 @@ class Share extends \OC\Share\Constants {
* @param string $itemType * @param string $itemType
* @param string $itemSource * @param string $itemSource
* @param string $uidOwner Owner of link * @param string $uidOwner Owner of link
* @return Item * @return array
*/ */
public static function getItemSharedWithByLink($itemType, $itemSource, $uidOwner) { public static function getItemSharedWithByLink($itemType, $itemSource, $uidOwner) {
return self::getItems($itemType, $itemSource, self::SHARE_TYPE_LINK, null, $uidOwner, self::FORMAT_NONE, return self::getItems($itemType, $itemSource, self::SHARE_TYPE_LINK, null, $uidOwner, self::FORMAT_NONE,
@ -362,7 +362,7 @@ class Share extends \OC\Share\Constants {
/** /**
* Based on the given token the share information will be returned - password protected shares will be verified * Based on the given token the share information will be returned - password protected shares will be verified
* @param string $token * @param string $token
* @return array | boolean false will be returned in case the token is unknown or unauthorized * @return array|boolean false will be returned in case the token is unknown or unauthorized
*/ */
public static function getShareByToken($token, $checkPasswordProtection = true) { public static function getShareByToken($token, $checkPasswordProtection = true) {
$query = \OC_DB::prepare('SELECT * FROM `*PREFIX*share` WHERE `token` = ?', 1); $query = \OC_DB::prepare('SELECT * FROM `*PREFIX*share` WHERE `token` = ?', 1);
@ -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) {
@ -926,6 +926,7 @@ class Share extends \OC\Share\Constants {
/** /**
* Get the backend class for the specified item type * Get the backend class for the specified item type
* @param string $itemType * @param string $itemType
* @throws \Exception
* @return \OCP\Share_Backend * @return \OCP\Share_Backend
*/ */
public static function getBackend($itemType) { public static function getBackend($itemType) {
@ -1000,10 +1001,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)
@ -1353,6 +1354,7 @@ class Share extends \OC\Share\Constants {
* @param boolean|array $parentFolder Parent folder target (optional) * @param boolean|array $parentFolder Parent folder target (optional)
* @param string $token (optional) * @param string $token (optional)
* @param string $itemSourceName name of the source item (optional) * @param string $itemSourceName name of the source item (optional)
* @throws \Exception
* @return boolean Returns true on success or false on failure * @return boolean Returns true on success or false on failure
*/ */
private static function put($itemType, $itemSource, $shareType, $shareWith, $uidOwner, private static function put($itemType, $itemSource, $shareType, $shareWith, $uidOwner,
@ -1641,7 +1643,7 @@ class Share extends \OC\Share\Constants {
} }
/** /**
* @breif construct select statement * @brief construct select statement
* @param int $format * @param int $format
* @param boolean $fileDependent ist it a file/folder share or a generla share * @param boolean $fileDependent ist it a file/folder share or a generla share
* @param string $uidOwner * @param string $uidOwner

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) {

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.

View File

@ -70,8 +70,8 @@ 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
* @returns 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
*/ */

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)) {

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)

View File

@ -35,7 +35,7 @@ class Updater extends BasicEmitter {
/** /**
* Check if a new version is available * Check if a new version is available
* @param string $updaterUrl the url to check, i.e. 'http://apps.owncloud.com/updater.php' * @param string $updaterUrl the url to check, i.e. 'http://apps.owncloud.com/updater.php'
* @return array | bool * @return array|bool
*/ */
public function check($updaterUrl) { public function check($updaterUrl) {

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

View File

@ -77,7 +77,7 @@ class OC_User {
/** /**
* @brief gets available backends * @brief gets available backends
* @deprecated * @deprecated
* @returns array of backends * @return array an array of backends
* *
* Returns the names of all backends. * Returns the names of all backends.
*/ */
@ -88,7 +88,7 @@ class OC_User {
/** /**
* @brief gets used backends * @brief gets used backends
* @deprecated * @deprecated
* @returns array of backends * @return array an array of backends
* *
* Returns the names of all used backends. * Returns the names of all used backends.
*/ */
@ -98,7 +98,7 @@ class OC_User {
/** /**
* @brief Adds the backend to the list of used backends * @brief Adds the backend to the list of used backends
* @param string | OC_User_Backend $backend default: database The backend to use for user management * @param string|OC_User_Interface $backend default: database The backend to use for user management
* @return bool * @return bool
* *
* Set the User Authentication Module * Set the User Authentication Module
@ -321,7 +321,7 @@ class OC_User {
/** /**
* @brief Check if the user is logged in * @brief Check if the user is logged in
* @returns bool * @return bool
* *
* Checks if the user is logged in * Checks if the user is logged in
*/ */
@ -517,7 +517,7 @@ class OC_User {
/** /**
* @brief Get a list of all users * @brief Get a list of all users
* @returns array with all uids * @return array an array of all uids
* *
* Get a list of all users. * Get a list of all users.
* @param string $search * @param string $search

View File

@ -103,7 +103,7 @@ abstract class OC_User_Backend implements OC_User_Interface {
/** /**
* @brief Get a list of all users * @brief Get a list of all users
* @returns array with all uids * @return array an array of all uids
* *
* Get a list of all users. * Get a list of all users.
*/ */
@ -140,7 +140,7 @@ abstract class OC_User_Backend implements OC_User_Interface {
/** /**
* @brief Get a list of all display names * @brief Get a list of all display names
* @returns array with all displayNames (value) and the corresponding uids (key) * @return array an array of all displayNames (value) and the corresponding uids (key)
* *
* Get a list of all display names and user ids. * Get a list of all display names and user ids.
*/ */

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
* @returns 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
* @returns 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
* @returns 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
* @returns 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) {
@ -149,7 +149,7 @@ class OC_User_Database extends OC_User_Backend {
/** /**
* @brief Get a list of all display names * @brief Get a list of all display names
* @returns array with all displayNames (value) and the correspondig uids (key) * @return array an array of all displayNames (value) and the correspondig uids (key)
* *
* Get a list of all display names and user ids. * Get a list of all display names and user ids.
*/ */
@ -169,9 +169,9 @@ 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
* @returns 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
* returns the user id or false * returns the user id or false
@ -203,7 +203,7 @@ class OC_User_Database extends OC_User_Backend {
/** /**
* @brief Load an user in the cache * @brief Load an user in the cache
* @param string $uid the username * @param string $uid the username
* @returns boolean * @return boolean
*/ */
private function loadUser($uid) { private function loadUser($uid) {
if (empty($this->cache[$uid])) { if (empty($this->cache[$uid])) {
@ -226,7 +226,7 @@ class OC_User_Database extends OC_User_Backend {
/** /**
* @brief Get a list of all users * @brief Get a list of all users
* @returns array with all uids * @return array an array of all uids
* *
* Get a list of all users. * Get a list of all users.
*/ */
@ -273,7 +273,7 @@ class OC_User_Database extends OC_User_Backend {
/** /**
* counts the users in the database * counts the users in the database
* *
* @return int | bool * @return int|bool
*/ */
public function countUsers() { public function countUsers() {
$query = OC_DB::prepare('SELECT COUNT(*) FROM `*PREFIX*users`'); $query = OC_DB::prepare('SELECT COUNT(*) FROM `*PREFIX*users`');

View File

@ -127,7 +127,7 @@ class OC_User_Dummy extends OC_User_Backend {
/** /**
* counts the users in the database * counts the users in the database
* *
* @return int | bool * @return int|bool
*/ */
public function countUsers() { public function countUsers() {
return 0; return 0;

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
* @returns 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
* @returns true/false * @return bool
* *
* Change the password of a user * Change the password of a user
*/ */
@ -49,9 +49,9 @@ 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
* @returns 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
* returns the user id or false * returns the user id or false
@ -60,8 +60,8 @@ 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
* @returns string * @return string
* *
* get the user's home directory * get the user's home directory
* returns the path or false * returns the path or false

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,9 +55,9 @@ 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
* @returns 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
* returns the user id or false * returns the user id or false

View File

@ -26,27 +26,23 @@ interface OC_User_Interface {
/** /**
* @brief Check if backend implements actions * @brief Check if backend implements actions
* @param $actions bitwise-or'ed actions * @param $actions bitwise-or'ed actions
* @returns boolean * @return boolean
* *
* 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
* @returns true/false * @return bool
*
* Deletes a user
* @return boolean
*/ */
public function deleteUser($uid); public function deleteUser($uid);
/** /**
* @brief Get a list of all users * @brief Get a list of all users
* @returns array with all uids * @return array an array of all uids
* *
* Get a list of all users. * Get a list of all users.
*/ */
@ -61,14 +57,14 @@ 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);
/** /**
* @brief Get a list of all display names * @brief Get a list of all display names
* @returns array with all displayNames (value) and the corresponding uids (key) * @return array an array of all displayNames (value) and the corresponding uids (key)
* *
* Get a list of all display names and user ids. * Get a list of all display names and user ids.
*/ */

View File

@ -26,7 +26,7 @@ use OC\Hooks\PublicEmitter;
*/ */
class Manager extends PublicEmitter { class Manager extends PublicEmitter {
/** /**
* @var \OC_User_Backend[] $backends * @var \OC_User_Interface[] $backends
*/ */
private $backends = array(); private $backends = array();
@ -57,7 +57,7 @@ class Manager extends PublicEmitter {
/** /**
* register a user backend * register a user backend
* *
* @param \OC_User_Backend $backend * @param \OC_User_Interface $backend
*/ */
public function registerBackend($backend) { public function registerBackend($backend) {
$this->backends[] = $backend; $this->backends[] = $backend;
@ -66,7 +66,7 @@ class Manager extends PublicEmitter {
/** /**
* remove a user backend * remove a user backend
* *
* @param \OC_User_Backend $backend * @param \OC_User_Interface $backend
*/ */
public function removeBackend($backend) { public function removeBackend($backend) {
$this->cachedUsers = array(); $this->cachedUsers = array();
@ -105,7 +105,7 @@ class Manager extends PublicEmitter {
* get or construct the user object * get or construct the user object
* *
* @param string $uid * @param string $uid
* @param \OC_User_Backend $backend * @param \OC_User_Interface $backend
* @return \OC\User\User * @return \OC\User\User
*/ */
protected function getUserObject($uid, $backend) { protected function getUserObject($uid, $backend) {
@ -222,7 +222,7 @@ class Manager extends PublicEmitter {
* @param string $uid * @param string $uid
* @param string $password * @param string $password
* @throws \Exception * @throws \Exception
* @return bool | \OC\User\User the created user of false * @return bool|\OC\User\User the created user of false
*/ */
public function createUser($uid, $password) { public function createUser($uid, $password) {
$l = \OC_L10N::get('lib'); $l = \OC_L10N::get('lib');
@ -261,7 +261,7 @@ class Manager extends PublicEmitter {
/** /**
* returns how many users per backend exist (if supported by backend) * returns how many users per backend exist (if supported by backend)
* *
* @return array with backend class as key and count number as value * @return array an array of backend class as key and count number as value
*/ */
public function countUsers() { public function countUsers() {
$userCountStatistics = array(); $userCountStatistics = array();

View File

@ -82,7 +82,7 @@ class Session implements Emitter, \OCP\IUserSession {
/** /**
* set the currently active user * set the currently active user
* *
* @param \OC\User\User $user * @param \OC\User\User|null $user
*/ */
public function setUser($user) { public function setUser($user) {
if (is_null($user)) { if (is_null($user)) {
@ -115,7 +115,7 @@ class Session implements Emitter, \OCP\IUserSession {
/** /**
* set the login name * set the login name
* *
* @param string $loginName for the logged in user * @param string|null $loginName for the logged in user
*/ */
public function setLoginName($loginName) { public function setLoginName($loginName) {
if (is_null($loginName)) { if (is_null($loginName)) {
@ -191,7 +191,7 @@ class Session implements Emitter, \OCP\IUserSession {
$expires = time() + \OC_Config::getValue('remember_login_cookie_lifetime', 60 * 60 * 24 * 15); $expires = time() + \OC_Config::getValue('remember_login_cookie_lifetime', 60 * 60 * 24 * 15);
setcookie("oc_username", $username, $expires, \OC::$WEBROOT, '', $secure_cookie); setcookie("oc_username", $username, $expires, \OC::$WEBROOT, '', $secure_cookie);
setcookie("oc_token", $token, $expires, \OC::$WEBROOT, '', $secure_cookie, true); setcookie("oc_token", $token, $expires, \OC::$WEBROOT, '', $secure_cookie, true);
setcookie("oc_remember_login", true, $expires, \OC::$WEBROOT, '', $secure_cookie); setcookie("oc_remember_login", "1", $expires, \OC::$WEBROOT, '', $secure_cookie);
} }
/** /**

View File

@ -23,7 +23,7 @@ class User {
private $displayName; private $displayName;
/** /**
* @var \OC_User_Backend $backend * @var \OC_User_Interface $backend
*/ */
private $backend; private $backend;
@ -33,7 +33,7 @@ class User {
private $enabled; private $enabled;
/** /**
* @var Emitter | Manager $emitter * @var Emitter|Manager $emitter
*/ */
private $emitter; private $emitter;
@ -49,7 +49,7 @@ class User {
/** /**
* @param string $uid * @param string $uid
* @param \OC_User_Backend $backend * @param \OC_User_Interface $backend
* @param \OC\Hooks\Emitter $emitter * @param \OC\Hooks\Emitter $emitter
* @param \OC\AllConfig $config * @param \OC\AllConfig $config
*/ */

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 with 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) {
@ -1113,7 +1113,7 @@ class OC_Util {
curl_setopt($curl, CURLOPT_PROXYUSERPWD, OC_Config::getValue('proxyuserpwd')); curl_setopt($curl, CURLOPT_PROXYUSERPWD, OC_Config::getValue('proxyuserpwd'));
} }
if (ini_get('open_basedir') === '' && ini_get('safe_mode' === 'Off')) { if (ini_get('open_basedir') === '' && ini_get('safe_mode') === 'Off') {
curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true); curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true);
curl_setopt($curl, CURLOPT_MAXREDIRS, $max_redirects); curl_setopt($curl, CURLOPT_MAXREDIRS, $max_redirects);
$data = curl_exec($curl); $data = curl_exec($curl);
@ -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) {

View File

@ -25,28 +25,28 @@
*/ */
class OC_VObject{ class OC_VObject{
/** @var Sabre\VObject\Component */ /** @var Sabre\VObject\Component */
protected $vobject; protected $vObject;
/** /**
* @returns Sabre\VObject\Component * @return Sabre\VObject\Component
*/ */
public function getVObject() { public function getVObject() {
return $this->vobject; return $this->vObject;
} }
/** /**
* @brief Parses the VObject * @brief Parses the VObject
* @param string $data VObject as string * @param string $data VObject as string
* @returns Sabre\VObject\Reader|null * @return Sabre\VObject\Reader|null
*/ */
public static function parse($data) { public static function parse($data) {
try { try {
Sabre\VObject\Property::$classMap['LAST-MODIFIED'] = 'Sabre\VObject\Property\DateTime'; Sabre\VObject\Property::$classMap['LAST-MODIFIED'] = 'Sabre\VObject\Property\DateTime';
$vobject = Sabre\VObject\Reader::read($data); $vObject = Sabre\VObject\Reader::read($data);
if ($vobject instanceof Sabre\VObject\Component) { if ($vObject instanceof Sabre\VObject\Component) {
$vobject = new OC_VObject($vobject); $vObject = new OC_VObject($vObject);
} }
return $vobject; return $vObject;
} catch (Exception $e) { } catch (Exception $e) {
OC_Log::write('vobject', $e->getMessage(), OC_Log::ERROR); OC_Log::write('vobject', $e->getMessage(), OC_Log::ERROR);
return null; return null;
@ -89,26 +89,26 @@ 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)) {
$this->vobject = $vobject_or_name; $this->vObject = $vobject_or_name;
} else { } else {
$this->vobject = new Sabre\VObject\Component($vobject_or_name); $this->vObject = new Sabre\VObject\Component($vobject_or_name);
} }
} }
/** /**
* @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) {
if ($item instanceof OC_VObject) { if ($item instanceof OC_VObject) {
$item = $item->getVObject(); $item = $item->getVObject();
} }
$this->vobject->add($item, $itemValue); $this->vObject->add($item, $itemValue);
} }
/** /**
@ -116,7 +116,7 @@ class OC_VObject{
* @param object $name of property * @param object $name of property
* @param object $value of property * @param object $value of property
* @param array|object $parameters of property * @param array|object $parameters of property
* @returns Sabre\VObject\Property newly created * @return Sabre\VObject\Property newly created
*/ */
public function addProperty($name, $value, $parameters=array()) { public function addProperty($name, $value, $parameters=array()) {
if(is_array($value)) { if(is_array($value)) {
@ -127,26 +127,26 @@ class OC_VObject{
$property->parameters[] = new Sabre\VObject\Parameter($name, $value); $property->parameters[] = new Sabre\VObject\Parameter($name, $value);
} }
$this->vobject->add($property); $this->vObject->add($property);
return $property; return $property;
} }
public function setUID() { public function setUID() {
$uid = substr(md5(rand().time()), 0, 10); $uid = substr(md5(rand().time()), 0, 10);
$this->vobject->add('UID', $uid); $this->vObject->add('UID', $uid);
} }
/** /**
* @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) {
if ($string != '') { if ($string != '') {
$string = strtr($string, array("\r\n"=>"\n")); $string = strtr($string, array("\r\n"=>"\n"));
$this->vobject->__set($name, $string); $this->vObject->__set($name, $string);
}else{ }else{
$this->vobject->__unset($name); $this->vObject->__unset($name);
} }
} }
@ -167,31 +167,31 @@ class OC_VObject{
if ($datetime instanceof DateTime) { if ($datetime instanceof DateTime) {
$datetime_element = new Sabre\VObject\Property\DateTime($name); $datetime_element = new Sabre\VObject\Property\DateTime($name);
$datetime_element->setDateTime($datetime, $dateType); $datetime_element->setDateTime($datetime, $dateType);
$this->vobject->__set($name, $datetime_element); $this->vObject->__set($name, $datetime_element);
}else{ }else{
$this->vobject->__unset($name); $this->vObject->__unset($name);
} }
} }
/** /**
* @todo Write documentation * @todo Write documentation
* @param $name * @param string $name
* @return string * @return string
*/ */
public function getAsString($name) { public function getAsString($name) {
return $this->vobject->__isset($name) ? return $this->vObject->__isset($name) ?
$this->vobject->__get($name)->value : $this->vObject->__get($name)->value :
''; '';
} }
/** /**
* @todo Write documentation * @todo Write documentation
* @param $name * @param string $name
* @return array * @return array
*/ */
public function getAsArray($name) { public function getAsArray($name) {
$values = array(); $values = array();
if ($this->vobject->__isset($name)) { if ($this->vObject->__isset($name)) {
$values = explode(',', $this->getAsString($name)); $values = explode(',', $this->getAsString($name));
$values = array_map('trim', $values); $values = array_map('trim', $values);
} }
@ -200,14 +200,14 @@ 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) {
if ($name == 'children') { if ($name == 'children') {
return $this->vobject->children; return $this->vObject->children;
} }
$return = $this->vobject->__get($name); $return = $this->vObject->__get($name);
if ($return instanceof Sabre\VObject\Component) { if ($return instanceof Sabre\VObject\Component) {
$return = new OC_VObject($return); $return = new OC_VObject($return);
} }
@ -220,7 +220,7 @@ class OC_VObject{
* @param string $value * @param string $value
*/ */
public function __set($name, $value) { public function __set($name, $value) {
return $this->vobject->__set($name, $value); return $this->vObject->__set($name, $value);
} }
/** /**
@ -228,7 +228,7 @@ class OC_VObject{
* @param string $name * @param string $name
*/ */
public function __unset($name) { public function __unset($name) {
return $this->vobject->__unset($name); return $this->vObject->__unset($name);
} }
/** /**
@ -237,16 +237,16 @@ class OC_VObject{
* @return bool * @return bool
*/ */
public function __isset($name) { public function __isset($name) {
return $this->vobject->__isset($name); return $this->vObject->__isset($name);
} }
/** /**
* @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) {
return call_user_func_array(array($this->vobject, $function), $arguments); return call_user_func_array(array($this->vObject, $function), $arguments);
} }
} }

Some files were not shown because too many files have changed in this diff Show More