* @param array $data with all information
* @return boolean
*
- * @deprecated This method is deprecated. Do not call it anymore.
+ * @deprecated 4.5.0 This method is deprecated. Do not call it anymore.
* It'll remain in our public API for compatibility reasons.
*
*/
* @param array $data containing the data
* @return boolean
*
- * @deprecated Use \OC::$server->getNavigationManager()->add() instead to
+ * @deprecated 8.1.0 Use \OC::$server->getNavigationManager()->add() instead to
* register a closure, this helps to speed up all requests against ownCloud
* @since 4.0.0
*/
* property from all other entries. The templates can use this for
* highlighting the current position of the user.
*
- * @deprecated Use \OC::$server->getNavigationManager()->setActiveEntry() instead
+ * @deprecated 8.1.0 Use \OC::$server->getNavigationManager()->setActiveEntry() instead
* @since 4.0.0
*/
public static function setActiveNavigationEntry( $id ) {
/**
* Lets you access post and get parameters by the index
- * @deprecated write your parameters as method arguments instead
+ * @deprecated 7.0.0 write your parameters as method arguments instead
* @param string $key the key which you want to access in the URL Parameter
* placeholder, $_POST or $_GET array.
* The priority how they're returned is the following:
/**
* Returns all params that were received, be it from the request
* (as GET or POST) or through the URL by the route
- * @deprecated use $this->request instead
+ * @deprecated 7.0.0 use $this->request instead
* @return array the array with all parameters
* @since 6.0.0
*/
/**
* Returns the method of the request
- * @deprecated use $this->request instead
+ * @deprecated 7.0.0 use $this->request instead
* @return string the method of the request (POST, GET, etc)
* @since 6.0.0
*/
/**
* Shortcut for accessing an uploaded file through the $_FILES array
- * @deprecated use $this->request instead
+ * @deprecated 7.0.0 use $this->request instead
* @param string $key the key that will be taken from the $_FILES array
* @return array the file in the $_FILES element
* @since 6.0.0
/**
* Shortcut for getting env variables
- * @deprecated use $this->request instead
+ * @deprecated 7.0.0 use $this->request instead
* @param string $key the key that will be taken from the $_ENV array
* @return array the value in the $_ENV element
* @since 6.0.0
/**
* Shortcut for getting cookie variables
- * @deprecated use $this->request instead
+ * @deprecated 7.0.0 use $this->request instead
* @param string $key the key that will be taken from the $_COOKIE array
* @return array the value in the $_COOKIE element
* @since 6.0.0
/**
* Shortcut for rendering a template
- * @deprecated return a template response instead
+ * @deprecated 7.0.0 return a template response instead
* @param string $templateName the name of the template
* @param array $params the template parameters in key => value structure
* @param string $renderAs user renders a full page, blank only your template
/**
* A few very basic and frequently used API functions are combined in here
- * @deprecated
+ * @deprecated 8.0.0
*/
interface IApi {
/**
* Gets the userid of the current user
* @return string the user id of the current user
- * @deprecated Use \OC::$server->getUserSession()->getUser()->getUID()
+ * @deprecated 8.0.0 Use \OC::$server->getUserSession()->getUser()->getUID()
*/
function getUserId();
/**
* Adds a new javascript file
- * @deprecated include javascript and css in template files
+ * @deprecated 8.0.0 include javascript and css in template files
* @param string $scriptName the name of the javascript in js/ without the suffix
* @param string $appName the name of the app, defaults to the current one
* @return void
/**
* Adds a new css file
- * @deprecated include javascript and css in template files
+ * @deprecated 8.0.0 include javascript and css in template files
* @param string $styleName the name of the css file in css/without the suffix
* @param string $appName the name of the app, defaults to the current one
* @return void
/**
- * @deprecated include javascript and css in template files
+ * @deprecated 8.0.0 include javascript and css in template files
* shorthand for addScript for files in the 3rdparty directory
* @param string $name the name of the file without the suffix
* @return void
/**
- * @deprecated include javascript and css in template files
+ * @deprecated 8.0.0 include javascript and css in template files
* shorthand for addStyle for files in the 3rdparty directory
* @param string $name the name of the file without the suffix
* @return void
/**
* Checks if an app is enabled
- * @deprecated communication between apps should happen over built in
+ * @deprecated 8.0.0 communication between apps should happen over built in
* callbacks or interfaces (check the contacts and calendar managers)
* Checks if an app is enabled
* also use \OC::$server->getAppManager()->isEnabledForUser($appName)
function getAppName();
/**
- * @deprecated implements only deprecated methods
+ * @deprecated 8.0.0 implements only deprecated methods
* @return IApi
* @since 6.0.0
*/
function registerMiddleWare($middleWare);
/**
- * @deprecated use IUserSession->isLoggedIn()
+ * @deprecated 8.0.0 use IUserSession->isLoggedIn()
* @return boolean
* @since 6.0.0
*/
function isLoggedIn();
/**
- * @deprecated use IGroupManager->isAdmin($userId)
+ * @deprecated 8.0.0 use IGroupManager->isAdmin($userId)
* @return boolean
- * @deprecated use the groupmanager instead to find out if the user is in
- * the admin group
* @since 6.0.0
*/
function isAdminUser();
/**
- * @deprecated use the ILogger instead
+ * @deprecated 8.0.0 use the ILogger instead
* @param string $message
* @param string $level
* @return mixed
}
/**
- * @deprecated
+ * @deprecated 6.0.0
* creates a regular task
* @param string $klass class name
* @param string $method method name
}
/**
- * @deprecated
+ * @deprecated 6.0.0
* gets all regular tasks
* @return array
*
}
/**
- * @deprecated
+ * @deprecated 6.0.0
* Gets one queued task
* @param int $id ID of the task
* @return BackgroundJob\IJob|null
}
/**
- * @deprecated
+ * @deprecated 6.0.0
* Gets all queued tasks
* @return array an array of associative arrays
* @since 4.5.0
}
/**
- * @deprecated
+ * @deprecated 6.0.0
* Gets all queued tasks of a specific app
* @param string $app app name
* @return array an array of associative arrays
}
/**
- * @deprecated
+ * @deprecated 6.0.0
* queues a task
* @param string $app app name
* @param string $class class name
}
/**
- * @deprecated
+ * @deprecated 6.0.0
* deletes a queued task
* @param int $id id of task
* @return boolean|null
/**
* This class provides functions to read and write configuration data.
* configuration can be on a system, application or user level
- * @deprecated use methods of \OCP\IConfig
+ * @deprecated 8.0.0 use methods of \OCP\IConfig
*/
class Config {
/**
* @param string $key key
* @param mixed $default = null default value
* @return mixed the value or $default
- * @deprecated use method getSystemValue of \OCP\IConfig
+ * @deprecated 8.0.0 use method getSystemValue of \OCP\IConfig
*
* This function gets the value from config.php. If it does not exist,
* $default will be returned.
* @param string $key key
* @param mixed $value value
* @return bool
- * @deprecated use method setSystemValue of \OCP\IConfig
+ * @deprecated 8.0.0 use method setSystemValue of \OCP\IConfig
*
* This function sets the value and writes the config.php. If the file can
* not be written, false will be returned.
/**
* Deletes a value from config.php
* @param string $key key
- * @deprecated use method deleteSystemValue of \OCP\IConfig
+ * @deprecated 8.0.0 use method deleteSystemValue of \OCP\IConfig
*
* This function deletes the value from config.php.
*/
* @param string $key key
* @param string $default = null, default value if the key does not exist
* @return string the value or $default
- * @deprecated use method getAppValue of \OCP\IConfig
+ * @deprecated 8.0.0 use method getAppValue of \OCP\IConfig
*
* This function gets a value from the appconfig table. If the key does
* not exist the default value will be returned
* @param string $key key
* @param string $value value
* @return boolean true/false
- * @deprecated use method setAppValue of \OCP\IConfig
+ * @deprecated 8.0.0 use method setAppValue of \OCP\IConfig
*
* Sets a value. If the key did not exist before it will be created.
*/
* @param string $key key
* @param string $default = null, default value if the key does not exist
* @return string the value or $default
- * @deprecated use method getUserValue of \OCP\IConfig
+ * @deprecated 8.0.0 use method getUserValue of \OCP\IConfig
*
* This function gets a value from the preferences table. If the key does
* not exist the default value will be returned
* @param string $key key
* @param string $value value
* @return bool
- * @deprecated use method setUserValue of \OCP\IConfig
+ * @deprecated 8.0.0 use method setUserValue of \OCP\IConfig
*
* Adds a value to the preferences. If the key did not exist before, it
* will be added automagically.
namespace OCP;
-/** @deprecated Use \OCP\Constants::PERMISSION_CREATE instead */
+/** @deprecated 8.0.0 Use \OCP\Constants::PERMISSION_CREATE instead */
const PERMISSION_CREATE = 4;
-/** @deprecated Use \OCP\Constants::PERMISSION_READ instead */
+/** @deprecated 8.0.0 Use \OCP\Constants::PERMISSION_READ instead */
const PERMISSION_READ = 1;
-/** @deprecated Use \OCP\Constants::PERMISSION_UPDATE instead */
+/** @deprecated 8.0.0 Use \OCP\Constants::PERMISSION_UPDATE instead */
const PERMISSION_UPDATE = 2;
-/** @deprecated Use \OCP\Constants::PERMISSION_DELETE instead */
+/** @deprecated 8.0.0 Use \OCP\Constants::PERMISSION_DELETE instead */
const PERMISSION_DELETE = 8;
-/** @deprecated Use \OCP\Constants::PERMISSION_SHARE instead */
+/** @deprecated 8.0.0 Use \OCP\Constants::PERMISSION_SHARE instead */
const PERMISSION_SHARE = 16;
-/** @deprecated Use \OCP\Constants::PERMISSION_ALL instead */
+/** @deprecated 8.0.0 Use \OCP\Constants::PERMISSION_ALL instead */
const PERMISSION_ALL = 31;
-/** @deprecated Use \OCP\Constants::FILENAME_INVALID_CHARS instead */
+/** @deprecated 8.0.0 Use \OCP\Constants::FILENAME_INVALID_CHARS instead */
const FILENAME_INVALID_CHARS = "\\/<>:\"|?*\n";
/**
class Constants {
/**
* CRUDS permissions.
+ * @since 8.0.0
*/
const PERMISSION_CREATE = 4;
const PERMISSION_READ = 1;
const PERMISSION_SHARE = 16;
const PERMISSION_ALL = 31;
+ /**
+ * @since 8.0.0
+ */
const FILENAME_INVALID_CHARS = "\\/<>:\"|?*\n";
}
* @param string $key key
* @param string $default = null, default value if the key does not exist
* @return string the value or $default
- * @deprecated use method getAppValue of \OCP\IConfig
+ * @deprecated 8.0.0 use method getAppValue of \OCP\IConfig
*
* This function gets a value from the appconfig table. If the key does
* not exist the default value will be returned
* @param string $app app
* @param string $key key
* @return bool
- * @deprecated use method deleteAppValue of \OCP\IConfig
+ * @deprecated 8.0.0 use method deleteAppValue of \OCP\IConfig
* @since 7.0.0
*/
public function deleteKey($app, $key);
* Get the available keys for an app
* @param string $app the app we are looking for
* @return array an array of key names
- * @deprecated use method getAppKeys of \OCP\IConfig
+ * @deprecated 8.0.0 use method getAppKeys of \OCP\IConfig
*
* This function gets all keys of an app. Please note that the values are
* not returned.
* @param string $app app
* @param string $key key
* @param string $value value
- * @deprecated use method setAppValue of \OCP\IConfig
+ * @deprecated 8.0.0 use method setAppValue of \OCP\IConfig
*
* Sets a value. If the key did not exist before it will be created.
* @return void
* Remove app from appconfig
* @param string $app app
* @return bool
- * @deprecated use method deleteAppValue of \OCP\IConfig
+ * @deprecated 8.0.0 use method deleteAppValue of \OCP\IConfig
*
* Removes all keys in appconfig belonging to the app.
* @since 7.0.0
* @param string $query
* @param string[] $inApps optionally limit results to the given apps
* @return array An array of OCP\Search\Result's
- * @deprecated use searchPaged() with page and size
+ * @deprecated 8.0.0 use searchPaged() with page and size
* @since 7.0.0 - parameter $inApps was added in 8.0.0
*/
public function search($query, array $inApps = array());
/**
* Returns an instance of the db facade
- * @deprecated use getDatabaseConnection, will be removed in ownCloud 10
+ * @deprecated 8.1.0 use getDatabaseConnection, will be removed in ownCloud 10
* @return \OCP\IDb
* @since 7.0.0
*/
/**
* Returns an instance of the HTTP helper class
* @return \OC\HTTPHelper
- * @deprecated Use \OCP\Http\Client\IClientService
+ * @deprecated 8.1.0 Use \OCP\Http\Client\IClientService
* @since 8.0.0
*/
public function getHTTPHelper();
/**
* This class provides convenient functions to generate and send JSON data. Useful for Ajax calls
- * @deprecated Use a AppFramework JSONResponse instead
+ * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
*/
class JSON {
/**
* Encode and print $data in JSON format
* @param array $data The data to use
* @param bool $setContentType the optional content type
- * @deprecated Use a AppFramework JSONResponse instead
+ * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
*/
public static function encodedPrint( $data, $setContentType=true ) {
\OC_JSON::encodedPrint($data, $setContentType);
*
* Add this call to the start of all ajax method files that requires
* an authenticated user.
- * @deprecated Use annotation based ACLs from the AppFramework instead
+ * @deprecated 8.1.0 Use annotation based ACLs from the AppFramework instead
*/
public static function checkLoggedIn() {
\OC_JSON::checkLoggedIn();
* a submittable form, you will need to add the requesttoken first as a
* parameter to the ajax call, then assign it to the template and finally
* add a hidden input field also named 'requesttoken' containing the value.
- * @deprecated Use annotation based CSRF checks from the AppFramework instead
+ * @deprecated 8.1.0 Use annotation based CSRF checks from the AppFramework instead
*/
public static function callCheck() {
\OC_JSON::callCheck();
*
* @param array $data The data to use
* @return string json formatted string.
- * @deprecated Use a AppFramework JSONResponse instead
+ * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
*/
public static function success( $data = array() ) {
\OC_JSON::success($data);
*
* @param array $data The data to use
* @return string json formatted error string.
- * @deprecated Use a AppFramework JSONResponse instead
+ * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
*/
public static function error( $data = array() ) {
\OC_JSON::error( $data );
/**
* Set Content-Type header to jsonrequest
* @param string $type The content type header
- * @deprecated Use a AppFramework JSONResponse instead
+ * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
*/
public static function setContentTypeHeader( $type='application/json' ) {
\OC_JSON::setContentTypeHeader($type);
* a specific app to be enabled.
*
* @param string $app The app to check
- * @deprecated Use the AppFramework instead. It will automatically check if the app is enabled.
+ * @deprecated 8.1.0 Use the AppFramework instead. It will automatically check if the app is enabled.
*/
public static function checkAppEnabled( $app ) {
\OC_JSON::checkAppEnabled($app);
* Add this call to the start of all ajax method files that requires
* administrative rights.
*
- * @deprecated Use annotation based ACLs from the AppFramework instead
+ * @deprecated 8.1.0 Use annotation based ACLs from the AppFramework instead
*/
public static function checkAdminUser() {
\OC_JSON::checkAdminUser();
* Encode JSON
* @param array $data
* @return string
- * @deprecated Use a AppFramework JSONResponse instead
+ * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
*/
public static function encode($data) {
return \OC_JSON::encode($data);
/**
* Check is a given user exists - send json error msg if not
* @param string $user
- * @deprecated Use a AppFramework JSONResponse instead
+ * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
*/
public static function checkUserExists($user) {
\OC_JSON::checkUserExists($user);
* @return string to the image
*
* @see OC_Helper::imagePath
- * @deprecated Use \OCP\Template::image_path() instead
+ * @deprecated 8.0.0 Use \OCP\Template::image_path() instead
*/
function image_path( $app, $image ) {
return(\image_path( $app, $image ));
* Make OC_Helper::mimetypeIcon available as a simple function
* @param string $mimetype
* @return string to the image of this file type.
- * @deprecated Use \OCP\Template::mimetype_icon() instead
+ * @deprecated 8.0.0 Use \OCP\Template::mimetype_icon() instead
*/
function mimetype_icon( $mimetype ) {
return(\mimetype_icon( $mimetype ));
* Make preview_icon available as a simple function
* @param string $path path to file
* @return string to the preview of the image
- * @deprecated Use \OCP\Template::preview_icon() instead
+ * @deprecated 8.0.0 Use \OCP\Template::preview_icon() instead
*/
function preview_icon( $path ) {
return(\preview_icon( $path ));
* @param string $path of file
* @param string $token
* @return string link to the preview
- * @deprecated Use \OCP\Template::publicPreview_icon() instead
+ * @deprecated 8.0.0 Use \OCP\Template::publicPreview_icon() instead
*/
function publicPreview_icon ( $path, $token ) {
return(\publicPreview_icon( $path, $token ));
* Example: 2048 to 2 kB.
* @param int $bytes in bytes
* @return string size as string
- * @deprecated Use \OCP\Template::human_file_size() instead
+ * @deprecated 8.0.0 Use \OCP\Template::human_file_size() instead
*/
function human_file_size( $bytes ) {
return(\human_file_size( $bytes ));
* @param boolean $dateOnly
* @return \OC_L10N_String human readable interpretation of the timestamp
*
- * @deprecated Use \OCP\Template::relative_modified_date() instead
+ * @deprecated 8.0.0 Use \OCP\Template::relative_modified_date() instead
*/
function relative_modified_date( $timestamp, $dateOnly = false ) {
return(\relative_modified_date($timestamp, null, $dateOnly));
* Return a human readable outout for a file size.
* @param integer $bytes size of a file in byte
* @return string human readable interpretation of a file size
- * @deprecated Use \OCP\Template::human_file_size() instead
+ * @deprecated 8.0.0 Use \OCP\Template::human_file_size() instead
*/
function simple_file_size($bytes) {
return(\human_file_size($bytes));
* @param mixed $selected which one is selected?
* @param array $params the parameters
* @return string html options
- * @deprecated Use \OCP\Template::html_select_options() instead
+ * @deprecated 8.0.0 Use \OCP\Template::html_select_options() instead
*/
function html_select_options($options, $selected, $params=array()) {
return(\html_select_options($options, $selected, $params));
/**
* Get the user id of the user currently logged in.
* @return string uid or false
- * @deprecated Use \OC::$server->getUserSession()->getUser()->getUID()
+ * @deprecated 8.0.0 Use \OC::$server->getUserSession()->getUser()->getUID()
* @since 5.0.0
*/
public static function getUser() {
/**
* Logs the user out including all the session data
* Logout, destroys session
- * @deprecated Use \OC::$server->getUserSession()->logout();
+ * @deprecated 8.0.0 Use \OC::$server->getUserSession()->logout();
* @since 5.0.0
*/
public static function logout() {
* @return string|false username on success, false otherwise
*
* Check if the password is correct without logging in the user
- * @deprecated Use \OC::$server->getUserManager()->checkPassword();
+ * @deprecated 8.0.0 Use \OC::$server->getUserManager()->checkPassword();
* @since 5.0.0
*/
public static function checkPassword( $uid, $password ) {
* @param string $ccaddress
* @param string $ccname
* @param string $bcc
- * @deprecated Use \OCP\Mail\IMailer instead
+ * @deprecated 8.1.0 Use \OCP\Mail\IMailer instead
* @since 4.0.0
*/
public static function sendMail($toaddress, $toname, $subject, $mailtext, $fromaddress, $fromname,
* @param DateTimeZone|string $timeZone where the given timestamp shall be converted to
* @return string timestamp
*
- * @deprecated Use \OC::$server->query('DateTimeFormatter') instead
+ * @deprecated 8.0.0 Use \OC::$server->query('DateTimeFormatter') instead
* @since 4.0.0
*/
public static function formatDate($timestamp, $dateOnly=false, $timeZone = null) {
* check if some encrypted files are stored
* @return bool
*
- * @deprecated No longer required
+ * @deprecated 8.1.0 No longer required
* @since 6.0.0
*/
public static function encryptedFiles() {
* @param array $parameters
* @internal param array $args with param=>value, will be appended to the returned url
* @return string the url
- * @deprecated Use \OC::$server->getURLGenerator()->linkToRoute($route, $parameters)
+ * @deprecated 8.1.0 Use \OC::$server->getURLGenerator()->linkToRoute($route, $parameters)
* @since 5.0.0
*/
public static function linkToRoute( $route, $parameters = array() ) {
* @param array $args array with param=>value, will be appended to the returned url
* The value of $args will be urlencoded
* @return string the url
- * @deprecated Use \OC::$server->getURLGenerator()->linkTo($app, $file, $args)
+ * @deprecated 8.1.0 Use \OC::$server->getURLGenerator()->linkTo($app, $file, $args)
* @since 4.0.0 - parameter $args was added in 4.5.0
*/
public static function linkTo( $app, $file, $args = array() ) {
/**
* Returns the server host, even if the website uses one or more reverse proxy
* @return string the server host
- * @deprecated Use \OCP\IRequest::getServerHost
+ * @deprecated 8.1.0 Use \OCP\IRequest::getServerHost
* @since 4.0.0
*/
public static function getServerHost() {
/**
* Returns the server protocol. It respects reverse proxy servers and load balancers
* @return string the server protocol
- * @deprecated Use \OCP\IRequest::getServerProtocol
+ * @deprecated 8.1.0 Use \OCP\IRequest::getServerProtocol
* @since 4.5.0
*/
public static function getServerProtocol() {
/**
* Returns the request uri, even if the website uses one or more reverse proxies
* @return string the request uri
- * @deprecated Use \OCP\IRequest::getRequestUri
+ * @deprecated 8.1.0 Use \OCP\IRequest::getRequestUri
* @since 5.0.0
*/
public static function getRequestUri() {
/**
* Returns the script name, even if the website uses one or more reverse proxies
* @return string the script name
- * @deprecated Use \OCP\IRequest::getScriptName
+ * @deprecated 8.1.0 Use \OCP\IRequest::getScriptName
* @since 5.0.0
*/
public static function getScriptName() {
* @param string $app app
* @param string $image image name
* @return string the url
- * @deprecated Use \OC::$server->getURLGenerator()->imagePath($app, $image)
+ * @deprecated 8.1.0 Use \OC::$server->getURLGenerator()->imagePath($app, $image)
* @since 4.0.0
*/
public static function imagePath( $app, $image ) {
* Returns whether the given file name is valid
* @param string $file file name to check
* @return bool true if the file name is valid, false otherwise
- * @deprecated use \OC\Files\View::verifyPath()
+ * @deprecated 8.1.0 use \OC\Files\View::verifyPath()
* @since 7.0.0
*/
public static function isValidFileName($file) {
* Generates a cryptographic secure pseudo-random string
* @param int $length of the random string
* @return string
- * @deprecated Use \OC::$server->getSecureRandom()->getMediumStrengthGenerator()->generate($length); instead
+ * @deprecated 8.0.0 Use \OC::$server->getSecureRandom()->getMediumStrengthGenerator()->generate($length); instead
* @since 7.0.0
*/
public static function generateRandomBytes($length = 30) {
projects / nextcloud-server.git / commitdiff