}
/**
- * @brief test rename of file/folder
+ * test rename of file/folder
*/
function testRenameFolder() {
$dir = '/';
* This file is licensed under the Affero General Public License version 3 or later.
* See the COPYING-README file.
*
- * @brief Script to handle admin settings for encrypted key recovery
+ * Script to handle admin settings for encrypted key recovery
*/
use OCA\Encryption;
* This file is licensed under the Affero General Public License version 3 or later.
* See the COPYING-README file.
*
- * @brief Script to change recovery key password
+ * Script to change recovery key password
*
*/
* This file is licensed under the Affero General Public License version 3 or later.
* See the COPYING-README file.
*
- * @brief check migration status
+ * check migration status
*/
use OCA\Encryption\Util;
* This file is licensed under the Affero General Public License version 3 or later.
* See the COPYING-README file.
*
- * @brief Script to change recovery key password
+ * Script to change recovery key password
*
*/
* This file is licensed under the Affero General Public License version 3 or later.
* See the COPYING-README file.
*
- * @brief Script to handle admin settings for encrypted key recovery
+ * Script to handle admin settings for encrypted key recovery
*/
use OCA\Encryption;
private static $deleteFiles = array();\r
\r
/**\r
- * @brief Startup encryption backend upon user login\r
+ * Startup encryption backend upon user login\r
* @note This method should never be called for users using client side encryption\r
*/\r
public static function login($params) {\r
}\r
\r
/**\r
- * @brief setup encryption backend upon user created\r
+ * setup encryption backend upon user created\r
* @note This method should never be called for users using client side encryption\r
*/\r
public static function postCreateUser($params) {\r
}\r
\r
/**\r
- * @brief cleanup encryption backend upon user deleted\r
+ * cleanup encryption backend upon user deleted\r
* @note This method should never be called for users using client side encryption\r
*/\r
public static function postDeleteUser($params) {\r
}\r
\r
/**\r
- * @brief If the password can't be changed within ownCloud, than update the key password in advance.\r
+ * If the password can't be changed within ownCloud, than update the key password in advance.\r
*/\r
public static function preSetPassphrase($params) {\r
if (\OCP\App::isEnabled('files_encryption')) {\r
}\r
\r
/**\r
- * @brief Change a user's encryption passphrase\r
+ * Change a user's encryption passphrase\r
* @param array $params keys: uid, password\r
*/\r
public static function setPassphrase($params) {\r
}\r
\r
/*\r
- * @brief check if files can be encrypted to every user.\r
+ * check if files can be encrypted to every user.\r
*/\r
/**\r
* @param array $params\r
}\r
\r
/**\r
- * @brief mark file as renamed so that we know the original source after the file was renamed\r
+ * mark file as renamed so that we know the original source after the file was renamed\r
* @param array $params with the old path and the new path\r
*/\r
public static function preRename($params) {\r
}\r
\r
/**\r
- * @brief after a file is renamed, rename its keyfile and share-keys also fix the file size and fix also the sharing\r
+ * after a file is renamed, rename its keyfile and share-keys also fix the file size and fix also the sharing\r
* @param array $params array with oldpath and newpath\r
*\r
* This function is connected to the rename signal of OC_Filesystem and adjust the name and location\r
}\r
\r
/**\r
- * @brief if the file was really deleted we remove the encryption keys\r
+ * if the file was really deleted we remove the encryption keys\r
* @param array $params\r
* @return boolean|null\r
*/\r
}\r
\r
/**\r
- * @brief remember the file which should be deleted and it's owner\r
+ * remember the file which should be deleted and it's owner\r
* @param array $params\r
* @return boolean|null\r
*/\r
\r
\r
/**\r
- * @brief return encryption mode client or server side encryption\r
+ * return encryption mode client or server side encryption\r
* @param string $user name (use system wide setting if name=null)\r
* @return string 'client' or 'server'\r
*/\r
}\r
\r
/**\r
- * @brief Create a new encryption keypair\r
+ * Create a new encryption keypair\r
* @return array publicKey, privatekey\r
*/\r
public static function createKeypair() {\r
}\r
\r
/**\r
- * @brief Add arbitrary padding to encrypted data\r
+ * Add arbitrary padding to encrypted data\r
* @param string $data data to be padded\r
* @return string padded data\r
* @note In order to end up with data exactly 8192 bytes long we must\r
}\r
\r
/**\r
- * @brief Remove arbitrary padding to encrypted data\r
+ * Remove arbitrary padding to encrypted data\r
* @param string $padded padded data to remove padding from\r
* @return string unpadded data on success, false on error\r
*/\r
}\r
\r
/**\r
- * @brief Check if a file's contents contains an IV and is symmetrically encrypted\r
+ * Check if a file's contents contains an IV and is symmetrically encrypted\r
* @param string $content\r
* @return boolean\r
* @note see also OCA\Encryption\Util->isEncryptedPath()\r
}\r
\r
/**\r
- * @brief Check if a file is encrypted via legacy system\r
+ * Check if a file is encrypted via legacy system\r
* @param boolean $isCatFileContent\r
* @param string $relPath The path of the file, relative to user/data;\r
* e.g. filename or /Docs/filename, NOT admin/files/filename\r
}\r
\r
/**\r
- * @brief Symmetrically encrypt a string\r
+ * Symmetrically encrypt a string\r
* @param string $plainContent\r
* @param string $iv\r
* @param string $passphrase\r
}\r
\r
/**\r
- * @brief Symmetrically decrypt a string\r
+ * Symmetrically decrypt a string\r
* @param string $encryptedContent\r
* @param string $iv\r
* @param string $passphrase\r
}\r
\r
/**\r
- * @brief Concatenate encrypted data with its IV and padding\r
+ * Concatenate encrypted data with its IV and padding\r
* @param string $content content to be concatenated\r
* @param string $iv IV to be concatenated\r
* @return string concatenated content\r
}\r
\r
/**\r
- * @brief Split concatenated data and IV into respective parts\r
+ * Split concatenated data and IV into respective parts\r
* @param string $catFile concatenated data to be split\r
* @return array keys: encrypted, iv\r
*/\r
}\r
\r
/**\r
- * @brief Symmetrically encrypts a string and returns keyfile content\r
+ * Symmetrically encrypts a string and returns keyfile content\r
* @param string $plainContent content to be encrypted in keyfile\r
* @param string $passphrase\r
* @return false|string encrypted content combined with IV\r
\r
\r
/**\r
- * @brief Symmetrically decrypts keyfile content\r
+ * Symmetrically decrypts keyfile content\r
* @param string $keyfileContent\r
* @param string $passphrase\r
* @throws \Exception\r
}\r
\r
/**\r
- * @brief Decrypt private key and check if the result is a valid keyfile\r
+ * Decrypt private key and check if the result is a valid keyfile\r
* @param string $encryptedKey encrypted keyfile\r
* @param string $passphrase to decrypt keyfile\r
* @return string|false encrypted private key or false\r
}\r
\r
/**\r
- * @brief Create asymmetrically encrypted keyfile content using a generated key\r
+ * Create asymmetrically encrypted keyfile content using a generated key\r
* @param string $plainContent content to be encrypted\r
* @param array $publicKeys array keys must be the userId of corresponding user\r
* @return array keys: keys (array, key = userId), data\r
}\r
\r
/**\r
- * @brief Asymmetrically encrypt a file using multiple public keys\r
+ * Asymmetrically encrypt a file using multiple public keys\r
* @param string $encryptedContent\r
* @param string $shareKey\r
* @param mixed $privateKey\r
}\r
\r
/**\r
- * @brief Generates a pseudo random initialisation vector\r
+ * Generates a pseudo random initialisation vector\r
* @return String $iv generated IV\r
*/\r
private static function generateIv() {\r
}\r
\r
/**\r
- * @brief Generate a pseudo random 256-bit ASCII key, used as file key\r
+ * Generate a pseudo random 256-bit ASCII key, used as file key\r
* @return string|false Generated key\r
*/\r
public static function generateKey() {\r
}\r
\r
/**\r
- * @brief Get the blowfish encryption handler for a key\r
+ * Get the blowfish encryption handler for a key\r
* @param string $key (optional)\r
* @return \Crypt_Blowfish blowfish object\r
*\r
}\r
\r
/**\r
- * @brief decrypts content using legacy blowfish system\r
+ * decrypts content using legacy blowfish system\r
* @param string $content the cleartext message you want to decrypt\r
* @param string $passphrase\r
* @return string cleartext content\r
namespace OCA\Encryption;
/**
- * @brief Class to manage registration of hooks an various helper methods
+ * Class to manage registration of hooks an various helper methods
* @package OCA\Encryption
*/
class Helper {
private static $tmpFileMapping; // Map tmp files to files in data/user/files
/**
- * @brief register share related hooks
+ * register share related hooks
*
*/
public static function registerShareHooks() {
}
/**
- * @brief register user related hooks
+ * register user related hooks
*
*/
public static function registerUserHooks() {
}
/**
- * @brief register filesystem related hooks
+ * register filesystem related hooks
*
*/
public static function registerFilesystemHooks() {
}
/**
- * @brief register app management related hooks
+ * register app management related hooks
*
*/
public static function registerAppHooks() {
}
/**
- * @brief setup user for files_encryption
+ * setup user for files_encryption
*
* @param Util $util
* @param string $password
}
/**
- * @brief enable recovery
+ * enable recovery
*
* @param string $recoveryKeyId
* @param string $recoveryPassword
}
/**
- * @brief Check if a path is a .part file
+ * Check if a path is a .part file
* @param string $path Path that may identify a .part file
* @return bool
*/
/**
- * @brief Remove .path extension from a file path
+ * Remove .path extension from a file path
* @param string $path Path that may identify a .part file
* @return string File path without .part extension
* @note this is needed for reusing keys
}
/**
- * @brief disable recovery
+ * disable recovery
*
* @param string $recoveryPassword
* @return bool
/**
- * @brief checks if access is public/anonymous user
+ * checks if access is public/anonymous user
* @return bool
*/
public static function isPublicAccess() {
}
/**
- * @brief Format a path to be relative to the /user/files/ directory
+ * Format a path to be relative to the /user/files/ directory
* @param string $path the absolute path
* @return string e.g. turns '/admin/files/test.txt' into 'test.txt'
*/
}
/**
- * @brief try to get the user from the path if no user is logged in
+ * try to get the user from the path if no user is logged in
* @param string $path
* @return mixed user or false if we couldn't determine a user
*/
}
/**
- * @brief get path to the corresponding file in data/user/files if path points
+ * get path to the corresponding file in data/user/files if path points
* to a version or to a file in cache
* @param string $path path to a version or a file in the trash
* @return string path to corresponding file relative to data/user/files
}
/**
- * @brief create directory recursively
+ * create directory recursively
* @param string $path
* @param \OC\Files\View $view
*/
}
/**
- * @brief redirect to a error page
+ * redirect to a error page
* @param Session $session
*/
public static function redirectToErrorPage($session, $errorCode = null) {
}
/**
- * @brief glob uses different pattern than regular expressions, escape glob pattern only
+ * glob uses different pattern than regular expressions, escape glob pattern only
* @param string $path unescaped path
* @return string path
*/
}
/**
- * @brief remember from which file the tmp file (getLocalFile() call) was created
+ * remember from which file the tmp file (getLocalFile() call) was created
* @param string $tmpFile path of tmp file
* @param string $originalFile path of the original file relative to data/
*/
}
/**
- * @brief get the path of the original file
+ * get the path of the original file
* @param string $tmpFile path of the tmp file
* @return string|false path of the original file or false
*/
namespace OCA\Encryption;
/**
- * @brief Class to manage storage and retrieval of encryption keys
+ * Class to manage storage and retrieval of encryption keys
* @note Where a method requires a view object, it's root must be '/'
*/
class Keymanager {
/**
- * @brief retrieve the ENCRYPTED private key from a user
+ * retrieve the ENCRYPTED private key from a user
*
* @param \OC\Files\View $view
* @param string $user
}
/**
- * @brief retrieve public key for a specified user
+ * retrieve public key for a specified user
* @param \OC\Files\View $view
* @param string $userId
* @return string public key or false
}
/**
- * @brief Retrieve a user's public and private key
+ * Retrieve a user's public and private key
* @param \OC\Files\View $view
* @param string $userId
* @return array keys: privateKey, publicKey
}
/**
- * @brief Retrieve public keys for given users
+ * Retrieve public keys for given users
* @param \OC\Files\View $view
* @param array $userIds
* @return array of public keys for the specified users
}
/**
- * @brief store file encryption key
+ * store file encryption key
*
* @param \OC\Files\View $view
* @param \OCA\Encryption\Util $util
}
/**
- * @brief retrieve keyfile for an encrypted file
+ * retrieve keyfile for an encrypted file
* @param \OC\Files\View $view
* @param \OCA\Encryption\Util $util
* @param string|false $filePath
}
/**
- * @brief Delete a keyfile
+ * Delete a keyfile
*
* @param \OC\Files\View $view
* @param string $path path of the file the key belongs to
}
/**
- * @brief store private key from the user
+ * store private key from the user
* @param string $key
* @return bool
* @note Encryption of the private key must be performed by client code
}
/**
- * @brief store share key
+ * store share key
*
* @param \OC\Files\View $view
* @param string $path where the share key is stored
}
/**
- * @brief store multiple share keys for a single file
+ * store multiple share keys for a single file
* @param \OC\Files\View $view
* @param \OCA\Encryption\Util $util
* @param string $path
}
/**
- * @brief retrieve shareKey for an encrypted file
+ * retrieve shareKey for an encrypted file
* @param \OC\Files\View $view
* @param string $userId
* @param \OCA\Encryption\Util $util
}
/**
- * @brief delete all share keys of a given file
+ * delete all share keys of a given file
* @param \OC\Files\View $view
* @param string $userId owner of the file
* @param string $filePath path to the file, relative to the owners file dir
}
/**
- * @brief Delete a single user's shareKey for a single file
+ * Delete a single user's shareKey for a single file
*/
public static function delShareKey(\OC\Files\View $view, $userIds, $filePath) {
}
/**
- * @brief recursively delete share keys from given users
+ * recursively delete share keys from given users
*
* @param string $dir directory
* @param array $userIds user ids for which the share keys should be deleted
}
/**
- * @brief Make preparations to vars and filesystem for saving a keyfile
+ * Make preparations to vars and filesystem for saving a keyfile
* @param string|boolean $path
* @param string $basePath
*/
}
/**
- * @brief extract filename from share key name
+ * extract filename from share key name
* @param string $shareKey (filename.userid.sharekey)
* @return string|false filename or false
*/
*/
/**
- * @brief Encryption proxy which handles filesystem operations before and after
+ * Encryption proxy which handles filesystem operations before and after
* execution and encrypts, and handles keyfiles accordingly. Used for
* webui.
*/
}
/**
- * @brief update file cache with the new unencrypted size after file was written
+ * update file cache with the new unencrypted size after file was written
* @param string $path
* @param mixed $result
* @return mixed
}
/**
- * @brief remember initial fopen mode because sometimes it gets changed during the request
+ * remember initial fopen mode because sometimes it gets changed during the request
* @param string $path path
* @param string $mode type of access
*/
/**
- * @brief if session is started, check if ownCloud key pair is set up, if not create it
+ * if session is started, check if ownCloud key pair is set up, if not create it
* @param \OC\Files\View $view
*
* @note The ownCloud key pair is used to allow public link sharing even if encryption is enabled
}
/**
- * @brief Sets user private key to session
+ * Sets user private key to session
* @param string $privateKey
* @return bool
*
}
/**
- * @brief Sets status of encryption app
+ * Sets status of encryption app
* @param string $init INIT_SUCCESSFUL, INIT_EXECUTED, NOT_INITIALIZED
* @return bool
*
}
/**
- * @brief remove encryption keys and init status from session
+ * remove encryption keys and init status from session
*/
public function closeSession() {
\OC::$session->remove('encryptionInitialized');
/**
- * @brief Gets status if we already tried to initialize the encryption app
+ * Gets status if we already tried to initialize the encryption app
* @return string init status INIT_SUCCESSFUL, INIT_EXECUTED, NOT_INITIALIZED
*
* @note this doesn not indicate of the init was successful, we just remeber the try!
}
/**
- * @brief Gets user or public share private key from session
+ * Gets user or public share private key from session
* @return string $privateKey The user's plaintext private key
*
*/
}
/**
- * @brief Sets public user private key to session
+ * Sets public user private key to session
* @param string $privateKey
* @return bool
*/
}
/**
- * @brief Gets public share private key from session
+ * Gets public share private key from session
* @return string $privateKey
*
*/
/**
- * @brief Sets user legacy key to session
+ * Sets user legacy key to session
* @param string $legacyKey
* @return bool
*/
}
/**
- * @brief Gets user legacy key from session
+ * Gets user legacy key from session
* @return string $legacyKey The user's plaintext legacy key
*
*/
namespace OCA\Encryption;
/**
- * @brief Provides 'crypt://' stream wrapper protocol.
+ * Provides 'crypt://' stream wrapper protocol.
* @note We use a stream wrapper because it is the most secure way to handle
* decrypted content transfers. There is no safe way to decrypt the entire file
* somewhere on the server, so we have to encrypt and decrypt blocks on the fly.
}
/**
- * @brief Returns the current position of the file pointer
+ * Returns the current position of the file pointer
* @return int position of the file pointer
*/
public function stream_tell() {
}
/**
- * @brief Encrypt and pad data ready for writing to disk
+ * Encrypt and pad data ready for writing to disk
* @param string $plainData data to be encrypted
* @param string $key key to use for encryption
* @return string encrypted data on success, false on failure
}
/**
- * @brief Fetch the plain encryption key for the file and set it as plainKey property
+ * Fetch the plain encryption key for the file and set it as plainKey property
* @internal param bool $generate if true, a new key will be generated if none can be found
* @return bool true on key found and set, false on key not found and new key generated and set
*/
}
/**
- * @brief Handle plain data from the stream, and write it in 8192 byte blocks
+ * Handle plain data from the stream, and write it in 8192 byte blocks
* @param string $data data to be written to disk
* @note the data will be written to the path stored in the stream handle, set in stream_open()
* @note $data is only ever be a maximum of 8192 bytes long. This is set by PHP internally. stream_write() is called multiple times in a loop on data larger than 8192 bytes
namespace OCA\Encryption;
/**
- * @brief Class for utilities relating to encrypted file storage system
+ * Class for utilities relating to encrypted file storage system
* @param \OC\Files\View $view expected to have OC '/' as root path
* @param string $userId ID of the logged in user
* @param int $client indicating status of client side encryption. Currently
}
/**
- * @brief check if the users private & public key exists
+ * check if the users private & public key exists
* @return boolean
*/
public function userKeysExists() {
}
/**
- * @brief Sets up user folders and keys for serverside encryption
+ * Sets up user folders and keys for serverside encryption
*
* @param string $passphrase to encrypt server-stored private key with
* @return bool
}
/**
- * @brief Check whether pwd recovery is enabled for a given user
+ * Check whether pwd recovery is enabled for a given user
* @return bool 1 = yes, 0 = no, false = no record
*
* @note If records are not being returned, check for a hidden space
}
/**
- * @brief Enable / disable pwd recovery for a given user
+ * Enable / disable pwd recovery for a given user
* @param bool $enabled Whether to enable or disable recovery
* @return bool
*/
}
/**
- * @brief Find all files and their encryption status within a directory
+ * Find all files and their encryption status within a directory
* @param string $directory The path of the parent directory to search
* @param bool $found the founded files if called again
* @return mixed false if 0 found, array on success. Keys: name, path
}
/**
- * @brief Check if a given path identifies an encrypted file
+ * Check if a given path identifies an encrypted file
* @param string $path
* @return boolean
*/
}
/**
- * @brief get the file size of the unencrypted file
+ * get the file size of the unencrypted file
* @param string $path absolute path
* @return bool
*/
}
/**
- * @brief fix the file size of the encrypted file
+ * fix the file size of the encrypted file
* @param string $path absolute path
* @return boolean true / false if file is encrypted
*/
}
/**
- * @brief encrypt versions from given file
+ * encrypt versions from given file
* @param array $filelist list of encrypted files, relative to data/user/files
* @return boolean
*/
}
/**
- * @brief decrypt versions from given file
+ * decrypt versions from given file
* @param string $filelist list of decrypted files, relative to data/user/files
* @return boolean
*/
}
/**
- * @brief Decrypt all files
+ * Decrypt all files
* @return bool
*/
public function decryptAll() {
}
/**
- * @brief Encrypt all files in a directory
+ * Encrypt all files in a directory
* @param string $dirPath the directory whose files will be encrypted
* @param null $legacyPassphrase
* @param null $newPassphrase
}
/**
- * @brief Return important encryption related paths
+ * Return important encryption related paths
* @param string $pathName Name of the directory to return the path of
* @return string path
*/
}
/**
- * @brief Filter an array of UIDs to return only ones ready for sharing
+ * Filter an array of UIDs to return only ones ready for sharing
* @param array $unfilteredUsers users to be checked for sharing readiness
* @return array as multi-dimensional array. keys: ready, unready
*/
}
/**
- * @brief Decrypt a keyfile
+ * Decrypt a keyfile
* @param string $filePath
* @param string $privateKey
* @return false|string
}
/**
- * @brief Encrypt keyfile to multiple users
+ * Encrypt keyfile to multiple users
* @param Session $session
* @param array $users list of users which should be able to access the file
* @param string $filePath path of the file to be shared
}
/**
- * @brief Find, sanitise and format users sharing a file
+ * Find, sanitise and format users sharing a file
* @note This wraps other methods into a portable bundle
* @param boolean $sharingEnabled
* @param string $filePath path relativ to current users files folder
}
/**
- * @brief set migration status
+ * set migration status
* @param int $status
* @return boolean
*/
}
/**
- * @brief start migration mode to initially encrypt users data
+ * start migration mode to initially encrypt users data
* @return boolean
*/
public function beginMigration() {
}
/**
- * @brief close migration mode after users data has been encrypted successfully
+ * close migration mode after users data has been encrypted successfully
* @return boolean
*/
public function finishMigration() {
}
/**
- * @brief check if files are already migrated to the encryption system
+ * check if files are already migrated to the encryption system
* @return int|false migration status, false = in case of no record
* @note If records are not being returned, check for a hidden space
* at the start of the uid in db
}
/**
- * @brief get uid of the owners of the file and the path to the file
+ * get uid of the owners of the file and the path to the file
* @param string $path Path of the file to check
* @throws \Exception
* @note $shareFilePath must be relative to data/UID/files. Files
}
/**
- * @brief go recursively through a dir and collect all files and sub files.
+ * go recursively through a dir and collect all files and sub files.
* @param string $dir relative to the users files folder
* @return array with list of files relative to the users files folder
*/
}
/**
- * @brief get owner of the shared files.
+ * get owner of the shared files.
* @param int $id ID of a share
* @return string owner
*/
}
/**
- * @brief add recovery key to all encrypted files
+ * add recovery key to all encrypted files
*/
public function addRecoveryKeys($path = '/') {
$dirContent = $this->view->getDirectoryContent($this->keyfilesPath . $path);
}
/**
- * @brief remove recovery key to all encrypted files
+ * remove recovery key to all encrypted files
*/
public function removeRecoveryKeys($path = '/') {
$dirContent = $this->view->getDirectoryContent($this->keyfilesPath . $path);
}
/**
- * @brief decrypt given file with recovery key and encrypt it again to the owner and his new key
+ * decrypt given file with recovery key and encrypt it again to the owner and his new key
* @param string $file
* @param string $privateKey recovery key to decrypt the file
*/
}
/**
- * @brief collect all files and recover them one by one
+ * collect all files and recover them one by one
* @param string $path to look for files keys
* @param string $privateKey private recovery key which is used to decrypt the files
*/
}
/**
- * @brief recover users files in case of password lost
+ * recover users files in case of password lost
* @param string $recoveryPassword
*/
public function recoverUsersFiles($recoveryPassword) {
}
/**
- * @brief check if the file is stored on a system wide mount point
+ * check if the file is stored on a system wide mount point
* @param string $path relative to /data/user with leading '/'
* @return boolean
*/
}
/**
- * @brief decrypt private key and add it to the current session
+ * decrypt private key and add it to the current session
* @param array $params with 'uid' and 'password'
* @return mixed session or false
*/
}
/*
- * @brief remove encryption related keys from the session
+ * remove encryption related keys from the session
*/
public function closeEncryptionSession() {
$session = new \OCA\Encryption\Session($this->view);
/**
* @medium
- * @brief Test that data that is written by the crypto stream wrapper
+ * Test that data that is written by the crypto stream wrapper
* @note Encrypted data is manually prepared and decrypted here to avoid dependency on success of stream_read
* @note If this test fails with truncate content, check that enough array slices are being rejoined to form $e, as the crypt.php file may have gotten longer and broken the manual
* reassembly of its data
/**
* @medium
- * @brief Test that data that is read by the crypto stream wrapper
+ * Test that data that is read by the crypto stream wrapper
*/
function testSymmetricStreamDecryptShortFileContent() {
/**
* @medium
- * @brief test decryption using legacy blowfish method
+ * test decryption using legacy blowfish method
*/
function testLegacyDecryptShort() {
/**
* @medium
- * @brief test decryption using legacy blowfish method
+ * test decryption using legacy blowfish method
*/
function testLegacyDecryptLong() {
/**
- * @brief encryption using legacy blowfish method
+ * encryption using legacy blowfish method
* @param string $data data to encrypt
* @param string $passwd password
* @return string
/**
* Class Test_Encryption_Hooks
- * @brief this class provide basic hook app tests
+ * this class provide basic hook app tests
*/
class Test_Encryption_Hooks extends \PHPUnit_Framework_TestCase {
}
/**
- * @brief test rename operation
+ * test rename operation
*/
function testRenameHook() {
/**
* Class Test_Encryption_Proxy
- * @brief this class provide basic proxy app tests
+ * this class provide basic proxy app tests
*/
class Test_Encryption_Proxy extends \PHPUnit_Framework_TestCase {
/**
* @medium
- * @brief test if postFileSize returns the unencrypted file size
+ * test if postFileSize returns the unencrypted file size
*/
function testPostFileSize() {
/**
- * @brief test moving a shared file out of the Shared folder
+ * test moving a shared file out of the Shared folder
*/
function testRename() {
/**
* Class Test_Encryption_Stream
- * @brief this class provide basic stream tests
+ * this class provide basic stream tests
*/
class Test_Encryption_Stream extends \PHPUnit_Framework_TestCase {
/**
* @medium
- * @brief test if stream wrapper can read files outside from the data folder
+ * test if stream wrapper can read files outside from the data folder
*/
function testStreamFromLocalFile() {
/**
* Class Test_Encryption_Trashbin
- * @brief this class provide basic trashbin app tests
+ * this class provide basic trashbin app tests
*/
class Test_Encryption_Trashbin extends \PHPUnit_Framework_TestCase {
/**
* @medium
- * @brief test delete file
+ * test delete file
*/
function testDeleteFile() {
/**
* @medium
- * @brief test restore file
+ * test restore file
*
* @depends testDeleteFile
*/
/**
* @medium
- * @brief test delete file forever
+ * test delete file forever
*/
function testPermanentDeleteFile() {
/**
* @medium
- * @brief test that paths set during User construction are correct
+ * test that paths set during User construction are correct
*/
function testKeyPaths() {
$util = new Encryption\Util($this->view, $this->userId);
/**
* @medium
- * @brief test detection of encrypted files
+ * test detection of encrypted files
*/
function testIsEncryptedPath() {
/**
* @medium
- * @brief test setup of encryption directories
+ * test setup of encryption directories
*/
function testSetupServerSide() {
$this->assertEquals(true, $this->util->setupServerSide($this->pass));
/**
* @medium
- * @brief test checking whether account is ready for encryption,
+ * test checking whether account is ready for encryption,
*/
function testUserIsReady() {
$this->assertEquals(true, $this->util->ready());
}
/**
- * @brief test checking whether account is not ready for encryption,
+ * test checking whether account is not ready for encryption,
*/
// function testUserIsNotReady() {
// $this->view->unlink($this->publicKeyDir);
/**
* @medium
- * @brief test checking whether account is not ready for encryption,
+ * test checking whether account is not ready for encryption,
*/
function testIsLegacyUser() {
\Test_Encryption_Util::loginHelper(\Test_Encryption_Util::TEST_ENCRYPTION_UTIL_LEGACY_USER);
}
/**
-< * @brief Test that data that is read by the crypto stream wrapper
+< * Test that data that is read by the crypto stream wrapper
*/
function testGetFileSize() {
\Test_Encryption_Util::loginHelper(\Test_Encryption_Util::TEST_ENCRYPTION_UTIL_USER1);
/**
* Class Test_Encryption_Webdav
*
- * @brief this class provide basic webdav tests for PUT,GET and DELETE
+ * this class provide basic webdav tests for PUT,GET and DELETE
*/
class Test_Encryption_Webdav extends \PHPUnit_Framework_TestCase {
}
/**
- * @brief test webdav put random file
+ * test webdav put random file
*/
function testWebdavPUT() {
}
/**
- * @brief test webdav get random file
+ * test webdav get random file
*
* @depends testWebdavPUT
*/
}
/**
- * @brief test webdav delete random file
+ * test webdav delete random file
* @depends testWebdavGET
*/
function testWebdavDELETE($filename) {
}
/**
- * @brief handle webdav request
+ * handle webdav request
*
* @param bool $body
*
}
/**
- * @brief Returns the path's metadata
+ * Returns the path's metadata
* @param string $path path for which to return the metadata
* @param bool $list if true, also return the directory's contents
* @return mixed directory contents if $list is true, file metadata if $list is
class Api {
/**
- * @brief get all shares
+ * get all shares
*
* @param array $params option 'file' to limit the result to a specific file/folder
* @return \OC_OCS_Result share information
}
/**
- * @brief get share information for a given share
+ * get share information for a given share
*
* @param array $params which contains a 'id'
* @return \OC_OCS_Result share information
}
/**
- * @brief collect all share information, either of a specific share or all
+ * collect all share information, either of a specific share or all
* shares for a given path
* @param array $params
* @return \OC_OCS_Result
}
/**
- * @brief add reshares to a array of shares
+ * add reshares to a array of shares
* @param array $shares array of shares
* @param int $itemSource item source ID
* @return array new shares array which includes reshares
}
/**
- * @brief get share from all files in a given folder (non-recursive)
+ * get share from all files in a given folder (non-recursive)
* @param array $params contains 'path' to the folder
* @return \OC_OCS_Result
*/
}
/**
- * @brief create a new share
+ * create a new share
* @param array $params
* @return \OC_OCS_Result
*/
}
/**
- * @brief update permissions for a share
+ * update permissions for a share
* @param array $share information about the share
* @param array $params contains 'permissions'
* @return \OC_OCS_Result
}
/**
- * @brief enable/disable public upload
+ * enable/disable public upload
* @param array $share information about the share
* @param array $params contains 'publicUpload' which can be 'yes' or 'no'
* @return \OC_OCS_Result
}
/**
- * @brief update password for public link share
+ * update password for public link share
* @param array $share information about the share
* @param array $params 'password'
* @return \OC_OCS_Result
}
/**
- * @brief unshare a file/folder
+ * unshare a file/folder
* @param array $params contains the shareID 'id' which should be unshared
* @return \OC_OCS_Result
*/
}
/**
- * @brief get file ID from a given path
+ * get file ID from a given path
* @param string $path
* @return string fileID or null
*/
}
/**
- * @brief get itemType
+ * get itemType
* @param string $path
* @return string type 'file', 'folder' or null of file/folder doesn't exists
*/
}
/**
- * @brief get some information from a given share
+ * get some information from a given share
* @param int $shareID
* @return array with: item_source, share_type, share_with, item_type, permissions
*/
}
/**
- * @brief Get the source cache of a shared file or folder
+ * Get the source cache of a shared file or folder
* @param string $target Shared target file path
* @return \OC\Files\Cache\Cache
*/
}
/**
- * @brief Format a path to be relative to the /user/files/ directory
+ * Format a path to be relative to the /user/files/ directory
* @param string $path the absolute path
* @return string e.g. turns '/admin/files/test.txt' into 'test.txt'
*/
}
/**
- * @brief create unique target
+ * create unique target
* @param string $filePath
* @param string $shareWith
* @param string $exclude
}
/**
- * @brief resolve reshares to return the correct source item
+ * resolve reshares to return the correct source item
* @param array $source
* @return array source item
*/
}
/**
- * @brief get id of the mount point
+ * get id of the mount point
* @return string
*/
public function getId() {
}
/**
- * @brief get file cache of the shared item source
+ * get file cache of the shared item source
* @return string
*/
public function getSourceId() {
}
/**
- * @brief Get the source file path, permissions, and owner for a shared file
+ * Get the source file path, permissions, and owner for a shared file
* @param string $target Shared target file path
* @return Returns array with the keys path, permissions, and owner or false if not found
*/
}
/**
- * @brief Get the source file path for a shared file
+ * Get the source file path for a shared file
* @param string $target Shared target file path
* @return string source file path or false if not found
*/
}
/**
- * @brief Get the permissions granted for a shared file
+ * Get the permissions granted for a shared file
* @param string $target Shared target file path
* @return int CRUDS permissions granted
*/
}
/**
- * @brief Format a path to be relative to the /user/files/ directory
+ * Format a path to be relative to the /user/files/ directory
* @param string $path the absolute path
* @return string e.g. turns '/admin/files/test.txt' into '/test.txt'
*/
}
/**
- * @brief rename a shared folder/file
+ * rename a shared folder/file
* @param string $sourcePath
* @param string $targetPath
* @return bool
}
/**
- * @brief return mount point of share, relative to data/user/files
+ * return mount point of share, relative to data/user/files
* @return string
*/
public function getMountPoint() {
}
/**
- * @brief get share type
+ * get share type
* @return integer can be single user share (0) group share (1), unique group share name (2)
*/
private function getShareType() {
}
/**
- * @brief does the group share already has a user specific unique name
+ * does the group share already has a user specific unique name
* @return bool
*/
private function uniqueNameSet() {
}
/**
- * @brief the share now uses a unique name of this user
+ * the share now uses a unique name of this user
*/
private function setUniqueName() {
$this->share['unique_name'] = true;
}
/**
- * @brief get share ID
+ * get share ID
* @return integer unique share ID
*/
private function getShareId() {
}
/**
- * @brief get the user who shared the file
+ * get the user who shared the file
* @return string
*/
public function getSharedFrom() {
}
/**
- * @brief return share type, can be "file" or "folder"
+ * return share type, can be "file" or "folder"
* @return string
*/
public function getItemType() {
static private $toRemove = array();
/**
- * @brief walk up the users file tree and update the etags
+ * walk up the users file tree and update the etags
* @param string $user
* @param string $path
*/
}
/**
- * @brief remove all shares for a given file if the file was deleted
+ * remove all shares for a given file if the file was deleted
*
* @param string $path
*/
}
/**
- * @brief share a folder, than reshare a file within the shared folder and check if we construct the correct path
+ * share a folder, than reshare a file within the shared folder and check if we construct the correct path
* @medium
*/
function testGetShareFromFolderReshares() {
}
/**
- * @brief reshare a sub folder and check if we get the correct path
+ * reshare a sub folder and check if we get the correct path
* @medium
*/
function testGetShareFromSubFolderReShares() {
}
/**
- * @brief test re-re-share of folder if the path gets constructed correctly
+ * test re-re-share of folder if the path gets constructed correctly
* @medium
*/
function testGetShareFromFolderReReShares() {
}
/**
- * @brief test multiple shared folder if the path gets constructed correctly
+ * test multiple shared folder if the path gets constructed correctly
* @medium
*/
function testGetShareMultipleSharedFolder() {
}
/**
- * @brief test re-re-share of folder if the path gets constructed correctly
+ * test re-re-share of folder if the path gets constructed correctly
* @medium
*/
function testGetShareFromFileReReShares() {
}
/**
- * @brief test unshare of a reshared file
+ * test unshare of a reshared file
*/
function testDeleteReshare() {
}
/**
- * @brief share a folder which contains a share mount point, should be forbidden
+ * share a folder which contains a share mount point, should be forbidden
*/
public function testShareFolderWithAMountPoint() {
// user 1 shares a folder with user2
}
/**
- * @brief get some information from a given share
+ * get some information from a given share
* @param int $shareID
* @return array with: item_source, share_type, share_with, item_type, permissions
*/
}
/**
- * @brief verify if each value from the result matches the expected result
+ * verify if each value from the result matches the expected result
* @param array $example array with the expected results
* @param array $result array with the results
*/
class Hooks {
/**
- * @brief Copy files to trash bin
+ * Copy files to trash bin
* @param array $params
*
* This function is connected to the delete signal of OC_Filesystem
}
/**
- * @brief clean up user specific settings if user gets deleted
+ * clean up user specific settings if user gets deleted
* @param array $params array with uid
*
* This function is connected to the pre_deleteUser signal of OC_Users
Trashbin::deleteUser($uid);
}
}
-
+
public static function post_write_hook($params) {
Trashbin::resizeTrash(\OCP\User::getUser());
}
/**
- * @brief copy file to owners trash
+ * copy file to owners trash
* @param string $sourcePath
* @param string $owner
* @param string $ownerPath
}
/**
- * @brief restore versions from trash bin
+ * restore versions from trash bin
*
* @param \OC\Files\View $view file view
* @param string $file complete path to file
}
/**
- * @brief restore encryption keys from trash bin
+ * restore encryption keys from trash bin
*
* @param \OC\Files\View $view
* @param string $file complete path to file
}
/**
- * @brief delete all files from the trash
+ * delete all files from the trash
*/
public static function deleteAll() {
$user = \OCP\User::getUser();
/**
- * @brief delete file from trash bin permanently
+ * delete file from trash bin permanently
*
* @param string $filename path to the file
* @param int $timestamp of deletion time
}
/**
- * @brief deletes used space for trash bin in db if user was deleted
+ * deletes used space for trash bin in db if user was deleted
*
* @param type $uid id of deleted user
* @return bool result of db delete operation
}
/**
- * @brief resize trash bin if necessary after a new file was added to ownCloud
+ * resize trash bin if necessary after a new file was added to ownCloud
* @param string $user user id
*/
public static function resizeTrash($user) {
}
/**
- * @brief get the size from a given root folder
+ * get the size from a given root folder
* @param \OC\Files\View $view file view on the root folder
* @return integer size of the folder
*/
}
/**
- * @brief check if trash bin is empty for a given user
+ * check if trash bin is empty for a given user
* @param string $user
*/
public static function isEmpty($user) {
/**
- * @brief Erase versions of deleted file
+ * Erase versions of deleted file
* @param array $params
*
* This function is connected to the delete signal of OC_Filesystem
}
/**
- * @brief mark file as "deleted" so that we can clean up the versions if the file is gone
+ * mark file as "deleted" so that we can clean up the versions if the file is gone
* @param array $params
*/
public static function pre_remove_hook($params) {
}
/**
- * @brief rename/move versions of renamed/moved files
+ * rename/move versions of renamed/moved files
* @param array $params array with oldpath and newpath
*
* This function is connected to the rename signal of OC_Filesystem and adjust the name and location
}
/**
- * @brief clean up user specific settings if user gets deleted
+ * clean up user specific settings if user gets deleted
* @param array $params array with uid
*
* This function is connected to the pre_deleteUser signal of OC_Users
/**
- * @brief mark file as deleted so that we can remove the versions if the file is gone
+ * mark file as deleted so that we can remove the versions if the file is gone
* @param string $path
*/
public static function markDeletedFile($path) {
/**
- * @brief get a list of all available versions of a file in descending chronological order
+ * get a list of all available versions of a file in descending chronological order
* @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 $userFullPath
}
/**
- * @brief translate a timestamp into a string like "5 days ago"
+ * translate a timestamp into a string like "5 days ago"
* @param int $timestamp
* @return string for example "5 days ago"
*/
}
/**
- * @brief deletes used space for files versions in db if user was deleted
+ * deletes used space for files versions in db if user was deleted
*
* @param string $uid id of deleted user
* @return \OC_DB_StatementWrapper of db delete operation
}
/**
- * @brief get the size of all stored versions from a given user
+ * get the size of all stored versions from a given user
* @param string $uid id from the user
* @return int size of versions
*/
}
/**
- * @brief returns all stored file versions from a given user
+ * returns all stored file versions from a given user
* @param string $uid id of the user
* @return array with contains two arrays 'all' which contains all versions sorted by age and 'by_file' which contains all versions sorted by filename
*/
}
/**
- * @brief get list of files we want to expire
+ * get list of files we want to expire
* @param array $versions list of versions
* @param integer $time
* @return array containing the list of to deleted versions and the size of them
}
/**
- * @brief Erase a file's versions which exceed the set quota
+ * Erase a file's versions which exceed the set quota
*/
private static function expire($filename, $versionsSize = null, $offset = 0) {
if(\OCP\Config::getSystemValue('files_versions', Storage::DEFAULTENABLED)=='true') {
}
/**
- * @brief create recursively missing directories
+ * create recursively missing directories
* @param string $filename $path to a file
* @param \OC\Files\View $view view on data/user/
*/
/**
* Class Test_Files_versions
- * @brief this class provide basic files versions test
+ * this class provide basic files versions test
*/
class Test_Files_Versioning extends \PHPUnit_Framework_TestCase {
/**
* @medium
- * @brief test expire logic
+ * test expire logic
* @dataProvider versionsProvider
*/
function testGetExpireList($versions, $sizeOfAllDeletedFiles) {
}
/**
- * @brief is user in group?
+ * is user in group?
* @param string $uid uid of the user
* @param string $gid gid of the group
* @return bool
}
/**
- * @brief Get all groups a user belongs to
+ * Get all groups a user belongs to
* @param string $uid Name of the user
* @return array with group names
*
}
/**
- * @brief get a list of all users in a group
+ * get a list of all users in a group
* @return array with user ids
*/
public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) {
}
/**
- * @brief returns the number of users in a group, who match the search term
+ * returns the number of users in a group, who match the search term
* @param string $gid the internal group name
* @param string $search optional, a search string
* @return int|bool
}
/**
- * @brief get a list of all groups
+ * get a list of all groups
* @return array with group names
*
* Returns a list with all groups (used by getGroups)
}
/**
- * @brief get a list of all groups using a paged search
+ * get a list of all groups using a paged search
* @return array with group names
*
* Returns a list with all groups
}
/**
- * @brief Check if backend implements actions
+ * Check if backend implements actions
* @param int $actions bitwise-or'ed actions
* @return boolean
*
private $refBackend = null;
/**
- * @brief Constructor
+ * Constructor
* @param string[] $serverConfigPrefixes array containing the config Prefixes
*/
public function __construct($serverConfigPrefixes, ILDAPWrapper $ldap) {
}
/**
- * @brief Tries the backends one after the other until a positive result is returned from the specified method
+ * Tries the backends one after the other until a positive result is returned from the specified method
* @param string $gid the gid connected to the request
* @param string $method the method of the group backend that shall be called
* @param array $parameters an array of parameters to be passed
}
/**
- * @brief Asks the backend connected to the server that supposely takes care of the gid from the request.
+ * Asks the backend connected to the server that supposely takes care of the gid from the request.
* @param string $gid the gid connected to the request
* @param string $method the method of the group backend that shall be called
* @param array $parameters an array of parameters to be passed
}
/**
- * @brief is user in group?
+ * is user in group?
* @param string $uid uid of the user
* @param string $gid gid of the group
* @return bool
}
/**
- * @brief Get all groups a user belongs to
+ * Get all groups a user belongs to
* @param string $uid Name of the user
* @return string[] with group names
*
}
/**
- * @brief get a list of all users in a group
+ * get a list of all users in a group
* @return string[] with user ids
*/
public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) {
}
/**
- * @brief returns the number of users in a group, who match the search term
+ * returns the number of users in a group, who match the search term
* @param string $gid the internal group name
* @param string $search optional, a search string
* @return int|bool
}
/**
- * @brief get a list of all groups
+ * get a list of all groups
* @return string[] with group names
*
* Returns a list with all groups
}
/**
- * @brief Check if backend implements actions
+ * Check if backend implements actions
* @param int $actions bitwise-or'ed actions
* @return boolean
*
}
/**
- * @brief reads a given attribute for an LDAP record identified by a DN
+ * reads a given attribute for an LDAP record identified by a DN
* @param string $dn the record in question
* @param string $attr the attribute that shall be retrieved
* if empty, just check the record's existence
}
/**
- * @brief checks whether the given attributes value is probably a DN
+ * checks whether the given attributes value is probably a DN
* @param string $attr the attribute in question
* @return boolean if so true, otherwise false
*/
}
/**
- * @brief sanitizes a DN received from the LDAP server
+ * sanitizes a DN received from the LDAP server
* @param array $dn the DN in question
* @return array the sanitized DN
*/
}
/**
- * @brief returns the LDAP DN for the given internal ownCloud name of the group
+ * returns the LDAP DN for the given internal ownCloud name of the group
* @param string $name the ownCloud name in question
* @return string with the LDAP DN on success, otherwise false
*/
}
/**
- * @brief returns the LDAP DN for the given internal ownCloud name of the user
+ * returns the LDAP DN for the given internal ownCloud name of the user
* @param string $name the ownCloud name in question
* @return string with the LDAP DN on success, otherwise false
*/
}
/**
- * @brief returns the LDAP DN for the given internal ownCloud name
+ * returns the LDAP DN for the given internal ownCloud name
* @param string $name the ownCloud name in question
* @param boolean $isUser is it a user? otherwise group
* @return string with the LDAP DN on success, otherwise false
}
/**
- * @brief returns the internal ownCloud name for the given LDAP DN of the group, false on DN outside of search DN or failure
+ * returns the internal ownCloud name for the given LDAP DN of the group, false on DN outside of search DN or failure
* @param string $dn the dn of the group object
* @param string $ldapName optional, the display name of the object
* @return string with the name to use in ownCloud, false on DN outside of search DN
}
/**
- * @brief returns the internal ownCloud name for the given LDAP DN of the user, false on DN outside of search DN or failure
+ * returns the internal ownCloud name for the given LDAP DN of the user, false on DN outside of search DN or failure
* @param string $dn the dn of the user object
* @param string $ldapName optional, the display name of the object
* @return string with with the name to use in ownCloud
}
/**
- * @brief returns an internal ownCloud name for the given LDAP DN, false on DN outside of search DN
+ * returns an internal ownCloud name for the given LDAP DN, false on DN outside of search DN
* @param string $dn the dn of the user object
* @param string $ldapName optional, the display name of the object
* @param bool $isUser optional, whether it is a user object (otherwise group assumed)
}
/**
- * @brief gives back the user names as they are used ownClod internally
+ * gives back the user names as they are used ownClod internally
* @param array $ldapUsers an array with the ldap Users result in style of array ( array ('dn' => foo, 'uid' => bar), ... )
* @return array an array with the user names to use in ownCloud
*
}
/**
- * @brief gives back the group names as they are used ownClod internally
+ * gives back the group names as they are used ownClod internally
* @param array $ldapGroups an array with the ldap Groups result in style of array ( array ('dn' => foo, 'cn' => bar), ... )
* @return array an array with the group names to use in ownCloud
*
}
/**
- * @brief caches the user display name
+ * caches the user display name
* @param string $ocName the internal ownCloud username
* @param string $displayName the display name
*/
}
/**
- * @brief creates a unique name for internal ownCloud use for users. Don't call it directly.
+ * creates a unique name for internal ownCloud use for users. Don't call it directly.
* @param string $name the display name of the object
* @return string with with the name to use in ownCloud or false if unsuccessful
*
}
/**
- * @brief creates a unique name for internal ownCloud use for groups. Don't call it directly.
+ * creates a unique name for internal ownCloud use for groups. Don't call it directly.
* @param string $name the display name of the object
* @return string with with the name to use in ownCloud or false if unsuccessful.
*
}
/**
- * @brief creates a unique name for internal ownCloud use.
+ * creates a unique name for internal ownCloud use.
* @param string $name the display name of the object
* @param boolean $isUser whether name should be created for a user (true) or a group (false)
* @return string with with the name to use in ownCloud or false if unsuccessful
}
/**
- * @brief retrieves all known groups from the mappings table
+ * retrieves all known groups from the mappings table
* @return array with the results
*
* retrieves all known groups from the mappings table
}
/**
- * @brief retrieves all known users from the mappings table
+ * retrieves all known users from the mappings table
* @return array with the results
*
* retrieves all known users from the mappings table
}
/**
- * @brief inserts a new user or group into the mappings table
+ * inserts a new user or group into the mappings table
* @param string $dn the record in question
* @param string $ocName the name to use in ownCloud
* @param bool $isUser is it a user or a group?
}
/**
- * @brief executes an LDAP search, optimized for Users
+ * executes an LDAP search, optimized for Users
* @param string $filter the LDAP filter for the search
* @param string|string[] $attr optional, when a certain attribute shall be filtered out
* @param integer $limit
}
/**
- * @brief executes an LDAP search, optimized for Groups
+ * executes an LDAP search, optimized for Groups
* @param string $filter the LDAP filter for the search
* @param string|string[] $attr optional, when a certain attribute shall be filtered out
* @param integer $limit
}
/**
- * @brief prepares and executes an LDAP search operation
+ * prepares and executes an LDAP search operation
* @param string $filter the LDAP filter for the search
* @param array $base an array containing the LDAP subtree(s) that shall be searched
* @param string|string[] $attr optional, array, one or more attributes that shall be
}
/**
- * @brief processes an LDAP paged search operation
+ * processes an LDAP paged search operation
* @param array $sr the array containing the LDAP search resources
* @param string $filter the LDAP filter for the search
* @param array $base an array containing the LDAP subtree(s) that shall be searched
}
/**
- * @brief executes an LDAP search, but counts the results only
+ * executes an LDAP search, but counts the results only
* @param string $filter the LDAP filter for the search
* @param array $base an array containing the LDAP subtree(s) that shall be searched
* @param string|string[] $attr optional, array, one or more attributes that shall be
}
/**
- * @brief Executes an LDAP search
+ * Executes an LDAP search
* @param string $filter the LDAP filter for the search
* @param array $base an array containing the LDAP subtree(s) that shall be searched
* @param string|string[] $attr optional, array, one or more attributes that shall be
}
/**
- * @brief escapes (user provided) parts for LDAP filter
+ * escapes (user provided) parts for LDAP filter
* @param string $input, the provided value
* @return string the escaped string
*/
}
/**
- * @brief combines the input filters with AND
+ * combines the input filters with AND
* @param string[] $filters the filters to connect
* @return string the combined filter
*/
}
/**
- * @brief combines the input filters with AND
+ * combines the input filters with AND
* @param string[] $filters the filters to connect
* @return string the combined filter
*/
}
/**
- * @brief combines the input filters with given operator
+ * combines the input filters with given operator
* @param string[] $filters the filters to connect
* @param string $operator either & or |
* @return string the combined filter
}
/**
- * @brief creates a filter part for to perform search for users
+ * creates a filter part for to perform search for users
* @param string $search the search term
* @return string the final filter part to use in LDAP searches
*/
}
/**
- * @brief creates a filter part for to perform search for groups
+ * creates a filter part for to perform search for groups
* @param string $search the search term
* @return string the final filter part to use in LDAP searches
*/
}
/**
- * @brief creates a filter part for searches
+ * creates a filter part for searches
* @param string $search the search term
* @param string[]|null $searchAttributes
* @param string $fallbackAttribute a fallback attribute in case the user
}
/**
- * @brief auto-detects the directory's UUID attribute
+ * auto-detects the directory's UUID attribute
* @param string $dn a known DN used to check against
* @param bool $isUser
* @param bool $force the detection should be run, even if it is not set to auto
}
/**
- * @brief converts a binary ObjectGUID into a string representation
+ * converts a binary ObjectGUID into a string representation
* @param string $oguid the ObjectGUID in it's binary form as retrieved from AD
* @return string
* @link http://www.php.net/manual/en/function.ldap-get-values-len.php#73198
}
/**
- * @brief converts a stored DN so it can be used as base parameter for LDAP queries, internally we store them for usage in LDAP filters
+ * converts a stored DN so it can be used as base parameter for LDAP queries, internally we store them for usage in LDAP filters
* @param string $dn the DN
* @return string
*/
}
/**
- * @brief checks if the given DN is part of the given base DN(s)
+ * checks if the given DN is part of the given base DN(s)
* @param string $dn the DN
* @param string[] $bases array containing the allowed base DN or DNs
* @return bool
}
/**
- * @brief get a cookie for the next LDAP paged search
+ * get a cookie for the next LDAP paged search
* @param string $base a string with the base DN for the search
* @param string $filter the search filter to identify the correct search
* @param int $limit the limit (or 'pageSize'), to identify the correct search well
}
/**
- * @brief set a cookie for LDAP paged search run
+ * set a cookie for LDAP paged search run
* @param string $base a string with the base DN for the search
* @param string $filter the search filter to identify the correct search
* @param int $limit the limit (or 'pageSize'), to identify the correct search well
}
/**
- * @brief Check whether the most recent paged search was successful. It flushed the state var. Use it always after a possible paged search.
+ * Check whether the most recent paged search was successful. It flushed the state var. Use it always after a possible paged search.
* @return boolean|null true on success, null or false otherwise
*/
public function getPagedSearchResultState() {
}
/**
- * @brief Prepares a paged search, if possible
+ * Prepares a paged search, if possible
* @param string $filter the LDAP filter for the search
* @param string[] $bases an array containing the LDAP subtree(s) that shall be searched
* @param string[] $attr optional, when a certain attribute shall be filtered outside
protected $access;
/**
- * @brief constructor, make sure the subclasses call this one!
+ * constructor, make sure the subclasses call this one!
* @param Access $access an instance of Access for LDAP interaction
*/
public function __construct(Access $access) {
}
/**
- * @brief set LDAP configuration with values delivered by an array, not read
+ * set LDAP configuration with values delivered by an array, not read
* from configuration. It does not save the configuration! To do so, you
* must call saveConfiguration afterwards.
* @param array $config array that holds the config parameters in an associated
}
/**
- * @brief saves the current Configuration in the database
+ * saves the current Configuration in the database
*/
public function saveConfiguration() {
$cta = array_flip($this->getConfigTranslationArray());
protected $doNotValidate = false;
/**
- * @brief Constructor
+ * Constructor
* @param ILDAPWrapper $ldap
* @param string $configPrefix a string with the prefix for the configkey column (appconfig table)
* @param string $configID a string with the value for the appid column (appconfig table) or null for on-the-fly connections
}
/**
- * @brief defines behaviour when the instance is cloned
+ * defines behaviour when the instance is cloned
*/
public function __clone() {
//a cloned instance inherits the connection resource. It may use it,
}
/**
- * @brief initializes the LDAP backend
+ * initializes the LDAP backend
* @param bool $force read the config settings no matter what
*/
public function init($force = false) {
}
/**
- * @brief Returns the LDAP handler
+ * Returns the LDAP handler
*/
public function getConnectionResource() {
if(!$this->ldapConnectionRes) {
}
/**
- * @brief Caches the general LDAP configuration.
+ * Caches the general LDAP configuration.
* @param bool $force optional. true, if the re-read should be forced. defaults
* to false.
* @return null
}
/**
- * @brief set LDAP configuration with values delivered by an array, not read from configuration
+ * set LDAP configuration with values delivered by an array, not read from configuration
* @param array $config array that holds the config parameters in an associated array
* @param array &$setParameters optional; array where the set fields will be given to
* @return boolean true if config validates, false otherwise. Check with $setParameters for detailed success on single parameters
}
/**
- * @brief saves the current Configuration in the database and empties the
+ * saves the current Configuration in the database and empties the
* cache
* @return null
*/
}
/**
- * @brief get the current LDAP configuration
+ * get the current LDAP configuration
* @return array
*/
public function getConfiguration() {
}
/**
- * @brief Validates the user specified configuration
+ * Validates the user specified configuration
* @return bool true if configuration seems OK, false otherwise
*/
private function validateConfiguration() {
class Helper {
/**
- * @brief returns prefixes for each saved LDAP/AD server configuration.
+ * returns prefixes for each saved LDAP/AD server configuration.
* @param bool $activeConfigurations optional, whether only active configuration shall be
* retrieved, defaults to false
* @return array with a list of the available prefixes
/**
*
- * @brief determines the host for every configured connection
+ * determines the host for every configured connection
* @return array an array with configprefix as keys
*
*/
}
/**
- * @brief deletes a given saved LDAP/AD server configuration.
+ * deletes a given saved LDAP/AD server configuration.
* @param string $prefix the configuration prefix of the config to delete
* @return bool true on success, false otherwise
*/
}
/**
- * @brief extractsthe domain from a given URL
+ * extractsthe domain from a given URL
* @param string $url the URL
* @return string|false domain as string on success, false otherwise
*/
//LDAP functions in use
/**
- * @brief Bind to LDAP directory
+ * Bind to LDAP directory
* @param resource $link LDAP link resource
* @param string $dn an RDN to log in with
* @param string $password the password
public function bind($link, $dn, $password);
/**
- * @brief connect to an LDAP server
+ * connect to an LDAP server
* @param string $host The host to connect to
* @param string $port The port to connect to
* @return mixed a link resource on success, otherwise false
public function connect($host, $port);
/**
- * @brief Send LDAP pagination control
+ * Send LDAP pagination control
* @param resource $link LDAP link resource
* @param int $pageSize number of results per page
* @param bool $isCritical Indicates whether the pagination is critical of not.
public function controlPagedResult($link, $pageSize, $isCritical, $cookie);
/**
- * @brief Retrieve the LDAP pagination cookie
+ * Retrieve the LDAP pagination cookie
* @param resource $link LDAP link resource
* @param resource $result LDAP result resource
* @param string $cookie structure sent by LDAP server
public function controlPagedResultResponse($link, $result, &$cookie);
/**
- * @brief Count the number of entries in a search
+ * Count the number of entries in a search
* @param resource $link LDAP link resource
* @param resource $result LDAP result resource
* @return int|false number of results on success, false otherwise
public function countEntries($link, $result);
/**
- * @brief Return the LDAP error number of the last LDAP command
+ * Return the LDAP error number of the last LDAP command
* @param resource $link LDAP link resource
* @return string error message as string
*/
public function errno($link);
/**
- * @brief Return the LDAP error message of the last LDAP command
+ * Return the LDAP error message of the last LDAP command
* @param resource $link LDAP link resource
* @return int error code as integer
*/
public function error($link);
/**
- * @brief Return first result id
+ * Return first result id
* @param resource $link LDAP link resource
* @param resource $result LDAP result resource
* @return Resource an LDAP search result resource
public function firstEntry($link, $result);
/**
- * @brief Get attributes from a search result entry
+ * Get attributes from a search result entry
* @param resource $link LDAP link resource
* @param resource $result LDAP result resource
* @return array containing the results, false on error
public function getAttributes($link, $result);
/**
- * @brief Get the DN of a result entry
+ * Get the DN of a result entry
* @param resource $link LDAP link resource
* @param resource $result LDAP result resource
* @return string containing the DN, false on error
public function getDN($link, $result);
/**
- * @brief Get all result entries
+ * Get all result entries
* @param resource $link LDAP link resource
* @param resource $result LDAP result resource
* @return array containing the results, false on error
public function getEntries($link, $result);
/**
- * @brief Return next result id
+ * Return next result id
* @param resource $link LDAP link resource
* @param resource $result LDAP entry result resource
* @return resource an LDAP search result resource
public function nextEntry($link, $result);
/**
- * @brief Read an entry
+ * Read an entry
* @param resource $link LDAP link resource
* @param array $baseDN The DN of the entry to read from
* @param string $filter An LDAP filter
public function read($link, $baseDN, $filter, $attr);
/**
- * @brief Search LDAP tree
+ * Search LDAP tree
* @param resource $link LDAP link resource
* @param string $baseDN The DN of the entry to read from
* @param string $filter An LDAP filter
public function search($link, $baseDN, $filter, $attr, $attrsOnly = 0, $limit = 0);
/**
- * @brief Sets the value of the specified option to be $value
+ * Sets the value of the specified option to be $value
* @param resource $link LDAP link resource
* @param string $option a defined LDAP Server option
* @param int $value the new value for the option
public function setOption($link, $option, $value);
/**
- * @brief establish Start TLS
+ * establish Start TLS
* @param resource $link LDAP link resource
* @return bool true on success, false otherwise
*/
public function startTls($link);
/**
- * @brief Sort the result of a LDAP search
+ * Sort the result of a LDAP search
* @param resource $link LDAP link resource
* @param resource $result LDAP result resource
* @param string $sortFilter attribute to use a key in sort
public function sort($link, $result, $sortFilter);
/**
- * @brief Unbind from LDAP directory
+ * Unbind from LDAP directory
* @param resource $link LDAP link resource
* @return bool true on success, false otherwise
*/
//additional required methods in ownCloud
/**
- * @brief Checks whether the server supports LDAP
+ * Checks whether the server supports LDAP
* @return bool true if it the case, false otherwise
* */
public function areLDAPFunctionsAvailable();
/**
- * @brief Checks whether PHP supports LDAP Paged Results
+ * Checks whether PHP supports LDAP Paged Results
* @return bool true if it the case, false otherwise
* */
public function hasPagedResultSupport();
/**
- * @brief Checks whether the submitted parameter is a resource
+ * Checks whether the submitted parameter is a resource
* @param resource $resource the resource variable to check
* @return bool true if it is a resource, false otherwise
*/
}
/**
- * @brief Checks whether the server supports LDAP
+ * Checks whether the server supports LDAP
* @return boolean if it the case, false otherwise
* */
public function areLDAPFunctionsAvailable() {
}
/**
- * @brief Checks whether PHP supports LDAP Paged Results
+ * Checks whether PHP supports LDAP Paged Results
* @return boolean if it the case, false otherwise
* */
public function hasPagedResultSupport() {
}
/**
- * @brief Checks whether the submitted parameter is a resource
+ * Checks whether the submitted parameter is a resource
* @param Resource $resource the resource variable to check
* @return bool true if it is a resource, false otherwise
*/
protected $ldap;
/**
- * @brief constructor, make sure the subclasses call this one!
+ * constructor, make sure the subclasses call this one!
* @param ILDAPWrapper $ldapWrapper an instance of an ILDAPWrapper
*/
public function __construct(ILDAPWrapper $ldapWrapper) {
abstract protected function walkBackends($id, $method, $parameters);
/**
- * @brief Takes care of the request to the User backend
+ * Takes care of the request to the User backend
* @param string $id
* @param string $method string, the method of the user backend that shall be called
* @param array $parameters an array of parameters to be passed
const LDAP_NW_TIMEOUT = 4;
/**
- * @brief Constructor
+ * Constructor
* @param Configuration $configuration an instance of Configuration
* @param ILDAPWrapper $ldap an instance of ILDAPWrapper
*/
}
/**
- * @brief return the state of the Group Filter Mode
+ * return the state of the Group Filter Mode
* @return WizardResult
*/
public function getGroupFilterMode() {
}
/**
- * @brief return the state of the Login Filter Mode
+ * return the state of the Login Filter Mode
* @return WizardResult
*/
public function getLoginFilterMode() {
}
/**
- * @brief return the state of the User Filter Mode
+ * return the state of the User Filter Mode
* @return WizardResult
*/
public function getUserFilterMode() {
}
/**
- * @brief return the state of the mode of the specified filter
+ * return the state of the mode of the specified filter
* @param string $confKey contains the access key of the Configuration
*/
private function getFilterMode($confKey) {
}
/**
- * @brief detects the available LDAP attributes
+ * detects the available LDAP attributes
* @return array The instance's WizardResult instance
* @throws \Exception
*/
}
/**
- * @brief detects the available LDAP groups
+ * detects the available LDAP groups
* @return WizardResult the instance's WizardResult instance
*/
public function determineGroupsForGroups() {
}
/**
- * @brief detects the available LDAP groups
+ * detects the available LDAP groups
* @return WizardResult the instance's WizardResult instance
*/
public function determineGroupsForUsers() {
}
/**
- * @brief detects the available LDAP groups
+ * detects the available LDAP groups
* @param string $dbKey
* @param string $confKey
* @param bool $testMemberOf
}
/**
- * @brief Detects the available object classes
+ * Detects the available object classes
* @return WizardResult the instance's WizardResult instance
* @throws \Exception
*/
}
/**
- * @brief detects the available object classes
+ * detects the available object classes
* @return WizardResult
* @throws \Exception
*/
}
/**
- * @brief tries to determine a base dn from User DN or LDAP Host
+ * tries to determine a base dn from User DN or LDAP Host
* @return WizardResult|false WizardResult on success, false otherwise
*/
public function guessBaseDN() {
}
/**
- * @brief sets the found value for the configuration key in the WizardResult
+ * sets the found value for the configuration key in the WizardResult
* as well as in the Configuration instance
* @param string $key the configuration key
* @param string $value the (detected) value
}
/**
- * @brief Checks, whether a port was entered in the Host configuration
+ * Checks, whether a port was entered in the Host configuration
* field. In this case the port will be stripped off, but also stored as
* setting.
*/
}
/**
- * @brief tries to detect the group member association attribute which is
+ * tries to detect the group member association attribute which is
* one of 'uniqueMember', 'memberUid', 'member'
* @return string|false, string with the attribute name, false on error
* @throws \Exception
}
/**
- * @brief Checks whether for a given BaseDN results will be returned
+ * Checks whether for a given BaseDN results will be returned
* @param string $base the BaseDN to test
* @return bool true on success, false otherwise
* @throws \Exception
}
/**
- * @brief Checks whether the server supports memberOf in LDAP Filter.
+ * Checks whether the server supports memberOf in LDAP Filter.
* Requires that groups are determined, thus internally called from within
* determineGroups()
* @return bool true if it does, false otherwise
}
/**
- * @brief creates an LDAP Filter from given configuration
+ * creates an LDAP Filter from given configuration
* @param integer $filterType int, for which use case the filter shall be created
* can be any of self::LFILTER_USER_LIST, self::LFILTER_LOGIN or
* self::LFILTER_GROUP_LIST
}
/**
- * @brief checks whether a valid combination of agent and password has been
+ * checks whether a valid combination of agent and password has been
* provided (either two values or nothing for anonymous connect)
* @return bool, true if everything is fine, false otherwise
*/
}
/**
- * @brief does a cumulativeSearch on LDAP to get different values of a
+ * does a cumulativeSearch on LDAP to get different values of a
* specified attribute
* @param string[] $filters array, the filters that shall be used in the search
* @param string $attr the attribute of which a list of values shall be returned
}
/**
- * @brief determines if and which $attr are available on the LDAP server
+ * determines if and which $attr are available on the LDAP server
* @param string[] $objectclasses the objectclasses to use as search filter
* @param string $attr the attribute to look for
* @param string $dbkey the dbkey of the setting the feature is connected to
}
/**
- * @brief appends a list of values fr
+ * appends a list of values fr
* @param resource $result the return value from ldap_get_attributes
* @param string $attribute the attribute values to look for
* @param array &$known new values will be appended here
}
/**
- * @brief Prepares the Access mock for checkPassword tests
+ * Prepares the Access mock for checkPassword tests
* @param \OCA\user_ldap\lib\Access $access mock
* @return void
*/
}
/**
- * @brief Prepares the Access mock for getUsers tests
+ * Prepares the Access mock for getUsers tests
* @param \OCA\user_ldap\lib\Access $access mock
* @return void
*/
}
/**
- * @brief reads jpegPhoto and set is as avatar if available
+ * reads jpegPhoto and set is as avatar if available
* @param string $uid ownCloud user name
* @param string $dn the user's LDAP DN
* @return void
}
/**
- * @brief checks whether the user is allowed to change his avatar in ownCloud
+ * checks whether the user is allowed to change his avatar in ownCloud
* @param string $uid the ownCloud user name
* @return boolean either the user can or cannot
*/
}
/**
- * @brief reads the image from LDAP that shall be used as Avatar
+ * reads the image from LDAP that shall be used as Avatar
* @param string $uid the ownCloud user name
* @param string $dn the user DN
* @return string data (provided by LDAP) | false
}
/**
- * @brief Check if the password is correct
+ * Check if the password is correct
* @param string $uid The username
* @param string $password The password
* @return boolean
}
/**
- * @brief Get a list of all users
+ * Get a list of all users
* @return string[] with all uids
*
* Get a list of all users.
}
/**
- * @brief check if a user exists
+ * check if a user exists
* @param string $uid the username
* @return boolean
*/
}
/**
- * @brief delete a user
+ * delete a user
* @param string $uid The username of the user to delete
* @return bool
*
}
/**
- * @brief get the user's home directory
+ * get the user's home directory
* @param string $uid the username
* @return boolean
*/
}
/**
- * @brief get display name of the user
+ * get display name of the user
* @param string $uid user ID of the user
* @return string display name
*/
}
/**
- * @brief Get a list of all display names
+ * Get a list of all display names
* @return array with all displayNames (value) and the correspondig uids (key)
*
* Get a list of all display names and user ids.
}
/**
- * @brief Check if backend implements actions
+ * Check if backend implements actions
* @param int $actions bitwise-or'ed actions
* @return boolean
*
private $refBackend = null;
/**
- * @brief Constructor
+ * Constructor
* @param array $serverConfigPrefixes array containing the config Prefixes
*/
public function __construct($serverConfigPrefixes, ILDAPWrapper $ldap) {
}
/**
- * @brief Tries the backends one after the other until a positive result is returned from the specified method
+ * Tries the backends one after the other until a positive result is returned from the specified method
* @param string $uid the uid connected to the request
* @param string $method the method of the user backend that shall be called
* @param array $parameters an array of parameters to be passed
}
/**
- * @brief Asks the backend connected to the server that supposely takes care of the uid from the request.
+ * Asks the backend connected to the server that supposely takes care of the uid from the request.
* @param string $uid the uid connected to the request
* @param string $method the method of the user backend that shall be called
* @param array $parameters an array of parameters to be passed
}
/**
- * @brief Check if backend implements actions
+ * Check if backend implements actions
* @param int $actions bitwise-or'ed actions
* @return boolean
*
}
/**
- * @brief Get a list of all users
+ * Get a list of all users
* @return string[] with all uids
*
* Get a list of all users.
}
/**
- * @brief check if a user exists
+ * check if a user exists
* @param string $uid the username
* @return boolean
*/
}
/**
- * @brief Check if the password is correct
+ * Check if the password is correct
* @param string $uid The username
* @param string $password The password
* @return bool
}
/**
- * @brief get the user's home directory
+ * get the user's home directory
* @param string $uid the username
* @return boolean
*/
}
/**
- * @brief get display name of the user
+ * get display name of the user
* @param string $uid user ID of the user
* @return string display name
*/
}
/**
- * @brief checks whether the user is allowed to change his avatar in ownCloud
+ * checks whether the user is allowed to change his avatar in ownCloud
* @param string $uid the ownCloud user name
* @return boolean either the user can or cannot
*/
}
/**
- * @brief Get a list of all display names
+ * Get a list of all display names
* @return array with all displayNames (value) and the corresponding uids (key)
*
* Get a list of all display names and user ids.
}
/**
- * @brief delete a user
+ * delete a user
* @param string $uid The username of the user to delete
* @return bool
*
}
/**
- * @brief Count the number of users
+ * Count the number of users
* @return int|bool
*/
public function countUsers() {
</fileset>
</apply>
+
+ <!-- this looks for @brief and @returns annotation in PHP files and fails if it found some -->
+ <apply executable="egrep" failonerror="false" resultproperty="grepReturnCode">
+ <arg value="-rsHn" />
+ <arg value="@brief|@returns" />
+
+ <fileset dir="${basedir}/build">
+ <include name="**/*.php" />
+ <exclude name="**/3rdparty/**" />
+ <exclude name="**/l10n/**" />
+ </fileset>
+ </apply>
+
+ <!-- fail if grep has found something -->
+ <fail message="Please remove @returns and @brief annotations for PHPDoc (listed above)">
+ <condition>
+ <equals arg1="0" arg2="${grepReturnCode}"/>
+ </condition>
+ </fail>
+
</target>
<!-- javascript lint -->
}
/**
- * @brief Sets the optional low-latency cache for class to path mapping.
+ * Sets the optional low-latency cache for class to path mapping.
* @param \OC\Memcache\Cache $memoryCache Instance of memory cache.
*/
public function setMemoryCache(\OC\Memcache\Cache $memoryCache = null) {
}
/**
- * @brief Handle the request
+ * Handle the request
*/
public static function handleRequest() {
$l = \OC_L10N::get('lib');
static private $altLogin = array();
/**
- * @brief clean the appid
+ * clean the appid
* @param string|boolean $app Appid that needs to be cleaned
* @return string
*/
}
/**
- * @brief loads all apps
+ * loads all apps
* @param array $types
* @return bool
*
}
/**
- * @brief checks whether or not an app is enabled
+ * checks whether or not an app is enabled
* @param string $app app
* @return bool
*
}
/**
- * @brief enables an app
+ * enables an app
* @param mixed $app app
* @throws \Exception
* @return void
}
/**
- * @brief disables an app
+ * disables an app
* @param string $app app
* @return boolean|null
*
}
/**
- * @brief adds an entry to the navigation
+ * adds an entry to the navigation
* @param array $data array containing the data
* @return bool
*
}
/**
- * @brief marks a navigation entry as active
+ * marks a navigation entry as active
* @param string $id id of the entry
* @return bool
*
}
/**
- * @brief Get the navigation entries for the $app
+ * Get the navigation entries for the $app
* @param string $app app
* @return array an array of the $data added with addNavigationEntry
*
}
/**
- * @brief gets the active Menu entry
+ * gets the active Menu entry
* @return string id or empty string
*
* This function returns the id of the active navigation entry (set by
}
/**
- * @brief Returns the Settings Navigation
+ * Returns the Settings Navigation
* @return string
*
* This function returns an array containing all settings pages added. The
}
/**
- * @brief Read all app metadata from the info.xml file
+ * Read all app metadata from the info.xml file
* @param string $appid id of the app or the path of the info.xml file
* @param boolean $path (optional)
* @return array
}
/**
- * @brief Returns the navigation
+ * Returns the navigation
* @return array
*
* This function returns an array containing all entries added. The
}
/**
- * @brief: get a list of all apps in the apps folder
+ * get a list of all apps in the apps folder
* @return array an array of app names (string IDs)
* @todo: change the name of this method to getInstalledApps, which is more accurate
*/
}
/**
- * @brief: Lists all apps, this is used in apps.php
+ * Lists all apps, this is used in apps.php
* @return array
*/
public static function listAllApps() {
}
/**
- * @brief: Internal custom sort funtion to bring the app into the right order. Should only be called by listAllApps
+ * Internal custom sort funtion to bring the app into the right order. Should only be called by listAllApps
* @return array
*/
private static function customSort($a, $b) {
}
/**
- * @brief: get a list of all apps on apps.owncloud.com
+ * get a list of all apps on apps.owncloud.com
* @return array, multi-dimensional array of apps.
* Keys: id, name, type, typename, personid, license, detailpage, preview, changed, description
*/
}
/**
- * @brief Get all apps using the config
+ * Get all apps using the config
* @return array an array of app ids
*
* This function returns a list of all apps that have at least one
}
/**
- * @brief Get the available keys for an app
+ * Get the available keys for an app
* @param string $app the app we are looking for
* @return array an array of key names
*
}
/**
- * @brief Gets the config value
+ * Gets the config value
* @param string $app app
* @param string $key key
* @param string $default = null, default value if the key does not exist
}
/**
- * @brief check if a key is set in the appconfig
+ * check if a key is set in the appconfig
* @param string $app
* @param string $key
* @return bool
}
/**
- * @brief sets a value in the appconfig
+ * sets a value in the appconfig
* @param string $app app
* @param string $key key
* @param string $value value
}
/**
- * @brief Deletes a key
+ * Deletes a key
* @param string $app app
* @param string $key key
* @return boolean|null
}
/**
- * @brief Remove app from appconfig
+ * Remove app from appconfig
* @param string $app app
* @return boolean|null
*
}
/**
- * @brief connects a function to a hook
+ * connects a function to a hook
* @param string $signalClass class name of emitter
* @param string $signalName name of signal
* @param string $slotClass class name of slot
}
/**
- * @brief Emits a signal. To get data from the slot use references!
+ * Emits a signal. To get data from the slot use references!
* @param string $signalClass class name of emitter
* @param string $signalName name of signal
* @param array $params default: array() array with additional data
}
/**
- * @brief clear hooks
+ * clear hooks
* @param string $signalClass
* @param string $signalName
*/
private $view;
/**
- * @brief constructor
+ * constructor
* @param string $user user to do avatar-management with
*/
public function __construct ($user) {
}
/**
- * @brief get the users avatar
+ * get the users avatar
* @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
*/
}
/**
- * @brief sets the users avatar
+ * sets the users avatar
* @param \OC_Image|resource|string $data OC_Image, imagedata or path to set a new avatar
* @throws Exception if the provided file is not a jpg or png image
* @throws Exception if the provided image is not valid
}
/**
- * @brief remove the users avatar
+ * remove the users avatar
* @return void
*/
public function remove () {
class AvatarManager implements IAvatarManager {
/**
- * @brief return a user specific instance of \OCP\IAvatar
+ * return a user specific instance of \OCP\IAvatar
* @see \OCP\IAvatar
* @param string $user the ownCloud user id
* @return \OCP\IAvatar
*/
class OC_BackgroundJob{
/**
- * @brief get the execution type of background jobs
+ * get the execution type of background jobs
* @return string
*
* This method returns the type how background jobs are executed. If the user
}
/**
- * @brief sets the background jobs execution type
+ * sets the background jobs execution type
* @param string $type execution type
* @return false|null
*
}
/**
- * @brief Lists all available config keys
+ * Lists all available config keys
* @return array an array of key names
*
* This function returns all keys saved in config.php. Please note that it
}
/**
- * @brief Gets a value from config.php
+ * Gets a value from config.php
* @param string $key key
* @param mixed $default = null default value
* @return mixed the value or $default
}
/**
- * @brief Sets a value
+ * Sets a value
* @param string $key key
* @param mixed $value value
*
}
/**
- * @brief Removes a key from the config
+ * Removes a key from the config
* @param string $key key
*
* This function removes a key from the config.php.
}
/**
- * @brief Loads the config file
+ * Loads the config file
*
* Reads the config file and saves it to the cache
*/
}
/**
- * @brief Writes the config file
+ * Writes the config file
*
* Saves the config to the config file.
*
protected $info;
/**
- * @brief Sets up the node, expects a full path name
+ * Sets up the node, expects a full path name
* @param \OC\Files\View $view
* @param \OCP\Files\FileInfo $info
*/
}
/**
- * @brief Returns the name of the node
+ * Returns the name of the node
* @return string
*/
public function getName() {
}
/**
- * @brief Renames the node
+ * Renames the node
* @param string $name The new name
* @throws Sabre_DAV_Exception_BadRequest
* @throws Sabre_DAV_Exception_Forbidden
}
/**
- * @brief Returns the last modification time, as a unix timestamp
+ * Returns the last modification time, as a unix timestamp
* @return int timestamp as integer
*/
public function getLastModified() {
}
/**
- * @brief Updates properties on this node,
+ * Updates properties on this node,
* @see Sabre_DAV_IProperties::updateProperties
* @param array $properties
* @return boolean
}
/**
- * @brief Returns a list of properties for this nodes.;
+ * Returns a list of properties for this nodes.;
* @param array $properties
* @return array
* @note The properties list is a list of propertynames the client
protected $verifyHost;
/**
- * @brief Sets the request timeout or 0 to disable timeout.
+ * Sets the request timeout or 0 to disable timeout.
* @param integer $timeout in seconds or 0 to disable
*/
public function setRequestTimeout($timeout) {
}
/**
- * @brief Sets the CURLOPT_SSL_VERIFYHOST setting
+ * Sets the CURLOPT_SSL_VERIFYHOST setting
* @param integer $value value to set CURLOPT_SSL_VERIFYHOST to
*/
public function setVerifyHost($value) {
static private $type=null;
/**
- * @brief connects to the database
+ * connects to the database
* @return boolean|null true if connection can be established or false on error
*
* Connects to the database as specified in config.php
}
/**
- * @brief Prepare a SQL query
+ * Prepare a SQL query
* @param string $query Query string
* @param int $limit
* @param int $offset
*/
static public function prepare( $query , $limit = null, $offset = null, $isManipulation = null) {
self::connect();
-
+
if ($isManipulation === null) {
//try to guess, so we return the number of rows on manipulations
$isManipulation = self::isManipulation($query);
}
-
+
// return the result
try {
$result = self::$connection->prepare($query, $limit, $offset);
/**
* tries to guess the type of statement based on the first 10 characters
* the current check allows some whitespace but does not work with IF EXISTS or other more complex statements
- *
+ *
* @param string $sql
* @return bool
*/
}
return false;
}
-
+
/**
- * @brief execute a prepared statement, on error write log and throw exception
+ * execute a prepared statement, on error write log and throw exception
* @param mixed $stmt OC_DB_StatementWrapper,
* an array with 'sql' and optionally 'limit' and 'offset' keys
* .. or a simple sql query string
}
/**
- * @brief gets last value of autoincrement
+ * gets last value of autoincrement
* @param string $table The optional table name (will replace *PREFIX*) and add sequence suffix
* @return string id
* @throws DatabaseException
}
/**
- * @brief Insert a row if a matching row doesn't exists.
+ * Insert a row if a matching row doesn't exists.
* @param string $table The table to insert into in the form '*PREFIX*tableName'
* @param array $input An array of fieldname/value pairs
* @return boolean number of updated rows
}
/**
- * @brief saves database schema to xml file
+ * saves database schema to xml file
* @param string $file name of file
* @param int $mode
* @return bool
}
/**
- * @brief Creates tables from XML file
+ * Creates tables from XML file
* @param string $file file to read structure from
* @return bool
*
}
/**
- * @brief update the database schema
+ * update the database schema
* @param string $file file to read structure from
* @throws Exception
* @return string|boolean
}
/**
- * @brief drop a table
+ * drop a table
* @param string $tableName the table to drop
*/
public static function dropTable($tableName) {
}
/**
- * @brief replaces the ownCloud tables with a new set
+ * replaces the ownCloud tables with a new set
* @param string $file path to the MDB2 xml db export file
*/
public static function replaceDB( $file ) {
}
/**
- * @brief insert the @input values when they do not exist yet
+ * insert the @input values when they do not exist yet
* @param string $table name
* @param array $input key->value pairs
* @return int count of inserted rows
}
/**
- * @brief Insert a row if a matching row doesn't exists.
+ * Insert a row if a matching row doesn't exists.
* @param string $table. The table to insert into in the form '*PREFIX*tableName'
* @param array $input. An array of fieldname/value pairs
* @return bool The return value from execute()
}
/**
- * @brief saves database scheme to xml file
+ * saves database scheme to xml file
* @param string $file name of file
* @param int|string $mode
* @return bool
}
/**
- * @brief Creates tables from XML file
+ * Creates tables from XML file
* @param string $file file to read structure from
* @return bool
*
}
/**
- * @brief update the database scheme
+ * update the database scheme
* @param string $file file to read structure from
* @return string|boolean
*/
$column->oldColumnName = $platform->quoteIdentifier($column->oldColumnName);
}
}
-
+
if ($generateSql) {
return $this->generateChangeScript($schemaDiff);
}
}
/**
- * @brief drop a table
+ * drop a table
* @param string $tableName the table to drop
*/
public function dropTable($tableName) {
}
/**
- * @brief replaces the ownCloud tables with a new set
+ * replaces the ownCloud tables with a new set
* @param string $file path to the MDB2 xml db export file
*/
public function replaceDB( $file ) {
}
/**
- * @brief check if the file should be ignored when scanning
+ * check if the file should be ignored when scanning
* NOTE: files with a '.part' extension are ignored as well!
* prevents unfinished put requests to be scanned
* @param string $file
}
/**
- * @brief get file owner and path
+ * get file owner and path
* @param string $filename
* @return string[] with the oweners uid and the owners path
*/
}
/**
- * @brief get the relative path of the root data directory for the current user
+ * get the relative path of the root data directory for the current user
* @return string
*
* Returns path like /admin/files
}
/**
- * @brief check if the directory should be ignored when scanning
+ * check if the directory should be ignored when scanning
* NOTE: the special directories . and .. would cause never ending recursion
* @param String $dir
* @return boolean
}
/**
- * @brief Fix common problems with a file path
+ * Fix common problems with a file path
* @param string $path
* @param bool $stripTrailingSlash
* @return string
protected $user;
/**
- * @brief Construct a Home storage instance
+ * Construct a Home storage instance
* @param array $arguments array with "user" containing the
* storage owner and "legacy" containing "true" if the storage is
* a legacy storage with "local::" URL instead of the new "home::" one.
}
/**
- * @brief Returns the owner of this home storage
+ * Returns the owner of this home storage
* @return \OC\User\User owner of this home storage
*/
public function getUser() {
}
/**
- * @brief abstraction layer for basic filesystem functions: wrapper for \OC\Files\Storage\Storage
+ * abstraction layer for basic filesystem functions: wrapper for \OC\Files\Storage\Storage
* @param string $operation
* @param string $path
* @param array $hooks (optional)
*/
class OC_Geo{
/**
- * @brief returns the closest timezone to coordinates
+ * returns the closest timezone to coordinates
* @param float $latitude
* @param float $longitude
* @return mixed Closest timezone
}
/**
- * @brief set the group backend
+ * set the group backend
* @param \OC_Group_Backend $backend The backend to use for user managment
* @return bool
*/
}
/**
- * @brief Try to create a new group
+ * Try to create a new group
* @param string $gid The name of the group to create
* @return bool
*
}
/**
- * @brief delete a group
+ * delete a group
* @param string $gid gid of the group to delete
* @return bool
*
}
/**
- * @brief is user in group?
+ * is user in group?
* @param string $uid uid of the user
* @param string $gid gid of the group
* @return bool
}
/**
- * @brief Add a user to a group
+ * Add a user to a group
* @param string $uid Name of the user to add to group
* @param string $gid Name of the group in which add the user
* @return bool
}
/**
- * @brief Removes a user from a group
+ * Removes a user from a group
* @param string $uid Name of the user to remove from group
* @param string $gid Name of the group from which remove the user
* @return bool
}
/**
- * @brief Get all groups a user belongs to
+ * Get all groups a user belongs to
* @param string $uid Name of the user
* @return array an array of group names
*
}
/**
- * @brief get a list of all groups
+ * get a list of all groups
* @param string $search
* @param int|null $limit
* @param int|null $offset
}
/**
- * @brief get a list of all users in a group
+ * get a list of all users in a group
* @param string $gid
* @param string $search
* @param int $limit
}
/**
- * @brief get a list of all users in several groups
+ * get a list of all users in several groups
* @param string[] $gids
* @param string $search
* @param int $limit
}
/**
- * @brief get a list of all display names in a group
+ * get a list of all display names in a group
* @param string $gid
* @param string $search
* @param int $limit
}
/**
- * @brief get a list of all display names in several groups
+ * get a list of all display names in several groups
* @param array $gids
* @param string $search
* @param int $limit
);
/**
- * @brief Get all supported actions
+ * Get all supported actions
* @return int bitwise-or'ed actions
*
* Returns the supported actions as int to be
}
/**
- * @brief Check if backend implements actions
+ * Check if backend implements actions
* @param int $actions bitwise-or'ed actions
* @return bool
*
}
/**
- * @brief is user in group?
+ * is user in group?
* @param string $uid uid of the user
* @param string $gid gid of the group
* @return bool
}
/**
- * @brief Get all groups a user belongs to
+ * Get all groups a user belongs to
* @param string $uid Name of the user
* @return array an array of group names
*
}
/**
- * @brief get a list of all groups
+ * get a list of all groups
* @param string $search
* @param int $limit
* @param int $offset
}
/**
- * @brief get a list of all users in a group
+ * get a list of all users in a group
* @param string $gid
* @param string $search
* @param int $limit
class OC_Group_Database extends OC_Group_Backend {
/**
- * @brief Try to create a new group
+ * Try to create a new group
* @param string $gid The name of the group to create
* @return bool
*
}
/**
- * @brief delete a group
+ * delete a group
* @param string $gid gid of the group to delete
* @return bool
*
}
/**
- * @brief is user in group?
+ * is user in group?
* @param string $uid uid of the user
* @param string $gid gid of the group
* @return bool
}
/**
- * @brief Add a user to a group
+ * Add a user to a group
* @param string $uid Name of the user to add to group
* @param string $gid Name of the group in which add the user
* @return bool
}
/**
- * @brief Removes a user from a group
+ * Removes a user from a group
* @param string $uid Name of the user to remove from group
* @param string $gid Name of the group from which remove the user
* @return bool
}
/**
- * @brief Get all groups a user belongs to
+ * Get all groups a user belongs to
* @param string $uid Name of the user
* @return array an array of group names
*
}
/**
- * @brief get a list of all groups
+ * get a list of all groups
* @param string $search
* @param int $limit
* @param int $offset
}
/**
- * @brief get a list of all users in a group
+ * get a list of all users in a group
* @param string $gid
* @param string $search
* @param int $limit
}
/**
- * @brief get the number of all users matching the search string in a group
+ * get the number of all users matching the search string in a group
* @param string $gid
* @param string $search
* @return int|false
class OC_Group_Dummy extends OC_Group_Backend {
private $groups=array();
/**
- * @brief Try to create a new group
+ * Try to create a new group
* @param string $gid The name of the group to create
* @return bool
*
}
/**
- * @brief delete a group
+ * delete a group
* @param string $gid gid of the group to delete
* @return bool
*
}
/**
- * @brief is user in group?
+ * is user in group?
* @param string $uid uid of the user
* @param string $gid gid of the group
* @return bool
}
/**
- * @brief Add a user to a group
+ * Add a user to a group
* @param string $uid Name of the user to add to group
* @param string $gid Name of the group in which add the user
* @return bool
}
/**
- * @brief Removes a user from a group
+ * Removes a user from a group
* @param string $uid Name of the user to remove from group
* @param string $gid Name of the group from which remove the user
* @return bool
}
/**
- * @brief Get all groups a user belongs to
+ * Get all groups a user belongs to
* @param string $uid Name of the user
* @return array an array of group names
*
}
/**
- * @brief Get a list of all groups
+ * Get a list of all groups
* @param string $search
* @param int $limit
* @param int $offset
}
/**
- * @brief Get a list of all users in a group
+ * Get a list of all users in a group
* @param string $gid
* @param string $search
* @param int $limit
}
/**
- * @brief get the number of all users in a group
+ * get the number of all users in a group
* @param string $gid
* @param string $search
* @param int $limit
*/
abstract class OC_Group_Example {
/**
- * @brief Try to create a new group
+ * Try to create a new group
* @param string $gid The name of the group to create
* @return bool
*
abstract public static function createGroup($gid);
/**
- * @brief delete a group
+ * delete a group
* @param string $gid gid of the group to delete
* @return bool
*
abstract public static function deleteGroup($gid);
/**
- * @brief is user in group?
+ * is user in group?
* @param string $uid uid of the user
* @param string $gid gid of the group
* @return bool
abstract public static function inGroup($uid, $gid);
/**
- * @brief Add a user to a group
+ * Add a user to a group
* @param string $uid Name of the user to add to group
* @param string $gid Name of the group in which add the user
* @return bool
abstract public static function addToGroup($uid, $gid);
/**
- * @brief Removes a user from a group
+ * Removes a user from a group
* @param string $uid Name of the user to remove from group
* @param string $gid Name of the group from which remove the user
* @return bool
abstract public static function removeFromGroup($uid, $gid);
/**
- * @brief Get all groups a user belongs to
+ * Get all groups a user belongs to
* @param string $uid Name of the user
* @return array an array of group names
*
abstract public static function getUserGroups($uid);
/**
- * @brief get a list of all groups
+ * get a list of all groups
* @param string $search
* @param int $limit
* @param int $offset
abstract public static function getGroups($search = '', $limit = -1, $offset = 0);
/**
- * @brief Check if a group exists
+ * Check if a group exists
* @param string $gid
* @return bool
*/
abstract public function groupExists($gid);
/**
- * @brief get a list of all users in a group
+ * get a list of all users in a group
* @param string $gid
* @param string $search
* @param int $limit
}
/**
- * @brief returns all the Users from an array that really exists
+ * returns all the Users from an array that really exists
* @param string[] $userIds an array containing user IDs
* @return \OC\User\User[] an Array with the userId as Key and \OC\User\User as value
*/
interface OC_Group_Interface {
/**
- * @brief Check if backend implements actions
+ * Check if backend implements actions
* @param int $actions bitwise-or'ed actions
* @return boolean
*
public function implementsActions($actions);
/**
- * @brief is user in group?
+ * is user in group?
* @param string $uid uid of the user
* @param string $gid gid of the group
* @return bool
public function inGroup($uid, $gid);
/**
- * @brief Get all groups a user belongs to
+ * Get all groups a user belongs to
* @param string $uid Name of the user
* @return array an array of group names
*
public function getUserGroups($uid);
/**
- * @brief get a list of all groups
+ * get a list of all groups
* @param string $search
* @param int $limit
* @param int $offset
public function groupExists($gid);
/**
- * @brief get a list of all users in a group
+ * get a list of all users in a group
* @param string $gid
* @param string $search
* @param int $limit
}
/**
- * @brief get a list of all display names in a group
+ * get a list of all display names in a group
* @param string $gid
* @param string $search
* @param int $limit
private static $templateManager;
/**
- * @brief Creates an url using a defined route
+ * Creates an url using a defined route
* @param string $route
* @param array $parameters
* @return
}
/**
- * @brief Creates an url
+ * Creates an url
* @param string $app app
* @param string $file file
* @param array $args array with param=>value, will be appended to the returned url
}
/**
- * @brief Creates an absolute url
+ * Creates an absolute url
* @param string $app app
* @param string $file file
* @param array $args array with param=>value, will be appended to the returned url
}
/**
- * @brief Makes an $url absolute
+ * Makes an $url absolute
* @param string $url the url
* @return string the absolute url
*
}
/**
- * @brief Creates an url for remote use
+ * Creates an url for remote use
* @param string $service id
* @return string the url
*
}
/**
- * @brief Creates an absolute url for remote use
+ * Creates an absolute url for remote use
* @param string $service id
* @param bool $add_slash
* @return string the url
}
/**
- * @brief Creates an absolute url for public use
+ * Creates an absolute url for public use
* @param string $service id
* @param bool $add_slash
* @return string the url
}
/**
- * @brief Creates path to an image
+ * Creates path to an image
* @param string $app app
* @param string $image image name
* @return string the url
}
/**
- * @brief get path to icon of file type
+ * get path to icon of file type
* @param string $mimetype mimetype
* @return string the url
*
}
/**
- * @brief get path to preview of file
+ * get path to preview of file
* @param string $path path
* @return string the url
*
}
/**
- * @brief Make a human file size
+ * Make a human file size
* @param int $bytes file size in bytes
* @return string a human readable file size
*
}
/**
- * @brief Make a php file size
+ * Make a php file size
* @param int $bytes file size in bytes
* @return string a php parseable file size
*
}
/**
- * @brief Make a computer file size
+ * Make a computer file size
* @param string $str file size in human readable format
* @return int a file size in bytes
*
}
/**
- * @brief Recursive copying of folders
+ * Recursive copying of folders
* @param string $src source folder
* @param string $dest target folder
*
}
/**
- * @brief Recursive deletion of folders
+ * Recursive deletion of folders
* @param string $dir path to the folder
* @return bool
*/
}
/**
- * @brief Checks $_REQUEST contains a var for the $s key. If so, returns the html-escaped value of this var; otherwise returns the default value provided by $d.
+ * Checks $_REQUEST contains a var for the $s key. If so, returns the html-escaped value of this var; otherwise returns the default value provided by $d.
* @param string $s name of the var to escape, if set.
* @param string $d default value.
* @return string the print-safe value.
}
/**
- * @brief Checks if $sub is a subdirectory of $parent
+ * Checks if $sub is a subdirectory of $parent
*
* @param string $sub
* @param string $parent
}
/**
- * @brief Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
+ * Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
*
* @param array $input The array to work on
* @param int $case Either MB_CASE_UPPER or MB_CASE_LOWER (default)
}
/**
- * @brief replaces a copy of string delimited by the start and (optionally) length parameters with the string given in replacement.
+ * replaces a copy of string delimited by the start and (optionally) length parameters with the string given in replacement.
*
* @param string $string
* @param string $replacement The replacement string.
}
/**
- * @brief Replace all occurrences of the search string with the replacement string
+ * Replace all occurrences of the search string with the replacement string
*
* @param string $search The value being searched for, otherwise known as the needle.
* @param string $replace The replacement
}
/**
- * @brief performs a search in a nested array
+ * performs a search in a nested array
* @param array $haystack the array to be searched
* @param string $needle the search string
* @param string $index optional, only search this key name
}
/**
- * @brief calculates the maximum upload size respecting system settings, free space and user quota
+ * calculates the maximum upload size respecting system settings, free space and user quota
*
* @param string $dir the current folder where the user currently operates
* @param int $freeSpace the number of bytes free on the storage holding $dir, if not set this will be received from the storage directly
/**
* Calculate free space left within user quota
- *
+ *
* @param string $dir the current folder where the user currently operates
* @return int number of bytes representing
*/
static private $registered = array();
/**
- * @brief connects a function to a hook
+ * connects a function to a hook
* @param string $signalclass class name of emitter
* @param string $signalname name of signal
* @param string $slotclass class name of slot
}
/**
- * @brief emits a signal
+ * emits a signal
* @param string $signalclass class name of emitter
* @param string $signalname name of signal
* @param mixed $params default: array() array with additional data
private $fileInfo;
/**
- * @brief Get mime type for an image file.
+ * Get mime type for an image file.
* @param string|null $filePath The path to a local image file.
* @return string The mime type if the it could be determined, otherwise an empty string.
*/
}
/**
- * @brief Constructor.
+ * Constructor.
* @param resource|string $imageRef The path to a local file, a base64 encoded string or a resource created by
* an imagecreate* function.
* @return \OC_Image False on error
}
/**
- * @brief Determine whether the object contains an image resource.
+ * Determine whether the object contains an image resource.
* @return bool
*/
public function valid() { // apparently you can't name a method 'empty'...
}
/**
- * @brief Returns the MIME type of the image or an empty string if no image is loaded.
+ * Returns the MIME type of the image or an empty string if no image is loaded.
* @return string
*/
public function mimeType() {
}
/**
- * @brief Returns the width of the image or -1 if no image is loaded.
+ * Returns the width of the image or -1 if no image is loaded.
* @return int
*/
public function width() {
}
/**
- * @brief Returns the height of the image or -1 if no image is loaded.
+ * Returns the height of the image or -1 if no image is loaded.
* @return int
*/
public function height() {
}
/**
- * @brief Returns the width when the image orientation is top-left.
+ * Returns the width when the image orientation is top-left.
* @return int
*/
public function widthTopLeft() {
}
/**
- * @brief Returns the height when the image orientation is top-left.
+ * Returns the height when the image orientation is top-left.
* @return int
*/
public function heightTopLeft() {
}
/**
- * @brief Outputs the image.
+ * Outputs the image.
* @param string $mimeType
* @return bool
*/
}
/**
- * @brief Saves the image.
+ * Saves the image.
* @param string $filePath
* @param string $mimeType
* @return bool
}
/**
- * @brief Outputs/saves the image.
+ * Outputs/saves the image.
* @param string $filePath
* @param string $mimeType
* @return bool
}
/**
- * @brief Prints the image when called as $image().
+ * Prints the image when called as $image().
*/
public function __invoke() {
return $this->show();
/**
* (I'm open for suggestions on better method name ;)
- * @brief Get the orientation based on EXIF data.
+ * Get the orientation based on EXIF data.
* @return int The orientation or -1 if no EXIF data is available.
*/
public function getOrientation() {
/**
* (I'm open for suggestions on better method name ;)
- * @brief Fixes orientation based on EXIF data.
+ * Fixes orientation based on EXIF data.
* @return bool.
*/
public function fixOrientation() {
}
/**
- * @brief Loads an image from a local file, a base64 encoded string or a resource created by an imagecreate* function.
+ * Loads an image from a local file, a base64 encoded string or a resource created by an imagecreate* function.
* @param resource|string $imageRef The path to a local file, a base64 encoded string or a resource created by an imagecreate* function or a file resource (file handle ).
* @return resource|false An image resource or false on error
*/
}
/**
- * @brief Loads an image from an open file handle.
+ * Loads an image from an open file handle.
* It is the responsibility of the caller to position the pointer at the correct place and to close the handle again.
* @param resource $handle
* @return resource|false An image resource or false on error
}
/**
- * @brief Loads an image from a local file.
+ * Loads an image from a local file.
* @param bool|string $imagePath The path to a local file.
* @return bool|resource An image resource or false on error
*/
}
/**
- * @brief Loads an image from a string of data.
+ * Loads an image from a string of data.
* @param string $str A string of image data as read from a file.
* @return bool|resource An image resource or false on error
*/
}
/**
- * @brief Loads an image from a base64 encoded string.
+ * Loads an image from a base64 encoded string.
* @param string $str A string base64 encoded string of image data.
* @return bool|resource An image resource or false on error
*/
}
/**
- * @brief Resizes the image preserving ratio.
+ * Resizes the image preserving ratio.
* @param integer $maxSize The maximum size of either the width or height.
* @return bool
*/
}
/**
- * @brief Crops the image to the middle square. If the image is already square it just returns.
+ * Crops the image to the middle square. If the image is already square it just returns.
* @param int $size maximum size for the result (optional)
* @return bool for success or failure
*/
}
/**
- * @brief Crops the image from point $x$y with dimension $wx$h.
+ * Crops the image from point $x$y with dimension $wx$h.
* @param int $x Horizontal position
* @param int $y Vertical position
* @param int $w Width
}
/**
- * @brief Resizes the image to fit within a boundry while preserving ratio.
+ * Resizes the image to fit within a boundry while preserving ratio.
* @param integer $maxWidth
* @param integer $maxHeight
* @return bool
* It is the task of oc_app_install to create the tables and do whatever is
* needed to get the app working.
*
- * @brief Installs an app
+ * Installs an app
* @param array $data with all information
* @throws \Exception
* @return integer
}
/**
- * @brief checks whether or not an app is installed
+ * checks whether or not an app is installed
* @param string $app app
* @return bool
*
}
/**
- * @brief Update an application
+ * Update an application
*
* This function installs an app. All information needed are passed in the
* associative array $data.
}
/**
- * @brief Check if an update for the app is available
+ * Check if an update for the app is available
* @return string|false false or the version number of the update
*
* The function will check if an update for a version is available
}
/**
- * @brief Check if app is already downloaded
+ * Check if app is already downloaded
* @param string $name name of the application to remove
* @return boolean
*
}
/**
- * @brief Removes an app
+ * Removes an app
* @param string $name name of the application to remove
* @param array $options options
* @return boolean|null
}
/**
- * @brief Installs shipped apps
+ * Installs shipped apps
*
* This function installs all apps found in the 'apps' directory that should be enabled by default;
*/
}
/**
- * @brief The constructor
+ * The constructor
* @param string $app app requesting l10n
* @param string $lang default: null Language
*
}
/**
- * @brief Creates a function that The constructor
+ * Creates a function that The constructor
*
* If language is not set, the constructor tries to find the right
* language.
}
/**
- * @brief Translating
+ * Translating
* @param string $text The text we need a translation for
* @param array $parameters default:array() Parameters for sprintf
* @return \OC_L10N_String Translation or the same text
}
/**
- * @brief Translating
+ * Translating
* @param string $text_singular the string to translate for exactly one object
* @param string $text_plural the string to translate for n objects
* @param integer $count Number of objects
}
/**
- * @brief getTranslations
+ * getTranslations
* @return array Fetch all translations
*
* Returns an associative array with all translations
}
/**
- * @brief getPluralFormString
+ * getPluralFormString
* @return string containing the gettext "Plural-Forms"-string
*
* Returns a string like "nplurals=2; plural=(n != 1);"
}
/**
- * @brief getPluralFormFunction
+ * getPluralFormFunction
* @return string the plural form function
*
* returned function accepts the argument $n
}
/**
- * @brief get localizations
+ * get localizations
* @return array Fetch all localizations
*
* Returns an associative array with all localizations
}
/**
- * @brief Localization
+ * Localization
* @param string $type Type of localization
* @param array|int|string $data parameters for this localization
* @return String or false
}
/**
- * @brief Choose a language
+ * Choose a language
* @param array $text Associative Array with possible strings
* @return String
*
/**
- * @brief find the best language
+ * find the best language
* @param array|string $app details below
- * @returns string language
+ * string language
*
* If $app is an array, ownCloud assumes that these are the available
* languages. Otherwise ownCloud tries to find the files in the l10n
public function getLanguageCode($app=null) {
return self::findLanguage($app);
}
-
+
/**
- * @brief find the best language
+ * find the best language
* @param array|string $app details below
* @return string language
*
}
/**
- * @brief find the l10n directory
+ * find the l10n directory
* @param string $app App that needs to be translated
* @return directory
*/
}
/**
- * @brief find all available languages for an app
+ * find all available languages for an app
* @param string $app App that needs to be translated
* @return array an array of available languages
*/
}
/**
- * @brief Get all apps using the config
+ * Get all apps using the config
* @return array an array of app ids
*
* This function returns a list of all apps that have at least one
}
/**
- * @brief Get the available keys for an app
+ * Get the available keys for an app
* @param string $app the app we are looking for
* @return array an array of key names
*
}
/**
- * @brief Gets the config value
+ * Gets the config value
* @param string $app app
* @param string $key key
* @param string $default = null, default value if the key does not exist
}
/**
- * @brief check if a key is set in the appconfig
+ * check if a key is set in the appconfig
* @param string $app
* @param string $key
* @return bool
}
/**
- * @brief sets a value in the appconfig
+ * sets a value in the appconfig
* @param string $app app
* @param string $key key
* @param string $value value
}
/**
- * @brief Deletes a key
+ * Deletes a key
* @param string $app app
* @param string $key key
*
}
/**
- * @brief Remove app from appconfig
+ * Remove app from appconfig
* @param string $app app
*
* Removes all keys in appconfig belonging to the app.
}
/**
- * @brief Lists all available config keys
+ * Lists all available config keys
* @return array an array of key names
*
* This function returns all keys saved in config.php. Please note that it
}
/**
- * @brief Gets a value from config.php
+ * Gets a value from config.php
* @param string $key key
* @param mixed $default = null default value
* @return mixed the value or $default
}
/**
- * @brief Sets a value
+ * Sets a value
* @param string $key key
* @param mixed $value value
*
}
/**
- * @brief Removes a key from the config
+ * Removes a key from the config
* @param string $key key
*
* This function removes a key from the config.php.
class OC_Preferences{
public static $object;
/**
- * @brief Get all users using the preferences
+ * Get all users using the preferences
* @return array an array of user ids
*
* This function returns a list of all users that have at least one entry
}
/**
- * @brief Get all apps of a user
+ * Get all apps of a user
* @param string $user user
* @return integer[] with app ids
*
}
/**
- * @brief Get the available keys for an app
+ * Get the available keys for an app
* @param string $user user
* @param string $app the app we are looking for
* @return array an array of key names
}
/**
- * @brief Gets the preference
+ * Gets the preference
* @param string $user user
* @param string $app app
* @param string $key key
}
/**
- * @brief sets a value in the preferences
+ * sets a value in the preferences
* @param string $user user
* @param string $app app
* @param string $key key
}
/**
- * @brief Deletes a key
+ * Deletes a key
* @param string $user user
* @param string $app app
* @param string $key key
}
/**
- * @brief Remove app of user from preferences
+ * Remove app of user from preferences
* @param string $user user
* @param string $app app
* @return bool
}
/**
- * @brief Remove user from preferences
+ * Remove user from preferences
* @param string $user user
* @return bool
*
}
/**
- * @brief Remove app from all users
+ * Remove app from all users
* @param string $app app
* @return bool
*
private static $logger;
/**
- * @brief remove password in URLs
+ * remove password in URLs
* @param string $msg
* @return string
*/
}
/**
- * @brief finds and loads the providers
+ * finds and loads the providers
*/
static private function findProviders() {
// Find the providers
}
/**
- * @brief exports a user, or owncloud instance
+ * exports a user, or owncloud instance
* @param string $uid user id of user to export if export type is user, defaults to current
* @param string $type type of export, defualts to user
* @param string $path path to zip output folder
}
/**
- * @brief imports a user, or owncloud instance
+ * imports a user, or owncloud instance
* @param string $path path to zip
* @param string $type type of import (user or instance)
* @param string|null|int $uid userid of new user
}
/**
- * @brief recursively deletes a directory
+ * recursively deletes a directory
* @param string $dir path of dir to delete
* @param bool $deleteRootToo delete the root directory
* @return bool
}
/**
- * @brief tries to extract the import zip
+ * tries to extract the import zip
* @param string $path path to the zip
* @return string path to extract location (with a trailing slash) or false on failure
*/
}
/**
- * @brief creates a migration.db in the users data dir with their app data in
+ * creates a migration.db in the users data dir with their app data in
* @return bool whether operation was successfull
*/
private static function exportAppData( ) {
/**
- * @brief generates json containing export info, and merges any data supplied
+ * generates json containing export info, and merges any data supplied
* @param array $array of data to include in the returned json
* @return string
*/
}
/**
- * @brief connects to migration.db, or creates if not found
+ * connects to migration.db, or creates if not found
* @param string $path to migration.db, defaults to user data dir
* @return bool whether the operation was successful
*/
}
/**
- * @brief creates the tables in migration.db from an apps database.xml
+ * creates the tables in migration.db from an apps database.xml
* @param string $appid id of the app
* @return bool whether the operation was successful
*/
}
/**
- * @brief tries to create the zip
+ * tries to create the zip
* @return bool
*/
static private function createZip() {
}
/**
- * @brief returns an array of apps that support migration
+ * returns an array of apps that support migration
* @return array
*/
static public function getApps() {
}
/**
- * @brief imports a new user
+ * imports a new user
* @param string $db string path to migration.db
* @param object $info object of migration info
* @param string|null|int $uid uid to use
private $tmpfiles=array();
/**
- * @brief sets up the
+ * sets up the
* @param ZipArchive $zip ZipArchive object
* @param object $db a database object (required for exporttype user)
* @return bool|null
}
/**
- * @brief prepares the db
+ * prepares the db
* @param string $query the sql query to prepare
*/
public function prepare( $query ) {
}
/**
- * @brief processes the db query
+ * processes the db query
* @param string $query the query to process
* @return string of processed query
*/
}
/**
- * @brief copys rows to migration.db from the main database
+ * copys rows to migration.db from the main database
* @param array $options array of options.
* @return bool
*/
}
/**
- * @brief saves a sql data set into migration.db
+ * saves a sql data set into migration.db
* @param OC_DB_StatementWrapper $data a sql data set returned from self::prepare()->query()
* @param array $options array of copyRows options
* @return void
}
/**
- * @brief adds a directory to the zip object
+ * adds a directory to the zip object
* @param boolean|string $dir string path of the directory to add
* @param bool $recursive
* @param string $internaldir path of folder to add dir to in zip
}
/**
- * @brief adds a file to the zip from a given string
+ * adds a file to the zip from a given string
* @param string $data string of data to add
* @param string $path the relative path inside of the zip to save the file to
* @return bool
}
/**
- * @brief closes the zip, removes temp files
+ * closes the zip, removes temp files
* @return bool
*/
public function finish() {
}
/**
- * @brief cleans up after the zip
+ * cleans up after the zip
*/
private function cleanup() {
// Delete tmp files
}
/**
- * @brief exports data for apps
+ * exports data for apps
* @return array appdata to be exported
*/
abstract function export( );
/**
- * @brief imports data for the app
+ * imports data for the app
* @return void
*/
abstract function import( );
/**
- * @brief sets the OC_Migration_Content object to $this->content
+ * sets the OC_Migration_Content object to $this->content
* @param OC_Migration_Content $content a OC_Migration_Content object
*/
public function setData( $uid, $content, $info=null ) {
}
/**
- * @brief returns the appid of the provider
+ * returns the appid of the provider
* @return string
*/
public function getID() {
}
/**
- * @brief returns all the added Menu entries
+ * returns all the added Menu entries
* @return array an array of the added entries
*/
public function getAll() {
}
/**
- * @brief removes all the entries
+ * removes all the entries
*/
public function clear() {
$this->entries = array();
}
/**
- * @brief gets the active Menu entry
+ * gets the active Menu entry
* @return string id or empty string
*
* This function returns the id of the active navigation entry (set by
class OC_OCSClient{
/**
- * @brief Get the url of the OCS AppStore server.
+ * Get the url of the OCS AppStore server.
* @return string of the AppStore server
*
* This function returns the url of the OCS AppStore server. It´s possible
/**
- * @brief Get the content of an OCS url call.
+ * Get the content of an OCS url call.
* @return string of the response
* This function calls an OCS server and returns the response. It also sets a sane timeout
* @param string $url
}
/**
- * @brief Get all the categories from the OCS server
+ * Get all the categories from the OCS server
* @return array an array of category ids
* @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
}
/**
- * @brief Get all the applications from the OCS server
+ * Get all the applications from the OCS server
* @return array an array of application data
*
* This function returns a list of all the applications on the OCS server
/**
- * @brief Get an the applications from the OCS server
+ * Get an the applications from the OCS server
* @param string $id
* @return array an array of application data
*
}
/**
- * @brief Get the download url for an application from the OCS server
+ * Get the download url for an application from the OCS server
* @return array an array of application data
*
* This function returns an download url for an applications from the OCS server
}
/**
- * @brief Get all users using the preferences
+ * Get all users using the preferences
* @return array an array of user ids
*
* This function returns a list of all users that have at least one entry
}
/**
- * @brief Get all apps of an user
+ * Get all apps of an user
* @param string $user user
* @return integer[] with app ids
*
}
/**
- * @brief Get the available keys for an app
+ * Get the available keys for an app
* @param string $user user
* @param string $app the app we are looking for
* @return array an array of key names
}
/**
- * @brief Gets the preference
+ * Gets the preference
* @param string $user user
* @param string $app app
* @param string $key key
}
/**
- * @brief sets a value in the preferences
+ * sets a value in the preferences
* @param string $user user
* @param string $app app
* @param string $key key
}
/**
- * @brief Deletes a key
+ * Deletes a key
* @param string $user user
* @param string $app app
* @param string $key key
}
/**
- * @brief Remove app of user from preferences
+ * Remove app of user from preferences
* @param string $user user
* @param string $app app
*
}
/**
- * @brief Remove user from preferences
+ * Remove user from preferences
* @param string $user user
*
* Removes all keys in preferences belonging to the user.
}
/**
- * @brief Remove app from all users
+ * Remove app from all users
* @param string $app app
*
* Removes all keys in preferences belonging to the app.
protected $info;
/**
- * @brief check if thumbnail or bigger version of thumbnail of file is cached
+ * check if thumbnail or bigger version of thumbnail of file is cached
* @param string $user userid - if no user is given, OC_User::getUser will be used
* @param string $root path of root
* @param string $file The path to the file where you want a thumbnail from
}
/**
- * @brief returns the path of the file you want a thumbnail from
+ * returns the path of the file you want a thumbnail from
* @return string
*/
public function getFile() {
}
/**
- * @brief returns the max width of the preview
+ * returns the max width of the preview
* @return integer
*/
public function getMaxX() {
}
/**
- * @brief returns the max height of the preview
+ * returns the max height of the preview
* @return integer
*/
public function getMaxY() {
}
/**
- * @brief returns whether or not scalingup is enabled
+ * returns whether or not scalingup is enabled
* @return bool
*/
public function getScalingUp() {
}
/**
- * @brief returns the name of the thumbnailfolder
+ * returns the name of the thumbnailfolder
* @return string
*/
public function getThumbnailsFolder() {
}
/**
- * @brief returns the max scale factor
+ * returns the max scale factor
* @return string
*/
public function getMaxScaleFactor() {
}
/**
- * @brief returns the max width set in ownCloud's config
+ * returns the max width set in ownCloud's config
* @return string
*/
public function getConfigMaxX() {
}
/**
- * @brief returns the max height set in ownCloud's config
+ * returns the max height set in ownCloud's config
* @return string
*/
public function getConfigMaxY() {
}
/**
- * @brief set the path of the file you want a thumbnail from
+ * set the path of the file you want a thumbnail from
* @param string $file
* @return \OC\Preview $this
*/
}
/**
- * @brief set mime type explicitly
+ * set mime type explicitly
* @param string $mimeType
*/
public function setMimetype($mimeType) {
}
/**
- * @brief set the the max width of the preview
+ * set the the max width of the preview
* @param int $maxX
* @throws \Exception
* @return \OC\Preview $this
}
/**
- * @brief set the the max height of the preview
+ * set the the max height of the preview
* @param int $maxY
* @throws \Exception
* @return \OC\Preview $this
}
/**
- * @brief set whether or not scalingup is enabled
+ * set whether or not scalingup is enabled
* @param bool $scalingUp
* @return \OC\Preview $this
*/
}
/**
- * @brief check if all parameters are valid
+ * check if all parameters are valid
* @return bool
*/
public function isFileValid() {
}
/**
- * @brief deletes previews of a file with specific x and y
+ * deletes previews of a file with specific x and y
* @return bool
*/
public function deletePreview() {
}
/**
- * @brief deletes all previews of a file
+ * deletes all previews of a file
* @return bool
*/
public function deleteAllPreviews() {
}
/**
- * @brief check if thumbnail or bigger version of thumbnail of file is cached
+ * check if thumbnail or bigger version of thumbnail of file is cached
* @param int $fileId fileId of the original image
* @return string|false path to thumbnail if it exists or false
*/
}
/**
- * @brief check if a bigger version of thumbnail of file is cached
+ * check if a bigger version of thumbnail of file is cached
* @param int $fileId fileId of the original image
* @return string|false path to bigger thumbnail if it exists or false
*/
}
/**
- * @brief get possible bigger thumbnails of the given image
+ * get possible bigger thumbnails of the given image
* @param int $fileId fileId of the original image
* @return array an array of paths to bigger thumbnails
*/
* @return bool
*/
private function unscalable($x, $y) {
-
+
$maxX = $this->getMaxX();
$maxY = $this->getMaxY();
$scalingUp = $this->getScalingUp();
$maxScaleFactor = $this->getMaxScaleFactor();
-
+
if ($x < $maxX || $y < $maxY) {
if ($scalingUp) {
$scalefactor = $maxX / $x;
}
/**
- * @brief return a preview of a file
+ * return a preview of a file
* @return \OC_Image
*/
public function getPreview() {
}
/**
- * @brief show preview
+ * show preview
* @return void
*/
public function showPreview($mimeType = null) {
}
/**
- * @brief resize, crop and fix orientation
+ * resize, crop and fix orientation
* @return void
*/
private function resizeAndCrop() {
}
/**
- * @brief register a new preview provider to be used
+ * register a new preview provider to be used
* @param array $options
* @return void
*/
}
/**
- * @brief create instances of all the registered preview providers
+ * create instances of all the registered preview providers
* @return void
*/
private static function initProviders() {
class PreviewManager implements IPreview {
/**
- * @brief return a preview of a file
+ * return a preview of a file
* @param string $file The path to the file where you want a thumbnail from
* @param int $maxX The maximum X size of the thumbnail. It can be smaller depending on the shape of the image
* @param int $maxY The maximum Y size of the thumbnail. It can be smaller depending on the shape of the image
}
/**
- * @brief returns true if the passed mime type is supported
+ * returns true if the passed mime type is supported
* @param string $mimeType
* @return boolean
*/
const REGEX_LOCALHOST = '/^(127\.0\.0\.1|localhost)(:[0-9]+|)$/';
/**
- * @brief Check overwrite condition
+ * Check overwrite condition
* @param string $type
* @return bool
*/
}
/**
- * @brief Checks whether a domain is considered as trusted from the list
+ * Checks whether a domain is considered as trusted from the list
* of trusted domains. If no trusted domains have been configured, returns
* true.
* This is used to prevent Host Header Poisoning.
}
/**
- * @brief Returns the unverified server host from the headers without checking
+ * Returns the unverified server host from the headers without checking
* whether it is a trusted domain
* @return string the server host
*
}
/**
- * @brief Returns the server host from the headers, or the first configured
+ * Returns the server host from the headers, or the first configured
* trusted domain if the host isn't in the trusted list
* @return string the server host
*
}
/**
- * @brief Returns the server protocol
+ * Returns the server protocol
* @return string the server protocol
*
* Returns the server protocol. It respects reverse proxy servers and load balancers
}
/**
- * @brief Returns the request uri
+ * Returns the request uri
* @return string the request uri
*
* Returns the request uri, even if the website uses one or more
}
/**
- * @brief Returns the script name
+ * Returns the script name
* @return string the script name
*
* Returns the script name, even if the website uses one or more
}
/**
- * @brief get Path info from request
+ * get Path info from request
* @return string Path info or false when not found
*/
public static function getPathInfo() {
}
/**
- * @brief get Path info from request, not urldecoded
+ * get Path info from request, not urldecoded
* @throws Exception
* @return string Path info or false when not found
*/
}
/**
- * @brief Check if the requester sent along an mtime
+ * Check if the requester sent along an mtime
* @return false or an mtime
*/
static public function hasModificationTime () {
const STATUS_SERVICE_UNAVAILABLE = 503;
/**
- * @brief Enable response caching by sending correct HTTP headers
+ * Enable response caching by sending correct HTTP headers
* @param integer $cache_time time to cache the response
* >0 cache time in seconds
* 0 and <0 enable default browser caching
}
/**
- * @brief disable browser caching
+ * disable browser caching
* @see enableCaching with cache_time = 0
*/
static public function disableCaching() {
}
/**
- * @brief Set response status
+ * Set response status
* @param int $status a HTTP status code, see also the STATUS constants
*/
static public function setStatus($status) {
}
/**
- * @brief Send redirect response
+ * Send redirect response
* @param string $location to redirect to
*/
static public function redirect($location) {
}
/**
- * @brief Set reponse expire time
+ * Set reponse expire time
* @param string|DateTime $expires date-time when the response expires
* string for DateInterval from now
* DateTime object when to expire response
}
/**
- * @brief Send file as response, checking and setting caching headers
+ * Send file as response, checking and setting caching headers
* @param string $filepath of file to send
*/
static public function sendFile($filepath) {
}
/**
- * @brief Post installation checks
+ * Post installation checks
*/
public static function postSetupCheck($params) {
// setup was successful -> webdav testing now
}
/**
- * @brief get default expire settings defined by the admin
+ * get default expire settings defined by the admin
* @return array contains 'defaultExpireDateSet', 'enforceExpireDate', 'expireAfterDays'
*/
public static function getDefaultExpireSetting() {
}
/**
- * @brief calculate expire date
+ * calculate expire date
* @param array $defaultExpireSettings contains 'defaultExpireDateSet', 'enforceExpireDate', 'expireAfterDays'
* @param int $creationTime timestamp when the share was created
* @param int $userExpireDate expire timestamp set by the user
}
/**
- * @brief inform users if a file was shared with them
+ * inform users if a file was shared with them
*
* @param array $recipientList list of recipients
* @param string $itemSource shared item source
}
/**
- * @brief inform recipient about public link share
+ * inform recipient about public link share
*
* @param string $recipient recipient email address
* @param string $filename the shared file
}
/**
- * @brief create mail body for plain text and html mail
+ * create mail body for plain text and html mail
*
* @param string $filename the shared file
* @param string $link link to the shared file
}
/**
- * @brief construct select statement
+ * construct select statement
* @param int $format
* @param boolean $fileDependent ist it a file/folder share or a generla share
* @param string $uidOwner
/**
- * @brief transform db results
+ * transform db results
* @param array $row result
*/
private static function transformDBResults(&$row) {
}
/**
- * @brief format result
+ * format result
* @param array $items result
* @param string $column is it a file share or a general share ('file_target' or 'item_target')
* @param \OCP\Share_Backend $backend sharing backend
class OC_SubAdmin{
/**
- * @brief add a SubAdmin
+ * add a SubAdmin
* @param string $uid uid of the SubAdmin
* @param string $gid gid of the group
* @return boolean
}
/**
- * @brief delete a SubAdmin
+ * delete a SubAdmin
* @param string $uid uid of the SubAdmin
* @param string $gid gid of the group
* @return boolean
}
/**
- * @brief get groups of a SubAdmin
+ * get groups of a SubAdmin
* @param string $uid uid of the SubAdmin
* @return array
*/
}
/**
- * @brief get SubAdmins of a group
+ * get SubAdmins of a group
* @param string $gid gid of the group
* @return array
*/
}
/**
- * @brief get all SubAdmins
+ * get all SubAdmins
* @return array
*/
public static function getAllSubAdmins() {
}
/**
- * @brief checks if a user is a SubAdmin of a group
+ * checks if a user is a SubAdmin of a group
* @param string $uid uid of the subadmin
* @param string $gid gid of the group
* @return bool
}
/**
- * @brief checks if a user is a SubAdmin
+ * checks if a user is a SubAdmin
* @param string $uid uid of the subadmin
* @return bool
*/
}
/**
- * @brief checks if a user is a accessible by a subadmin
+ * checks if a user is a accessible by a subadmin
* @param string $subadmin uid of the subadmin
* @param string $user uid of the user
* @return bool
}
/*
- * @brief alias for self::isSubAdminofGroup()
+ * alias for self::isSubAdminofGroup()
*/
public static function isGroupAccessible($subadmin, $group) {
return self::isSubAdminofGroup($subadmin, $group);
}
/**
- * @brief delete all SubAdmins by uid
+ * delete all SubAdmins by uid
* @param array $parameters
* @return boolean
*/
}
/**
- * @brief delete all SubAdmins by gid
+ * delete all SubAdmins by gid
* @param array $parameters
* @return boolean
*/
protected $app; // app id
/**
- * @brief Constructor
+ * Constructor
* @param string $app app providing the template
* @param string $name of the template file (without suffix)
* @param string $renderas = ""; produce a full page
}
/**
- * @brief Returns the formfactor extension for current formfactor
+ * Returns the formfactor extension for current formfactor
*/
static public function getFormFactorExtension()
{
}
/**
- * @brief find the template with the given name
+ * find the template with the given name
* @param string $name of the template file (without suffix)
*
* Will select the template file for the selected theme and formfactor.
}
/**
- * @brief Add a custom element to the header
+ * Add a custom element to the header
* @param string $tag tag name of the element
* @param array $attributes array of attributes for the element
* @param string $text the text content for the element
}
/**
- * @brief Process the template
+ * Process the template
* @return boolean|string
*
* This function process the template. If $this->renderas is set, it
}
/**
- * @brief Include template
+ * Include template
* @return string returns content of included template
*
* Includes another template. use <?php echo $this->inc('template'); ?> to
}
/**
- * @brief Shortcut to print a simple page for users
+ * Shortcut to print a simple page for users
* @param string $application The application we render the template for
* @param string $name Name of the template
* @param array $parameters Parameters for the template
}
/**
- * @brief Shortcut to print a simple page for admins
+ * Shortcut to print a simple page for admins
* @param string $application The application we render the template for
* @param string $name Name of the template
* @param array $parameters Parameters for the template
}
/**
- * @brief Shortcut to print a simple page for guests
+ * Shortcut to print a simple page for guests
* @param string $application The application we render the template for
* @param string $name Name of the template
* @param array|string $parameters Parameters for the template
}
/**
- * @brief Print a fatal error page and terminates the script
+ * Print a fatal error page and terminates the script
* @param string $error_msg The error message to show
* @param string $hint An optional hint message
* Warning: All data passed to $hint needs to get sanitized using OC_Util::sanitizeHTML
$content->printPage();
die();
}
-
+
/**
* print error page using Exception details
* @param Exception $exception
}
/**
- * @brief Assign variables
+ * Assign variables
* @param string $key key
* @param array|bool|integer|string $value value
* @return bool
}
/**
- * @brief Appends a variable
+ * Appends a variable
* @param string $key key
* @param mixed $value value
* @return boolean|null
}
/**
- * @brief Prints the proceeded template
+ * Prints the proceeded template
* @return bool
*
* This function proceeds the template and prints its output.
}
/**
- * @brief Process the template
+ * Process the template
* @return string
*
* This function processes the template.
}
/**
- * @brief doing the actual work
+ * doing the actual work
* @param string $file
* @return string content
*
}
/**
- * @brief make OC_Helper::linkTo available as a simple function
+ * make OC_Helper::linkTo available as a simple function
* @param string $app app
* @param string $file file
* @param array $args array with param=>value, will be appended to the returned url
}
/**
- * @brief make OC_Helper::imagePath available as a simple function
+ * make OC_Helper::imagePath available as a simple function
* @param string $app app
* @param string $image image
* @return string link to the image
}
/**
- * @brief make OC_Helper::mimetypeIcon available as a simple function
+ * make OC_Helper::mimetypeIcon available as a simple function
* @param string $mimetype mimetype
* @return string link to the image
*
}
/**
- * @brief make preview_icon available as a simple function
+ * make preview_icon available as a simple function
* Returns the path to the preview of the image.
* @param string $path path of file
* @return link to the preview
}
/**
- * @brief make OC_Helper::humanFileSize available as a simple function
+ * make OC_Helper::humanFileSize available as a simple function
* @param int $bytes size in bytes
* @return string size as string
*
}
/**
- * @brief Strips the timestamp of its time value
+ * Strips the timestamp of its time value
* @param int $timestamp UNIX timestamp to strip
* @return $timestamp without time value
*/
}
/**
- * @brief Formats timestamp relatively to the current time using
+ * Formats timestamp relatively to the current time using
* a human-friendly format like "x minutes ago" or "yesterday"
* @param int $timestamp timestamp to format
* @param int $fromTime timestamp to compare from, defaults to current time
}
/*
- * @brief append the $file resource if exist at $root
+ * append the $file resource if exist at $root
* @param string $root path to check
* @param string $file the filename
* @param string|null $webroot base for path, default map $root to $webroot
}
/**
- * @brief Creates an url using a defined route
+ * Creates an url using a defined route
* @param string $route
* @param array $parameters
* @internal param array $args with param=>value, will be appended to the returned url
}
/**
- * @brief Creates an url
+ * Creates an url
* @param string $app app
* @param string $file file
* @param array $args array with param=>value, will be appended to the returned url
}
/**
- * @brief Creates path to an image
+ * Creates path to an image
* @param string $app app
* @param string $image image name
* @throws \RuntimeException If the image does not exist
private static $incognitoMode = false;
/**
- * @brief registers backend
+ * registers backend
* @param string $backend name of the backend
* @deprecated Add classes by calling useBackend with a class instance instead
* @return bool
}
/**
- * @brief gets available backends
+ * gets available backends
* @deprecated
* @return array an array of backends
*
}
/**
- * @brief gets used backends
+ * gets used backends
* @deprecated
* @return array an array of backends
*
}
/**
- * @brief Adds the backend to the list of used backends
+ * Adds the backend to the list of used backends
* @param string|OC_User_Interface $backend default: database The backend to use for user management
* @return bool
*
}
/**
- * @brief Create a new user
+ * Create a new user
* @param string $uid The username of the user to create
* @param string $password The password of the new user
* @throws Exception
}
/**
- * @brief delete a user
+ * delete a user
* @param string $uid The username of the user to delete
* @return bool
*
}
/**
- * @brief Try to login a user
+ * Try to login a user
* @param string $uid The username of the user to log in
* @param string $password The password of the user
* @return boolean|null
}
/**
- * @brief Try to login a user, assuming authentication
+ * Try to login a user, assuming authentication
* has already happened (e.g. via Single Sign On).
*
* Log in a user and regenerate a new session.
}
/**
- * @brief Verify with Apache whether user is authenticated.
+ * Verify with Apache whether user is authenticated.
*
* @return boolean|null
* true: authenticated
/**
- * @brief Sets user id for session and triggers emit
+ * Sets user id for session and triggers emit
*/
public static function setUserId($uid) {
OC::$session->set('user_id', $uid);
}
/**
- * @brief Sets user display name for session
+ * Sets user display name for session
* @param string $uid
* @param null $displayName
* @return bool Whether the display name could get set
}
/**
- * @brief Logs the current user out and kills all the session data
+ * Logs the current user out and kills all the session data
*
* Logout, destroys session
*/
}
/**
- * @brief Check if the user is logged in
+ * Check if the user is logged in
* @return bool
*
* Checks if the user is logged in
}
/**
- * @brief set incognito mode, e.g. if a user wants to open a public link
+ * set incognito mode, e.g. if a user wants to open a public link
* @param bool $status
*/
public static function setIncognitoMode($status) {
}
/**
- * @brief Check if the user is an admin user
+ * Check if the user is an admin user
* @param string $uid uid of the admin
* @return bool
*/
/**
- * @brief get the user id of the user currently logged in.
+ * get the user id of the user currently logged in.
* @return string uid or false
*/
public static function getUser() {
}
/**
- * @brief get the display name of the user currently logged in.
+ * get the display name of the user currently logged in.
* @param string $uid
* @return string uid or false
*/
}
/**
- * @brief Autogenerate a password
+ * Autogenerate a password
* @return string
*
* generates a password
}
/**
- * @brief Set password
+ * Set password
* @param string $uid The username
* @param string $password The new password
* @param string $recoveryPassword for the encryption app to reset encryption keys
}
/**
- * @brief Check whether user can change his avatar
+ * Check whether user can change his avatar
* @param string $uid The username
* @return bool
*
}
/**
- * @brief Check whether user can change his password
+ * Check whether user can change his password
* @param string $uid The username
* @return bool
*
}
/**
- * @brief Check whether user can change his display name
+ * Check whether user can change his display name
* @param string $uid The username
* @return bool
*
}
/**
- * @brief Check if the password is correct
+ * Check if the password is correct
* @param string $uid The username
* @param string $password The password
* @return string|false user id a string on success, false otherwise
}
/**
- * @brief Get a list of all users
+ * Get a list of all users
* @return array an array of all uids
*
* Get a list of all users.
}
/**
- * @brief Get a list of all users display name
+ * Get a list of all users display name
* @param string $search
* @param int $limit
* @param int $offset
}
/**
- * @brief check if a user exists
+ * check if a user exists
* @param string $uid the username
* @return boolean
*/
}
/**
- * @brief Set cookie value to use in next page load
+ * Set cookie value to use in next page load
* @param string $username username to be set
* @param string $token
*/
}
/**
- * @brief Remove cookie for "remember username"
+ * Remove cookie for "remember username"
*/
public static function unsetMagicInCookie() {
self::getUserSession()->unsetMagicInCookie();
}
/**
- * @brief Returns the first active backend from self::$_usedBackends.
+ * Returns the first active backend from self::$_usedBackends.
* @return OCP\Authentication\IApacheBackend|null if no backend active, otherwise OCP\Authentication\IApacheBackend
*/
private static function findFirstActiveUsedBackend() {
);
/**
- * @brief Get all supported actions
+ * Get all supported actions
* @return int bitwise-or'ed actions
*
* Returns the supported actions as int to be
}
/**
- * @brief Check if backend implements actions
+ * Check if backend implements actions
* @param int $actions bitwise-or'ed actions
* @return boolean
*
}
/**
- * @brief delete a user
+ * delete a user
* @param string $uid The username of the user to delete
* @return bool
*
}
/**
- * @brief Get a list of all users
+ * Get a list of all users
* @return array an array of all uids
*
* Get a list of all users.
}
/**
- * @brief check if a user exists
+ * check if a user exists
* @param string $uid the username
* @return boolean
*/
}
/**
- * @brief get the user's home directory
+ * get the user's home directory
* @param string $uid the username
* @return boolean
*/
}
/**
- * @brief get display name of the user
+ * get display name of the user
* @param string $uid user ID of the user
* @return string display name
*/
}
/**
- * @brief Get a list of all display names
+ * Get a list of all display names
* @return array an array of all displayNames (value) and the corresponding uids (key)
*
* Get a list of all display names and user ids.
}
/**
- * @brief Check if a user list is available or not
+ * Check if a user list is available or not
* @return boolean if users can be listed or not
*/
public function hasUserListings() {
}
/**
- * @brief Create a new user
+ * Create a new user
* @param string $uid The username of the user to create
* @param string $password The password of the new user
* @return bool
}
/**
- * @brief delete a user
+ * delete a user
* @param string $uid The username of the user to delete
* @return bool
*
}
/**
- * @brief Set password
+ * Set password
* @param string $uid The username
* @param string $password The new password
* @return bool
}
/**
- * @brief Set display name
+ * Set display name
* @param string $uid The username
* @param string $displayName The new display name
* @return bool
}
/**
- * @brief get display name of the user
+ * get display name of the user
* @param string $uid user ID of the user
* @return string display name
*/
}
/**
- * @brief Get a list of all display names
+ * Get a list of all display names
* @return array an array of all displayNames (value) and the correspondig uids (key)
*
* Get a list of all display names and user ids.
}
/**
- * @brief Check if the password is correct
+ * Check if the password is correct
* @param string $uid The username
* @param string $password The password
* @return string
}
/**
- * @brief Load an user in the cache
+ * Load an user in the cache
* @param string $uid the username
* @return boolean
*/
}
/**
- * @brief Get a list of all users
+ * Get a list of all users
* @return array an array of all uids
*
* Get a list of all users.
}
/**
- * @brief check if a user exists
+ * check if a user exists
* @param string $uid the username
* @return boolean
*/
}
/**
- * @brief get the user's home directory
+ * get the user's home directory
* @param string $uid the username
* @return string|false
*/
private $users = array();
/**
- * @brief Create a new user
+ * Create a new user
* @param string $uid The username of the user to create
* @param string $password The password of the new user
* @return bool
}
/**
- * @brief delete a user
+ * delete a user
* @param string $uid The username of the user to delete
* @return bool
*
}
/**
- * @brief Set password
+ * Set password
* @param string $uid The username
* @param string $password The new password
* @return bool
}
/**
- * @brief Check if the password is correct
+ * Check if the password is correct
* @param string $uid The username
* @param string $password The password
* @return string
}
/**
- * @brief Get a list of all users
+ * Get a list of all users
* @param string $search
* @param int $limit
* @param int $offset
}
/**
- * @brief check if a user exists
+ * check if a user exists
* @param string $uid the username
* @return boolean
*/
*/
abstract class OC_User_Example extends OC_User_Backend {
/**
- * @brief Create a new user
+ * Create a new user
* @param string $uid The username of the user to create
* @param string $password The password of the new user
* @return bool
abstract public function createUser($uid, $password);
/**
- * @brief Set password
+ * Set password
* @param string $uid The username
* @param string $password The new password
* @return bool
abstract public function setPassword($uid, $password);
/**
- * @brief Check if the password is correct
+ * Check if the password is correct
* @param string $uid The username
* @param string $password The password
* @return string
abstract public function checkPassword($uid, $password);
/**
- * @brief get the user's home directory
+ * get the user's home directory
* @param string $uid The username
* @return string
*
}
/**
- * @brief Check if the password is correct
+ * Check if the password is correct
* @param string $uid The username
* @param string $password The password
* @return string
}
/**
- * @brief check if a user exists
+ * check if a user exists
* @param string $uid the username
* @return boolean
*/
}
/**
- * @brief get the user's home directory
+ * get the user's home directory
* @param string $uid the username
* @return string|false
*/
interface OC_User_Interface {
/**
- * @brief Check if backend implements actions
+ * Check if backend implements actions
* @param $actions bitwise-or'ed actions
* @return boolean
*
public function implementsActions($actions);
/**
- * @brief delete a user
+ * delete a user
* @param string $uid The username of the user to delete
* @return bool
*/
public function deleteUser($uid);
/**
- * @brief Get a list of all users
+ * Get a list of all users
* @return array an array of all uids
*
* Get a list of all users.
public function getUsers($search = '', $limit = null, $offset = null);
/**
- * @brief check if a user exists
+ * check if a user exists
* @param string $uid the username
* @return boolean
*/
public function userExists($uid);
/**
- * @brief get display name of the user
+ * get display name of the user
* @param string $uid user ID of the user
* @return string display name
*/
public function getDisplayName($uid);
/**
- * @brief Get a list of all display names
+ * Get a list of all display names
* @return array an array of all displayNames (value) and the corresponding uids (key)
*
* Get a list of all display names and user ids.
public function getDisplayNames($search = '', $limit = null, $offset = null);
/**
- * @brief Check if a user list is available or not
+ * Check if a user list is available or not
* @return boolean if users can be listed or not
*/
public function hasUserListings();
private static $fsSetup=false;
/**
- * @brief Can be set up
+ * Can be set up
* @param string $user
* @return boolean
* @description configure the initial filesystem based on the configuration
}
/**
- * @brief check if a password is required for each public link
+ * check if a password is required for each public link
* @return boolean
*/
public static function isPublicLinkPasswordRequired() {
}
/**
- * @brief copies the user skeleton files into the fresh user home files
+ * copies the user skeleton files into the fresh user home files
* @param string $userDirectory
*/
public static function copySkeleton($userDirectory) {
}
/**
- * @brief copies a directory recursively
+ * copies a directory recursively
* @param string $source
* @param string $target
* @return void
}
/**
- * @brief get the current installed version of ownCloud
+ * get the current installed version of ownCloud
* @return array
*/
public static function getVersion() {
}
/**
- * @brief get the current installed version string of ownCloud
+ * get the current installed version string of ownCloud
* @return string
*/
public static function getVersionString() {
}
/**
- * @brief add a javascript file
+ * add a javascript file
*
* @param string $application
* @param string|null $file filename
}
/**
- * @brief add a css file
+ * add a css file
*
* @param string $application
* @param string|null $file filename
}
/**
- * @brief Add a custom element to the header
+ * Add a custom element to the header
* @param string $tag tag name of the element
* @param array $attributes array of attributes for the element
* @param string $text the text content for the element
}
/**
- * @brief formats a timestamp in the "right" way
+ * formats a timestamp in the "right" way
*
* @param int $timestamp
* @param bool $dateOnly option to omit time from the result
}
/**
- * @brief check if the current server configuration is suitable for ownCloud
+ * check if the current server configuration is suitable for ownCloud
* @return array arrays with error messages and hints
*/
public static function checkServer() {
/**
- * @brief check if there are still some encrypted files stored
+ * check if there are still some encrypted files stored
* @return boolean
*/
public static function encryptedFiles() {
}
/**
- * @brief check if a backup from the encryption keys exists
+ * check if a backup from the encryption keys exists
* @return boolean
*/
public static function backupKeysExists() {
}
/**
- * @brief Check for correct file permissions of data directory
+ * Check for correct file permissions of data directory
* @param string $dataDirectory
* @return array arrays with error messages and hints
*/
/**
- * @brief Check if the app is enabled, redirects to home if not
+ * Check if the app is enabled, redirects to home if not
* @param string $app
* @return void
*/
}
/**
- * @brief Check if the user is a admin, redirects to home if not
+ * Check if the user is a admin, redirects to home if not
* @return void
*/
public static function checkAdminUser() {
}
/**
- * @brief Check if the user is a subadmin, redirects to home if not
+ * Check if the user is a subadmin, redirects to home if not
* @return null|boolean $groups where the current user is subadmin
*/
public static function checkSubAdminUser() {
}
/**
- * @brief Redirect to the user default page
+ * Redirect to the user default page
* @return void
*/
public static function redirectToDefaultPage() {
}
/**
- * @brief get an id unique for this instance
+ * get an id unique for this instance
* @return string
*/
public static function getInstanceId() {
}
/**
- * @brief Static lifespan (in seconds) when a request token expires.
+ * Static lifespan (in seconds) when a request token expires.
* @see OC_Util::callRegister()
* @see OC_Util::isCallRegistered()
* @description
public static $callLifespan = 3600; // 3600 secs = 1 hour
/**
- * @brief Register an get/post call. Important to prevent CSRF attacks.
+ * Register an get/post call. Important to prevent CSRF attacks.
* @todo Write howto: CSRF protection guide
* @return string Generated token.
* @description
}
/**
- * @brief Check an ajax get/post call if the request token is valid.
+ * Check an ajax get/post call if the request token is valid.
* @return boolean False if request token is not set or is invalid.
* @see OC_Util::$callLifespan
* @see OC_Util::callRegister()
}
/**
- * @brief Check an ajax get/post call if the request token is valid. Exit if not.
+ * Check an ajax get/post call if the request token is valid. Exit if not.
* @todo Write howto
* @return void
*/
}
/**
- * @brief Public function to sanitize HTML
+ * Public function to sanitize HTML
*
* 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.
}
/**
- * @brief Public function to encode url parameters
+ * Public function to encode url parameters
*
* This function is used to encode path to file before output.
* Encoding is done according to RFC 3986 with one exception:
}
/**
- * @brief Check if the .htaccess file is working
+ * Check if the .htaccess file is working
* @throws OC\HintException If the testfile can't get written.
* @return bool
* @description Check if the .htaccess file is working by creating a test
}
/**
- * @brief test if webDAV is working properly
+ * test if webDAV is working properly
* @return bool
* @description
* The basic assumption is that if the server returns 401/Not Authenticated for an unauthenticated PROPFIND
}
/**
- * @brief Check if the PHP module fileinfo is loaded.
+ * Check if the PHP module fileinfo is loaded.
* @return bool
*/
public static function fileInfoLoaded() {
}
/**
- * @brief Check if a PHP version older then 5.3.8 is installed.
+ * Check if a PHP version older then 5.3.8 is installed.
* @return bool
*/
public static function isPHPoutdated() {
}
/**
- * @brief Check if the ownCloud server can connect to the internet
+ * Check if the ownCloud server can connect to the internet
* @return bool
*/
public static function isInternetConnectionWorking() {
}
/**
- * @brief Check if the connection to the internet is disabled on purpose
+ * Check if the connection to the internet is disabled on purpose
* @return string
*/
public static function isInternetConnectionEnabled(){
}
/**
- * @brief clear all levels of output buffering
+ * clear all levels of output buffering
* @return void
*/
public static function obEnd(){
/**
- * @brief Generates a cryptographic secure pseudo-random string
+ * Generates a cryptographic secure pseudo-random string
* @param int $length of the random string
* @return string
* Please also update secureRNGAvailable if you change something here
}
/**
- * @brief Checks if a secure random number generator is available
+ * Checks if a secure random number generator is available
* @return bool
*/
public static function secureRNGAvailable() {
}
/**
- * @brief Clear the opcode cache if one exists
+ * Clear the opcode cache if one exists
* This is necessary for writing to the config file
* in case the opcode cache does not re-validate files
* @return void
}
/**
- * @brief Parses the VObject
+ * Parses the VObject
* @param string $data VObject as string
* @return Sabre\VObject\Reader|null
*/
}
/**
- * @brief Escapes semicolons
+ * Escapes semicolons
* @param array $value
* @return string
*/
}
/**
- * @brief Creates an array out of a multivalue property
+ * Creates an array out of a multivalue property
* @param string $value
* @return array
*/
}
/**
- * @brief Add property to vobject
+ * Add property to vobject
* @param object $name of property
* @param object $value of property
* @param array|object $parameters of property
*/
interface IAppConfig {
/**
- * @brief check if a key is set in the appconfig
+ * check if a key is set in the appconfig
* @param string $app
* @param string $key
* @return bool
public function hasKey($app, $key);
/**
- * @brief Gets the config value
+ * Gets the config value
* @param string $app app
* @param string $key key
* @param string $default = null, default value if the key does not exist
public function getValue($app, $key, $default = null);
/**
- * @brief Deletes a key
+ * Deletes a key
* @param string $app app
* @param string $key key
* @return bool
public function deleteKey($app, $key);
/**
- * @brief Get the available keys for an app
+ * Get the available keys for an app
* @param string $app the app we are looking for
* @return array an array of key names
*
public function getValues($app, $key);
/**
- * @brief sets a value in the appconfig
+ * sets a value in the appconfig
* @param string $app app
* @param string $key key
* @param string $value value
public function setValue($app, $key, $value);
/**
- * @brief Get all apps using the config
+ * Get all apps using the config
* @return array an array of app ids
*
* This function returns a list of all apps that have at least one
public function getApps();
/**
- * @brief Remove app from appconfig
+ * Remove app from appconfig
* @param string $app app
* @return bool
*
interface IAvatar {
/**
- * @brief get the users avatar
+ * get the users avatar
* @param int $size size in px of the avatar, avatars are square, defaults to 64
* @return boolean|\OC_Image containing the avatar or false if there's no image
*/
function get($size = 64);
/**
- * @brief sets the users avatar
+ * sets the users avatar
* @param Image $data mixed imagedata or path to set a new avatar
* @throws Exception if the provided file is not a jpg or png image
* @throws Exception if the provided image is not valid
function set($data);
/**
- * @brief remove the users avatar
+ * remove the users avatar
* @return void
*/
function remove();
interface IAvatarManager {
/**
- * @brief return a user specific instance of \OCP\IAvatar
+ * return a user specific instance of \OCP\IAvatar
* @see \OCP\IAvatar
* @param string $user the ownCloud user id
* @return \OCP\IAvatar
/**
- * @brief find the best language
+ * find the best language
* @param array|string $app details below
- * @returns string language
+ * @return string language
*
* If $app is an array, ownCloud assumes that these are the available
* languages. Otherwise ownCloud tries to find the files in the l10n
}
/**
- * @brief Generates a cryptographic secure pseudo-random string
+ * Generates a cryptographic secure pseudo-random string
* @param int $length of the random string
* @return string
*/
}
/**
- * @brief check if a password is required for each public link
+ * check if a password is required for each public link
* @return boolean
*/
public static function isPublicLinkPasswordRequired() {
class Test_ErrorHandler extends \PHPUnit_Framework_TestCase {
/**
- * @brief provide username, password combinations for testRemovePassword
+ * provide username, password combinations for testRemovePassword
* @return array
*/
function passwordProvider() {
}
/**
- * @brief dummy class to access protected methods of \OC\Log\ErrorHandler
+ * dummy class to access protected methods of \OC\Log\ErrorHandler
*/
class TestableErrorHandler extends \OC\Log\ErrorHandler {
}
/**
- * @brief this test show the bug resulting if we have no normalizer installed
+ * this test show the bug resulting if we have no normalizer installed
*/
public function testWithoutNormalizer() {
// folder name "Schön" with U+00F6 (normalized)
}
/**
- * @brief this test shows that there is no bug if we use the normalizer
+ * this test shows that there is no bug if we use the normalizer
*/
public function testWithNormalizer() {
);
$result = OC_Helper::mb_array_change_key_case($arrayStart, MB_CASE_UPPER);
$expected = $arrayResult;
- $this->assertEquals($result, $expected);
+ $this->assertEquals($result, $expected);
}
function testMb_substr_replace() {
/**
* @small
- * @brief test absolute URL construction
+ * test absolute URL construction
* @dataProvider provideDocRootURLs
*/
function testMakeAbsoluteURLDocRoot($url, $expectedResult) {
/**
* @small
- * @brief test absolute URL construction
+ * test absolute URL construction
* @dataProvider provideSubDirURLs
*/
function testMakeAbsoluteURLSubDir($url, $expectedResult) {
/**
* @small
- * @brief test linkTo URL construction
+ * test linkTo URL construction
* @dataProvider provideDocRootAppUrlParts
*/
public function testLinkToDocRoot($app, $file, $args, $expectedResult) {
/**
* @small
- * @brief test linkTo URL construction in sub directory
+ * test linkTo URL construction in sub directory
* @dataProvider provideSubDirAppUrlParts
*/
public function testLinkToSubDir($app, $file, $args, $expectedResult) {
/**
* @small
- * @brief test linkToAbsolute URL construction
+ * test linkToAbsolute URL construction
* @dataProvider provideDocRootAppAbsoluteUrlParts
*/
public function testLinkToAbsoluteDocRoot($app, $file, $args, $expectedResult) {
/**
* @small
- * @brief test linkToAbsolute URL construction in sub directory
+ * test linkToAbsolute URL construction in sub directory
* @dataProvider provideSubDirAppAbsoluteUrlParts
*/
public function testLinkToAbsoluteSubDir($app, $file, $args, $expectedResult) {
/**
* @small
- * @brief test linkToRemoteBase URL construction
+ * test linkToRemoteBase URL construction
*/
public function testLinkToRemoteBase() {
\OC::$WEBROOT = '';
/**
* @small
- * @brief test linkToRemote URL construction
+ * test linkToRemote URL construction
*/
public function testLinkToRemote() {
\OC::$WEBROOT = '';
/**
* @small
- * @brief test linkToPublic URL construction
+ * test linkToPublic URL construction
*/
public function testLinkToPublic() {
\OC::$WEBROOT = '';
public $tmpfiles = array();
/**
- * @brief Generates a test user and sets up their file system
+ * Generates a test user and sets up their file system
* @return string the test users id
*/
public function generateUser() {
}
/**
- * @brief validates an export for a user
- * @brief checks for existence of export_info.json and file folder
+ * validates an export for a user
+ * checks for existence of export_info.json and file folder
* @param string $exportedUser the user that was exported
* @param string $path the path to the .zip export
* @param string $exportedBy
/**
* @small
- * @brief test linkTo URL construction
+ * test linkTo URL construction
* @dataProvider provideDocRootAppUrlParts
*/
public function testLinkToDocRoot($app, $file, $args, $expectedResult) {
/**
* @small
- * @brief test linkTo URL construction in sub directory
+ * test linkTo URL construction in sub directory
* @dataProvider provideSubDirAppUrlParts
*/
public function testLinkToSubDir($app, $file, $args, $expectedResult) {
/**
* @small
- * @brief test absolute URL construction
+ * test absolute URL construction
* @dataProvider provideDocRootURLs
*/
function testGetAbsoluteURLDocRoot($url, $expectedResult) {
/**
* @small
- * @brief test absolute URL construction
+ * test absolute URL construction
* @dataProvider provideSubDirURLs
*/
function testGetAbsoluteURLSubDir($url, $expectedResult) {
projects / nextcloud-server.git / commitdiff